Install the Cypress Mochawesome Reporter / About Cypress HTML Reports

Ram Pothuraju


 About Cypress HTML Reports

Cypress HTML Reports is a tool used for generating detailed and interactive HTML reports 

for test results in Cypress, a popular JavaScript end-to-end testing framework. These reports provide a comprehensive overview of test execution, including test status, test case details, screenshots, error messages, and other relevant information.

Here's a breakdown of the key features and components of Cypress HTML Reports:

Report Generation: 

Cypress HTML Reports generates HTML reports based on the test results obtained from running Cypress tests. It parses the test results and organizes them into a structured format, making it easier to analyze and interpret the data.

Test Summary: 

The report begins with a summary section that provides an overview of the test run. It includes details such as the total number of tests executed, the number of passed and failed tests, the duration of the test run, and any errors or exceptions encountered.

Test Case Details: 

The report presents individual test case details, including the test name, status (passed or failed), and a description of the test. It also displays any relevant error messages or exceptions that occurred during test execution.


Cypress HTML Reports allows you to capture screenshots during test execution. These screenshots are embedded within the report, providing visual evidence of the test's behavior at different stages. Screenshots can be particularly helpful in debugging and identifying issues.

Video Recording: 

In addition to screenshots, Cypress HTML Reports can also record videos of the test execution. These videos capture the entire test run, enabling you to review the test steps and identify any potential problems.

Interactive Interface: 

The HTML report generated by Cypress HTML Reports offers an interactive user interface. It provides a user-friendly way to navigate through the test results and drill down into individual test cases. You can expand and collapse test case details, view screenshots and videos, and access error messages with ease.

Filtering and Sorting: 

The report allows you to filter and sort test results based on various criteria. You can filter tests by their status (passed, failed, or pending), search for specific test names or keywords, and sort the test cases based on execution time or status.

History and Comparisons: 

Cypress HTML Reports provides a history feature that allows you to compare test results across multiple test runs. This feature is useful for tracking changes in test outcomes over time and identifying trends or patterns in test performance.

Integration and Customization:

 Cypress HTML Reports can be integrated into your existing Cypress test automation workflow. It provides command-line options and APIs for generating reports programmatically. Additionally, you can customize the look and feel of the reports by modifying the HTML and CSS templates provided by the tool.

Overall, Cypress HTML Reports enhances the reporting capabilities of Cypress by generating visually appealing and informative HTML reports. It simplifies the analysis of test results, aids in debugging, and facilitates communication among team members by providing a comprehensive view of test execution.

Install the Cypress Mochawesome Reporter

Step 1: Install the Cypress Mochawesome Reporter

This step installs the Cypress Mochawesome Reporter plugin as a development dependency in your project. The npm i --save-dev command is used to install the package and cypress-mochawesome-reporter is the name of the package you want to install.

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

Step 2: Configure Cypress

In your cypress.config.js file, you need to specify the reporter you want to use for your Cypress tests. By adding the line reporter: 'cypress-mochawesome-reporter', you configure Cypress to use the Mochawesome reporter.

Go to this file cypress.config.js

 reporter: 'cypress-mochawesome-reporter',

Just Paste This Lines above e2e: {     Line



Step 3: Add Plugin Configuration

The plugin configuration allows Cypress to load and use the Mochawesome reporter. By adding require('cypress-mochawesome-reporter/plugin')(on); inside the setup function of your cypress.config.js file, you enable the plugin and make it available for Cypress to utilize.

 Just Paste This Lines   below setup NodeEvents(on, config) {




Step 4: Add Import Statement

In the e2e.js file located in the support directory, you need to import the Mochawesome reporter. The line import 'cypress-mochawesome-reporter/register'; imports the necessary components and sets up the Mochawesome reporter to generate reports based on your test results.


 Now go to Support >> e2e.js file and paste below cand save it 

 import 'cypress-mochawesome-reporter/register';



By following these steps, you install and configure the Cypress Mochawesome Reporter plugin, which enhances your test reporting capabilities by generating Mochawesome reports for your Cypress tests.

Post a Comment


Post a Comment (0)