Assertion timeout customization in Cypress - Build an Automation Script

Customize assertion timeout for element visibility

Preconditions (1)

Step 1: Visit the web page URL 'https://example.com/delayed-button'

Step 2: Wait for the button with id 'delayed-btn' to become visible with a custom timeout of 10 seconds

Step 3: Assert that the button is visible

✅ Expected Result: The test waits up to 10 seconds for the button to appear and passes if the button becomes visible within that time

Automation Requirements - Cypress

Assertions Needed:

Verify the button with id 'delayed-btn' is visible within 10 seconds

Best Practices:

Use cy.get() with timeout option for waiting

Use should('be.visible') assertion

Avoid hardcoded waits like cy.wait()

Use clear and descriptive test titles

Automated Solution

Cypress

describe('Assertion timeout customization test', () => {
  it('Waits up to 10 seconds for delayed button to appear and asserts visibility', () => {
    cy.visit('https://example.com/delayed-button');
    cy.get('#delayed-btn', { timeout: 10000 })
      .should('be.visible');
  });
});

This test visits the specified URL where a button appears after some delay. The cy.get command includes a timeout option set to 10000 milliseconds (10 seconds), so Cypress waits up to 10 seconds for the element with id delayed-btn to appear in the DOM and be visible. The should('be.visible') assertion confirms the button is visible. This approach avoids using fixed waits and makes the test reliable and efficient.

Common Mistakes - 3 Pitfalls

Using cy.wait(10000) before checking visibility

Not setting a timeout and relying on default timeout

{'mistake': "Using incorrect selector syntax like cy.get('delayed-btn') without #", 'why_bad': "Selector won't find the element, causing test failure.", 'correct_approach': "Use correct CSS selector syntax, e.g., '#delayed-btn' for id."}

Bonus Challenge

Now add data-driven testing with 3 different button IDs that appear after different delays

Show Hint

Practice

1. What does customizing the timeout option in Cypress assertions help with?

easy

A. It allows tests to wait longer or shorter for elements or conditions before failing.

B. It changes the browser window size during tests.

C. It disables all assertions in the test.

D. It automatically retries failed tests multiple times.

Solution

1. Step 1: Understand the purpose of timeout in Cypress assertions

   The timeout option controls how long Cypress waits for an element or condition before marking the test as failed.

2. Step 2: Identify what customizing timeout achieves

   By customizing timeout, you can adjust waiting time to match your app's response speed, avoiding false failures or unnecessary delays.

3. Final Answer:

   It allows tests to wait longer or shorter for elements or conditions before failing. -> Option A

4. Quick Check:

   Timeout customization = wait time adjustment [OK]

Hint: Timeout controls wait duration for assertions [OK]

Common Mistakes:

• Confusing timeout with browser size settings
• Thinking timeout disables assertions
• Assuming timeout retries tests automatically

2. Which of the following is the correct way to set a 10-second timeout for a cy.get() command in Cypress?

easy

A. cy.get('.btn').timeout(10000)

B. cy.get('.btn', { timeout: 10000 })

C. cy.get('.btn').setTimeout(10)

D. cy.get('.btn', timeout=10)

Solution

1. Step 1: Recall the syntax for setting timeout in Cypress commands

   The timeout option is passed as an object in the second argument of cy.get(), like { timeout: 10000 } for 10 seconds.

2. Step 2: Check each option for correct syntax

   cy.get('.btn', { timeout: 10000 }) uses the correct object syntax. Chained .timeout(10000) and .setTimeout(10) use invalid methods. cy.get('.btn', timeout=10) uses incorrect assignment syntax.

3. Final Answer:

   cy.get('.btn', { timeout: 10000 }) -> Option B

4. Quick Check:

   Timeout option passed as object = correct syntax [OK]

Hint: Timeout is an option object in command parentheses [OK]

Common Mistakes:

• Using method chaining for timeout instead of option object
• Passing timeout as a separate argument without braces
• Using assignment syntax inside command arguments

3. Consider this Cypress code snippet:

cy.get('#loading', { timeout: 5000 }).should('not.exist');

What happens if the element with id loading still exists after 5 seconds?

medium

A. The test ignores the assertion and continues.

B. The test passes immediately without waiting.

C. The test retries forever until the element disappears.

D. The test fails because the element still exists after the 5-second timeout.

Solution

1. Step 1: Understand the timeout effect on cy.get() and assertion

   The timeout: 5000 means Cypress waits up to 5 seconds for the element to appear or disappear as per the assertion.

2. Step 2: Analyze the assertion should('not.exist') with timeout

   If after 5 seconds the element still exists, the assertion fails because the condition was not met within the timeout.

3. Final Answer:

   The test fails because the element still exists after the 5-second timeout. -> Option D

4. Quick Check:

   Timeout reached without condition met = test failure [OK]

Hint: Timeout limits wait; failure if condition unmet [OK]

Common Mistakes:

• Thinking test passes immediately without waiting
• Assuming infinite retries beyond timeout
• Believing assertion is skipped on timeout

4. You wrote this Cypress test but it fails too quickly:

cy.contains('Submit', { timeout: 2000 }).click();

Your app sometimes takes 5 seconds to show the button. What is the best fix?

medium

A. Increase the timeout value to at least 5000 milliseconds.

B. Remove the timeout option completely.

C. Change cy.contains to cy.get without timeout.

D. Add a wait(2000) before cy.contains.

Solution

1. Step 1: Identify the problem with current timeout

   The timeout is set to 2000 ms, but the button appears after 5 seconds, so the test fails too early.

2. Step 2: Choose the best fix to wait longer for the button

   Increasing the timeout to 5000 ms or more lets Cypress wait long enough for the button to appear before failing.

3. Final Answer:

   Increase the timeout value to at least 5000 milliseconds. -> Option A

4. Quick Check:

   Timeout must match app response time [OK]

Hint: Match timeout to app load speed [OK]

Common Mistakes:

• Removing timeout and causing default short wait
• Using wait() which is less reliable than timeout
• Changing command type without fixing wait time

5. You want to check that a success message appears within 3 seconds after clicking a button, but the message may sometimes take up to 7 seconds. Which is the best way to customize the assertion timeout in Cypress?

hard

A. Use cy.get('.success').should('be.visible').wait(7000) after clicking.

B. Use cy.get('.success').should('be.visible', { timeout: 3000 }) after clicking.

C. Use cy.get('.success', { timeout: 7000 }).should('be.visible') after clicking.

D. Use cy.get('.success', { timeout: 3000 }).should('be.visible') after clicking.

Solution

1. Step 1: Understand the timing requirement for the success message

   The message can take up to 7 seconds to appear, so the timeout must be at least 7000 ms to avoid false failures.

2. Step 2: Identify correct syntax to set timeout on cy.get()

   The timeout option must be passed inside the cy.get() command as an object, not inside should() or using wait().

3. Final Answer:

   Use cy.get('.success', { timeout: 7000 }).should('be.visible') -> Option C

4. Quick Check:

   Set timeout on cy.get to max wait needed [OK]

Hint: Set timeout on cy.get, not on should or wait [OK]

Common Mistakes:

• Setting timeout inside should() which is ignored
• Using fixed wait() which delays unnecessarily
• Setting timeout too short causing test failure