App Actions pattern in Cypress - Framework Patterns

Framework Mode - App Actions pattern

Folder Structure

cypress/
├── e2e/                  # Test specs
│   ├── login.cy.js       # Example test file
│   └── dashboard.cy.js
├── support/              # Support files
│   ├── appActions.js     # App Actions pattern implementation
│   ├── commands.js       # Custom Cypress commands
│   └── index.js          # Support file entry point
├── fixtures/             # Test data files
│   └── users.json
cypress.config.js         # Cypress configuration
package.json              # Project dependencies and scripts

Test Framework Layers

• Test Specs (cypress/e2e): Contains test files that describe user scenarios using App Actions.
• App Actions (cypress/support/appActions.js): Encapsulates user interactions as reusable functions representing app behaviors.
• Custom Commands (cypress/support/commands.js): Adds Cypress commands for common low-level actions.
• Fixtures (cypress/fixtures): Holds test data like user credentials or sample inputs.
• Configuration (cypress.config.js): Defines environment settings, base URLs, and browser options.

Configuration Patterns

• Environment Variables: Use cypress.env.json or --env CLI flags to switch between dev, staging, and production URLs.
• Browser Selection: Configure browsers in cypress.config.js or via CLI to run tests in Chrome, Firefox, or Edge.
• Credentials Management: Store sensitive data in cypress.env.json or CI environment variables, never in source code.
• Base URL: Set baseUrl in cypress.config.js for easy navigation in tests.

Test Reporting and CI/CD Integration

• Test Reports: Use Cypress built-in reporter or integrate with mochawesome for detailed HTML reports.
• CI/CD Integration: Run Cypress tests in pipelines (GitHub Actions, GitLab CI, Jenkins) with commands like npx cypress run.
• Artifacts: Save screenshots and videos on test failures for debugging.
• Notifications: Configure pipeline to notify team on test results via email or chat tools.

Best Practices for App Actions Pattern

• Single Responsibility: Each app action function should perform one clear user interaction.
• Reusability: Write app actions to be reusable across multiple tests to reduce duplication.
• Readable Tests: Use app actions in test specs to make tests easy to read like a story.
• Maintainability: Keep app actions in a dedicated file to isolate UI changes from tests.
• Parameterization: Allow app actions to accept parameters for flexible inputs.

Self Check

Where in this folder structure would you add a new app action for filling out a registration form?

Key Result

Use App Actions to encapsulate user interactions as reusable functions in Cypress support files for clean, maintainable tests.

Practice

1. What is the main benefit of using the App Actions pattern in Cypress tests?

easy

A. It automatically generates test data for each test run.

B. It speeds up test execution by running tests in parallel.

C. It replaces the need for assertions in tests.

D. It groups test steps into reusable methods to keep tests clean and maintainable.

Solution

1. Step 1: Understand the purpose of App Actions pattern

   The pattern groups common test steps into reusable methods to avoid repetition.

2. Step 2: Identify the benefit in test code

   This grouping makes tests cleaner and easier to maintain by reusing code.

3. Final Answer:

   It groups test steps into reusable methods to keep tests clean and maintainable. -> Option D

4. Quick Check:

   Reusable methods = cleaner tests [OK]

Hint: Remember: App Actions = reusable test steps [OK]

Common Mistakes:

• Thinking App Actions generate test data automatically
• Confusing App Actions with test assertions
• Assuming App Actions speed up test execution

2. Which of the following is the correct way to define an App Action method for logging in a user in Cypress?

easy

A. const login = () => { cy.get('#user').type('admin'); cy.get('#pass').type('1234'); cy.get('#submit').click(); }

B. cy.login = () => { cy.get('#user').type('admin'); cy.get('#pass').type('1234'); cy.get('#submit').click(); }

C. function login() { cy.get('#user').type('admin'); cy.get('#pass').type('1234'); cy.get('#submit').click(); }

D. login() { cy.get('#user').type('admin'); cy.get('#pass').type('1234'); cy.get('#submit').click(); }

Solution

1. Step 1: Identify valid JavaScript function syntax

   const login = () => { cy.get('#user').type('admin'); cy.get('#pass').type('1234'); cy.get('#submit').click(); } uses a valid arrow function assigned to a constant, which is common in Cypress helper files.

2. Step 2: Check other options for syntax errors

   function login() { cy.get('#user').type('admin'); cy.get('#pass').type('1234'); cy.get('#submit').click(); } is a function declaration but not exported or assigned; cy.login = () => { cy.get('#user').type('admin'); cy.get('#pass').type('1234'); cy.get('#submit').click(); } incorrectly assigns to cy object; login() { cy.get('#user').type('admin'); cy.get('#pass').type('1234'); cy.get('#submit').click(); } is invalid syntax.

3. Final Answer:

   const login = () => { cy.get('#user').type('admin'); cy.get('#pass').type('1234'); cy.get('#submit').click(); } -> Option A

4. Quick Check:

   Arrow function assigned to const = correct syntax [OK]

Hint: Use arrow functions assigned to const for App Actions [OK]

Common Mistakes:

• Using invalid function syntax without const or arrow
• Attaching methods directly to cy object incorrectly
• Omitting function keyword or arrow in definitions

3. Given this App Action method:

const addItem = (name) => { cy.get('#item-input').type(name); cy.get('#add-button').click(); }

What will be the result of this test code?

addItem('Book'); cy.get('#item-list').should('contain', 'Book');

medium

A. The test will fail because addItem does not return a value.

B. The test will pass if 'Book' appears in the item list after adding.

C. The test will throw a syntax error due to missing return statement.

D. The test will pass only if the input field has a placeholder 'Book'.

Solution

1. Step 1: Understand what addItem does

   It types the given name into the input and clicks the add button, triggering UI update.

2. Step 2: Analyze the assertion

   The test checks if '#item-list' contains the text 'Book', which should be true after adding.

3. Final Answer:

   The test will pass if 'Book' appears in the item list after adding. -> Option B

4. Quick Check:

   UI updates with added item = test passes [OK]

Hint: Add item then check list contains it [OK]

Common Mistakes:

• Assuming missing return causes failure
• Confusing input placeholder with typed value
• Expecting addItem to return a value

4. This App Action method is intended to log in a user:

const login = (user, pass) => { cy.get('#username').type(user); cy.get('#password').type(pass); cy.get('#login-btn').click }

What is the error and how to fix it?

medium

A. Missing parentheses after click; fix by changing to cy.get('#login-btn').click().

B. Wrong selector for username; fix by using #user instead of #username.

C. Missing return statement; fix by adding return before cy commands.

D. Using arrow function incorrectly; fix by using function keyword.

Solution

1. Step 1: Check method chaining syntax

   The click command is missing parentheses, so it is not called.

2. Step 2: Fix the click command

   Add parentheses to call the function: click() to perform the click action.

3. Final Answer:

   Missing parentheses after click; fix by changing to cy.get('#login-btn').click() -> Option A

4. Quick Check:

   Method calls need parentheses [OK]

Hint: Always add () to call Cypress commands like click [OK]

Common Mistakes:

• Forgetting parentheses on Cypress commands
• Changing selectors without verifying correctness
• Thinking return is needed for Cypress commands

5. You want to create an App Action to add multiple items from an array and verify all appear in the list. Which is the best approach?

hard

A. Use a single cy.get() call to type all items at once separated by commas.

B. Write separate tests for each item instead of looping in one method.

C. Create an addItems method that loops over the array, calls addItem for each, then asserts all items appear.

D. Add all items by typing them in one input, then click add once.

Solution

1. Step 1: Understand the need for reusability and verification

   Looping over the array and calling addItem reuses existing code and ensures each item is added properly.

2. Step 2: Verify all items appear after adding

   After adding, asserting all items appear confirms the UI updated correctly for each item.

3. Final Answer:

   Create an addItems method that loops over the array, calls addItem for each, then asserts all items appear. -> Option C

4. Quick Check:

   Loop + reuse + verify = best practice [OK]

Hint: Loop array, reuse addItem, then assert all present [OK]

Common Mistakes:

• Typing all items at once without separate adds
• Writing many separate tests instead of one reusable method
• Assuming one click adds multiple items automatically