Adaptation of example run-qunit.js, provided with PhantomJS distribution. Run QUnit test and produce TAP output

run-qunit-tap.js

/**
run-qunit-tap.js

Run QUnit tests using PhantomJS and produce TAP output

Quick and dirty adaptation of example run-qunit.js, provided with PhantomJS
distribution.

All console output, apart from TAP plan and test results, is formatted as a
TAP comment

If you want to test it you can validate the TAP output using this perl
oneliner from pedantic-git:

phantomjs run-qunit-tap.js http://127.0.0.1/my-qunit-test.html | perl -00 -MTAP::Parser -E '$t=TAP::Parser->new({source => <>}); while($_ = $t->next) { say $_->type }'

*/

var system = require('system');

/**
 * Wait until the test condition is true or a timeout occurs. Useful for waiting
 * on a server response or for a ui change (fadeIn, etc.) to occur.
 *
 * @param testFx javascript condition that evaluates to a boolean,
 * it can be passed in as a string (e.g.: "1 == 1" or "$('#bar').is(':visible')" or
 * as a callback function.
 * @param onReady what to do when testFx condition is fulfilled,
 * it can be passed in as a string (e.g.: "1 == 1" or "$('#bar').is(':visible')" or
 * as a callback function.
 * @param timeOutMillis the max amount of time to wait. If not specified, 3 sec is used.
 */
function waitFor(testFx, onReady, timeOutMillis) {
    var maxtimeOutMillis = timeOutMillis ? timeOutMillis : 3001, //< Default Max Timout is 3s
        start = new Date().getTime(),
        condition = false,
        interval = setInterval(function() {
            if ( (new Date().getTime() - start < maxtimeOutMillis) && !condition ) {
                // If not time-out yet and condition not yet fulfilled
                condition = (typeof(testFx) === "string" ? eval(testFx) : testFx()); //< defensive code
            } else {
                if(!condition) {
                    // If condition still not fulfilled (timeout but condition is 'false')
                    console.log("# 'waitFor()' timeout");
                    phantom.exit(1);
                } else {
                    // Condition fulfilled (timeout and/or condition is 'true')
                    console.log("# 'waitFor()' finished in " + (new Date().getTime() - start) + "ms.");
                    typeof(onReady) === "string" ? eval(onReady) : onReady(); //< Do what it's supposed to do once the condition is fulfilled
                    clearInterval(interval); //< Stop this interval
                }
            }
        }, 100); //< repeat check every 250ms
};


if (system.args.length !== 2) {
    console.log('Usage: run-qunit-tap.js URL');
    phantom.exit(1);
}

var page = require('webpage').create();

// Route "console.log()" calls from within the Page context to the main Phantom context (i.e. current "this")
// Assume all output from is a comment unless prefixed with "_TAP_OUTPUT: "
page.onConsoleMessage = function(msg) {
    if(msg.match(/^_TAP_OUTPUT:/)){
        //actual TAP output
        var tapOutput = msg.match(/^_TAP_OUTPUT: (.*?)$/)[1];
        console.log(tapOutput);
    }
    else{
        //all other console.log output should be considered a comment in TAP
        var logLines = msg.split("\n");
        for(var i = 0; i< logLines.length; i++){
            console.log('# ' + logLines[i]);
        }
    }
};


page.onError = function(msg, trace){
     console.error('an error: ' + msg);
}

page.open(system.args[1], function(status){
    if (status !== "success") {
        console.log("# Unable to access network");
        phantom.exit(1);
    } else {
        waitFor(function(){
            return page.evaluate(function(){
                var el = document.getElementById('qunit-testresult');
                if (el && el.innerText.match('completed')) {
                    return true;
                }
                return false;
            });
        }, function(){
            var failedNum = page.evaluate(function(){

                var tapOutput = function(msg){
                    console.log('_TAP_OUTPUT: ' + msg);
                }
                var testPos = 0;
                var testList = document.getElementById('qunit-tests');
                var testResults = testList.children;
                var resultsNum = testResults.length;
                tapOutput('1..' + resultsNum);
                for(var i=0; i < resultsNum; i++){
                    var subTestResults = testResults[i].getElementsByTagName('ol')[0].children;
                    var subTestResultCount = subTestResults.length;
                    for(var j=0; j < subTestResultCount; j++){
                        testPos ++;
                        var subTest = subTestResults[j];
                        var testMessage = subTest.getElementsByClassName('test-message')[0].textContent;
                        var okNotOk = (subTest.className === 'pass') ? 'ok' : 'not ok';
                        tapOutput(okNotOk + ' ' + testPos + ' - ' + testMessage);
                    }
                }

                var el = document.getElementById('qunit-testresult');
                console.log(el.innerText);
                try {
                    return el.getElementsByClassName('failed')[0].innerHTML;
                } catch (e) { }
                return 10000;
            });
            phantom.exit((parseInt(failedNum, 10) > 0) ? 1 : 0);
        }, 12 * 1000);
    }
});

//TODO - error logging