robojerk/codeql-action

Send short codes that do not need URL encoding for better splunk tracing

Browse source
This commit is contained in:
Simon Engledew 2020-11-24 12:43:08 +00:00
parent 6df1fc5e38
commit 2ac22e8935
No known key found for this signature in database
GPG key ID: 84302E7B02FE8BCE
10 changed files with 215 additions and 72 deletions
Download patch file Download diff file Expand all files Collapse all files

90
lib/actions-util.js generated
View file

@ -103,16 +103,34 @@ function isObject(o) {
} }
var MissingTriggers; var MissingTriggers;
(function (MissingTriggers) { (function (MissingTriggers) {
MissingTriggers[MissingTriggers["NONE"] = 0] = "NONE"; MissingTriggers[MissingTriggers["None"] = 0] = "None";
MissingTriggers[MissingTriggers["PUSH"] = 1] = "PUSH"; MissingTriggers[MissingTriggers["Push"] = 1] = "Push";
MissingTriggers[MissingTriggers["PULL_REQUEST"] = 2] = "PULL_REQUEST"; MissingTriggers[MissingTriggers["PullRequest"] = 2] = "PullRequest";
})(MissingTriggers || (MissingTriggers = {})); })(MissingTriggers || (MissingTriggers = {}));
exports.ErrCheckoutWrongHead = `Git checkout HEAD^2 is no longer necessary. Please remove this line.`; exports.ErrCheckoutWrongHead = {
exports.ErrMismatchedBranches = `Please make sure that every branch in on.pull_request is also in on.push so that CodeQL can establish a baseline.`; message: `Git checkout HEAD^2 is no longer necessary. Please remove this line.`,
exports.ErrMissingHooks = `Please specify on.push and on.pull_request hooks.`; code: "CheckoutWrongHead",
exports.ErrMissingPushHook = `Please specify an on.push hook so CodeQL can establish a baseline.`; };
exports.ErrMissingPullRequestHook = `Please specify an on.pull_request hook so CodeQL is run against new pull requests.`; exports.ErrMismatchedBranches = {
exports.ErrPathsSpecified = `Please do not specify paths at on.pull.`; message: `Please make sure that every branch in on.pull_request is also in on.push so that CodeQL can establish a baseline.`,
code: "MismatchedBranches",
};
exports.ErrMissingHooks = {
message: `Please specify on.push and on.pull_request hooks.`,
code: "MissingHooks",
};
exports.ErrMissingPushHook = {
message: `Please specify an on.push hook so CodeQL can establish a baseline.`,
code: "MissingPushHook",
};
exports.ErrMissingPullRequestHook = {
message: `Please specify an on.pull_request hook so CodeQL is run against new pull requests.`,
code: "MissingPullRequestHook",
};
exports.ErrPathsSpecified = {
message: `Please do not specify paths at on.pull.`,
code: "PathsSpecified",
};
function validateWorkflow(doc) { function validateWorkflow(doc) {
var _a, _b, _c, _d; var _a, _b, _c, _d;
const errors = []; const errors = [];
@ -124,37 +142,37 @@ function validateWorkflow(doc) {
} }
} }
} }
let missing = MissingTriggers.NONE; let missing = MissingTriggers.None;
if (doc.on === undefined) { if (doc.on === undefined) {
missing = MissingTriggers.PUSH | MissingTriggers.PULL_REQUEST; missing = MissingTriggers.Push | MissingTriggers.PullRequest;
} }
else if (typeof doc.on === "string") { else if (typeof doc.on === "string") {
switch (doc.on) { switch (doc.on) {
case "push": case "push":
missing = MissingTriggers.PULL_REQUEST; missing = MissingTriggers.PullRequest;
break; break;
case "pull_request": case "pull_request":
missing = MissingTriggers.PUSH; missing = MissingTriggers.Push;
break; break;
default: default:
missing = MissingTriggers.PUSH | MissingTriggers.PULL_REQUEST; missing = MissingTriggers.Push | MissingTriggers.PullRequest;
break; break;
} }
} }
else if (Array.isArray(doc.on)) { else if (Array.isArray(doc.on)) {
if (!doc.on.includes("push")) { if (!doc.on.includes("push")) {
missing = missing | MissingTriggers.PUSH; missing = missing | MissingTriggers.Push;
} }
if (!doc.on.includes("pull_request")) { if (!doc.on.includes("pull_request")) {
missing = missing | MissingTriggers.PULL_REQUEST; missing = missing | MissingTriggers.PullRequest;
} }
} }
else if (isObject(doc.on)) { else if (isObject(doc.on)) {
if (!Object.prototype.hasOwnProperty.call(doc.on, "pull_request")) { if (!Object.prototype.hasOwnProperty.call(doc.on, "pull_request")) {
missing = missing | MissingTriggers.PULL_REQUEST; missing = missing | MissingTriggers.PullRequest;
} }
if (!Object.prototype.hasOwnProperty.call(doc.on, "push")) { if (!Object.prototype.hasOwnProperty.call(doc.on, "push")) {
missing = missing | MissingTriggers.PUSH; missing = missing | MissingTriggers.Push;
} }
else { else {
const paths = (_d = doc.on.push) === null || _d === void 0 ? void 0 : _d.paths; const paths = (_d = doc.on.push) === null || _d === void 0 ? void 0 : _d.paths;
@ -162,30 +180,35 @@ function validateWorkflow(doc) {
errors.push(exports.ErrPathsSpecified); errors.push(exports.ErrPathsSpecified);
} }
} }
if (doc.on.push && doc.on.pull_request) { if (doc.on.push) {
const push = doc.on.push.branches || []; const push = doc.on.push.branches || [];
const pull_request = doc.on.pull_request.branches || []; if (doc.on.pull_request) {
const intersects = pull_request.filter((value) => !push.includes(value)); const pull_request = doc.on.pull_request.branches || [];
if (intersects.length > 0) { const intersects = pull_request.filter((value) => !push.includes(value));
if (intersects.length > 0) {
errors.push(exports.ErrMismatchedBranches);
}
}
else if (push.length > 0) {
errors.push(exports.ErrMismatchedBranches); errors.push(exports.ErrMismatchedBranches);
} }
} }
} }
switch (missing) { switch (missing) {
case MissingTriggers.PULL_REQUEST | MissingTriggers.PUSH: case MissingTriggers.PullRequest | MissingTriggers.Push:
errors.push(exports.ErrMissingHooks); errors.push(exports.ErrMissingHooks);
break; break;
case MissingTriggers.PULL_REQUEST: case MissingTriggers.PullRequest:
errors.push(exports.ErrMissingPullRequestHook); errors.push(exports.ErrMissingPullRequestHook);
break; break;
case MissingTriggers.PUSH: case MissingTriggers.Push:
errors.push(exports.ErrMissingPushHook); errors.push(exports.ErrMissingPushHook);
break; break;
} }
return errors; return errors;
} }
exports.validateWorkflow = validateWorkflow; exports.validateWorkflow = validateWorkflow;
async function getWorkflowError() { async function getWorkflowErrors() {
const workflow = await getWorkflow(); const workflow = await getWorkflow();
if (workflow === undefined) { if (workflow === undefined) {
return undefined; return undefined;
@ -194,9 +217,20 @@ async function getWorkflowError() {
if (workflowErrors.length === 0) { if (workflowErrors.length === 0) {
return undefined; return undefined;
} }
return `${workflowErrors.length} issue${workflowErrors.length === 1 ? " was" : "s were"} detected with this workflow: ${workflowErrors.join(", ")}`; return workflowErrors;
} }
exports.getWorkflowError = getWorkflowError; exports.getWorkflowErrors = getWorkflowErrors;
function formatWorkflowErrors(errors) {
return `${errors.length} issue${errors.length === 1 ? " was" : "s were"} detected with this workflow: ${errors.map((e) => e.message).join(", ")}`;
}
exports.formatWorkflowErrors = formatWorkflowErrors;
function formatWorkflowCause(errors) {
if (errors === undefined) {
return undefined;
}
return errors.map((e) => e.code).join(",");
}
exports.formatWorkflowCause = formatWorkflowCause;
async function getWorkflow() { async function getWorkflow() {
const relativePath = await getWorkflowPath(); const relativePath = await getWorkflowPath();
const absolutePath = path.join(getRequiredEnvParam("GITHUB_WORKSPACE"), relativePath); const absolutePath = path.join(getRequiredEnvParam("GITHUB_WORKSPACE"), relativePath);

2
lib/actions-util.js.map
View file

File diff suppressed because one or more lines are too long

30
lib/actions-util.test.js generated
View file

@ -146,6 +146,15 @@ ava_1.default("validateWorkflow() when on.push is mismatched for pull_request",
}); });
t.deepEqual(errors, [actionsutil.ErrMismatchedBranches]); t.deepEqual(errors, [actionsutil.ErrMismatchedBranches]);
}); });
ava_1.default("validateWorkflow() when on.pull_request for every branch but push specifies branches", (t) => {
const errors = actionsutil.validateWorkflow({
on: {
push: { branches: ["main"] },
pull_request: null,
},
});
t.deepEqual(errors, [actionsutil.ErrMismatchedBranches]);
});
ava_1.default("validateWorkflow() when HEAD^2 is checked out", (t) => { ava_1.default("validateWorkflow() when HEAD^2 is checked out", (t) => {
const errors = actionsutil.validateWorkflow({ const errors = actionsutil.validateWorkflow({
on: ["push", "pull_request"], on: ["push", "pull_request"],
@ -153,4 +162,25 @@ ava_1.default("validateWorkflow() when HEAD^2 is checked out", (t) => {
}); });
t.deepEqual(errors, [actionsutil.ErrCheckoutWrongHead]); t.deepEqual(errors, [actionsutil.ErrCheckoutWrongHead]);
}); });
ava_1.default("formatWorkflowErrors() when there is one error", (t) => {
const message = actionsutil.formatWorkflowErrors([
actionsutil.ErrCheckoutWrongHead,
]);
t.true(message.startsWith("1 issue was detected with this workflow:"));
});
ava_1.default("formatWorkflowErrors() when there are multiple errors", (t) => {
const message = actionsutil.formatWorkflowErrors([
actionsutil.ErrCheckoutWrongHead,
actionsutil.ErrPathsSpecified,
]);
t.true(message.startsWith("2 issues were detected with this workflow:"));
});
ava_1.default("formatWorkflowCause()", (t) => {
const message = actionsutil.formatWorkflowCause([
actionsutil.ErrCheckoutWrongHead,
actionsutil.ErrPathsSpecified,
]);
t.deepEqual(message, "CheckoutWrongHead,PathsSpecified");
t.deepEqual(actionsutil.formatWorkflowCause(undefined), undefined);
});
//# sourceMappingURL=actions-util.test.js.map //# sourceMappingURL=actions-util.test.js.map

2
lib/actions-util.test.js.map
View file

File diff suppressed because one or more lines are too long

8
lib/init-action.js generated
View file

@ -55,11 +55,11 @@ async function run() {
let toolsVersion; let toolsVersion;
try { try {
actionsUtil.prepareLocalRunEnvironment(); actionsUtil.prepareLocalRunEnvironment();
const workflowError = await actionsUtil.getWorkflowError(); const workflowErrors = await actionsUtil.getWorkflowErrors();
if (workflowError !== undefined) { if (workflowErrors !== undefined) {
core.warning(workflowError); core.warning(actionsUtil.formatWorkflowErrors(workflowErrors));
} }
if (!(await actionsUtil.sendStatusReport(await actionsUtil.createStatusReportBase("init", "starting", startedAt, workflowError)))) { if (!(await actionsUtil.sendStatusReport(await actionsUtil.createStatusReportBase("init", "starting", startedAt, actionsUtil.formatWorkflowCause(workflowErrors))))) {
return; return;
} }
const initCodeQLResult = await init_1.initCodeQL(actionsUtil.getOptionalInput("tools"), actionsUtil.getRequiredInput("token"), actionsUtil.getRequiredEnvParam("GITHUB_SERVER_URL"), actionsUtil.getRequiredEnvParam("RUNNER_TEMP"), actionsUtil.getRequiredEnvParam("RUNNER_TOOL_CACHE"), "actions", logger); const initCodeQLResult = await init_1.initCodeQL(actionsUtil.getOptionalInput("tools"), actionsUtil.getRequiredInput("token"), actionsUtil.getRequiredEnvParam("GITHUB_SERVER_URL"), actionsUtil.getRequiredEnvParam("RUNNER_TEMP"), actionsUtil.getRequiredEnvParam("RUNNER_TOOL_CACHE"), "actions", logger);

2
lib/init-action.js.map
View file

@ -1 +1 @@
{"version":3,"file":"init-action.js","sourceRoot":"","sources":["../src/init-action.ts"],"names":[],"mappings":";;;;;;;;;AAAA,oDAAsC;AAEtC,4DAA8C;AAG9C,iCAMgB;AAChB,2CAAuC;AACvC,uCAA6C;AAC7C,6CAAkD;AAsBlD,KAAK,UAAU,uBAAuB,CACpC,SAAe,EACf,MAA0B,EAC1B,YAAoB;;IAEpB,MAAM,gBAAgB,GAAG,MAAM,WAAW,CAAC,sBAAsB,CAC/D,MAAM,EACN,SAAS,EACT,SAAS,CACV,CAAC;IAEF,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7C,MAAM,iBAAiB,GAAG,WAAW,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;IACpE,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC,iBAAiB,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/D,MAAM,WAAW,GAAG,CAAC,MAAM,CAAC,iBAAiB,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CACvE,GAAG,CACJ,CAAC;IACF,MAAM,qBAAqB,GAAG,MAAM,CAAC,iBAAiB,CACpD,yBAAyB,CAC1B;QACC,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,EAAE,CAAC;IAEP,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,IAAI,YAAY,SAAG,WAAW,CAAC,gBAAgB,CAAC,SAAS,CAAC,0CAAE,IAAI,EAAE,CAAC;IACnE,IAAI,YAAY,KAAK,SAAS,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;QAC9D,OAAO,CAAC,IAAI,CACV,GAAG,CAAC,MAAM,CAAC,iBAAiB,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAC/D,CAAC;KACH;IACD,IAAI,YAAY,KAAK,SAAS,EAAE;QAC9B,YAAY,GAAG,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC;YACzC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YACxB,CAAC,CAAC,YAAY,CAAC;QACjB,OAAO,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;KAC1C;IAED,MAAM,YAAY,GAA4B;QAC5C,GAAG,gBAAgB;QACnB,SAAS;QACT,kBAAkB,EAAE,iBAAiB,IAAI,EAAE;QAC3C,KAAK;QACL,YAAY,EAAE,WAAW;QACzB,uBAAuB,EAAE,qBAAqB;QAC9C,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC;QAC1B,WAAW,EAAE,WAAW,CAAC,gBAAgB,CAAC,OAAO,CAAC,IAAI,EAAE;QACxD,sBAAsB,EAAE,YAAY;KACrC,CAAC;IAEF,MAAM,WAAW,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;AACnD,CAAC;AAED,KAAK,UAAU,GAAG;IAChB,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;IAC7B,MAAM,MAAM,GAAG,0BAAgB,EAAE,CAAC;IAClC,IAAI,MAA0B,CAAC;IAC/B,IAAI,MAAc,CAAC;IACnB,IAAI,YAAoB,CAAC;IAEzB,IAAI;QACF,WAAW,CAAC,0BAA0B,EAAE,CAAC;QAEzC,MAAM,aAAa,GAAG,MAAM,WAAW,CAAC,gBAAgB,EAAE,CAAC;QAE3D,IAAI,aAAa,KAAK,SAAS,EAAE;YAC/B,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;SAC7B;QAED,IACE,CAAC,CAAC,MAAM,WAAW,CAAC,gBAAgB,CAClC,MAAM,WAAW,CAAC,sBAAsB,CACtC,MAAM,EACN,UAAU,EACV,SAAS,EACT,aAAa,CACd,CACF,CAAC,EACF;YACA,OAAO;SACR;QAED,MAAM,gBAAgB,GAAG,MAAM,iBAAU,CACvC,WAAW,CAAC,gBAAgB,CAAC,OAAO,CAAC,EACrC,WAAW,CAAC,gBAAgB,CAAC,OAAO,CAAC,EACrC,WAAW,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,EACpD,WAAW,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAC9C,WAAW,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,EACpD,SAAS,EACT,MAAM,CACP,CAAC;QACF,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC;QACjC,YAAY,GAAG,gBAAgB,CAAC,YAAY,CAAC;QAE7C,MAAM,GAAG,MAAM,iBAAU,CACvB,WAAW,CAAC,gBAAgB,CAAC,WAAW,CAAC,EACzC,WAAW,CAAC,gBAAgB,CAAC,SAAS,CAAC,EACvC,WAAW,CAAC,gBAAgB,CAAC,aAAa,CAAC,EAC3C,+BAAkB,CAAC,WAAW,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,CAAC,EACxE,WAAW,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAC9C,WAAW,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,EACpD,MAAM,EACN,WAAW,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,EACnD,WAAW,CAAC,gBAAgB,CAAC,OAAO,CAAC,EACrC,WAAW,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,EACpD,SAAS,EACT,MAAM,CACP,CAAC;QAEF,IACE,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,oBAAQ,CAAC,MAAM,CAAC;YAC1C,WAAW,CAAC,gBAAgB,CAAC,2BAA2B,CAAC,KAAK,MAAM,EACpE;YACA,IAAI;gBACF,MAAM,wBAAiB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;aACzC;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAM,CAAC,OAAO,CACZ,GAAG,GAAG,CAAC,OAAO,2FAA2F,CAC1G,CAAC;aACH;SACF;KACF;IAAC,OAAO,CAAC,EAAE;QACV,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAC1B,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACf,MAAM,WAAW,CAAC,gBAAgB,CAChC,MAAM,WAAW,CAAC,sBAAsB,CACtC,MAAM,EACN,SAAS,EACT,SAAS,EACT,CAAC,CAAC,OAAO,CACV,CACF,CAAC;QACF,OAAO;KACR;IAED,IAAI;QACF,mBAAmB;QACnB,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACvC,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YACxC,IAAI,CAAC,OAAO,CACV,6GAA6G,CAC9G,CAAC;SACH;QAED,mGAAmG;QACnG,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,MAAM,CAAC;QACtD,IAAI,CAAC,cAAc,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QAE7C,MAAM,YAAY,GAAG,MAAM,cAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACnD,IAAI,YAAY,KAAK,SAAS,EAAE;YAC9B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE;gBAC3D,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;aACjC;YAED,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE;gBAChC,MAAM,0BAAmB,CACvB,mBAAmB,EACnB,SAAS,EACT,MAAM,EACN,MAAM,EACN,YAAY,CACb,CAAC;aACH;SACF;QAED,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;KACjD;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC9B,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACnB,MAAM,WAAW,CAAC,gBAAgB,CAChC,MAAM,WAAW,CAAC,sBAAsB,CACtC,MAAM,EACN,SAAS,EACT,SAAS,EACT,KAAK,CAAC,OAAO,EACb,KAAK,CAAC,KAAK,CACZ,CACF,CAAC;QACF,OAAO;KACR;IACD,MAAM,uBAAuB,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;AACjE,CAAC;AAED,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;IAChB,IAAI,CAAC,SAAS,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;IAC3C,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AACjB,CAAC,CAAC,CAAC"} {"version":3,"file":"init-action.js","sourceRoot":"","sources":["../src/init-action.ts"],"names":[],"mappings":";;;;;;;;;AAAA,oDAAsC;AAEtC,4DAA8C;AAG9C,iCAMgB;AAChB,2CAAuC;AACvC,uCAA6C;AAC7C,6CAAkD;AAsBlD,KAAK,UAAU,uBAAuB,CACpC,SAAe,EACf,MAA0B,EAC1B,YAAoB;;IAEpB,MAAM,gBAAgB,GAAG,MAAM,WAAW,CAAC,sBAAsB,CAC/D,MAAM,EACN,SAAS,EACT,SAAS,CACV,CAAC;IAEF,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7C,MAAM,iBAAiB,GAAG,WAAW,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;IACpE,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC,iBAAiB,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/D,MAAM,WAAW,GAAG,CAAC,MAAM,CAAC,iBAAiB,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CACvE,GAAG,CACJ,CAAC;IACF,MAAM,qBAAqB,GAAG,MAAM,CAAC,iBAAiB,CACpD,yBAAyB,CAC1B;QACC,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,EAAE,CAAC;IAEP,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,IAAI,YAAY,SAAG,WAAW,CAAC,gBAAgB,CAAC,SAAS,CAAC,0CAAE,IAAI,EAAE,CAAC;IACnE,IAAI,YAAY,KAAK,SAAS,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;QAC9D,OAAO,CAAC,IAAI,CACV,GAAG,CAAC,MAAM,CAAC,iBAAiB,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAC/D,CAAC;KACH;IACD,IAAI,YAAY,KAAK,SAAS,EAAE;QAC9B,YAAY,GAAG,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC;YACzC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YACxB,CAAC,CAAC,YAAY,CAAC;QACjB,OAAO,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;KAC1C;IAED,MAAM,YAAY,GAA4B;QAC5C,GAAG,gBAAgB;QACnB,SAAS;QACT,kBAAkB,EAAE,iBAAiB,IAAI,EAAE;QAC3C,KAAK;QACL,YAAY,EAAE,WAAW;QACzB,uBAAuB,EAAE,qBAAqB;QAC9C,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC;QAC1B,WAAW,EAAE,WAAW,CAAC,gBAAgB,CAAC,OAAO,CAAC,IAAI,EAAE;QACxD,sBAAsB,EAAE,YAAY;KACrC,CAAC;IAEF,MAAM,WAAW,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;AACnD,CAAC;AAED,KAAK,UAAU,GAAG;IAChB,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;IAC7B,MAAM,MAAM,GAAG,0BAAgB,EAAE,CAAC;IAClC,IAAI,MAA0B,CAAC;IAC/B,IAAI,MAAc,CAAC;IACnB,IAAI,YAAoB,CAAC;IAEzB,IAAI;QACF,WAAW,CAAC,0BAA0B,EAAE,CAAC;QAEzC,MAAM,cAAc,GAAG,MAAM,WAAW,CAAC,iBAAiB,EAAE,CAAC;QAE7D,IAAI,cAAc,KAAK,SAAS,EAAE;YAChC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC,CAAC;SAChE;QAED,IACE,CAAC,CAAC,MAAM,WAAW,CAAC,gBAAgB,CAClC,MAAM,WAAW,CAAC,sBAAsB,CACtC,MAAM,EACN,UAAU,EACV,SAAS,EACT,WAAW,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAChD,CACF,CAAC,EACF;YACA,OAAO;SACR;QAED,MAAM,gBAAgB,GAAG,MAAM,iBAAU,CACvC,WAAW,CAAC,gBAAgB,CAAC,OAAO,CAAC,EACrC,WAAW,CAAC,gBAAgB,CAAC,OAAO,CAAC,EACrC,WAAW,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,EACpD,WAAW,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAC9C,WAAW,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,EACpD,SAAS,EACT,MAAM,CACP,CAAC;QACF,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC;QACjC,YAAY,GAAG,gBAAgB,CAAC,YAAY,CAAC;QAE7C,MAAM,GAAG,MAAM,iBAAU,CACvB,WAAW,CAAC,gBAAgB,CAAC,WAAW,CAAC,EACzC,WAAW,CAAC,gBAAgB,CAAC,SAAS,CAAC,EACvC,WAAW,CAAC,gBAAgB,CAAC,aAAa,CAAC,EAC3C,+BAAkB,CAAC,WAAW,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,CAAC,EACxE,WAAW,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAC9C,WAAW,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,EACpD,MAAM,EACN,WAAW,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,EACnD,WAAW,CAAC,gBAAgB,CAAC,OAAO,CAAC,EACrC,WAAW,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,EACpD,SAAS,EACT,MAAM,CACP,CAAC;QAEF,IACE,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,oBAAQ,CAAC,MAAM,CAAC;YAC1C,WAAW,CAAC,gBAAgB,CAAC,2BAA2B,CAAC,KAAK,MAAM,EACpE;YACA,IAAI;gBACF,MAAM,wBAAiB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;aACzC;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAM,CAAC,OAAO,CACZ,GAAG,GAAG,CAAC,OAAO,2FAA2F,CAC1G,CAAC;aACH;SACF;KACF;IAAC,OAAO,CAAC,EAAE;QACV,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAC1B,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACf,MAAM,WAAW,CAAC,gBAAgB,CAChC,MAAM,WAAW,CAAC,sBAAsB,CACtC,MAAM,EACN,SAAS,EACT,SAAS,EACT,CAAC,CAAC,OAAO,CACV,CACF,CAAC;QACF,OAAO;KACR;IAED,IAAI;QACF,mBAAmB;QACnB,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACvC,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YACxC,IAAI,CAAC,OAAO,CACV,6GAA6G,CAC9G,CAAC;SACH;QAED,mGAAmG;QACnG,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,MAAM,CAAC;QACtD,IAAI,CAAC,cAAc,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QAE7C,MAAM,YAAY,GAAG,MAAM,cAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACnD,IAAI,YAAY,KAAK,SAAS,EAAE;YAC9B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE;gBAC3D,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;aACjC;YAED,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE;gBAChC,MAAM,0BAAmB,CACvB,mBAAmB,EACnB,SAAS,EACT,MAAM,EACN,MAAM,EACN,YAAY,CACb,CAAC;aACH;SACF;QAED,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;KACjD;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC9B,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACnB,MAAM,WAAW,CAAC,gBAAgB,CAChC,MAAM,WAAW,CAAC,sBAAsB,CACtC,MAAM,EACN,SAAS,EACT,SAAS,EACT,KAAK,CAAC,OAAO,EACb,KAAK,CAAC,KAAK,CACZ,CACF,CAAC;QACF,OAAO;KACR;IACD,MAAM,uBAAuB,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;AACjE,CAAC;AAED,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;IAChB,IAAI,CAAC,SAAS,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;IAC3C,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AACjB,CAAC,CAAC,CAAC"}

2
package.json
View file

@ -5,7 +5,7 @@
"description": "CodeQL action", "description": "CodeQL action",
"scripts": { "scripts": {
"build": "tsc", "build": "tsc",
"test": "ava src/** --serial --verbose", "test": "ava src/actions-util.test.ts --serial --verbose",
"lint": "eslint --report-unused-disable-directives --max-warnings=0 . --ext .js,.ts", "lint": "eslint --report-unused-disable-directives --max-warnings=0 . --ext .js,.ts",
"lint-fix": "eslint --report-unused-disable-directives --max-warnings=0 . --ext .js,.ts --fix", "lint-fix": "eslint --report-unused-disable-directives --max-warnings=0 . --ext .js,.ts --fix",
"removeNPMAbsolutePaths": "removeNPMAbsolutePaths . --force" "removeNPMAbsolutePaths": "removeNPMAbsolutePaths . --force"

36
src/actions-util.test.ts
View file

@ -186,6 +186,17 @@ test("validateWorkflow() when on.push is mismatched for pull_request", (t) => {
t.deepEqual(errors, [actionsutil.ErrMismatchedBranches]); t.deepEqual(errors, [actionsutil.ErrMismatchedBranches]);
}); });
test("validateWorkflow() when on.pull_request for every branch but push specifies branches", (t) => {
const errors = actionsutil.validateWorkflow({
on: {
push: { branches: ["main"] },
pull_request: null,
},
});
t.deepEqual(errors, [actionsutil.ErrMismatchedBranches]);
});
test("validateWorkflow() when HEAD^2 is checked out", (t) => { test("validateWorkflow() when HEAD^2 is checked out", (t) => {
const errors = actionsutil.validateWorkflow({ const errors = actionsutil.validateWorkflow({
on: ["push", "pull_request"], on: ["push", "pull_request"],
@ -194,3 +205,28 @@ test("validateWorkflow() when HEAD^2 is checked out", (t) => {
t.deepEqual(errors, [actionsutil.ErrCheckoutWrongHead]); t.deepEqual(errors, [actionsutil.ErrCheckoutWrongHead]);
}); });
test("formatWorkflowErrors() when there is one error", (t) => {
const message = actionsutil.formatWorkflowErrors([
actionsutil.ErrCheckoutWrongHead,
]);
t.true(message.startsWith("1 issue was detected with this workflow:"));
});
test("formatWorkflowErrors() when there are multiple errors", (t) => {
const message = actionsutil.formatWorkflowErrors([
actionsutil.ErrCheckoutWrongHead,
actionsutil.ErrPathsSpecified,
]);
t.true(message.startsWith("2 issues were detected with this workflow:"));
});
test("formatWorkflowCause()", (t) => {
const message = actionsutil.formatWorkflowCause([
actionsutil.ErrCheckoutWrongHead,
actionsutil.ErrPathsSpecified,
]);
t.deepEqual(message, "CheckoutWrongHead,PathsSpecified");
t.deepEqual(actionsutil.formatWorkflowCause(undefined), undefined);
});

107
src/actions-util.ts
View file

@ -130,20 +130,43 @@ function isObject(o): o is object {
} }
enum MissingTriggers { enum MissingTriggers {
NONE = 0, None = 0,
PUSH = 1, Push = 1,
PULL_REQUEST = 2, PullRequest = 2,
} }
export const ErrCheckoutWrongHead = `Git checkout HEAD^2 is no longer necessary. Please remove this line.`; interface WorkflowError {
export const ErrMismatchedBranches = `Please make sure that every branch in on.pull_request is also in on.push so that CodeQL can establish a baseline.`; message: string;
export const ErrMissingHooks = `Please specify on.push and on.pull_request hooks.`; code: string;
export const ErrMissingPushHook = `Please specify an on.push hook so CodeQL can establish a baseline.`; }
export const ErrMissingPullRequestHook = `Please specify an on.pull_request hook so CodeQL is run against new pull requests.`;
export const ErrPathsSpecified = `Please do not specify paths at on.pull.`;
export function validateWorkflow(doc: Workflow): string[] { export const ErrCheckoutWrongHead = {
const errors: string[] = []; message: `Git checkout HEAD^2 is no longer necessary. Please remove this line.`,
code: "CheckoutWrongHead",
};
export const ErrMismatchedBranches = {
message: `Please make sure that every branch in on.pull_request is also in on.push so that CodeQL can establish a baseline.`,
code: "MismatchedBranches",
};
export const ErrMissingHooks = {
message: `Please specify on.push and on.pull_request hooks.`,
code: "MissingHooks",
};
export const ErrMissingPushHook = {
message: `Please specify an on.push hook so CodeQL can establish a baseline.`,
code: "MissingPushHook",
};
export const ErrMissingPullRequestHook = {
message: `Please specify an on.pull_request hook so CodeQL is run against new pull requests.`,
code: "MissingPullRequestHook",
};
export const ErrPathsSpecified = {
message: `Please do not specify paths at on.pull.`,
code: "PathsSpecified",
};
export function validateWorkflow(doc: Workflow): WorkflowError[] {
const errors: WorkflowError[] = [];
// .jobs[key].steps[].run // .jobs[key].steps[].run
for (const job of Object.values(doc?.jobs || {})) { for (const job of Object.values(doc?.jobs || {})) {
@ -154,35 +177,35 @@ export function validateWorkflow(doc: Workflow): string[] {
} }
} }
let missing = MissingTriggers.NONE; let missing = MissingTriggers.None;
if (doc.on === undefined) { if (doc.on === undefined) {
missing = MissingTriggers.PUSH | MissingTriggers.PULL_REQUEST; missing = MissingTriggers.Push | MissingTriggers.PullRequest;
} else if (typeof doc.on === "string") { } else if (typeof doc.on === "string") {
switch (doc.on) { switch (doc.on) {
case "push": case "push":
missing = MissingTriggers.PULL_REQUEST; missing = MissingTriggers.PullRequest;
break; break;
case "pull_request": case "pull_request":
missing = MissingTriggers.PUSH; missing = MissingTriggers.Push;
break; break;
default: default:
missing = MissingTriggers.PUSH | MissingTriggers.PULL_REQUEST; missing = MissingTriggers.Push | MissingTriggers.PullRequest;
break; break;
} }
} else if (Array.isArray(doc.on)) { } else if (Array.isArray(doc.on)) {
if (!doc.on.includes("push")) { if (!doc.on.includes("push")) {
missing = missing | MissingTriggers.PUSH; missing = missing | MissingTriggers.Push;
} }
if (!doc.on.includes("pull_request")) { if (!doc.on.includes("pull_request")) {
missing = missing | MissingTriggers.PULL_REQUEST; missing = missing | MissingTriggers.PullRequest;
} }
} else if (isObject(doc.on)) { } else if (isObject(doc.on)) {
if (!Object.prototype.hasOwnProperty.call(doc.on, "pull_request")) { if (!Object.prototype.hasOwnProperty.call(doc.on, "pull_request")) {
missing = missing | MissingTriggers.PULL_REQUEST; missing = missing | MissingTriggers.PullRequest;
} }
if (!Object.prototype.hasOwnProperty.call(doc.on, "push")) { if (!Object.prototype.hasOwnProperty.call(doc.on, "push")) {
missing = missing | MissingTriggers.PUSH; missing = missing | MissingTriggers.Push;
} else { } else {
const paths = doc.on.push?.paths; const paths = doc.on.push?.paths;
if (Array.isArray(paths) && paths.length > 0) { if (Array.isArray(paths) && paths.length > 0) {
@ -190,26 +213,31 @@ export function validateWorkflow(doc: Workflow): string[] {
} }
} }
if (doc.on.push && doc.on.pull_request) { if (doc.on.push) {
const push = doc.on.push.branches || []; const push = doc.on.push.branches || [];
const pull_request = doc.on.pull_request.branches || [];
const intersects = pull_request.filter((value) => !push.includes(value)); if (doc.on.pull_request) {
const pull_request = doc.on.pull_request.branches || [];
if (intersects.length > 0) { const intersects = pull_request.filter(
(value) => !push.includes(value)
);
if (intersects.length > 0) {
errors.push(ErrMismatchedBranches);
}
} else if (push.length > 0) {
errors.push(ErrMismatchedBranches); errors.push(ErrMismatchedBranches);
} }
} }
} }
switch (missing) { switch (missing) {
case MissingTriggers.PULL_REQUEST | MissingTriggers.PUSH: case MissingTriggers.PullRequest | MissingTriggers.Push:
errors.push(ErrMissingHooks); errors.push(ErrMissingHooks);
break; break;
case MissingTriggers.PULL_REQUEST: case MissingTriggers.PullRequest:
errors.push(ErrMissingPullRequestHook); errors.push(ErrMissingPullRequestHook);
break; break;
case MissingTriggers.PUSH: case MissingTriggers.Push:
errors.push(ErrMissingPushHook); errors.push(ErrMissingPushHook);
break; break;
} }
@ -217,7 +245,9 @@ export function validateWorkflow(doc: Workflow): string[] {
return errors; return errors;
} }
export async function getWorkflowError(): Promise<string | undefined> { export async function getWorkflowErrors(): Promise<
WorkflowError[] | undefined
> {
const workflow = await getWorkflow(); const workflow = await getWorkflow();
if (workflow === undefined) { if (workflow === undefined) {
@ -230,9 +260,22 @@ export async function getWorkflowError(): Promise<string | undefined> {
return undefined; return undefined;
} }
return `${workflowErrors.length} issue${ return workflowErrors;
workflowErrors.length === 1 ? " was" : "s were" }
} detected with this workflow: ${workflowErrors.join(", ")}`;
export function formatWorkflowErrors(errors: WorkflowError[]): string {
return `${errors.length} issue${
errors.length === 1 ? " was" : "s were"
} detected with this workflow: ${errors.map((e) => e.message).join(", ")}`;
}
export function formatWorkflowCause(
errors?: WorkflowError[]
): undefined | string {
if (errors === undefined) {
return undefined;
}
return errors.map((e) => e.code).join(",");
} }
export async function getWorkflow(): Promise<Workflow | undefined> { export async function getWorkflow(): Promise<Workflow | undefined> {

8
src/init-action.ts
View file

@ -96,10 +96,10 @@ async function run() {
try { try {
actionsUtil.prepareLocalRunEnvironment(); actionsUtil.prepareLocalRunEnvironment();
const workflowError = await actionsUtil.getWorkflowError(); const workflowErrors = await actionsUtil.getWorkflowErrors();
if (workflowError !== undefined) { if (workflowErrors !== undefined) {
core.warning(workflowError); core.warning(actionsUtil.formatWorkflowErrors(workflowErrors));
} }
if ( if (
@ -108,7 +108,7 @@ async function run() {
"init", "init",
"starting", "starting",
startedAt, startedAt,
workflowError actionsUtil.formatWorkflowCause(workflowErrors)
) )
)) ))
) { ) {