Surface autobuild errors from stderr stream

github · henrymercer · Mar 18, 2024 · Mar 12, 2024 · Mar 12, 2024 · Mar 12, 2024
commit 88b28eb70de0ce90819beb741e488921e89177e1
@@ -20,20 +20,31 @@ export class CommandInvocationError extends Error {
       .join(" ");
 
     const fatalErrors = extractFatalErrors(stderr);
-    const lastLine = stderr.trim().split("\n").pop()?.trim();
-    let error = fatalErrors
-      ? ` and error was: ${fatalErrors.trim()}`
-      : lastLine
-      ? ` and last log line was: ${lastLine}`
-      : "";
-    if (error[error.length - 1] !== ".") {
-      error += ".";
+    const autobuildErrors = extractAutobuildErrors(stderr);
+    let message: string;
+
+    if (fatalErrors) {
+      message =
+        `Encountered a fatal error while running "${prettyCommand}". ` +
+        `Exit code was ${exitCode} and error was: ${fatalErrors.trim()} See the logs for more details.`;
+    } else if (autobuildErrors) {
+      const autobuildHelpLink =
+        "https://docs.github.com/en/code-security/code-scanning/troubleshooting-code-scanning/automatic-build-failed";
+      message =
+        "We were unable to automatically build your code. Please provide manual build steps. " +
+        `For more information, see ${autobuildHelpLink}. ` +
+        `Encountered the following error: ${autobuildErrors}`;
+    } else {
+      let lastLine = stderr.trim().split("\n").pop()?.trim() || "";
+      if (lastLine[lastLine.length - 1] !== ".") {
+        lastLine += ".";
+      }
+      message =
+        `Encountered a fatal error while running "${prettyCommand}". ` +
+        `Exit code was ${exitCode} and last log line was: ${lastLine} See the logs for more details.`;
     }
 
-    super(
-      `Encountered a fatal error while running "${prettyCommand}". ` +
-        `Exit code was ${exitCode}${error} See the logs for more details.`,
-    );
+    super(message);
   }
 }
 
@@ -96,6 +107,14 @@ function extractFatalErrors(error: string): string | undefined {
   return undefined;
 }
 
+function extractAutobuildErrors(error: string): string | undefined {
+  const pattern = /.*\[autobuild\] \[ERROR\] (.*)/gi;
+  return (
+    [...error.matchAll(pattern)].map((match) => match[1]).join("\n") ||
+    undefined
+  );
+}
+
 function ensureEndsInPeriod(text: string): string {
   return text[text.length - 1] === "." ? text : `${text}.`;
 }

@@ -12,6 +12,7 @@ import * as sinon from "sinon";
 
 import * as actionsUtil from "./actions-util";
 import { GitHubApiDetails } from "./api-client";
+import { CommandInvocationError } from "./cli-errors";
 import * as codeql from "./codeql";
 import { AugmentationProperties, Config } from "./config-utils";
 import * as defaults from "./defaults.json";
@@ -967,6 +968,40 @@ test("runTool summarizes several fatal errors", async (t) => {
   );
 });
 
+test("runTool summarizes autobuilder errors", async (t) => {
+  const stderr = `
+    [2019-09-18 12:00:00] [autobuild] A non-error message
+    [2019-09-18 12:00:00] Untagged message
+    [2019-09-18 12:00:00] [autobuild] [ERROR] Start of the error message
+    [2019-09-18 12:00:00] [autobuild] An interspersed non-error message
+    [2019-09-18 12:00:01] [autobuild] [ERROR]   Some more context about the error message
+    [2019-09-18 12:00:01] [autobuild] [ERROR]   continued
+    [2019-09-18 12:00:01] [autobuild] [ERROR]   and finished here.
+    [2019-09-18 12:00:01] [autobuild] A non-error message
+  `;
+  stubToolRunnerConstructor(1, stderr);
+  const codeqlObject = await codeql.getCodeQLForTesting();
+  sinon.stub(codeqlObject, "getVersion").resolves(makeVersionInfo("2.12.4"));
+  sinon.stub(codeqlObject, "resolveExtractor").resolves("/path/to/extractor");
+  // safeWhich throws because of the test CodeQL object.
+  sinon.stub(safeWhich, "safeWhich").resolves("");
+
+  await t.throwsAsync(
+    async () => await codeqlObject.runAutobuild(Language.java, false),
+    {
+      instanceOf: CommandInvocationError,
+      message:
+        "We were unable to automatically build your code. Please provide manual build steps. " +
+        "For more information, see " +
+        "https://docs.github.com/en/code-security/code-scanning/troubleshooting-code-scanning/automatic-build-failed. " +
+        "Encountered the following error: Start of the error message\n" +
+        "  Some more context about the error message\n" +
+        "  continued\n" +
+        "  and finished here.",
+    },
+  );
+});
+
 test("runTool outputs last line of stderr if fatal error could not be found", async (t) => {
   const cliStderr = "line1\nline2\nline3\nline4\nline5";
   stubToolRunnerConstructor(32, cliStderr);