cypress-mochawesome-reporter

npmpackage.info

Gathering detailed insights and metrics for cypress-mochawesome-reporter

Other packages similar to cypress-mochawesome-reporter

@paschal_cheps/cypress-ms-teams-reporter

1.3.16

A Cypress reporter for Microsoft Teams with mochawesome support

cypress-slack-reporter

1.5.4

A slack reporter for mochawesome reports generated by Cypress or other test frameworks using Mocha, for runs generated on CircleCI

@pedro.pires/cypress-slack-reporter

1.3.1

A slack reporter for mochawesome reports generated by Cypress or other test frameworks using Mocha, for runs generated on CircleCI

slack-cypress-reporter-jenkins

1.3.0

A slack reporter for mochawesome reports generated by Cypress or other test frameworks using Mocha, for runs generated on Jenkins

Gathering detailed insights and metrics for cypress-mochawesome-reporter

reporter version	cypress version	reporter branch
`v4`	node >= 22 >= `6.7.0` >= `6.2.0` with `experimentalRunEvents: true`	`main`
`v3`	node >= 14 >= `6.7.0` >= `6.2.0` with `experimentalRunEvents: true`	`v2`
`v2`	>= `6.7.0` >= `6.2.0` with `experimentalRunEvents: true`	`v2`
`v1`	>= `4.0.0`	`v1`

reporter version

cypress version

reporter branch

v4

node >= 22
>= 6.7.0
>= 6.2.0 with experimentalRunEvents: true

main

v3

node >= 14
>= 6.7.0
>= 6.2.0 with experimentalRunEvents: true

v2

>= 6.7.0
>= 6.2.0 with experimentalRunEvents: true

v2

v1

>= 4.0.0

v1

Setup

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

install cypress-mochawesome-reporter

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

yarn add -D cypress-mochawesome-reporter

Change cypress reporter & setup hooks

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

1const { defineConfig } = require('cypress');
2
3module.exports = defineConfig({
4  reporter: 'cypress-mochawesome-reporter',
5  e2e: {
6    setupNodeEvents(on, config) {
7      require('cypress-mochawesome-reporter/plugin')(on);
8    },
9  },
10});

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

1const { defineConfig } = require('cypress');
2const { beforeRunHook, afterRunHook } = require('cypress-mochawesome-reporter/lib');
3
4module.exports = defineConfig({
5  reporter: 'cypress-mochawesome-reporter',
6  e2e: {
7    setupNodeEvents(on, config) {
8      on('before:run', async (details) => {
9        console.log('override before:run');
10        await beforeRunHook(details);
11      });
12
13      on('after:run', async () => {
14        console.log('override after:run');
15        await afterRunHook();
16      });
17    },
18  },
19});

Add to cypress/support/e2e.js

1import 'cypress-mochawesome-reporter/register';

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

1import '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.

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

1const { defineConfig } = require('cypress'); 2 3module.exports = defineConfig({ 4 reporter: 'cypress-mochawesome-reporter', 5 reporterOptions: { 6 charts: true, 7 reportPageTitle: 'custom-title', 8 embeddedScreenshots: true, 9 inlineAssets: true, 10 saveAllAttempts: false, 11 }, 12 e2e: { 13 setupNodeEvents(on, config) { 14 require('cypress-mochawesome-reporter/plugin')(on); 15 }, 16 }, 17});

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 note 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
`saveJson`	`boolean`	`false`	Keeps the json file used to create html report

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

saveJson

boolean

false

Keeps the json file used to create html report

Other packages similar to cypress-mochawesome-reporter

Other packages similar to cypress-mochawesome-reporter

Installations

Developer Guide

Yes

CommonJS

>=22

22.17.0

10.9.2

Pull Requests

0

102

18

84

Issues

7

105

98

Releases

Languages

Developer

LironEr

Download Statistics

GitHub Statistics

Sponsor this package

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

cypress-mochawesome-reporter

Cypress compatibility

Setup

Custom options

Add extra information to report

Examples

10

10

10

8

3

0

0

0

0

0

0

0

3.6

/10