Merge remote-tracking branch 'origin/report-offending-file' into main

launchable/commands/record/tests.py

@@ -126,25 +126,28 @@ def payload():
                 first = True        # used to control ',' in printing
 
                 for p in self.reports:
-                    # To understand JUnit XML format, https://llg.cubic.org/docs/junit/ is helpful
-                    # TODO: robustness: what's the best way to deal with broken XML file, if any?
-                    xml = JUnitXml.fromfile(p, self.junitxml_parse_func)
-                    if isinstance(xml, JUnitXml):
-                        testsuites = [suite for suite in xml]
-                    elif isinstance(xml, TestSuite):
-                        testsuites = [xml]
-                    else:
-                        # TODO: what is a Pythonesque way to do this?
-                        assert False
-
-                    for suite in testsuites:
-                        for case in suite:
-                            if not first:
-                                yield ','
-                            first = False
-                            count += 1
-
-                            yield json.dumps(CaseEvent.from_case_and_suite(self.path_builder, case, suite, p))
+                    try:
+                        # To understand JUnit XML format, https://llg.cubic.org/docs/junit/ is helpful
+                        # TODO: robustness: what's the best way to deal with broken XML file, if any?
+                        xml = JUnitXml.fromfile(p, self.junitxml_parse_func)
+                        if isinstance(xml, JUnitXml):
+                            testsuites = [suite for suite in xml]
+                        elif isinstance(xml, TestSuite):
+                            testsuites = [xml]
+                        else:
+                            # TODO: what is a Pythonesque way to do this?
+                            assert False
+
+                        for suite in testsuites:
+                            for case in suite:
+                                if not first:
+                                    yield ','
+                                first = False
+                                count += 1
+
+                                yield json.dumps(CaseEvent.from_case_and_suite(self.path_builder, case, suite, p))
+                    except Exception as e:
+                        raise Exception("Failed to process a report file: %s" % p) from e
                 yield ']}'
 
             def printer(f):
@@ -171,7 +174,7 @@ def printer(f):
                 res.raise_for_status()
                 res = client.request("patch", "{}/close".format(session_id), headers=headers)
                 res.raise_for_status()
-                click.echo("Processed {} tests".format(count))
+                click.echo("Recorded {} tests".format(count))
                 if count==0:
                     click.echo(click.style("Looks like tests didn't run? If not, make sure the right files/directories are passed",'yellow'))
             except Exception as e:

tests/commands/record/test_tests.py

@@ -0,0 +1,21 @@
+from pathlib import Path
+import responses, traceback
+
+from tests.cli_test_case import CliTestCase
+
+
+class TestsTest(CliTestCase):
+
+    @responses.activate
+    def test_filename_in_error_message(self):
+        broken_xml = str(Path(__file__).parent.joinpath('../../data/broken.xml').resolve())
+        self.cli('record', 'tests', '--build', self.build_name, 'file', broken_xml)
+        # mock doesn't evaluate generator so we need to do so here
+        g = responses.calls[1].request.body
+        try:
+            b''.join(g)
+        except Exception as e:
+            # making sure the offending file path name is being printed.
+            self.assertIn(broken_xml, traceback.format_exc())
+        else:
+            self.fail("Expected to see an error")

tests/data/broken.xml

@@ -0,0 +1 @@
+this is not an XML!