Merge pull request #2382 from github/angelapwen/make-autobuild-config-error

Classify autobuild errors as configuration errors

lib/cli-errors.js

@@ -115,6 +115,7 @@ function ensureEndsInPeriod(text) {
 /** Error messages from the CLI that we consider configuration errors and handle specially. */
 var CliConfigErrorCategory;
 (function (CliConfigErrorCategory) {
+    CliConfigErrorCategory["AutobuildError"] = "AutobuildError";
     CliConfigErrorCategory["ExternalRepositoryCloneFailed"] = "ExternalRepositoryCloneFailed";
     CliConfigErrorCategory["GradleBuildFailed"] = "GradleBuildFailed";
     CliConfigErrorCategory["IncompatibleWithActionVersion"] = "IncompatibleWithActionVersion";
@@ -138,6 +139,11 @@ var CliConfigErrorCategory;
  * would like to categorize an error as a configuration error or not.
  */
 exports.cliErrorsConfig = {
+    [CliConfigErrorCategory.AutobuildError]: {
+        cliErrorMessageCandidates: [
+            new RegExp("We were unable to automatically build your code"),
+        ],
+    },
     [CliConfigErrorCategory.ExternalRepositoryCloneFailed]: {
         cliErrorMessageCandidates: [
             new RegExp("Failed to clone external Git repository"),

lib/codeql.test.js

@@ -574,7 +574,7 @@ for (const { codeqlVersion, flagPassed, githubVersion, negativeFlagPassed, } of
     // safeWhich throws because of the test CodeQL object.
     sinon.stub(safeWhich, "safeWhich").resolves("");
     await t.throwsAsync(async () => await codeqlObject.runAutobuild(stubConfig, languages_1.Language.java), {
-        instanceOf: cli_errors_1.CommandInvocationError,
+        instanceOf: util.ConfigurationError,
         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. " +
@@ -593,7 +593,7 @@ for (const { codeqlVersion, flagPassed, githubVersion, negativeFlagPassed, } of
     // safeWhich throws because of the test CodeQL object.
     sinon.stub(safeWhich, "safeWhich").resolves("");
     await t.throwsAsync(async () => await codeqlObject.runAutobuild(stubConfig, languages_1.Language.java), {
-        instanceOf: cli_errors_1.CommandInvocationError,
+        instanceOf: util.ConfigurationError,
         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. " +

src/cli-errors.ts

@@ -122,6 +122,7 @@ function ensureEndsInPeriod(text: string): string {
 
 /** Error messages from the CLI that we consider configuration errors and handle specially. */
 export enum CliConfigErrorCategory {
+  AutobuildError = "AutobuildError",
   ExternalRepositoryCloneFailed = "ExternalRepositoryCloneFailed",
   GradleBuildFailed = "GradleBuildFailed",
   IncompatibleWithActionVersion = "IncompatibleWithActionVersion",
@@ -156,6 +157,11 @@ export const cliErrorsConfig: Record<
   CliConfigErrorCategory,
   CliErrorConfiguration
 > = {
+  [CliConfigErrorCategory.AutobuildError]: {
+    cliErrorMessageCandidates: [
+      new RegExp("We were unable to automatically build your code"),
+    ],
+  },
   [CliConfigErrorCategory.ExternalRepositoryCloneFailed]: {
     cliErrorMessageCandidates: [
       new RegExp("Failed to clone external Git repository"),

src/codeql.test.ts

@@ -906,7 +906,7 @@ test("runTool summarizes autobuilder errors", async (t) => {
   await t.throwsAsync(
     async () => await codeqlObject.runAutobuild(stubConfig, Language.java),
     {
-      instanceOf: CommandInvocationError,
+      instanceOf: util.ConfigurationError,
       message:
         "We were unable to automatically build your code. Please provide manual build steps. " +
         "For more information, see " +
@@ -934,7 +934,7 @@ test("runTool truncates long autobuilder errors", async (t) => {
   await t.throwsAsync(
     async () => await codeqlObject.runAutobuild(stubConfig, Language.java),
     {
-      instanceOf: CommandInvocationError,
+      instanceOf: util.ConfigurationError,
       message:
         "We were unable to automatically build your code. Please provide manual build steps. " +
         "For more information, see " +