data-cy attributes for test stability in Cypress - Framework Patterns

Framework Mode - data-cy attributes for test stability

Folder Structure

cypress/
├── e2e/                  # Test specs using data-cy selectors
│   ├── login.cy.js
│   ├── dashboard.cy.js
│   └── userProfile.cy.js
├── fixtures/             # Test data files (JSON)
│   └── users.json
├── support/              # Custom commands and utilities
│   ├── commands.js       # Custom commands using data-cy
│   └── index.js          # Support file loaded before tests
cypress.config.js         # Cypress configuration file
package.json              # Project dependencies and scripts
    

Test Framework Layers

• Test Specs (cypress/e2e): Use data-cy attributes to locate elements reliably. Example: cy.get('[data-cy=submit-button]').
• Support Layer (cypress/support): Define custom commands that use data-cy selectors to keep tests clean and stable.
• Fixtures: Store test data separately to keep tests maintainable and reusable.
• Configuration: Manage environment variables and base URLs in cypress.config.js.

Configuration Patterns

Use cypress.config.js to manage environments and settings:

import { defineConfig } from 'cypress'

export default defineConfig({
  e2e: {
    baseUrl: 'https://staging.example.com',
    env: {
      username: 'testuser',
      password: 'password123'
    },
    setupNodeEvents(on, config) {
      // implement node event listeners here
    }
  }
})
    

Use data-cy attributes in HTML elements to avoid brittle selectors that depend on classes or IDs that may change.

Test Reporting and CI/CD Integration

• Use Cypress built-in reporter for clear pass/fail results.
• Integrate with CI tools like GitHub Actions or Jenkins to run tests on every push.
• Generate HTML or JSON reports using plugins like mochawesome for detailed insights.
• Use screenshots and video recordings on test failures to help debugging.

Best Practices for Using data-cy Attributes

1. Use data-cy only for testing: Keep these attributes separate from styling or functionality to avoid accidental changes.
2. Make data-cy values meaningful and stable: Use descriptive names like data-cy="login-button" instead of generic ones.
3. Do not rely on classes or IDs for tests: These often change with design updates, causing flaky tests.
4. Centralize selectors in custom commands: Define commands like cy.login() that use data-cy selectors internally.
5. Collaborate with developers: Ensure data-cy attributes are added consistently during development.

Self Check

Where in this folder structure would you add a new data-cy selector for a "submit" button used across multiple tests?

Key Result

Use data-cy attributes as stable, dedicated selectors in Cypress tests to improve test reliability and maintainability.

Practice

1. Why are data-cy attributes recommended for locating elements in Cypress tests?

easy

A. They improve page loading speed.

B. They automatically generate test data for forms.

C. They provide stable and unique selectors that don't change with UI updates.

D. They style elements with CSS.

Solution

1. Step 1: Understand the purpose of data-cy attributes

   data-cy attributes are used as custom selectors in tests to find elements reliably.

2. Step 2: Recognize why stability matters in tests

   Using data-cy keeps tests stable because these attributes don't change when the page design or CSS changes.

3. Final Answer:

   They provide stable and unique selectors that don't change with UI updates. -> Option C

4. Quick Check:

   Stable selectors = They provide stable and unique selectors that don't change with UI updates. [OK]

Hint: Remember: stable selectors = stable tests [OK]

Common Mistakes:

• Thinking data-cy affects page style
• Confusing data-cy with test data generation
• Assuming data-cy improves performance

2. Which of the following is the correct way to select an element with data-cy='submit-button' in Cypress?

easy

A. cy.get('[data-cy=submit-button]')

B. cy.get('submit-button')

C. cy.get('#submit-button')

D. cy.get('.submit-button')

Solution

1. Step 1: Recall the syntax for attribute selectors in Cypress

   To select an element by attribute, use cy.get('[attribute=value]').

2. Step 2: Match the attribute and value correctly

   The attribute is data-cy and value is submit-button, so the selector is [data-cy=submit-button].

3. Final Answer:

   cy.get('[data-cy=submit-button]') -> Option A

4. Quick Check:

   Attribute selector syntax = cy.get('[data-cy=submit-button]') [OK]

Hint: Use square brackets for attribute selectors [OK]

Common Mistakes:

• Omitting square brackets in selector
• Using ID or class selectors instead of attribute
• Not quoting attribute values when needed

3. Given this HTML snippet:

<button data-cy="login-btn">Login</button>

What will the following Cypress command do?

cy.get('[data-cy=login-btn]').click()

medium

A. Find the button with data-cy 'login-btn' and click it.

B. Throw an error because the selector is invalid.

C. Click the first button on the page regardless of attributes.

D. Find all buttons and click them all.

Solution

1. Step 1: Understand the selector usage

   The command cy.get('[data-cy=login-btn]') selects the element with attribute data-cy equal to login-btn.

2. Step 2: Understand the action performed

   The .click() method clicks on the selected element, which is the login button.

3. Final Answer:

   Find the button with data-cy 'login-btn' and click it. -> Option A

4. Quick Check:

   Selector + click = Find the button with data-cy 'login-btn' and click it. [OK]

Hint: Selector matches attribute, then perform action [OK]

Common Mistakes:

• Assuming selector is invalid syntax
• Thinking it clicks all buttons
• Confusing attribute selector with tag selector

4. You wrote this Cypress test:

cy.get('[data-cy=submit]').click()

But the test fails with "Cannot find element" error. What is the most likely cause?

medium

A. The click() method is not supported on buttons.

B. The element does not have a data-cy='submit' attribute.

C. The selector syntax is incorrect; it should be cy.get('data-cy=submit').

D. Cypress cannot click elements inside forms.

Solution

1. Step 1: Check the selector correctness

   The selector [data-cy=submit] is correct syntax for attribute selection.

2. Step 2: Identify why element is not found

   If the test fails to find the element, it likely means the element does not have the data-cy='submit' attribute in the HTML.

3. Final Answer:

   The element does not have a data-cy='submit' attribute. -> Option B

4. Quick Check:

   Missing attribute = The element does not have a data-cy='submit' attribute. [OK]

Hint: Check if attribute exists on element first [OK]

Common Mistakes:

• Blaming click() method for failure
• Using wrong selector syntax
• Assuming Cypress can't click form elements

5. You want to make your Cypress tests more stable by adding data-cy attributes. Which practice will best improve test stability?

hard

A. Use data-cy attributes only on buttons, ignoring other elements.

B. Add data-cy attributes with random values generated at runtime.

C. Use CSS classes as selectors instead of data-cy attributes for flexibility.

D. Add unique, descriptive data-cy attributes to key elements and use them in tests.

Solution

1. Step 1: Understand the goal of data-cy attributes

   They help tests find elements reliably and keep tests stable even if UI changes.

2. Step 2: Identify best practice for stability

   Using unique, descriptive data-cy attributes on important elements ensures selectors remain stable and easy to maintain.

3. Final Answer:

   Add unique, descriptive data-cy attributes to key elements and use them in tests. -> Option D

4. Quick Check:

   Unique descriptive attributes = Add unique, descriptive data-cy attributes to key elements and use them in tests. [OK]

Hint: Use clear, unique data-cy names for stable tests [OK]

Common Mistakes:

• Adding attributes only to buttons
• Relying on CSS classes that may change
• Using random values that break selectors