318 lines
11 KiB
TypeScript
318 lines
11 KiB
TypeScript
import * as fs from "fs";
|
|
import * as path from "path";
|
|
|
|
import test from "ava";
|
|
import * as sinon from "sinon";
|
|
|
|
import * as actionsutil from "./actions-util";
|
|
import { EnvVar } from "./environment";
|
|
import { setupActionsVars, setupTests } from "./testing-utils";
|
|
import { initializeEnvironment, withTmpDir } from "./util";
|
|
|
|
setupTests(test);
|
|
|
|
test("getRef() throws on the empty string", async (t) => {
|
|
process.env["GITHUB_REF"] = "";
|
|
await t.throwsAsync(actionsutil.getRef);
|
|
});
|
|
|
|
test("getRef() returns merge PR ref if GITHUB_SHA still checked out", async (t) => {
|
|
await withTmpDir(async (tmpDir: string) => {
|
|
setupActionsVars(tmpDir, tmpDir);
|
|
const expectedRef = "refs/pull/1/merge";
|
|
const currentSha = "a".repeat(40);
|
|
process.env["GITHUB_REF"] = expectedRef;
|
|
process.env["GITHUB_SHA"] = currentSha;
|
|
|
|
const callback = sinon.stub(actionsutil, "getCommitOid");
|
|
callback.withArgs("HEAD").resolves(currentSha);
|
|
|
|
const actualRef = await actionsutil.getRef();
|
|
t.deepEqual(actualRef, expectedRef);
|
|
callback.restore();
|
|
});
|
|
});
|
|
|
|
test("getRef() returns merge PR ref if GITHUB_REF still checked out but sha has changed (actions checkout@v1)", async (t) => {
|
|
await withTmpDir(async (tmpDir: string) => {
|
|
setupActionsVars(tmpDir, tmpDir);
|
|
const expectedRef = "refs/pull/1/merge";
|
|
process.env["GITHUB_REF"] = expectedRef;
|
|
process.env["GITHUB_SHA"] = "b".repeat(40);
|
|
const sha = "a".repeat(40);
|
|
|
|
const callback = sinon.stub(actionsutil, "getCommitOid");
|
|
callback.withArgs("refs/remotes/pull/1/merge").resolves(sha);
|
|
callback.withArgs("HEAD").resolves(sha);
|
|
|
|
const actualRef = await actionsutil.getRef();
|
|
t.deepEqual(actualRef, expectedRef);
|
|
callback.restore();
|
|
});
|
|
});
|
|
|
|
test("getRef() returns head PR ref if GITHUB_REF no longer checked out", async (t) => {
|
|
await withTmpDir(async (tmpDir: string) => {
|
|
setupActionsVars(tmpDir, tmpDir);
|
|
process.env["GITHUB_REF"] = "refs/pull/1/merge";
|
|
process.env["GITHUB_SHA"] = "a".repeat(40);
|
|
|
|
const callback = sinon.stub(actionsutil, "getCommitOid");
|
|
callback.withArgs(tmpDir, "refs/pull/1/merge").resolves("a".repeat(40));
|
|
callback.withArgs(tmpDir, "HEAD").resolves("b".repeat(40));
|
|
|
|
const actualRef = await actionsutil.getRef();
|
|
t.deepEqual(actualRef, "refs/pull/1/head");
|
|
callback.restore();
|
|
});
|
|
});
|
|
|
|
test("getRef() returns ref provided as an input and ignores current HEAD", async (t) => {
|
|
await withTmpDir(async (tmpDir: string) => {
|
|
setupActionsVars(tmpDir, tmpDir);
|
|
const getAdditionalInputStub = sinon.stub(actionsutil, "getOptionalInput");
|
|
getAdditionalInputStub.withArgs("ref").resolves("refs/pull/2/merge");
|
|
getAdditionalInputStub.withArgs("sha").resolves("b".repeat(40));
|
|
|
|
// These values are be ignored
|
|
process.env["GITHUB_REF"] = "refs/pull/1/merge";
|
|
process.env["GITHUB_SHA"] = "a".repeat(40);
|
|
|
|
const callback = sinon.stub(actionsutil, "getCommitOid");
|
|
callback.withArgs("refs/pull/1/merge").resolves("b".repeat(40));
|
|
callback.withArgs("HEAD").resolves("b".repeat(40));
|
|
|
|
const actualRef = await actionsutil.getRef();
|
|
t.deepEqual(actualRef, "refs/pull/2/merge");
|
|
callback.restore();
|
|
getAdditionalInputStub.restore();
|
|
});
|
|
});
|
|
|
|
test("getRef() returns CODE_SCANNING_REF as a fallback for GITHUB_REF", async (t) => {
|
|
await withTmpDir(async (tmpDir: string) => {
|
|
setupActionsVars(tmpDir, tmpDir);
|
|
const expectedRef = "refs/pull/1/HEAD";
|
|
const currentSha = "a".repeat(40);
|
|
process.env["CODE_SCANNING_REF"] = expectedRef;
|
|
process.env["GITHUB_REF"] = "";
|
|
process.env["GITHUB_SHA"] = currentSha;
|
|
|
|
const actualRef = await actionsutil.getRef();
|
|
t.deepEqual(actualRef, expectedRef);
|
|
});
|
|
});
|
|
|
|
test("getRef() returns GITHUB_REF over CODE_SCANNING_REF if both are provided", async (t) => {
|
|
await withTmpDir(async (tmpDir: string) => {
|
|
setupActionsVars(tmpDir, tmpDir);
|
|
const expectedRef = "refs/pull/1/merge";
|
|
const currentSha = "a".repeat(40);
|
|
process.env["CODE_SCANNING_REF"] = "refs/pull/1/HEAD";
|
|
process.env["GITHUB_REF"] = expectedRef;
|
|
process.env["GITHUB_SHA"] = currentSha;
|
|
|
|
const actualRef = await actionsutil.getRef();
|
|
t.deepEqual(actualRef, expectedRef);
|
|
});
|
|
});
|
|
|
|
test("getRef() throws an error if only `ref` is provided as an input", async (t) => {
|
|
await withTmpDir(async (tmpDir: string) => {
|
|
setupActionsVars(tmpDir, tmpDir);
|
|
const getAdditionalInputStub = sinon.stub(actionsutil, "getOptionalInput");
|
|
getAdditionalInputStub.withArgs("ref").resolves("refs/pull/1/merge");
|
|
|
|
await t.throwsAsync(
|
|
async () => {
|
|
await actionsutil.getRef();
|
|
},
|
|
{
|
|
instanceOf: Error,
|
|
message:
|
|
"Both 'ref' and 'sha' are required if one of them is provided.",
|
|
}
|
|
);
|
|
getAdditionalInputStub.restore();
|
|
});
|
|
});
|
|
|
|
test("getRef() throws an error if only `sha` is provided as an input", async (t) => {
|
|
await withTmpDir(async (tmpDir: string) => {
|
|
setupActionsVars(tmpDir, tmpDir);
|
|
process.env["GITHUB_WORKSPACE"] = "/tmp";
|
|
const getAdditionalInputStub = sinon.stub(actionsutil, "getOptionalInput");
|
|
getAdditionalInputStub.withArgs("sha").resolves("a".repeat(40));
|
|
|
|
await t.throwsAsync(
|
|
async () => {
|
|
await actionsutil.getRef();
|
|
},
|
|
{
|
|
instanceOf: Error,
|
|
message:
|
|
"Both 'ref' and 'sha' are required if one of them is provided.",
|
|
}
|
|
);
|
|
getAdditionalInputStub.restore();
|
|
});
|
|
});
|
|
|
|
test("computeAutomationID()", async (t) => {
|
|
let actualAutomationID = actionsutil.computeAutomationID(
|
|
".github/workflows/codeql-analysis.yml:analyze",
|
|
'{"language": "javascript", "os": "linux"}'
|
|
);
|
|
t.deepEqual(
|
|
actualAutomationID,
|
|
".github/workflows/codeql-analysis.yml:analyze/language:javascript/os:linux/"
|
|
);
|
|
|
|
// check the environment sorting
|
|
actualAutomationID = actionsutil.computeAutomationID(
|
|
".github/workflows/codeql-analysis.yml:analyze",
|
|
'{"os": "linux", "language": "javascript"}'
|
|
);
|
|
t.deepEqual(
|
|
actualAutomationID,
|
|
".github/workflows/codeql-analysis.yml:analyze/language:javascript/os:linux/"
|
|
);
|
|
|
|
// check that an empty environment produces the right results
|
|
actualAutomationID = actionsutil.computeAutomationID(
|
|
".github/workflows/codeql-analysis.yml:analyze",
|
|
"{}"
|
|
);
|
|
t.deepEqual(
|
|
actualAutomationID,
|
|
".github/workflows/codeql-analysis.yml:analyze/"
|
|
);
|
|
|
|
// check non string environment values
|
|
actualAutomationID = actionsutil.computeAutomationID(
|
|
".github/workflows/codeql-analysis.yml:analyze",
|
|
'{"number": 1, "object": {"language": "javascript"}}'
|
|
);
|
|
t.deepEqual(
|
|
actualAutomationID,
|
|
".github/workflows/codeql-analysis.yml:analyze/number:/object:/"
|
|
);
|
|
|
|
// check undefined environment
|
|
actualAutomationID = actionsutil.computeAutomationID(
|
|
".github/workflows/codeql-analysis.yml:analyze",
|
|
undefined
|
|
);
|
|
t.deepEqual(
|
|
actualAutomationID,
|
|
".github/workflows/codeql-analysis.yml:analyze/"
|
|
);
|
|
});
|
|
|
|
test("initializeEnvironment", (t) => {
|
|
initializeEnvironment("1.2.3");
|
|
t.deepEqual(process.env[EnvVar.VERSION], "1.2.3");
|
|
});
|
|
|
|
test("isAnalyzingDefaultBranch()", async (t) => {
|
|
process.env["GITHUB_EVENT_NAME"] = "push";
|
|
process.env["CODE_SCANNING_IS_ANALYZING_DEFAULT_BRANCH"] = "true";
|
|
t.deepEqual(await actionsutil.isAnalyzingDefaultBranch(), true);
|
|
process.env["CODE_SCANNING_IS_ANALYZING_DEFAULT_BRANCH"] = "false";
|
|
|
|
await withTmpDir(async (tmpDir) => {
|
|
setupActionsVars(tmpDir, tmpDir);
|
|
const envFile = path.join(tmpDir, "event.json");
|
|
fs.writeFileSync(
|
|
envFile,
|
|
JSON.stringify({
|
|
repository: {
|
|
default_branch: "main",
|
|
},
|
|
})
|
|
);
|
|
process.env["GITHUB_EVENT_PATH"] = envFile;
|
|
|
|
process.env["GITHUB_REF"] = "main";
|
|
process.env["GITHUB_SHA"] = "1234";
|
|
t.deepEqual(await actionsutil.isAnalyzingDefaultBranch(), true);
|
|
|
|
process.env["GITHUB_REF"] = "refs/heads/main";
|
|
t.deepEqual(await actionsutil.isAnalyzingDefaultBranch(), true);
|
|
|
|
process.env["GITHUB_REF"] = "feature";
|
|
t.deepEqual(await actionsutil.isAnalyzingDefaultBranch(), false);
|
|
|
|
fs.writeFileSync(
|
|
envFile,
|
|
JSON.stringify({
|
|
schedule: "0 0 * * *",
|
|
})
|
|
);
|
|
process.env["GITHUB_EVENT_NAME"] = "schedule";
|
|
process.env["GITHUB_REF"] = "refs/heads/main";
|
|
t.deepEqual(await actionsutil.isAnalyzingDefaultBranch(), true);
|
|
|
|
const getAdditionalInputStub = sinon.stub(actionsutil, "getOptionalInput");
|
|
getAdditionalInputStub
|
|
.withArgs("ref")
|
|
.resolves("refs/heads/something-else");
|
|
getAdditionalInputStub
|
|
.withArgs("sha")
|
|
.resolves("0000000000000000000000000000000000000000");
|
|
process.env["GITHUB_EVENT_NAME"] = "schedule";
|
|
process.env["GITHUB_REF"] = "refs/heads/main";
|
|
t.deepEqual(await actionsutil.isAnalyzingDefaultBranch(), false);
|
|
getAdditionalInputStub.restore();
|
|
});
|
|
});
|
|
|
|
test("createStatusReportBase", async (t) => {
|
|
await withTmpDir(async (tmpDir: string) => {
|
|
setupActionsVars(tmpDir, tmpDir);
|
|
|
|
process.env["GITHUB_REF"] = "refs/heads/main";
|
|
process.env["GITHUB_SHA"] = "a".repeat(40);
|
|
process.env["GITHUB_RUN_ID"] = "100";
|
|
process.env["GITHUB_RUN_ATTEMPT"] = "2";
|
|
process.env["GITHUB_REPOSITORY"] = "octocat/HelloWorld";
|
|
process.env["CODEQL_ACTION_ANALYSIS_KEY"] = "analysis-key";
|
|
process.env["RUNNER_OS"] = "macOS";
|
|
|
|
const getRequiredInput = sinon.stub(actionsutil, "getRequiredInput");
|
|
getRequiredInput.withArgs("matrix").resolves("input/matrix");
|
|
|
|
const statusReport = await actionsutil.createStatusReportBase(
|
|
"init",
|
|
"failure",
|
|
new Date("May 19, 2023 05:19:00"),
|
|
"failure cause",
|
|
"exception stack trace"
|
|
);
|
|
|
|
t.assert(typeof statusReport.job_run_uuid === "string");
|
|
t.assert(statusReport.workflow_run_id === 100);
|
|
t.assert(statusReport.workflow_run_attempt === 2);
|
|
t.assert(
|
|
statusReport.workflow_name === (process.env["GITHUB_WORKFLOW"] || "")
|
|
);
|
|
t.assert(statusReport.job_name === (process.env["GITHUB_JOB"] || ""));
|
|
t.assert(statusReport.analysis_key === "analysis-key");
|
|
t.assert(statusReport.commit_oid === process.env["GITHUB_SHA"]);
|
|
t.assert(statusReport.ref === process.env["GITHUB_REF"]);
|
|
t.assert(statusReport.action_name === "init");
|
|
t.assert(statusReport.action_oid === "unknown");
|
|
t.assert(
|
|
statusReport.started_at === process.env[EnvVar.WORKFLOW_STARTED_AT]
|
|
);
|
|
t.assert(
|
|
statusReport.action_started_at ===
|
|
new Date("May 19, 2023 05:19:00").toISOString()
|
|
);
|
|
t.assert(statusReport.status === "failure");
|
|
t.assert(statusReport.cause === "failure cause");
|
|
t.assert(statusReport.exception === "exception stack trace");
|
|
t.assert(statusReport.runner_os === process.env["RUNNER_OS"]);
|
|
t.assert(typeof statusReport.action_version === "string");
|
|
});
|
|
});
|