Test Automation - How To Edit Cookies in Selenium Python

Introduction

This article will provide step-by-step instructions on how to edit cookies in Selenium Python.

Cookies are small text files that are stored on the user’s device by a website. They are used to remember user preferences, login credentials, and other information that is specific to the user. Cookies are stored on the user’s device and are sent back to the server with every request, allowing the server to recognize the user and their preferences.

The technological stack used to implement the solution is:

Programing language: Python

Testing Framework: pytest

Reporting Framework: Allure

link to the project that was developed together with Elias Shourosh.

Common Cases for Updating Cookie Values

There are various situations where it is required to update cookie values. Here are three typical scenarios:

1. Modifying session data: When you need to update session-related information stored in cookies, such as user authentication tokens or user-specific settings.
2. Testing different scenarios: In test automation, you may want to modify cookie values to simulate different user states or test various application functionalities.
3. Debugging and troubleshooting: Updating cookie values can help debug issues

The problem

Selenium does not provide a method to update cookies, Although it offers methods to add and delete cookies, it lacks a built-in method to update cookie values.

Implementing the Solution

def edit_cookie(self, cookie_key, cookie_value):
    cookie = self.wait.until(
        lambda d: d.get_cookie(cookie_key),
        message=f"Cookie '{cookie_key}' does not exist within the given timeout")
    self.driver.delete_cookie(cookie_key)
    self.driver.add_cookie({
        "name": cookie['name'],
        "value": cookie_value,
        "domain": cookie['domain'],
        "path": cookie['path'],
        "secure": cookie['secure'],
        "expiry": cookie['expiry']
    })

This method takes in the cookie key and the desired cookie value as parameters. It first retrieves the existing cookie using the cookie key. If the cookie doesn’t exist within the specified timeout, an appropriate error message is displayed. The method then deletes the old cookie and adds a new cookie with the updated value while retaining the original cookie properties.

In conclusion

Editing cookies is a valuable ability when working with web automation using Selenium in Python. While Selenium doesn’t provide a direct method for editing cookies, we can overcome this limitation by creating a custom method. By using the edit_cookie method provided in this article which is found here. This capability empowers you to handle a variety of scenarios, including session management, testing, and troubleshooting, leading to a more robust and effective web automation framework.

Happy testing!