DEV: clean up JavaScript testing

- Unify runner for autospec and qunit:test
- Report on slowest 30 tests
- Use async await instead of promise tower
This commit is contained in:
Sam 2018-04-23 14:41:29 +10:00
parent d2d3c7d24e
commit 6a0aeae91b
3 changed files with 96 additions and 246 deletions

View File

@ -66,7 +66,7 @@ module Autospec
end
end
cmd = "node #{Rails.root}/lib/autospec/run-qunit.js \"#{qunit_url}\""
cmd = "node #{Rails.root}/vendor/assets/javascripts/run-qunit.js \"#{qunit_url}\" 3000000 ./tmp/qunit_result"
@pid = Process.spawn(cmd)
_, status = Process.wait2(@pid)

View File

@ -1,182 +0,0 @@
// Chrome QUnit Test Runner
// Author: David Taylor
// Requires chrome-launcher and chrome-remote-interface from npm
// An up-to-date version of chrome is also required
/* globals Promise */
var args = process.argv.slice(2);
if (args.length < 1 || args.length > 2) {
console.log("Usage: node run-qunit.js <URL> <timeout>");
process.exit(1);
}
const chromeLauncher = require('chrome-launcher');
const CDP = require('chrome-remote-interface');
const fs = require('fs');
const QUNIT_RESULT = "./tmp/qunit_result";
(async () => {
await fs.stat(QUNIT_RESULT, (err, stats) => {
if (stats && stats.isFile()) fs.unlink(QUNIT_RESULT);
});
})();
(function() {
function launchChrome() {
return chromeLauncher.launch({
chromeFlags: [
'--disable-gpu',
'--headless',
'--no-sandbox'
]
});
}
launchChrome().then(chrome => {
CDP({
port: chrome.port
}).then(protocol => {
const {Page, Runtime} = protocol;
Promise.all([Page.enable(), Runtime.enable()]).then(()=>{
Runtime.consoleAPICalled((response) => {
const message = response['args'][0].value;
// If it's a simple test result, write without newline
if (message === "." || message === "F") {
process.stdout.write(message);
} else if (message.startsWith("AUTOSPEC:")) {
fs.appendFileSync(QUNIT_RESULT, `${message.slice(10)}\n`);
} else {
console.log(message);
}
});
Page.navigate({
url: args[0]
});
Page.loadEventFired(() => {
Runtime.evaluate({
expression: `(${qunit_script})()`
}).then(() => {
const timeout = parseInt(args[1] || 300000, 10);
var start = Date.now();
var interval = setInterval(() => {
if (Date.now() > start + timeout) {
console.error("Tests timed out");
protocol.close();
chrome.kill();
process.exit(124);
} else {
Runtime.evaluate({
expression: `(${check_script})()`
}).then(numFails => {
if (numFails.result.type !== 'undefined') {
clearInterval(interval);
protocol.close();
chrome.kill();
if (numFails.result.value > 0) {
process.exit(1);
} else {
process.exit();
}
}
}).catch(error);
}
}, 250);
}).catch(error(1));
});
}).catch(error(3));
}).catch(error(4));
}).catch(error(5));
})();
function error(code){
return function(){
console.log("A promise failed to resolve code:"+code);
process.exit(1);
};
}
// The following functions are converted to strings
// And then sent to chrome to be evalaluated
function logQUnit() {
var moduleErrors = [];
var testErrors = [];
var assertionErrors = [];
console.log("\nRunning: " + JSON.stringify(QUnit.urlParams) + "\n");
QUnit.config.testTimeout = 10000;
QUnit.moduleDone(function(context) {
if (context.failed) {
var msg = "Module Failed: " + context.name + "\n" + testErrors.join("\n");
moduleErrors.push(msg);
testErrors = [];
}
});
QUnit.testDone(function(context) {
if (context.failed) {
var msg = " Test Failed: " + context.name + assertionErrors.join(" ");
console.log(`AUTOSPEC: ${context.module}:::${context.testId}:::${context.name}`);
testErrors.push(msg);
assertionErrors = [];
console.log("F");
} else {
console.log(".");
}
});
QUnit.log(function(context) {
if (context.result) { return; }
var msg = "\n Assertion Failed:";
if (context.message) {
msg += " " + context.message;
}
if (context.expected) {
msg += "\n Expected: " + context.expected + ", Actual: " + context.actual;
}
assertionErrors.push(msg);
});
QUnit.done(function(context) {
console.log("\n");
if (moduleErrors.length > 0) {
for (var idx=0; idx<moduleErrors.length; idx++) {
console.error(moduleErrors[idx]+"\n");
}
}
var stats = [
"Time: " + context.runtime + "ms",
"Total: " + context.total,
"Passed: " + context.passed,
"Failed: " + context.failed
];
console.log(stats.join(", "));
window.qunitDone = context;
});
}
const qunit_script = logQUnit.toString();
function check() {
if(window.qunitDone){
return window.qunitDone.failed;
}
}
const check_script = check.toString();

View File

@ -7,15 +7,26 @@
var args = process.argv.slice(2);
if (args.length < 1 || args.length > 2) {
console.log("Usage: node run-qunit.js <URL> <timeout>");
if (args.length < 1 || args.length > 3) {
console.log("Usage: node run-qunit.js <URL> <timeout> <result_file>");
process.exit(1);
}
const chromeLauncher = require('chrome-launcher');
const CDP = require('chrome-remote-interface');
(function() {
const QUNIT_RESULT = args[2];
const fs = require('fs');
if (QUNIT_RESULT) {
(async () => {
await fs.stat(QUNIT_RESULT, (err, stats) => {
if (stats && stats.isFile()) fs.unlink(QUNIT_RESULT);
});
})();
}
async function runAllTests() {
function launchChrome() {
const options = {
@ -24,7 +35,7 @@ const CDP = require('chrome-remote-interface');
'--headless',
'--no-sandbox'
]
}
};
if (process.env.REMOTE_DEBUG) {
options.port = 9222;
@ -33,74 +44,71 @@ const CDP = require('chrome-remote-interface');
return chromeLauncher.launch(options);
}
launchChrome().then(chrome => {
CDP({
port: chrome.port
}).then(protocol => {
const {Page, Runtime} = protocol;
Promise.all([Page.enable(), Runtime.enable()]).then(()=>{
let chrome = await launchChrome();
let protocol = await CDP({ port: chrome.port});
Runtime.consoleAPICalled((response) => {
const message = response['args'][0].value;
const {Page, Runtime} = protocol;
// If it's a simple test result, write without newline
if(message === "." || message === "F"){
process.stdout.write(message);
}else{
console.log(message);
}
});
await Promise.all([Page.enable(), Runtime.enable()]);
Page.navigate({
url: args[0]
});
Runtime.consoleAPICalled((response) => {
const message = response['args'][0].value;
Page.loadEventFired(() => {
// If it's a simple test result, write without newline
if(message === "." || message === "F"){
process.stdout.write(message);
} else if (message.startsWith("AUTOSPEC:")) {
fs.appendFileSync(QUNIT_RESULT, `${message.slice(10)}\n`);
} else {
console.log(message);
}
});
Runtime.evaluate({
expression: `(${qunit_script})()`
}).then(() => {
const timeout = parseInt(args[1] || 300000, 10);
var start = Date.now();
console.log("navigate to " + args[0]);
Page.navigate({url: args[0]});
var interval = setInterval(() => {
if (Date.now() > start + timeout) {
console.error("Tests timed out");
Page.loadEventFired(async () => {
protocol.close();
chrome.kill();
process.exit(124);
} else {
await Runtime.evaluate({ expression: `(${qunit_script})()`});
Runtime.evaluate({
expression: `(${check_script})()`
}).then(numFails => {
if (numFails.result.type !== 'undefined') {
clearInterval(interval);
protocol.close();
chrome.kill();
const timeout = parseInt(args[1] || 300000, 10);
var start = Date.now();
if (numFails.result.value > 0) {
process.exit(1);
} else {
process.exit();
}
}
}).catch(error);
}
}, 250);
}).catch(error(1));
});
}).catch(error(3));
}).catch(error(4));
}).catch(error(5));
})();
var interval;
function error(code){
return function(){
console.log("A promise failed to resolve code:"+code);
process.exit(1);
};
let runTests = async function() {
if (Date.now() > start + timeout) {
console.error("Tests timed out");
protocol.close();
chrome.kill();
process.exit(124);
}
let numFails = await Runtime.evaluate({expression: `(${check_script})()`});
if (numFails && numFails.result && numFails.result.type !== 'undefined') {
clearInterval(interval);
protocol.close();
chrome.kill();
if (numFails.result.value > 0) {
process.exit(1);
} else {
process.exit();
}
}
};
interval = setInterval(runTests, 250);
});
}
try {
runAllTests();
} catch(e) {
console.log("Failed to run tests: " + e);
process.exit(1);
}
// The following functions are converted to strings
@ -122,9 +130,17 @@ function logQUnit() {
}
});
let durations = {};
QUnit.testDone(function(context) {
durations[context.module + "::" + context.name] = context.runtime;
if (context.failed) {
var msg = " Test Failed: " + context.name + assertionErrors.join(" ");
/* QUNIT_RESULT */
testErrors.push(msg);
assertionErrors = [];
console.log("F");
@ -157,6 +173,14 @@ function logQUnit() {
}
}
console.log("Slowest tests");
console.log("----------------------------------------------");
let ary = Object.keys(durations).map((key) => ({ 'key': key, 'value': durations[key] }))
ary.sort((p1, p2) => (p2.value - p1.value));
ary.slice(0, 30).forEach(pair => {
console.log(pair.key + ": " + pair.value + "ms");
});
var stats = [
"Time: " + context.runtime + "ms",
"Total: " + context.total,
@ -164,14 +188,22 @@ function logQUnit() {
"Failed: " + context.failed
];
console.log(stats.join(", "));
window.qunitDone = context;
});
}
const qunit_script = logQUnit.toString();
let qunit_script = logQUnit.toString();
if (QUNIT_RESULT) {
qunit_script = qunit_script.replace("/* QUNIT_RESULT */", "console.log(`AUTOSPEC: ${context.module}:::${context.testId}:::${context.name}`);");
}
function check() {
if(window.qunitDone){
return window.qunitDone.failed;
}
}
const check_script = check.toString();