util/scanner: add UnitTestScanner.num_of_total_failures

In UnitTestScanner's final error message, add total count of failures before the first error occurance, like "(total x failed) <message>". Another minor change: add "..." if the failure reason is more than 200 chars. Signed-off-by: Vallari Agrawal <[email protected]>
ceph · Nov 27, 2023 · fec6e47 · fec6e47
1 parent bfbd419
commit fec6e47
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 4 deletions.
diff --git a/teuthology/util/scanner.py b/teuthology/util/scanner.py
@@ -89,7 +89,7 @@ def _parse(self, file_content: str) -> Tuple[Optional[str], Optional[dict]]:
                 if child.tag in ['failure', 'error']:
                     fault_kind = child.tag
                     reason = child.get('message', 'No message found in xml output, check logs.')
-                    short_reason = reason[:200]
+                    short_reason = (reason[:200].strip() + '...') if len(reason) > 200 else reason.strip()
                     error_data[testcase_suitename] += [{
                             "kind": fault_kind, 
                             "testcase": testcase_name,
@@ -99,7 +99,16 @@ def _parse(self, file_content: str) -> Tuple[Optional[str], Optional[dict]]:
                         exception_txt = f'{fault_kind.upper()}: Test `{testcase_name}` of `{testcase_suitename}`. Reason: {short_reason}.'
 
         return exception_txt, { "failed_testsuites": dict(error_data), "num_of_failures": len(failed_testcases) }
-
+
+    @property
+    def num_of_total_failures(self):
+        total_failed_testcases = 0
+        if self.summary_data:
+            for file_data in self.summary_data:
+                failed_tests = file_data.get("num_of_failures", 0)
+                total_failed_testcases += failed_tests
+        return total_failed_testcases
+
     def scan_and_write(self, path_regex: str, summary_path: str) -> Optional[str]:
         """
         Scan all files matching 'path_regex'
@@ -109,7 +118,8 @@ def scan_and_write(self, path_regex: str, summary_path: str) -> Optional[str]:
             errors = self.scan_all_files(path_regex)
             self.write_summary(summary_path)
             if errors:
-                return errors[0]
+                count = self.num_of_total_failures
+                return f"(total {count} failed) " + errors[0]
         except Exception as scanner_exc:
             log.error(str(scanner_exc))
 

diff --git a/teuthology/util/test/test_scanner.py b/teuthology/util/test/test_scanner.py
@@ -44,7 +44,7 @@ def test_scan_and_write(self, m_write_summary):
         m_open.return_value = open(xml_path, "rb")
         self.remote._sftp_open_file = m_open
         result = UnitTestScanner(remote=self.remote).scan_and_write(xml_path, "test_summary.yaml")
-        assert result == self.test_values["error_msg"]
+        assert result == "(total 1 failed) " + self.test_values["error_msg"]
 
     def test_parse(self):
         xml_content = b'<?xml version="1.0" encoding="UTF-8"?>\n<testsuite name="xyz" tests="1" \