Skip to content

Arghajit47/Cypress-Docker

Repository files navigation

https://glebbahmutov.com/blog/cypress-lighthouse/ : Cypress Lighthouse integration link

To Generate Cypress Report:

cypress-mochawesome-reporter

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

Example report

Mochawesome report with fail test screenshot

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

  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 (cypress.json by default)

  "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 cypress/plugins/index.js
module.exports = (on, config) => {
  require("cypress-mochawesome-reporter/plugin")(on);
};

or (cypress-mochawesome-reporter >= 2.2.0)

const {
  beforeRunHook,
  afterRunHook,
} = require("cypress-mochawesome-reporter/lib");

module.exports = (on) => {
  on("before:run", async (details) => {
    console.log("override before:run");
    await beforeRunHook(details);
  });

  on("after:run", async () => {
    console.log("override after:run");
    await afterRunHook();
  });
};
  1. 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

{
  "reporter": "cypress-mochawesome-reporter",
  "reporterOptions": {
    "reportDir": "cypress/report",
    "charts": true,
    "reportPageTitle": "custom-title"
  }
}

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
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

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

Run npm i in root directory then:

cd examples/<example-project>

npm i
npm test

About

Sample Cypress testing Docker containerized

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published