Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: correctly document behavior of --strict-out-of-sync and avoid string typed booleans #779

Merged
merged 3 commits into from
Sep 30, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions help/help.txt
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,11 @@ Gradle options:

Npm options:
--strict-out-of-sync=<true|false>
Allow testing out of sync lockfile. Defauls to false.
Allow testing out of sync lockfile. Defauls to true.
darscan marked this conversation as resolved.
Show resolved Hide resolved

Yarn options:
--strict-out-of-sync=<true|false>
Allow testing out of sync lockfile. Defauls to false.
Allow testing out of sync lockfile. Defauls to true.

Python options:
--command=<string> Python interpreter to use. Default: "python", set to
Expand Down
8 changes: 8 additions & 0 deletions src/cli/args.ts
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,14 @@ export function args(rawArgv: string[]): Args {
}
}

if (argv.strictOutOfSync !== undefined) {
if (argv.strictOutOfSync === 'false') {
argv.strictOutOfSync = false;
} else {
argv.strictOutOfSync = true;
}
}

// Alias
if (argv.gradleSubProject) {
argv.subProject = argv.gradleSubProject;
Expand Down
3 changes: 1 addition & 2 deletions src/lib/plugins/nodejs-plugin/npm-lock-parser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import * as baseDebug from 'debug';
const debug = baseDebug('snyk');
import * as path from 'path';
import * as spinner from '../../spinner';
import * as _ from 'lodash';
import * as analytics from '../../analytics';
import * as fs from 'fs';
import * as lockFileParser from 'snyk-nodejs-lockfile-parser';
Expand Down Expand Up @@ -46,7 +45,7 @@ export async function parse(root: string, targetFile: string, options: Options):
debug(resolveModuleSpinnerLabel);
try {
await spinner(resolveModuleSpinnerLabel);
const strictOutOfSync = _.get(options, 'strictOutOfSync') !== 'false';
const strictOutOfSync = options.strictOutOfSync !== false;
return lockFileParser
.buildDepTree(manifestFile, lockFile, options.dev, lockFileType, strictOutOfSync);
darscan marked this conversation as resolved.
Show resolved Hide resolved
} finally {
Expand Down
2 changes: 1 addition & 1 deletion src/lib/plugins/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export interface Options {
docker?: boolean;
traverseNodeModules?: boolean;
dev?: boolean;
strictOutOfSync?: boolean | 'true' | 'false';
strictOutOfSync?: boolean;
allSubProjects?: boolean;
debug?: boolean;
packageManager?: string;
Expand Down
6 changes: 3 additions & 3 deletions test/acceptance/cli.acceptance.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1063,7 +1063,7 @@ test('`test yarn-out-of-sync` out of sync fails', async (t) => {

test('`test yarn-out-of-sync --strict-out-of-sync=false` passes', async (t) => {
chdirWorkspaces();
await cli.test('yarn-out-of-sync', { dev: true, strictOutOfSync: 'false'});
await cli.test('yarn-out-of-sync', { dev: true, strictOutOfSync: false});
const req = server.popRequest();
t.match(req.url, '/test-dep-graph', 'posts to correct url');
const depGraph = req.body.depGraph;
Expand Down Expand Up @@ -1103,7 +1103,7 @@ test('`test yarn-out-of-sync --strict-out-of-sync=false` passes', async (t) => {

test('`test npm-out-of-sync --strict-out-of-sync=false` passes', async (t) => {
chdirWorkspaces();
await cli.test('npm-out-of-sync', { dev: true, strictOutOfSync: 'false' });
await cli.test('npm-out-of-sync', { dev: true, strictOutOfSync: false });
const req = server.popRequest();
t.match(req.url, '/test-dep-graph', 'posts to correct url');
const depGraph = req.body.depGraph;
Expand Down Expand Up @@ -2481,7 +2481,7 @@ test('`monitor npm-package`', async (t) => {

test('`monitor npm-out-of-sync`', async (t) => {
chdirWorkspaces();
await cli.monitor('npm-out-of-sync-graph', { 'experimental-dep-graph': true, strictOutOfSync: 'false' });
await cli.monitor('npm-out-of-sync-graph', { 'experimental-dep-graph': true, strictOutOfSync: false });
const req = server.popRequest();
t.match(req.url, '/monitor/npm/graph', 'puts at correct url');
t.ok(req.body.depGraphJSON, 'sends depGraphJSON');
Expand Down
36 changes: 36 additions & 0 deletions test/args.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -78,3 +78,39 @@ test('test command line test --gradle-sub-project=foo', function(t) {
t.equal(result.options.subProject, 'foo');
t.end();
});

test('test command line test --strict-out-of-sync', function(t) {
t.plan(1);
var cliArgs = [ '/Users/dror/.nvm/versions/node/v6.9.2/bin/node',
'/Users/dror/work/snyk/snyk-internal/cli',
'test',
'--strict-out-of-sync',
];
var result = args(cliArgs);
t.equal(result.options.strictOutOfSync, true);
t.end();
});

test('test command line test --strict-out-of-sync=true', function(t) {
t.plan(1);
var cliArgs = [ '/Users/dror/.nvm/versions/node/v6.9.2/bin/node',
'/Users/dror/work/snyk/snyk-internal/cli',
'test',
'--strict-out-of-sync=true',
];
var result = args(cliArgs);
t.equal(result.options.strictOutOfSync, true);
t.end();
});

test('test command line test --strict-out-of-sync=false', function(t) {
t.plan(1);
var cliArgs = [ '/Users/dror/.nvm/versions/node/v6.9.2/bin/node',
'/Users/dror/work/snyk/snyk-internal/cli',
'test',
'--strict-out-of-sync=false',
];
var result = args(cliArgs);
t.equal(result.options.strictOutOfSync, false);
t.end();
});