ava/lib/test.js

'use strict';
var isGeneratorFn = require('is-generator-fn');
var maxTimeout = require('max-timeout');
var Promise = require('bluebird');
var fnName = require('fn-name');
var co = require('co-with-promise');
var observableToPromise = require('observable-to-promise');
var isPromise = require('is-promise');
var isObservable = require('is-observable');
var assert = require('./assert');
var globals = require('./globals');

function Test(title, fn) {
	if (!(this instanceof Test)) {
		return new Test(title, fn);
	}

	if (typeof title === 'function') {
		fn = title;
		title = null;
	}

	assert.is(typeof fn, 'function', 'you must provide a callback');

	this.title = title || fnName(fn) || '[anonymous]';
	this.fn = isGeneratorFn(fn) ? co.wrap(fn) : fn;
	this.assertCount = 0;
	this.planCount = null;
	this.duration = null;
	this.assertError = undefined;

	// TODO(jamestalmage): make this an optional constructor arg instead of having Runner set it after the fact.
	// metadata should just always exist, otherwise it requires a bunch of ugly checks all over the place.
	this.metadata = {};

	// store the time point before test execution
	// to calculate the total time spent in test
	this._timeStart = null;

	// workaround for Babel giving anonymous functions a name
	if (this.title === 'callee$0$0') {
		this.title = '[anonymous]';
	}
}

module.exports = Test;

Test.prototype._assert = function () {
	this.assertCount++;
};

Test.prototype._setAssertError = function (err) {
	if (this.assertError !== undefined) {
		return;
	}

	if (err === undefined) {
		err = 'undefined';
	}

	this.assertError = err;
};

// Workaround for power-assert
// `t` must be capturable for decorated assert output
Test.prototype._capt = assert._capt;
Test.prototype._expr = assert._expr;

Test.prototype.plan = function (count) {
	if (typeof count !== 'number') {
		throw new TypeError('Expected a number');
	}

	this.planCount = count;

	// in case the `planCount` doesn't match `assertCount,
	// we need the stack of this function to throw with a useful stack
	this.planStack = new Error().stack;
};

Test.prototype.run = function () {
	var self = this;

	this.promise = Promise.pending();

	// TODO(vdemedes): refactor this to avoid storing the promise
	if (!this.fn) {
		this.exit();
		return undefined;
	}

	this._timeStart = globals.now();

	// wait until all assertions are complete
	this._timeout = globals.setTimeout(function () {}, maxTimeout);

	var ret;

	try {
		ret = this.fn(this._publicApi());
	} catch (err) {
		this._setAssertError(err);
		this.exit();
	}

	var asyncType = 'promises';

	if (isObservable(ret)) {
		asyncType = 'observables';
		ret = observableToPromise(ret);
	}

	if (isPromise(ret)) {
		if (this.metadata.callback) {
			self._setAssertError(new Error('Do not return ' + asyncType + ' from tests declared via `test.cb(...)`, if you want to return a promise simply declare the test via `test(...)`'));
			this.exit();
			return this.promise.promise;
		}

		ret
			.then(function () {
				self.exit();
			})
			.catch(function (err) {
				self._setAssertError(new assert.AssertionError({
					actual: err,
					message: 'Promise rejected → ' + err,
					operator: 'promise'
				}));

				self.exit();
			});
	} else if (!this.metadata.callback) {
		this.exit();
	}

	return this.promise.promise;
};

Object.defineProperty(Test.prototype, 'end', {
	get: function () {
		if (this.metadata.callback) {
			return this._end.bind(this);
		}
		throw new Error('t.end is not supported in this context. To use t.end as a callback, you must use "callback mode" via `test.cb(testName, fn)` ');
	}
});

Test.prototype._end = function (err) {
	if (err) {
		this._setAssertError(new assert.AssertionError({
			actual: err,
			message: 'Callback called with an error → ' + err,
			operator: 'callback'
		}));

		this.exit();
		return;
	}

	if (this.endCalled) {
		throw new Error('.end() called more than once');
	}

	this.endCalled = true;
	this.exit();
};

Test.prototype.exit = function () {
	var self = this;

	// calculate total time spent in test
	this.duration = globals.now() - this._timeStart;

	// stop infinite timer
	globals.clearTimeout(this._timeout);

	if (this.assertError === undefined && this.planCount !== null && this.planCount !== this.assertCount) {
		this._setAssertError(new assert.AssertionError({
			actual: this.assertCount,
			expected: this.planCount,
			message: 'Assertion count does not match planned',
			operator: 'plan'
		}));

		this.assertError.stack = this.planStack;
	}

	if (!this.ended) {
		this.ended = true;

		globals.setImmediate(function () {
			if (self.assertError !== undefined) {
				self.promise.reject(self.assertError);
				return;
			}

			self.promise.resolve(self);
		});
	}
};

Test.prototype._publicApi = function () {
	var self = this;
	var api = {};

	// Getters
	[
		'assertCount',
		'title',
		'end',
		'_capt',
		'_expr'
	]
		.forEach(function (name) {
			Object.defineProperty(api, name, {
				enumerable: !/^_/.test(name),
				get: function () {
					return self[name];
				}
			});
		});

	// Get / Set
	Object.defineProperty(api, 'context', {
		enumerable: true,
		get: function () {
			return self.context;
		},
		set: function (context) {
			self.context = context;
		}
	});

	// Bound Functions
	api.plan = this.plan.bind(this);

	// Patched assert methods: increase assert count and store errors.
	Object.keys(assert).forEach(function (el) {
		api[el] = function () {
			try {
				var fn = assert[el].apply(assert, arguments);

				fn = observableToPromise(fn);

				if (isPromise(fn)) {
					return Promise.resolve(fn)
						.catch(function (err) {
							self._setAssertError(err);
						})
						.finally(function () {
							self._assert();
						});
				}
			} catch (err) {
				self._setAssertError(err);
			}

			self._assert();
		};
	});

	return api;
};