Output jasmine test results to the console

Question

I am using Jasmine (BDD Testing Framework for JavaScript) in my firefox add-on to test the functionality of my code.

The problem is that jasmine is outputing the test results to an HTML file,what I need is to Firebug Console or other solution to output the results.

Solution 1

Have you tried the ConsoleReporter?

jasmine.getEnv().addReporter(new jasmine.ConsoleReporter(console.log));

According to the code Jasmine has the ConsoleReporter class that executes a print function (in this case console.log) that should do what you need.

If all else fails you could just use this as a starting point to implement your own console.log reporter.

UPDATE In newer versions of jasmine, ConsoleReporter was removed. You can either use the built-in jsApiReporter, or write your own (console) reporter, as shown in the following link: https://jasmine.github.io/tutorials/custom_reporter

Solution 2

In newest version of Jasmine (2.0) if you want to get test output to console you need to add following lines.

var ConsoleReporter = jasmineRequire.ConsoleReporter();
var options = {
   timer: new jasmine.Timer, 
   print: function () {
      console.log.apply(console,arguments)
}};
consoleReporter = new ConsoleReporter(options); // initialize ConsoleReporter
jasmine.getEnv().addReporter(consoleReporter); //add reporter to execution environment

Output to html is included by default however so if you don't want html output at all you have to edit your boot.js file and remove relevant lines from there. If you want to customize how output is displayed in console edit file console.js. Source

Solution 3

jasmineRequire.ConsoleReporter did not exist in 2.3.0 so I used the following code:

//create a console.log reporter
var MyReporter = function(){jasmineRequire.JsApiReporter.apply(this,arguments);};
MyReporter.prototype = jasmineRequire.JsApiReporter.prototype;
MyReporter.prototype.constructor = MyReporter;
MyReporter.prototype.specDone=function(o){
    o=o||{};
    if(o.status!=="passed"){
      console.warn("Failed:" + o.fullName + o.failedExpectations[0].message);
    }
};
var env = jasmine.getEnv();
env.addReporter(new MyReporter());

Solution 4

For the sake of completeness here's the full configuration:

First of all run the npm install command:

npm install jasmine-console-reporter --save-dev

Then check your Jasmine configuration to make sure you got the helpers setting there:

spec/support/jasmine.json

{
    "spec_dir": "spec",
    "spec_files": [
        "**/*[sS]pec.js"
    ],
    "helpers": [
        "helpers/**/*.js"
    ],
    "stopSpecOnExpectationFailure": false,
    "random": false
}

Since helpers are executed before specs the only thing you have to do is to create a console reporter helper.

spec/helpers/reporter/consoleReporter.js

const JasmineConsoleReporter = require('jasmine-console-reporter');

let consoleReporter = new JasmineConsoleReporter({
    colors: 1,           // (0|false)|(1|true)|2
    cleanStack: 1,       // (0|false)|(1|true)|2|3
    verbosity: 4,        // (0|false)|1|2|(3|true)|4
    listStyle: 'indent', // "flat"|"indent"
    activity: false
});

jasmine.getEnv().addReporter(consoleReporter);

• jasmine-console-reporter on npmjs.com
• Jasmine custom reporter docs
• Jasmine configuration reference

View more solutions

Comments

[DShah]

Have you implemented Jasmine for iPhone??? if yes, does the ConsoleReporter works for getting output in Console of iPhone??

[Mateusz Szulc]

It works, but watch out which version of Jasmine you're using. Provided ConsoleReporter github link points to master branch version of ConsoleReporter.js, which use different reporter-API as current (1.3.1) official version of Jasmine (e.g. jasmineStarted or jasmineDone instead of reportRunnerStarting etc). If it does not work for you, you probably need to select v1.3.1 tag (or use this link).

[Dave Sag]

Running Jasmine via Guard (using PhantomJS) I tried adding the above to the describe block of my test but get "Can't find variable: jasmineRequire"

[mustafa.0x]

@DaveSag add it to boot.js.

[Green]

That is ridiculous how complicated it is with jasmine. Why not just to add "color": "true" option in jasmine.json? Like in mocha just type --color in config file

[cxw]

Worked for me under Jasmine 2.8.0 :) I added this to boot.js just after creation of the jsApiReporter. I removed the var env=... line since env already existed. Would you be willing to add a bit of explanation to help me better understand the interactions between JsApiReporter and MyReporter?