Skip to content

Commit

Permalink
Merge pull request #2469 from snyk/fix/enable-vuln-grouping-for-opens…
Browse files Browse the repository at this point in the history 
…ource-multiprojects-json

fix: Enable vuln grouping for json array result regardless of --app-vulns flag
  • Loading branch information
@snaftaly
snaftaly authored Dec 28, 2021
2 parents 1dec52f + 2fafcc1 commit a75c451
Show file tree
Hide file tree
Showing 13 changed files with 13,187 additions and 17 deletions.
10 changes: 6 additions & 4 deletions src/lib/formatters/test/format-test-results.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ import {
} from 'snyk-docker-plugin/dist';
import { ScanResult } from '../../ecosystems/types';

export function formatJsonOutput(jsonData, options: Options) {
export function formatJsonVulnerabilityStructure(jsonData, options: Options) {
const jsonDataClone = cloneDeep(jsonData);

if (options['group-issues']) {
Expand Down Expand Up @@ -82,12 +82,14 @@ export function extractDataToSendFromResults(

let stringifiedJsonData = '';
if (options.json || options['json-file-output']) {
if (Array.isArray(jsonData) && options['app-vulns']) {
const jsonResult = jsonData.map((res) => formatJsonOutput(res, options));
if (Array.isArray(jsonData)) {
const jsonResult = jsonData.map((res) =>
formatJsonVulnerabilityStructure(res, options),
);
stringifiedJsonData = jsonStringifyLargeObject(jsonResult);
} else {
stringifiedJsonData = jsonStringifyLargeObject(
formatJsonOutput(jsonData, options),
formatJsonVulnerabilityStructure(jsonData, options),
);
}
}
Expand Down
0 test/fixtures/basic-apk/jsonDataGrouped.json → ...ures/basic-apk/resultJsonDataGrouped.json
View file
File renamed without changes.
0 .../container-app-vulns/jsonDataGrouped.json → ...iner-app-vulns/resultJsonDataGrouped.json
View file
File renamed without changes.
0 ...ntainer-app-vulns/jsonDataNonGrouped.json → ...r-app-vulns/resultJsonDataNonGrouped.json
View file
File renamed without changes.
1,996 changes: 1,996 additions & 0 deletions test/fixtures/npm/issue-grouping/multiProjectJsonData.json
View file

Large diffs are not rendered by default.

1,331 changes: 1,331 additions & 0 deletions test/fixtures/npm/issue-grouping/multiProjectResultJsonDataGrouped.json
View file

Large diffs are not rendered by default.

1,996 changes: 1,996 additions & 0 deletions test/fixtures/npm/issue-grouping/multiProjectResultJsonDataNonGrouped.json
View file

Large diffs are not rendered by default.

1,996 changes: 1,996 additions & 0 deletions test/fixtures/npm/issue-grouping/multiProjectResults.json
View file

Large diffs are not rendered by default.

1,556 changes: 1,556 additions & 0 deletions test/fixtures/npm/issue-grouping/singleProjectJsonData.json
View file

Large diffs are not rendered by default.

1,020 changes: 1,020 additions & 0 deletions test/fixtures/npm/issue-grouping/singleProjectResultJsonDataGrouped.json
View file

Large diffs are not rendered by default.

1,556 changes: 1,556 additions & 0 deletions test/fixtures/npm/issue-grouping/singleProjectResultJsonDataNonGrouped.json
View file

Large diffs are not rendered by default.

1,558 changes: 1,558 additions & 0 deletions test/fixtures/npm/issue-grouping/singleProjectResults.json
View file

Large diffs are not rendered by default.

185 changes: 172 additions & 13 deletions test/jest/unit/lib/formatters/test/format-test-results.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,15 +126,176 @@ describe('extractDataToSendFromResults', () => {
});
});

describe('open source results grouping', () => {
describe('single project results grouping', () => {
const resultsFixture = JSON.parse(
fs.readFileSync(
'test/fixtures/npm/issue-grouping/singleProjectResults.json',
'utf-8',
),
);

const jsonDataFixture = JSON.parse(
fs.readFileSync(
'test/fixtures/npm/issue-grouping/singleProjectJsonData.json',
'utf-8',
),
);

const resultJsonDataGroupedFixture = JSON.parse(
fs.readFileSync(
'test/fixtures/npm/issue-grouping/singleProjectResultJsonDataGrouped.json',
'utf-8',
),
);

const resultJsonDataNonGroupedFixture = JSON.parse(
fs.readFileSync(
'test/fixtures/npm/issue-grouping/singleProjectResultJsonDataNonGrouped.json',
'utf-8',
),
);

it('should create grouped Snyk JSON and only grouped Snyk JSON if `--json` and `--group-issues` is set in the options', () => {
const options = {
json: true,
'group-issues': true,
} as Options;
const jsonStringifySpy = jest.spyOn(JSON, 'stringify');
const res = extractDataToSendFromResults(
resultsFixture,
jsonDataFixture,
options,
);
expect(jsonStringifySpy).toHaveBeenCalledTimes(1);
expect(JSON.parse(res.stringifiedJsonData)).toMatchObject(
resultJsonDataGroupedFixture,
);
expect(res.stringifiedData).not.toBe('');
expect(res.stringifiedJsonData).not.toBe('');
expect(res.stringifiedSarifData).toBe('');
expect(
JSON.parse(res.stringifiedJsonData).vulnerabilities,
).toHaveLength(7);
});

it('should create non-grouped Snyk JSON and only Snyk JSON if `--json` is set in the options', () => {
const options = {
json: true,
} as Options;
const jsonStringifySpy = jest.spyOn(JSON, 'stringify');
const res = extractDataToSendFromResults(
resultsFixture,
jsonDataFixture,
options,
);
expect(jsonStringifySpy).toHaveBeenCalledTimes(1);
expect(JSON.parse(res.stringifiedJsonData)).toMatchObject(
resultJsonDataNonGroupedFixture,
);
expect(res.stringifiedData).not.toBe('');
expect(res.stringifiedJsonData).not.toBe('');
expect(res.stringifiedSarifData).toBe('');
expect(
JSON.parse(res.stringifiedJsonData).vulnerabilities,
).toHaveLength(11);
});
});

describe('multiple project results grouping', () => {
const resultsFixture = JSON.parse(
fs.readFileSync(
'test/fixtures/npm/issue-grouping/multiProjectResults.json',
'utf-8',
),
);

const jsonDataFixture = JSON.parse(
fs.readFileSync(
'test/fixtures/npm/issue-grouping/multiProjectJsonData.json',
'utf-8',
),
);

const resultJsonDataGroupedFixture = JSON.parse(
fs.readFileSync(
'test/fixtures/npm/issue-grouping/multiProjectResultJsonDataGrouped.json',
'utf-8',
),
);

const resultJsonDataNonGroupedFixture = JSON.parse(
fs.readFileSync(
'test/fixtures/npm/issue-grouping/multiProjectResultJsonDataNonGrouped.json',
'utf-8',
),
);

it('should create grouped Snyk JSON for each of the projects in the result if `--json` and `--group-issues` is set in the options', () => {
const options = {
json: true,
'group-issues': true,
} as Options;
const jsonStringifySpy = jest.spyOn(JSON, 'stringify');
const res = extractDataToSendFromResults(
resultsFixture,
jsonDataFixture,
options,
);
expect(jsonStringifySpy).toHaveBeenCalledTimes(1);
expect(JSON.parse(res.stringifiedJsonData)).toMatchObject(
resultJsonDataGroupedFixture,
);
expect(res.stringifiedData).not.toBe('');
expect(res.stringifiedJsonData).not.toBe('');
expect(res.stringifiedSarifData).toBe('');
expect(
JSON.parse(res.stringifiedJsonData)[0].vulnerabilities,
).toHaveLength(7);
expect(
JSON.parse(res.stringifiedJsonData)[1].vulnerabilities,
).toHaveLength(2);
});

it('should create non-grouped Snyk JSON for each of the projects in the result if `--json` is set in the options', () => {
const options = {
json: true,
} as Options;
const jsonStringifySpy = jest.spyOn(JSON, 'stringify');
const res = extractDataToSendFromResults(
resultsFixture,
jsonDataFixture,
options,
);
expect(jsonStringifySpy).toHaveBeenCalledTimes(1);
expect(JSON.parse(res.stringifiedJsonData)).toMatchObject(
resultJsonDataNonGroupedFixture,
);
expect(res.stringifiedData).not.toBe('');
expect(res.stringifiedJsonData).not.toBe('');
expect(res.stringifiedSarifData).toBe('');
expect(
JSON.parse(res.stringifiedJsonData)[0].vulnerabilities,
).toHaveLength(11);
expect(
JSON.parse(res.stringifiedJsonData)[1].vulnerabilities,
).toHaveLength(4);
});
});
});

describe('container image json results', () => {
const resultsContainerFixture = JSON.parse(
fs.readFileSync('test/fixtures/basic-apk/results.json', 'utf-8'),
);
const jsonDataContainerFixture = JSON.parse(
fs.readFileSync('test/fixtures/basic-apk/jsonData.json', 'utf-8'),
);
const jsonDataGroupedContainerFixture = JSON.parse(
fs.readFileSync('test/fixtures/basic-apk/jsonDataGrouped.json', 'utf-8'),
const resultJsonDataGroupedContainerFixture = JSON.parse(
fs.readFileSync(
'test/fixtures/basic-apk/resultJsonDataGrouped.json',
'utf-8',
),
);

it('should create Snyk grouped JSON for container image if `--json` and `--group-issues` are set in the options', () => {
Expand All @@ -150,7 +311,7 @@ describe('extractDataToSendFromResults', () => {
);
expect(jsonStringifySpy).toHaveBeenCalledTimes(1);
expect(JSON.parse(res.stringifiedJsonData)).toMatchObject(
jsonDataGroupedContainerFixture,
resultJsonDataGroupedContainerFixture,
);
expect(res.stringifiedData).not.toBe('');
expect(res.stringifiedJsonData).not.toBe('');
Expand All @@ -171,23 +332,22 @@ describe('extractDataToSendFromResults', () => {
'utf-8',
),
);
const jsonDataGroupedContainerAppVulnsFixture = JSON.parse(
const resultJsonDataGroupedContainerAppVulnsFixture = JSON.parse(
fs.readFileSync(
'test/fixtures/container-app-vulns/jsonDataGrouped.json',
'test/fixtures/container-app-vulns/resultJsonDataGrouped.json',
'utf-8',
),
);
const jsonDataNonGroupedContainerAppVulnsFixture = JSON.parse(
const resultJsonDataNonGroupedContainerAppVulnsFixture = JSON.parse(
fs.readFileSync(
'test/fixtures/container-app-vulns/jsonDataNonGrouped.json',
'test/fixtures/container-app-vulns/resultJsonDataNonGrouped.json',
'utf-8',
),
);

it('should create Snyk grouped JSON for each of the multiple test results if `--json`, `--app-vulns` and `--group-issues` are set in the options', () => {
it('should create Snyk grouped JSON for each of the multiple test results if `--json` and `--group-issues` are set in the options', () => {
const options = {
json: true,
'app-vulns': true,
'group-issues': true,
} as Options;
const jsonStringifySpy = jest.spyOn(JSON, 'stringify');
Expand All @@ -198,7 +358,7 @@ describe('extractDataToSendFromResults', () => {
);
expect(jsonStringifySpy).toHaveBeenCalledTimes(1);
expect(JSON.parse(res.stringifiedJsonData)).toMatchObject(
jsonDataGroupedContainerAppVulnsFixture,
resultJsonDataGroupedContainerAppVulnsFixture,
);
expect(res.stringifiedData).not.toBe('');
expect(res.stringifiedJsonData).not.toBe('');
Expand All @@ -211,10 +371,9 @@ describe('extractDataToSendFromResults', () => {
).toHaveLength(7);
});

it('should create a non-grouped JSON for each of the test results if `--json` and `--app-vulns` options are set and `--group-issues` is not set', () => {
it('should create a non-grouped JSON for each of the test results if `--json` option is set and `--group-issues` is not set', () => {
const options = {
json: true,
'app-vulns': true,
} as Options;
const jsonStringifySpy = jest.spyOn(JSON, 'stringify');
const res = extractDataToSendFromResults(
Expand All @@ -224,7 +383,7 @@ describe('extractDataToSendFromResults', () => {
);
expect(jsonStringifySpy).toHaveBeenCalledTimes(1);
expect(JSON.parse(res.stringifiedJsonData)).toMatchObject(
jsonDataNonGroupedContainerAppVulnsFixture,
resultJsonDataNonGroupedContainerAppVulnsFixture,
);
expect(res.stringifiedData).not.toBe('');
expect(res.stringifiedJsonData).not.toBe('');
Expand Down

0 comments on commit a75c451

Please sign in to comment.