jasmine-reporters

What is jasmine-reporters?

The jasmine-reporters npm package provides a set of reporters for the Jasmine testing framework. These reporters can generate test results in various formats, such as JUnit XML, TAP, and more, which can be used for continuous integration and other reporting purposes.

What are jasmine-reporters's main functionalities?

JUnit XML Reporter

The JUnit XML Reporter generates test results in JUnit XML format, which is commonly used by CI tools like Jenkins. The code sample demonstrates how to configure and add the JUnit XML Reporter to a Jasmine test suite.

const Jasmine = require('jasmine');
const JasmineReporters = require('jasmine-reporters');

const jasmine = new Jasmine();
jasmine.loadConfigFile('spec/support/jasmine.json');

const junitReporter = new JasmineReporters.JUnitXmlReporter({
  savePath: 'test_results',
  consolidateAll: false
});
jasmine.addReporter(junitReporter);

jasmine.execute();

TAP Reporter

The TAP Reporter outputs test results in the Test Anything Protocol (TAP) format. This format is useful for integrating with TAP consumers. The code sample shows how to set up the TAP Reporter in a Jasmine test suite.

const Jasmine = require('jasmine');
const JasmineReporters = require('jasmine-reporters');

const jasmine = new Jasmine();
jasmine.loadConfigFile('spec/support/jasmine.json');

const tapReporter = new JasmineReporters.TapReporter();
jasmine.addReporter(tapReporter);

jasmine.execute();

TeamCity Reporter

The TeamCity Reporter formats test results for integration with JetBrains TeamCity. The code sample illustrates how to add the TeamCity Reporter to a Jasmine test suite.

const Jasmine = require('jasmine');
const JasmineReporters = require('jasmine-reporters');

const jasmine = new Jasmine();
jasmine.loadConfigFile('spec/support/jasmine.json');

const teamCityReporter = new JasmineReporters.TeamCityReporter();
jasmine.addReporter(teamCityReporter);

jasmine.execute();

Other packages similar to jasmine-reporters

karma-junit-reporter

The karma-junit-reporter package is a reporter for the Karma test runner that generates test results in JUnit XML format. It is similar to the JUnit XML Reporter in jasmine-reporters but is specifically designed for use with Karma.

mocha-junit-reporter

The mocha-junit-reporter package is a reporter for the Mocha testing framework that outputs test results in JUnit XML format. It serves a similar purpose to the JUnit XML Reporter in jasmine-reporters but is tailored for Mocha.

jest-junit

The jest-junit package is a Jest reporter that generates test results in JUnit XML format. It is comparable to the JUnit XML Reporter in jasmine-reporters but is intended for use with the Jest testing framework.

README

This branch is for Jasmine 1.x. Switch to the 2.x branch.

Jasmine Reporters

Jasmine Reporters is a collection of javascript jasmine.Reporter classes that can be used with the JasmineBDD testing framework.

Included reporters:

• ConsoleReporter - Report test results to the browser console.
• JUnitXmlReporter - Report test results to a file in JUnit XML Report format.
• NUnitXmlReporter - Report test results to a file in NUnit XML Report format.
• TapReporter - Test Anything Protocol, report tests results to console.
• TeamcityReporter - Basic reporter that outputs spec results to for the Teamcity build system.
• TerminalReporter - Logs to a terminal (including colors) with variable verbosity.

Usage

Examples are included in the test directory that show how to use the reporters, as well a basic runner scripts for Rhino + envjs, and a basic runner for PhantomJS. Either of these methods could be used in a Continuous Integration project for running headless tests and generating JUnit XML output.

Rhino + EnvJS

Everything needed to run the tests in Rhino + EnvJS is included in this repository inside the ext directory, specifically Rhino 1.7r2 and envjs 1.2 for Rhino.

PhantomJS

Should work in most versions of PhantomJS > 1.4.1 I have used PhantomJS 1.4.1 through 1.9.6 on Mac OS X with no problems.

Node.js

Most of these reporters also work in node.js by making use of the excellent jasmine-node project.

Protractor

Protractor 1.6.0 or above allows you to use either Jasmine 1 or Jasmine 2. If you are using Jasmine 1, make sure you install a 1.x-compatible version of jasmine-reporters:

npm install --save-dev jasmine-reporters@^1.0.0

Then set everything up inside your protractor.conf:

onPrepare: function() {
    // The require statement must be down here, since jasmine-reporters@1.0
    // expects jasmine to be in the global and protractor does not guarantee
    // this until inside the onPrepare function.
    require('jasmine-reporters');
    jasmine.getEnv().addReporter(
        new jasmine.JUnitXmlReporter('xmloutput', true, true)
    );
}