Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

karma-junit-reporter

karma-runner1.7mMIT2.0.1TypeScript support: definitely-typed

A Karma plugin. Report results in junit xml format.

junit, karma-plugin, karma-reporter

readme

karma-junit-reporter

js-standard-style npm version npm downloads

Build Status Dependency Status devDependency Status

Reporter for the JUnit XML format.

Installation

The easiest way is to keep karma-junit-reporter as a devDependency in your package.json. Just run

npm install karma-junit-reporter --save-dev

to let npm automatically add it there.

Configuration

// karma.conf.js
module.exports = function(config) {
  config.set({
    reporters: ['progress', 'junit'],

    // the default configuration
    junitReporter: {
      outputDir: '', // results will be saved as $outputDir/$browserName.xml
      outputFile: undefined, // if included, results will be saved as $outputDir/$browserName/$outputFile
      suite: '', // suite will become the package name attribute in xml testsuite element
      useBrowserName: true, // add browser name to report and classes names
      nameFormatter: undefined, // function (browser, result) to customize the name attribute in xml testcase element
      classNameFormatter: undefined, // function (browser, result) to customize the classname attribute in xml testcase element
      properties: {}, // key value pair of properties to add to the <properties> section of the report
      xmlVersion: null // use '1' if reporting to be per SonarQube 6.2 XML format
    }
  });
};

You can pass list of reporters as a CLI argument too:

karma start --reporters junit,dots

Produce test result with schema acceptable in sonar

To make this possible, it's required to make the classnames of each tests to match its file name.

For Example:

describe('analytics.AnalyticsModule_test', function(){

    var analytics;
    beforeEach(module('ECApp'));
    beforeEach(module('angularytics'));
    beforeEach(module('AnalyticsModule'));
...

should have a file name AnalyticsModule_test.js

This will produce test result with schema acceptable in sonar.

Grunt file reporters property example:

reporters: ['junit', 'coverage', 'progress'],
junitReporter: {
    outputDir: $junitResults,
    suite: 'models'
},
coverageReporter: {
    type: 'lcov',
    dir: $coverageOutputDir,
    subdir: '.'
},
preprocessors: {
    'src/main/webapp/public/js/ec3.3/**/*.js': 'coverage',
    'src/main/webapp/public/js/ec3/**/*.js': 'coverage'
},
plugins: [
    'karma-jasmine',
    'karma-phantomjs-launcher',
    'ec-karma-junit-reporter23',
    'karma-coverage'
]

Sonar property example:

sonar.projectName=js
sonar.sources=site-main-php/src/main/webapp/public/js
sonar.projectBaseDir=.
sonar.exclusions=site-main-php/src/main/webapp/public/js/lib/*.js,site-main-php/src/main/webapp/public/js/tests/**/*.php,site-main-php/src/main/webapp/public/js/tests/**/*.js,site-main-php/src/main/webapp/public/js/ec3.3/vendor/**
sonar.javascript.lcov.reportPath=site-main-php/target/coverage/lcov.info
sonar.javascript.jstestdriver.reportsPath=site-main-php/target/surefire-reports/
sonar.tests=site-main-php/src/main/webapp/public/js/tests

Example junit xml report:

<?xml version="1.0"?>
<testsuite name="PhantomJS 1.9.8 (Linux)" package="models" timestamp="2015-03-10T13:59:23" id="0" hostname="admin" tests="629" errors="0" failures="0" time="11.452">
  <properties>
    <property name="browser.fullName" value="Mozilla/5.0 (Unknown; Linux x86_64) AppleWebKit/534.34 (KHTML, like Gecko) PhantomJS/1.9.8 Safari/534.34"/>
  </properties>
 <testcase name="(C.2) Checks if an empty object is returned when error 404 is encountered" time="0.01" classname="PhantomJS_1_9_8_(Linux).models.AnalyticsModule_test"/>
 <testcase name="(C.3) Checks if an empty array is returned when error 405 is encountered" time="0.013" classname="PhantomJS_1_9_8_(Linux).models.AnalyticsModule_test"/>
</testsuite>
...

For more information on Karma see the homepage.

changelog

2.0.1 (2019-10-07)

2.0.0 (2019-10-07)

Bug Fixes

  • allow special characters and emoji in output (59fd3c6)

Chores

  • travis: Drop old nodejs version: NO v10 (#164) (bc07177)
  • remove support for node 6 (435cb5e)

Features

  • support for new XML format (per SonarQube) (b0984e0)

BREAKING CHANGES

  • Drop Support for Node 6, to make it possible to use async/await in karma codebase.
  • travis: no support for node < 6

  • node 10 not supported by libxmljs-mt

1.2.0 (2016-12-06)

Bug Fixes

  • initialize var suites early (e09acb2)
  • release memory held by a testsuite after we're done with it. (eacf8bb)
  • remove unnecessary nulling out of suites (4202ee8), closes #99

1.1.0 (2016-06-26)

Bug Fixes

  • add defensive checks to safely handle browser disconnects. (485d87a)

1.0.0 (2016-05-03)

0.4.2 (2016-04-08)

Features

  • Add support for additional properties to add to the report section (b67d234)

0.4.1 (2016-03-21)

Bug Fixes

  • check if outputFile is set before checking for absolute outputFile (c8887ac), closes #87

0.4.0 (2016-03-10)

Bug Fixes

  • Handle absolute outputFile paths in Junit Reporter (d5dc808), closes #83
  • test name to contain parent suite(s) names (8e6e202), closes #62

Features

  • add name and classname formatters (3f43c51), closes #75

0.3.8 (2015-10-20)

Features

  • reporter: add useBrowserName parameter (2327234)

0.3.7 (2015-10-01)

Bug Fixes

  • reporter: bug creating directory when outputFile specified (#67) (2205f47)

0.3.6 (2015-09-29)

Bug Fixes

0.3.5 (2015-09-27)

Bug Fixes

0.3.4 (2015-08-28)

Bug Fixes

  • Change how classname is generated (e4f7ebd)
  • config: Default outputDir to '.' (8fdfb73), closes #54

Features

  • Upgrade dependencies to their latest versions (62b5783)

<a name"0.3.3">

0.3.3 (2015-07-23)

Bug Fixes

  • create browser directory if not exist (fe14a8d8)

<a name"0.3.2">

0.3.2 (2015-07-19)

Features

  • Allow user to specify filename (71e0e432)

<a name"0.3.1">

0.3.1 (2015-07-13)

Bug Fixes

  • handle browser script failure and put the error to browser report (d5b365ab)

<a name"0.3.0">

0.3.0 (2015-07-13)

Features

  • add error tag when browser disconnected (a1a1e7c4, closes #29)

<a name"0.2.2">

0.2.2 (2015-07-13)

Bug Fixes

  • reporter fails when browser times out (00fbfe4c, closes #16)

<a name"0.2.1">

0.2.1 (2015-07-13)

Bug Fixes

  • Compatibility with Karma 0.10 (29d4de18)
  • update to work with Karma 0.11 (a0676bec)

Features

<a name"0.1.0">

0.1.0 (2015-07-13)

<a name"0.0.2">

0.0.2 (2015-07-13)

Features

  • reporter.junit: add a 'skipped' tag for skipped testcases (b552dcb4)