beforeEach and afterEach hooks in Cypress - Framework Patterns

Framework Mode - beforeEach and afterEach hooks

Folder Structure

  cypress/
  ├── e2e/
  │   ├── login.spec.js       # Test files using beforeEach and afterEach hooks
  │   └── dashboard.spec.js
  ├── support/
  │   ├── commands.js         # Custom commands
  │   └── e2e.js              # Global beforeEach/afterEach can be placed here
  ├── fixtures/
  │   └── user.json           # Test data
  cypress.config.js            # Configuration file
  

Test Framework Layers

• Test Files (cypress/e2e/): Contains test cases where beforeEach and afterEach hooks run setup and cleanup before and after each test.
• Support Layer (cypress/support/): Contains reusable commands and global hooks that run before or after all tests or suites.
• Fixtures (cypress/fixtures/): Holds test data files loaded during tests.
• Configuration (cypress.config.js): Defines environment settings, base URLs, and browser options.

Configuration Patterns

Use cypress.config.js to define environment variables and base URLs for different environments (dev, staging, prod).

Example snippet:

  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 via Cypress.env('username').

Test Reporting and CI/CD Integration

• Use built-in Cypress reporter or integrate with mochawesome for detailed HTML reports.
• Configure CI pipelines (GitHub Actions, Jenkins, GitLab CI) to run npx cypress run on code push.
• Store test artifacts like screenshots and videos for failed tests automatically.
• Use beforeEach and afterEach hooks to prepare and clean test state for reliable CI runs.

Best Practices

1. Use beforeEach to set up test state: Reset app state, visit pages, or login before each test to keep tests independent.
2. Use afterEach for cleanup: Clear cookies, local storage, or reset mocks to avoid test pollution.
3. Keep hooks simple and fast: Avoid heavy operations in hooks to keep tests quick and stable.
4. Use global hooks in cypress/support/e2e.js for common setup: For example, global login or clearing data before all tests.
5. Do not share state between tests: Each test should be able to run alone without relying on previous tests.

Self Check

Where would you add a beforeEach hook that logs in a user before every test in the login.spec.js file?

Key Result

Use beforeEach and afterEach hooks in Cypress tests to set up and clean test state for reliable, independent tests.

Practice

1. What is the main purpose of the beforeEach hook in Cypress testing?

easy

A. To run code before every test to set up the test environment

B. To run code after every test to clean up the test environment

C. To skip a test conditionally

D. To group multiple tests together

Solution

1. Step 1: Understand the role of beforeEach

   The beforeEach hook runs before each test to prepare the environment or state needed for the test.

2. Step 2: Differentiate from afterEach

   Unlike afterEach, which runs after tests to clean up, beforeEach sets up conditions before tests.

3. Final Answer:

   To run code before every test to set up the test environment -> Option A

4. Quick Check:

   beforeEach = setup before tests [OK]

Hint: Remember: beforeEach runs before tests, afterEach runs after [OK]

Common Mistakes:

• Confusing beforeEach with afterEach
• Thinking beforeEach skips tests
• Assuming beforeEach groups tests

2. Which of the following is the correct syntax to use afterEach in a Cypress test file?

easy

A. afterEach { cy.visit('/home') }

B. afterEach(() => { cy.visit('/home') })

C. afterEach: () => cy.visit('/home')

D. afterEach => { cy.visit('/home') }

Solution

1. Step 1: Recall correct function syntax in Cypress

   Cypress hooks use function calls with arrow functions inside parentheses, like afterEach(() => { ... }).

2. Step 2: Identify syntax errors in other options

   Options B, C, and D miss parentheses or use incorrect arrow function syntax.

3. Final Answer:

   afterEach(() => { cy.visit('/home') }) -> Option B

4. Quick Check:

   Hook syntax = function call with arrow function [OK]

Hint: Hooks need parentheses and arrow functions: hook(() => {}) [OK]

Common Mistakes:

• Omitting parentheses after hook name
• Using curly braces without parentheses
• Incorrect arrow function syntax

3. Consider this Cypress test code:

describe('My Tests', () => {
  beforeEach(() => {
    cy.visit('/login')
  })

  it('Test 1', () => {
    cy.get('#username').type('user1')
  })

  it('Test 2', () => {
    cy.get('#username').type('user2')
  })
})

How many times will cy.visit('/login') run when these tests execute?

medium

A. Once before all tests

B. Twice, once after each test

C. Twice, once before each test

D. Once after all tests

Solution

1. Step 1: Understand beforeEach behavior

   The beforeEach hook runs before every individual test inside the describe block.

2. Step 2: Count the tests and hook calls

   There are two tests, so cy.visit('/login') runs twice, once before each test.

3. Final Answer:

   Twice, once before each test -> Option C

4. Quick Check:

   beforeEach runs before every test [OK]

Hint: Count tests; beforeEach runs before each one [OK]

Common Mistakes:

• Thinking beforeEach runs only once
• Confusing beforeEach with afterEach
• Assuming hooks run after tests

4. You wrote this Cypress test:

describe('Sample', () => {
  beforeEach(() => {
    cy.visit('/dashboard')
  })

  afterEach(() => {
    cy.clearCookies
  })

  it('checks title', () => {
    cy.title().should('include', 'Dashboard')
  })
})

Why does cy.clearCookies not run after the test?

medium

A. Because cy.clearCookies is missing parentheses to call the function

B. Because afterEach only runs before tests

C. Because cy.clearCookies is not a valid Cypress command

D. Because beforeEach overrides afterEach

Solution

1. Step 1: Check the afterEach hook code

   The code uses cy.clearCookies without parentheses, so the function is not called.

2. Step 2: Understand function call syntax

   To execute the command, parentheses are required: cy.clearCookies().

3. Final Answer:

   Because cy.clearCookies is missing parentheses to call the function -> Option A

4. Quick Check:

   Functions need () to run [OK]

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

Common Mistakes:

• Forgetting parentheses on Cypress commands
• Confusing beforeEach and afterEach roles
• Assuming afterEach runs before tests

5. You want to test a form that requires logging in before each test and clearing local storage after each test. Which is the best way to organize your Cypress hooks?

hard

A. Use only beforeEach for both login and clearing local storage

B. Use afterEach to log in and beforeEach to clear local storage

C. Use only afterEach for both login and clearing local storage

D. Use beforeEach to log in and afterEach to clear local storage

Solution

1. Step 1: Identify setup and cleanup tasks

   Logging in is setup needed before each test; clearing local storage is cleanup after each test.

2. Step 2: Assign tasks to correct hooks

   Use beforeEach for setup (login) and afterEach for cleanup (clear local storage).

3. Final Answer:

   Use beforeEach to log in and afterEach to clear local storage -> Option D

4. Quick Check:

   Setup beforeEach, cleanup afterEach [OK]

Hint: Setup in beforeEach, cleanup in afterEach [OK]

Common Mistakes:

• Mixing setup and cleanup in wrong hooks
• Using only one hook for both tasks
• Not cleaning up after tests