Cypress How to Integrate HTML report with Screenshots in an Easy Way on Cypress End to End Automation Framework

Cypress HTML Reporter

You might have written thousands of test cases but what makes you proud of it is, when you visualize the test results to stakeholders in an understandable way. There is a lot of articles over the internet to Integrate HTML reports into Cypress but when it comes to screenshot integration it's very difficult and time-consuming. The complexity is more.

In this article, I am presenting you Step by Step guide to integrate HTML results into your Cypress Automation Framework with Screenshots in an easy way.

This article explains Integrating HTML Results or reports with embedded Screenshot using cypress mochawesome reporter

This plugin is built on top of the mocha awesome report just to make life easy, so some of the options available in the mocha awesome reports are available here too.

Let’s start

Assumptions:

  1. You already have set up a cypress framework with a few test cases running

Step by Step Guide to Integrate HTML Results with Screenshot into your Cypress Automation Framework using cypress mochawesome reporter

In Visual Studio Code, Navigate to Terminal (Ensure present working directory is your Project root level directory) type below command.

Open, cypress.json file which is located in your project root directory, add the below entries.

Sample Image of Report configuration in cypress.json

From your Project Root Folder, Navigate to cypress folder > plugin folder> index.js file

Open the index.js file located inside the plugin folder. add the below code.

Example Screenshot

From the Project root folder > Navigate to cypress folder > support folder> index.js file

Add below entry

Example Screenshot

That’s all you are done with Set up!!!

Alternatively, you can also run using your package.json config, if you have configured it already.

The result file is located in the reportDir option value which we mentioned in Step 2. In our example, we have mentioned cypress/reports

So, From your Project Root Directory > Navigate to cypress folder > reports folder > index.html file

The index.html is your result file, just open in chrome or any browser

Index.html file looks like below.

Example Screenshot of HTML Results

The screenshot will be captured for all failed tests, so in order to view the screenshot Just click on Failed Test. The screenshot will appear.

Example Screenshot of Failed Test and embedded screenshot

Yes, You can disable screenshots, In the cypress.json file change the below code.

You can change the default screenshot folder using the below command

here, images is the folder name you can change it to any valid path like cypress/images, etc.

It looks like below

3. Can I use this plugin with cypress-multi-reporters to configure both Junit and HTML results?

Yes, you can use this plugin to configure multiple reporters.

If you want to configure multiple reports you should use the below code in cypress.json the folder

Below is an example code, you can configure with options.

4. How to enable inline CSS and styles in mocha awesome HTML reports?

To enable inline styles and a single HTML file (without any assets files) you need to turn on the option

Hope you enjoyed this…

Reference:
npm: https://www.npmjs.com/package/cypress-mochawesome-reporter
git: https://github.com/LironEr/cypress-mochawesome-reporter#readme

This article is written with the intention of helping the community