feat:improve iac test json output

.github/CODEOWNERS

@@ -11,5 +11,6 @@ src/lib/snyk-test/iac-test-result.ts @snyk/cloudconfig
 src/lib/snyk-test/payload-schema.ts @snyk/cloudconfig
 src/lib/snyk-test/run-iac-test.ts @snyk/cloudconfig
 test/acceptance/cli-test/cli-test.iac-k8s.spec.ts @snyk/cloudconfig
+test/acceptance/cli-test/cli-test.iac-k8s.utils.ts @snyk/cloudconfig
 src/lib/errors/invalid-iac-file.ts @snyk/cloudconfig
 src/lib/errors/unsupported-options-iac-error.ts @snyk/cloudconfig

src/cli/commands/test/formatters/format-test-meta.ts

@@ -2,11 +2,11 @@ import chalk from 'chalk';
 import { rightPadWithSpaces } from '../../../../lib/right-pad';
 import { TestOptions, Options } from '../../../../lib/types';
 import { TestResult } from '../../../../lib/snyk-test/legacy';
-import { IacTestResult } from '../../../../lib/snyk-test/iac-test-result';
+import { IacTestResponse } from '../../../../lib/snyk-test/iac-test-result';
 import { capitalizePackageManager } from '../iac-output';
 
 export function formatTestMeta(
-  res: TestResult | IacTestResult,
+  res: TestResult | IacTestResponse,
   options: Options & TestOptions,
 ): string {
   const padToLength = 19; // chars to align

src/cli/commands/test/iac-output.ts

@@ -1,9 +1,11 @@
 import chalk from 'chalk';
 import * as Debug from 'debug';
-import { IacTestResult } from '../../../lib/snyk-test/iac-test-result';
+import {
+  IacTestResponse,
+  AnnotatedIacIssue,
+} from '../../../lib/snyk-test/iac-test-result';
 import { getSeverityValue } from './formatters';
 import { printPath } from './formatters/remediation-based-format-issues';
-import { AnnotatedIacIssue } from '../../../lib/snyk-test/iac-test-result';
 import { titleCaseText } from './formatters/legacy-format-issue';
 const debug = Debug('iac-output');
 
@@ -66,7 +68,7 @@ function extractOverview(description: string): string {
 }
 
 export function getIacDisplayedOutput(
-  res: IacTestResult,
+  iacTest: IacTestResponse,
   testedInfoText: string,
   meta: string,
   prefix: string,
@@ -77,7 +79,7 @@ export function getIacDisplayedOutput(
 
   const NotNew = false;
 
-  const issues: AnnotatedIacIssue[] = res.result.cloudConfigResults;
+  const issues: AnnotatedIacIssue[] = iacTest.result.cloudConfigResults;
   debug(`iac display output - ${issues.length} issues`);
 
   issues

src/cli/commands/test/index.ts

@@ -24,7 +24,10 @@ import {
   TestResult,
   VulnMetaData,
 } from '../../../lib/snyk-test/legacy';
-import { IacTestResult } from '../../../lib/snyk-test/iac-test-result';
+import {
+  IacTestResponse,
+  mapIacTestResult,
+} from '../../../lib/snyk-test/iac-test-result';
 import {
   SupportedPackageManagers,
   WIZARD_SUPPORTED_PACKAGE_MANAGERS,
@@ -181,7 +184,8 @@ async function test(...args: MethodArgs): Promise<TestCommandResult> {
   // values depend on `options.json` value - string or object
   const errorMappedResults = !options.iac
     ? createErrorMappedResultsForJsonOutput(results)
-    : createErrorMappedResultsForJsonOutputForIac(results);
+    : results.map(mapIacTestResult);
+
   // backwards compat - strip array IFF only one result
   const dataToSend =
     errorMappedResults.length === 1
@@ -310,25 +314,6 @@ function createErrorMappedResultsForJsonOutput(results) {
   return errorMappedResults;
 }
 
-function createErrorMappedResultsForJsonOutputForIac(results) {
-  const errorMappedResults = results.map((result) => {
-    // add json for when thrown exception
-    if (result instanceof Error) {
-      return {
-        ok: false,
-        error: result.message,
-        path: (result as any).path,
-      };
-    }
-    const res = { ...result, ...result.result };
-    delete res.result;
-    delete res.meta;
-    return res;
-  });
-
-  return errorMappedResults;
-}
-
 function shouldFail(vulnerableResults: any[], failOn: FailOn) {
   // find reasons not to fail
   if (failOn === 'all') {
@@ -488,7 +473,7 @@ function displayResult(
 
   if (res.packageManager === 'k8sconfig') {
     return getIacDisplayedOutput(
-      (res as any) as IacTestResult,
+      (res as any) as IacTestResponse,
       testedInfoText,
       meta,
       prefix,

src/lib/snyk-test/iac-test-result.ts

@@ -1,4 +1,4 @@
-import { BasicResultData, SEVERITY } from './legacy';
+import { BasicResultData, TestDepGraphMeta, SEVERITY } from './legacy';
 
 export interface AnnotatedIacIssue {
   id: string;
@@ -9,15 +9,78 @@ export interface AnnotatedIacIssue {
   cloudConfigPath: string[];
   type: string;
   subType: string;
+  path: string[];
+  // Legacy fields from Registry, unused.
+  name?: string;
+  from?: string[];
 }
 
-export interface IacTestResult extends BasicResultData {
+type FILTERED_OUT_FIELDS = 'cloudConfigPath' | 'name' | 'from';
+
+export interface IacTestResponse extends BasicResultData {
   targetFile: string;
   projectName: string;
   displayTargetFile: string; // used for display only
   foundProjectCount: number;
+  meta: TestDepGraphMeta;
   result: {
     cloudConfigResults: AnnotatedIacIssue[];
     projectType: string;
   };
 }
+
+const IAC_ISSUES_KEY = 'infrastructureAsCodeIssues';
+
+export function mapIacTestResult(
+  iacTest: IacTestResponse,
+): MappedIacTestResponse | IacTestError {
+  if (iacTest instanceof Error) {
+    return {
+      ok: false,
+      error: iacTest.message,
+      path: (iacTest as any).path,
+    };
+  }
+
+  const {
+    result: { projectType },
+    ...filteredIacTest
+  } = iacTest;
+  return {
+    ...filteredIacTest,
+    projectType,
+    [IAC_ISSUES_KEY]:
+      iacTest?.result?.cloudConfigResults.map(mapIacIssue) || [],
+  };
+}
+
+/**
+ * The following types represent manipulations to the data structure returned from Registry's `test-iac`.
+ * These manipulations are being done prior to outputing as JSON, for renaming fields only.
+ * The types above, IacTestResult & AnnotatedIacIssue, represent how the response from Registry actually is.
+ * These were introduced in order to prevent cascading complex changes caused by changing Registry's `test-iac` response.
+ */
+export interface IacTestError {
+  ok: boolean;
+  error: string;
+  path: string;
+}
+
+export interface MappedIacTestResponse extends Omit<IacTestResponse, 'result'> {
+  [IAC_ISSUES_KEY]: MappedAnnotatedIacIssue[];
+  projectType: string;
+}
+
+export interface MappedAnnotatedIacIssue
+  extends Omit<AnnotatedIacIssue, FILTERED_OUT_FIELDS> {
+  path: string[];
+}
+
+export function mapIacIssue(
+  iacIssue: AnnotatedIacIssue,
+): MappedAnnotatedIacIssue {
+  // filters out & renames properties we're getting from registry and don't need for the JSON output.
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  const { cloudConfigPath: path, name, from, ...mappedIacIssue } = iacIssue;
+  return { ...mappedIacIssue, path };
+}

src/lib/snyk-test/legacy.ts

@@ -221,7 +221,7 @@ interface TestDepGraphResult {
   remediation?: RemediationChanges;
 }
 
-interface TestDepGraphMeta {
+export interface TestDepGraphMeta {
   isPublic: boolean;
   isLicensesEnabled: boolean;
   licensesPolicy?: {

src/lib/snyk-test/run-iac-test.ts

@@ -2,7 +2,7 @@ import * as fs from 'fs';
 import * as path from 'path';
 import * as pathUtil from 'path';
 import { TestResult } from './legacy';
-import { IacTestResult } from './iac-test-result';
+import { IacTestResponse } from './iac-test-result';
 import * as snyk from '..';
 import { isCI } from '../is-ci';
 import * as common from './common';
@@ -14,7 +14,7 @@ import { SEVERITY } from './legacy';
 import * as pathLib from 'path';
 
 export async function parseIacTestResult(
-  res: IacTestResult,
+  res: IacTestResponse,
   targetFile: string | undefined,
   projectName: any,
   severityThreshold?: SEVERITY,

src/lib/snyk-test/run-test.ts

@@ -16,7 +16,7 @@ import {
   convertTestDepGraphResultToLegacy,
   LegacyVulnApiResult,
 } from './legacy';
-import { IacTestResult } from './iac-test-result';
+import { IacTestResponse } from './iac-test-result';
 import {
   AuthFailedError,
   InternalServerError,
@@ -79,7 +79,7 @@ async function sendAndParseResults(
     if (options.iac) {
       const iacScan: IacScan = payload.body as IacScan;
       analytics.add('iac type', !!iacScan.type);
-      const res = (await sendTestPayload(payload)) as IacTestResult;
+      const res = (await sendTestPayload(payload)) as IacTestResponse;
 
       const projectName =
         iacScan.projectNameOverride || iacScan.originalProjectName;
@@ -267,7 +267,7 @@ async function parseRes(
 
 function sendTestPayload(
   payload: Payload,
-): Promise<LegacyVulnApiResult | TestDepGraphResponse | IacTestResult> {
+): Promise<LegacyVulnApiResult | TestDepGraphResponse | IacTestResponse> {
   const filesystemPolicy = payload.body && !!payload.body.policy;
   return new Promise((resolve, reject) => {
     request(payload, (error, res, body) => {