Skip to content

Include process environment into grype execution #202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kzantow merged 1 commit into from
Nov 17, 2022
Merged

Include process environment into grype execution #202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions dist/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ exports.GRYPE_VERSION = "v0.52.0";

const cache = __nccwpck_require__(7784);
const core = __nccwpck_require__(2186);
const { exec } = __nccwpck_require__(1514);
const exec = __nccwpck_require__(1514);
const fs = __nccwpck_require__(7147);
const stream = __nccwpck_require__(2781);
const { GRYPE_VERSION } = __nccwpck_require__(6244);
Expand All @@ -31,10 +31,10 @@ async function downloadGrype(version) {
// Download the installer, and run
const installPath = await cache.downloadTool(url);
// Make sure the tool's executable bit is set
await exec(`chmod +x ${installPath}`);
await exec.exec(`chmod +x ${installPath}`);

let cmd = `${installPath} -b ${installPath}_grype ${version}`;
await exec(cmd);
await exec.exec(cmd);
let grypePath = `${installPath}_grype/grype`;

// Cache the downloaded file
Expand Down Expand Up @@ -121,6 +121,7 @@ async function runScan({ source, failBuild, severityCutoff, outputFormat }) {
const out = {};

const env = {
...process.env,
GRYPE_CHECK_FOR_APP_UPDATE: "false",
};

Expand Down Expand Up @@ -203,7 +204,7 @@ async function runScan({ source, failBuild, severityCutoff, outputFormat }) {
const exitCode = await core.group(`${cmd} output...`, async () => {
core.info(`Executing: ${cmd} ` + cmdArgs.join(" "));

return exec(cmd, cmdArgs, {
return exec.exec(cmd, cmdArgs, {
env,
ignoreReturnCode: true,
outStream,
Expand Down
9 changes: 5 additions & 4 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
const cache = require("@actions/tool-cache");
const core = require("@actions/core");
const { exec } = require("@actions/exec");
const exec = require("@actions/exec");
const fs = require("fs");
const stream = require("stream");
const { GRYPE_VERSION } = require("./GrypeVersion");
Expand All @@ -17,10 +17,10 @@ async function downloadGrype(version) {
// Download the installer, and run
const installPath = await cache.downloadTool(url);
// Make sure the tool's executable bit is set
await exec(`chmod +x ${installPath}`);
await exec.exec(`chmod +x ${installPath}`);

let cmd = `${installPath} -b ${installPath}_grype ${version}`;
await exec(cmd);
await exec.exec(cmd);
let grypePath = `${installPath}_grype/grype`;

// Cache the downloaded file
Expand Down Expand Up @@ -107,6 +107,7 @@ async function runScan({ source, failBuild, severityCutoff, outputFormat }) {
const out = {};

const env = {
...process.env,
GRYPE_CHECK_FOR_APP_UPDATE: "false",
};

Expand Down Expand Up @@ -189,7 +190,7 @@ async function runScan({ source, failBuild, severityCutoff, outputFormat }) {
const exitCode = await core.group(`${cmd} output...`, async () => {
core.info(`Executing: ${cmd} ` + cmdArgs.join(" "));

return exec(cmd, cmdArgs, {
return exec.exec(cmd, cmdArgs, {
env,
ignoreReturnCode: true,
outStream,
Expand Down
6 changes: 3 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
},
"scripts": {
"lint": "eslint index.js",
"test": "eslint index.js && npm run download-pinned-grype-db && GRYPE_DB_AUTO_UPDATE=false GRYPE_DB_CACHE_DIR=./grype-db jest",
"test:update-snapshots": "eslint index.js && npm run download-pinned-grype-db && GRYPE_DB_AUTO_UPDATE=false GRYPE_DB_CACHE_DIR=./grype-db jest --updateSnapshot",
"download-pinned-grype-db": "mkdir -p grype-db/3 && curl -sL https://toolbox-data.anchore.io/grype/databases/vulnerability-db_v3_2022-03-16T08:14:11Z.tar.gz | tar zxf - -C grype-db/3",
"test": "eslint index.js && npm run download-pinned-grype-db && GRYPE_DB_AUTO_UPDATE=false GRYPE_DB_CACHE_DIR=./grype-db GRYPE_DB_VALIDATE_AGE=false jest",
"test:update-snapshots": "eslint index.js && npm run download-pinned-grype-db && GRYPE_DB_AUTO_UPDATE=false GRYPE_DB_CACHE_DIR=./grype-db GRYPE_DB_VALIDATE_AGE=false jest --updateSnapshot",
"download-pinned-grype-db": "mkdir -p grype-db/5 && curl -sL https://toolbox-data.anchore.io/grype/databases/vulnerability-db_v5_2022-10-17T08:14:57Z_b50a86ce07d268101316.tar.gz | tar zxf - -C grype-db/5",
"build": "ncc build ./index.js",
"precommit": "pretty-quick --staged && npm run build && git add dist/",
"prepare": "husky install",
Expand Down
41 changes: 41 additions & 0 deletions tests/action_args.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
const { run } = require("../index");
const core = require("@actions/core");
const exec = require("@actions/exec");

jest.setTimeout(30000);

Expand Down Expand Up @@ -116,4 +117,44 @@ describe("Github action args", () => {
spyOutput.mockRestore();
spyStdout.mockRestore();
});

it("runs with environment variables", async () => {
const inputs = {
path: "tests/fixtures/npm-project",
};
const spyInput = jest.spyOn(core, "getInput").mockImplementation((name) => {
try {
return inputs[name];
} finally {
inputs[name] = true;
}
});
process.env.BOGUS_ENVIRONMENT_VARIABLE = "bogus";

try {
var call = {}; // commandLine, args, options
const baseExec = exec.exec;
const spyExec = jest
.spyOn(exec, "exec")
.mockImplementation((commandLine, args, options) => {
call = {
commandLine,
args,
options,
};
return baseExec(commandLine, args, options);
});

await run();

expect(call.options).toBeDefined();
expect(call.options.env.BOGUS_ENVIRONMENT_VARIABLE).toEqual("bogus");

spyExec.mockRestore();
} finally {
delete process.env.BOGUS_ENVIRONMENT_VARIABLE;
}

spyInput.mockRestore();
});
});