feat: added skip_if_soc marker for idf target

Author: horw

pytest-embedded-idf/pyproject.toml

@@ -33,6 +33,7 @@ requires-python = ">=3.7"
 dependencies = [
     "pytest-embedded~=1.12.1",
     "esp-idf-panic-decoder",
+    "esp-bool-parser>=0.1.2,<1"
 ]
 
 [project.optional-dependencies]

pytest-embedded-idf/tests/test_idf.py

@@ -987,3 +987,54 @@ def test_python_case(dut):
     assert junit_report[0].attrib['is_unity_case'] == '0'  # Python test case
     for testcase in junit_report[1:]:
         assert testcase.attrib['is_unity_case'] == '1'  # Other test cases
+
+
+def test_skip_if_soc(testdir):
+    EMBEDDED_SERVICES = ['--embedded-services', 'esp,idf']
+
+    def run_pytest_with_target(target):
+        count = len(target.split('|'))
+        return testdir.runpytest(*EMBEDDED_SERVICES, '--target', target, '--count', count)
+
+    testdir.makepyfile("""
+        import pytest
+        from esp_bool_parser.constants import SUPPORTED_TARGETS
+
+        @pytest.mark.skip_if_soc("SOC_ULP_LP_UART_SUPPORTED == 1")
+        @pytest.mark.parametrize('target', ['esp32', 'esp32s3', 'esp32c6'], indirect=True)
+        def test_lp_uart_wakeup():
+            pass
+
+        @pytest.mark.skip_if_soc("SOC_BLE_SUPPORTED == 1")
+        @pytest.mark.parametrize('target', SUPPORTED_TARGETS, indirect=True)
+        def test_ble():
+            pass
+
+        @pytest.mark.skip_if_soc("SOC_ADC_SAMPLE_FREQ_THRES_HIGH == 83333")
+        @pytest.mark.parametrize('target', SUPPORTED_TARGETS, indirect=True)
+        def test_adc():
+            pass
+
+    """)
+
+    result = testdir.runpytest('-s', *EMBEDDED_SERVICES)
+    result.assert_outcomes(passed=14, failed=0, skipped=5)
+
+    testdir.makepyfile("""
+        import pytest
+
+        @pytest.mark.skip_if_soc("SOC_ULP_LP_UART_SUPPORTED == 1")
+        def test_from_args():
+            pass
+
+    """)
+
+    results = [
+        (run_pytest_with_target('esp32'), {'passed': 0, 'failed': 0, 'skipped': 1}),
+        (run_pytest_with_target('esp32c5'), {'passed': 1, 'failed': 0, 'skipped': 0}),
+        (run_pytest_with_target('auto'), {'passed': 1, 'failed': 0, 'skipped': 0}),
+        (run_pytest_with_target('esp32|esp32'), {'passed': 1, 'failed': 0, 'skipped': 0}),
+    ]
+
+    for result, expected in results:
+        result.assert_outcomes(**expected)

pytest-embedded/pytest_embedded/plugin.py

@@ -12,6 +12,7 @@
 import subprocess
 import tempfile
 import typing as t
+import warnings
 import xml.dom.minidom
 from collections import Counter
 from operator import itemgetter
@@ -1204,6 +1205,7 @@ def pytest_configure(config: Config) -> None:
         add_target_as_marker=_str_bool(config.getoption('add_target_as_marker', False)),
     )
     config.pluginmanager.register(config.stash[_pytest_embedded_key])
+    config.addinivalue_line('markers', 'skip_if_soc')
 
 
 def pytest_unconfigure(config: Config) -> None:
@@ -1252,7 +1254,39 @@ def _duplicate_items(items: t.List[_T]) -> t.List[_T]:
         return duplicates
 
     @pytest.hookimpl(hookwrapper=True, trylast=True)
-    def pytest_collection_modifyitems(self, items: t.List[Function]):
+    def pytest_collection_modifyitems(self, config: Config, items: t.List[Function]):
+        for item in items:
+            skip_marker = item.get_closest_marker('skip_if_soc')
+            if not skip_marker:
+                continue
+
+            from esp_bool_parser import parse_bool_expr
+
+            target = config.getoption('--target', None)
+            if hasattr(item, 'callspec'):
+                target = item.callspec.params.get('target', None)
+            if target == 'auto' or not isinstance(target, str):
+                warnings.warn(
+                    f"Ignoring pytest.mark.skip_if_soc for test item '{item.originalname}': "
+                    "Ensure that 'target' is included in the test's "
+                    "@pytest.mark.parametrize when using 'skip_if_soc', "
+                    'or provide the --target argument '
+                    "when running tests (excluding 'auto' and multi-DUT configurations)."
+                )
+                continue
+            if '|' in target:
+                warnings.warn(
+                    'Ignoring pytest.mark.skip_if_soc, '
+                    "because multi-DUT tests do not support the 'skip_if_soc' marker. "
+                    'Please adjust the test setup accordingly.'
+                )
+                continue
+
+            stm = parse_bool_expr(skip_marker.args[0])
+            if not stm.get_value(target, ''):
+                reason = f'Filtered by {skip_marker.args[0]}, for {target}.'
+                item.add_marker(pytest.mark.skip(reason=reason))
+
         if self.add_target_as_marker:
             for item in items:
                 item_target = item.callspec.getparam('target')