Bump verbosity when running autobuild script directly in debug mode

github · Mar 13, 2024 · 649f3e8 · 649f3e8
1 parent 362c407
commit 649f3e8
Show file tree

Hide file tree

Showing 9 changed files with 30 additions and 8 deletions.
diff --git a/lib/autobuild.js b/lib/autobuild.js
diff --git a/lib/autobuild.js.map b/lib/autobuild.js.map
diff --git a/lib/codeql.js b/lib/codeql.js
diff --git a/lib/codeql.js.map b/lib/codeql.js.map
diff --git a/lib/environment.js b/lib/environment.js
diff --git a/lib/environment.js.map b/lib/environment.js.map
diff --git a/src/autobuild.ts b/src/autobuild.ts
@@ -162,7 +162,7 @@ export async function runAutobuild(
   if (language === Language.cpp) {
     await setupCppAutobuild(codeQL, logger);
   }
-  await codeQL.runAutobuild(language);
+  await codeQL.runAutobuild(language, config.debugMode);
   if (language === Language.go) {
     core.exportVariable(EnvVar.DID_AUTOBUILD_GOLANG, "true");
   }

diff --git a/src/codeql.ts b/src/codeql.ts
@@ -82,7 +82,7 @@ export interface CodeQL {
   /**
    * Runs the autobuilder for the given language.
    */
-  runAutobuild(language: Language): Promise<void>;
+  runAutobuild(language: Language, enableDebugLogging: boolean): Promise<void>;
   /**
    * Extract code for a scanned language using 'codeql database trace-command'
    * and running the language extractor.
@@ -637,7 +637,7 @@ export async function getCodeQLForCmd(
         throw e;
       }
     },
-    async runAutobuild(language: Language) {
+    async runAutobuild(language: Language, enableDebugLogging: boolean) {
       const autobuildCmd = path.join(
         await this.resolveExtractor(language),
         "tools",
@@ -656,6 +656,12 @@ export async function getCodeQLForCmd(
         "-Dmaven.wagon.http.pool=false",
       ].join(" ");
 
+      // Bump the verbosity of the autobuild command if we're in debug mode
+      if (enableDebugLogging) {
+        process.env[EnvVar.CLI_VERBOSITY] =
+          process.env[EnvVar.CLI_VERBOSITY] || EXTRACTION_DEBUG_MODE_VERBOSITY;
+      }
+
       // On macOS, System Integrity Protection (SIP) typically interferes with
       // CodeQL build tracing of protected binaries.
       // The usual workaround is to prefix `$CODEQL_RUNNER` to build commands:

diff --git a/src/environment.ts b/src/environment.ts
@@ -11,6 +11,12 @@ export enum EnvVar {
   /** Whether the `autobuild` Action completes successfully. */
   AUTOBUILD_DID_COMPLETE_SUCCESSFULLY = "CODEQL_ACTION_AUTOBUILD_DID_COMPLETE_SUCCESSFULLY",
 
+  /**
+   * The verbosity level of the CLI. One of the following: `errors`, `warnings`, `progress`,
+   * `progress+`, `progress++`, `progress+++`.
+   */
+  CLI_VERBOSITY = "CODEQL_VERBOSITY",
+
   /** Whether the CodeQL Action has invoked the Go autobuilder. */
   DID_AUTOBUILD_GOLANG = "CODEQL_ACTION_DID_AUTOBUILD_GOLANG",