From 0a0f6ff9d1e7c21ef5f3ba9dfe5254f01ddd1887 Mon Sep 17 00:00:00 2001 From: Fu Hanxi Date: Wed, 19 Aug 2026 15:42:18 +0200 Subject: [PATCH] tests: replace CLI-dependent xfail/skipif conditions Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../esp_event/test_apps/pytest_esp_event.py | 11 ++--- .../contribute/esp-idf-tests-with-pytest.rst | 24 +++++++++- .../contribute/esp-idf-tests-with-pytest.rst | 24 +++++++++- .../system/panic/panic_base/pytest_panic.py | 47 ++++++++++++++----- 4 files changed, 83 insertions(+), 23 deletions(-) diff --git a/components/esp_event/test_apps/pytest_esp_event.py b/components/esp_event/test_apps/pytest_esp_event.py index 249a4056b28..4e6a2b737ca 100644 --- a/components/esp_event/test_apps/pytest_esp_event.py +++ b/components/esp_event/test_apps/pytest_esp_event.py @@ -27,15 +27,14 @@ def test_esp_event_ext_ram(dut: Dut) -> None: @pytest.mark.qemu -@pytest.mark.xfail('config.getvalue("target") == "esp32c3"', reason='Unstable on QEMU, needs investigation') -@pytest.mark.parametrize( - 'config', +@idf_parametrize( + 'config,target,markers', [ - 'defaults', + ('defaults', 'esp32'), + ('defaults', 'esp32c3', (pytest.mark.xfail(reason='Unstable on QEMU, needs investigation'),)), ], - indirect=True, + indirect=['config', 'target'], ) -@idf_parametrize('target', ['esp32', 'esp32c3'], indirect=['target']) def test_esp_event_qemu(dut: Dut) -> None: for case in dut.test_menu: if 'qemu-ignore' not in case.groups and not case.is_ignored and case.type == 'normal': diff --git a/docs/en/contribute/esp-idf-tests-with-pytest.rst b/docs/en/contribute/esp-idf-tests-with-pytest.rst index 562fae9df58..33cb28491d0 100644 --- a/docs/en/contribute/esp-idf-tests-with-pytest.rst +++ b/docs/en/contribute/esp-idf-tests-with-pytest.rst @@ -735,15 +735,35 @@ Sometimes, a test can consistently fail for the following reasons: Now you may mark this test case with marker `xfail `__ with a user-friendly readable reason. +.. attention:: + + Avoid using a string condition, e.g., ``@pytest.mark.xfail('config.getvalue("target") == "esp32s2"', ...)``. This condition is evaluated against the session-level CLI ``--target`` option, not against the actual target resolved for a given parametrized test instance, so it can silently mismatch when the same test is parametrized over multiple targets and produce unreliable results. + + Instead, attach the ``xfail`` marker directly to the specific parametrized value passed to ``idf_parametrize`` (see :ref:`Same App With Different Running Environments `), so the marker is tied to that value at collection time. + This code example is taken from :idf_file:`pytest_panic.py ` .. code-block:: python - @pytest.mark.xfail('config.getvalue("target") == "esp32s2"', reason='raised IllegalInstruction instead') - def test_cache_error(dut: PanicTestDut, config: str, test_func_name: str) -> None: + @pytest.mark.generic + @idf_parametrize( + 'config,target,markers', + [ + ( + 'memprot_esp32s2', + 'esp32s2', + pytest.mark.xfail(reason='Incorrect panic reason may be observed', run=False), + ), + ('memprot_esp32c3', 'esp32c3'), + ], + indirect=['config', 'target'], + ) + def test_cache_error(dut: PanicTestDut, test_func_name: str) -> None: This marker means that test is a known failure on the ESP32-S2. +If a test is only ever parametrized with a single target, there is no ambiguity, and you can use an unconditional ``@pytest.mark.xfail(reason=..., run=False)`` instead. + Mark Nightly Run Test Cases --------------------------- diff --git a/docs/zh_CN/contribute/esp-idf-tests-with-pytest.rst b/docs/zh_CN/contribute/esp-idf-tests-with-pytest.rst index 9b5a455c635..18bf1ccbc92 100644 --- a/docs/zh_CN/contribute/esp-idf-tests-with-pytest.rst +++ b/docs/zh_CN/contribute/esp-idf-tests-with-pytest.rst @@ -735,15 +735,35 @@ Pytest 使用技巧 可使用 `xfail `__ marker 来标记此测试用例，并写出原因。 +.. attention:: + + 请避免使用字符串条件，例如 ``@pytest.mark.xfail('config.getvalue("target") == "esp32s2"', ...)``。该条件是在运行时根据 session 级别的 CLI ``--target`` 参数求值的，而不是针对某个具体参数化测试实例实际解析出的 target 值，因此当同一测试针对多个 target 参数化时，该条件可能被错误匹配，导致结果不可靠。 + + 推荐做法是通过 ``idf_parametrize`` 传入的具体参数化取值直接附加 ``xfail`` marker，更复杂的示例请参阅 :ref:`在不同运行环境中运行相同的应用程序 ` 小节，这样该 marker 在 collection 阶段就与该取值绑定。 + 以下代码来自 :idf_file:`pytest_panic.py `。 .. code-block:: python - @pytest.mark.xfail('config.getvalue("target") == "esp32s2"', reason='raised IllegalInstruction instead') - def test_cache_error(dut: PanicTestDut, config: str, test_func_name: str) -> None: + @pytest.mark.generic + @idf_parametrize( + 'config,target,markers', + [ + ( + 'memprot_esp32s2', + 'esp32s2', + pytest.mark.xfail(reason='Incorrect panic reason may be observed', run=False), + ), + ('memprot_esp32c3', 'esp32c3'), + ], + indirect=['config', 'target'], + ) + def test_cache_error(dut: PanicTestDut, test_func_name: str) -> None: 这一 marker 表示该测试在 ESP32-S2 上是一个已知失败。 +如果一个测试始终只针对单个 target 参数化，则不存在歧义，此时可直接使用无条件的 ``@pytest.mark.xfail(reason=..., run=False)``。 + 标记夜间运行的测试用例 --------------------------- diff --git a/tools/test_apps/system/panic/panic_base/pytest_panic.py b/tools/test_apps/system/panic/panic_base/pytest_panic.py index 13ffe68c0ae..e894d6b3fa6 100644 --- a/tools/test_apps/system/panic/panic_base/pytest_panic.py +++ b/tools/test_apps/system/panic/panic_base/pytest_panic.py @@ -35,6 +35,15 @@ def configs_for_app(app_path: str, configs: Sequence[str]) -> list[tuple[str, st return [(app_path, config) for config in configs] +def configs_with_esp32s2_xfail( + configs: Sequence[tuple[str, str]], reason: str +) -> list[tuple[str, str] | tuple[str, str, Any]]: + return [ + (config, target, pytest.mark.xfail(reason=reason, run=False)) if target == 'esp32s2' else (config, target) + for config, target in configs + ] + + CONFIGS = configs_for_app(PANIC_APP, ['gdbstub', 'panic']) CONFIGS_UBSAN = configs_for_app(PANIC_APP, ['gdbstub', 'panic']) @@ -722,7 +731,7 @@ def test_dcache_read_violation(dut: PanicTestDut, test_func_name: str) -> None: # TODO: IDF-6820: ESP32-S2 -> Fix multiple panic reasons in different runs @pytest.mark.generic -@pytest.mark.xfail(targets=['esp32s2'], reason='Incorrect panic reason may be observed', run=False) +@pytest.mark.xfail(reason='Incorrect panic reason may be observed', run=False) @idf_parametrize('config, target', CONFIGS_MEMPROT_DCACHE, indirect=['config', 'target']) def test_dcache_write_violation(dut: PanicTestDut, test_func_name: str) -> None: dut.run_test_func(test_func_name) @@ -862,11 +871,14 @@ def iram_reg4_write_violation(dut: PanicTestDut, test_func_name: str) -> None: dut.expect_cpu_reset() -# TODO: IDF-6820: ESP32-S2 -> Fix incorrect panic reason: Unhandled debug exception @pytest.mark.generic -@pytest.mark.xfail(targets=['esp32s2'], reason='Incorrect panic reason may be observed', run=False) @pytest.mark.temp_skip_ci(targets=['esp32h21'], reason='lack of runners') -@idf_parametrize('config, target', CONFIGS_MEMPROT_IDRAM, indirect=['config', 'target']) +# TODO: IDF-6820: ESP32-S2 -> Fix incorrect panic reason: Unhandled debug exception +@idf_parametrize( + 'config,target,markers', + configs_with_esp32s2_xfail(CONFIGS_MEMPROT_IDRAM, 'Incorrect panic reason may be observed'), + indirect=['config', 'target'], +) def test_iram_reg4_write_violation(dut: PanicTestDut, test_func_name: str) -> None: iram_reg_write_violation(dut, test_func_name) @@ -894,11 +906,14 @@ def dram_reg1_execute_violation(dut: PanicTestDut, test_func_name: str) -> None: dut.expect_cpu_reset() -# TODO: IDF-6820: ESP32-S2 -> Fix multiple panic reasons in different runs @pytest.mark.generic -@pytest.mark.xfail(targets=['esp32s2'], reason='Multiple panic reasons for the same test may surface', run=False) @pytest.mark.temp_skip_ci(targets=['esp32h21'], reason='lack of runners') -@idf_parametrize('config, target', CONFIGS_MEMPROT_IDRAM, indirect=['config', 'target']) +# TODO: IDF-6820: ESP32-S2 -> Fix multiple panic reasons in different runs +@idf_parametrize( + 'config,target,markers', + configs_with_esp32s2_xfail(CONFIGS_MEMPROT_IDRAM, 'Multiple panic reasons for the same test may surface'), + indirect=['config', 'target'], +) def test_dram_reg1_execute_violation(dut: PanicTestDut, test_func_name: str) -> None: dram_reg1_execute_violation(dut, test_func_name) @@ -925,11 +940,14 @@ def dram_reg2_execute_violation(dut: PanicTestDut, test_func_name: str) -> None: dut.expect_cpu_reset() -# TODO: IDF-6820: ESP32-S2 -> Fix multiple panic reasons in different runs @pytest.mark.generic -@pytest.mark.xfail(targets=['esp32s2'], reason='Multiple panic reasons for the same test may surface', run=False) @pytest.mark.temp_skip_ci(targets=['esp32h21'], reason='lack of runners') -@idf_parametrize('config, target', CONFIGS_MEMPROT_IDRAM, indirect=['config', 'target']) +# TODO: IDF-6820: ESP32-S2 -> Fix multiple panic reasons in different runs +@idf_parametrize( + 'config,target,markers', + configs_with_esp32s2_xfail(CONFIGS_MEMPROT_IDRAM, 'Multiple panic reasons for the same test may surface'), + indirect=['config', 'target'], +) def test_dram_reg2_execute_violation(dut: PanicTestDut, test_func_name: str) -> None: dram_reg2_execute_violation(dut, test_func_name) @@ -974,11 +992,14 @@ def test_rtc_fast_reg2_execute_violation(dut: PanicTestDut, test_func_name: str) dut.expect_cpu_reset() -# TODO: IDF-6820: ESP32-S2 -> Fix multiple panic reasons in different runs @pytest.mark.generic -@pytest.mark.xfail(targets=['esp32s2'], reason='Multiple panic reasons for the same test may surface', run=False) @pytest.mark.temp_skip_ci(targets=['esp32h21'], reason='lack of runners') -@idf_parametrize('config, target', CONFIGS_MEMPROT_RTC_FAST_MEM, indirect=['config', 'target']) +# TODO: IDF-6820: ESP32-S2 -> Fix multiple panic reasons in different runs +@idf_parametrize( + 'config,target,markers', + configs_with_esp32s2_xfail(CONFIGS_MEMPROT_RTC_FAST_MEM, 'Multiple panic reasons for the same test may surface'), + indirect=['config', 'target'], +) def test_rtc_fast_reg3_execute_violation(dut: PanicTestDut, test_func_name: str) -> None: dut.run_test_func(test_func_name)