@momsfriendlydevco/testa/lib/testa.js

Low-overhead, parallel-first testkit harness

import * as chai from 'chai';
import TestaBase from './base.js';
import TestaTest from './test.js';
import {getLocation} from './utils.js';

/**
* Main library entrypoint
*/


/**
* Main Testa worker
* This is a factory function which generates TestaTest instances
*
* @param {String} [title] The title of the test, this can also be specified later
* @param {Function} [handler] The worker function for the test, this can also be specified later
* @returns {TestaTest} A created TestaTest instance
*/
export default function testa(title, handler) {
	// Argument munging {{{
	if (
		(!title && !handler) //~ test()
		|| (typeof title == 'string' && !handler) //~ test(title:String)
		|| (typeof title == 'string' && typeof handler == 'function') //~ test(title:String, handler:Function)
	) {
		// Pass
	} else if (typeof title == 'function' && !handler) { //~ test(handler:Function)
		[title, handler] = ['unnamed', title];
	} else { //~ test(*)
		throw new Error(`Unknown call signature for test(title:String, handler:Function) - got (${typeof title}, ${typeof handler})`);
	}
	// }}}


	let testa = new TestaTest();
	testa.location(getLocation());
	if (title) testa.title(title);
	if (handler) testa.handler(handler);

	TestaBase.queue(testa);
	return testa;
}


/**
* Alias import for `testa`
*
* @type {Function}
*/
export let test = testa;

// Setup: Aliasing - test.THING() mappings {{{
// Allow test.THING() to map to test() while setting that as a flag
// e.g. 'test.skip(title, handler)' -> `new TestaTest.title(title).handler(handler).skip()`
[
	'id',
	'location',
	'handler',
	'do',
	'title',
	'skip',
	'only',
	'priority',
	'depends',
].forEach(f =>
	test[f] = (...args) => testa()[f](...args)
);
// }}}

// Setup: Aliasing - test.SETTING() mappings {{{
// Like the above map test.SETTING() to map to TestaBase.set() but don't intialize a test
// e.g. `test.slow('1m')` -> `TestaBase.set('slow', '1m')`
[
	'slow',
	'timeout',
].forEach(f =>
	test[f] = (...args) => {
		TestaBase.set(f, ...args)
		return test; // Return the meta Test element here in case the next call is to another setter OR the dev wants to make a test with these settings
	}
);
// }}}

// Setup: before(), after() {{{
/**
* Alias export for `before()`
* @type {Function}
*/
test.before = (...args) => testa().priority('BEFORE', ...args);
export let before = test.before;

/**
* Alias export for `after()`
* @type {Function}
*/
test.after = (...args) => testa().priority('AFTER', ...args);
export let after = test.after;
// }}}

// test.expect() - Shortcut to Chai#expect() {{{
/**
* Alias export for `chai#expect()`
* @type {Function}
*/
test.expect = chai.expect;
// }}}


/**
* Alias export for Chai#export()
* @type {Function}
*/
export {expect} from 'chai'; //~ `import {expect} from '@momsfriendlydevco/testa'`