Mochawesome reporter setup in Cypress - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is Mochawesome reporter in Cypress testing?

Mochawesome is a custom reporter for Cypress that generates detailed and visually appealing HTML and JSON test reports, making it easier to understand test results.

beginner

How do you install Mochawesome reporter for Cypress?

You install Mochawesome by running npm install --save-dev mochawesome mochawesome-merge mochawesome-report-generator in your project folder.

beginner

Which configuration file do you update to enable Mochawesome reporter in Cypress?

You update the cypress.config.js file to set Mochawesome as the reporter and configure reporter options.

intermediate

What is the purpose of mochawesome-merge in the Mochawesome setup?

mochawesome-merge combines multiple JSON report files generated by Cypress into a single JSON file for easier report generation.

intermediate

How do you generate the final HTML report after running Cypress tests with Mochawesome?

After tests run, use mochawesome-merge to merge JSON files, then run marge from mochawesome-report-generator to create the HTML report.

Which command installs Mochawesome reporter and its related packages?

A npm install --save-dev mochawesome mochawesome-merge mochawesome-report-generator

B npm install --save mochawesome

C npm install --global mochawesome

D npm install --save-dev cypress-mochawesome

The correct command installs Mochawesome and the tools needed to merge and generate reports.

Where do you specify Mochawesome as the reporter in Cypress?

A In the Cypress GUI settings

B In package.json scripts

C In the test files using comments

D In cypress.config.js under reporter and reporterOptions

You configure Mochawesome in cypress.config.js to tell Cypress to use it as the reporter.

What does mochawesome-merge do?

A Generates screenshots

B Runs Cypress tests

C Merges multiple JSON reports into one

D Starts the Cypress test runner

Mochawesome-merge combines JSON report files into a single file for easier report generation.

Which file format does Mochawesome generate for the final report?

A HTML

B TXT

C CSV

D XML

Mochawesome generates a detailed HTML report that is easy to read in a browser.

Why is using Mochawesome reporter helpful?

A It speeds up test execution

B It creates clear, visual test reports

C It automatically fixes test failures

D It replaces Cypress test runner

Mochawesome helps by making test results easier to understand with visual reports.

Explain the steps to set up Mochawesome reporter in a Cypress project.

Think about installation, configuration, running tests, merging, and report generation.

Describe the benefits of using Mochawesome reporter for Cypress test results.

Focus on how Mochawesome improves understanding and sharing of test results.

Practice

1. What is the main purpose of using the mochawesome reporter in Cypress testing?

easy

A. To create test data for Cypress tests

B. To speed up test execution time

C. To automatically fix failing tests

D. To generate clear and detailed HTML and JSON test reports

Solution

1. Step 1: Understand the role of reporters in Cypress

   Reporters provide a way to view test results in a readable format after tests run.

2. Step 2: Identify what mochawesome specifically does

   Mochawesome generates detailed HTML and JSON reports that are easy to read and share.

3. Final Answer:

   To generate clear and detailed HTML and JSON test reports -> Option D

4. Quick Check:

   Reporter purpose = Generate reports [OK]

Hint: Mochawesome = report generator, not test runner or fixer [OK]

Common Mistakes:

• Thinking mochawesome speeds up tests
• Confusing mochawesome with test data tools
• Assuming mochawesome fixes test failures

2. Which of the following is the correct way to enable mochawesome reporter in cypress.config.js?

easy

A. reporter: 'mochawesome', reporterOptions: { reportDir: 'cypress/reports' }

B. reporter: 'mocha', reporterOptions: { output: 'cypress/reports' }

C. reporter: 'mochawesome', outputDir: 'cypress/reports'

D. reporter: 'mochawesome', reportPath: 'cypress/reports'

Solution

1. Step 1: Recall the correct reporter property name

   The reporter is set using the key reporter with value 'mochawesome'.

2. Step 2: Use the correct options key for mochawesome

   The options for mochawesome are passed under reporterOptions, including reportDir for output folder.

3. Final Answer:

   reporter: 'mochawesome', reporterOptions: { reportDir: 'cypress/reports' } -> Option A

4. Quick Check:

   Correct keys = reporter + reporterOptions [OK]

Hint: Use reporterOptions, not outputDir or reportPath [OK]

Common Mistakes:

• Using 'mocha' instead of 'mochawesome'
• Wrong option keys like outputDir or reportPath
• Missing reporterOptions wrapper

3. Given this snippet in cypress.config.js:

reporter: 'mochawesome',
reporterOptions: {
  reportDir: 'cypress/reports',
  overwrite: false,
  html: false,
  json: true
}

What will be the result after running tests?

medium

A. HTML and JSON reports will be generated and overwritten each run

B. Only HTML reports will be generated and overwrite previous reports

C. Only JSON reports will be generated without overwriting previous ones

D. No reports will be generated because html is false

Solution

1. Step 1: Analyze reporterOptions settings

   html is set to false, so no HTML report is generated. json is true, so JSON report is generated.

2. Step 2: Understand overwrite behavior

   overwrite is false, so new reports will not overwrite existing ones, allowing multiple JSON reports to accumulate.

3. Final Answer:

   Only JSON reports will be generated without overwriting previous ones -> Option C

4. Quick Check:

   html=false + json=true + overwrite=false = JSON only, no overwrite [OK]

Hint: html false means no HTML report; overwrite false keeps old reports [OK]

Common Mistakes:

• Assuming HTML report is generated when html=false
• Thinking overwrite=false deletes old reports
• Confusing json and html options

4. You configured mochawesome in cypress.config.js but after running tests, no report files appear. Which fix is most likely correct?

medium

A. Remove reporterOptions from config to fix issue

B. Install mochawesome and mochawesome-merge packages and update config

C. Change reporter to 'mocha' to generate reports

D. Run tests with --no-report flag to enable reports

Solution

1. Step 1: Check if mochawesome packages are installed

   Mochawesome requires installing both mochawesome and mochawesome-merge packages to generate and merge reports.

2. Step 2: Verify config and installation

   Without these packages installed, no reports will be created even if config is correct.

3. Final Answer:

   Install mochawesome and mochawesome-merge packages and update config -> Option B

4. Quick Check:

   Missing packages = no reports [OK]

Hint: Always install mochawesome and merge packages before running tests [OK]

Common Mistakes:

• Removing reporterOptions thinking it fixes issue
• Changing reporter to 'mocha' which doesn't generate mochawesome reports
• Using wrong CLI flags like --no-report

5. You want to generate a single combined HTML report after running multiple Cypress test runs with mochawesome. Which approach is correct?

hard

A. Use mochawesome-merge to combine JSON reports, then generate HTML from merged JSON

B. Run tests with overwrite: true and html: true to auto-merge reports

C. Set reporter to 'mochawesome-merge' in cypress.config.js to merge reports automatically

D. Run tests multiple times with html: false and manually copy JSON files into one

Solution

1. Step 1: Understand mochawesome report generation

   Mochawesome generates separate JSON reports per test run; it does not merge automatically.

2. Step 2: Use mochawesome-merge tool

   mochawesome-merge combines multiple JSON reports into one, which can then be converted to a single HTML report.

3. Step 3: Confirm other options are incorrect

   overwrite: true overwrites reports, no auto-merge; 'mochawesome-merge' is not a reporter; manual copying is error-prone.

4. Final Answer:

   Use mochawesome-merge to combine JSON reports, then generate HTML from merged JSON -> Option A

5. Quick Check:

   Merge JSON then generate HTML = combined report [OK]

Hint: Merge JSON reports first, then create one HTML report [OK]

Common Mistakes:

• Expecting mochawesome to auto-merge reports
• Setting reporter to 'mochawesome-merge' which is not valid
• Manually copying JSON files without merging