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.

Practice

1. What is the main purpose of managing cookies in Cypress tests?

easy

A. To speed up the browser rendering process

B. To change the website's HTML structure

C. To store and verify small pieces of information like user sessions

D. To create new browser tabs automatically

Solution

1. Step 1: Understand what cookies do

   Cookies store small data like user sessions or preferences to remember users.

2. Step 2: Relate to Cypress testing

   Cypress manages cookies to test if the site remembers users or settings correctly.

3. Final Answer:

   To store and verify small pieces of information like user sessions -> Option C

4. Quick Check:

   Cookies store info = A [OK]

Hint: Cookies store user info; Cypress tests that info [OK]

Common Mistakes:

• Thinking cookies change page layout
• Confusing cookies with browser tabs
• Assuming cookies speed up rendering

2. Which Cypress command correctly sets a cookie named session_id with value abc123?

easy

A. cy.setCookie('session_id', 'abc123')

B. cy.cookieSet('session_id', 'abc123')

C. cy.set('session_id', 'abc123')

D. cy.createCookie('session_id', 'abc123')

Solution

1. Step 1: Recall Cypress cookie setting syntax

   The correct command to set a cookie is cy.setCookie(name, value).

2. Step 2: Match the command with options

   Only cy.setCookie('session_id', 'abc123') uses cy.setCookie with correct parameters.

3. Final Answer:

   cy.setCookie('session_id', 'abc123') -> Option A

4. Quick Check:

   Use cy.setCookie() to set cookies [OK]

Hint: Use cy.setCookie(name, value) to set cookies [OK]

Common Mistakes:

• Using wrong command names like cookieSet or createCookie
• Confusing cy.set with cy.setCookie
• Missing quotes around cookie name or value

3. What will be the output of this Cypress code snippet?

cy.setCookie('token', 'xyz789')
cy.getCookie('token').should('have.property', 'value', 'xyz789')

medium

A. Test passes because cookie 'token' has value 'xyz789'

B. Test fails because cookie 'token' is not set

C. Syntax error due to wrong command usage

D. Test passes but cookie value is empty string

Solution

1. Step 1: Analyze cookie setting

   The code sets a cookie named 'token' with value 'xyz789' using cy.setCookie.

2. Step 2: Analyze assertion

   The code gets the cookie 'token' and asserts its value property equals 'xyz789'. This matches the set value.

3. Final Answer:

   Test passes because cookie 'token' has value 'xyz789' -> Option A

4. Quick Check:

   Set cookie then assert value = Pass [OK]

Hint: Set cookie then assert value matches to pass test [OK]

Common Mistakes:

• Assuming getCookie returns undefined if setCookie was called
• Confusing property name in assertion
• Thinking syntax is incorrect

4. Identify the error in this Cypress code that tries to clear all cookies:

cy.clearCookie()

medium

A. clearCookie clears all cookies without arguments, so no error

B. clearCookie requires a cookie name argument to clear a specific cookie

C. clearCookie is not a valid Cypress command

D. clearCookie must be called with an array of cookie names

Solution

1. Step 1: Understand clearCookie usage

   cy.clearCookie() requires a cookie name string to clear one cookie.

2. Step 2: How to clear all cookies

   To clear all cookies, use cy.clearCookies() (note plural) without arguments.

3. Final Answer:

   clearCookie requires a cookie name argument to clear a specific cookie -> Option B

4. Quick Check:

   clearCookie needs name; clearCookies clears all [OK]

Hint: Use clearCookies() to clear all, clearCookie(name) for one [OK]

Common Mistakes:

• Calling clearCookie() without name to clear all
• Confusing clearCookie with clearCookies
• Assuming clearCookie accepts multiple names

5. You want to test that a user stays logged in after a page reload by preserving the auth_token cookie. Which Cypress approach correctly achieves this?

hard

A. Use cy.reload(preserveCookies: true) to keep cookies

B. Use cy.preserveCookie('auth_token') before reload

C. Use cy.clearCookies() before reload to reset cookies

D. Use cy.getCookie('auth_token').then(cookie => { cy.setCookie(cookie.name, cookie.value) }) after reload

Solution

1. Step 1: Understand cookie preservation

   Cypress clears cookies on reload by default, so to keep a cookie, you must reset it after reload.

2. Step 2: Analyze options

   Use cy.getCookie('auth_token').then(cookie => { cy.setCookie(cookie.name, cookie.value) }) after reload manually gets and sets the cookie again after reload, which preserves it correctly. Use cy.preserveCookie('auth_token') before reload is invalid syntax. Use cy.clearCookies() before reload to reset cookies clears cookies, which removes the token. Use cy.reload({ preserveCookies: true }) to keep cookies is not a valid reload option in Cypress.

3. Final Answer:

   Use cy.getCookie('auth_token').then(cookie => { cy.setCookie(cookie.name, cookie.value) }) after reload -> Option D

4. Quick Check:

   Manually reset cookie after reload to preserve [OK]

Hint: Manually reset cookie after reload to keep it [OK]

Common Mistakes:

• Assuming reload keeps cookies automatically
• Using non-existent preserveCookie command
• Clearing cookies before reload by mistake