Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Runs Jasmine tests using PhantomJS. Adapted for use within TeamCity..Compatible with Jasmine 2.0.
var system = require('system'),
env = system.env;
/**
* 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 Timeout 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 100ms
};
if (system.args.length !== 2) {
console.log('Usage: run-jasmine.js URL');
phantom.exit(1);
}
var page = require('webpage').create();
/**
*
##teamcity[testSuiteStarted name='suite.name']
##teamcity[testSuiteStarted name='nested.suite']
##teamcity[testStarted name='package_or_namespace.ClassName.TestName']
##teamcity[testFailed name='package_or_namespace.ClassName.TestName' message='The number should be 20000' details='expected:<20000> but was:<10000>']
##teamcity[testFinished name='package_or_namespace.ClassName.TestName']
##teamcity[testSuiteFinished name='nested.suite']
##teamcity[testSuiteFinished name='suite.name']
*/
// Route "console.log()" calls from within the Page context to the main Phantom context (i.e. current "this")
page.onConsoleMessage = function (msg) {
var teamCityMessage = msg.indexOf('TEAMCITY_') === 0;
if (teamCityMessage) {
if (!env.hasOwnProperty('TEAMCITY_PROJECT_NAME')) return;
var separatorIndex = msg.indexOf(':');
var command = msg.substring(0, separatorIndex);
var data = JSON.parse(msg.substring(separatorIndex + 1));
switch (command) {
case 'TEAMCITY_TESTSTARTED': {
console.log("##teamcity[testStarted name='" + escape(data.name) + "']");
break;
}
case 'TEAMCITY_TESTFINISHED': {
console.log("##teamcity[testFinished name='" + escape(data.name) + "']");
break;
}
case 'TEAMCITY_SUITESTARTED': {
console.log("##teamcity[testSuiteStarted name='" + escape(data.suite) + "']");
break;
}
case 'TEAMCITY_SUITEFINISHED': {
console.log("##teamcity[testSuiteFinished name='" + escape(data.suite) + "']");
break;
}
case 'TEAMCITY_TESTFAILED': {
console.log("##teamcity[testFailed name='" + escape(data.name) + "' message='" + escape(data.message) + "']");
break;
}
}
}
else {
if (env.hasOwnProperty('TEAMCITY_PROJECT_NAME')) return;
console.log(msg);
}
function escape(message) {
while (message.indexOf("'") >= 0) message = message.replace("'", '"');
return message;
}
};
page.open(system.args[1], function (status) {
if (status !== "success") {
console.log("Unable to access network");
phantom.exit();
} else {
waitFor(function () {
return page.evaluate(function () {
return document.body.querySelector('.symbolSummary .pending') === null
});
}, function () {
var exitCode = page.evaluate(function () {
var currentSuite;
var successList = document.body.querySelectorAll('.results > .summary .specs > .passed');
var suites = {};
if (successList && successList.length > 0) {
for (var i = 0; i < successList.length; ++i) {
var el = successList[i],
name = el.children[0].innerText,
suite = el.parentElement.parentElement.querySelector('.suite-detail').innerText;
suites[suite] = suites[suite] || [];
suites[suite].push({ status: 'success', name: name });
}
}
var failedList = document.body.querySelectorAll('.results > .failures > .spec-detail.failed');
if (failedList && failedList.length > 0) {
console.log('');
console.log(failedList.length + ' test(s) FAILED:');
for (var i = 0; i < failedList.length; ++i) {
var el = failedList[i],
name = el.querySelector('.description').innerText,
msg = el.querySelector('.result-message').innerText,
suite = name.substring(0, name.indexOf(' '));
// remove trailing period
name = name.substring(0, name.length - 1);
suites[suite] = suites[suite] || [];
suites[suite].push({ suite: suite, status: 'failed', name: name, message: name + ': ' + msg });
}
}
for (var suite in suites) {
var tests = suites[suite];
console.log('TEAMCITY_SUITESTARTED:' + JSON.stringify({ suite: suite }));
for (var i in tests) {
var test = tests[i];
console.log('TEAMCITY_TESTSTARTED:' + JSON.stringify({ name: test.name }));
if (test.status === 'success') {
}
else if (test.status === 'failed') {
console.log('TEAMCITY_TESTFAILED:' + JSON.stringify({ name: test.name, message: test.message }));
console.log('');
console.log(test.suite);
console.log(test.message);
}
console.log('TEAMCITY_TESTFINISHED:' + JSON.stringify({ name: test.name }));
}
console.log('TEAMCITY_SUITEFINISHED:' + JSON.stringify({ suite: suite }));
}
if (failedList && failedList.length > 0) {
return 1;
} else {
console.log(document.body.querySelector('.alert > .bar.passed').innerText);
return 0;
}
});
phantom.exit(exitCode);
});
}
});
@Greenstone3672

This comment has been minimized.

Copy link

Greenstone3672 commented Mar 27, 2014

This just helped me out on a project today. Thanks for the 2.0 updates!

@steffstefferson

This comment has been minimized.

Copy link

steffstefferson commented Jun 4, 2014

Cool stuff, thanks a lot! It worked straightaway.

@Purush0th

This comment has been minimized.

Copy link

Purush0th commented Aug 27, 2014

Guys i am using custom jasmine 2.0 which with works with requirejs based spec implementation.
Here i've got https://github.com/erikringsmuth/jasmine2-amd-specrunner/

Running tests on browser is fine but phantomjs is not running. It throws following type error.

'waitFor()' finished in 219ms.
TypeError: 'null' is not an object (evaluating 'document.body.querySelector('.alert > .bar.passed').innerText')

  phantomjs://webpage.evaluate():58
  phantomjs://webpage.evaluate():61
  phantomjs://webpage.evaluate():61

I am trying to integrate test suites with team city. Please help me guys.

@Purush0th

This comment has been minimized.

Copy link

Purush0th commented Aug 27, 2014

when 'waitFor()' finished in 228 ms or higher all tests getting passed. How can i control wait time?

@thegruffalo

This comment has been minimized.

Copy link

thegruffalo commented Oct 9, 2014

Hi Purush0th, I've been experiencing similar problems myself. The problem is the html reporter is not initialised before the jquery selector is run, the reason for this is you are waiting for the modules to be loaded before initialing and running the specs. IMHO a better way of doing this teamcity integration is to use the JSApiReporter, (I'm keen to try this) however as a stop gap you can initialise the htmlreporter before requiring the modules.

@daniel-chambers

This comment has been minimized.

Copy link

daniel-chambers commented Oct 10, 2014

Purush0th and thegruffalo, I've fixed that bug in my fork of this script (barahilia, feel free to incorporate that change here): https://gist.github.com/daniel-chambers/f783d8ef869e64281e98/937d16ba9284cfadb5a7fecd0f08d9f1946a68a0

The problem seems to be that the code that runs after the tests have completed don't quite wait until the jasmine runner has finished updating the dom. I've modified the script so that it waits for the appropriate dom elements to appear on the page before trying to find them.

@leviwilson

This comment has been minimized.

Copy link

leviwilson commented Dec 11, 2014

Nice, @daniel-chambers...thanks for the patch!

@jiimaho

This comment has been minimized.

Copy link

jiimaho commented May 19, 2015

Does this work with Jasmine 2.2?

Update: Yes it seems to be working for 2.2. However I get the same error as Purush0th above.
Update2: After trying with daniel-chambers script, I instead get "'waitFor()' timeout". Any ideas?

@marti1125

This comment has been minimized.

Copy link

marti1125 commented Oct 6, 2015

nice! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.