Merge pull request #1704 from snyk/refactor/set-default-test-options

refactor: set default test options

src/cli/commands/protect/index.ts

@@ -12,7 +12,10 @@ import * as errors from '../../../lib/errors';
 const debug = debugModule('snyk');
 
 async function protectFunc(
-  options: types.PolicyOptions & types.Options & types.TestOptions,
+  options: types.PolicyOptions &
+    types.Options &
+    types.TestOptions &
+    types.ProtectOptions,
 ) {
   const protectOptions = { ...options };
   protectOptions.loose = true; // replace missing policies with empty ones

src/cli/commands/protect/wizard.ts

@@ -43,8 +43,8 @@ import {
   Options,
   MonitorMeta,
   MonitorResult,
-  WizardOptions,
   PackageJson,
+  ProtectOptions,
 } from '../../../lib/types';
 import { LegacyVulnApiResult } from '../../../lib/snyk-test/legacy';
 import { MultiProjectResult } from '@snyk/cli-interface/legacy/plugin';
@@ -82,7 +82,7 @@ async function processPackageManager(options: Options) {
   return Promise.resolve(options);
 }
 
-async function loadOrCreatePolicyFile(options: Options & WizardOptions) {
+async function loadOrCreatePolicyFile(options: Options & ProtectOptions) {
   let policyFile;
   try {
     policyFile = await snyk.policy.load(options['policy-path'], options);

src/cli/commands/test/index.ts

@@ -4,13 +4,11 @@ const cloneDeep = require('lodash.clonedeep');
 const assign = require('lodash.assign');
 import chalk from 'chalk';
 import * as snyk from '../../../lib';
-import * as config from '../../../lib/config';
 import { isCI } from '../../../lib/is-ci';
 import * as Debug from 'debug';
 import * as pathLib from 'path';
 import {
   Options,
-  ShowVulnPaths,
   SupportedProjectTypes,
   TestOptions,
 } from '../../../lib/types';
@@ -54,30 +52,17 @@ import * as iacLocalExecution from './iac-local-execution';
 import { validateCredentials } from './validate-credentials';
 import { generateSnykTestError } from './generate-snyk-test-error';
 import { validateTestOptions } from './validate-test-options';
+import { setDefaultTestOptions } from './set-default-test-options';
 import { processCommandArgs } from '../process-command-args';
 
 const debug = Debug('snyk-test');
 const SEPARATOR = '\n-------------------------------------------------------\n';
 
-const showVulnPathsMapping: Record<string, ShowVulnPaths> = {
-  false: 'none',
-  none: 'none',
-  true: 'some',
-  some: 'some',
-  all: 'all',
-};
-
 // TODO: avoid using `as any` whenever it's possible
 
 async function test(...args: MethodArgs): Promise<TestCommandResult> {
-  const { options, paths } = processCommandArgs(...args);
-  // org fallback to config unless specified
-  options.org = options.org || config.org;
-
-  // making `show-vulnerable-paths` 'some' by default.
-  const svpSupplied = (options['show-vulnerable-paths'] || '').toLowerCase();
-  options.showVulnPaths = showVulnPathsMapping[svpSupplied] || 'some';
-
+  const { options: originalOptions, paths } = processCommandArgs(...args);
+  const options = setDefaultTestOptions(originalOptions);
   validateTestOptions(options);
   validateCredentials(options);
 

src/cli/commands/test/set-default-test-options.ts

@@ -0,0 +1,25 @@
+import * as config from '../../../lib/config';
+import { Options, ShowVulnPaths, TestOptions } from '../../../lib/types';
+
+export function setDefaultTestOptions(options: Options): Options & TestOptions {
+  const svpSupplied = (options['show-vulnerable-paths'] || '')
+    .toString()
+    .toLowerCase();
+
+  delete options['show-vulnerable-paths'];
+  return {
+    ...options,
+    // org fallback to config unless specified
+    org: options.org || config.org,
+    // making `show-vulnerable-paths` 'some' by default.
+    showVulnPaths: showVulnPathsMapping[svpSupplied] || 'some',
+  };
+}
+
+const showVulnPathsMapping: Record<string, ShowVulnPaths> = {
+  false: 'none',
+  none: 'none',
+  true: 'some',
+  some: 'some',
+  all: 'all',
+};

src/lib/types.ts

@@ -13,8 +13,7 @@ export type DepTree = legacyApi.DepTree;
 export type ShowVulnPaths = 'none' | 'some' | 'all';
 
 export interface TestOptions {
-  traverseNodeModules: boolean;
-  interactive: boolean;
+  traverseNodeModules?: boolean;
   pruneRepeatedSubdependencies?: boolean;
   showVulnPaths: ShowVulnPaths;
   failOn?: FailOn;
@@ -27,7 +26,8 @@ export interface TestOptions {
   iacDirFiles?: IacFileInDirectory[];
 }
 
-export interface WizardOptions {
+export interface ProtectOptions {
+  interactive?: boolean;
   newPolicy: boolean;
 }
 
@@ -184,7 +184,8 @@ export type SupportedUserReachableFacingCliArgs =
   | 'reachable-vulns-timeout'
   | 'init-script'
   | 'integration-name'
-  | 'integration-version';
+  | 'integration-version'
+  | 'show-vulnerable-paths';
 
 export enum SupportedCliCommands {
   version = 'version',

test/run-test.spec.ts

@@ -15,7 +15,6 @@ describe('CLI runTest - propagate correct user error', () => {
     const options: Options & TestOptions = {
       path: '',
       traverseNodeModules: false,
-      interactive: false,
       showVulnPaths: 'none',
     };
 
@@ -37,7 +36,6 @@ describe('CLI runTest - propagate correct user error', () => {
     const options: Options & TestOptions = {
       path: '',
       traverseNodeModules: false,
-      interactive: false,
       showVulnPaths: 'none',
     };
 
@@ -59,7 +57,6 @@ describe('CLI runTest - propagate correct user error', () => {
     const options: Options & TestOptions = {
       path: '',
       traverseNodeModules: false,
-      interactive: false,
       showVulnPaths: 'none',
     };
 

test/set-default-test-options.spec.ts

@@ -0,0 +1,99 @@
+import { setDefaultTestOptions } from '../src/cli/commands/test/set-default-test-options';
+
+describe('setDefaultTestOptions', () => {
+  it('defaults to show-vulnerable-paths:some & org from config when no options passed in', () => {
+    const updated = setDefaultTestOptions({ path: '/' });
+    expect(updated).toEqual({
+      org: undefined,
+      path: '/',
+      showVulnPaths: 'some',
+    });
+  });
+
+  it('with show-vulnerable-paths set to `false` => `none`', () => {
+    const options = {
+      path: '/',
+      'show-vulnerable-paths': 'false',
+    };
+    const updated = setDefaultTestOptions(options);
+    expect(updated).toEqual({
+      org: undefined,
+      path: '/',
+      showVulnPaths: 'none',
+    });
+  });
+
+  it('with show-vulnerable-paths as boolean => `some`', () => {
+    const options = {
+      path: '/',
+      'show-vulnerable-paths': true,
+    };
+    const updated = setDefaultTestOptions(options as any);
+    expect(updated).toEqual({
+      org: undefined,
+      path: '/',
+      showVulnPaths: 'some',
+    });
+  });
+
+  it('with show-vulnerable-paths set to `none` => `none`', () => {
+    const options = {
+      path: '/',
+      'show-vulnerable-paths': 'none',
+    };
+    const updated = setDefaultTestOptions(options);
+    expect(updated).toEqual({
+      org: undefined,
+      path: '/',
+      showVulnPaths: 'none',
+    });
+  });
+
+  it('with show-vulnerable-paths set to `true` => `some`', () => {
+    const options = {
+      path: '/',
+      'show-vulnerable-paths': 'true',
+    };
+    const updated = setDefaultTestOptions(options);
+    expect(updated).toEqual({
+      org: undefined,
+      path: '/',
+      showVulnPaths: 'some',
+    });
+  });
+
+  it('with show-vulnerable-paths set to `some` => `some`', () => {
+    const options = {
+      path: '/',
+      'show-vulnerable-paths': 'some',
+    };
+    const updated = setDefaultTestOptions(options);
+    expect(updated).toEqual({
+      org: undefined,
+      path: '/',
+      showVulnPaths: 'some',
+    });
+  });
+
+  it('with show-vulnerable-paths set to `all` => `all`', () => {
+    const options = {
+      path: '/',
+      'show-vulnerable-paths': 'all',
+    };
+    const updated = setDefaultTestOptions(options);
+    expect(updated).toEqual({
+      org: undefined,
+      path: '/',
+      showVulnPaths: 'all',
+    });
+  });
+
+  it('with org set', () => {
+    const updated = setDefaultTestOptions({ path: '/', org: 'my-org' });
+    expect(updated).toEqual({
+      org: 'my-org',
+      path: '/',
+      showVulnPaths: 'some',
+    });
+  });
+});

test/snyk-code-test.spec.ts

@@ -63,7 +63,6 @@ describe('Test snyk code', () => {
     const options: Options & TestOptions = {
       path: '',
       traverseNodeModules: false,
-      interactive: false,
       showVulnPaths: 'none',
     };
     isFeatureFlagSupportedForOrgSpy.mockResolvedValueOnce({ code: 401 });
@@ -82,7 +81,6 @@ describe('Test snyk code', () => {
     const options: Options & TestOptions = {
       path: '',
       traverseNodeModules: false,
-      interactive: false,
       showVulnPaths: 'none',
       code: true,
     };