flectra/addons/web/static/tests/helpers/qunit_config.js
2018-01-16 02:34:37 -08:00

134 lines
3.9 KiB
JavaScript

(function() {
"use strict";
/**
* QUnit Config
*
* The Flectra javascript test framework is based on QUnit (http://qunitjs.com/).
* This file is necessary to setup Qunit and to prepare its interactions with
* Flectra. It has to be loaded before any tests are defined.
*
* Note that it is not an Flectra module, because we want this code to be executed
* as soon as possible, not whenever the Flectra module system feels like it.
*/
/**
* This configuration variable is not strictly necessary, but it ensures more
* safety for asynchronous tests. With it, each test has to explicitely tell
* QUnit how many assertion it expects, otherwise the test will fail.
*/
QUnit.config.requireExpects = true;
/**
* not important in normal mode, but in debug=assets, the files are loaded
* asynchroneously, which can lead to various issues with QUnit... Notice that
* this is done outside of flectra modules, otherwise the setting would not take
* effect on time.
*/
QUnit.config.autostart = false;
/**
* A test timeout of 1 min, before an async test is considered failed.
*/
QUnit.config.testTimeout = 1 * 60 * 1000;
/**
* Hide passed tests by default in the QUnit page
*/
QUnit.config.hidepassed = (window.location.href.match(/[?&]testId=/) === null);
var sortButtonAppended = false;
/**
* We override the _.throttle function to avoid the delay in order to be able to
* chain multiple actions using throttle in the same test.
*/
QUnit.begin(function () {
this._initialThrottle = _.throttle;
var self = this;
_.throttle = function (func, wait, options) {
return self._initialThrottle(func, 0, options);
};
});
/**
* This is the way the testing framework knows that tests passed or failed. It
* only look in the phantomJS console and check if there is a ok or an error.
*
* Someday, we should devise a safer strategy...
*/
QUnit.done(function(result) {
if (!result.failed) {
console.log('ok');
} else {
console.log('error');
}
if (!sortButtonAppended) {
_addSortButton();
}
_.throttle = this._initialThrottle;
});
/**
* This logs various data in the console, which will be available in the log
* .txt file generated by the runbot.
*/
QUnit.log(function (result) {
if (!result.result) {
var info = '"QUnit test failed: "' + result.module + ' > ' + result.name + '"';
info += ' [message: "' + result.message + '"';
if (result.actual !== null) {
info += ', actual: "' + result.actual + '"';
}
if (result.expected !== null) {
info += ', expected: "' + result.expected + '"';
}
info += ']';
console.error(info);
}
});
/**
* This is done mostly for the .txt log file generated by the runbot.
*/
QUnit.moduleDone(function(result) {
if (!result.failed) {
console.log('"' + result.name + '"', "passed", result.total, "tests.");
} else {
console.log('"' + result.name + '"',
"failed", result.failed,
"tests out of", result.total, ".");
}
});
/**
* Add a sort button on top of the QUnit result page, so we can see which tests
* take the most time.
*/
function _addSortButton() {
sortButtonAppended = true;
var $sort = $('<label> sort by time (desc)</label>').css({float: 'right'});
$('h2#qunit-userAgent').append($sort);
$sort.click(function() {
var $ol = $('ol#qunit-tests');
var $results = $ol.children('li').get();
$results.sort(function (a, b) {
var timeA = Number($(a).find('span.runtime').first().text().split(" ")[0]);
var timeB = Number($(b).find('span.runtime').first().text().split(" ")[0]);
if (timeA < timeB) {
return 1;
} else if (timeA > timeB) {
return -1;
} else {
return 0;
}
});
$.each($results, function(idx, $itm) { $ol.append($itm); });
});
}
})();