Permalink
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
codeql-action/lib/codeql.test.js
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Andrew Eisenberg
Add environment variables to signal feature and version to the CLI
This PR ensures environment variables are set before any invocation of the CLI. Here is a list of vars that are set: https://github.com/github/codeql-coreql-team/issues/1124#issuecomment-852463521 This ensures the CLI knows the features and versions of the containing actions/runner. Additionally: - Fix the user agent so that it more closely aligns with user agent spec - Refactor environment variable initialization so that it all happens in one place and call. - Move Mode, getRequiredEnvParam, setMode, getMode out of actions-util and into util. actions-util is meant for utils only called by the action, not the runner. The `prepareLocalRunEnvironment()` method is most likely deprecated and should be removed. I originally added it because I had a way of working where I would run the action from my local machine to test out changes, but this was always a little flaky. So, I no longer use this way of working. I will probably remove it soon.
208 lines (208 sloc)
11.4 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| "use strict"; | |
| var __importStar = (this && this.__importStar) || function (mod) { | |
| if (mod && mod.__esModule) return mod; | |
| var result = {}; | |
| if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k]; | |
| result["default"] = mod; | |
| return result; | |
| }; | |
| var __importDefault = (this && this.__importDefault) || function (mod) { | |
| return (mod && mod.__esModule) ? mod : { "default": mod }; | |
| }; | |
| Object.defineProperty(exports, "__esModule", { value: true }); | |
| const path = __importStar(require("path")); | |
| const toolcache = __importStar(require("@actions/tool-cache")); | |
| const ava_1 = __importDefault(require("ava")); | |
| const nock_1 = __importDefault(require("nock")); | |
| const codeql = __importStar(require("./codeql")); | |
| const defaults = __importStar(require("./defaults.json")); | |
| const logging_1 = require("./logging"); | |
| const testing_utils_1 = require("./testing-utils"); | |
| const util = __importStar(require("./util")); | |
| const util_1 = require("./util"); | |
| testing_utils_1.setupTests(ava_1.default); | |
| const sampleApiDetails = { | |
| auth: "token", | |
| url: "https://github.com", | |
| }; | |
| const sampleGHAEApiDetails = { | |
| auth: "token", | |
| url: "https://example.githubenterprise.com", | |
| }; | |
| ava_1.default.beforeEach(() => { | |
| util_1.initializeEnvironment(util_1.Mode.actions, "1.2.3"); | |
| }); | |
| ava_1.default("download codeql bundle cache", async (t) => { | |
| await util.withTmpDir(async (tmpDir) => { | |
| testing_utils_1.setupActionsVars(tmpDir, tmpDir); | |
| const versions = ["20200601", "20200610"]; | |
| for (let i = 0; i < versions.length; i++) { | |
| const version = versions[i]; | |
| nock_1.default("https://example.com") | |
| .get(`/download/codeql-bundle-${version}/codeql-bundle.tar.gz`) | |
| .replyWithFile(200, path.join(__dirname, `/../src/testdata/codeql-bundle.tar.gz`)); | |
| await codeql.setupCodeQL(`https://example.com/download/codeql-bundle-${version}/codeql-bundle.tar.gz`, sampleApiDetails, tmpDir, tmpDir, util.GitHubVariant.DOTCOM, logging_1.getRunnerLogger(true)); | |
| t.assert(toolcache.find("CodeQL", `0.0.0-${version}`)); | |
| } | |
| const cachedVersions = toolcache.findAllVersions("CodeQL"); | |
| t.is(cachedVersions.length, 2); | |
| }); | |
| }); | |
| ava_1.default("download codeql bundle cache explicitly requested with pinned different version cached", async (t) => { | |
| await util.withTmpDir(async (tmpDir) => { | |
| testing_utils_1.setupActionsVars(tmpDir, tmpDir); | |
| nock_1.default("https://example.com") | |
| .get(`/download/codeql-bundle-20200601/codeql-bundle.tar.gz`) | |
| .replyWithFile(200, path.join(__dirname, `/../src/testdata/codeql-bundle-pinned.tar.gz`)); | |
| await codeql.setupCodeQL("https://example.com/download/codeql-bundle-20200601/codeql-bundle.tar.gz", sampleApiDetails, tmpDir, tmpDir, util.GitHubVariant.DOTCOM, logging_1.getRunnerLogger(true)); | |
| t.assert(toolcache.find("CodeQL", "0.0.0-20200601")); | |
| nock_1.default("https://example.com") | |
| .get(`/download/codeql-bundle-20200610/codeql-bundle.tar.gz`) | |
| .replyWithFile(200, path.join(__dirname, `/../src/testdata/codeql-bundle.tar.gz`)); | |
| await codeql.setupCodeQL("https://example.com/download/codeql-bundle-20200610/codeql-bundle.tar.gz", sampleApiDetails, tmpDir, tmpDir, util.GitHubVariant.DOTCOM, logging_1.getRunnerLogger(true)); | |
| t.assert(toolcache.find("CodeQL", "0.0.0-20200610")); | |
| }); | |
| }); | |
| ava_1.default("don't download codeql bundle cache with pinned different version cached", async (t) => { | |
| await util.withTmpDir(async (tmpDir) => { | |
| testing_utils_1.setupActionsVars(tmpDir, tmpDir); | |
| nock_1.default("https://example.com") | |
| .get(`/download/codeql-bundle-20200601/codeql-bundle.tar.gz`) | |
| .replyWithFile(200, path.join(__dirname, `/../src/testdata/codeql-bundle-pinned.tar.gz`)); | |
| await codeql.setupCodeQL("https://example.com/download/codeql-bundle-20200601/codeql-bundle.tar.gz", sampleApiDetails, tmpDir, tmpDir, util.GitHubVariant.DOTCOM, logging_1.getRunnerLogger(true)); | |
| t.assert(toolcache.find("CodeQL", "0.0.0-20200601")); | |
| await codeql.setupCodeQL(undefined, sampleApiDetails, tmpDir, tmpDir, util.GitHubVariant.DOTCOM, logging_1.getRunnerLogger(true)); | |
| const cachedVersions = toolcache.findAllVersions("CodeQL"); | |
| t.is(cachedVersions.length, 1); | |
| }); | |
| }); | |
| ava_1.default("download codeql bundle cache with different version cached (not pinned)", async (t) => { | |
| await util.withTmpDir(async (tmpDir) => { | |
| testing_utils_1.setupActionsVars(tmpDir, tmpDir); | |
| nock_1.default("https://example.com") | |
| .get(`/download/codeql-bundle-20200601/codeql-bundle.tar.gz`) | |
| .replyWithFile(200, path.join(__dirname, `/../src/testdata/codeql-bundle.tar.gz`)); | |
| await codeql.setupCodeQL("https://example.com/download/codeql-bundle-20200601/codeql-bundle.tar.gz", sampleApiDetails, tmpDir, tmpDir, util.GitHubVariant.DOTCOM, logging_1.getRunnerLogger(true)); | |
| t.assert(toolcache.find("CodeQL", "0.0.0-20200601")); | |
| const platform = process.platform === "win32" | |
| ? "win64" | |
| : process.platform === "linux" | |
| ? "linux64" | |
| : "osx64"; | |
| nock_1.default("https://github.com") | |
| .get(`/github/codeql-action/releases/download/${defaults.bundleVersion}/codeql-bundle-${platform}.tar.gz`) | |
| .replyWithFile(200, path.join(__dirname, `/../src/testdata/codeql-bundle.tar.gz`)); | |
| await codeql.setupCodeQL(undefined, sampleApiDetails, tmpDir, tmpDir, util.GitHubVariant.DOTCOM, logging_1.getRunnerLogger(true)); | |
| const cachedVersions = toolcache.findAllVersions("CodeQL"); | |
| t.is(cachedVersions.length, 2); | |
| }); | |
| }); | |
| ava_1.default('download codeql bundle cache with pinned different version cached if "latest" tools specified', async (t) => { | |
| await util.withTmpDir(async (tmpDir) => { | |
| testing_utils_1.setupActionsVars(tmpDir, tmpDir); | |
| nock_1.default("https://example.com") | |
| .get(`/download/codeql-bundle-20200601/codeql-bundle.tar.gz`) | |
| .replyWithFile(200, path.join(__dirname, `/../src/testdata/codeql-bundle-pinned.tar.gz`)); | |
| await codeql.setupCodeQL("https://example.com/download/codeql-bundle-20200601/codeql-bundle.tar.gz", sampleApiDetails, tmpDir, tmpDir, util.GitHubVariant.DOTCOM, logging_1.getRunnerLogger(true)); | |
| t.assert(toolcache.find("CodeQL", "0.0.0-20200601")); | |
| const platform = process.platform === "win32" | |
| ? "win64" | |
| : process.platform === "linux" | |
| ? "linux64" | |
| : "osx64"; | |
| nock_1.default("https://github.com") | |
| .get(`/github/codeql-action/releases/download/${defaults.bundleVersion}/codeql-bundle-${platform}.tar.gz`) | |
| .replyWithFile(200, path.join(__dirname, `/../src/testdata/codeql-bundle.tar.gz`)); | |
| await codeql.setupCodeQL("latest", sampleApiDetails, tmpDir, tmpDir, util.GitHubVariant.DOTCOM, logging_1.getRunnerLogger(true)); | |
| const cachedVersions = toolcache.findAllVersions("CodeQL"); | |
| t.is(cachedVersions.length, 2); | |
| }); | |
| }); | |
| ava_1.default("download codeql bundle from github ae endpoint", async (t) => { | |
| await util.withTmpDir(async (tmpDir) => { | |
| testing_utils_1.setupActionsVars(tmpDir, tmpDir); | |
| const bundleAssetID = 10; | |
| const platform = process.platform === "win32" | |
| ? "win64" | |
| : process.platform === "linux" | |
| ? "linux64" | |
| : "osx64"; | |
| const codeQLBundleName = `codeql-bundle-${platform}.tar.gz`; | |
| nock_1.default("https://example.githubenterprise.com") | |
| .get(`/api/v3/enterprise/code-scanning/codeql-bundle/find/${defaults.bundleVersion}`) | |
| .reply(200, { | |
| assets: { [codeQLBundleName]: bundleAssetID }, | |
| }); | |
| nock_1.default("https://example.githubenterprise.com") | |
| .get(`/api/v3/enterprise/code-scanning/codeql-bundle/download/${bundleAssetID}`) | |
| .reply(200, { | |
| url: `https://example.githubenterprise.com/github/codeql-action/releases/download/${defaults.bundleVersion}/${codeQLBundleName}`, | |
| }); | |
| nock_1.default("https://example.githubenterprise.com") | |
| .get(`/github/codeql-action/releases/download/${defaults.bundleVersion}/${codeQLBundleName}`) | |
| .replyWithFile(200, path.join(__dirname, `/../src/testdata/codeql-bundle-pinned.tar.gz`)); | |
| await codeql.setupCodeQL(undefined, sampleGHAEApiDetails, tmpDir, tmpDir, util.GitHubVariant.GHAE, logging_1.getRunnerLogger(true)); | |
| const cachedVersions = toolcache.findAllVersions("CodeQL"); | |
| t.is(cachedVersions.length, 1); | |
| }); | |
| }); | |
| ava_1.default("parse codeql bundle url version", (t) => { | |
| t.deepEqual(codeql.getCodeQLURLVersion("https://github.com/.../codeql-bundle-20200601/..."), "20200601"); | |
| }); | |
| ava_1.default("convert to semver", (t) => { | |
| const tests = { | |
| "20200601": "0.0.0-20200601", | |
| "20200601.0": "0.0.0-20200601.0", | |
| "20200601.0.0": "20200601.0.0", | |
| "1.2.3": "1.2.3", | |
| "1.2.3-alpha": "1.2.3-alpha", | |
| "1.2.3-beta.1": "1.2.3-beta.1", | |
| }; | |
| for (const [version, expectedVersion] of Object.entries(tests)) { | |
| try { | |
| const parsedVersion = codeql.convertToSemVer(version, logging_1.getRunnerLogger(true)); | |
| t.deepEqual(parsedVersion, expectedVersion); | |
| } | |
| catch (e) { | |
| t.fail(e.message); | |
| } | |
| } | |
| }); | |
| ava_1.default("getExtraOptions works for explicit paths", (t) => { | |
| t.deepEqual(codeql.getExtraOptions({}, ["foo"], []), []); | |
| t.deepEqual(codeql.getExtraOptions({ foo: [42] }, ["foo"], []), ["42"]); | |
| t.deepEqual(codeql.getExtraOptions({ foo: { bar: [42] } }, ["foo", "bar"], []), ["42"]); | |
| }); | |
| ava_1.default("getExtraOptions works for wildcards", (t) => { | |
| t.deepEqual(codeql.getExtraOptions({ "*": [42] }, ["foo"], []), ["42"]); | |
| }); | |
| ava_1.default("getExtraOptions works for wildcards and explicit paths", (t) => { | |
| const o1 = { "*": [42], foo: [87] }; | |
| t.deepEqual(codeql.getExtraOptions(o1, ["foo"], []), ["42", "87"]); | |
| const o2 = { "*": [42], foo: [87] }; | |
| t.deepEqual(codeql.getExtraOptions(o2, ["foo", "bar"], []), ["42"]); | |
| const o3 = { "*": [42], foo: { "*": [87], bar: [99] } }; | |
| const p = ["foo", "bar"]; | |
| t.deepEqual(codeql.getExtraOptions(o3, p, []), ["42", "87", "99"]); | |
| }); | |
| ava_1.default("getExtraOptions throws for bad content", (t) => { | |
| t.throws(() => codeql.getExtraOptions({ "*": 42 }, ["foo"], [])); | |
| t.throws(() => codeql.getExtraOptions({ foo: 87 }, ["foo"], [])); | |
| t.throws(() => codeql.getExtraOptions({ "*": [42], foo: { "*": 87, bar: [99] } }, ["foo", "bar"], [])); | |
| }); | |
| ava_1.default("getCodeQLActionRepository", (t) => { | |
| const logger = logging_1.getRunnerLogger(true); | |
| util_1.initializeEnvironment(util_1.Mode.actions, "1.2.3"); | |
| const repoActions = codeql.getCodeQLActionRepository(logger); | |
| t.deepEqual(repoActions, "github/codeql-action"); | |
| util_1.initializeEnvironment(util_1.Mode.runner, "1.2.3"); | |
| // isRunningLocalAction() === true | |
| delete process.env["GITHUB_ACTION_REPOSITORY"]; | |
| process.env["RUNNER_TEMP"] = path.dirname(__dirname); | |
| const repoLocalRunner = codeql.getCodeQLActionRepository(logger); | |
| t.deepEqual(repoLocalRunner, "github/codeql-action"); | |
| process.env["GITHUB_ACTION_REPOSITORY"] = "xxx/yyy"; | |
| const repoEnv = codeql.getCodeQLActionRepository(logger); | |
| t.deepEqual(repoEnv, "xxx/yyy"); | |
| }); | |
| //# sourceMappingURL=codeql.test.js.map |