Merge pull request #541 from seleniumbase/guest-mode-and-devtools

mdmintz · web-flow · commit 815dad700c06 · 2020-04-18T01:30:32.000-04:00
Add Guest Mode and DevTools options for Chromium
diff --git a/.gitignore b/.gitignore
@@ -71,6 +71,7 @@ latest_logs
 log_archives
 archived_logs
 geckodriver.log
+pytestdebug.log
 
 # Reports
 latest_report
diff --git a/README.md b/README.md
@@ -46,7 +46,7 @@ If multiple versions of Python are installed, be specific (E.g. use ``python3``
 pip install seleniumbase
 ```
 * Add ``--upgrade`` OR ``-U`` to upgrade an installation.
-* Add ``--force-reinstall`` for a clean install.
+* Add ``--force-reinstall`` to also upgrade dependencies.
 
 ### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Download a webdriver:
 
diff --git a/examples/raw_parameter_script.py b/examples/raw_parameter_script.py
@@ -36,6 +36,8 @@
     sb.environment = "test"
     sb.user_agent = None
     sb.incognito = False
+    sb.guest_mode = False
+    sb.devtools = False
     sb.mobile_emulator = False
     sb.device_metrics = None
     sb.extension_zip = None
diff --git a/pytest.ini b/pytest.ini
@@ -4,7 +4,9 @@
 addopts = --capture=no --ignore conftest.py -p no:cacheprovider
 
 # Ignore warnings such as DeprecationWarning and pytest.PytestUnknownMarkWarning
-filterwarnings = ignore::pytest.PytestWarning
+filterwarnings =
+    ignore::pytest.PytestWarning
+    ignore:.*U.*mode is deprecated:DeprecationWarning
 
 # Configure the junit_family option explicitly:
 junit_family = legacy
diff --git a/requirements.txt b/requirements.txt
@@ -8,7 +8,7 @@ nose==1.3.7
 ipdb==0.13.2
 idna==2.9
 chardet==3.0.4
-urllib3==1.25.8
+urllib3==1.25.9
 requests==2.23.0
 selenium==3.141.0
 pluggy==0.13.1
diff --git a/seleniumbase/core/browser_launcher.py b/seleniumbase/core/browser_launcher.py
@@ -132,7 +132,8 @@ def _set_chrome_options(
         downloads_path, headless,
         proxy_string, proxy_auth, proxy_user, proxy_pass,
         user_agent, disable_csp, enable_sync, no_sandbox, disable_gpu,
-        incognito, user_data_dir, extension_zip, extension_dir, servername,
+        incognito, guest_mode, devtools,
+        user_data_dir, extension_zip, extension_dir, servername,
         mobile_emulator, device_width, device_height, device_pixel_ratio):
     chrome_options = webdriver.ChromeOptions()
     prefs = {
@@ -145,10 +146,15 @@ def _set_chrome_options(
     }
     chrome_options.add_experimental_option("prefs", prefs)
     chrome_options.add_experimental_option("w3c", True)
-    chrome_options.add_experimental_option(
-        "excludeSwitches", ["enable-automation", "enable-logging"])
-    if servername == "localhost" or servername == "127.0.0.1":
-        chrome_options.add_experimental_option("useAutomationExtension", False)
+    if enable_sync:
+        chrome_options.add_experimental_option(
+            "excludeSwitches",
+            ["enable-automation", "enable-logging", "disable-sync"])
+        chrome_options.add_argument("--enable-sync")
+    else:
+        chrome_options.add_experimental_option(
+            "excludeSwitches",
+            ["enable-automation", "enable-logging"])
     if mobile_emulator:
         emulator_settings = {}
         device_metrics = {}
@@ -166,12 +172,13 @@ def _set_chrome_options(
             emulator_settings["userAgent"] = user_agent
         chrome_options.add_experimental_option(
             "mobileEmulation", emulator_settings)
-    if enable_sync:
-        chrome_options.add_experimental_option(
-            "excludeSwitches", ["disable-sync"])
         chrome_options.add_argument("--enable-sync")
     if incognito:
         chrome_options.add_argument("--incognito")
+    elif guest_mode:
+        chrome_options.add_argument("--guest")
+    else:
+        pass
     if user_data_dir:
         abs_path = os.path.abspath(user_data_dir)
         chrome_options.add_argument("user-data-dir=%s" % abs_path)
@@ -189,6 +196,8 @@ def _set_chrome_options(
     chrome_options.add_argument("--log-level=3")
     chrome_options.add_argument("--no-first-run")
     chrome_options.add_argument("--ignore-certificate-errors")
+    if devtools and not headless:
+        chrome_options.add_argument("--auto-open-devtools-for-tabs")
     chrome_options.add_argument("--allow-file-access-from-files")
     chrome_options.add_argument("--allow-insecure-localhost")
     chrome_options.add_argument("--allow-running-insecure-content")
@@ -199,10 +208,15 @@ def _set_chrome_options(
     chrome_options.add_argument("--disable-single-click-autofill")
     chrome_options.add_argument("--disable-translate")
     chrome_options.add_argument("--disable-web-security")
+    if servername == "localhost" or servername == "127.0.0.1":
+        chrome_options.add_experimental_option("useAutomationExtension", False)
     if (settings.DISABLE_CSP_ON_CHROME or disable_csp) and not headless:
         # Headless Chrome doesn't support extensions, which are required
         # for disabling the Content Security Policy on Chrome
         chrome_options = _add_chrome_disable_csp_extension(chrome_options)
+    elif not extension_zip and not extension_dir:
+        if servername == "localhost" or servername == "127.0.0.1":
+            chrome_options.add_argument("--disable-extensions")
     if proxy_string:
         if proxy_auth:
             chrome_options = _add_chrome_proxy_extension(
@@ -333,8 +347,9 @@ def get_driver(browser_name, headless=False, use_grid=False,
                servername='localhost', port=4444, proxy_string=None,
                user_agent=None, cap_file=None, disable_csp=None,
                enable_sync=None, no_sandbox=None, disable_gpu=None,
-               incognito=None, user_data_dir=None, extension_zip=None,
-               extension_dir=None, mobile_emulator=False, device_width=None,
+               incognito=None, guest_mode=None, devtools=None,
+               user_data_dir=None, extension_zip=None, extension_dir=None,
+               mobile_emulator=False, device_width=None,
                device_height=None, device_pixel_ratio=None):
     proxy_auth = False
     proxy_user = None
@@ -370,22 +385,25 @@ def get_driver(browser_name, headless=False, use_grid=False,
             browser_name, headless, servername, port,
             proxy_string, proxy_auth, proxy_user, proxy_pass, user_agent,
             cap_file, disable_csp, enable_sync, no_sandbox, disable_gpu,
-            incognito, user_data_dir, extension_zip, extension_dir,
+            incognito, guest_mode, devtools,
+            user_data_dir, extension_zip, extension_dir,
             mobile_emulator, device_width, device_height, device_pixel_ratio)
     else:
         return get_local_driver(
             browser_name, headless, servername,
             proxy_string, proxy_auth, proxy_user, proxy_pass, user_agent,
-            disable_csp, enable_sync, no_sandbox, disable_gpu, incognito,
-            user_data_dir, extension_zip, extension_dir, mobile_emulator,
-            device_width, device_height, device_pixel_ratio)
+            disable_csp, enable_sync, no_sandbox, disable_gpu,
+            incognito, guest_mode, devtools,
+            user_data_dir, extension_zip, extension_dir,
+            mobile_emulator, device_width, device_height, device_pixel_ratio)
 
 
 def get_remote_driver(
         browser_name, headless, servername, port, proxy_string, proxy_auth,
         proxy_user, proxy_pass, user_agent, cap_file, disable_csp,
-        enable_sync, no_sandbox, disable_gpu, incognito, user_data_dir,
-        extension_zip, extension_dir,
+        enable_sync, no_sandbox, disable_gpu,
+        incognito, guest_mode, devtools,
+        user_data_dir, extension_zip, extension_dir,
         mobile_emulator, device_width, device_height, device_pixel_ratio):
     downloads_path = download_helper.get_downloads_folder()
     download_helper.reset_downloads_folder()
@@ -397,7 +415,8 @@ def get_remote_driver(
         chrome_options = _set_chrome_options(
             downloads_path, headless,
             proxy_string, proxy_auth, proxy_user, proxy_pass, user_agent,
-            disable_csp, enable_sync, no_sandbox, disable_gpu, incognito,
+            disable_csp, enable_sync, no_sandbox, disable_gpu,
+            incognito, guest_mode, devtools,
             user_data_dir, extension_zip, extension_dir, servername,
             mobile_emulator, device_width, device_height, device_pixel_ratio)
         capabilities = chrome_options.to_capabilities()
@@ -508,7 +527,8 @@ def get_remote_driver(
 def get_local_driver(
         browser_name, headless, servername,
         proxy_string, proxy_auth, proxy_user, proxy_pass, user_agent,
-        disable_csp, enable_sync, no_sandbox, disable_gpu, incognito,
+        disable_csp, enable_sync, no_sandbox, disable_gpu,
+        incognito, guest_mode, devtools,
         user_data_dir, extension_zip, extension_dir,
         mobile_emulator, device_width, device_height, device_pixel_ratio):
     '''
@@ -597,7 +617,8 @@ def get_local_driver(
             chrome_options = _set_chrome_options(
                 downloads_path, headless,
                 proxy_string, proxy_auth, proxy_user, proxy_pass, user_agent,
-                disable_csp, enable_sync, no_sandbox, disable_gpu, incognito,
+                disable_csp, enable_sync, no_sandbox, disable_gpu,
+                incognito, guest_mode, devtools,
                 user_data_dir, extension_zip, extension_dir, servername,
                 mobile_emulator, device_width, device_height,
                 device_pixel_ratio)
@@ -652,7 +673,8 @@ def get_local_driver(
             chrome_options = _set_chrome_options(
                 downloads_path, headless,
                 proxy_string, proxy_auth, proxy_user, proxy_pass, user_agent,
-                disable_csp, enable_sync, no_sandbox, disable_gpu, incognito,
+                disable_csp, enable_sync, no_sandbox, disable_gpu,
+                incognito, guest_mode, devtools,
                 user_data_dir, extension_zip, extension_dir, servername,
                 mobile_emulator, device_width, device_height,
                 device_pixel_ratio)
diff --git a/seleniumbase/fixtures/base_case.py b/seleniumbase/fixtures/base_case.py
@@ -1523,7 +1523,8 @@ def get_new_driver(self, browser=None, headless=None,
                        servername=None, port=None, proxy=None, agent=None,
                        switch_to=True, cap_file=None, disable_csp=None,
                        enable_sync=None, no_sandbox=None, disable_gpu=None,
-                       incognito=None, user_data_dir=None, extension_zip=None,
+                       incognito=None, guest_mode=None, devtools=None,
+                       user_data_dir=None, extension_zip=None,
                        extension_dir=None, is_mobile=False,
                        d_width=None, d_height=None, d_p_r=None):
         """ This method spins up an extra browser for tests that require
@@ -1543,6 +1544,8 @@ def get_new_driver(self, browser=None, headless=None,
             no_sandbox - the option to enable the "No-Sandbox" feature (Chrome)
             disable_gpu - the option to enable Chrome's "Disable GPU" feature
             incognito - the option to enable Chrome's Incognito mode (Chrome)
+            guest - the option to enable Chrome's Guest mode (Chrome)
+            devtools - the option to open Chrome's DevTools on start (Chrome)
             user_data_dir - Chrome's User Data Directory to use (Chrome-only)
             extension_zip - A Chrome Extension ZIP file to use (Chrome-only)
             extension_dir - A Chrome Extension folder to use (Chrome-only)
@@ -1601,6 +1604,10 @@ def get_new_driver(self, browser=None, headless=None,
             disable_gpu = self.disable_gpu
         if incognito is None:
             incognito = self.incognito
+        if guest_mode is None:
+            guest_mode = self.guest_mode
+        if devtools is None:
+            devtools = self.devtools
         if user_data_dir is None:
             user_data_dir = self.user_data_dir
         if extension_zip is None:
@@ -1639,6 +1646,8 @@ def get_new_driver(self, browser=None, headless=None,
                                                  no_sandbox=no_sandbox,
                                                  disable_gpu=disable_gpu,
                                                  incognito=incognito,
+                                                 guest_mode=guest_mode,
+                                                 devtools=devtools,
                                                  user_data_dir=user_data_dir,
                                                  extension_zip=extension_zip,
                                                  extension_dir=extension_dir,
@@ -4532,6 +4541,8 @@ def setUp(self, masterqa_mode=False):
             self.no_sandbox = sb_config.no_sandbox
             self.disable_gpu = sb_config.disable_gpu
             self.incognito = sb_config.incognito
+            self.guest_mode = sb_config.guest_mode
+            self.devtools = sb_config.devtools
             self.user_data_dir = sb_config.user_data_dir
             self.extension_zip = sb_config.extension_zip
             self.extension_dir = sb_config.extension_dir
@@ -4687,6 +4698,8 @@ def setUp(self, masterqa_mode=False):
                                               no_sandbox=self.no_sandbox,
                                               disable_gpu=self.disable_gpu,
                                               incognito=self.incognito,
+                                              guest_mode=self.guest_mode,
+                                              devtools=self.devtools,
                                               user_data_dir=self.user_data_dir,
                                               extension_zip=self.extension_zip,
                                               extension_dir=self.extension_dir,
diff --git a/seleniumbase/plugins/pytest_plugin.py b/seleniumbase/plugins/pytest_plugin.py
@@ -42,10 +42,12 @@ def pytest_addoption(parser):
     --disable-csp  (This disables the Content Security Policy of websites.)
     --enable-sync  (The option to enable "Chrome Sync".)
     --no-sandbox  (The option to enable Chrome's "No-Sandbox" feature.)
-    --disable_gpu  (The option to enable Chrome's "Disable GPU" feature.)
+    --disable-gpu  (The option to enable Chrome's "Disable GPU" feature.)
     --incognito  (The option to enable Chrome's Incognito mode.)
+    --guest  (The option to enable Chrome's Guest mode.)
+    --devtools  (The option to open Chrome's DevTools when the browser opens.)
     --reuse-session  (The option to reuse the browser session between tests.)
-    --maximize-window  (The option to start with the web browser maximized.)
+    --maximize  (The option to start with the web browser maximized.)
     --save-screenshot  (The option to save a screenshot after each test.)
     --visual-baseline  (Set the visual baseline for Visual/Layout tests.)
     --timeout-multiplier=MULTIPLIER  (Multiplies the default timeout values.)
@@ -331,11 +333,21 @@ def pytest_addoption(parser):
                      dest='disable_gpu',
                      default=False,
                      help="""Using this enables the "Disable GPU" feature.""")
-    parser.addoption('--incognito',
+    parser.addoption('--incognito', '--incognito_mode', '--incognito-mode',
                      action="store_true",
                      dest='incognito',
                      default=False,
                      help="""Using this enables Chrome's Incognito mode.""")
+    parser.addoption('--guest', '--guest_mode', '--guest-mode',
+                     action="store_true",
+                     dest='guest_mode',
+                     default=False,
+                     help="""Using this enables Chrome's Guest mode.""")
+    parser.addoption('--devtools', '--open_devtools', '--open-devtools',
+                     action="store_true",
+                     dest='devtools',
+                     default=False,
+                     help="""Using this opens Chrome's DevTools.""")
     parser.addoption('--reuse_session', '--reuse-session',
                      action="store_true",
                      dest='reuse_session',
@@ -422,6 +434,8 @@ def pytest_configure(config):
     sb_config.no_sandbox = config.getoption('no_sandbox')
     sb_config.disable_gpu = config.getoption('disable_gpu')
     sb_config.incognito = config.getoption('incognito')
+    sb_config.guest_mode = config.getoption('guest_mode')
+    sb_config.devtools = config.getoption('devtools')
     sb_config.reuse_session = config.getoption('reuse_session')
     sb_config.shared_driver = None  # The default driver for session reuse
     sb_config.maximize_option = config.getoption('maximize_option')
diff --git a/seleniumbase/plugins/selenium_plugin.py b/seleniumbase/plugins/selenium_plugin.py
@@ -38,6 +38,8 @@ class SeleniumBrowser(Plugin):
     --no-sandbox  (The option to enable Chrome's "No-Sandbox" feature.)
     --disable_gpu  (The option to enable Chrome's "Disable GPU" feature.)
     --incognito  (The option to enable Chrome's Incognito mode.)
+    --guest  (The option to enable Chrome's Guest mode.)
+    --devtools  (The option to open Chrome's DevTools when the browser opens.)
     --maximize-window  (The option to start with the web browser maximized.)
     --save-screenshot  (The option to save a screenshot after each test.)
     --visual-baseline  (Set the visual baseline for Visual/Layout tests.)
@@ -265,11 +267,23 @@ def options(self, parser, env):
             default=False,
             help="""Using this enables the "Disable GPU" feature.""")
         parser.add_option(
-            '--incognito',
+            '--incognito', '--incognito_mode', '--incognito-mode',
             action="store_true",
             dest='incognito',
             default=False,
             help="""Using this enables Chrome's Incognito mode.""")
+        parser.add_option(
+            '--guest', '--guest_mode', '--guest-mode',
+            action="store_true",
+            dest='guest_mode',
+            default=False,
+            help="""Using this enables Chrome's Guest mode.""")
+        parser.add_option(
+            '--devtools', '--open_devtools', '--open-devtools',
+            action="store_true",
+            dest='devtools',
+            default=False,
+            help="""Using this opens Chrome's DevTools.""")
         parser.add_option(
             '--maximize_window', '--maximize-window', '--maximize',
             '--fullscreen',
@@ -338,6 +352,8 @@ def beforeTest(self, test):
         test.test.no_sandbox = self.options.no_sandbox
         test.test.disable_gpu = self.options.disable_gpu
         test.test.incognito = self.options.incognito
+        test.test.guest_mode = self.options.guest_mode
+        test.test.devtools = self.options.devtools
         test.test.maximize_option = self.options.maximize_option
         test.test.save_screenshot_after_test = self.options.save_screenshot
         test.test.visual_baseline = self.options.visual_baseline
diff --git a/setup.py b/setup.py
@@ -45,7 +45,7 @@
 
 setup(
     name='seleniumbase',
-    version='1.37.2',
+    version='1.37.3',
     description='Fast, Easy, and Reliable Browser Automation & Testing.',
     long_description=long_description,
     long_description_content_type='text/markdown',
@@ -90,7 +90,7 @@
         'ipdb',
         'idna==2.9',  # Must stay in sync with "requests"
         'chardet==3.0.4',  # Must stay in sync with "requests"
-        'urllib3==1.25.8',  # Must stay in sync with "requests"
+        'urllib3==1.25.9',  # Must stay in sync with "requests"
         'requests==2.23.0',
         'selenium==3.141.0',
         'pluggy==0.13.1',
