cypress-mochawesome-reporter

What is cypress-mochawesome-reporter?

The cypress-mochawesome-reporter is an npm package that integrates Mochawesome reporting with Cypress, allowing you to generate detailed, visually appealing test reports for your Cypress tests.

What are cypress-mochawesome-reporter's main functionalities?

Generate HTML Reports

This feature allows you to generate HTML reports for your Cypress tests. By including the plugin in your Cypress configuration, you can produce detailed and visually appealing reports.

module.exports = (on, config) => {
  require('cypress-mochawesome-reporter/plugin')(on);
};

Customizable Report Options

This feature allows you to customize various options for your reports, such as the directory where reports are saved, whether to overwrite existing reports, and whether to generate HTML and JSON reports.

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

Screenshots and Videos Integration

This feature allows you to integrate screenshots and videos into your reports. You can add custom logic to handle screenshots and videos, making your reports more comprehensive and useful for debugging.

module.exports = (on, config) => {
  require('cypress-mochawesome-reporter/plugin')(on);
  on('after:screenshot', (details) => {
    // Custom logic for handling screenshots
  });
};

Other packages similar to cypress-mochawesome-reporter

mochawesome

Mochawesome is a standalone reporter for Mocha tests that generates a visually appealing HTML report. It is similar to cypress-mochawesome-reporter but is not specifically designed for Cypress. It can be used with any Mocha-based testing framework.

cypress-multi-reporters

Cypress-multi-reporters allows you to use multiple reporters for your Cypress tests. It can be used to combine different reporting formats, such as JSON and HTML, into a single test run. While it does not provide the same level of visual detail as cypress-mochawesome-reporter, it offers flexibility in combining different reporting tools.

cypress-junit-reporter

Cypress-junit-reporter is a reporter that generates JUnit XML reports for Cypress tests. It is useful for integrating Cypress test results with CI/CD pipelines that require JUnit format. Unlike cypress-mochawesome-reporter, it focuses on XML output rather than HTML.

README

cypress-mochawesome-reporter

Zero config Mochawesome reporter for Cypress with screenshots attached to tests.

Example report

Cypress compatibility

reporter version	cypress version	reporter branch
v3	node >= 14 >= 6.7.0 >= 6.2.0 with experimentalRunEvents: true	master
v2	>= 6.7.0 >= 6.2.0 with experimentalRunEvents: true	v2
v1	>= 4.0.0	v1

migration guide from v1 to v2

Setup

This setup tutorial works with Cypress >= v10, looking for older version setup? here

1. install cypress-mochawesome-reporter

   npm i --save-dev cypress-mochawesome-reporter
   

   or

   yarn add -D cypress-mochawesome-reporter
   

2. Change cypress reporter & setup hooks

   Edit config file (cypress.config.js by default)

   const { defineConfig } = require('cypress');
   
   module.exports = defineConfig({
     reporter: 'cypress-mochawesome-reporter',
     e2e: {
       setupNodeEvents(on, config) {
         require('cypress-mochawesome-reporter/plugin')(on);
       },
     },
   });
   

   If you are override before:run or after:run hooks, use this:

   const { defineConfig } = require('cypress');
   const { beforeRunHook, afterRunHook } = require('cypress-mochawesome-reporter/lib');
   
   module.exports = defineConfig({
     reporter: 'cypress-mochawesome-reporter',
     e2e: {
       setupNodeEvents(on, config) {
         on('before:run', async (details) => {
           console.log('override before:run');
           await beforeRunHook(details);
         });
   
         on('after:run', async () => {
           console.log('override after:run');
           await afterRunHook();
         });
       },
     },
   });
   

3. Add to cypress/support/e2e.js

   import 'cypress-mochawesome-reporter/register';
   

4. (optional, if your are using cypress-cucumber-preprocessor) Add to cypress/support/step_definitions/index.js

   import 'cypress-mochawesome-reporter/cucumberSupport';
   

   ⚠️ cypress-cucumber-preprocessor uses the same hooks as cypress-mochawesome-reporter, you also need to install cypress-on-fix. Full example of using cypress-mochawesome-reporter with cypress-cucumber-preprocessor can be found here.

5. run cypress

Custom options

If you want to customize your HTML report with mochawesome-report-generator flags just add the flags you want to reporterOptions

const { defineConfig } = require('cypress');

module.exports = defineConfig({
  reporter: 'cypress-mochawesome-reporter',
  reporterOptions: {
    charts: true,
    reportPageTitle: 'custom-title',
    embeddedScreenshots: true,
    inlineAssets: true,
    saveAllAttempts: false,
  },
  e2e: {
    setupNodeEvents(on, config) {
      require('cypress-mochawesome-reporter/plugin')(on);
    },
  },
});

Additional reporter options:

name	type	default	description
embeddedScreenshots	boolean	false	Embedded external screenshots into HTML using base64, use with inlineAssets option to produce a single HTML file
ignoreVideos	boolean	false	Will not copy videos recorded by Cypress nor show them in the mochawesome report. Requires that Cypress config option video is set to true for the option to have any effect Because mochawesome doesn't support context per spec file, each test will have the whole spec file video. More info can be found here
videoOnFailOnly	boolean	false	If Videos are recorded and added to the report, setting this to true will add the videos only to tests with failures. Do not that this will NOT cause video's to only record failed tests, just they not be added to passed tests in the mochawesome report
quiet	boolean	false	Silence console messages
saveAllAttempts	boolean	true	Save screenshots of all test attempts, set to false to save only the last attempt
debug	boolean	false	Creates log file with debug data

Add extra information to report

Add extra information to the report manually by using cy.addTestContext() as seen in the simple-typescript example test 2

Examples

1. Simple use of cypress-mochawesome-reporter
2. Using cypress-multi-reporters
3. With mochawesome-report-generator flags
4. Change default screenshots folder in cypress.json
5. Using cypress-mochawesome-reporter with typescript
6. Using cypress-mochawesome-reporter with cypress-parallel
7. Using cypress-mochawesome-reporter with cypress-cucumber-preprocessor

Run npm i in root directory then:

cd examples/<example-project>

npm i
npm test

Changelog

3.8.2 (2024-02-22)

Bug Fixes

• cucumberSupport fail if there is no examples in scenario (#183) (633da67)