cy.parent() and cy.children() in Cypress - Framework Patterns

Framework Mode - cy.parent() and cy.children()

Folder Structure of a Cypress Test Project

    cypress/
    ├── e2e/                  # Test specs
    │   ├── login.cy.js       # Example test file
    │   └── navigation.cy.js  # Another test file
    ├── fixtures/             # Test data files (JSON)
    │   └── users.json
    ├── support/              # Custom commands and utilities
    │   ├── commands.js       # Custom Cypress commands
    │   └── e2e.js            # Support file loaded before tests
    └── pages/                # Page Object files
        └── navigationPage.js
    cypress.config.js          # Cypress configuration file
    

Test Framework Layers

• Test Specs (e2e/): Contains test files that use cy.parent() and cy.children() to navigate DOM elements during tests.
• Page Objects (pages/): Encapsulate selectors and actions. Use cy.children() and cy.parent() to find elements relative to others.
• Support (support/): Define custom commands or utilities that may wrap cy.parent() and cy.children() for reuse.
• Fixtures (fixtures/): Store test data, unrelated to DOM traversal but used in tests.
• Configuration (cypress.config.js): Setup environment, base URL, and browser options.

Configuration Patterns

Use cypress.config.js to manage environments and browser settings.

    // cypress.config.js
    import { defineConfig } from 'cypress'

    export default defineConfig({
      e2e: {
        baseUrl: 'https://example.com',
        env: {
          username: 'testuser',
          password: 'password123'
        },
        setupNodeEvents(on, config) {
          // implement node event listeners here
        },
      },
    })
    

Access credentials in tests with Cypress.env('username').

Test Reporting and CI/CD Integration

• Use built-in Cypress reporter or integrate with mochawesome for detailed HTML reports.
• Configure cypress.config.js to generate reports after test runs.
• Integrate Cypress tests in CI/CD pipelines (GitHub Actions, Jenkins) to run tests on code changes.
• Use screenshots and videos on test failures to help debug DOM traversal issues with cy.parent() and cy.children().

Best Practices for Using cy.parent() and cy.children()

1. Use clear selectors: Prefer data attributes like data-cy to select elements before using cy.parent() or cy.children().
2. Limit chaining depth: Avoid long chains of cy.parent() calls to keep tests readable and stable.
3. Use cy.children() to scope: Narrow down to direct children to avoid selecting unintended elements.
4. Combine with assertions: After navigating DOM, assert element visibility or content to confirm correct selection.
5. Wrap DOM traversal in page objects: Encapsulate cy.parent() and cy.children() usage in page object methods for reuse and clarity.

Self Check

Where in this folder structure would you add a new method that uses cy.parent() to get the parent container of a button?

Key Result

Organize Cypress tests with clear folder layers and use cy.parent() and cy.children() in page objects for clean DOM navigation.

Practice

1. What does the Cypress command cy.parent() do?

easy

A. Finds all child elements of the current element

B. Finds the immediate parent element of the current element

C. Finds all sibling elements of the current element

D. Finds the first child element of the current element

Solution

1. Step 1: Understand the purpose of cy.parent()

   This command is used to get the immediate parent of the currently selected element in the DOM tree.

2. Step 2: Compare with other options

   cy.children() finds children, siblings are not targeted by cy.parent(), and it does not find the first child specifically.

3. Final Answer:

   Finds the immediate parent element of the current element -> Option B

4. Quick Check:

   cy.parent() = immediate parent [OK]

Hint: Parent means one level up in the DOM tree [OK]

Common Mistakes:

• Confusing parent with children
• Thinking it finds all ancestors
• Assuming it finds siblings

2. Which of the following is the correct syntax to get all direct children of an element with class container in Cypress?

easy

A. cy.get('.container').children()

B. cy.get('.container').parent()

C. cy.get('.container').child()

D. cy.get('.container').parents()

Solution

1. Step 1: Identify the correct command for children

   The command to get direct children is children(), so cy.get('.container').children() is correct.

2. Step 2: Check other options for correctness

   parent() gets the parent, child() is not a valid Cypress command, and parents() gets all ancestors, not children.

3. Final Answer:

   cy.get('.container').children() -> Option A

4. Quick Check:

   children() gets direct children [OK]

Hint: Use children() to get direct children elements [OK]

Common Mistakes:

• Using parent() instead of children()
• Using incorrect method child()
• Confusing parents() with children()

3. Consider the following HTML structure:

<div class='grandparent'>
  <div class='parent'>
    <span class='child'>Hello</span>
    <span class='child'>World</span>
  </div>
</div>

What will cy.get('.child').parent().should('have.class', 'parent') assert?

medium

A. That the grandparent has class 'parent'

B. That the children of .parent have class 'child'

C. That the parent of each .child element has class 'parent'

D. That the .child elements have class 'parent'

Solution

1. Step 1: Understand the command chain

   cy.get('.child') selects both span elements. parent() gets their immediate parent, which is the div with class 'parent'.

2. Step 2: Analyze the assertion

   The assertion checks if the parent element has class 'parent', which is true for both .child elements.

3. Final Answer:

   That the parent of each .child element has class 'parent' -> Option C

4. Quick Check:

   parent() gets immediate parent with class 'parent' [OK]

Hint: parent() gets immediate parent element of selected children [OK]

Common Mistakes:

• Thinking parent() gets grandparent
• Confusing children with parent
• Assuming assertion checks children classes

4. You wrote this Cypress test:

cy.get('.list').children('.item').parent('.container')

But it fails with an error. What is the likely cause?

medium

A. The parent() command does not accept a selector argument

B. The children() command cannot filter by class

C. The parent() command returns all ancestors, not immediate parent

D. The children() command returns siblings, not children

Solution

1. Step 1: Check parent() usage

   The parent() command in Cypress does not accept any selector argument; it always returns the immediate parent element.

2. Step 2: Verify other commands

   children() can filter by selector, so that part is valid. parent() does not return all ancestors, only immediate parent. children() returns direct children, not siblings.

3. Final Answer:

   The parent() command does not accept a selector argument -> Option A

4. Quick Check:

   parent() takes no selector argument [OK]

Hint: parent() never takes a selector; children() can filter [OK]

Common Mistakes:

• Passing selector to parent()
• Confusing children() filtering
• Thinking parent() returns all ancestors

5. Given this HTML:

<ul class='menu'>
  <li class='item'>Home</li>
  <li class='item'>About</li>
  <li class='item'>Contact</li>
</ul>
<div class='footer'>Footer content</div>

Which Cypress command chain correctly selects the <ul> element starting from the <li> elements with class item?

hard

A. cy.get('.item').children('ul')

B. cy.get('.item').parent().parent()

C. cy.get('.item').children()

D. cy.get('.item').parent()

Solution

1. Step 1: Identify the parent of .item elements

   Each <li class='item'> is a direct child of the <ul class='menu'> element.

2. Step 2: Use parent() to get immediate parent

   cy.get('.item').parent() correctly gets the immediate parent <ul class='menu'> element.

3. Step 3: Check other options

   children('ul') is wrong because <li> elements do not have <ul> children. parent().parent() goes too far up. children() gets children, not parent.

4. Final Answer:

   cy.get('.item').parent() -> Option D

5. Quick Check:

   parent() gets immediate parent [OK]

Hint: Use parent() to get immediate parent element [OK]

Common Mistakes:

• Using children() to get parent
• Going two levels up unnecessarily
• Assuming children() returns parent