Parent commands in Cypress - Framework Patterns

Framework Mode - Parent commands

Folder Structure

cypress/
├── e2e/                  # Test specs
│   ├── login.cy.js       # Example test file
│   └── dashboard.cy.js
├── support/              # Custom commands and support files
│   ├── commands.js       # Custom Cypress commands including parent commands
│   └── e2e.js            # Support file loaded before tests
├── fixtures/             # Test data files (JSON, etc.)
│   └── user.json
cypress.config.js         # Cypress configuration file
package.json              # Project dependencies and scripts

Test Framework Layers

• Test Specs (cypress/e2e): Contains test files that use parent commands to chain actions and assertions.
• Support Layer (cypress/support): Holds commands.js where parent commands are defined using Cypress.Commands.add(). This layer extends Cypress with reusable parent commands that return Cypress chains.
• Fixtures: Static test data used by tests.
• Configuration: Central place for environment and browser settings.

Configuration Patterns

• cypress.config.js: Define baseUrl, defaultCommandTimeout, and environment variables here.
• Environment Variables: Use env property in config or CYPRESS_ prefixed system variables for sensitive data like credentials.
• Browser Selection: Specify browser via CLI or config for cross-browser testing.
• Test Data: Use fixtures folder to store JSON files and load them in tests or commands.

Test Reporting and CI/CD Integration

• Use built-in Cypress Dashboard or third-party reporters (like Mochawesome) for detailed test reports.
• Configure cypress.config.js to generate reports after test runs.
• Integrate Cypress tests into CI/CD pipelines (GitHub Actions, Jenkins, GitLab CI) to run tests on code changes.
• Use --record flag with Cypress Dashboard for cloud test results and analytics.

Best Practices for Parent Commands in Cypress

1. Return Cypress Chain: Always return the Cypress chainable object from parent commands to allow chaining.
2. Use Cypress.Commands.add(): Define parent commands here to keep tests clean and reusable.
3. Keep Commands Focused: Each parent command should perform a clear, single action or logical group of actions.
4. Use Aliases and Fixtures: Combine parent commands with fixtures and aliases for data-driven and maintainable tests.
5. Document Commands: Comment commands clearly so team members understand their purpose and usage.

Self Check

Where in this folder structure would you add a new parent command to log in a user?

Key Result

Use Cypress custom parent commands in the support/commands.js file to create reusable, chainable test actions.

Practice

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

easy

A. It finds the direct parent element of the current element.

B. It finds all child elements inside the current element.

C. It clicks on the current element.

D. It waits for the element to appear on the page.

Solution

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

   The parent() command in Cypress is used to get the immediate parent of the selected element in the DOM tree.

2. Step 2: Compare with other options

   Options A, B, and D describe different commands or actions unrelated to parent(). Only It finds the direct parent element of the current element. correctly describes the direct parent selection.

3. Final Answer:

   It finds the direct parent element of the current element. -> Option A

4. Quick Check:

   parent() = direct parent element [OK]

Hint: Remember: parent() gets one level up in the DOM tree [OK]

Common Mistakes:

• Confusing parent() with children()
• Thinking parent() clicks the element
• Assuming parent() waits for elements

2. Which of the following is the correct syntax to get the parent of an element with class child-item in Cypress?

easy

A. cy.get('.child-item').children();

B. cy.get('.child-item').parents();

C. cy.get('.child-item').parent('.parent-item');

D. cy.get('.child-item').parent();

Solution

1. Step 1: Identify the basic parent command syntax

   The basic syntax to get the direct parent is cy.get(selector).parent();. This returns the immediate parent element.

2. Step 2: Analyze options

   cy.get('.child-item').parents(); uses parents() which gets all ancestors, not just the direct parent. cy.get('.child-item').parent('.parent-item'); filters the direct parent to only those matching '.parent-item', but the question does not specify the parent's class. cy.get('.child-item').children(); gets children, not parent.

3. Final Answer:

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

4. Quick Check:

   Correct syntax = cy.get(...).parent() [OK]

Hint: Use parent() without arguments for direct parent [OK]

Common Mistakes:

• Using parents() instead of parent()
• Trying to pass selector directly inside parent() incorrectly
• Confusing children() with parent()

3. What will the following Cypress code select?

cy.get('.list-item').parent('.list-container').should('have.class', 'active');

medium

A. All parents of '.list-item' with class 'list-container' regardless of other classes.

B. The direct parent of '.list-item' that has class 'list-container' and also has class 'active'.

C. The child elements of '.list-item' with class 'active'.

D. The '.list-item' elements themselves if they have class 'active'.

Solution

1. Step 1: Understand the parent() with selector

   The parent('.list-container') command filters the direct parent to only those with class list-container.

2. Step 2: Understand the assertion

   The should('have.class', 'active') asserts that the selected parent element also has the class active.

3. Final Answer:

   The direct parent of '.list-item' that has class 'list-container' and also has class 'active'. -> Option B

4. Quick Check:

   parent(selector) filters direct parent [OK]

Hint: parent(selector) filters direct parent by selector [OK]

Common Mistakes:

• Thinking parents() selects only direct parent
• Confusing child elements with parent elements
• Ignoring the filter selector in parent()

4. You wrote this Cypress code but it fails:

cy.get('.button').parent('.container').click();

What is the likely cause of the failure?

medium

A. The parent element with class 'container' does not exist directly above '.button'.

B. The parent() command cannot be chained with click().

C. The selector '.button' is invalid.

D. You must use parents() instead of parent().

Solution

1. Step 1: Check the parent selector usage

   The parent('.container') filters the direct parent to only those with class 'container'. If no direct parent matches, the command yields no element.

2. Step 2: Understand why click() fails

   Since no element is found, click() fails because it has nothing to act on.

3. Final Answer:

   The parent element with class 'container' does not exist directly above '.button'. -> Option A

4. Quick Check:

   parent(selector) fails if no direct parent matches [OK]

Hint: Check if direct parent matches selector before chaining actions [OK]

Common Mistakes:

• Assuming parent() always finds an element
• Thinking click() can't chain after parent()
• Using parents() unnecessarily

5. You want to verify that a button with class submit-btn is inside a form with class user-form. Which Cypress code correctly checks the form is the direct parent of the button?

hard

A. cy.get('.user-form').children('.submit-btn').should('exist');

B. cy.get('.submit-btn').parents('form.user-form').should('exist');

C. cy.get('.submit-btn').parent('form.user-form').should('exist');

D. cy.get('.submit-btn').parent().should('have.class', 'user-form');

Solution

1. Step 1: Understand direct parent check

   To check if the direct parent matches a selector, use parent(selector). cy.get('.submit-btn').parent('form.user-form').should('exist'); uses this correctly.

2. Step 2: Compare other options

   cy.get('.submit-btn').parents('form.user-form').should('exist'); checks all ancestors, not just direct parent. cy.get('.user-form').children('.submit-btn').should('exist'); checks children of the form, reversed logic. cy.get('.submit-btn').parent().should('have.class', 'user-form'); checks parent but does not filter by selector, so it may pass incorrectly.

3. Final Answer:

   cy.get('.submit-btn').parent('form.user-form').should('exist'); -> Option C

4. Quick Check:

   parent(selector) verifies direct parent matches selector [OK]

Hint: Use parent(selector) to confirm direct parent matches [OK]

Common Mistakes:

• Using parents() when only direct parent matters
• Checking children instead of parent
• Not filtering parent by selector