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.

Sign up for GitHub

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

Jump to bottom

fix extension and spec handling; closes #3808 #3834

Merged
merged 2 commits into from May 5, 2019
Merged

fix extension and spec handling; closes #3808 #3834

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
544a841
fix extension handling; closes #3808
boneskull Mar 14, 2019
2d1dc34
use yargs-parser options.default
juergba Apr 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 5 additions & 3 deletions lib/cli/options.js
View file
Open in desktop
Expand Up @@ -80,11 +80,12 @@ const nargOpts = types.array
/**
* Wrapper around `yargs-parser` which applies our settings
* @param {string|string[]} args - Arguments to parse
* @param {Object} defaultValues - Default values of mocharc.json
* @param {...Object} configObjects - `configObjects` for yargs-parser
* @private
* @ignore
*/
const parse = (args = [], ...configObjects) => {
const parse = (args = [], defaultValues = {}, ...configObjects) => {
// save node-specific args for special handling.
// 1. when these args have a "=" they should be considered to have values
// 2. if they don't, they just boolean flags
Expand All @@ -109,6 +110,7 @@ const parse = (args = [], ...configObjects) => {
const result = yargsParser.detailed(args, {
configuration,
configObjects,
default: defaultValues,
coerce: coerceOpts,
narg: nargOpts,
alias: aliases,
Expand Down Expand Up @@ -324,11 +326,11 @@ const loadOptions = (argv = []) => {

args = parse(
args._,
mocharc,
args,
rcConfig || {},
pkgConfig || {},
optsConfig || {},
mocharc
optsConfig || {}
);

// recombine positional arguments and "spec"
Expand Down
4 changes: 2 additions & 2 deletions lib/cli/run-helpers.js
View file
Open in desktop
Expand Up @@ -219,7 +219,7 @@ exports.singleRun = (mocha, {files = [], exit = false} = {}) => {
*/
exports.watchRun = (
mocha,
{extension = ['js'], grep = '', ui = 'bdd', files = []} = {}
{extension = [], grep = '', ui = 'bdd', files = []} = {}
) => {
let runner;

Expand Down Expand Up @@ -291,7 +291,7 @@ exports.watchRun = (
*/
exports.runMocha = (
mocha,
{watch = false, extension = ['js'], grep = '', ui = 'bdd', exit = false} = {},
{watch = false, extension = [], grep = '', ui = 'bdd', exit = false} = {},
files = []
) => {
if (watch) {
Expand Down
16 changes: 10 additions & 6 deletions lib/utils.js
View file
Open in desktop
Expand Up @@ -562,7 +562,6 @@ function isHiddenOnUnix(pathname) {
*
* @public
* @memberof Mocha.utils
* @todo Fix extension handling
* @param {string} filepath - Base path to start searching from.
* @param {string[]} extensions - File extensions to look for.
* @param {boolean} recursive - Whether to recurse into subdirectories.
Expand All @@ -571,13 +570,18 @@ function isHiddenOnUnix(pathname) {
* @throws {TypeError} if `filepath` is directory and `extensions` not provided.
*/
exports.lookupFiles = function lookupFiles(filepath, extensions, recursive) {
extensions = extensions || [];
var files = [];
var stat;

if (!fs.existsSync(filepath)) {
if (fs.existsSync(filepath + '.js')) {
filepath += '.js';
} else {
// check all extensions
extensions.forEach(function(ext) {
if (fs.existsSync(filepath + '.' + ext)) {
files.push(filepath + '.' + ext);
}
});
if (!files.length) {
// Handle glob
files = glob.sync(filepath);
if (!files.length) {
Expand All @@ -586,8 +590,8 @@ exports.lookupFiles = function lookupFiles(filepath, extensions, recursive) {
filepath
);
}
return files;
}
return files;
}

// Handle file
Expand Down Expand Up @@ -618,7 +622,7 @@ exports.lookupFiles = function lookupFiles(filepath, extensions, recursive) {
// ignore error
return;
}
if (!extensions) {
if (!extensions.length) {
throw createMissingArgumentError(
util.format(
'Argument %s required when argument %s is a directory',
Expand Down
13 changes: 9 additions & 4 deletions test/integration/file-utils.spec.js
View file
Open in desktop
Expand Up @@ -58,17 +58,22 @@ describe('file utils', function() {
ex.and('to have length', expectedLength);
});

it('should parse extensions from extnsions parameter', function() {
it('should parse extensions from extensions parameter', function() {
var nonJsFile = tmpFile('mocha-utils-text.txt');
fs.writeFileSync(nonJsFile, 'yippy skippy ying yang yow');

var res = utils.lookupFiles(tmpDir, ['txt'], false);
expect(res, 'to contain', nonJsFile).and('to have length', 1);
});

it('should not require the extensions parameter when looking up a file', function() {
var res = utils.lookupFiles(tmpFile('mocha-utils'), undefined, false);
expect(res, 'to be', tmpFile('mocha-utils.js'));
it('should require the extensions parameter when looking up a file', function() {
var dirLookup = function() {
return utils.lookupFiles(tmpFile('mocha-utils'), undefined, false);
};
expect(dirLookup, 'to throw', {
name: 'Error',
code: 'ERR_MOCHA_NO_FILES_MATCH_PATTERN'
});
});

it('should require the extensions parameter when looking up a directory', function() {
Expand Down
90 changes: 83 additions & 7 deletions test/node-unit/cli/options.spec.js
View file
Open in desktop
Expand Up @@ -27,7 +27,9 @@ const defaults = {
timeout: 1000,
timeouts: 1000,
t: 1000,
opts: '/default/path/to/mocha.opts'
opts: '/default/path/to/mocha.opts',
extension: ['js'],
'watch-extensions': ['js']
};

describe('options', function() {
Expand Down Expand Up @@ -59,6 +61,7 @@ describe('options', function() {
describe('loadOptions()', function() {
describe('when no parameter provided', function() {
beforeEach(function() {
this.timeout(500);
readFileSync = sandbox.stub();
readFileSync.onFirstCall().returns('{}');
readFileSync.onSecondCall().returns('--retries 3');
Expand Down Expand Up @@ -497,8 +500,8 @@ describe('options', function() {
beforeEach(function() {
readFileSync = sandbox.stub();
config = '/some/.mocharc.json';
readFileSync.onFirstCall().returns('--retries 3');
readFileSync.onSecondCall().returns('{}');
readFileSync.onFirstCall().returns('{}');
readFileSync.onSecondCall().returns('--retries 3');
findConfig = sandbox.stub();
loadConfig = sandbox.stub().throws('Error', 'failed to parse');
findupSync = sandbox.stub().returns('/some/package.json');
Expand Down Expand Up @@ -542,8 +545,8 @@ describe('options', function() {

beforeEach(function() {
readFileSync = sandbox.stub();
readFileSync.onFirstCall().returns('--retries 3');
readFileSync.onSecondCall().returns('{}');
readFileSync.onFirstCall().returns('{}');
readFileSync.onSecondCall().throws();
findConfig = sandbox.stub().returns('/some/.mocharc.json');
loadConfig = sandbox.stub().returns({});
findupSync = sandbox.stub().returns('/some/package.json');
Expand Down Expand Up @@ -578,8 +581,8 @@ describe('options', function() {

beforeEach(function() {
readFileSync = sandbox.stub();
readFileSync.onFirstCall().returns('--retries 3');
readFileSync.onSecondCall().returns('{}');
readFileSync.onFirstCall().returns('{}');
readFileSync.onSecondCall().throws();
findConfig = sandbox.stub().returns(null);
loadConfig = sandbox.stub().returns({});
findupSync = sandbox.stub().returns('/some/package.json');
Expand Down Expand Up @@ -716,5 +719,78 @@ describe('options', function() {
});
});
});

describe('"extension" handling', function() {
describe('when user supplies "extension" option', function() {
let result;

beforeEach(function() {
readFileSync = sandbox.stub();
readFileSync.onFirstCall().throws();
findConfig = sandbox.stub().returns('/some/.mocharc.json');
loadConfig = sandbox.stub().returns({extension: ['tsx']});
findupSync = sandbox.stub();
loadOptions = proxyLoadOptions({
readFileSync,
findConfig,
loadConfig,
findupSync
});
result = loadOptions(['--extension', 'ts']);
});

it('should not concatenate the default value', function() {
expect(result, 'to have property', 'extension', ['ts', 'tsx']);
});
});

describe('when user does not supply "extension" option', function() {
let result;

beforeEach(function() {
readFileSync = sandbox.stub();
readFileSync.onFirstCall().throws();
findConfig = sandbox.stub().returns('/some/.mocharc.json');
loadConfig = sandbox.stub().returns({});
findupSync = sandbox.stub();
loadOptions = proxyLoadOptions({
readFileSync,
findConfig,
loadConfig,
findupSync
});
result = loadOptions();
});

it('should retain the default', function() {
expect(result, 'to have property', 'extension', ['js']);
});
});
});

describe('"spec" handling', function() {
describe('when user supplies "spec" in config and positional arguments', function() {
let result;

beforeEach(function() {
readFileSync = sandbox.stub();
readFileSync.onFirstCall().throws();
findConfig = sandbox.stub().returns('/some/.mocharc.json');
loadConfig = sandbox.stub().returns({spec: '*.spec.js'});
findupSync = sandbox.stub();
loadOptions = proxyLoadOptions({
readFileSync,
findConfig,
loadConfig,
findupSync
});
result = loadOptions(['*.test.js']);
});

it('should place both into the positional arguments array', function() {
expect(result, 'to have property', '_', ['*.test.js', '*.spec.js']);
});
});
});
});
});