feat: record app_path in junit reports

Author: hfudev

pytest-embedded-idf/pytest_embedded_idf/unity_tester.py

@@ -288,7 +288,9 @@ def wrapper(self, *args, **kwargs):
                 finally:
                     _end_at = time.perf_counter()
                     self._add_single_unity_test_case(
-                        _case, _log, additional_attrs={'time': round(_end_at - _start_at, 3)}
+                        _case,
+                        _log,
+                        additional_attrs={'app_path': self.app.app_path, 'time': round(_end_at - _start_at, 3)},
                     )
 
         return wrapper
@@ -695,6 +697,8 @@ def process_raw_report_data(self, raw_data_to_report) -> t.Dict:
         if log:
             attrs.update({'stdout': log})
 
+        attrs.update({'app_path': self.dut.app.app_path})
+
         return attrs
 
     def add_to_report(self, attrs):
@@ -765,9 +769,6 @@ def gather(self):
             for _t in self.workers:
                 _t.close()
 
-    def get_processed_report_data(self, res: t.List[t.Any]) -> t.List[t.Dict]:
-        return [self.workers[i].process_raw_report_data(res[i]) for i in range(len(res))]
-
     @staticmethod
     def get_merge_data(test_cases_attr: t.List[t.Dict]) -> t.Dict:
         output = {}
@@ -794,6 +795,8 @@ def get_merge_data(test_cases_attr: t.List[t.Dict]) -> t.Dict:
         for k, val in output.items():
             if k in ('file', 'line'):
                 output[k] = val[0]
+            elif k == 'app_path':
+                output[k] = '|'.join(val)
             else:
                 output[k] = '<------------------->\n'.join(val)
 

pytest-embedded-idf/tests/test_idf.py

@@ -858,6 +858,10 @@ def test_dut_run_all_single_board_cases(dut):
     assert junit_report.attrib['failures'] == '1'
     assert junit_report.attrib['skipped'] == '0'
     assert junit_report.attrib['tests'] == '1'
+    cases = junit_report.findall('.//testcase')
+    assert len(cases) == 2
+    assert cases[0].attrib['app_path'] == os.path.join(testdir.tmpdir, 'unit_test_app_esp32')
+    assert cases[1].attrib['app_path'] == os.path.join(testdir.tmpdir, 'unit_test_app_esp32')
 
 
 def test_dut_run_all_single_board_cases_invert_group(testdir):
@@ -939,14 +943,24 @@ def test_unity_test_case_runner(unity_tester):
     assert junit_report.attrib['skipped'] == '0'
     assert junit_report.attrib['tests'] == '3'
 
+    # single-dut app_path should be the dut[0] one
     assert junit_report[0].get('name') == 'normal_case1'
     assert junit_report[0].find('failure') is None
+    assert junit_report[0].get('app_path') == os.path.join(testdir.tmpdir, 'unit_test_app_esp32')
     assert junit_report[1].get('name') == 'normal_case2'
     assert junit_report[1].find('failure') is not None
+    assert junit_report[1].get('app_path') == os.path.join(testdir.tmpdir, 'unit_test_app_esp32')
     assert junit_report[2].get('name') == 'multiple_stages_test'
     assert junit_report[2].find('failure') is None
+    assert junit_report[2].get('app_path') == os.path.join(testdir.tmpdir, 'unit_test_app_esp32')
+    # multi-dut app_path should be concatenated
     assert junit_report[3].get('name') == 'multiple_devices_test'
     assert junit_report[3].find('failure') is None
+    assert (
+        junit_report[3].get('app_path') == f'{os.path.join(testdir.tmpdir, "unit_test_app_esp32")}'
+        f'|'
+        f'{os.path.join(testdir.tmpdir, "unit_test_app_esp32c3")}'
+    )
 
 
 def test_erase_all_with_port_cache(testdir):

pytest-embedded/pytest_embedded/dut.py

@@ -187,7 +187,12 @@ def expect_unity_test_output(
         if remove_asci_escape_code:
             log = remove_asci_color_code(log)
 
-        self.testsuite.add_unity_test_cases(log)
+        self.testsuite.add_unity_test_cases(
+            log,
+            additional_attrs={
+                'app_path': self.app.app_path,
+            },
+        )
 
     @_InjectMixinCls.require_services('idf')
     def run_all_single_board_cases(

pytest-embedded/pytest_embedded/plugin.py

@@ -1377,7 +1377,7 @@ def pytest_sessionfinish(self, session: Session, exitstatus: int) -> None:
         _stash_session_tempdir = session.config.stash.get(_session_tempdir_key, None)
         _stash_junit_report_path = session.config.stash.get(_junit_report_path_key, None)
         if _stash_session_tempdir is not None:
-            modifier.merge(find_by_suffix('.xml', _stash_session_tempdir))
+            modifier.merge(sorted(find_by_suffix('.xml', _stash_session_tempdir)))
 
         if _stash_junit_report_path:
             # before we only modified the junit report generated by the unity test cases

pytest-embedded/tests/test_base.py

@@ -457,26 +457,33 @@ def test_expect_unity_test_output_multi_dut_with_illegal_chars(testdir):
         import pytest
         import inspect
 
-        output = inspect.cleandoc(
+        output1 = inspect.cleandoc(
                 u'''
-            TEST(group, test_case)foo.c:100::FAIL:Expected 2 \x00 was 1
+            TEST(group, test_case_1)foo.c:100::FAIL:Expected 2 \x00 was 1
             -------------------
             4 Tests 3 Failures 0 Ignored
             FAIL
         ''')
+        output2 = inspect.cleandoc(
+                u'''
+            TEST(group, test_case_2)foo.c:100::FAIL:Expected 2 \x00 was 1
+            -------------------
+            5 Tests 2 Failures 0 Ignored
+            FAIL
+        ''')
 
         @pytest.mark.parametrize('count', [2], indirect=True)
         def test_expect_unity_test_output_multi_dut_with_illegal_chars(dut):
             dut_0 = dut[0]
             dut_1 = dut[1]
 
-            dut_0.write(output)
-            dut_1.write(output)
+            dut_0.write(output1)
+            dut_1.write(output2)
             dut_0.expect_unity_test_output()
             dut_1.expect_unity_test_output()
     """)
 
-    result = testdir.runpytest('--junitxml', 'report.xml')
+    result = testdir.runpytest('--app-path', f'{testdir.tmpdir}/foo|{testdir.tmpdir}/bar', '--junitxml', 'report.xml')
 
     try:
         result.assert_outcomes(failed=1)
@@ -490,10 +497,12 @@ def test_expect_unity_test_output_multi_dut_with_illegal_chars(dut):
     assert junit_report.attrib['skipped'] == '0'
     assert junit_report.attrib['tests'] == '2'
 
-    assert junit_report[0].get('name') == 'test_case'
+    assert junit_report[0].get('name') == 'test_case_1'
     assert junit_report[0].find('failure') is not None
-    assert junit_report[1].get('name') == 'test_case'
+    assert junit_report[0].get('app_path') == f'{testdir.tmpdir}/foo'
+    assert junit_report[1].get('name') == 'test_case_2'
     assert junit_report[1].find('failure') is not None
+    assert junit_report[1].get('app_path') == f'{testdir.tmpdir}/bar'
 
 
 def test_duplicate_stdout_popen(testdir):