Merge pull request #2201 from github/mergeback/v3.24.8-to-main-05963f47

Mergeback v3.24.8 refs/heads/releases/v3 into main

CHANGELOG.md

@@ -6,6 +6,10 @@ Note that the only difference between `v2` and `v3` of the CodeQL Action is the
 
 ## [UNRELEASED]
 
+No user facing changes.
+
+## 3.24.8 - 18 Mar 2024
+
 - Improve the ease of debugging extraction issues by increasing the verbosity of the extractor logs when running in debug mode. [#2195](https://github.com/github/codeql-action/pull/2195)
 
 ## 3.24.7 - 12 Mar 2024

lib/cli-errors.js

@@ -13,17 +13,30 @@ class CommandInvocationError extends Error {
             .map((x) => (x.includes(" ") ? `'${x}'` : x))
             .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;
+        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.`;
         }
-        super(`Encountered a fatal error while running "${prettyCommand}". ` +
-            `Exit code was ${exitCode}${error} 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(message);
         this.exitCode = exitCode;
         this.stderr = stderr;
         this.stdout = stdout;
@@ -88,26 +101,44 @@ function extractFatalErrors(error) {
     }
     return undefined;
 }
+function extractAutobuildErrors(error) {
+    const pattern = /.*\[autobuild\] \[ERROR\] (.*)/gi;
+    let errorLines = [...error.matchAll(pattern)].map((match) => match[1]);
+    // Truncate if there are more than 10 matching lines.
+    if (errorLines.length > 10) {
+        errorLines = errorLines.slice(0, 10);
+        errorLines.push("(truncated)");
+    }
+    return errorLines.join("\n") || undefined;
+}
 function ensureEndsInPeriod(text) {
     return text[text.length - 1] === "." ? text : `${text}.`;
 }
 /** Error messages from the CLI that we consider configuration errors and handle specially. */
 var CliConfigErrorCategory;
 (function (CliConfigErrorCategory) {
+    CliConfigErrorCategory["GradleBuildFailed"] = "GradleBuildFailed";
     CliConfigErrorCategory["IncompatibleWithActionVersion"] = "IncompatibleWithActionVersion";
     CliConfigErrorCategory["InitCalledTwice"] = "InitCalledTwice";
     CliConfigErrorCategory["InvalidSourceRoot"] = "InvalidSourceRoot";
+    CliConfigErrorCategory["MavenBuildFailed"] = "MavenBuildFailed";
     CliConfigErrorCategory["NoBuildCommandAutodetected"] = "NoBuildCommandAutodetected";
     CliConfigErrorCategory["NoBuildMethodAutodetected"] = "NoBuildMethodAutodetected";
     CliConfigErrorCategory["NoSourceCodeSeen"] = "NoSourceCodeSeen";
     CliConfigErrorCategory["NoSupportedBuildCommandSucceeded"] = "NoSupportedBuildCommandSucceeded";
     CliConfigErrorCategory["NoSupportedBuildSystemDetected"] = "NoSupportedBuildSystemDetected";
+    CliConfigErrorCategory["SwiftBuildFailed"] = "SwiftBuildFailed";
 })(CliConfigErrorCategory || (exports.CliConfigErrorCategory = CliConfigErrorCategory = {}));
 /**
  * All of our caught CLI error messages that we handle specially: ie. if we
  * would like to categorize an error as a configuration error or not.
  */
 exports.cliErrorsConfig = {
+    [CliConfigErrorCategory.GradleBuildFailed]: {
+        cliErrorMessageCandidates: [
+            new RegExp("[autobuild] FAILURE: Build failed with an exception."),
+        ],
+    },
     // Version of CodeQL CLI is incompatible with this version of the CodeQL Action
     [CliConfigErrorCategory.IncompatibleWithActionVersion]: {
         cliErrorMessageCandidates: [
@@ -124,6 +155,11 @@ exports.cliErrorsConfig = {
     [CliConfigErrorCategory.InvalidSourceRoot]: {
         cliErrorMessageCandidates: [new RegExp("Invalid source root")],
     },
+    [CliConfigErrorCategory.MavenBuildFailed]: {
+        cliErrorMessageCandidates: [
+            new RegExp("\\[autobuild\\] \\[ERROR\\] Failed to execute goal"),
+        ],
+    },
     [CliConfigErrorCategory.NoBuildCommandAutodetected]: {
         cliErrorMessageCandidates: [
             new RegExp("Could not auto-detect a suitable build method"),
@@ -162,6 +198,11 @@ exports.cliErrorsConfig = {
             new RegExp("No supported build system detected"),
         ],
     },
+    [CliConfigErrorCategory.SwiftBuildFailed]: {
+        cliErrorMessageCandidates: [
+            new RegExp("\\[autobuilder/build\\] \\[build-command-failed\\] `autobuild` failed to run the build command"),
+        ],
+    },
 };
 /**
  * Check if the given CLI error or exit code, if applicable, apply to any known

lib/codeql.test.js

@@ -37,6 +37,7 @@ const yaml = __importStar(require("js-yaml"));
 const nock_1 = __importDefault(require("nock"));
 const sinon = __importStar(require("sinon"));
 const actionsUtil = __importStar(require("./actions-util"));
+const cli_errors_1 = require("./cli-errors");
 const codeql = __importStar(require("./codeql"));
 const defaults = __importStar(require("./defaults.json"));
 const languages_1 = require("./languages");
@@ -600,6 +601,51 @@ for (const { codeqlVersion, flagPassed, githubVersion, negativeFlagPassed, } of
             `Exit code was 32 and error was: ${datasetImportError.replaceAll(".", "\\.")}\\. Context: ${heapError.replaceAll(".", "\\.")}\\. See the logs for more details\\.`),
     });
 });
+(0, ava_1.default)("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((0, testing_utils_1.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(languages_1.Language.java, false), {
+        instanceOf: cli_errors_1.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.",
+    });
+});
+(0, ava_1.default)("runTool truncates long autobuilder errors", async (t) => {
+    const stderr = Array.from({ length: 20 }, (_, i) => `[2019-09-18 12:00:00] [autobuild] [ERROR] line${i + 1}`).join("\n");
+    stubToolRunnerConstructor(1, stderr);
+    const codeqlObject = await codeql.getCodeQLForTesting();
+    sinon.stub(codeqlObject, "getVersion").resolves((0, testing_utils_1.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(languages_1.Language.java, false), {
+        instanceOf: cli_errors_1.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: " +
+            `${Array.from({ length: 10 }, (_, i) => `line${i + 1}`).join("\n")}\n(truncated)`,
+    });
+});
 (0, ava_1.default)("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);

node_modules/.package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "codeql",
-  "version": "3.24.8",
+  "version": "3.24.9",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "codeql",
-  "version": "3.24.8",
+  "version": "3.24.9",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "codeql",
-      "version": "3.24.8",
+      "version": "3.24.9",
       "license": "MIT",
       "dependencies": {
         "@actions/artifact": "^1.1.2",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeql",
-  "version": "3.24.8",
+  "version": "3.24.9",
   "private": true,
   "description": "CodeQL action",
   "scripts": {

src/cli-errors.ts

@@ -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,20 +107,34 @@ function extractFatalErrors(error: string): string | undefined {
   return undefined;
 }
 
+function extractAutobuildErrors(error: string): string | undefined {
+  const pattern = /.*\[autobuild\] \[ERROR\] (.*)/gi;
+  let errorLines = [...error.matchAll(pattern)].map((match) => match[1]);
+  // Truncate if there are more than 10 matching lines.
+  if (errorLines.length > 10) {
+    errorLines = errorLines.slice(0, 10);
+    errorLines.push("(truncated)");
+  }
+  return errorLines.join("\n") || undefined;
+}
+
 function ensureEndsInPeriod(text: string): string {
   return text[text.length - 1] === "." ? text : `${text}.`;
 }
 
 /** Error messages from the CLI that we consider configuration errors and handle specially. */
 export enum CliConfigErrorCategory {
+  GradleBuildFailed = "GradleBuildFailed",
   IncompatibleWithActionVersion = "IncompatibleWithActionVersion",
   InitCalledTwice = "InitCalledTwice",
   InvalidSourceRoot = "InvalidSourceRoot",
+  MavenBuildFailed = "MavenBuildFailed",
   NoBuildCommandAutodetected = "NoBuildCommandAutodetected",
   NoBuildMethodAutodetected = "NoBuildMethodAutodetected",
   NoSourceCodeSeen = "NoSourceCodeSeen",
   NoSupportedBuildCommandSucceeded = "NoSupportedBuildCommandSucceeded",
   NoSupportedBuildSystemDetected = "NoSupportedBuildSystemDetected",
+  SwiftBuildFailed = "SwiftBuildFailed",
 }
 
 type CliErrorConfiguration = {
@@ -127,6 +152,11 @@ export const cliErrorsConfig: Record<
   CliConfigErrorCategory,
   CliErrorConfiguration
 > = {
+  [CliConfigErrorCategory.GradleBuildFailed]: {
+    cliErrorMessageCandidates: [
+      new RegExp("[autobuild] FAILURE: Build failed with an exception."),
+    ],
+  },
   // Version of CodeQL CLI is incompatible with this version of the CodeQL Action
   [CliConfigErrorCategory.IncompatibleWithActionVersion]: {
     cliErrorMessageCandidates: [
@@ -145,6 +175,11 @@ export const cliErrorsConfig: Record<
   [CliConfigErrorCategory.InvalidSourceRoot]: {
     cliErrorMessageCandidates: [new RegExp("Invalid source root")],
   },
+  [CliConfigErrorCategory.MavenBuildFailed]: {
+    cliErrorMessageCandidates: [
+      new RegExp("\\[autobuild\\] \\[ERROR\\] Failed to execute goal"),
+    ],
+  },
   [CliConfigErrorCategory.NoBuildCommandAutodetected]: {
     cliErrorMessageCandidates: [
       new RegExp("Could not auto-detect a suitable build method"),
@@ -190,6 +225,13 @@ export const cliErrorsConfig: Record<
       new RegExp("No supported build system detected"),
     ],
   },
+  [CliConfigErrorCategory.SwiftBuildFailed]: {
+    cliErrorMessageCandidates: [
+      new RegExp(
+        "\\[autobuilder/build\\] \\[build-command-failed\\] `autobuild` failed to run the build command",
+      ),
+    ],
+  },
 };
 
 /**

src/codeql.test.ts

@@ -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,68 @@ 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 truncates long autobuilder errors", async (t) => {
+  const stderr = Array.from(
+    { length: 20 },
+    (_, i) => `[2019-09-18 12:00:00] [autobuild] [ERROR] line${i + 1}`,
+  ).join("\n");
+  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: " +
+        `${Array.from({ length: 10 }, (_, i) => `line${i + 1}`).join(
+          "\n",
+        )}\n(truncated)`,
+    },
+  );
+});
+
 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);