feat: sort all vulns by severity before display

snyk · Aug 22, 2019 · 42ec296 · 42ec296
1 parent 5dbf591
commit 42ec296
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 7 deletions.
diff --git a/src/cli/commands/test/formatters/remediation-based-format-issues.ts b/src/cli/commands/test/formatters/remediation-based-format-issues.ts
@@ -4,6 +4,7 @@ import * as config from '../../../../lib/config';
 import { TestOptions } from '../../../../lib/types';
 import { RemediationResult, PatchRemediation,
   DependencyUpdates, IssueData, SEVERITY, GroupedVuln } from '../../../../lib/snyk-test/legacy';
+import { SEVERITIES } from '../../../../lib/snyk-test/common';
 
 interface BasicVulnInfo {
   title: string;
@@ -56,6 +57,10 @@ export function formatIssuesWithRemediation(
   return results;
 }
 
+export function getSeverityValue(severity) {
+  return SEVERITIES.find((severityObj) => severityObj.verboseName === severity)!.value;
+}
+
 function constructPatchesText(
   patches: {
     [name: string]: PatchRemediation;
@@ -69,6 +74,7 @@ function constructPatchesText(
     return [];
   }
   const patchedTextArray = [chalk.bold.green('\nPatchable issues:')];
+
   for (const id of Object.keys(patches)) {
     // todo: add vulnToPatch package name
     const packageAtVersion = `${basicVulnInfo[id].name}@${basicVulnInfo[id].version}`;
@@ -104,6 +110,7 @@ function constructUpgradesText(
     const upgradeText =
     `\n  Upgrade ${chalk.bold.whiteBright(upgrade)} to ${chalk.bold.whiteBright(upgradeDepTo)} to fix\n`;
     const thisUpgradeFixes = vulnIds
+      .sort((a, b) => getSeverityValue(basicVulnInfo[a].severity) - getSeverityValue(basicVulnInfo[b].severity))
       .map((id) => formatIssue(
           id,
           basicVulnInfo[id].title,
@@ -125,9 +132,16 @@ function constructUnfixableText(unresolved: IssueData[]) {
     const extraInfo = issue.fixedIn && issue.fixedIn.length
       ? `\n  This issue was fixed in versions: ${chalk.bold(issue.fixedIn.join(', '))}`
       : '\n  No upgrade or patch available';
-    const packageNameAtVersion = chalk.bold.whiteBright(`\n  ${issue.packageName}@${issue.version}\n`);
+    const packageNameAtVersion = chalk.bold
+    .whiteBright(`\n  ${issue.packageName}@${issue.version}\n`);
     unfixableIssuesTextArray
-      .push(packageNameAtVersion + formatIssue(issue.id, issue.title, issue.severity, issue.isNew) + `${extraInfo}`);
+      .push(packageNameAtVersion +
+      formatIssue(
+        issue.id,
+        issue.title,
+        issue.severity,
+        issue.isNew) + `${extraInfo}`,
+      );
   }
 
   return unfixableIssuesTextArray;

diff --git a/src/cli/commands/test/index.ts b/src/cli/commands/test/index.ts
@@ -14,7 +14,7 @@ import { MethodArgs } from '../../args';
 import { LegacyVulnApiResult, SEVERITY, GroupedVuln, VulnMetaData } from '../../../lib/snyk-test/legacy';
 import { formatIssues } from './formatters/legacy-format-issue';
 import { WIZARD_SUPPORTED_PACKAGE_MANAGERS } from '../../../lib/package-managers';
-import { formatIssuesWithRemediation } from './formatters/remediation-based-format-issues';
+import { formatIssuesWithRemediation, getSeverityValue } from './formatters/remediation-based-format-issues';
 
 const debug = Debug('snyk');
 const SEPARATOR = '\n-------------------------------------------------------\n';
@@ -451,10 +451,6 @@ function validateSeverityThreshold(severityThreshold) {
     .indexOf(severityThreshold) > -1;
 }
 
-function getSeverityValue(severity) {
-  return SEVERITIES.find((severityObj) => severityObj.verboseName === severity)!.value;
-}
-
 // This is all a copy from Registry snapshots/index
 function isVulnFixable(vuln) {
   return vuln.isUpgradable || vuln.isPatchable;