import * as fs from "fs"; import * as os from "os"; import test from "ava"; import { getRunnerLogger } from "./logging"; import { setupTests } from "./testing-utils"; import * as util from "./util"; setupTests(test); test("getToolNames", (t) => { const input = fs.readFileSync( `${__dirname}/../src/testdata/tool-names.sarif`, "utf8" ); 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 = [ [undefined, `--ram=${totalMem - 256}`], ["", `--ram=${totalMem - 256}`], ["512", "--ram=512"], ]; for (const [input, expectedFlag] of tests) { const flag = util.getMemoryFlag(input); t.deepEqual(flag, expectedFlag); } }); test("getMemoryFlag() throws if the ram input is < 0 or NaN", (t) => { for (const input of ["-1", "hello!"]) { t.throws(() => util.getMemoryFlag(input)); } }); test("getAddSnippetsFlag() should return the correct flag", (t) => { t.deepEqual(util.getAddSnippetsFlag(true), "--sarif-add-snippets"); t.deepEqual(util.getAddSnippetsFlag("true"), "--sarif-add-snippets"); t.deepEqual(util.getAddSnippetsFlag(false), "--no-sarif-add-snippets"); t.deepEqual(util.getAddSnippetsFlag(undefined), "--no-sarif-add-snippets"); t.deepEqual(util.getAddSnippetsFlag("false"), "--no-sarif-add-snippets"); t.deepEqual(util.getAddSnippetsFlag("foo bar"), "--no-sarif-add-snippets"); }); test("getThreadsFlag() should return the correct --threads flag", (t) => { const numCpus = os.cpus().length; const tests = [ ["0", "--threads=0"], ["1", "--threads=1"], [undefined, `--threads=${numCpus}`], ["", `--threads=${numCpus}`], [`${numCpus + 1}`, `--threads=${numCpus}`], [`${-numCpus - 1}`, `--threads=${-numCpus}`], ]; for (const [input, expectedFlag] of tests) { const flag = util.getThreadsFlag(input, getRunnerLogger(true)); t.deepEqual(flag, expectedFlag); } }); test("getThreadsFlag() throws if the threads input is not an integer", (t) => { t.throws(() => util.getThreadsFlag("hello!", getRunnerLogger(true))); }); test("isLocalRun() runs correctly", (t) => { process.env.CODEQL_LOCAL_RUN = ""; t.assert(!util.isLocalRun()); process.env.CODEQL_LOCAL_RUN = "false"; t.assert(!util.isLocalRun()); process.env.CODEQL_LOCAL_RUN = "0"; t.assert(!util.isLocalRun()); process.env.CODEQL_LOCAL_RUN = "true"; t.assert(util.isLocalRun()); process.env.CODEQL_LOCAL_RUN = "hucairz"; t.assert(util.isLocalRun()); }); test("getExtraOptionsEnvParam() succeeds on valid JSON with invalid options (for now)", (t) => { const origExtraOptions = process.env.CODEQL_ACTION_EXTRA_OPTIONS; const options = { foo: 42 }; process.env.CODEQL_ACTION_EXTRA_OPTIONS = JSON.stringify(options); t.deepEqual(util.getExtraOptionsEnvParam(), <any>options); process.env.CODEQL_ACTION_EXTRA_OPTIONS = origExtraOptions; }); test("getExtraOptionsEnvParam() succeeds on valid options", (t) => { const origExtraOptions = process.env.CODEQL_ACTION_EXTRA_OPTIONS; const options = { database: { init: ["--debug"] } }; process.env.CODEQL_ACTION_EXTRA_OPTIONS = JSON.stringify(options); t.deepEqual(util.getExtraOptionsEnvParam(), options); process.env.CODEQL_ACTION_EXTRA_OPTIONS = origExtraOptions; }); test("getExtraOptionsEnvParam() fails on invalid JSON", (t) => { const origExtraOptions = process.env.CODEQL_ACTION_EXTRA_OPTIONS; process.env.CODEQL_ACTION_EXTRA_OPTIONS = "{{invalid-json}}"; t.throws(util.getExtraOptionsEnvParam); process.env.CODEQL_ACTION_EXTRA_OPTIONS = origExtraOptions; }); test("parseGithubUrl", (t) => { t.deepEqual(util.parseGithubUrl("github.com"), "https://github.com"); t.deepEqual(util.parseGithubUrl("https://github.com"), "https://github.com"); t.deepEqual( util.parseGithubUrl("https://api.github.com"), "https://github.com" ); t.deepEqual( util.parseGithubUrl("https://github.com/foo/bar"), "https://github.com" ); t.deepEqual( util.parseGithubUrl("github.example.com"), "https://github.example.com/" ); t.deepEqual( util.parseGithubUrl("https://github.example.com"), "https://github.example.com/" ); t.deepEqual( util.parseGithubUrl("https://api.github.example.com"), "https://github.example.com/" ); t.deepEqual( util.parseGithubUrl("https://github.example.com/api/v3"), "https://github.example.com/" ); t.deepEqual( util.parseGithubUrl("https://github.example.com:1234"), "https://github.example.com:1234/" ); t.deepEqual( util.parseGithubUrl("https://api.github.example.com:1234"), "https://github.example.com:1234/" ); t.deepEqual( util.parseGithubUrl("https://github.example.com:1234/api/v3"), "https://github.example.com:1234/" ); t.deepEqual( util.parseGithubUrl("https://github.example.com/base/path"), "https://github.example.com/base/path/" ); t.deepEqual( util.parseGithubUrl("https://github.example.com/base/path/api/v3"), "https://github.example.com/base/path/" ); t.throws(() => util.parseGithubUrl(""), { message: '"" is not a valid URL', }); t.throws(() => util.parseGithubUrl("ssh://github.com"), { message: '"ssh://github.com" is not a http or https URL', }); t.throws(() => util.parseGithubUrl("http:///::::433"), { message: '"http:///::::433" is not a valid URL', }); });