Add common CLI configuration error categories

.github/workflows/debug-artifacts-failure.yml

@@ -65,7 +65,7 @@ jobs:
         shell: bash
         run: |
           LANGUAGES="cpp csharp go java javascript python"
-          pushd "./my-debug-artifacts"
+          cd "./my-debug-artifacts"
           echo "Artifacts from run:"
           for language in $LANGUAGES; do
             echo "- Checking $language"
@@ -82,6 +82,5 @@ jobs:
               exit 1
             fi
           done
-          popd
         env:
           GO111MODULE: auto

src/cli-errors.ts

@@ -99,13 +99,20 @@ function ensureEndsInPeriod(text: string): string {
 
 /** Error messages from the CLI that we consider configuration errors and handle specially. */
 export enum CliConfigErrorCategory {
+  DetectedCodeButCouldNotProcess = "DetectedCodeButCouldNotProcess",
   IncompatibleWithActionVersion = "IncompatibleWithActionVersion",
   InitCalledTwice = "InitCalledTwice",
   InvalidSourceRoot = "InvalidSourceRoot",
   NoJavaScriptTypeScriptCodeFound = "NoJavaScriptTypeScriptCodeFound",
+  NoBuildCommandAutodetected = "NoBuildCommandAutodetected",
+  NoBuildMethodAutodetected = "NoBuildMethodAutodetected",
+  NoSupportedBuildCommandSucceeded = "NoSupportedBuildCommandSucceeded",
+  NoSupportedBuildSystemDetected = "NoSupportedBuildSystemDetected",
+  NoSupportedLanguagesDetected = "NoSupportedLanguagesDetected",
 }
 
 type CliErrorConfiguration = {
+  // All of these snippets should be present to match to a specific CliConfigErrorCategory.
   cliErrorMessageSnippets: string[];
   exitCode?: number;
   // Error message to prepend for this type of CLI error.
@@ -121,6 +128,18 @@ export const cliErrorsConfig: Record<
   CliConfigErrorCategory,
   CliErrorConfiguration
 > = {
+  // Usually when a manual build script has failed, or if an autodetected language
+  // was unintended to have CodeQL analysis run on it.
+  [CliConfigErrorCategory.DetectedCodeButCouldNotProcess]: {
+    exitCode: 32,
+    cliErrorMessageSnippets: [
+      "CodeQL detected code written in",
+      "but could not process any of it",
+    ],
+    additionalErrorMessageToPrepend:
+      "No code found during the build. Please see: " +
+      "https://gh.io/troubleshooting-code-scanning/no-source-code-seen-during-build.",
+  },
   // Version of CodeQL CLI is incompatible with this version of the CodeQL Action
   [CliConfigErrorCategory.IncompatibleWithActionVersion]: {
     cliErrorMessageSnippets: ["is not compatible with this CodeQL CLI"],
@@ -145,12 +164,30 @@ export const cliErrorsConfig: Record<
    * This can be removed once support for CodeQL 2.11.6 is removed.
    */
   [CliConfigErrorCategory.NoJavaScriptTypeScriptCodeFound]: {
-    exitCode: 32,
     cliErrorMessageSnippets: ["No JavaScript or TypeScript code found."],
     additionalErrorMessageToPrepend:
       "No code found during the build. Please see: " +
       "https://gh.io/troubleshooting-code-scanning/no-source-code-seen-during-build.",
   },
+  [CliConfigErrorCategory.NoBuildCommandAutodetected]: {
+    cliErrorMessageSnippets: ["Could not auto-detect a suitable build method"],
+  },
+  [CliConfigErrorCategory.NoBuildMethodAutodetected]: {
+    cliErrorMessageSnippets: [
+      "Could not detect a suitable build command for the source checkout",
+    ],
+  },
+  [CliConfigErrorCategory.NoSupportedBuildCommandSucceeded]: {
+    cliErrorMessageSnippets: ["No supported build command succeeded"],
+  },
+  [CliConfigErrorCategory.NoSupportedBuildSystemDetected]: {
+    cliErrorMessageSnippets: ["No supported build system detected"],
+  },
+  [CliConfigErrorCategory.NoSupportedLanguagesDetected]: {
+    cliErrorMessageSnippets: [
+      "CodeQL did not detect any code written in languages supported by CodeQL",
+    ],
+  },
 };
 
 // Check if the given CLI error or exit code, if applicable, apply to any known

src/codeql.ts

@@ -284,6 +284,8 @@ const GHES_VERSION_MOST_RECENTLY_DEPRECATED = "3.7";
 const GHES_MOST_RECENT_DEPRECATION_DATE = "2023-11-08";
 
 /*
+ * Deprecated in favor of ToolsFeature.
+ *
  * Versions of CodeQL that version-flag certain functionality in the Action.
  * For convenience, please keep these in descending order. Once a version
  * flag is older than the oldest supported version above, it may be removed.
@@ -670,7 +672,14 @@ export async function getCodeQLForCmd(
       // When `DYLD_INSERT_LIBRARIES` is set in the environment for a step,
       // the Actions runtime introduces its own workaround for SIP
       // (https://github.com/actions/runner/pull/416).
-      await runTool(autobuildCmd);
+      try {
+        await runTool(autobuildCmd);
+      } catch (e) {
+        if (e instanceof Error) {
+          throw wrapCliConfigurationError(e);
+        }
+        throw e;
+      }
     },
     async extractScannedLanguage(config: Config, language: Language) {
       await runTool(cmd, [