Merge remote-tracking branch 'origin/main' into only-output-on-failure

src/finalize-db.ts

@@ -2,7 +2,6 @@ import * as core from '@actions/core';
 import * as exec from '@actions/exec';
 import * as io from '@actions/io';
 import * as fs from 'fs';
-import * as os from 'os';
 import * as path from 'path';
 
 import * as configUtils from './config-utils';
@@ -32,23 +31,6 @@ function queryIsDisabled(language, query): boolean {
     .some(disabledQuery => query.endsWith(disabledQuery));
 }
 
-function getMemoryFlag(): string {
-  let memoryToUseMegaBytes: number;
-  const memoryToUseString = core.getInput("ram");
-  if (memoryToUseString) {
-    memoryToUseMegaBytes = Number(memoryToUseString);
-    if (Number.isNaN(memoryToUseMegaBytes) || memoryToUseMegaBytes <= 0) {
-      throw new Error("Invalid RAM setting \"" + memoryToUseString + "\", specified.");
-    }
-  } else {
-    const totalMemoryBytes = os.totalmem();
-    const totalMemoryMegaBytes = totalMemoryBytes / (1024 * 1024);
-    const systemReservedMemoryMegaBytes = 256;
-    memoryToUseMegaBytes = totalMemoryMegaBytes - systemReservedMemoryMegaBytes;
-  }
-  return "--ram=" + Math.floor(memoryToUseMegaBytes);
-}
-
 async function createdDBForScannedLanguages(codeqlCmd: string, databaseFolder: string) {
   const scannedLanguages = process.env[sharedEnv.CODEQL_ACTION_SCANNED_LANGUAGES];
   if (scannedLanguages) {
@@ -200,7 +182,8 @@ async function runQueries(codeqlCmd: string, databaseFolder: string, sarifFolder
     await exec.exec(codeqlCmd, [
       'database',
       'analyze',
-      getMemoryFlag(),
+      util.getMemoryFlag(),
+      util.getThreadsFlag(),
       path.join(databaseFolder, database),
       '--format=sarif-latest',
       '--output=' + sarifFile,

src/util.test.ts

@@ -1,5 +1,6 @@
 import test from 'ava';
 import * as fs from 'fs';
+import * as os from "os";
 
 import {silenceDebugOutput} from './testing-utils';
 import * as util from './util';
@@ -11,3 +12,55 @@ test('getToolNames', t => {
   const toolNames = util.getToolNames(input);
   t.deepEqual(toolNames, ["CodeQL command-line toolchain", "ESLint"]);
 });
+
+test('getMemoryFlag() should return the correct --ram flag', t => {
+
+  const totalMem = Math.floor(os.totalmem() / (1024 * 1024));
+
+  const tests = {
+    "": `--ram=${totalMem - 256}`,
+    "512": "--ram=512",
+  };
+
+  for (const [input, expectedFlag] of Object.entries(tests)) {
+
+    process.env['INPUT_RAM'] = input;
+
+    const flag = util.getMemoryFlag();
+    t.deepEqual(flag, expectedFlag);
+  }
+});
+
+test('getMemoryFlag() throws if the ram input is < 0 or NaN', t => {
+  for (const input of ["-1", "hello!"]) {
+    process.env['INPUT_RAM'] = input;
+    t.throws(util.getMemoryFlag);
+  }
+});
+
+test('getThreadsFlag() should return the correct --threads flag', t => {
+
+  const numCpus = os.cpus().length;
+
+  const tests = {
+    "0": "--threads=0",
+    "1": "--threads=1",
+    [`${numCpus + 1}`]: `--threads=${numCpus}`,
+    [`${-numCpus - 1}`]: `--threads=${-numCpus}`
+  };
+
+  for (const [input, expectedFlag] of Object.entries(tests)) {
+
+    process.env['INPUT_THREADS'] = input;
+
+    const flag = util.getThreadsFlag();
+    t.deepEqual(flag, expectedFlag);
+  }
+});
+
+test('getThreadsFlag() throws if the ram input is < 0 or NaN', t => {
+  for (const input of ["hello!"]) {
+    process.env['INPUT_THREADS'] = input;
+    t.throws(util.getThreadsFlag);
+  }
+});

src/util.ts

@@ -393,3 +393,52 @@ export async function withTmpDir<T>(body: (tmpDir: string) => Promise<T>): Promi
     fs.rmdirSync(tmpDir, { recursive: true });
     return result;
 }
+
+/**
+ * Get the codeql `--ram` flag as configured by the `ram` input. If no value was
+ * specified, the total available memory will be used minus 256 MB.
+ *
+ * @returns string
+ */
+export function getMemoryFlag(): string {
+    let memoryToUseMegaBytes: number;
+    const memoryToUseString = core.getInput("ram");
+    if (memoryToUseString) {
+        memoryToUseMegaBytes = Number(memoryToUseString);
+        if (Number.isNaN(memoryToUseMegaBytes) || memoryToUseMegaBytes <= 0) {
+            throw new Error("Invalid RAM setting \"" + memoryToUseString + "\", specified.");
+        }
+    } else {
+        const totalMemoryBytes = os.totalmem();
+        const totalMemoryMegaBytes = totalMemoryBytes / (1024 * 1024);
+        const systemReservedMemoryMegaBytes = 256;
+        memoryToUseMegaBytes = totalMemoryMegaBytes - systemReservedMemoryMegaBytes;
+    }
+    return "--ram=" + Math.floor(memoryToUseMegaBytes);
+}
+
+/**
+ * Get the codeql `--threads` value specified for the `threads` input. The value
+ * defaults to 1. The value will be capped to the number of available CPUs.
+ *
+ * @returns string
+ */
+export function getThreadsFlag(): string {
+    let numThreads = 1;
+    const numThreadsString = core.getInput("threads");
+    if (numThreadsString) {
+        numThreads = Number(numThreadsString);
+        if (Number.isNaN(numThreads)) {
+            throw new Error(`Invalid threads setting "${numThreadsString}", specified.`);
+        }
+        const maxThreads = os.cpus().length;
+        if (numThreads > maxThreads) {
+            numThreads = maxThreads;
+        }
+        const minThreads = -maxThreads;
+        if (numThreads < minThreads) {
+            numThreads = minThreads;
+        }
+    }
+    return `--threads=${numThreads}`;
+}