fix: clearer error message when testing with fail-fast, all-projects, json flag combo

j-luong · CatalinSnyk · commit a396bd6ea4ab · 2025-04-14T18:39:28.000+03:00
diff --git a/src/lib/snyk-test/run-test.ts b/src/lib/snyk-test/run-test.ts
@@ -642,6 +642,13 @@ async function assembleLocalPayloads(
     const failedResults = (deps as MultiProjectResultCustom).failedResults;
     if (failedResults?.length) {
       await spinner.clear<void>(spinnerLbl)();
+      const isNotJsonOrQueiet = !options.json && !options.quiet;
+
+      const errorMessages = extractErrorMessages(
+        failedResults,
+        isNotJsonOrQueiet,
+      );
+
       if (!options.json && !options.quiet) {
         console.warn(
           chalk.bold.red(
@@ -650,21 +657,18 @@ async function assembleLocalPayloads(
             } potential projects failed to get dependencies.`,
           ),
         );
-        failedResults.forEach((f) => {
-          if (f.targetFile) {
-            console.warn(theme.color.status.error(`${f.targetFile}:`));
-          }
-          console.warn(theme.color.status.error(`  ${f.errMessage}`));
-        });
       }
       debug(
         'getDepsFromPlugin returned failed results, cannot run test/monitor',
         failedResults,
       );
       if (options['fail-fast']) {
-        throw new FailedToRunTestError(
-          errorMessageWithRetry('Your test request could not be completed.'),
-        );
+        // should include failure message if applicable
+        const message = errorMessages.length
+          ? errorMessages
+          : errorMessageWithRetry('Your test request could not be completed.');
+
+        throw new FailedToRunTestError(message);
       }
     }
     analytics.add('pluginName', deps.plugin.name);
@@ -930,3 +934,29 @@ function countUniqueVulns(vulns: AnnotatedIssue[]): number {
   }
   return Object.keys(seen).length;
 }
+
+function extractErrorMessages(
+  results: Array<any>,
+  shouldWarn: boolean,
+): string {
+  if (!results.length) {
+    return '';
+  }
+
+  const errorMessages: string[] = [];
+
+  results.forEach((f) => {
+    if (shouldWarn) {
+      if (f.targetFile) {
+        console.warn(theme.color.status.error(`${f.targetFile}:`));
+      }
+      console.warn(theme.color.status.error(`  ${f.errMessage}`));
+    }
+
+    errorMessages.push(
+      `${f.targetFile ? f.targetFile + ': ' : ''}${f.errMessage}`,
+    );
+  });
+
+  return errorMessages.join('\n');
+}
diff --git a/test/jest/acceptance/snyk-test/all-projects.spec.ts b/test/jest/acceptance/snyk-test/all-projects.spec.ts
@@ -78,9 +78,7 @@ describe('snyk test --all-projects (mocked server only)', () => {
     );
     expect(code).toEqual(2);
 
-    expect(stdout).toContainText(
-      'Your test request could not be completed.\nTip: Re-run in debug mode to see more information: DEBUG=*snyk* <COMMAND>\nIf the issue persists contact support@snyk.io',
-    );
+    expect(stdout).toContainText('SNYK-CLI-0000');
     expect(stderr).toMatch(
       '✗ 1/3 potential projects failed to get dependencies',
     );
@@ -89,6 +87,31 @@ describe('snyk test --all-projects (mocked server only)', () => {
     );
   });
 
+  test('`test yarn-out-of-sync` with --fail-fast and --json errors the whole scan', async () => {
+    const project = await createProjectFromWorkspace(
+      'yarn-workspace-out-of-sync',
+    );
+
+    const { code, stdout } = await runSnykCLI(
+      'test --all-projects --fail-fast --json',
+      {
+        cwd: project.path(),
+        env,
+      },
+    );
+    expect(code).toEqual(2);
+    let jsonResponse;
+    try {
+      jsonResponse = JSON.parse(stdout);
+    } catch (error) {
+      throw new Error(`test command did not return a valid json: ${error}`);
+    }
+    expect(jsonResponse?.ok).toBe(false);
+    expect(jsonResponse?.error).toMatch(
+      `Dependency snyk@1.320.0 was not found in yarn.lock. Your package.json and yarn.lock are probably out of sync. Please run "yarn install" and try again.`,
+    );
+  });
+
   test('`test yarn-out-of-sync` --strict-out-of-sync=false scans all the workspace projects', async () => {
     const project = await createProjectFromWorkspace(
       'yarn-workspace-out-of-sync',
