Retry-ability of commands in Cypress - Test Execution Trace

Test Overview

This test demonstrates how Cypress automatically retries commands until the element appears or the assertion passes. It verifies that a button becomes visible after a delay and can be clicked successfully.

Test Code - Cypress

Cypress

describe('Retry-ability of commands', () => {
  it('should wait for the button to appear and click it', () => {
    cy.visit('https://example.cypress.io/commands/waiting')
    // The button appears after 3 seconds
    cy.get('#delayed-button', { timeout: 5000 })
      .should('be.visible')
      .click()
    cy.get('#delayed-button').should('have.class', 'clicked')
  })
})

Execution Trace - 6 Steps

Step	Action	System State	Assertion	Result
1	Test starts	Test runner initialized, browser ready	—	PASS
2	Browser opens and navigates to 'https://example.cypress.io/commands/waiting'	Page loads with delayed button not yet visible	—	PASS
3	Cypress tries to find element with selector '#delayed-button' with 5 seconds timeout	Button not visible initially, appears after 3 seconds	Waits and retries until '#delayed-button' is found and visible	PASS
4	Cypress asserts '#delayed-button' is visible	Button is visible on the page	Check that button is visible	PASS
5	Cypress clicks the '#delayed-button'	Button is clicked, changes state	—	PASS
6	Cypress asserts '#delayed-button' has class 'clicked'	Button has class 'clicked' after click	Verify button state changed after click	PASS

Failure Scenario

Failing Condition: The '#delayed-button' does not appear within 5 seconds timeout

Execution Trace Quiz - 3 Questions

What does Cypress do when it cannot find the '#delayed-button' immediately?

A It retries finding the element until timeout expires

B It fails the test immediately

C It skips the test step

D It reloads the page automatically

Key Result

Cypress automatically retries commands and assertions until they pass or timeout, making tests more reliable for elements that appear or change state asynchronously.

Practice

1. What does retry-ability in Cypress help with during test execution?

easy

A. Automatically waiting for elements or conditions before proceeding

B. Skipping tests that take too long to run

C. Running tests in parallel on multiple browsers

D. Generating test data automatically

Solution

1. Step 1: Understand retry-ability concept

   Retry-ability means Cypress waits and retries commands until the element or condition is met or timeout occurs.

2. Step 2: Identify what retry-ability helps with

   This automatic waiting avoids flaky tests caused by timing issues, ensuring tests proceed only when ready.

3. Final Answer:

   Automatically waiting for elements or conditions before proceeding -> Option A

4. Quick Check:

   Retry-ability = Automatic wait [OK]

Hint: Retry-ability means Cypress waits automatically for conditions [OK]

Common Mistakes:

• Confusing retry-ability with parallel test execution
• Thinking retry-ability skips tests
• Assuming retry-ability generates test data

2. Which of the following Cypress command patterns correctly uses retry-ability?

easy

A. cy.wait(5000).get('.btn').click()

B. cy.get('.btn').click()

C. cy.click('.btn')

D. cy.get('.btn').should('be.visible').click()

Solution

1. Step 1: Identify retry-ability usage

   Retry-ability works with commands like get combined with should assertions that retry until condition is true.

2. Step 2: Check each option

   cy.get('.btn').should('be.visible').click() uses get with should('be.visible') which retries until the button is visible before clicking.

3. Final Answer:

   cy.get('.btn').should('be.visible').click() -> Option D

4. Quick Check:

   Use get + should for retry-ability [OK]

Hint: Use get() with should() for retry-ability in Cypress [OK]

Common Mistakes:

• Using cy.click() directly without get()
• Relying on fixed wait times instead of should()
• Missing should() causes no retry

3. Consider this Cypress code snippet:

cy.get('#status').should('contain', 'Success')
cy.get('#submit').click()

What happens if the element with id status initially does not contain 'Success' but updates after 2 seconds?

medium

A. The test fails immediately because 'Success' is not found

B. The test skips the assertion and clicks submit immediately

C. Cypress retries the assertion until 'Success' appears or timeout

D. The test waits 2 seconds automatically before clicking submit

Solution

1. Step 1: Understand retry-ability with should()

   The should('contain', 'Success') assertion retries until the text appears or timeout.

2. Step 2: Analyze behavior when text updates after 2 seconds

   Cypress waits and retries the assertion, so it passes once 'Success' appears, then proceeds to click.

3. Final Answer:

   Cypress retries the assertion until 'Success' appears or timeout -> Option C

4. Quick Check:

   should() retries until condition met [OK]

Hint: should() retries assertions until success or timeout [OK]

Common Mistakes:

• Assuming test fails immediately without retry
• Thinking Cypress waits fixed time automatically
• Believing test skips assertion

4. You wrote this Cypress test:

cy.get('.loading').should('not.exist')
cy.get('.content').click()

But the test fails because .content is not clickable yet. What is the likely cause?

medium

A. The get('.content') command does not wait for element to be clickable

B. The should('not.exist') does not retry properly for .loading

C. You need to add wait() before clicking .content

D. The selector .content is incorrect

Solution

1. Step 1: Understand retry-ability of should('not.exist')

   The should('not.exist') retries until the loading element disappears, so this part works correctly.

2. Step 2: Analyze get('.content').click() behavior

   The get command retries until the element exists but does not wait for it to be clickable or visible before clicking.

3. Final Answer:

   The get('.content') command does not wait for element to be clickable -> Option A

4. Quick Check:

   get() waits for existence, not clickability [OK]

Hint: get() waits for element existence, not clickability [OK]

Common Mistakes:

• Assuming should('not.exist') fails to retry
• Adding unnecessary fixed waits
• Blaming wrong selector without checking

5. You want to test a button that appears only after a loading spinner disappears. Which Cypress command sequence best uses retry-ability to ensure the button is clicked only when ready?

hard

A. cy.get('.spinner').should('not.exist')
cy.get('button#submit').click()

B. cy.get('.spinner').should('not.exist')
cy.get('button#submit').should('be.visible').click()

C. cy.get('button#submit').should('be.visible').click()

D. cy.wait(3000)
cy.get('button#submit').click()

Solution

1. Step 1: Wait for spinner to disappear

   Using should('not.exist') on spinner retries until spinner is gone, ensuring loading finished.

2. Step 2: Wait for button to be visible before clicking

   Using should('be.visible') retries until button is visible and ready for click, avoiding flaky clicks.

3. Final Answer:

   cy.get('.spinner').should('not.exist') cy.get('button#submit').should('be.visible').click() -> Option B

4. Quick Check:

   Chain should() assertions for reliable waits [OK]

Hint: Chain should('not.exist') and should('be.visible') for reliable clicks [OK]

Common Mistakes:

• Clicking button immediately after spinner disappears without visibility check
• Using fixed wait instead of retry-ability
• Skipping spinner wait and causing flaky tests