fix: wrong 2x count of iac issues with --report -multi-doc yaml

this is to fix a bug where we mutated the "results" in the formatAndShareResults and these were used again in the formatScanResults below, resulting in double count of issues. note: this happened only in multi-YAML documents
snyk · Aug 10, 2022 · 06da34e · 06da34e
1 parent 7a46414
commit 06da34e
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 6 deletions.
diff --git a/src/cli/commands/test/iac/local-execution/measurable-methods.ts b/src/cli/commands/test/iac/local-execution/measurable-methods.ts
@@ -109,7 +109,7 @@ export {
   measurableScanFiles as scanFiles,
   measurableGetIacOrgSettings as getIacOrgSettings,
   measurableApplyCustomSeverities as applyCustomSeverities,
-  measurableFormatScanResults as formatScanResultsV2,
+  measurableFormatScanResults as formatScanResults,
   measurableTrackUsage as trackUsage,
   measurableCleanLocalCache as cleanLocalCache,
   measurableLocalTest as localTest,

diff --git a/src/cli/commands/test/iac/local-execution/process-results/process-results.ts b/src/cli/commands/test/iac/local-execution/process-results/process-results.ts
@@ -1,6 +1,7 @@
 import { filterIgnoredIssues } from './policy';
 import { formatAndShareResults } from './share-results';
-import { formatScanResultsV2 } from '../measurable-methods';
+import { formatScanResults } from '../measurable-methods';
+import * as cloneDeep from 'lodash.clonedeep';
 import { Policy } from '../../../../../../lib/policy/find-and-load-policy';
 import {
   IacOutputMeta,
@@ -33,7 +34,11 @@ export async function processResults(
 
   if (options.report) {
     ({ projectPublicIds, gitRemoteUrl } = await formatAndShareResults({
-      results: resultsWithCustomSeverities,
+      // this is to fix a bug where we mutated the "results" in the formatAndShareResults
+      // and these were used again in the formatScanResults below
+      // resulting in double count of issues
+      // note: this happened only in multi-YAML documents
+      results: cloneDeep(resultsWithCustomSeverities),
       options,
       orgPublicId,
       policy,
@@ -44,7 +49,7 @@ export async function processResults(
     }));
   }
 
-  const formattedResults = formatScanResultsV2(
+  const formattedResults = formatScanResults(
     resultsWithCustomSeverities,
     options,
     iacOrgSettings.meta,

diff --git a/src/cli/commands/test/iac/local-execution/process-results/results-formatter.ts b/src/cli/commands/test/iac/local-execution/process-results/results-formatter.ts
@@ -27,12 +27,12 @@ export function formatScanResults(
   options: IaCTestFlags,
   meta: TestMeta,
   projectPublicIds: Record<string, string>,
-  porjectRoot: string,
+  projectRoot: string,
   gitRemoteUrl?: string,
 ): FormattedResult[] {
   try {
     const groupedByFile = scanResults.reduce((memo, scanResult) => {
-      const res = formatScanResult(scanResult, meta, options, porjectRoot);
+      const res = formatScanResult(scanResult, meta, options, projectRoot);
 
       if (memo[scanResult.filePath]) {
         memo[scanResult.filePath].result.cloudConfigResults.push(