Merge pull request #691 from snyk/feat/unsupported-package-manager-error

feat: Unsupported package manager error

src/lib/errors/index.ts

@@ -10,3 +10,4 @@ export {PolicyNotFoundError} from './policy-not-found-error';
 export {InternalServerError} from './internal-server-error';
 export {FailedToGetVulnerabilitiesError} from './failed-to-get-vulnerabilities-error';
 export {UnsupportedFeatureFlagError} from './unsupported-feature-flag-error';
+export {UnsupportedPackageManagerError} from './unsupported-package-manager-error';

src/lib/errors/unsupported-package-manager-error.ts

@@ -0,0 +1,17 @@
+import {CustomError} from './custom-error';
+import * as pms from '../package-managers';
+
+export class UnsupportedPackageManagerError extends CustomError {
+    private static ERROR_MESSAGE: string =
+        'Here are our supported package managers:' +
+        `${Object.keys(pms.SUPPORTED_PACKAGE_MANAGER_NAME)
+          .map((i) => '\n  - ' + i + ' (' + pms.SUPPORTED_PACKAGE_MANAGER_NAME[i] + ')')}
+        `;
+
+    constructor(packageManager) {
+        super(`Unsupported package manager ${packageManager}.` + UnsupportedPackageManagerError.ERROR_MESSAGE);
+        this.code = 422;
+        this.userMessage = `Unsupported package manager '${packageManager}''. ` +
+        UnsupportedPackageManagerError.ERROR_MESSAGE;
+    }
+}

src/lib/plugins/index.ts

@@ -10,6 +10,7 @@ import * as phpPlugin from 'snyk-php-plugin';
 import * as nodejsPlugin from './nodejs-plugin';
 import * as types from './types';
 import {SupportedPackageManagers} from '../package-managers';
+import { UnsupportedPackageManagerError } from '../errors';
 
 export function loadPlugin(packageManager: SupportedPackageManagers,
                            options: types.Options = {}): types.Plugin {
@@ -54,7 +55,7 @@ export function loadPlugin(packageManager: SupportedPackageManagers,
       return phpPlugin;
     }
     default: {
-      throw new Error(`Unsupported package manager: ${packageManager}`);
+      throw new UnsupportedPackageManagerError(packageManager);
     }
   }
 }

src/lib/snyk-test/index.js

@@ -4,6 +4,7 @@ const detect = require('../detect');
 const runTest = require('./run-test');
 const chalk = require('chalk');
 const pm = require('../package-managers');
+const {UnsupportedPackageManagerError} = require('../errors');
 
 function test(root, options, callback) {
   if (typeof options === 'function') {
@@ -49,7 +50,7 @@ function executeTest(root, options) {
 function run(root, options) {
   const packageManager = options.packageManager;
   if (!(options.docker || pm.SUPPORTED_PACKAGE_MANAGER_NAME[packageManager])) {
-    throw new Error('Unsupported package manager: ' + packageManager);
+    throw new UnsupportedPackageManagerError(packageManager);
   }
   return runTest(packageManager, root, options);
 }

test/acceptance/cli-args.test.ts

@@ -15,3 +15,14 @@ test('snyk test command should fail when --file is not specified correctly', (t)
     t.equal(stdout.trim(), 'Empty --file argument. Did you mean --file=path/to/file ?', 'correct error output');
   });
 });
+
+test('snyk test command should fail when --packageManager is not specified correctly', (t) => {
+  t.plan(1);
+
+  exec(`node ${main} test --packageManager=hello`, (err, stdout, stderr) => {
+    if (err) {
+      throw err;
+    }
+    t.match(stdout.trim(), 'Unsupported package manager', 'correct error output');
+  });
+});