Mochawesome reporter setup in Cypress - Framework Patterns

Framework Mode - Mochawesome reporter setup

Folder Structure

cypress/
├── e2e/                  # Test specs
│   └── example.cy.js
├── fixtures/             # Test data files
│   └── example.json
├── support/              # Support commands and utilities
│   ├── commands.js
│   └── e2e.js
cypress.config.js         # Cypress configuration file
package.json             # Project dependencies and scripts
mochawesome-report/      # Generated Mochawesome reports (output folder)

Test Framework Layers

• Test Specs (cypress/e2e): Contains the actual test files written in Cypress syntax.
• Support Layer (cypress/support): Custom commands and reusable utilities to keep tests clean.
• Fixtures (cypress/fixtures): Static test data like JSON files used in tests.
• Configuration (cypress.config.js): Defines environment settings, reporter setup, and test options.
• Reporting Layer: Mochawesome reporter integrated via config and npm scripts to generate detailed HTML and JSON reports.

Configuration Patterns

To set up Mochawesome reporter in Cypress, configure cypress.config.js and package.json as follows:

// cypress.config.js
import { defineConfig } from 'cypress'

export default defineConfig({
  reporter: 'mochawesome',
  reporterOptions: {
    reportDir: 'mochawesome-report',
    overwrite: false,
    html: true,
    json: true
  },
  e2e: {
    setupNodeEvents(on, config) {
      // implement node event listeners here if needed
    },
    baseUrl: 'http://localhost:3000',
  },
})

// package.json (scripts section)
{
  "scripts": {
    "test": "cypress run",
    "test:report": "cypress run --reporter mochawesome"
  },
  "devDependencies": {
    "cypress": "^12.0.0",
    "mochawesome": "^7.0.0"
  }
}

Environment Handling: Use cypress.env.json or CLI flags to manage credentials or URLs per environment.

Test Reporting and CI/CD Integration

• Mochawesome Reporter: Generates detailed HTML and JSON reports after test runs.
• Report Output: Stored in mochawesome-report/ folder for easy access and sharing.
• CI/CD Integration: Add npm run test:report in CI pipelines (GitHub Actions, Jenkins, GitLab CI) to run tests and generate reports automatically.
• Artifacts: Configure CI to save the mochawesome-report/ folder as build artifacts for review.
• Notifications: Use CI tools to notify team members with report links on test failures or successes.

Best Practices

1. Keep Reports Clean: Configure Mochawesome to not overwrite reports but create new ones per run for history.
2. Use JSON + HTML Reports: JSON reports enable further processing or integration with other tools.
3. Separate Configurations: Use environment variables or separate config files for different test environments.
4. Integrate with CI: Automate report generation and artifact storage in your CI pipeline for team visibility.
5. Use Support Files: Keep test code clean by placing reusable commands and hooks in cypress/support.

Self Check

Where in this folder structure would you add a new custom command to log in a user for multiple tests?

Key Result

Organize Cypress tests with clear folder layers and configure Mochawesome reporter in cypress.config.js for detailed HTML/JSON reports.

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