Cypress folder structure - Framework Patterns

Framework Mode - Cypress folder structure

Folder Structure

  cypress/
  ├── e2e/                  # End-to-end test files
  │   ├── login.cy.js       # Example test for login
  │   └── dashboard.cy.js   # Example test for dashboard
  ├── fixtures/             # Test data files (JSON, etc.)
  │   └── users.json        # Sample user data
  ├── support/              # Support files and custom commands
  │   ├── commands.js       # Custom Cypress commands
  │   ├── e2e.js            # Global setup for tests
  │   └── index.js          # Entry point for support
  ├── videos/               # Automatically saved test run videos
  └── screenshots/          # Automatically saved screenshots on failure

cypress.config.js           # Main Cypress configuration file
package.json                # Project dependencies and scripts
  

Test Framework Layers

• Test Layer (cypress/e2e): Contains the actual test scripts that simulate user actions and verify app behavior.
• Support Layer (cypress/support): Holds reusable code like custom commands and global hooks to keep tests clean and DRY.
• Fixtures Layer (cypress/fixtures): Stores static test data files used to feed tests with consistent inputs.
• Configuration Layer (cypress.config.js): Defines environment settings, base URLs, browser options, and other global settings.
• Output Layer (videos/screenshots): Automatically generated test run artifacts for debugging and reporting.

Configuration Patterns

Use cypress.config.js to manage settings like base URL, test retries, and viewport size.

Define environment variables inside cypress.config.js or via CLI to handle different environments (dev, staging, prod).

Example snippet to set base URL and environment variables:

  export default defineConfig({
    e2e: {
      baseUrl: 'https://example.com',
      env: {
        username: 'testuser',
        password: 'securePass123'
      },
      retries: 2,
      viewportWidth: 1280,
      viewportHeight: 720
    }
  })
  

Use Cypress.env() in tests to access these variables securely.

Test Reporting and CI/CD Integration

Integrate Cypress with CI/CD pipelines (GitHub Actions, Jenkins, GitLab CI) to run tests automatically on code changes.

Use built-in reporters or plugins like mochawesome for detailed HTML and JSON reports.

Configure video and screenshot capture on test failures to help diagnose issues quickly.

Example GitHub Actions step to run Cypress tests:

  - name: Run Cypress Tests
    uses: cypress-io/github-action@v5
    with:
      browser: chrome
      headless: true
  

Best Practices

• Keep tests independent: Each test should run alone without relying on others.
• Use custom commands: Put repeated actions in cypress/support/commands.js to avoid duplication.
• Organize tests by feature: Group related tests in folders inside cypress/e2e for clarity.
• Use fixtures for test data: Load data from cypress/fixtures to keep tests clean and maintainable.
• Configure retries and timeouts: Handle flaky tests gracefully with retries and proper waits.

Self Check

Question: Where in this folder structure would you add a new custom command to log in users?

Answer: Add it inside cypress/support/commands.js to reuse it across all tests.

Key Result

Organize Cypress tests with clear folders for tests, support code, fixtures, and config for maintainability and scalability.

Practice

1. Which folder in Cypress is primarily used to store your test files?

easy

A. plugins

B. fixtures

C. support

D. e2e

Solution

1. Step 1: Understand folder purposes

   The e2e folder is designed to hold end-to-end test files in Cypress.

2. Step 2: Differentiate from other folders

   fixtures holds test data, support has helper code, and plugins manages plugins, not tests.

3. Final Answer:

   e2e -> Option D

4. Quick Check:

   Tests go in e2e folder [OK]

Hint: Tests live in e2e folder by default [OK]

Common Mistakes:

• Confusing fixtures with test files
• Thinking support holds tests
• Assuming plugins stores tests

2. Which of the following is the correct path to place fixture files in a Cypress project?

easy

A. cypress/fixtures

B. cypress/support/fixtures

C. cypress/e2e/fixtures

D. fixtures/cypress

Solution

1. Step 1: Recall default Cypress folder structure

   Fixture files are stored directly inside the cypress/fixtures folder.

2. Step 2: Eliminate incorrect paths

   Options placing fixtures inside support or e2e are incorrect. Also, fixtures/cypress is not standard.

3. Final Answer:

   cypress/fixtures -> Option A

4. Quick Check:

   Fixtures folder is cypress/fixtures [OK]

Hint: Fixtures go directly under cypress/fixtures [OK]

Common Mistakes:

• Placing fixtures inside support
• Adding extra nested folders incorrectly
• Confusing fixtures with test files location

3. Given the following folder structure, where will Cypress look for support files by default?

cypress/
  e2e/
  fixtures/
  support/
    commands.js
    index.js

medium

A. cypress/support/commands.js

B. cypress/support/index.js

C. cypress/fixtures/index.js

D. cypress/e2e/index.js

Solution

1. Step 1: Identify default support file

   Cypress automatically loads cypress/support/index.js as the support file.

2. Step 2: Differentiate from other files

   commands.js is imported inside index.js, but Cypress looks for index.js by default.

3. Final Answer:

   cypress/support/index.js -> Option B

4. Quick Check:

   Support file = cypress/support/index.js [OK]

Hint: Support file is always support/index.js by default [OK]

Common Mistakes:

• Choosing commands.js as main support file
• Looking in e2e or fixtures folders for support
• Assuming support file is optional

4. You placed your test files inside cypress/support instead of cypress/e2e. What issue will you face?

medium

A. Tests will not run because Cypress does not look for tests in support

B. Tests will run normally without any issue

C. Tests will run but fixtures won't load

D. Support commands will override test files

Solution

1. Step 1: Understand folder roles

   The support folder is for helper code, not test files.

2. Step 2: Consequence of wrong placement

   Cypress only runs tests inside e2e folder by default, so tests in support won't run.

3. Final Answer:

   Tests will not run because Cypress does not look for tests in support -> Option A

4. Quick Check:

   Tests must be in e2e, not support [OK]

Hint: Tests outside e2e folder won't run [OK]

Common Mistakes:

• Assuming tests run anywhere inside cypress folder
• Confusing support folder as test location
• Thinking fixtures affect test execution location

5. You want to organize your test data for multiple environments in Cypress. Which folder and structure is best practice to keep environment-specific fixture files?

hard

A. Store environment data inside cypress/e2e alongside tests

B. Put environment files inside cypress/support as separate JS files

C. Place all environment files inside cypress/fixtures with subfolders like dev, prod

D. Create a new folder outside cypress for environment data

Solution

1. Step 1: Identify fixture folder purpose

   The cypress/fixtures folder is meant for test data files, including environment-specific data.

2. Step 2: Organize environment data properly

   Using subfolders like dev and prod inside fixtures keeps data organized and easy to load.

3. Final Answer:

   Place all environment files inside cypress/fixtures with subfolders like dev, prod -> Option C

4. Quick Check:

   Environment data belongs in fixtures with subfolders [OK]

Hint: Use subfolders in fixtures for environment data [OK]

Common Mistakes:

• Putting data in support folder
• Mixing data files with test files in e2e
• Creating folders outside Cypress structure