Why external test data improves maintainability in Cypress - Test Execution Impact

Test Overview

This test demonstrates how using external test data in Cypress improves maintainability by separating test logic from data. It verifies that the login form accepts valid credentials loaded from an external JSON file.

Test Code - Cypress

Cypress

import { describe, it, beforeEach } from 'cypress';

describe('Login form with external test data', () => {
  let credentials;

  beforeEach(() => {
    cy.fixture('loginData.json').then((data) => {
      credentials = data;
    });
    cy.visit('/login');
  });

  it('logs in successfully with valid credentials', () => {
    cy.get('input[name="username"]').type(credentials.username);
    cy.get('input[name="password"]').type(credentials.password);
    cy.get('button[type="submit"]').click();
    cy.url().should('include', '/dashboard');
    cy.get('h1').should('contain.text', 'Welcome');
  });
});

Execution Trace - 7 Steps

Step	Action	System State	Assertion	Result
1	Load external test data from fixture file 'loginData.json'	Test data object with username and password is loaded into variable	—	PASS
2	Open browser and navigate to '/login' page	Login page is displayed with username and password fields and submit button	—	PASS
3	Find username input field and type username from external data	Username field contains the typed username	—	PASS
4	Find password input field and type password from external data	Password field contains the typed password	—	PASS
5	Find and click the submit button	Form is submitted, page starts navigation	—	PASS
6	Verify URL includes '/dashboard' after login	Browser URL is '/dashboard'	URL contains '/dashboard'	PASS
7	Verify page header contains text 'Welcome'	Page shows header with text 'Welcome'	Header text includes 'Welcome'	PASS

Failure Scenario

Failing Condition: External test data file 'loginData.json' is missing or malformed, or credentials are invalid

Execution Trace Quiz - 3 Questions

Why is loading test data from an external file helpful in this test?

A It separates test data from test code, making updates easier

B It makes the test run faster

C It hides the test data from the tester

D It automatically fixes test failures

Key Result

Using external test data files keeps test scripts clean and easy to update, improving maintainability by allowing data changes without touching test code.

Practice

1. Why is using external test data considered better for maintainability in Cypress tests?

easy

A. It separates test logic from data, making updates easier without changing code.

B. It makes tests run faster by loading data from external files.

C. It reduces the number of test cases needed.

D. It automatically fixes broken tests when data changes.

Solution

1. Step 1: Understand separation of concerns

   External test data keeps test logic and data separate, so changing data doesn't require code edits.

2. Step 2: Recognize maintainability benefits

   This separation makes tests easier to update and maintain over time.

3. Final Answer:

   It separates test logic from data, making updates easier without changing code. -> Option A

4. Quick Check:

   Separation of logic and data = easier maintenance [OK]

Hint: Separate data from code to update tests easily [OK]

Common Mistakes:

• Thinking external data speeds up tests
• Believing external data reduces test count
• Assuming external data auto-fixes tests

2. Which of the following is the correct way to load external JSON test data in a Cypress test?

easy

A. cy.fixture('data.json').then((data) => { /* use data */ });

B. import data from './data.json';

C. const data = require('./data.json');

D. fetch('./data.json').then(response => response.json());

Solution

1. Step 1: Identify Cypress method for external data

   Cypress uses cy.fixture() to load external test data files.

2. Step 2: Confirm correct usage

   The cy.fixture('data.json').then((data) => { ... }) syntax loads and uses the data asynchronously.

3. Final Answer:

   cy.fixture('data.json').then((data) => { /* use data */ }); -> Option A

4. Quick Check:

   Use cy.fixture() to load external JSON data [OK]

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

Common Mistakes:

• Using require() which is not recommended in Cypress tests
• Using import which may not work for JSON in Cypress
• Using fetch which is not Cypress standard for fixtures

3. Given this Cypress test snippet using external data:

cy.fixture('user.json').then((user) => {
  cy.get('#username').type(user.name);
  cy.get('#password').type(user.password);
  cy.get('#login').click();
  cy.contains(user.welcomeMessage).should('be.visible');
});

What will happen if the user.json file changes the welcomeMessage text?

medium

A. The test will automatically update the app's welcome message.

B. The test will ignore the change and always pass.

C. The test will fail if the welcome message in the app does not match the new text.

D. The test will throw a syntax error.

Solution

1. Step 1: Understand test assertion with external data

   The test checks if the app shows the welcome message from the external data file.

2. Step 2: Effect of changing external data

   If the welcomeMessage changes in user.json, the test expects the new message in the app.

3. Final Answer:

   The test will fail if the welcome message in the app does not match the new text. -> Option C

4. Quick Check:

   Changed data means test expects new message [OK]

Hint: Test expects app text to match external data exactly [OK]

Common Mistakes:

• Thinking test ignores data changes
• Believing test auto-updates app content
• Confusing syntax errors with data mismatches

4. You have this Cypress test code:

cy.fixture('data.json').then((data) => {
  cy.get('#email').type(data.email);
  cy.get('#submit').click();
  cy.contains('Thank you, ' + data.name).should('be.visible');
});

But the test fails because data.name is undefined. What is the most likely cause?

medium

A. The cy.fixture() method cannot load JSON files.

B. The data.json file does not have a name property.

C. The cy.contains() syntax is invalid.

D. The cy.get() selector is incorrect.

Solution

1. Step 1: Check the undefined property cause

   If data.name is undefined, the JSON file likely lacks the name key.

2. Step 2: Verify other code parts

   The selectors and syntax are valid; cy.fixture() loads JSON correctly in Cypress.

3. Final Answer:

   The data.json file does not have a name property. -> Option B

4. Quick Check:

   Undefined property means missing key in JSON [OK]

Hint: Check JSON keys if data properties are undefined [OK]

Common Mistakes:

• Blaming selectors for undefined data
• Assuming cy.contains() syntax error
• Thinking cy.fixture() can't load JSON

5. You want to improve maintainability by moving test data out of your Cypress test code. Which approach best supports this goal while allowing easy updates for multiple test cases?

hard

A. Write test data directly in the Cypress commands without external files.

B. Hardcode test data inside each test to keep it close to the test steps.

C. Use inline variables inside tests and update them manually when needed.

D. Store all test data in a single external JSON file and load it with cy.fixture() in tests.

Solution

1. Step 1: Identify maintainability best practice

   Keeping test data in a single external JSON file separates data from code and centralizes updates.

2. Step 2: Compare with other options

   Hardcoding or inline variables mix data with code, making updates harder and error-prone.

3. Final Answer:

   Store all test data in a single external JSON file and load it with cy.fixture() in tests. -> Option D

4. Quick Check:

   Centralized external data = easier maintenance [OK]

Hint: Centralize data in one external file for easy updates [OK]

Common Mistakes:

• Hardcoding data inside tests
• Using inline variables for all data
• Ignoring external files for test data