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

Example report

Setup

1. install cypress-mochawesome-reporter

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

or

yarn add -D cypress-mochawesome-reporter

1. Change cypress reporter

config file

  "reporter": "cypress-mochawesome-reporter"

or command line

--reporter cypress-mochawesome-reporter

1. Add to cypress/support/index.js

import 'cypress-mochawesome-reporter/register';

1. add to your package.json scripts

"cypress:report": "generate-mochawesome-report"

1. run cypress and then npm run cypress:report

CLI (generate-mochawesome-report) flags

Flag	Type	Default	Description
--jsonDir	string	[cwd]/cypress/results/json	Cypress results json folder, should be the same as reportDir in cypress.json
--reportDir	string	[cwd]/cypress/screenshots	Cypress screenshots directory
-o, --output	string	[cwd]/cypress/reports/html	Path to save report

Run example project

cd example

npm i
npm run serve
npm run cypress:run
npm run cypress:report