Jest tests

Projektor can visualize test results from any test framework that can output JUnit XML format, including Jest. In just a few simple steps you can set up your Jest test results to be available in Projektor.

First, add the jest-junit package (https://www.npmjs.com/package/jest-junit) to your project:

  "devDependencies": {
    "jest-junit": "17.0.0",
  }

Then add jest-junit as a Jest reporter and configure it to write the JUnit XML results file that Projektor understands:

package.json

  "jest": {
    "reporters": [
      "default",
      "jest-junit"
    ]
  },
  "jest-junit": {
    "includeConsoleOutput": "true",
    "outputDirectory": "jestResults",
    "classNameTemplate": "{classname}",
    "usePathForSuiteName": "true"
  }

With the above config, the jest-junit package will write the JUnit XML file in the jestResults directory, so now we just need to point Projektor at that directory.

On the command line:

yarn projektor-publish --serverUrl=<projektor_url> jestResults/*.xml

Or in the projektor.json configuration file:

{
  "serverUrl": "<url>",
  "results": [
    "jestResults/*.xml"
  ]
}

Code coverage

To include code coverage in your Projektor report, turn on coverage collection in Jest:

  "jest": {
    "reporters": [
      "default",
      "jest-junit"
    ],
    "collectCoverage": true
  }

Jest’s default coverage reporters include clover, which writes the coverage/clover.xml file that Projektor reads. (If you’ve customized coverageReporters, make sure clover is in the list.)

Then add the coverage file to your Projektor config:

{
  "serverUrl": "<url>",
  "results": [
    "jestResults/*.xml"
  ],
  "coverage": [
    "coverage/clover.xml"
  ]
}