[idf] Support Skip Marker for ESP-IDF Soc Caps (RDT-1055)

[hfudev]

Soc Caps defines hardware capabilities or ESP-IDF apps.

Ideal Use Case

1. Basic

Support a marker, like

@pytest.mark.skip_if_soc("SOC_ADC_SAMPLE_FREQ_THRES_HIGH == 20000")

Iterate through all supported targets, if the expression is false, then we skip running the test case for this target.

2. Preview Targets

Support iterating through preview targets as well, by

@pytest.mark.skip_if_soc(
    "SOC_ADC_SAMPLE_FREQ_THRES_HIGH == 20000",
    include_preview_targets=True
)

Here we shall iterate over SUPPORTED_TARGETS + PREVIEW_TARGETS

3. Limited Targets

Or iterate over a subset of targets, if user specified targets as param, like

@pytest.mark.skip_if_soc("SOC_ADC_SAMPLE_FREQ_THRES_HIGH == 20000")
@pytest.mark.parametrization('target', ['esp32', 'esp32s2'], indirect=True)
def test_foo():
    pass

here shall only iterate over esp32 and esp32s2

Implementation Details

• the parsing soc caps part could be done by idf_build_apps.manifest.if_parser
• the skip test case part shall be done in the pytest hook function pytest_collection_modifyitems
• idf-build-apps shall be added as a dependency for pytest-embedded-idf
• SUPPORTED_TARGETS and PREVIEW_TARGETS could be loaded from idf_build_apps. These values are lazy loaded from IDF_PATH.
• Make sure everything is lazy-loaded, otherwise it would break user without IDF_PATH.

[horw]

@hfudev Hi, I can do it, WDYT?

[horw]

Should we also support the and syntax?
There are two possible variants:

@pytest.mark.custom_skip(
    ("SOC_ADC_SAMPLE_FREQ_THRES_HIGH == 20000", "SUPPORT_A_FEATURE == 1"),
    "SOC_ADC_SAMPLE_FREQ_THRES_HIGH == 10000",
    include_preview_targets=True
)

@pytest.mark.custom_skip(
    "SOC_ADC_SAMPLE_FREQ_THRES_HIGH == 20000 and SUPPORT_A_FEATURE == 1",
    "SOC_ADC_SAMPLE_FREQ_THRES_HIGH == 10000",
    include_preview_targets=True
)

[hfudev]

@horw sure. the idf-build-apps if-clause supports and or that we may reuse.

[horw]

The easiest part was 3. Limited Targets because we can associate our pytest item with the target. However, for 1. Basic and 2. Preview Targets, it’s trickier because we don’t know which target it is associated with. So, maybe we should do this only for tests with a target in the parametrize?

[hfudev]

sure it makes sense