ava 2.0.0 → 2.4.0

package/lib/fork.js

@@ -25,6 +25,7 @@ if (process.env.NODE_PATH) {
 
 const describeTTY = tty => ({
 	colorDepth: tty.getColorDepth ? tty.getColorDepth() : undefined,
+	hasColors: typeof tty.hasColors === 'function',
 	columns: tty.columns || 80,
 	rows: tty.rows
 });

package/lib/globs.js

@@ -98,17 +98,17 @@ exports.hasExtension = hasExtension;
 const findFiles = async (cwd, patterns) => {
 	const files = await globby(patterns, {
 		absolute: true,
-		brace: true,
-		case: false,
+		braceExpansion: true,
+		caseSensitiveMatch: false,
 		cwd,
 		dot: false,
 		expandDirectories: false,
 		extglob: true,
-		followSymlinkedDirectories: true,
+		followSymbolicLinks: true,
 		gitignore: false,
 		globstar: true,
 		ignore: defaultIgnorePatterns,
-		matchBase: false,
+		baseNameMatch: false,
 		onlyFiles: true,
 		stats: false,
 		unique: true

package/lib/load-config.js

@@ -6,12 +6,25 @@ const pkgConf = require('pkg-conf');
 
 const NO_SUCH_FILE = Symbol('no ava.config.js file');
 const MISSING_DEFAULT_EXPORT = Symbol('missing default export');
+const EXPERIMENTS = new Set(['tryAssertion']);
 
-function loadConfig(resolveFrom = process.cwd(), defaults = {}) {
-	const packageConf = pkgConf.sync('ava', {cwd: resolveFrom});
+function loadConfig({configFile, resolveFrom = process.cwd(), defaults = {}} = {}) { // eslint-disable-line complexity
+	let packageConf = pkgConf.sync('ava', {cwd: resolveFrom});
 	const filepath = pkgConf.filepath(packageConf);
 	const projectDir = filepath === null ? resolveFrom : path.dirname(filepath);
 
+	const fileForErrorMessage = configFile || 'ava.config.js';
+	const allowConflictWithPackageJson = Boolean(configFile);
+
+	if (configFile) {
+		configFile = path.resolve(configFile); // Relative to CWD
+		if (path.basename(configFile) !== path.relative(projectDir, configFile)) {
+			throw new Error('Config files must be located next to the package.json file');
+		}
+	} else {
+		configFile = path.join(projectDir, 'ava.config.js');
+	}
+
 	let fileConf;
 	try {
 		({default: fileConf = MISSING_DEFAULT_EXPORT} = esm(module, {
@@ -26,49 +39,64 @@ function loadConfig(resolveFrom = process.cwd(), defaults = {}) {
 			},
 			force: true,
 			mode: 'all'
-		})(path.join(projectDir, 'ava.config.js')));
+		})(configFile));
 	} catch (error) {
 		if (error && error.code === 'MODULE_NOT_FOUND') {
 			fileConf = NO_SUCH_FILE;
 		} else {
-			throw Object.assign(new Error('Error loading ava.config.js'), {parent: error});
+			throw Object.assign(new Error(`Error loading ${fileForErrorMessage}`), {parent: error});
 		}
 	}
 
 	if (fileConf === MISSING_DEFAULT_EXPORT) {
-		throw new Error('ava.config.js must have a default export, using ES module syntax');
+		throw new Error(`${fileForErrorMessage} must have a default export, using ES module syntax`);
 	}
 
 	if (fileConf !== NO_SUCH_FILE) {
-		if (Object.keys(packageConf).length > 0) {
-			throw new Error('Conflicting configuration in ava.config.js and package.json');
+		if (allowConflictWithPackageJson) {
+			packageConf = {};
+		} else if (Object.keys(packageConf).length > 0) {
+			throw new Error(`Conflicting configuration in ${fileForErrorMessage} and package.json`);
 		}
 
 		if (fileConf && typeof fileConf.then === 'function') { // eslint-disable-line promise/prefer-await-to-then
-			throw new TypeError('ava.config.js must not export a promise');
+			throw new TypeError(`${fileForErrorMessage} must not export a promise`);
 		}
 
 		if (!isPlainObject(fileConf) && typeof fileConf !== 'function') {
-			throw new TypeError('ava.config.js must export a plain object or factory function');
+			throw new TypeError(`${fileForErrorMessage} must export a plain object or factory function`);
 		}
 
 		if (typeof fileConf === 'function') {
 			fileConf = fileConf({projectDir});
 			if (fileConf && typeof fileConf.then === 'function') { // eslint-disable-line promise/prefer-await-to-then
-				throw new TypeError('Factory method exported by ava.config.js must not return a promise');
+				throw new TypeError(`Factory method exported by ${fileForErrorMessage} must not return a promise`);
 			}
 
 			if (!isPlainObject(fileConf)) {
-				throw new TypeError('Factory method exported by ava.config.js must return a plain object');
+				throw new TypeError(`Factory method exported by ${fileForErrorMessage} must return a plain object`);
 			}
 		}
 
 		if ('ava' in fileConf) {
-			throw new Error('Encountered \'ava\' property in ava.config.js; avoid wrapping the configuration');
+			throw new Error(`Encountered 'ava' property in ${fileForErrorMessage}; avoid wrapping the configuration`);
+		}
+	}
+
+	const config = {...defaults, nonSemVerExperiments: {}, ...fileConf, ...packageConf, projectDir};
+
+	const {nonSemVerExperiments: experiments} = config;
+	if (!isPlainObject(experiments)) {
+		throw new Error(`nonSemVerExperiments from ${fileForErrorMessage} must be an object`);
+	}
+
+	for (const key of Object.keys(experiments)) {
+		if (!EXPERIMENTS.has(key)) {
+			throw new Error(`nonSemVerExperiments.${key} from ${fileForErrorMessage} is not a supported experiment`);
 		}
 	}
 
-	return {...defaults, ...fileConf, ...packageConf, projectDir};
+	return config;
 }
 
 module.exports = loadConfig;

package/lib/parse-test-args.js

@@ -0,0 +1,15 @@
+'use strict';
+function parseTestArgs(args) {
+	const rawTitle = typeof args[0] === 'string' ? args.shift() : undefined;
+	const receivedImplementationArray = Array.isArray(args[0]);
+	const implementations = receivedImplementationArray ? args.shift() : args.splice(0, 1);
+
+	const buildTitle = implementation => {
+		const title = implementation.title ? implementation.title(rawTitle, ...args) : rawTitle;
+		return {title, isSet: typeof title !== 'undefined', isValid: typeof title === 'string', isEmpty: !title};
+	};
+
+	return {args, buildTitle, implementations, rawTitle, receivedImplementationArray};
+}
+
+module.exports = parseTestArgs;

package/lib/reporters/mini.js

@@ -135,6 +135,11 @@ class MiniReporter {
 
 		cliCursor.hide(this.reportStream);
 		this.lineWriter.writeLine();
+
+		if (plan.experiments.length > 0) {
+			this.lineWriter.writeLine(colors.information(`${figures.warning} Experiments are enabled. These are unsupported and may change or be be removed at any time.`));
+		}
+
 		this.spinner.start();
 	}
 

package/lib/reporters/tap.js

@@ -5,6 +5,7 @@ const path = require('path');
 const plur = require('plur');
 const stripAnsi = require('strip-ansi');
 const supertap = require('supertap');
+const indentString = require('indent-string');
 
 const prefixTitle = require('./prefix-title');
 
@@ -41,7 +42,7 @@ function dumpError(error) {
 	}
 
 	if (error.stack) {
-		obj.at = error.stack.split('\n')[0];
+		obj.at = error.stack;
 	}
 
 	return obj;
@@ -74,7 +75,7 @@ class TapReporter {
 		if (this.stats) {
 			this.reportStream.write(supertap.finish({
 				crashed: this.crashCount,
-				failed: this.stats.failedHooks + this.stats.failedTests,
+				failed: this.stats.failedTests + this.stats.remainingTests,
 				passed: this.stats.passedTests + this.stats.passedKnownFailingTests,
 				skipped: this.stats.skippedTests,
 				todo: this.stats.todoTests
@@ -118,6 +119,21 @@ class TapReporter {
 		}) + os.EOL);
 	}
 
+	writeComment(evt, {error = false, title = this.prefixTitle(evt.testFile, evt.title)}) {
+		let formattedTitle = title;
+		if (error) {
+			formattedTitle = `Failed hook: ${formattedTitle}`;
+		}
+
+		this.reportStream.write(`# ${stripAnsi(formattedTitle)}${os.EOL}`);
+		if (evt.logs) {
+			for (const log of evt.logs) {
+				const logLines = indentString(log, 4).replace(/^ {4}/, '  # ');
+				this.reportStream.write(`${logLines}${os.EOL}`);
+			}
+		}
+	}
+
 	consumeStateChange(evt) { // eslint-disable-line complexity
 		const fileStats = this.stats && evt.testFile ? this.stats.byFile.get(evt.testFile) : null;
 
@@ -126,7 +142,10 @@ class TapReporter {
 				// Ignore
 				break;
 			case 'hook-failed':
-				this.writeTest(evt, {passed: false, todo: false, skip: false});
+				this.writeComment(evt, {error: true});
+				break;
+			case 'hook-finished':
+				this.writeComment(evt, {});
 				break;
 			case 'internal-error':
 				this.writeCrash(evt);
@@ -176,7 +195,7 @@ class TapReporter {
 					if (fileStats.declaredTests === 0) {
 						this.writeCrash(evt, `No tests found in ${path.relative('.', evt.testFile)}`);
 					} else if (!this.failFastEnabled && fileStats.remainingTests > 0) {
-						this.writeCrash(evt, `${fileStats.remainingTests} ${plur('test', fileStats.remainingTests)} remaining in ${path.relative('.', evt.testFile)}`);
+						this.writeComment(evt, {title: `${fileStats.remainingTests} ${plur('test', fileStats.remainingTests)} remaining in ${path.relative('.', evt.testFile)}`});
 					}
 				}
 

package/lib/reporters/verbose.js

@@ -97,6 +97,9 @@ class VerboseReporter {
 		}
 
 		this.lineWriter.writeLine();
+		if (plan.experiments.length > 0) {
+			this.lineWriter.writeLine(colors.information(`${figures.warning} Experiments are enabled. These are unsupported and may change or be removed at any time.${os.EOL}`));
+		}
 	}
 
 	consumeStateChange(evt) { // eslint-disable-line complexity

package/lib/runner.js

@@ -3,6 +3,7 @@ const Emittery = require('emittery');
 const matcher = require('matcher');
 const ContextRef = require('./context-ref');
 const createChain = require('./create-chain');
+const parseTestArgs = require('./parse-test-args');
 const snapshotManager = require('./snapshot-manager');
 const serializeError = require('./serialize-error');
 const Runnable = require('./test');
@@ -11,6 +12,7 @@ class Runner extends Emittery {
 	constructor(options = {}) {
 		super();
 
+		this.experiments = options.experiments || {};
 		this.failFast = options.failFast === true;
 		this.failWithoutAssertions = options.failWithoutAssertions !== false;
 		this.file = options.file;
@@ -39,12 +41,21 @@ class Runner extends Emittery {
 		};
 
 		const uniqueTestTitles = new Set();
+		this.registerUniqueTitle = title => {
+			if (uniqueTestTitles.has(title)) {
+				return false;
+			}
+
+			uniqueTestTitles.add(title);
+			return true;
+		};
+
 		let hasStarted = false;
 		let scheduledStart = false;
 		const meta = Object.freeze({
 			file: options.file
 		});
-		this.chain = createChain((metadata, args) => { // eslint-disable-line complexity
+		this.chain = createChain((metadata, testArgs) => { // eslint-disable-line complexity
 			if (hasStarted) {
 				throw new Error('All tests and hooks must be declared synchronously in your test file, and cannot be nested within other tests or hooks.');
 			}
@@ -57,40 +68,33 @@ class Runner extends Emittery {
 				});
 			}
 
-			const specifiedTitle = typeof args[0] === 'string' ?
-				args.shift() :
-				undefined;
-			const implementations = Array.isArray(args[0]) ?
-				args.shift() :
-				args.splice(0, 1);
+			const {args, buildTitle, implementations, rawTitle} = parseTestArgs(testArgs);
 
 			if (metadata.todo) {
 				if (implementations.length > 0) {
 					throw new TypeError('`todo` tests are not allowed to have an implementation. Use `test.skip()` for tests with an implementation.');
 				}
 
-				if (specifiedTitle === undefined || specifiedTitle === '') {
+				if (!rawTitle) { // Either undefined or a string.
 					throw new TypeError('`todo` tests require a title');
 				}
 
-				if (uniqueTestTitles.has(specifiedTitle)) {
-					throw new Error(`Duplicate test title: ${specifiedTitle}`);
-				} else {
-					uniqueTestTitles.add(specifiedTitle);
+				if (!this.registerUniqueTitle(rawTitle)) {
+					throw new Error(`Duplicate test title: ${rawTitle}`);
 				}
 
 				if (this.match.length > 0) {
 					// --match selects TODO tests.
-					if (matcher([specifiedTitle], this.match).length === 1) {
+					if (matcher([rawTitle], this.match).length === 1) {
 						metadata.exclusive = true;
 						this.runOnlyExclusive = true;
 					}
 				}
 
-				this.tasks.todo.push({title: specifiedTitle, metadata});
+				this.tasks.todo.push({title: rawTitle, metadata});
 				this.emit('stateChange', {
 					type: 'declared-test',
-					title: specifiedTitle,
+					title: rawTitle,
 					knownFailing: false,
 					todo: true
 				});
@@ -100,15 +104,13 @@ class Runner extends Emittery {
 				}
 
 				for (const implementation of implementations) {
-					let title = implementation.title ?
-						implementation.title(specifiedTitle, ...args) :
-						specifiedTitle;
+					let {title, isSet, isValid, isEmpty} = buildTitle(implementation);
 
-					if (title !== undefined && typeof title !== 'string') {
+					if (isSet && !isValid) {
 						throw new TypeError('Test & hook titles must be strings');
 					}
 
-					if (title === undefined || title === '') {
+					if (isEmpty) {
 						if (metadata.type === 'test') {
 							throw new TypeError('Tests must have a title');
 						} else if (metadata.always) {
@@ -118,12 +120,8 @@ class Runner extends Emittery {
 						}
 					}
 
-					if (metadata.type === 'test') {
-						if (uniqueTestTitles.has(title)) {
-							throw new Error(`Duplicate test title: ${title}`);
-						} else {
-							uniqueTestTitles.add(title);
-						}
+					if (metadata.type === 'test' && !this.registerUniqueTitle(title)) {
+						throw new Error(`Duplicate test title: ${title}`);
 					}
 
 					const task = {
@@ -162,6 +160,7 @@ class Runner extends Emittery {
 			todo: false,
 			failing: false,
 			callback: false,
+			inline: false, // Set for attempt metadata created by `t.try()`
 			always: false
 		}, meta);
 	}
@@ -269,6 +268,7 @@ class Runner extends Emittery {
 	async runHooks(tasks, contextRef, titleSuffix) {
 		const hooks = tasks.map(task => new Runnable({
 			contextRef,
+			experiments: this.experiments,
 			failWithoutAssertions: false,
 			fn: task.args.length === 0 ?
 				task.implementation :
@@ -309,6 +309,7 @@ class Runner extends Emittery {
 			// Only run the test if all `beforeEach` hooks passed.
 			const test = new Runnable({
 				contextRef,
+				experiments: this.experiments,
 				failWithoutAssertions: this.failWithoutAssertions,
 				fn: task.args.length === 0 ?
 					task.implementation :
@@ -316,7 +317,8 @@ class Runner extends Emittery {
 				compareTestSnapshot: this.boundCompareTestSnapshot,
 				updateSnapshots: this.updateSnapshots,
 				metadata: task.metadata,
-				title: task.title
+				title: task.title,
+				registerUniqueTitle: this.registerUniqueTitle
 			});
 
 			const result = await this.runSingle(test);

package/lib/serialize-error.js

@@ -39,7 +39,8 @@ function buildSource(source) {
 	const file = path.resolve(projectDir, source.file.trim());
 	const rel = path.relative(projectDir, file);
 
-	const isWithinProject = rel.split(path.sep)[0] !== '..';
+	const [segment] = rel.split(path.sep);
+	const isWithinProject = segment !== '..' && (process.platform !== 'win32' || !segment.includes(':'));
 	const isDependency = isWithinProject && path.dirname(rel).split(path.sep).includes('node_modules');
 
 	return {
@@ -51,7 +52,11 @@ function buildSource(source) {
 }
 
 function trySerializeError(err, shouldBeautifyStack) {
-	const stack = shouldBeautifyStack ? beautifyStack(err.stack) : err.stack;
+	let stack = err.savedError ? err.savedError.stack : err.stack;
+
+	if (shouldBeautifyStack) {
+		stack = beautifyStack(stack);
+	}
 
 	const retval = {
 		avaAssertionError: isAvaAssertionError(err),

package/lib/snapshot-manager.js

@@ -305,45 +305,64 @@ class Manager {
 	compare(options) {
 		const hash = md5Hex(options.belongsTo);
 		const entries = this.snapshotsByHash.get(hash) || [];
-		if (options.index > entries.length) {
-			throw new RangeError(`Cannot record snapshot ${options.index} for ${JSON.stringify(options.belongsTo)}, exceeds expected index of ${entries.length}`);
-		}
+		const snapshotBuffer = entries[options.index];
 
-		if (options.index === entries.length) {
+		if (!snapshotBuffer) {
 			if (!this.recordNewSnapshots) {
 				return {pass: false};
 			}
 
+			if (options.deferRecording) {
+				const record = this.deferRecord(hash, options);
+				return {pass: true, record};
+			}
+
 			this.record(hash, options);
 			return {pass: true};
 		}
 
-		const snapshotBuffer = entries[options.index];
 		const actual = concordance.deserialize(snapshotBuffer, concordanceOptions);
-
 		const expected = concordance.describe(options.expected, concordanceOptions);
 		const pass = concordance.compareDescriptors(actual, expected);
 
 		return {actual, expected, pass};
 	}
 
-	record(hash, options) {
+	deferRecord(hash, options) {
 		const descriptor = concordance.describe(options.expected, concordanceOptions);
-
-		this.hasChanges = true;
 		const snapshot = concordance.serialize(descriptor);
-		if (this.snapshotsByHash.has(hash)) {
-			this.snapshotsByHash.get(hash).push(snapshot);
-		} else {
-			this.snapshotsByHash.set(hash, [snapshot]);
-		}
-
 		const entry = formatEntry(options.label, descriptor);
-		if (this.reportEntries.has(options.belongsTo)) {
-			this.reportEntries.get(options.belongsTo).push(entry);
-		} else {
-			this.reportEntries.set(options.belongsTo, [entry]);
-		}
+
+		return () => { // Must be called in order!
+			this.hasChanges = true;
+
+			let snapshots = this.snapshotsByHash.get(hash);
+			if (!snapshots) {
+				snapshots = [];
+				this.snapshotsByHash.set(hash, snapshots);
+			}
+
+			if (options.index > snapshots.length) {
+				throw new RangeError(`Cannot record snapshot ${options.index} for ${JSON.stringify(options.belongsTo)}, exceeds expected index of ${snapshots.length}`);
+			}
+
+			if (options.index < snapshots.length) {
+				throw new RangeError(`Cannot record snapshot ${options.index} for ${JSON.stringify(options.belongsTo)}, already exists`);
+			}
+
+			snapshots.push(snapshot);
+
+			if (this.reportEntries.has(options.belongsTo)) {
+				this.reportEntries.get(options.belongsTo).push(entry);
+			} else {
+				this.reportEntries.set(options.belongsTo, [entry]);
+			}
+		};
+	}
+
+	record(hash, options) {
+		const record = this.deferRecord(hash, options);
+		record();
 	}
 
 	save() {