cy.within() for scoped queries in Cypress - Build an Automation Script

Verify form fields inside a specific section using cy.within()

Preconditions (2)

Step 1: Locate the section with id 'user-form'

Step 2: Within this section, find the input field with name 'firstName' and type 'John'

Step 3: Within this section, find the input field with name 'lastName' and type 'Doe'

Step 4: Within this section, click the submit button with type 'submit'

Step 5: Verify that a success message with id 'success-msg' is visible

✅ Expected Result: The form fields inside the 'user-form' section accept input and the form submits successfully showing the success message

Automation Requirements - Cypress

Assertions Needed:

Verify input fields accept the typed values

Verify the submit button is clicked

Verify the success message is visible after submission

Best Practices:

Use cy.within() to scope queries inside the form section

Use data-* attributes or semantic selectors for locating elements

Avoid global selectors to prevent flaky tests

Use Cypress commands chaining properly

Automated Solution

Cypress

describe('Form section scoped queries with cy.within()', () => {
  beforeEach(() => {
    cy.visit('/path-to-form-page');
  });

  it('fills and submits the form inside #user-form section', () => {
    cy.get('#user-form').within(() => {
      cy.get('input[name="firstName"]').type('John').should('have.value', 'John');
      cy.get('input[name="lastName"]').type('Doe').should('have.value', 'Doe');
      cy.get('button[type="submit"]').click();
    });

    cy.get('#success-msg').should('be.visible');
  });
});

The test starts by visiting the page containing the form.

Using cy.get('#user-form').within(), we scope all queries inside the form section. This means all cy.get() calls inside the within block only look inside the #user-form element.

We type 'John' and 'Doe' into the respective input fields and assert the values were entered correctly.

Then we click the submit button inside the same section.

Finally, outside the within block, we verify that the success message is visible, confirming the form submission worked.

This approach keeps selectors scoped and tests reliable.

Common Mistakes - 4 Pitfalls

Not using cy.within() and querying inputs globally

{'mistake': "Using overly generic selectors like 'input' without attributes", 'why_bad': 'Generic selectors may match multiple elements, leading to unpredictable test behavior.', 'correct_approach': 'Use specific selectors like \'input[name="firstName"]\' or data attributes for precise targeting.'}

{'mistake': 'Not asserting input values after typing', 'why_bad': 'Without assertions, test may pass even if typing failed silently.', 'correct_approach': "Add assertions like .should('have.value', 'expectedValue') after typing to confirm input."}

Clicking submit button outside the within block

Bonus Challenge

Now add data-driven testing with 3 different sets of first and last names

Show Hint

Practice

1. What is the main purpose of using cy.within() in Cypress tests?

easy

A. To run tests faster by skipping some steps

B. To select all elements on the page at once

C. To limit commands to a specific section of the page

D. To reset the browser state between tests

Solution

1. Step 1: Understand the role of cy.within()

   cy.within() scopes all commands inside it to a specific part of the page, so only elements inside that section are targeted.

2. Step 2: Compare with other options

   Options A, C, and D describe unrelated Cypress features. Only To limit commands to a specific section of the page correctly describes cy.within().

3. Final Answer:

   To limit commands to a specific section of the page -> Option C

4. Quick Check:

   Scope commands = Limit to section [OK]

Hint: Think of within as focusing on one page part [OK]

Common Mistakes:

• Confusing cy.within() with global selectors
• Thinking it speeds up tests by skipping steps
• Assuming it resets browser state

2. Which of the following is the correct syntax to use cy.within() to scope commands inside a <form> element with id loginForm?

easy

A. cy.get('#loginForm').within(() => { /* commands */ })

B. cy.within('#loginForm', () => { /* commands */ })

C. cy.within(() => cy.get('#loginForm'))

D. cy.get('#loginForm').scope(() => { /* commands */ })

Solution

1. Step 1: Recall correct cy.within() usage

   The correct pattern is to first get the element, then call within() with a callback containing scoped commands.

2. Step 2: Analyze each option

   cy.get('#loginForm').within(() => { /* commands */ }) matches the correct syntax. cy.within('#loginForm', () => { /* commands */ }) is invalid because cy.within() does not take a selector as first argument. cy.within(() => cy.get('#loginForm')) misuses within by nesting get inside callback. cy.get('#loginForm').scope(() => { /* commands */ }) uses a non-existent scope method.

3. Final Answer:

   cy.get('#loginForm').within(() => { /* commands */ }) -> Option A

4. Quick Check:

   Get element then within callback = C [OK]

Hint: Always call within() on a selected element [OK]

Common Mistakes:

• Passing selector directly to within()
• Using non-existent methods like scope()
• Nesting get inside within callback

3. Given the HTML below:

<div id="section1">
  <button class="btn">Click Me</button>
</div>
<div id="section2">
  <button class="btn">Don't Click Me</button>
</div>

What will the following Cypress code click?

cy.get('#section1').within(() => {
  cy.get('.btn').click()
})

medium

A. Throws an error because of multiple buttons

B. Clicks the button inside #section1 with text 'Click Me'

C. Clicks the button inside #section2 with text 'Don't Click Me'

D. Clicks both buttons with class 'btn'

Solution

1. Step 1: Understand within() scope

   The within() limits commands to elements inside #section1. So cy.get('.btn') finds only the button inside #section1.

2. Step 2: Identify clicked button

   The button inside #section1 has text 'Click Me', so that is clicked. Buttons outside #section1 are ignored.

3. Final Answer:

   Clicks the button inside #section1 with text 'Click Me' -> Option B

4. Quick Check:

   Scoped get clicks inside section1 only [OK]

Hint: Within limits get to one section only [OK]

Common Mistakes:

• Thinking all buttons on page are clicked
• Assuming error due to multiple buttons
• Confusing which section is scoped

4. You wrote this Cypress test:

cy.within(() => {
  cy.get('.item').click()
})

But it fails with error: Cannot read property 'within' of undefined. What is the likely cause?

medium

A. The callback function is missing parentheses

B. The selector .item is incorrect

C. You cannot use within() with cy.get()

D. You forgot to select an element before calling within()

Solution

1. Step 1: Analyze error message

   The error says within is called on undefined, meaning cy.within() is not a valid method.

2. Step 2: Check usage of within()

   within() is a method on a selected element, like cy.get(...).within(). Calling cy.within() directly is invalid.

3. Final Answer:

   You forgot to select an element before calling within() -> Option D

4. Quick Check:

   Call within() on element, not on cy [OK]

Hint: Always select element before within() [OK]

Common Mistakes:

• Calling within() directly on cy
• Blaming selector instead of method usage
• Ignoring error message details

5. You have two sections on a page, each with a button labeled 'Submit'. You want to click the 'Submit' button only inside the section with id form2. Which Cypress code correctly does this?

hard

A. cy.get('#form2').within(() => { cy.contains('Submit').click() })

B. cy.contains('Submit').click()

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

D. cy.within('#form2', () => { cy.get('button').click() })

Solution

1. Step 1: Identify the need for scoping

   Since there are multiple 'Submit' buttons, we must limit the search to the section with id form2 to avoid clicking the wrong button.

2. Step 2: Check each option's correctness

   cy.get('#form2').within(() => { cy.contains('Submit').click() }) correctly uses cy.get('#form2').within() to scope commands, then finds and clicks the 'Submit' button inside. cy.contains('Submit').click() clicks the first 'Submit' button anywhere, which is unsafe. cy.get('button').contains('Submit').click() tries to chain contains incorrectly and is ambiguous. cy.within('#form2', () => { cy.get('button').click() }) uses invalid syntax for within().

3. Final Answer:

   cy.get('#form2').within(() => { cy.contains('Submit').click() }) -> Option A

4. Quick Check:

   Scope then find button inside = A [OK]

Hint: Use get then within to scope clicks [OK]

Common Mistakes:

• Clicking buttons without scoping causes wrong clicks
• Using within with selector argument
• Misusing contains chaining