cypress-testing-library

Introduction

cypress-testing-library helps you find and interact with web page elements like a user would. It makes tests easier to write and understand.

When you want to test a button by its label text instead of a complex selector.

When you need to check if a heading or paragraph with specific text is visible on the page.

When you want to simulate user actions like clicking or typing in a way that matches real user behavior.

When you want your tests to be more readable and less tied to the page's HTML structure.

When you want to avoid brittle tests that break when the page layout changes but the user experience stays the same.

Syntax

Cypress

import '@testing-library/cypress/add-commands';

// Example usage in a test
cy.getByRole('button', { name: 'Submit' }).click();

Use getByRole to find elements by their role and accessible name, which matches how users see the page.

Import @testing-library/cypress/add-commands to extend Cypress with user-friendly selectors.

Examples

Finds an element with the exact text 'Login' and clicks it.

Cypress

cy.getByText('Login').click();

Finds an input box labeled 'Username' and types 'myuser' into it.

Cypress

cy.getByRole('textbox', { name: 'Username' }).type('myuser');

Checks that the input labeled 'Email' is visible on the page.

Cypress

cy.getByLabelText('Email').should('be.visible');

Sample Program

This test visits a login page, fills in username and password using labels, clicks the login button by its role and name, then checks if a welcome message appears.

Cypress

import '@testing-library/cypress/add-commands';

describe('Login form test', () => {
  it('should allow user to login', () => {
    cy.visit('https://example.com/login');
    cy.getByLabelText('Username').type('testuser');
    cy.getByLabelText('Password').type('password123');
    cy.getByRole('button', { name: 'Log In' }).click();
    cy.getByText('Welcome, testuser!').should('be.visible');
  });
});

Important Notes

Always import @testing-library/cypress/add-commands once to enable the commands.

Using roles and labels makes tests more accessible and closer to how real users find elements.

These selectors are less likely to break if the page layout changes but the user interface stays the same.

Summary

cypress-testing-library helps find page elements by text, role, or label like a user would.

It makes tests easier to read and maintain.

Use it to write tests that focus on user experience, not page structure.

Practice

1. What is the main benefit of using cypress-testing-library in your tests?

easy

A. It helps find elements like a user would, improving test readability.

B. It automatically fixes broken tests.

C. It replaces Cypress commands with JavaScript alerts.

D. It only works with CSS selectors.

Solution

1. Step 1: Understand the purpose of cypress-testing-library

   It is designed to find page elements by text, role, or label, mimicking how users interact with the page.

2. Step 2: Compare options with this purpose

   Only It helps find elements like a user would, improving test readability. correctly states that it helps find elements like a user would and improves test readability.

3. Final Answer:

   It helps find elements like a user would, improving test readability. -> Option A

4. Quick Check:

   User-focused element finding = A [OK]

Hint: Remember: testing-library = user-like element finding [OK]

Common Mistakes:

• Thinking it fixes tests automatically
• Confusing it with Cypress core commands
• Assuming it only uses CSS selectors

2. Which of the following is the correct syntax to find a button with the text 'Submit' using cypress-testing-library?

easy

A. cy.findByRole('button', { name: 'Submit' })

B. cy.findByText('Submit')

C. cy.get('button').contains('Submit')

D. cy.querySelector('button:contains("Submit")')

Solution

1. Step 1: Recall cypress-testing-library syntax for roles

   The recommended way is to use findByRole with the role and accessible name.

2. Step 2: Check each option

   cy.findByRole('button', { name: 'Submit' }) uses findByRole('button', { name: 'Submit' }), which is correct. cy.findByText('Submit') relies on text content without specifying the button role, making it less precise. cy.get('button').contains('Submit') uses Cypress core commands, not testing-library. cy.querySelector('button:contains("Submit")') is invalid syntax.

3. Final Answer:

   cy.findByRole('button', { name: 'Submit' }) -> Option A

4. Quick Check:

   Use findByRole with name for buttons = B [OK]

Hint: Use findByRole with name for accessible buttons [OK]

Common Mistakes:

• Using Cypress core commands instead of testing-library
• Missing the role parameter
• Using invalid selectors like querySelector

3. Given the code snippet:

cy.findByLabelText('Email').type('[e-mail]')
cy.findByRole('button', { name: 'Send' }).click()

What will happen when this test runs?

medium

A. It clicks the button but does not type the email.

B. It throws an error because findByLabelText does not exist.

C. It types the email but fails to find the button.

D. It types the email and clicks the 'Send' button successfully.

Solution

1. Step 1: Understand the commands used

   findByLabelText finds an input by its label text, and type enters text. findByRole finds a button by role and name, then click clicks it.

2. Step 2: Analyze the expected behavior

   Both commands are valid and should work if elements exist. So the test will type the email and click the button.

3. Final Answer:

   It types the email and clicks the 'Send' button successfully. -> Option D

4. Quick Check:

   Valid findByLabelText and findByRole = A [OK]

Hint: findByLabelText types, findByRole clicks [OK]

Common Mistakes:

• Assuming findByLabelText is invalid
• Confusing Cypress core commands with testing-library
• Thinking click happens before typing

4. You wrote this test:

cy.findByRole('textbox', { name: 'Username' }).type('admin')
cy.findByRole('button', { name: 'Login' }).click()

But the test fails with "Unable to find element" error on the textbox. What is the likely cause?

medium

A. The test is missing a wait() before typing.

B. The textbox does not have an accessible name 'Username'.

C. The type command is not supported on textboxes.

D. The button role is incorrect.

Solution

1. Step 1: Understand the error message

   "Unable to find element" means the locator did not find the textbox with role 'textbox' and name 'Username'.

2. Step 2: Check possible causes

   If the textbox lacks an accessible name 'Username', the locator fails. The button role is likely correct, and type works on textboxes. wait() is usually unnecessary.

3. Final Answer:

   The textbox does not have an accessible name 'Username'. -> Option B

4. Quick Check:

   Accessible name missing causes find failure = D [OK]

Hint: Check accessible names if findByRole fails [OK]

Common Mistakes:

• Assuming role or command is wrong
• Adding unnecessary waits
• Ignoring accessibility attributes

5. You want to test a form with multiple inputs labeled 'Name' but only one is visible at a time. Which cypress-testing-library method helps you select the visible input labeled 'Name' reliably?

hard

A. cy.findByLabelText('Name', { exact: false })

B. cy.findByLabelText('Name', { selector: ':visible' })

C. cy.findAllByLabelText('Name').filter(':visible').first()

D. cy.findByText('Name').filter(':visible')

Solution

1. Step 1: Identify the problem

   Multiple inputs share the same label 'Name', but only one is visible at a time.

2. Step 2: Choose method to select visible input

   findAllByLabelText returns all matching elements. Using filter(':visible') narrows to visible ones, and first() picks the first visible input.

3. Final Answer:

   cy.findAllByLabelText('Name').filter(':visible').first() -> Option C

4. Quick Check:

   Use findAll + filter visible + first = C [OK]

Hint: Use findAllByLabelText + filter(':visible') + first() [OK]

Common Mistakes:

• Using findByLabelText with invalid selector option
• Using findByText instead of label text
• Ignoring visibility filtering