Cookie management in Selenium Python - Framework Patterns

Framework Mode - Cookie management

Folder Structure

selenium-python-project/
├── src/
│   ├── pages/
│   │   └── base_page.py
│   ├── tests/
│   │   └── test_cookie_management.py
│   ├── utils/
│   │   └── cookie_manager.py
│   └── config/
│       └── config.py
├── requirements.txt
└── pytest.ini

Test Framework Layers

• Driver Layer: Handles browser setup and teardown using Selenium WebDriver.
• Page Objects: Classes representing web pages, encapsulating elements and actions.
• Utilities: Helper modules like cookie_manager.py to manage cookies (add, delete, get).
• Tests: Test scripts that use page objects and utilities to perform cookie-related tests.
• Config: Configuration files for environment variables, browser options, and credentials.

Configuration Patterns

• Use config.py to store environment URLs and browser options.
• Manage browser choice and headless mode via environment variables or command line arguments.
• Store sensitive data like credentials securely outside the codebase (e.g., environment variables).
• Cookie settings can be parameterized if needed for different test scenarios.

Test Reporting and CI/CD Integration

• Use pytest with plugins like pytest-html for readable HTML reports showing cookie test results.
• Integrate tests into CI/CD pipelines (e.g., GitHub Actions, Jenkins) to run cookie tests on every commit.
• Configure screenshots or logs on test failures to help diagnose cookie-related issues.
• Use clear test names and assertions to make reports easy to understand.

Best Practices for Cookie Management Framework

1. Encapsulate cookie operations: Use a dedicated utility module to add, delete, and retrieve cookies instead of repeating code.
2. Use explicit waits: Wait for page loads or elements before manipulating cookies to avoid flaky tests.
3. Isolate tests: Clear cookies before each test to ensure tests do not affect each other.
4. Parameterize cookie data: Allow tests to use different cookie values for flexibility and coverage.
5. Keep tests readable: Use descriptive test names and comments explaining cookie-related steps.

Self Check

Where would you add a new method to delete all cookies in this framework structure?

Key Result

Organize cookie management in a dedicated utility module with clear separation from page objects and tests.

Practice

1. What is the primary purpose of managing cookies in Selenium tests?

easy

A. To install browser extensions automatically

B. To store and manipulate small pieces of data like session info during tests

C. To speed up the browser loading time

D. To change the browser's homepage

Solution

1. Step 1: Understand what cookies do in web context

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

2. Step 2: Relate cookie management in Selenium

   Selenium manages cookies to simulate user sessions and test behaviors depending on stored data.

3. Final Answer:

   To store and manipulate small pieces of data like session info during tests -> Option B

4. Quick Check:

   Cookies store session data = D [OK]

Hint: Cookies hold session data for tests, not browser settings [OK]

Common Mistakes:

• Thinking cookies change browser settings
• Confusing cookies with browser speed optimization
• Assuming cookies install extensions

2. Which of the following is the correct way to add a cookie named user with value admin in Selenium Python?

easy

A. driver.add_cookie({'name': 'user', 'value': 'admin'})

B. driver.addCookie('user', 'admin')

C. driver.add_cookie('user', 'admin')

D. driver.addCookie({'user': 'admin'})

Solution

1. Step 1: Recall Selenium Python cookie syntax

   The method add_cookie expects a dictionary with keys 'name' and 'value'.

2. Step 2: Match the correct syntax

   driver.add_cookie({'name': 'user', 'value': 'admin'}) correctly uses driver.add_cookie({'name': 'user', 'value': 'admin'}).

3. Final Answer:

   driver.add_cookie({'name': 'user', 'value': 'admin'}) -> Option A

4. Quick Check:

   add_cookie needs dict with 'name' and 'value' keys = A [OK]

Hint: Use a dict with 'name' and 'value' keys for add_cookie [OK]

Common Mistakes:

• Using camelCase method names like addCookie
• Passing cookie name and value as separate arguments
• Passing a dict without 'name' and 'value' keys

3. What will be the output of the following code snippet?

driver.add_cookie({'name': 'session', 'value': 'xyz123'})
cookie = driver.get_cookie('session')
print(cookie['value'])

medium

A. {'name': 'session', 'value': 'xyz123'}

B. session

C. xyz123

D. null

Solution

1. Step 1: Add cookie with name 'session' and value 'xyz123'

   The cookie is stored with key 'session' and value 'xyz123'.

2. Step 2: Retrieve cookie and print its 'value'

   Calling get_cookie('session') returns the cookie dict; printing cookie['value'] outputs 'xyz123'.

3. Final Answer:

   xyz123 -> Option C

4. Quick Check:

   get_cookie('session')['value'] = 'xyz123' [OK]

Hint: get_cookie returns dict; access 'value' key for cookie value [OK]

Common Mistakes:

• Printing cookie name instead of value
• Expecting get_cookie to return just the value string
• Confusing cookie dict with string

4. Identify the error in this Selenium Python code for deleting a cookie:

driver.delete_cookie('user')

medium

A. Method name should be deleteCookie instead of delete_cookie

B. delete_cookie requires a dictionary, not a string

C. Must call driver.delete_all_cookies() instead

D. No error; this is the correct way to delete a cookie by name

Solution

1. Step 1: Check Selenium Python method for deleting a cookie

   The method delete_cookie takes the cookie name as a string argument.

2. Step 2: Verify the code usage

   Using driver.delete_cookie('user') correctly deletes the cookie named 'user'.

3. Final Answer:

   No error; this is the correct way to delete a cookie by name -> Option D

4. Quick Check:

   delete_cookie('name') is correct syntax = C [OK]

Hint: delete_cookie takes cookie name string, not dict [OK]

Common Mistakes:

• Using camelCase method names
• Passing dict instead of string
• Confusing delete_cookie with delete_all_cookies

5. You want to test a website's behavior when a cookie named theme is set to dark. Which sequence of Selenium Python commands correctly sets this cookie, verifies it, and then deletes it?

hard

A. driver.add_cookie({'name': 'theme', 'value': 'dark'})\ncookie = driver.get_cookie('theme')\nassert cookie['value'] == 'dark'\ndriver.delete_cookie('theme')

B. driver.add_cookie('theme', 'dark')\ncookie = driver.get_cookie('theme')\nassert cookie == 'dark'\ndriver.delete_cookie('theme')

C. driver.add_cookie({'theme': 'dark'})\ncookie = driver.get_cookie('theme')\nassert cookie['value'] == 'dark'\ndriver.delete_cookie('theme')

D. driver.add_cookie({'name': 'theme', 'value': 'dark'})\ncookie = driver.get_cookie('theme')\nassert cookie == 'dark'\ndriver.delete_cookie('theme')

Solution

1. Step 1: Add cookie with correct dictionary format

   Use add_cookie({'name': 'theme', 'value': 'dark'}) to set the cookie properly.

2. Step 2: Retrieve cookie and assert its 'value'

   Get the cookie dict with get_cookie('theme') and check cookie['value'] == 'dark'.

3. Step 3: Delete the cookie by name

   Use delete_cookie('theme') to remove the cookie after test.

4. Final Answer:

   Correct sequence with dict, assert on value, and delete by name -> Option A

5. Quick Check:

   add_cookie dict + get_cookie['value'] + delete_cookie(name) = B [OK]

Hint: Add cookie with dict, assert value key, delete by name [OK]

Common Mistakes:

• Passing cookie as separate args instead of dict
• Asserting cookie object equals string
• Using wrong keys in cookie dict