feedback

Created using spr 1.3.6

Author: boomanaiden154

.ci/generate_test_report_lib.py

@@ -27,14 +27,16 @@ def _parse_ninja_log(ninja_log: list[str]) -> list[tuple[str, str]]:
             # We hit the end of the log without finding a build failure, go to
             # the next log.
             return failures
+        # index will point to the line that starts with Failed:. The progress
+        # indicator is the line before this and contains a pretty printed version
+        # of the target being built. We use this and remove the progress information
+        # to get a succinct name for the target.
         failing_action = ninja_log[index - 1].split("] ")[1]
         failure_log = []
         while (
             index < len(ninja_log)
             and not ninja_log[index].startswith("[")
-            and not ninja_log[index].startswith(
-                "ninja: build stopped: subcommand failed"
-            )
+            and not ninja_log[index].startswith("ninja: build stopped:")
             and len(failure_log) < NINJA_LOG_SIZE_THRESHOLD
         ):
             failure_log.append(ninja_log[index])
@@ -46,7 +48,7 @@ def _parse_ninja_log(ninja_log: list[str]) -> list[tuple[str, str]]:
 def find_failure_in_ninja_logs(ninja_logs: list[list[str]]) -> list[tuple[str, str]]:
     """Extracts failure messages from ninja output.
 
-    This patch takes stdout/stderr from ninja in the form of a list of files
+    This function takes stdout/stderr from ninja in the form of a list of files
     represented as a list of lines. This function then returns tuples containing
     the name of the target and the error message.
 
@@ -65,6 +67,25 @@ def find_failure_in_ninja_logs(ninja_logs: list[list[str]]) -> list[tuple[str, s
     return failures
 
 
+def _format_ninja_failures(ninja_failures: list[tuple[str, str]]) -> list[str]:
+    """Formats ninja failures into summary views for the report."""
+    output = []
+    for build_failure in ninja_failures:
+        failed_action, failure_message = build_failure
+        output.extend(
+            [
+                "<details>",
+                f"<summary>{failed_action}</summary>",
+                "",
+                "```",
+                failure_message,
+                "```",
+                "</details>",
+            ]
+        )
+    return output
+
+
 # Set size_limit to limit the byte size of the report. The default is 1MB as this
 # is the most that can be put into an annotation. If the generated report exceeds
 # this limit and failures are listed, it will be generated again without failures
@@ -129,24 +150,12 @@ def generate_report(
             else:
                 report.extend(
                     [
-                        "The build failed before running any tests. Click on the "
+                        "The build failed before running any tests. Click on a "
                         "failure below to see the details.",
                         "",
                     ]
                 )
-                for build_failure in ninja_failures:
-                    failed_action, failure_message = build_failure
-                    report.extend(
-                        [
-                            "<details>",
-                            f"<summary>{failed_action}</summary>",
-                            "",
-                            "```",
-                            failure_message,
-                            "```",
-                            "</details>",
-                        ]
-                    )
+                report.extend(_format_ninja_failures(ninja_failures))
                 report.extend(
                     [
                         "",
@@ -203,26 +212,14 @@ def plural(num_tests):
                 [
                     "",
                     "All tests passed but another part of the build **failed**. "
-                    "Detailed information about the build failure could not be "
-                    "automatically obtained.",
+                    "Information about the build failure could not be automatically "
+                    "obtained.",
                     "",
                     SEE_BUILD_FILE_STR,
                 ]
             )
         else:
-            for build_failure in ninja_failures:
-                failed_action, failure_message = build_failure
-                report.extend(
-                    [
-                        "<details>",
-                        f"<summary>{failed_action}</summary>",
-                        "",
-                        "```",
-                        failure_message,
-                        "```",
-                        "</details>",
-                    ]
-                )
+            report.extend(_format_ninja_failures(ninja_failures))
 
     if failures or return_code != 0:
         report.extend(["", UNRELATED_FAILURES_STR])

.ci/generate_test_report_lib_test.py

@@ -27,8 +27,7 @@ def test_find_failure_ninja_logs(self):
                     "[2/5] test/2.stamp",
                     "[3/5] test/3.stamp",
                     "[4/5] test/4.stamp",
-                    "FAILED: test/4.stamp",
-                    "touch test/4.stamp",
+                    "FAILED: touch test/4.stamp",
                     "Wow! This system is really broken!",
                     "[5/5] test/5.stamp",
                 ],
@@ -41,8 +40,7 @@ def test_find_failure_ninja_logs(self):
                 "test/4.stamp",
                 dedent(
                     """\
-                    FAILED: test/4.stamp
-                    touch test/4.stamp
+                    FAILED: touch test/4.stamp
                     Wow! This system is really broken!"""
                 ),
             ),
@@ -175,7 +173,7 @@ def test_title_only_failure_ninja_log(self):
                 """\
             # Foo
 
-            The build failed before running any tests. Click on the failure below to see the details.
+            The build failed before running any tests. Click on a failure below to see the details.
 
             <details>
             <summary>test/4.stamp</summary>
@@ -279,7 +277,7 @@ def test_no_failures_build_failed(self):
 
               * 1 test passed
 
-              All tests passed but another part of the build **failed**. Detailed information about the build failure could not be automatically obtained.
+              All tests passed but another part of the build **failed**. Information about the build failure could not be automatically obtained.
 
               Download the build's log file to see the details.