cypress-testing-library - Build an Automation Script

Verify user can search and see results on the search page

Preconditions (1)

Step 1: Locate the search input field by its accessible label 'Search'

Step 2: Type the text 'apple' into the search input field

Step 3: Locate and click the button with the accessible name 'Submit Search'

Step 4: Wait for the search results to appear

Step 5: Verify that at least one search result item is visible containing the text 'apple'

✅ Expected Result: The page displays search results related to 'apple' and at least one result item is visible with the text 'apple'

Automation Requirements - Cypress with @testing-library/cypress

Assertions Needed:

Verify the search input field is found by label 'Search'

Verify the search button is found by role and name 'Submit Search'

Verify at least one search result contains text 'apple' and is visible

Best Practices:

Use testing-library commands like cy.findByLabelText and cy.findByRole for accessibility-friendly selectors

Avoid using brittle selectors like CSS classes or IDs

Use explicit assertions to check visibility and content

Use Cypress commands chaining and built-in retries for stability

Automated Solution

Cypress

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

describe('Search Page Tests', () => {
  beforeEach(() => {
    cy.visit('/search');
  });

  it('allows user to search and see results', () => {
    // Find the search input by its label and type 'apple'
    cy.findByLabelText('Search').type('apple');

    // Find the submit button by role and name and click it
    cy.findByRole('button', { name: 'Submit Search' }).click();

    // Verify that at least one search result containing 'apple' is visible
    cy.findAllByText(/apple/i).should('be.visible').and('have.length.greaterThan', 0);
  });
});

The test imports the testing-library commands to use accessibility-friendly selectors.

Before each test, it visits the '/search' page as per precondition.

It finds the search input by its label 'Search' and types 'apple'.

Then it finds the submit button by its role 'button' and accessible name 'Submit Search' and clicks it.

Finally, it asserts that at least one visible element contains the text 'apple' (case-insensitive), ensuring search results appear.

This approach uses best practices by relying on accessible selectors and Cypress's automatic waiting for elements.

Common Mistakes - 3 Pitfalls

Using cy.get() with CSS selectors instead of testing-library queries

{'mistake': 'Not waiting for search results before asserting', 'why_bad': 'Assertions may run before results load, causing flaky test failures.', 'correct_approach': "Use testing-library queries that automatically retry until elements appear, like cy.findAllByText with should('be.visible')."}

Hardcoding text case in assertions

Bonus Challenge

Now add data-driven testing with 3 different search terms: 'apple', 'banana', 'cherry'

Show Hint

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