Using fixtures in tests in Cypress - Framework Patterns

Framework Mode - Using fixtures in tests

Folder Structure

  cypress/
  ├── e2e/                  # Test specs
  │   └── login.cy.js       # Example test using fixtures
  ├── fixtures/             # Test data files (JSON, CSV, etc.)
  │   └── user.json         # User data fixture
  ├── support/              # Custom commands and utilities
  │   ├── commands.js       # Custom Cypress commands
  │   └── e2e.js            # Support file loaded before tests
  cypress.config.js         # Cypress configuration file
  

Test Framework Layers

• Fixtures Layer: Contains static test data files in cypress/fixtures/. These files provide reusable data for tests.
• Test Specs Layer: Test files in cypress/e2e/ that load fixture data and perform test actions and assertions.
• Support Layer: Custom commands and utilities in cypress/support/ to keep tests clean and reusable.
• Configuration Layer: cypress.config.js manages environment settings, base URLs, and test options.

Configuration Patterns

Use cypress.config.js to define base URLs and environment variables.

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

  export default defineConfig({
    e2e: {
      baseUrl: 'https://example.com',
      env: {
        username: 'testuser',
        password: 'password123'
      },
      supportFile: 'cypress/support/e2e.js'
    }
  })
  

Fixtures are loaded in tests using cy.fixture('filename').then(data => {...}) or with beforeEach hooks for reusability.

Test Reporting and CI/CD Integration

• Use Cypress built-in reporters or integrate with mochawesome for detailed HTML reports.
• Configure CI pipelines (GitHub Actions, Jenkins, GitLab CI) to run npx cypress run headlessly.
• Store test artifacts like screenshots and videos for failed tests to help debugging.
• Use environment variables in CI to manage credentials securely.

Best Practices

• Keep fixture data simple and realistic: Use JSON files with clear, minimal data to avoid confusion.
• Load fixtures in beforeEach hooks: This ensures fresh data for each test and avoids shared state issues.
• Use descriptive fixture file names: Name files by purpose, e.g., user.json, products.json.
• Separate test data from test logic: This makes tests easier to read and maintain.
• Secure sensitive data: Avoid storing passwords or secrets in fixtures; use environment variables instead.

Self Check

Where would you add a new fixture file for storing product information used in multiple tests?

Key Result

Organize test data in fixtures folder and load them in tests for reusable, clean test automation.

Practice

1. What is the main purpose of using fixtures in Cypress tests?

easy

A. To load external static data files for use in tests

B. To create dynamic test data during test execution

C. To define custom commands for repeated actions

D. To configure browser settings before tests run

Solution

1. Step 1: Understand what fixtures are

   Fixtures are files that hold static data like JSON or text files used in tests.

2. Step 2: Identify their purpose in Cypress

   They help load this external data into tests to simulate real data inputs or responses.

3. Final Answer:

   To load external static data files for use in tests -> Option A

4. Quick Check:

   Fixtures = external static data [OK]

Hint: Fixtures hold static test data files for easy reuse [OK]

Common Mistakes:

• Thinking fixtures create dynamic data
• Confusing fixtures with custom commands
• Assuming fixtures configure browser settings

2. Which of the following is the correct syntax to load a fixture named user.json in a Cypress test?

easy

A. cy.readFile('user.json').then((data) => { ... })

B. cy.loadFixture('user.json').then((data) => { ... })

C. cy.fixture('user.json').then((data) => { ... })

D. cy.getFixture('user.json').then((data) => { ... })

Solution

1. Step 1: Recall the Cypress fixture command

   The correct command to load fixture data is cy.fixture().

2. Step 2: Match the syntax with the options

   cy.fixture('user.json').then((data) => { ... }) uses cy.fixture('user.json').then((data) => { ... }), which is correct syntax.

3. Final Answer:

   cy.fixture('user.json').then((data) => { ... }) -> Option C

4. Quick Check:

   Use cy.fixture() to load fixture files [OK]

Hint: Use cy.fixture() to load fixture files [OK]

Common Mistakes:

• Using non-existent commands like cy.loadFixture or cy.getFixture
• Confusing cy.readFile with cy.fixture
• Omitting the .then() to access data

3. Given the fixture file user.json contains { "name": "Alice", "age": 30 }, what will the following Cypress code print?

cy.fixture('user.json').then((user) => {
  cy.log(`Name: ${user.name}, Age: ${user.age}`)
})

medium

A. SyntaxError due to template string

B. Name: undefined, Age: undefined

C. Name: user.name, Age: user.age

D. Name: Alice, Age: 30

Solution

1. Step 1: Understand fixture data loading

   The fixture loads JSON data with keys "name" and "age" correctly.

2. Step 2: Analyze the template string usage

   The template string uses ${user.name} and ${user.age} to insert values.

3. Final Answer:

   Name: Alice, Age: 30 -> Option D

4. Quick Check:

   Fixture data accessed correctly = prints values [OK]

Hint: Template strings insert fixture data values directly [OK]

Common Mistakes:

• Expecting undefined because of async confusion
• Misreading template string syntax
• Assuming fixture data keys are different

4. What is wrong with this Cypress test code snippet that tries to use fixture data?

cy.fixture('data.json').then((data) => {
  cy.get('#name').type(data.name)
})
cy.get('#submit').click()

medium

A. The cy.get('#submit').click() runs before fixture loads

B. The fixture file name is incorrect

C. The type() command is invalid

D. Missing assertion after typing

Solution

1. Step 1: Check command chaining and timing

   The cy.get('#submit').click() runs immediately, not waiting for fixture to load.

2. Step 2: Understand Cypress command queue

   Commands outside the then() run before the fixture data is ready, causing timing issues.

3. Final Answer:

   The cy.get('#submit').click() runs before fixture loads -> Option A

4. Quick Check:

   Commands must chain to wait for fixture data [OK]

Hint: Chain commands inside .then() to ensure order [OK]

Common Mistakes:

• Placing commands outside fixture .then() causing race conditions
• Assuming fixture loads instantly
• Ignoring Cypress command queue behavior

5. You want to use a fixture named profile.json in multiple tests inside a describe block. Which is the best way to load it once and reuse the data in all tests?

hard

A. Load fixture inside each it() test separately

B. Use before() hook to load fixture and assign to this context

C. Use cy.readFile() in each test to read the fixture

D. Import the fixture JSON file directly using import statement

Solution

1. Step 1: Understand fixture reuse in Cypress

   Loading fixture once in before() hook improves efficiency and shares data.

2. Step 2: Assign fixture data to this context

   Using function() syntax allows this.data access in tests.

3. Final Answer:

   Use before() hook to load fixture and assign to this context -> Option B

4. Quick Check:

   before() loads fixture once for all tests [OK]

Hint: Load fixture once in before() and save to this [OK]

Common Mistakes:

• Loading fixture repeatedly in each test wasting time
• Using arrow functions preventing this context access
• Confusing cy.readFile with cy.fixture for fixtures