Merge pull request #1029 from snyk/fix/cli-error-message-on-snyk-test

fix: cli error message when <snyk test> command fails.

src/lib/errors/failed-to-get-vulns-from-unavailable-resource.ts

@@ -0,0 +1,20 @@
+import { CustomError } from './custom-error';
+
+const errorNpmMessage =
+  'Please check the version and package name and try running `snyk test` again.\nFor additional assistance, run `snyk help` or check out our docs \n(link to: https://support.snyk.io/hc/en-us/articles/360003851277#UUID-ba99a73f-110d-1f1d-9e7a-1bad66bf0996).';
+const errorRepositoryMessage =
+  'Try testing this repository at https://snyk.io/test/.\nFor additional assistance, run `snyk help` or check out our docs \n(link to: https://support.snyk.io/hc/en-us/articles/360003851277#UUID-ba99a73f-110d-1f1d-9e7a-1bad66bf0996).';
+
+export function FailedToGetVulnsFromUnavailableResource(
+  root: string,
+  statusCode: number,
+): CustomError {
+  const isRepository = root.startsWith('http' || 'https');
+  const errorMsg = `We couldn't test ${root}. ${
+    isRepository ? errorRepositoryMessage : errorNpmMessage
+  }`;
+  const error = new CustomError(errorMsg);
+  error.code = statusCode;
+  error.userMessage = errorMsg;
+  return error;
+}

src/lib/errors/index.ts

@@ -9,6 +9,7 @@ export { FailedToLoadPolicyError } from './failed-to-load-policy-error';
 export { PolicyNotFoundError } from './policy-not-found-error';
 export { InternalServerError } from './internal-server-error';
 export { FailedToGetVulnerabilitiesError } from './failed-to-get-vulnerabilities-error';
+export { FailedToGetVulnsFromUnavailableResource } from './failed-to-get-vulns-from-unavailable-resource';
 export { UnsupportedFeatureFlagError } from './unsupported-feature-flag-error';
 export { UnsupportedPackageManagerError } from './unsupported-package-manager-error';
 export { FailedToRunTestError } from './failed-to-run-test-error';

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

@@ -19,6 +19,7 @@ import {
   InternalServerError,
   NoSupportedManifestsFoundError,
   FailedToGetVulnerabilitiesError,
+  FailedToGetVulnsFromUnavailableResource,
   FailedToRunTestError,
 } from '../errors';
 import * as snyk from '../';
@@ -204,9 +205,19 @@ async function runTest(
     debug('Error running test', { error });
     // handling denial from registry because of the feature flag
     // currently done for go.mod
-    if (error.code === 403 && error.message.includes('Feature not allowed')) {
+    const isFeatureNotAllowed =
+      error.code === 403 && error.message.includes('Feature not allowed');
+
+    const hasFailedToGetVulnerabilities =
+      error.code === 404 &&
+      error.name.includes('FailedToGetVulnerabilitiesError');
+
+    if (isFeatureNotAllowed) {
       throw NoSupportedManifestsFoundError([root]);
     }
+    if (hasFailedToGetVulnerabilities) {
+      throw FailedToGetVulnsFromUnavailableResource(root, error.code);
+    }
 
     throw new FailedToRunTestError(
       error.userMessage ||

test/acceptance/cli-test/cli-test.generic.spec.ts

@@ -40,7 +40,7 @@ export const GenericTests: AcceptanceTests = {
       } catch (err) {
         t.equal(
           err.userMessage,
-          'cli error message',
+          "We couldn't test npm-package. Please check the version and package name and try running `snyk test` again.\nFor additional assistance, run `snyk help` or check out our docs \n(link to: https://support.snyk.io/hc/en-us/articles/360003851277#UUID-ba99a73f-110d-1f1d-9e7a-1bad66bf0996).",
           'got correct err message',
         );
       }
@@ -58,7 +58,7 @@ export const GenericTests: AcceptanceTests = {
       } catch (err) {
         t.equal(
           err.userMessage,
-          'cli error message',
+          "We couldn't test ruby-app. Please check the version and package name and try running `snyk test` again.\nFor additional assistance, run `snyk help` or check out our docs \n(link to: https://support.snyk.io/hc/en-us/articles/360003851277#UUID-ba99a73f-110d-1f1d-9e7a-1bad66bf0996).",
           'got correct err message',
         );
       }