ava 0.21.0 → 0.25.0

package/api.js

@@ -2,9 +2,11 @@
 const EventEmitter = require('events');
 const path = require('path');
 const fs = require('fs');
+const os = require('os');
 const commonPathPrefix = require('common-path-prefix');
 const uniqueTempDir = require('unique-temp-dir');
 const findCacheDir = require('find-cache-dir');
+const isCi = require('is-ci');
 const resolveCwd = require('resolve-cwd');
 const debounce = require('lodash.debounce');
 const autoBind = require('auto-bind');
@@ -53,6 +55,7 @@ class Api extends EventEmitter {
 		this.options = Object.assign({match: []}, options);
 		this.options.require = resolveModules(this.options.require);
 	}
+
 	_runFile(file, runStatus, execArgv) {
 		const hash = this.precompiler.precompileFile(file);
 		const precompiled = Object.assign({}, this._precompiledHelpers);
@@ -69,17 +72,20 @@ class Api extends EventEmitter {
 
 		return emitter;
 	}
+
 	run(files, options) {
 		return new AvaFiles({cwd: this.options.resolveTestsFrom, files})
 			.findTestFiles()
 			.then(files => this._run(files, options));
 	}
+
 	_onTimeout(runStatus) {
 		const timeout = ms(this.options.timeout);
 		const err = new AvaError(`Exited because no new tests completed within the last ${timeout}ms of inactivity`);
 		this._handleError(runStatus, err);
 		runStatus.emit('timeout');
 	}
+
 	_setupTimeout(runStatus) {
 		const timeout = ms(this.options.timeout);
 
@@ -90,9 +96,11 @@ class Api extends EventEmitter {
 		runStatus._restartTimer();
 		runStatus.on('test', runStatus._restartTimer);
 	}
+
 	_cancelTimeout(runStatus) {
 		runStatus._restartTimer.cancel();
 	}
+
 	_setupPrecompiler(files) {
 		const isCacheEnabled = this.options.cacheEnabled !== false;
 		let cacheDir = uniqueTempDir();
@@ -119,6 +127,7 @@ class Api extends EventEmitter {
 				});
 			});
 	}
+
 	_precompileHelpers() {
 		this._precompiledHelpers = {};
 
@@ -134,6 +143,7 @@ class Api extends EventEmitter {
 				this._precompiledHelpers[file] = hash;
 			});
 	}
+
 	_run(files, options) {
 		options = options || {};
 
@@ -160,18 +170,20 @@ class Api extends EventEmitter {
 					this._setupTimeout(runStatus);
 				}
 
-				let overwatch;
+				let concurrency = Math.min(os.cpus().length, isCi ? 2 : Infinity);
+
 				if (this.options.concurrency > 0) {
-					const concurrency = this.options.serial ? 1 : this.options.concurrency;
-					overwatch = this._runWithPool(files, runStatus, concurrency);
-				} else {
-					// _runWithoutPool exists to preserve legacy behavior, specifically around `.only`
-					overwatch = this._runWithoutPool(files, runStatus);
+					concurrency = this.options.concurrency;
+				}
+
+				if (this.options.serial) {
+					concurrency = 1;
 				}
 
-				return overwatch;
+				return this._runWithPool(files, runStatus, concurrency);
 			});
 	}
+
 	_computeForkExecArgs(files) {
 		const execArgv = this.options.testOnlyExecArgv || process.execArgv;
 		let debugArgIndex = -1;
@@ -217,85 +229,14 @@ class Api extends EventEmitter {
 				return forkExecArgv;
 			});
 	}
+
 	_handleError(runStatus, err) {
 		runStatus.handleExceptions({
 			exception: err,
 			file: err.file ? path.relative(process.cwd(), err.file) : undefined
 		});
 	}
-	_runWithoutPool(files, runStatus) {
-		const tests = [];
-		let execArgvList;
-
-		// TODO: This should be cleared at the end of the run
-		runStatus.on('timeout', () => {
-			tests.forEach(fork => {
-				fork.exit();
-			});
-		});
 
-		return this._computeForkExecArgs(files)
-			.then(argvList => {
-				execArgvList = argvList;
-			})
-			.return(files)
-			.each((file, index) => {
-				return new Promise(resolve => {
-					const forkArgs = execArgvList[index];
-					const test = this._runFile(file, runStatus, forkArgs);
-					tests.push(test);
-					test.on('stats', resolve);
-					test.catch(resolve);
-				}).catch(err => {
-					err.results = [];
-					err.file = file;
-					return Promise.reject(err);
-				});
-			})
-			.then(() => {
-				if (this.options.match.length > 0 && !runStatus.hasExclusive) {
-					const err = new AvaError('Couldn\'t find any matching tests');
-					err.file = undefined;
-					err.results = [];
-					return Promise.reject(err);
-				}
-
-				const method = this.options.serial ? 'mapSeries' : 'map';
-				const options = {
-					runOnlyExclusive: runStatus.hasExclusive
-				};
-
-				return Promise[method](files, (file, index) => {
-					return tests[index].run(options).catch(err => {
-						err.file = file;
-						this._handleError(runStatus, err);
-						return getBlankResults();
-					});
-				});
-			})
-			.catch(err => {
-				this._handleError(runStatus, err);
-				return err.results;
-			})
-			.tap(results => {
-				// If no tests ran, make sure to tear down the child processes
-				if (results.length === 0) {
-					tests.forEach(test => {
-						test.send('teardown');
-					});
-				}
-			})
-			.then(results => {
-				// Cancel debounced _onTimeout() from firing
-				if (this.options.timeout) {
-					this._cancelTimeout(runStatus);
-				}
-
-				runStatus.processResults(results);
-
-				return runStatus;
-			});
-	}
 	_runWithPool(files, runStatus, concurrency) {
 		const tests = [];
 		let execArgvList;

package/cli.js

@@ -8,7 +8,7 @@ if (importLocal(__filename)) {
 	debug('Using local install of AVA');
 } else {
 	if (debug.enabled) {
-		require('time-require'); // eslint-disable-line import/no-unassigned-import
+		require('@ladjs/time-require'); // eslint-disable-line import/no-unassigned-import
 	}
 
 	try {

package/index.js.flow

@@ -69,7 +69,7 @@ type AssertContext = {
 	// Assert that contents matches regex.
 	regex(contents: string, regex: RegExp, message?: string): void;
 	// Assert that contents matches a snapshot.
-	snapshot(contents: any, message?: string): void;
+	snapshot: ((contents: any, message?: string) => void) & ((contents: any, options: {id: string}, message?: string) => void);
 	// Assert that contents does not match regex.
 	notRegex(contents: string, regex: RegExp, message?: string): void;
 	// Assert that error is falsy.
@@ -81,8 +81,10 @@ type AssertContext = {
  */
 
 type TestContext = AssertContext & {
+	title: string;
 	plan(count: number): void;
 	skip: AssertContext;
+	log(...values: Array<any>): void;
 };
 type ContextualTestContext         = TestContext & { context: any; };
 type ContextualCallbackTestContext = TestContext & { context: any; end(): void; };

package/lib/assert.js

@@ -49,14 +49,22 @@ class AssertionError extends Error {
 
 		if (opts.stack) {
 			this.stack = opts.stack;
+		} else {
+			const limitBefore = Error.stackTraceLimit;
+			Error.stackTraceLimit = Infinity;
+			Error.captureStackTrace(this);
+			Error.stackTraceLimit = limitBefore;
 		}
 	}
 }
 exports.AssertionError = AssertionError;
 
 function getStack() {
+	const limitBefore = Error.stackTraceLimit;
+	Error.stackTraceLimit = Infinity;
 	const obj = {};
 	Error.captureStackTrace(obj, getStack);
+	Error.stackTraceLimit = limitBefore;
 	return obj.stack;
 }
 
@@ -64,6 +72,7 @@ function wrapAssertions(callbacks) {
 	const pass = callbacks.pass;
 	const pending = callbacks.pending;
 	const fail = callbacks.fail;
+	const log = callbacks.log;
 
 	const noop = () => {};
 	const makeRethrow = reason => () => {
@@ -86,14 +95,25 @@ function wrapAssertions(callbacks) {
 			if (Object.is(actual, expected)) {
 				pass(this);
 			} else {
-				const actualDescriptor = concordance.describe(actual, concordanceOptions);
-				const expectedDescriptor = concordance.describe(expected, concordanceOptions);
-				fail(this, new AssertionError({
-					assertion: 'is',
-					message,
-					raw: {actual, expected},
-					values: [formatDescriptorDiff(actualDescriptor, expectedDescriptor)]
-				}));
+				const result = concordance.compare(actual, expected, concordanceOptions);
+				const actualDescriptor = result.actual || concordance.describe(actual, concordanceOptions);
+				const expectedDescriptor = result.expected || concordance.describe(expected, concordanceOptions);
+
+				if (result.pass) {
+					fail(this, new AssertionError({
+						assertion: 'is',
+						message,
+						raw: {actual, expected},
+						values: [formatDescriptorWithLabel('Values are deeply equal to each other, but they are not the same:', actualDescriptor)]
+					}));
+				} else {
+					fail(this, new AssertionError({
+						assertion: 'is',
+						message,
+						raw: {actual, expected},
+						values: [formatDescriptorDiff(actualDescriptor, expectedDescriptor)]
+					}));
+				}
 			}
 		},
 
@@ -110,6 +130,18 @@ function wrapAssertions(callbacks) {
 			}
 		},
 
+		log() {
+			const args = Array.from(arguments, value => {
+				return typeof value === 'string' ?
+					value :
+					concordance.format(value, concordanceOptions);
+			});
+
+			if (args.length > 0) {
+				log(this, args.join(' '));
+			}
+		},
+
 		deepEqual(actual, expected, message) {
 			const result = concordance.compare(actual, expected, concordanceOptions);
 			if (result.pass) {

package/lib/ava-files.js

@@ -125,6 +125,7 @@ class AvaFiles {
 
 		autoBind(this);
 	}
+
 	findTestFiles() {
 		return handlePaths(this.files, this.excludePatterns, {
 			cwd: this.cwd,
@@ -134,6 +135,7 @@ class AvaFiles {
 			symlinks: Object.create(null)
 		});
 	}
+
 	findTestHelpers() {
 		return handlePaths(defaultHelperPatterns(), ['!**/node_modules/**'], {
 			cwd: this.cwd,
@@ -144,6 +146,7 @@ class AvaFiles {
 			symlinks: Object.create(null)
 		});
 	}
+
 	isSource(filePath) {
 		let mixedPatterns = [];
 		const defaultIgnorePatterns = getDefaultIgnorePatterns();
@@ -195,6 +198,7 @@ class AvaFiles {
 
 		return false;
 	}
+
 	isTest(filePath) {
 		const excludePatterns = this.excludePatterns;
 		const initialPatterns = this.files.concat(excludePatterns);
@@ -241,6 +245,7 @@ class AvaFiles {
 		// excludePatterns into account. This mimicks the behavior in api.js
 		return multimatch(matchable(filePath), recursivePatterns.concat(excludePatterns)).length === 1;
 	}
+
 	getChokidarPatterns() {
 		let paths = [];
 		let ignored = [];

package/lib/babel-config.js

@@ -6,6 +6,7 @@ const figures = require('figures');
 const configManager = require('hullabaloo-config-manager');
 const md5Hex = require('md5-hex');
 const makeDir = require('make-dir');
+const semver = require('semver');
 const colors = require('./colors');
 
 function validate(conf) {
@@ -99,6 +100,7 @@ function build(projectDir, cacheDir, userOptions, powerAssert) {
 
 	const baseOptions = {
 		babelrc: false,
+		plugins: [],
 		presets: [
 			['@ava/transform-test-files', {powerAssert}]
 		]
@@ -107,6 +109,12 @@ function build(projectDir, cacheDir, userOptions, powerAssert) {
 		baseOptions.presets.unshift('@ava/stage-4');
 	}
 
+	// Include object rest spread support for node versions that support it
+	// natively.
+	if (userOptions === 'default' && semver.satisfies(process.versions.node, '>= 8.3.0')) {
+		baseOptions.plugins.push('babel-plugin-syntax-object-rest-spread');
+	}
+
 	const baseConfig = configManager.createConfig({
 		dir: AVA_DIR, // Presets are resolved relative to this directory
 		hash: md5Hex(JSON.stringify(baseOptions)),

package/lib/beautify-stack.js

@@ -8,6 +8,7 @@ let ignoreStackLines = [];
 
 const avaInternals = /\/ava\/(?:lib\/)?[\w-]+\.js:\d+:\d+\)?$/;
 const avaDependencies = /\/node_modules\/(?:bluebird|empower-core|(?:ava\/node_modules\/)?(?:babel-runtime|core-js))\//;
+const stackFrameLine = /^.+( \(.+:\d+:\d+\)|:\d+:\d+)$/;
 
 if (!debug.enabled) {
 	ignoreStackLines = StackUtils.nodeInternals();
@@ -17,21 +18,55 @@ if (!debug.enabled) {
 
 const stackUtils = new StackUtils({internals: ignoreStackLines});
 
+function extractFrames(stack) {
+	return stack
+		.split('\n')
+		.map(line => line.trim())
+		.filter(line => stackFrameLine.test(line))
+		.join('\n');
+}
+
+/**
+ * Given a string value of the format generated for the `stack` property of a
+ * V8 error object, return a string that contains only stack frame information
+ * for frames that have relevance to the consumer.
+ *
+ * For example, given the following string value:
+ *
+ * ```
+ * Error
+ *     at inner (/home/ava/ex.js:7:12)
+ *     at /home/ava/ex.js:12:5
+ *     at outer (/home/ava/ex.js:13:4)
+ *     at Object.<anonymous> (/home/ava/ex.js:14:3)
+ *     at Module._compile (module.js:570:32)
+ *     at Object.Module._extensions..js (module.js:579:10)
+ *     at Module.load (module.js:487:32)
+ *     at tryModuleLoad (module.js:446:12)
+ *     at Function.Module._load (module.js:438:3)
+ *     at Module.runMain (module.js:604:10)
+ * ```
+ *
+ * ...this function returns the following string value:
+ *
+ * ```
+ * inner (/home/ava/ex.js:7:12)
+ * /home/ava/ex.js:12:5
+ * outer (/home/ava/ex.js:13:4)
+ * Object.<anonymous> (/home/ava/ex.js:14:3)
+ * ```
+ */
 module.exports = stack => {
 	if (!stack) {
 		return '';
 	}
 
+	stack = extractFrames(stack);
 	// Workaround for https://github.com/tapjs/stack-utils/issues/14
 	// TODO: fix it in `stack-utils`
 	stack = cleanStack(stack);
 
-	const title = stack.split('\n')[0];
-	const lines = stackUtils
-		.clean(stack)
-		.split('\n')
-		.map(x => `    ${x}`)
-		.join('\n');
-
-	return `${title}\n${lines}`;
+	return stackUtils.clean(stack)
+		// Remove the trailing newline inserted by the `stack-utils` module
+		.trim();
 };

package/lib/caching-precompiler.js

@@ -33,6 +33,7 @@ class CachingPrecompiler {
 		this.fileHashes = {};
 		this.transform = this._createTransform();
 	}
+
 	precompileFile(filePath) {
 		if (!this.fileHashes[filePath]) {
 			const source = stripBomBuf(fs.readFileSync(filePath));
@@ -41,11 +42,13 @@ class CachingPrecompiler {
 
 		return this.fileHashes[filePath];
 	}
+
 	// Conditionally called by caching-transform when precompiling is required
 	_init() {
 		this.babel = require('babel-core');
 		return this._transform;
 	}
+
 	_transform(code, filePath, hash) {
 		code = code.toString();
 
@@ -73,12 +76,11 @@ class CachingPrecompiler {
 
 		// Append source map comment to transformed code
 		// So that other libraries (like nyc) can find the source map
-		const dirPath = path.dirname(filePath);
-		const relativeMapPath = path.relative(dirPath, mapPath);
-		const comment = convertSourceMap.generateMapFileComment(relativeMapPath);
+		const comment = convertSourceMap.generateMapFileComment(mapPath);
 
 		return `${result.code}\n${comment}`;
 	}
+
 	_createTransform() {
 		const salt = packageHash.sync([
 			require.resolve('../package.json'),
@@ -93,6 +95,7 @@ class CachingPrecompiler {
 			ext: '.js'
 		});
 	}
+
 	_generateHash(code, filePath, salt) {
 		const hash = md5Hex([code, filePath, salt]);
 		this.fileHashes[filePath] = hash;

package/lib/cli.js

@@ -43,7 +43,7 @@ exports.run = () => {
 		  --match, -m             Only run tests with matching title (Can be repeated)
 		  --watch, -w             Re-run tests when tests and source files change
 		  --timeout, -T           Set global timeout
-		  --concurrency, -c       Maximum number of test files running at the same time (EXPERIMENTAL)
+		  --concurrency, -c       Max number of test files running at the same time (Default: CPU cores)
 		  --update-snapshots, -u  Update snapshots
 
 		Examples
@@ -75,7 +75,7 @@ exports.run = () => {
 		],
 		default: {
 			cache: conf.cache,
-			color: 'color' in conf ? conf.color : require('supports-color') !== false,
+			color: 'color' in conf ? conf.color : require('supports-color').stdout !== false,
 			concurrency: conf.concurrency,
 			failFast: conf.failFast,
 			init: conf.init,
@@ -119,7 +119,12 @@ exports.run = () => {
 	}
 
 	if (cli.flags.concurrency === '') {
-		throw new Error(colors.error(figures.cross) + ' The --concurrency and -c flags must be provided the maximum number of test files to run at once.');
+		throw new Error(colors.error(figures.cross) + ' The --concurrency and -c flags must be provided.');
+	}
+
+	if (cli.flags.concurrency &&
+		(!Number.isInteger(Number.parseFloat(cli.flags.concurrency)) || parseInt(cli.flags.concurrency, 10) < 0)) {
+		throw new Error(colors.error(figures.cross) + ' The --concurrency and -c flags must be a nonnegative integer.');
 	}
 
 	if (hasFlag('--require') || hasFlag('-r')) {
@@ -144,6 +149,7 @@ exports.run = () => {
 		timeout: conf.timeout,
 		concurrency: conf.concurrency ? parseInt(conf.concurrency, 10) : 0,
 		updateSnapshots: conf.updateSnapshots,
+		snapshotDir: conf.snapshotDir ? path.resolve(projectDir, conf.snapshotDir) : null,
 		color: conf.color
 	});
 
@@ -152,7 +158,7 @@ exports.run = () => {
 	if (conf.tap && !conf.watch) {
 		reporter = new TapReporter();
 	} else if (conf.verbose || isCi) {
-		reporter = new VerboseReporter({color: conf.color});
+		reporter = new VerboseReporter({color: conf.color, watching: conf.watch});
 	} else {
 		reporter = new MiniReporter({color: conf.color, watching: conf.watch});
 	}

package/lib/colors.js

@@ -2,6 +2,7 @@
 const chalk = require('chalk');
 
 module.exports = {
+	log: chalk.gray,
 	title: chalk.bold.white,
 	error: chalk.red,
 	skip: chalk.yellow,

package/lib/enhance-assert.js

@@ -1,6 +1,7 @@
 'use strict';
 const concordance = require('concordance');
 const dotProp = require('dot-prop');
+const generate = require('babel-generator').default;
 const concordanceOptions = require('./concordance-options').default;
 
 // When adding patterns, don't forget to add to
@@ -15,31 +16,16 @@ const PATTERNS = [
 	't.notRegex(contents, regex, [message])'
 ];
 
-const isRangeMatch = (a, b) => {
-	return (a[0] === b[0] && a[1] === b[1]) ||
-		(a[0] > b[0] && a[0] < b[1]) ||
-		(a[1] > b[0] && a[1] < b[1]);
-};
-
-const computeStatement = (tokens, range) => {
-	return tokens
-		.filter(token => isRangeMatch(token.range, range))
-		.map(token => token.value === undefined ? token.type.label : token.value)
-		.join('');
-};
-
+const computeStatement = node => generate(node, {quotes: 'single'}).code;
 const getNode = (ast, path) => dotProp.get(ast, path.replace(/\//g, '.'));
 
 const formatter = context => {
 	const ast = JSON.parse(context.source.ast);
-	const tokens = JSON.parse(context.source.tokens);
 	const args = context.args[0].events;
-
 	return args
 		.map(arg => {
-			const range = getNode(ast, arg.espath).range;
-			const statement = computeStatement(tokens, range);
-
+			const node = getNode(ast, arg.espath);
+			const statement = computeStatement(node);
 			const formatted = concordance.format(arg.value, concordanceOptions);
 			return [statement, formatted];
 		})

package/lib/fork.js

@@ -10,12 +10,10 @@ if (fs.realpathSync(__filename) !== __filename) {
 	console.warn('WARNING: `npm link ava` and the `--preserve-symlink` flag are incompatible. We have detected that AVA is linked via `npm link`, and that you are using either an early version of Node 6, or the `--preserve-symlink` flag. This breaks AVA. You should upgrade to Node 6.2.0+, avoid the `--preserve-symlink` flag, or avoid using `npm link ava`.');
 }
 
-let env = process.env;
+const env = Object.assign({NODE_ENV: 'test'}, process.env);
 
 // Ensure NODE_PATH paths are absolute
 if (env.NODE_PATH) {
-	env = Object.assign({}, env);
-
 	env.NODE_PATH = env.NODE_PATH
 		.split(path.delimiter)
 		.map(x => path.resolve(x))

package/lib/logger.js

@@ -6,6 +6,7 @@ class Logger {
 		this.reporter = reporter;
 		autoBind(this);
 	}
+
 	start(runStatus) {
 		if (!this.reporter.start) {
 			return;
@@ -13,6 +14,7 @@ class Logger {
 
 		this.write(this.reporter.start(runStatus), runStatus);
 	}
+
 	reset(runStatus) {
 		if (!this.reporter.reset) {
 			return;
@@ -20,9 +22,11 @@ class Logger {
 
 		this.write(this.reporter.reset(runStatus), runStatus);
 	}
+
 	test(test, runStatus) {
 		this.write(this.reporter.test(test, runStatus), runStatus);
 	}
+
 	unhandledError(err, runStatus) {
 		if (!this.reporter.unhandledError) {
 			return;
@@ -30,6 +34,7 @@ class Logger {
 
 		this.write(this.reporter.unhandledError(err, runStatus), runStatus);
 	}
+
 	finish(runStatus) {
 		if (!this.reporter.finish) {
 			return;
@@ -37,6 +42,7 @@ class Logger {
 
 		this.write(this.reporter.finish(runStatus), runStatus);
 	}
+
 	section() {
 		if (!this.reporter.section) {
 			return;
@@ -44,6 +50,7 @@ class Logger {
 
 		this.write(this.reporter.section());
 	}
+
 	clear() {
 		if (!this.reporter.clear) {
 			return false;
@@ -52,6 +59,7 @@ class Logger {
 		this.write(this.reporter.clear());
 		return true;
 	}
+
 	write(str, runStatus) {
 		if (typeof str === 'undefined') {
 			return;
@@ -59,6 +67,7 @@ class Logger {
 
 		this.reporter.write(str, runStatus);
 	}
+
 	stdout(data, runStatus) {
 		if (!this.reporter.stdout) {
 			return;
@@ -66,6 +75,7 @@ class Logger {
 
 		this.reporter.stdout(data, runStatus);
 	}
+
 	stderr(data, runStatus) {
 		if (!this.reporter.stderr) {
 			return;
@@ -73,6 +83,7 @@ class Logger {
 
 		this.reporter.stderr(data, runStatus);
 	}
+
 	exit(code) {
 		process.exit(code); // eslint-disable-line unicorn/no-process-exit
 	}

package/lib/main.js

@@ -13,7 +13,8 @@ const runner = new Runner({
 	match: opts.match,
 	projectDir: opts.projectDir,
 	serial: opts.serial,
-	updateSnapshots: opts.updateSnapshots
+	updateSnapshots: opts.updateSnapshots,
+	snapshotDir: opts.snapshotDir
 });
 
 worker.setRunner(runner);
@@ -22,8 +23,6 @@ worker.setRunner(runner);
 // that no more tests should be logged
 let isFailed = false;
 
-Error.stackTraceLimit = Infinity;
-
 function test(props) {
 	if (isFailed) {
 		return;