cy.fixture() for loading data in Cypress - Framework Patterns

Framework Mode - cy.fixture() for loading data

Folder Structure for Cypress Test Project

    cypress/
    ├── e2e/                  # Test specs
    │   ├── login.cy.js       # Example test using fixture data
    │   └── userProfile.cy.js
    ├── fixtures/             # Static test data files
    │   ├── user.json         # User data fixture
    │   └── settings.json
    ├── support/              # Custom commands and utilities
    │   ├── commands.js       # Custom Cypress commands
    │   └── e2e.js            # Global support file
    cypress.config.js          # Cypress configuration file
    package.json              # Project dependencies and scripts
    

Test Framework Layers

• Fixtures Layer: Contains JSON or other files with test data (e.g., user.json). Loaded using cy.fixture().
• Test Specs Layer: Test files in cypress/e2e/ that use cy.fixture() to load data and run tests.
• Support Layer: Custom commands and reusable utilities to keep tests clean.
• 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'
        },
        setupNodeEvents(on, config) {
          // implement node event listeners here
        }
      }
    })
    

Fixtures are stored as JSON files in cypress/fixtures/. Load them in tests with cy.fixture('user').then((user) => {...}).

Test Reporting and CI/CD Integration

• Use built-in Cypress test runner for interactive reports.
• Integrate with mochawesome reporter for detailed HTML reports.
• Configure CI pipelines (GitHub Actions, Jenkins) to run npx cypress run and collect reports.
• Store test artifacts like screenshots and videos for failed tests.

Best Practices for Using cy.fixture()

• Keep fixture files small and focused on specific test data sets.
• Use descriptive file names for fixtures to clarify their purpose.
• Load fixtures in beforeEach() hooks to reuse data across tests.
• Avoid hardcoding test data inside test specs; use fixtures instead.
• Combine fixtures with environment variables for flexible test configurations.

Self Check Question

Where in this folder structure would you add a new fixture file for storing login credentials?

Key Result

Use fixtures folder to store test data files and load them in tests with cy.fixture() for clean, reusable data-driven tests.

Practice

1. What is the primary purpose of cy.fixture() in Cypress testing?

easy

A. To start the Cypress test runner

B. To load external test data files for use in tests

C. To perform assertions on page content

D. To locate elements on the web page

Solution

1. Step 1: Understand the role of cy.fixture()

   cy.fixture() is used to load data from external files like JSON, which can be reused in tests.

2. Step 2: Compare with other Cypress commands

   Locating elements is done by cy.get(), assertions by should(), and starting tests is automatic or via CLI, not cy.fixture().

3. Final Answer:

   To load external test data files for use in tests -> Option B

4. Quick Check:

   Purpose of cy.fixture() = Load test data [OK]

Hint: Remember: fixture means fixed data file loading [OK]

Common Mistakes:

• Confusing cy.fixture() with element selectors
• Thinking it runs tests instead of loading data
• Using it for assertions instead of data loading

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

easy

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

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

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

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

Solution

1. Step 1: Recall the correct Cypress command for fixtures

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

2. Step 2: Check the syntax for loading and using data

   The syntax uses cy.fixture('filename').then((data) => { ... }) to access the loaded data.

3. Final Answer:

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

4. Quick Check:

   Correct fixture syntax = cy.fixture('user.json').then((data) => { ... }) [OK]

Hint: Use cy.fixture('file').then() to load data [OK]

Common Mistakes:

• Using non-existent commands like cy.loadFixture()
• Confusing cy.readFile() with cy.fixture()
• Omitting the .then() callback

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(user.name);
  cy.log(user.age);
});

medium

A. Alice and 30

B. user.name and user.age

C. undefined and undefined

D. Error: fixture not found

Solution

1. Step 1: Understand the fixture data structure

   The fixture file contains a JSON object with keys "name" and "age" having values "Alice" and 30 respectively.

2. Step 2: Analyze the Cypress code output

   The code logs user.name and user.age, so it will print "Alice" and 30 in the Cypress log.

3. Final Answer:

   Alice and 30 -> Option A

4. Quick Check:

   Fixture data accessed correctly = Alice, 30 [OK]

Hint: Fixture data keys map to object properties [OK]

Common Mistakes:

• Expecting literal strings instead of values
• Confusing variable names with strings
• Assuming fixture file is missing causing error

4. What is wrong with this Cypress code snippet that tries to load a fixture?

cy.fixture('config').then((data) => {
  cy.log(data.url);
});

Assuming the fixture file is named config.json and is located in the default fixtures folder.

medium

A. There is no error; the code is correct

B. The file extension .json must be included in the fixture name

C. The fixture file must be imported before using cy.fixture()

D. The cy.log command cannot access fixture data

Solution

1. Step 1: Check if file extension is required in cy.fixture()

   Cypress automatically adds .json if omitted, so 'config' works for config.json.

2. Step 2: Verify usage of cy.log() with fixture data

   cy.log() can log any string, including values from fixture data, so this is valid.

3. Final Answer:

   There is no error; the code is correct -> Option A

4. Quick Check:

   Omitting .json is allowed = Code correct [OK]

Hint: Omit .json in fixture name; Cypress adds it automatically [OK]

Common Mistakes:

• Adding .json causes no error but is optional
• Thinking cy.log can't print fixture data
• Trying to import fixture files manually

5. You want to use fixture data to fill a login form in Cypress. The fixture user.json contains { "username": "testuser", "password": "pass123" }. Which code snippet correctly uses cy.fixture() to fill the form fields with IDs #user and #pass?

hard

A. cy.fixture('user').then((data) => { cy.get('#user').type(data.user); cy.get('#pass').type(data.pass); });

B. cy.get('#user').type(user.username); cy.get('#pass').type(user.password); cy.fixture('user');

C. cy.fixture('user').then((user) => { cy.get('#user').type(user.username); cy.get('#pass').type(user.password); });

D. cy.loadFixture('user').then((user) => { cy.get('#user').type(user.username); cy.get('#pass').type(user.password); });

Solution

1. Step 1: Identify correct fixture loading and data usage

   cy.fixture('user').then((user) => { cy.get('#user').type(user.username); cy.get('#pass').type(user.password); }); correctly uses cy.fixture('user').then((user) => { ... }) and accesses user.username and user.password.

2. Step 2: Check form field selectors and typing commands

   It uses cy.get('#user').type() and cy.get('#pass').type() correctly to fill inputs.

3. Final Answer:

   cy.fixture('user').then((user) => { cy.get('#user').type(user.username); cy.get('#pass').type(user.password); }); -> Option C

4. Quick Check:

   Load fixture then fill fields = cy.fixture('user').then((user) => { cy.get('#user').type(user.username); cy.get('#pass').type(user.password); }); [OK]

Hint: Load fixture first, then use data inside .then() callback [OK]

Common Mistakes:

• Using wrong property names like data.user instead of data.username
• Calling cy.fixture() after typing commands
• Using non-existent commands like cy.loadFixture()