Cypress v3.7.0 has arrived - featuring improved support for GitHub Actions, browser customization, and more

See what's new

Reporters

Improve this doc

Because Cypress is built on top of Mocha, that means any reporter built for Mocha can be used with Cypress. Here is a list of built in Mocha reporters.

We’ve also added the two most common 3rd party reporters for Mocha. These are built into Cypress and you can use them without installing anything.

Finally, we support creating your own custom reporters or using any kind of 3rd party reporter.

Once you’ve read through the documentation below, we invite you to experience the power of Cypress reporters via Section 9 of our open source testing workshop for Cypress.

Custom reporter

You need to install any peer dependencies the reporter requires, even if they’re bundled with Cypress. For example, mochawesome requires mocha as a peer dependency. You will need to install mocha as a dev dependency of your own project for it to work.

Installed locally

Custom reporters can be loaded through a relative or absolute path. These can be specified in your configuration file (cypress.json by default) or via the command line.

For example, if you have the following directory structure:

> my-project
  > cypress
  > src
  > reporters
    - custom.js

You would specify the path to your custom reporter in either of the ways below.

Config File

{
  "reporter": "reporters/custom.js"
}

Command Line

cypress run --reporter reporters/custom.js

Installed via npm

When using custom reporters via npm, specify the package name.

Config file

{
  "reporter": "mochawesome"
}

Command line

cypress run --reporter mochawesome

Reporter Options

Some reporters accept options that customize their behavior. These can be specified in your configuration file (cypress.json by default) or via command line options.

Reporter options differ depending on the reporter (and may not be supported at all). Refer to the documentation for the reporter you are using for details on which options are supported.

The below configuration will output the JUnit report to STDOUT and save it into an XML file.

Config file

{
  "reporter": "junit",
  "reporterOptions": {
    "mochaFile": "results/my-test-output.xml",
    "toConsole": true
  }
}

Command line

cypress run --reporter junit \
  --reporter-options "mochaFile=results/my-test-output.xml,toConsole=true"

Merging reports across spec files

Each spec file is processed completely separately during each cypress run execution. Thus each spec run overwrites the previous report file. To preserve unique reports for each specfile, use the [hash] in the mochaFile filename.

The following configuration will create separate XML files in the results folder. You can then merge the reported output in a separate step using a 3rd party tool. For example, for the Mochawesome reporter, you can use the mochawesome-merge tool.

Config file

{
  "reporter": "junit",
  "reporterOptions": {
    "mochaFile": "results/my-test-output-[hash].xml"
  }
}

Command line

cypress run --reporter junit \
  --reporter-options "results/my-test-output-[hash].xml"

Multiple reporters

Oftentimes we see users wanting the ability to use multiple reporters. When running in CI, you might want to generate a report for junit and perhaps a json report. This is great, but by setting this reporter you won’t receive any additional feedback while the tests are running!

The solution here is to use multiple reporters. You will have the benefit of both worlds.

We suggest using the npm module: https://github.com/you54f/cypress-multi-reporters

We use multiple reporters for every single one of our internal projects.

The below examples were implemented in https://github.com/cypress-io/cypress-example-circleci-orb.

Examples

Spec to STDOUT, save JUnit XML files

We want to output a “spec” report to STDOUT, while saving Mochawesome JSON reports and then combine them into a single report.

We need to install additional dependencies including Mocha itself.

npm install --save-dev mocha cypress-multi-reporters mocha-junit-reporter

Specify your reporter and reporterOptions in your configuration file (cypress.json by default) or via the command line.

Config file

{
  "reporter": "cypress-multi-reporters",
  "reporterOptions": {
    "configFile": "reporter-config.json"
  }
}

Command line

cypress run --reporter cypress-multi-reporters \
  --reporter-options configFile=reporter-config.json

Then add the separate reporter-config.json file (defined in your configuration) to enable spec and junit reporters and direct the junit reporter to save a separate XML files.

{
  "reporterEnabled": "spec, mocha-junit-reporter",
  "reporterOptions": {
    "mochaFile": "cypress/results/results-[hash].xml"
  }
}

We recommend deleting all files from the cypress/results folder before running this command, since each run will output new XML files. For example, you can add the npm script commands below to your package.json then call npm run report.

{
  "scripts": {
    "delete:reports": "rm cypress/results/* || true",
    "prereport": "npm run delete:reports",
    "report": "cypress run --reporter cypress-multi-reporters --reporter-options configFile=reporter-config.json"
  }
}

Spec to STDOUT, produce a combined Mochawesome JSON file

This example is shown in the branch spec-and-single-mochawesome-json in https://github.com/cypress-io/cypress-example-circleci-orb. We want to output a “spec” report to STDOUT, save an individual Mochawesome JSON file per test file, and then combine all JSON reports into a single report.

We need to install several dependencies.

npm install --save-dev mocha mochawesome mochawesome-merge mochawesome-report-generator

We need to configure the reporter in your configuration file (cypress.json by default) to skip the HTML report generation and save each individual JSON file in the cypress/results folder.

Config file

{
  "reporter": "mochawesome",
  "reporterOptions": {
    "reportDir": "cypress/results",
    "overwrite": false,
    "html": false,
    "json": true
  }
}

Command line

cypress run --reporter mochawesome \
  --reporter-options reportDir=reporter-config.json,overwrite=false,html=false,json=true

Our run will generate files cypress/results/mochawesome.json, cypress/results/mochawesome_001.json, .... Then we can combine them using the mochawesome-merge utility.

npx mochawesome-merge --reportDir cypress/results > mochawesome.json

We can now generate a combined HTML report from the mochawesome.json file using the https://github.com/adamgruber/mochawesome-report-generator:

npx mochawesome-report-generator mochawesome.json

It generates the beautiful standalone HTML report file mochawesome-report/mochawesome.html shown below. As you can see all test results, timing information, and even test bodies are included.

Mochawesome HTML report

For more information, see Integrating Mochawesome reporter with Cypresss