test/services/TestRunner.js

//--------------------------------------------------------
//-- Node IoC - Test - Service - Test runner
//--------------------------------------------------------

import hasEngine from '../../support/mixins/hasEngine';


/**
 * Test runner that handles all the pipeline to run given tests.
 *
 * @memberof test.services
 * @augments support.mixins.HasEngine
 * @hideconstructor
 */
class TestRunner extends hasEngine() {

	/**
	 * Class dependencies: <code>['app']</code>.
	 *
	 * @type {Array<string>}
	 */
	static get dependencies() {
		return (super.dependencies || []).concat(['app']);
	}

	/**
	 * Run a list of tests.
	 *
	 * @param {Array<{instane: test.TestCase, name: string, namespace: string, tests: Array<{method: string, description: string}>}>} testList - List of tests.
	 */
	run(testList = []) {
		testList.forEach(this.runTest.bind(this));
	}

	/**
	 * Run every tests of a single test case instance.
	 *
	 * @param {{instance: test.TestCase, name: string, namespace: string, tests: Array<{method: string, description: string}>}} test - Single test.
	 */
	runTest({ instance, name, namespace, tests }) {
		if (typeof this.engine === 'undefined') {
			throw new TypeError('Test engine is not defined');
		}


		instance
			.setEngine(this.engine);

		this.describe(namespace, () => {
			this.describe(name, () => {
				this.beforeEach(() => {
					instance.setApp(this.app.make('app'));
				});
				this.beforeAll((...parameters) => { return instance.beforeAll(...parameters); });
				this.beforeEach((...parameters) => { return instance.beforeEach(...parameters); });
				tests.forEach(({ method, description }) => {
					this.test(description, (...parameters) => { return instance[method](...parameters); });
				});
				this.afterEach((...parameters) => { return instance.afterEach(...parameters); });
				this.afterAll((...parameters) => { return instance.afterAll(...parameters); });
			});
		});
	}

	/**
	 * Describe the inner tests.
	 *
	 * @param {...*} parameters - Call parameters.
	 * @returns {*} The call returned value.
	 */
	describe(...parameters) {
		return this.engine.describe(...parameters);
	}

	/**
	 * Setup before the first inner test.
	 *
	 * @param {...*} parameters - Call parameters.
	 * @returns {*} The call returned value.
	 */
	beforeAll(...parameters) {
		return this.engine.beforeAll(...parameters);
	}

	/**
	 * Setup before any inner test.
	 *
	 * @param {...*} parameters - Call parameters.
	 * @returns {*} The call returned value.
	 */
	beforeEach(...parameters) {
		return this.engine.beforeEach(...parameters);
	}

	/**
	 * Tear down after the last inner test.
	 *
	 * @param {...*} parameters - Call parameters.
	 * @returns {*} The call returned value.
	 */
	afterAll(...parameters) {
		return this.engine.afterAll(...parameters);
	}

	/**
	 * Tear down after any inner test.
	 *
	 * @param {...*} parameters - Call parameters.
	 * @returns {*} The call returned value.
	 */
	afterEach(...parameters) {
		return this.engine.afterEach(...parameters);
	}

	/**
	 * Test a given case.
	 *
	 * @param {...*} parameters - Call parameters.
	 * @returns {*} The call returned value.
	 */
	test(...parameters) {
		return this.engine.test(...parameters);
	}

}


export default TestRunner;