fix: update share results message for iac v2

alina-d-m · sandor-trombitas · commit 1c9b3b30d5ed · 2025-02-07T10:11:55.000+02:00
Updates the user messages for snyk iac test --report for IaC V2.
diff --git a/src/cli/commands/test/iac/output.ts b/src/cli/commands/test/iac/output.ts
@@ -32,7 +32,11 @@ import {
   shareResultsTip,
   formatTestData,
 } from '../../../../lib/formatters/iac-output/text';
-import { formatShareResultsOutputV2 } from '../../../../lib/formatters/iac-output/text/share-results';
+import {
+  formatShareResultsOutputIacV2,
+  formatShareResultsOutputIacPlus,
+  shareResultsError,
+} from '../../../../lib/formatters/iac-output/text/share-results';
 
 const SEPARATOR = '\n-------------------------------------------------------\n';
 
@@ -270,7 +274,7 @@ export function buildShareResultsSummary({
   return response;
 }
 
-export function buildShareResultsSummaryV2({
+export function buildShareResultsSummaryIacPlus({
   orgName,
   projectName,
   options,
@@ -286,7 +290,7 @@ export function buildShareResultsSummaryV2({
   let response = '';
 
   response +=
-    SEPARATOR + EOL + formatShareResultsOutputV2(orgName, projectName);
+    SEPARATOR + EOL + formatShareResultsOutputIacPlus(orgName, projectName);
 
   if (
     shouldPrintShareCustomRulesDisclaimer(
@@ -301,6 +305,21 @@ export function buildShareResultsSummaryV2({
   return response;
 }
 
+export function buildShareResultsSummaryIacV2({
+  orgName,
+  projectPublicId,
+}: {
+  orgName: string;
+  projectPublicId: string | undefined;
+}): string {
+  let response = SEPARATOR + EOL;
+  response += projectPublicId
+    ? formatShareResultsOutputIacV2(orgName, projectPublicId)
+    : shareResultsError;
+
+  return response;
+}
+
 export function shouldPrintShareResultsTip(options: IaCTestFlags): boolean {
   return shouldLogUserMessages(options) && !options.report;
 }
diff --git a/src/cli/commands/test/iac/v2/index.ts b/src/cli/commands/test/iac/v2/index.ts
@@ -33,6 +33,7 @@ export async function test(
       scanResult,
       testSpinner,
       options,
+      iacNewEngine,
     });
   } finally {
     testSpinner?.stop();
diff --git a/src/lib/formatters/iac-output/text/share-results.ts b/src/lib/formatters/iac-output/text/share-results.ts
@@ -17,7 +17,7 @@ export function formatShareResultsOutput(orgName: string, projectName: string) {
   );
 }
 
-export function formatShareResultsOutputV2(
+export function formatShareResultsOutputIacPlus(
   orgName: string,
   projectName: string,
 ) {
@@ -37,6 +37,25 @@ export function formatShareResultsOutputV2(
   );
 }
 
+export function formatShareResultsOutputIacV2(
+  orgName: string,
+  projectPublicId: string | undefined,
+) {
+  let projectLink = ''; // empty link if projectId is undefined, will follow up on this after product decision
+  if (projectPublicId) {
+    projectLink = `${config.ROOT}/org/${orgName}/project/${encodeURIComponent(projectPublicId)}`;
+  }
+
+  return (
+    colors.title('Report Complete') +
+    EOL +
+    EOL +
+    contentPadding +
+    'Your test results are available at: ' +
+    colors.title(projectLink)
+  );
+}
+
 export const shareResultsTip =
   colors.title('Tip') +
   EOL +
@@ -50,3 +69,14 @@ export const shareCustomRulesDisclaimer =
   colors.suggestion(
     'Please note that your custom rules will not be sent to the platform, and will not be available on the projects page.',
   );
+
+export const shareResultsError =
+  colors.title('Failed to create and display results in Snyk UI') +
+  EOL +
+  EOL +
+  contentPadding +
+  'There was a problem creating the project and displaying the test results in Snyk UI.' +
+  EOL +
+  contentPadding +
+  colors.title('Need help?') +
+  ' Check the Snyk CLI for IaC doc https://docs.snyk.io/snyk-cli/scan-and-maintain-projects-using-the-cli/snyk-cli-for-iac';
diff --git a/src/lib/iac/test/v2/local-cache/policy-engine/constants/utils.ts b/src/lib/iac/test/v2/local-cache/policy-engine/constants/utils.ts
@@ -1,11 +1,11 @@
 import * as os from 'os';
 
 const policyEngineChecksums = `
-aeb08fbecd094cdec741237f0f9f187492fa4e446f41e3dc7135426fdd721382  snyk-iac-test_0.57.4_Darwin_x86_64
-b9607371e0372b382c6e92fdbe1624364baf3b2d4856312c32567de4ed0bdc72  snyk-iac-test_0.57.4_Darwin_arm64
-c4447339c352c646bfa79bf12aef108e8c9f0263ac2440fe7e5edafa46ba433d  snyk-iac-test_0.57.4_Linux_arm64
-fa327f0909b43b59bb76dfd54f99603859a2606663390aad16abe484f6ef8765  snyk-iac-test_0.57.4_Windows_x86_64.exe
-fe0604529047aa5fcd3edffe5f1b9392bfc255f94885d745266aca768f521907  snyk-iac-test_0.57.4_Linux_x86_64
+2bece98c6602298aab72fe8be803cd48974b63766c2a53491761d0855dccef0d  snyk-iac-test_0.57.5_Darwin_x86_64
+3703de51908fb24ea11358c1f97643937b502a43afac5131d45c11a321138687  snyk-iac-test_0.57.5_Windows_x86_64.exe
+458e9debc734006ce6bb4ae530111ad0548a3d85ca43f8b4b5f0b17994e75efd  snyk-iac-test_0.57.5_Linux_arm64
+c624ddaa85851ed8c9fb54895c8834d0f04221066feb7d08afd2413ae2cf97cc  snyk-iac-test_0.57.5_Darwin_arm64
+d15e89f5933933b13693f5ee42b27799825a1abc16e0bdbd5a2c40c5b5af8f9b  snyk-iac-test_0.57.5_Linux_x86_64
 `;
 
 export const policyEngineVersion = getPolicyEngineVersion();
diff --git a/src/lib/iac/test/v2/output.ts b/src/lib/iac/test/v2/output.ts
@@ -25,7 +25,8 @@ import stripAnsi = require('strip-ansi');
 import * as path from 'path';
 import { getErrorStringCode } from '../../../../cli/commands/test/iac/local-execution/error-utils';
 import {
-  buildShareResultsSummaryV2,
+  buildShareResultsSummaryIacV2,
+  buildShareResultsSummaryIacPlus,
   shouldPrintShareResultsTip,
 } from '../../../../cli/commands/test/iac/output';
 import {
@@ -40,10 +41,12 @@ export function buildOutput({
   scanResult,
   testSpinner,
   options,
+  iacNewEngine,
 }: {
   scanResult: TestOutput;
   testSpinner?: Ora;
   options: any;
+  iacNewEngine?: boolean;
 }): TestCommandResult {
   if (scanResult.results) {
     testSpinner?.succeed(spinnerSuccessMessage);
@@ -54,6 +57,7 @@ export function buildOutput({
   const { responseData, jsonData, sarifData } = buildTestCommandResultData({
     scanResult,
     options,
+    iacNewEngine,
   });
 
   if (options.json || options.sarif) {
@@ -74,9 +78,11 @@ export function buildOutput({
 function buildTestCommandResultData({
   scanResult,
   options,
+  iacNewEngine,
 }: {
   scanResult: TestOutput;
   options: any;
+  iacNewEngine?: boolean;
 }) {
   const projectName =
     scanResult.results?.metadata?.projectName ?? path.basename(process.cwd());
@@ -108,6 +114,7 @@ function buildTestCommandResultData({
       scanResult,
       projectName,
       options,
+      iacNewEngine,
     });
   }
 
@@ -129,10 +136,12 @@ function buildTextOutput({
   scanResult,
   projectName,
   options,
+  iacNewEngine,
 }: {
   scanResult: TestOutput;
   projectName: string;
   options: IaCTestFlags;
+  iacNewEngine?: boolean;
 }): string {
   let response = '';
 
@@ -177,24 +186,34 @@ function buildTextOutput({
   response += EOL;
 
   if (options.report) {
-    response += buildShareResultsSummaryV2({
-      orgName: scanResult.settings.org,
-      projectName,
-      options,
-      isIacCustomRulesEntitlementEnabled: false, // TODO: update when we add custom rules support
-      isIacShareCliResultsCustomRulesSupported: false, // TODO: update when we add custom rules support
-    });
+    if (iacNewEngine) {
+      response += buildShareResultsSummaryIacV2({
+        orgName: scanResult.settings.org,
+        projectPublicId: scanResult.results?.metadata.projectPublicId,
+      });
+    } else {
+      response += buildShareResultsSummaryIacPlus({
+        orgName: scanResult.settings.org,
+        projectName,
+        options,
+        isIacCustomRulesEntitlementEnabled: false, // TODO: update when we add custom rules support
+        isIacShareCliResultsCustomRulesSupported: false, // TODO: update when we add custom rules support
+      });
+    }
+
     response += EOL;
   }
 
   if (shouldPrintShareResultsTip(options)) {
     response += SEPARATOR + EOL + shareResultsTip + EOL;
   }
 
-  response += EOL;
-  response += colors.title('Info') + EOL;
-  response += EOL;
-  response += wrapWithPadding(infoMessage(scanResult), 80) + EOL;
+  if (!iacNewEngine) {
+    response += EOL;
+    response += colors.title('Info') + EOL;
+    response += EOL;
+    response += wrapWithPadding(infoMessage(scanResult), 80) + EOL;
+  }
 
   return response;
 }
diff --git a/src/lib/iac/test/v2/scan/results.ts b/src/lib/iac/test/v2/scan/results.ts
@@ -71,6 +71,7 @@ export interface Results {
 
 export interface Metadata {
   projectName: string;
+  projectPublicId: string;
   ignoredCount: number;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -71,6 +71,7 @@ export interface Results {`
`71`	`71`
`72`	`72`	`export interface Metadata {`
`73`	`73`	`projectName: string;`
	`74`	`+ projectPublicId: string;`
`74`	`75`	`ignoredCount: number;`
`75`	`76`	`}`
`76`	`77`