Merge pull request #426 from seleniumbase/cookie-actions

Add methods for handling cookies on web pages

Author: mdmintz

.gitignore

@@ -84,6 +84,9 @@ tours_exported
 # Images
 images_exported
 
+# Cookies
+saved_cookies
+
 # Automated Visual Testing
 visual_baseline
 

README.md

@@ -7,7 +7,7 @@ All-in-one framework for web automation, end-to-end testing, and website tours.
 * Contains reliable, smart-waiting code to prevent flaky tests.
 * Simplifies the process of creating UI tests for any website.
 * Includes [Plugins](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/plugins/pytest_plugin.py) for logging [test results and screenshots](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md).
-* Multiplies the abilities of [pytest](https://pytest.org) and [Selenium WebDriver](https://www.seleniumhq.org/).
+* Multiplies the abilities of [pytest](https://pytest.org) and [Selenium WebDriver](https://selenium.dev/).
 * Uses versatile [Python methods](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md) and [command-line options](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md).
 * Includes tools for [assisted-QA](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md), [visual testing](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/visual_testing/ReadMe.md), and [web tours](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md).
 * Integrates with [Selenium Grid](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md), [Katalon Recorder](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_ide/ReadMe.md), and [MySQL](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/core/testcase_manager.py).
@@ -340,7 +340,7 @@ Here are some things you can do to setup a production environment for your testi
 
 * You can setup a [Jenkins](https://jenkins.io/) build server for running tests at regular intervals. Jenkins has many plugins available, such as [the Xvfb headless browser plugin](https://wiki.jenkins-ci.org/display/JENKINS/Xvfb+Plugin) for running tests on a machine with no GUI. If you have Xvfb running in the background, you can add ``--headless`` to your run command in order to utilize it. For more info about the Xvfb plugin, [read this](https://qxf2.com/blog/xvfb-plugin-for-jenkins-selenium/). For a real-world Jenkins example of headless browser automation in action, check out [the SeleniumBase Google Cloud ReadMe](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/google_cloud/ReadMe.md).
 
-* You can use [the Selenium Grid](https://github.com/SeleniumHQ/selenium/wiki/Grid2) to scale your testing by distributing tests on several machines with parallel execution. To do this, check out the SeleniumBase [selenium_grid folder](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/utilities/selenium_grid), which should have everything you need. The [Selenium Grid ReadMe](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md) will help you get started.
+* You can use [the Selenium Grid](https://selenium.dev/documentation/en/grid/) to scale your testing by distributing tests on several machines with parallel execution. To do this, check out the SeleniumBase [selenium_grid folder](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/utilities/selenium_grid), which should have everything you need. The [Selenium Grid ReadMe](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md) will help you get started.
 
 * If you're using the [SeleniumBase MySQL feature](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/mysql_installation.md) to save results from tests running on a server machine, you can install [MySQL Workbench](https://dev.mysql.com/downloads/tools/workbench/) to help you read & write from your DB more easily. See [Stackoverflow](https://stackoverflow.com/questions/43102442/whats-the-difference-between-mysqldb-mysqlclient-and-mysql-connector-python) for more info.
 

help_docs/method_summary.md

@@ -159,6 +159,14 @@ self.save_screenshot(name, folder=None)
 
 self.save_page_source(name, folder=None)
 
+self.save_cookies(name="cookies.txt")
+
+self.load_cookies(name="cookies.txt")
+
+self.delete_all_cookies()
+
+self.delete_saved_cookies(name="cookies.txt")
+
 self.wait_for_ready_state_complete(timeout=None)
 
 self.wait_for_angularjs(timeout=None)

requirements.txt

@@ -10,7 +10,7 @@ chardet==3.0.4
 urllib3==1.25.6
 requests>=2.22.0
 selenium==3.141.0
-pluggy>=0.13.0
+pluggy>=0.13.1
 attrs>=19.3.0
 pytest>=4.6.6;python_version<"3"
 pytest>=5.3.0;python_version>="3"
@@ -35,6 +35,6 @@ pypdf2>=1.26.0
 pyotp>=2.3.0
 boto>=2.49.0
 cffi>=1.13.2
-tqdm>=4.38.0
+tqdm>=4.39.0
 flake8>=3.7.9
 certifi>=2019.9.11

seleniumbase/fixtures/base_case.py

@@ -1479,6 +1479,75 @@ def save_page_source(self, name, folder=None):
         """
         return page_actions.save_page_source(self.driver, name, folder)
 
+    def save_cookies(self, name="cookies.txt"):
+        """ Saves the page cookies to the "saved_cookies" folder. """
+        cookies = self.driver.get_cookies()
+        json_cookies = json.dumps(cookies)
+        if name.endswith('/'):
+            raise Exception("Invalid filename for Cookies!")
+        if '/' in name:
+            name = name.split('/')[-1]
+        if len(name) < 1:
+            raise Exception("Filename for Cookies is too short!")
+        if not name.endswith(".txt"):
+            name = name + ".txt"
+        folder = constants.SavedCookies.STORAGE_FOLDER
+        abs_path = os.path.abspath('.')
+        file_path = abs_path + "/%s" % folder
+        if not os.path.exists(file_path):
+            os.makedirs(file_path)
+        cookies_file_path = "%s/%s" % (file_path, name)
+        cookies_file = codecs.open(cookies_file_path, "w+")
+        cookies_file.writelines(json_cookies)
+        cookies_file.close()
+
+    def load_cookies(self, name="cookies.txt"):
+        """ Loads the page cookies from the "saved_cookies" folder. """
+        if name.endswith('/'):
+            raise Exception("Invalid filename for Cookies!")
+        if '/' in name:
+            name = name.split('/')[-1]
+        if len(name) < 1:
+            raise Exception("Filename for Cookies is too short!")
+        if not name.endswith(".txt"):
+            name = name + ".txt"
+        folder = constants.SavedCookies.STORAGE_FOLDER
+        abs_path = os.path.abspath('.')
+        file_path = abs_path + "/%s" % folder
+        cookies_file_path = "%s/%s" % (file_path, name)
+        f = open(cookies_file_path, 'r')
+        json_cookies = f.read().strip()
+        f.close()
+        cookies = json.loads(json_cookies)
+        for cookie in cookies:
+            if 'expiry' in cookie:
+                del cookie['expiry']
+            self.driver.add_cookie(cookie)
+
+    def delete_all_cookies(self):
+        """ Deletes all cookies in the web browser.
+            Does NOT delete the saved cookies file. """
+        self.driver.delete_all_cookies()
+
+    def delete_saved_cookies(self, name="cookies.txt"):
+        """ Deletes the cookies file from the "saved_cookies" folder.
+            Does NOT delete the cookies from the web browser. """
+        if name.endswith('/'):
+            raise Exception("Invalid filename for Cookies!")
+        if '/' in name:
+            name = name.split('/')[-1]
+        if len(name) < 1:
+            raise Exception("Filename for Cookies is too short!")
+        if not name.endswith(".txt"):
+            name = name + ".txt"
+        folder = constants.SavedCookies.STORAGE_FOLDER
+        abs_path = os.path.abspath('.')
+        file_path = abs_path + "/%s" % folder
+        cookies_file_path = "%s/%s" % (file_path, name)
+        if os.path.exists(cookies_file_path):
+            if cookies_file_path.endswith('.txt'):
+                os.remove(cookies_file_path)
+
     def wait_for_ready_state_complete(self, timeout=None):
         try:
             # If there's an alert, skip

seleniumbase/fixtures/constants.py

@@ -19,6 +19,10 @@ class Files:
     ARCHIVED_DOWNLOADS_FOLDER = "archived_files"
 
 
+class SavedCookies:
+    STORAGE_FOLDER = "saved_cookies"
+
+
 class VisualBaseline:
     STORAGE_FOLDER = "visual_baseline"
 

seleniumbase/fixtures/page_actions.py

@@ -467,7 +467,7 @@ def save_screenshot(driver, name, folder=None):
     If the folder provided doesn't exist, it will get created.
     The screenshot will be in PNG format.
     """
-    if "." not in name:
+    if not name.endswith(".png"):
         name = name + ".png"
     if folder:
         abs_path = os.path.abspath('.')
@@ -497,7 +497,7 @@ def save_page_source(driver, name, folder=None):
     name - The file name to save the current page's HTML to.
     folder - The folder to save the file to. (Default = current folder)
     """
-    if "." not in name:
+    if not name.endswith(".html"):
         name = name + ".html"
     if folder:
         abs_path = os.path.abspath('.')

setup.py

@@ -45,7 +45,7 @@
 
 setup(
     name='seleniumbase',
-    version='1.33.2',
+    version='1.33.3',
     description='Fast, Easy, and Reliable Browser Automation & Testing.',
     long_description=long_description,
     long_description_content_type='text/markdown',
@@ -93,7 +93,7 @@
         'urllib3==1.25.6',  # Must stay in sync with "requests"
         'requests>=2.22.0',
         'selenium==3.141.0',
-        'pluggy>=0.13.0',
+        'pluggy>=0.13.1',
         'attrs>=19.3.0',
         'pytest>=4.6.6;python_version<"3"',  # For Python 2 compatibility
         'pytest>=5.3.0;python_version>="3"',
@@ -118,7 +118,7 @@
         'pyotp>=2.3.0',
         'boto>=2.49.0',
         'cffi>=1.13.2',
-        'tqdm>=4.38.0',
+        'tqdm>=4.39.0',
         'flake8>=3.7.9',
         'certifi>=2019.9.11',
     ],