feat: Adding group-issues option for JSON output

snyk · Nov 27, 2020 · ea8f68d · ea8f68d
1 parent 05ad7cc
commit ea8f68d
Show file tree

Hide file tree

Showing 7 changed files with 1,706 additions and 2 deletions.
diff --git a/src/cli/commands/test/formatters/format-test-results.ts b/src/cli/commands/test/formatters/format-test-results.ts
@@ -28,9 +28,22 @@ import { createSarifOutputForIac } from '../iac-output';
 import { isNewVuln, isVulnFixable } from '../vuln-helpers';
 import { jsonStringifyLargeObject } from '../../../../lib/json';
 
-export function formatJsonOutput(jsonData) {
+export function formatJsonOutput(jsonData, options: Options) {
   const jsonDataClone = _.cloneDeep(jsonData);
 
+  if (options['group-issues']) {
+    jsonDataClone.vulnerabilities = Object.values(
+      (jsonDataClone.vulnerabilities || []).reduce((acc, vuln): Record<
+        string,
+        any
+      > => {
+        vuln.from = [vuln.from].concat(acc[vuln.id]?.from || []);
+        acc[vuln.id] = vuln;
+        return acc;
+      }, {}),
+    );
+  }
+
   if (jsonDataClone.vulnerabilities) {
     jsonDataClone.vulnerabilities.forEach((vuln) => {
       if (vuln.reachability) {
@@ -57,7 +70,9 @@ export function extractDataToSendFromResults(
 
   let stringifiedJsonData = '';
   if (options.json || options['json-file-output']) {
-    stringifiedJsonData = jsonStringifyLargeObject(formatJsonOutput(jsonData));
+    stringifiedJsonData = jsonStringifyLargeObject(
+      formatJsonOutput(jsonData, options),
+    );
   }
 
   const dataToSend = options.sarif ? sarifData : jsonData;

diff --git a/src/cli/index.ts b/src/cli/index.ts
@@ -246,6 +246,16 @@ async function main() {
           '—json only to get your image vulnerabilties, excluding the application ones.',
       ]);
     }
+    if (args.options['group-issues'] && args.options['iac']) {
+      throw new UnsupportedOptionCombinationError([
+        '--group-issues is currently not supported for Snyk IaC.',
+      ]);
+    }
+    if (args.options['group-issues'] && !args.options['json']) {
+      throw new UnsupportedOptionCombinationError([
+        'JSON output is required to use --group-issues, try adding --json.',
+      ]);
+    }
 
     if (
       args.options.file &&

diff --git a/src/lib/types.ts b/src/lib/types.ts
@@ -76,6 +76,7 @@ export interface Options {
   'app-vulns'?: boolean;
   debug?: boolean;
   sarif?: boolean;
+  'group-issues'?: boolean;
 }
 
 // TODO(kyegupov): catch accessing ['undefined-properties'] via noImplicitAny