Parallel execution in Cypress - Framework Patterns

Framework Mode - Parallel execution

Folder Structure for Cypress Parallel Execution Framework

cypress-project/
├── cypress/
│   ├── e2e/                  # Test specs organized by feature
│   │   ├── login.cy.js
│   │   ├── dashboard.cy.js
│   │   └── settings.cy.js
│   ├── fixtures/             # Test data files (JSON)
│   │   └── users.json
│   ├── support/              # Custom commands and reusable utilities
│   │   ├── commands.js
│   │   └── index.js
├── cypress.config.js         # Cypress configuration file
├── package.json              # Project dependencies and scripts
└── README.md

Test Framework Layers for Cypress Parallel Execution

• Test Specs (cypress/e2e): Contains individual test files that Cypress runs in parallel by default when configured.
• Support Layer (cypress/support): Holds reusable commands and setup code to keep tests clean and DRY (Don't Repeat Yourself).
• Fixtures (cypress/fixtures): Stores static test data like user credentials or sample inputs.
• Configuration (cypress.config.js): Defines environment settings, base URLs, and parallel execution options.
• Package Scripts (package.json): Contains scripts to run tests in parallel using Cypress CLI or CI tools.

Configuration Patterns for Parallel Execution in Cypress

• cypress.config.js: Use environment variables to set baseUrl, test environment, and browser type.
• Parallel Runs: Enable parallelization by running cypress run --parallel --record --key <record-key> in CI.
• CI Environment Variables: Store sensitive data like CYPRESS_RECORD_KEY securely in CI pipeline settings.
• Test Splitting: Cypress Dashboard automatically splits tests across machines when parallel flag is used with recording.
• Retries and Timeouts: Configure retries in cypress.config.js to handle flaky tests during parallel runs.

Test Reporting and CI/CD Integration

• Cypress Dashboard: Provides detailed test run reports, including parallel execution insights and video recordings.
• CI Integration: Use GitHub Actions, GitLab CI, Jenkins, or other CI tools to trigger parallel Cypress runs.
• Artifacts: Collect screenshots and videos from failed tests for debugging.
• Notifications: Configure email or Slack notifications on test failures or completion.
• Test Flakiness Monitoring: Use retries and dashboard analytics to identify unstable tests.

Best Practices for Cypress Parallel Execution Framework

1. Keep Tests Independent: Each test should not depend on others to avoid flaky results when run in parallel.
2. Use Fixtures and Custom Commands: Reuse data and commands to reduce duplication and improve maintainability.
3. Configure Environment Variables: Manage different environments (dev, staging, prod) cleanly using config files and env vars.
4. Leverage Cypress Dashboard: Use the dashboard service for parallel test orchestration and detailed reporting.
5. Optimize Test Splitting: Organize tests logically so Cypress can split them efficiently across parallel machines.

Self Check Question

Where in this folder structure would you add a new test file for a "User Profile" feature to run in parallel with other tests?

Key Result

Organize Cypress tests in the e2e folder and configure cypress.config.js to enable parallel execution with the Cypress Dashboard.