Cookie management in Cypress - Framework Patterns

Framework Mode - Cookie management

Folder Structure

cypress/
├── e2e/
│   ├── login.cy.js          # Tests that use cookies for login
│   ├── session.cy.js        # Tests managing session cookies
├── support/
│   ├── commands.js          # Custom commands for cookie handling
│   ├── e2e.js               # Global support file
├── fixtures/
│   ├── user.json            # Test data including cookie info
cypress.config.js            # Cypress configuration file

Test Framework Layers

• Test Layer (cypress/e2e): Contains test files that verify cookie behavior like setting, clearing, and validating cookies.
• Support Layer (cypress/support): Holds reusable custom commands for cookie operations (e.g., cy.setCookie(), cy.clearCookies()), and global hooks.
• Fixtures Layer (cypress/fixtures): Stores test data such as user credentials or cookie values to simulate different scenarios.
• Configuration Layer (cypress.config.js): Defines environment variables, base URLs, and browser settings relevant for cookie tests.

Configuration Patterns

• Environment Variables: Use env in cypress.config.js to store sensitive cookie-related data like session tokens or domain names.
• Base URL: Set the baseUrl to ensure cookies are scoped correctly during tests.
• Browser Settings: Configure browser launch options if needed to allow or block cookies.
• Fixtures for Cookie Data: Store expected cookie values or user sessions in fixture files for reuse.

Test Reporting and CI/CD Integration

• Use Cypress built-in reporters or plugins like mochawesome to generate clear reports showing cookie test results.
• Integrate Cypress tests into CI/CD pipelines (GitHub Actions, Jenkins) to run cookie management tests automatically on code changes.
• Configure screenshots and video recording on test failures to help debug cookie-related issues.
• Use tags or test grouping to run only cookie-related tests when needed.

Best Practices

• Use Custom Commands: Create reusable commands for cookie operations to keep tests clean and readable.
• Clear Cookies Between Tests: Always clear cookies before or after tests to avoid state leakage.
• Validate Cookie Attributes: Check cookie properties like httpOnly, secure, and expiration to ensure security compliance.
• Use Fixtures for Data: Store cookie values and user sessions in fixtures to separate data from test logic.
• Test Across Browsers: Verify cookie behavior in different browsers to catch compatibility issues.

Self Check

Where in this folder structure would you add a new custom command to set a cookie with specific attributes?

Key Result

Organize cookie management tests with clear layers: tests, support commands, fixtures, and config for reliable, reusable automation.