Bump verbosity of database finalize in debug mode

github · Mar 13, 2024 · 070b051 · 070b051
1 parent 649f3e8
commit 070b051
Show file tree

Hide file tree

Showing 9 changed files with 39 additions and 15 deletions.
diff --git a/lib/analyze.js b/lib/analyze.js
diff --git a/lib/analyze.js.map b/lib/analyze.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/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/analyze.ts b/src/analyze.ts
@@ -263,6 +263,7 @@ async function finalizeDatabaseCreation(
         util.getCodeQLDatabasePath(config, language),
         threadsFlag,
         memoryFlag,
+        config.debugMode,
       );
       logger.endGroup();
     }

diff --git a/src/codeql.test.ts b/src/codeql.test.ts
@@ -873,7 +873,7 @@ test("database finalize recognises JavaScript no code found error on CodeQL 2.11
   sinon.stub(safeWhich, "safeWhich").resolves("");
 
   await t.throwsAsync(
-    async () => await codeqlObject.finalizeDatabase("", "", ""),
+    async () => await codeqlObject.finalizeDatabase("", "", "", false),
     {
       instanceOf: util.ConfigurationError,
       message: new RegExp(
@@ -892,7 +892,7 @@ test("database finalize overrides no code found error on CodeQL 2.11.6", async (
   sinon.stub(safeWhich, "safeWhich").resolves("");
 
   await t.throwsAsync(
-    async () => await codeqlObject.finalizeDatabase("", "", ""),
+    async () => await codeqlObject.finalizeDatabase("", "", "", false),
     {
       instanceOf: util.ConfigurationError,
       message: new RegExp(
@@ -915,7 +915,12 @@ test("database finalize does not override no code found error on CodeQL 2.12.4",
 
   await t.throwsAsync(
     async () =>
-      await codeqlObject.finalizeDatabase("db", "--threads=2", "--ram=2048"),
+      await codeqlObject.finalizeDatabase(
+        "db",
+        "--threads=2",
+        "--ram=2048",
+        false,
+      ),
     {
       message:
         'Encountered a fatal error while running "codeql-for-testing database finalize --finalize-dataset --threads=2 --ram=2048 db". ' +
@@ -940,7 +945,12 @@ test("runTool summarizes several fatal errors", async (t) => {
 
   await t.throwsAsync(
     async () =>
-      await codeqlObject.finalizeDatabase("db", "--threads=2", "--ram=2048"),
+      await codeqlObject.finalizeDatabase(
+        "db",
+        "--threads=2",
+        "--ram=2048",
+        false,
+      ),
     {
       instanceOf: util.ConfigurationError,
       message: new RegExp(
@@ -967,7 +977,12 @@ test("runTool outputs last line of stderr if fatal error could not be found", as
 
   await t.throwsAsync(
     async () =>
-      await codeqlObject.finalizeDatabase("db", "--threads=2", "--ram=2048"),
+      await codeqlObject.finalizeDatabase(
+        "db",
+        "--threads=2",
+        "--ram=2048",
+        false,
+      ),
     {
       instanceOf: util.ConfigurationError,
       message: new RegExp(

diff --git a/src/codeql.ts b/src/codeql.ts
@@ -100,6 +100,7 @@ export interface CodeQL {
     databasePath: string,
     threadsFlag: string,
     memoryFlag: string,
+    enableDebugLogging: boolean,
   ): Promise<void>;
   /**
    * Run 'codeql resolve languages'.
@@ -715,13 +716,17 @@ export async function getCodeQLForCmd(
       databasePath: string,
       threadsFlag: string,
       memoryFlag: string,
+      enableDebugLogging: boolean,
     ) {
       const args = [
         "database",
         "finalize",
         "--finalize-dataset",
         threadsFlag,
         memoryFlag,
+        ...(enableDebugLogging
+          ? [`--verbosity=${EXTRACTION_DEBUG_MODE_VERBOSITY}`]
+          : []),
         ...getExtraOptionsFromEnv(["database", "finalize"]),
         databasePath,
       ];