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

…-error Classify autobuild errors as configuration errors
github · Jul 22, 2024 · ea8137f · ea8137f
2 parents 44534b7 + b516521
commit ea8137f
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 6 deletions.
diff --git a/lib/cli-errors.js b/lib/cli-errors.js
diff --git a/lib/cli-errors.js.map b/lib/cli-errors.js.map
diff --git a/lib/codeql.test.js b/lib/codeql.test.js
diff --git a/lib/codeql.test.js.map b/lib/codeql.test.js.map
diff --git a/src/cli-errors.ts b/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"),

diff --git a/src/codeql.test.ts b/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 " +