@financial-times/o-ads/test.src/qunit/setup.js

This package contains the core functionality used by the FT in providing ads across all of its sites. This includes ft.com, howtospendit.com, ftadviser.com and other specialist titles.

/* global QUnit: false */

'use strict'; //eslint-disable-line

import ads from '../../main.js';
import utils from '../../src/js/utils/index.js';
import helpers from './helpers.js';

const Ads = ads.constructor;

QUnit.config.testTimeout = 5000;
QUnit.config.urlConfig.push({
	id: 'DEBUG',
	value: 'OADS',
	label: 'Debug Mode',
	tooltip: 'Show debug log messages'
});

// change the karma debug page title to something more fitting
document.querySelector('title').innerHTML = 'o-ads unit tests';


// Show the qunit ui only when viewing the karma debug page
if (window.top === window) {
	document.body.insertAdjacentHTML('afterbegin', '<div id="qunit"></div>');
}

// div for attaching HTML fixtures, will be emptied after each test
document.body.insertAdjacentHTML('afterbegin', '<div id="qunit-fixtures"></div>');
decorateModule();

// Because Ads is a singleton using require('main.js') in each
// test will always return the same instance of the object, using the
// constructor gives each test access to a unique instance
// this is added to the test context via the module decorator

// Curry helper methods
function addHelpers(obj) {
	for (const key in helpers) {
		if (helpers.hasOwnProperty(key)) {
			obj[key] = helpers[key];
		}
	}
}

// QUnit decided to remove the ability to define global test hooks
function decorateModule() {
	const _module = QUnit.module;
	function decorateHooks(hooks) {
		return {
			beforeEach: function() {
				let mod;
				this.adsConstructor = Ads;
				this.ads = new Ads();
				this.utils = utils;
				window.scroll(0, 0);

				// we also have to clone all submodules that are constructors
				for (mod in Ads.prototype) {
					if (new RegExp(mod, 'i').test(Ads.prototype[mod].constructor.toString())) {
						Ads.prototype[mod] = new Ads.prototype[mod].constructor();
					}
				}

				addHelpers(this);

				// stub out the attach method to prevent external files being loaded
				this.attach = this.stub(utils, 'attach', function(url, async, fn) {
					if (typeof fn === 'function') {
						fn();
					}
				});

				// run beforeEach hook from module in test file
				if (hooks.beforeEach && hooks.beforeEach.apply) {
					hooks.beforeEach.apply(this, [].slice.call(arguments));
				}
			},
			afterEach: function() {
				window.scroll(0, 0);

				// run afterEach hook from module in test file
				if (hooks.afterEach && hooks.afterEach.apply) {
					hooks.afterEach.apply(this, [].slice.call(arguments));
				}
				this.attach.restore();
				// reset sinon sandbox and remove elements added to dom
				this.clear();
				this.ads.targeting.clear();

				//this.ads.config.clear();
				// explicitly delete the ads object used in the test so it is GCed
				delete this.ads;
			}
		};
	}

	QUnit.module = function(name, hooks) {
		_module(name, decorateHooks(hooks || {}));
	};
}