/* * grunt-contrib-jasmine * http://gruntjs.com/ * * Licensed under the MIT license. */ 'use strict'; module.exports = function(grunt) { // node api var fs = require('fs'), path = require('path'); // npm lib var phantomjs = require('grunt-lib-phantomjs').init(grunt); // local lib var jasmine = require('./lib/jasmine').init(grunt, phantomjs); var junitTemplate = __dirname + '/jasmine/templates/JUnit.tmpl'; var status = {}; grunt.registerMultiTask('jasmine', 'Run jasmine specs headlessly through PhantomJS.', function() { // Merge task-specific options with these defaults. var options = this.options({ version : '1.3.1', timeout : 10000, styles : [], specs : [], helpers : [], vendor : [], outfile : '_SpecRunner.html', host : '', template : __dirname + '/jasmine/templates/DefaultRunner.tmpl', templateOptions : {}, phantomjs : {}, junit: {} }); if (options.template === 'requirejs') { grunt.log.warn( 'The requirejs template is no longer included in grunt-contrib-jasmine core.\n' + 'Please see the https://github.com/gruntjs/grunt-contrib-jasmine README for details' ); } if (grunt.option('debug')) { grunt.log.debug(options); } setup(options); jasmine.buildSpecrunner(this.filesSrc,options); // If we're just building (e.g. for web), skip phantom. if (this.flags.build) return; var done = this.async(); phantomRunner(options, function(err,status) { var success = !err && status.failed === 0; if (err) grunt.log.error(err); if (status.failed === 0) grunt.log.ok('0 failures'); else grunt.log.error(status.failed + ' failures'); teardown(options, function(){ done(success); }); }); }); function logWrite(text, isInline) { text += (isInline ? '' : '\n'); status.log += text; grunt.verbose.write(text); } function phantomRunner(options,cb){ var file = options.outfile; if (options.host) { if (!(/\/$/).test(options.host)) options.host = options.host + '/'; file = options.host + options.outfile; } grunt.verbose.subhead('Testing jasmine specs via phantom').or.writeln('Testing jasmine specs via phantom'); phantomjs.spawn(file, { failCode : 90, options : options, done : function(err){ cb(err,status); } }); } function teardown(options, cb) { phantomjs.removeAllListeners(); phantomjs.listenersAny().length = 0; if (!options.keepRunner && fs.statSync(options.outfile).isFile()) fs.unlink(options.outfile); if (!options.keepRunner) { jasmine.cleanTemp(cb); } else { cb(); } } function setup(options) { var thisRun = {}; status = { specs : 0, failed : 0, passed : 0, total : 0, skipped : 0, duration : 0, log : '' }; phantomjs.on('fail.timeout',function(){ grunt.log.writeln(); grunt.warn('PhantomJS timed out, possibly due to an unfinished async spec.', 90); }); phantomjs.on('console',console.log.bind(console)); phantomjs.on('verbose',grunt.verbose.writeln.bind(grunt.verbose)); phantomjs.on('debug', grunt.log.debug.bind(grunt.log, 'phantomjs')); phantomjs.on('write', grunt.log.write.bind(grunt.log)); phantomjs.on('writeln', grunt.log.writeln.bind(grunt.log)); phantomjs.on('error.onError',function(string, trace){ if (trace && trace.length) { grunt.log.error(string.red + ' at '); trace.forEach(function(line) { var file = line.file.replace(/^file:/,''); var message = grunt.util._('%s:%d %s').sprintf(path.relative('.',file), line.line, line.function); grunt.log.error(message.red); }); } else { grunt.log.error("Error caught from phantom. More info can be found by opening the Spec Runner in a browser."); grunt.warn(string); } }); phantomjs.onAny(function() { var args = [this.event].concat(grunt.util.toArray(arguments)); grunt.event.emit.apply(grunt.event, args); }); phantomjs.on('jasmine.reportRunnerStarting',function(suites) { grunt.verbose.writeln('Starting...'); thisRun.start_time = (new Date()).getTime(); thisRun.executed_specs = 0; thisRun.passed_specs = 0; }); phantomjs.on('jasmine.reportSpecStarting',function(spec) { thisRun.executed_specs++; grunt.verbose.write(spec.suite.description + ':' + spec.description + '...'); }); phantomjs.on('jasmine.reportSuiteResults',function(suite){ //grunt.verbose.writeln(suite.description + ": " + suite.results.passedCount + " of " + suite.results.totalCount + " passed."); }); phantomjs.on('jasmine.reportSpecResults',function(specId, result, fullName) { if (result.passed) thisRun.passed_specs++; if (!result.passed) { if (grunt.option('verbose')) grunt.verbose.writeln(result.description + ': ' + result.msg.red); else { logWrite(fullName + ': ' + result.msg.red); grunt.log.write('x'.red); } } else { grunt.verbose.writeln(result.description + ': ' + result.msg.green); if (!grunt.option('verbose')) grunt.log.write('.'); } for (var i = 0; i < result.messages.length; i++) { var item = result.messages[i]; if (item.type === 'log') { grunt.verbose.writeln(item.toString()); } else if (item.type === 'expect' && !item.passed_) { var specIndex = ' ('+(i+1)+')'; logWrite(' ' + item.message.red+specIndex.red); phantomjs.emit('onError', item.message, item.trace); } } phantomjs.emit( 'jasmine.testDone', result.totalCount, result.passedCount, result.failedCount, result.skipped ); }); phantomjs.on('jasmine.reportRunnerResults',function(){ var dur = (new Date()).getTime() - thisRun.start_time; var spec_str = thisRun.executed_specs + (thisRun.executed_specs === 1 ? " spec " : " specs "); grunt.verbose.writeln('Runner finished'); if (thisRun.executed_specs === 0) { grunt.warn('No specs executed, is there a configuration error?'); } if (!grunt.option('verbose')) { grunt.log.writeln(''); grunt.log.write(status.log); } grunt.log.writeln(spec_str + 'in ' + (dur/1000) + "s."); }); phantomjs.on('jasmine.testDone',function(totalAssertions, passedAssertions, failedAssertions, skippedAssertions){ status.specs++; status.failed += failedAssertions; status.passed += passedAssertions; status.total += totalAssertions; status.skipped += skippedAssertions; }); phantomjs.on('jasmine.reportJUnitResults',function(junitData){ if (options.junit && options.junit.path) { var template = grunt.file.read(junitTemplate); if (options.junit.consolidate) { grunt.util._(junitData.consolidatedSuites).each(function(suites){ var xmlFile = path.join(options.junit.path, 'TEST-' + suites[0].name.replace(/[^\w]/g, '') + '.xml'); grunt.file.write(xmlFile, grunt.util._.template(template, { testsuites: suites})); }); } else { junitData.suites.forEach(function(suiteData){ var xmlFile = path.join(options.junit.path, 'TEST-' + suiteData.name.replace(/[^\w]/g, '') + '.xml'); grunt.file.write(xmlFile, grunt.util._.template(template, { testsuites: [suiteData] })); }); } } }); phantomjs.on('jasmine.done',function(elapsed){ phantomjs.halt(); status.duration = elapsed; }); phantomjs.on('jasmine.done.PhantomReporter',function(){ phantomjs.emit('jasmine.done'); }); phantomjs.on('jasmine.done_fail',function(url){ grunt.log.error(); grunt.warn('PhantomJS unable to load "' + url + '" URI.', 90); }); } };