Merge pull request #621 from seleniumbase/swiftshader-command-line-option

mdmintz · web-flow · commit 4551dad22ff4 · 2020-07-10T21:26:58.000-04:00
Add the "--swiftshader" command-line option
diff --git a/README.md b/README.md
@@ -326,6 +326,7 @@ SeleniumBase provides additional Pytest command-line options for tests:
 --disable-csp  # (This disables the Content Security Policy of websites.)
 --enable-sync  # (The option to enable "Chrome Sync".)
 --use-auto-ext  # (The option to use Chrome's automation extension.)
+--swiftshader  # (The option to use Chrome's "--use-gl=swiftshader" 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.)
diff --git a/examples/raw_parameter_script.py b/examples/raw_parameter_script.py
@@ -71,6 +71,7 @@
     sb.settings_file = None
     sb.user_data_dir = None
     sb.proxy_string = None
+    sb.swiftshader = False
     sb.ad_block_on = False
     sb.highlights = None
     sb.check_js = False
diff --git a/help_docs/customizing_test_runs.md b/help_docs/customizing_test_runs.md
@@ -123,6 +123,7 @@ SeleniumBase provides additional Pytest command-line options for tests:
 --disable-csp  # (This disables the Content Security Policy of websites.)
 --enable-sync  # (The option to enable "Chrome Sync".)
 --use-auto-ext  # (The option to use Chrome's automation extension.)
+--swiftshader  # (The option to use Chrome's "--use-gl=swiftshader" 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.)
diff --git a/seleniumbase/core/browser_launcher.py b/seleniumbase/core/browser_launcher.py
@@ -132,8 +132,8 @@ def _set_chrome_options(
         downloads_path, headless,
         proxy_string, proxy_auth, proxy_user, proxy_pass,
         user_agent, disable_csp, enable_sync, use_auto_ext,
-        no_sandbox, disable_gpu, incognito, guest_mode, devtools, block_images,
-        user_data_dir, extension_zip, extension_dir, servername,
+        no_sandbox, disable_gpu, incognito, guest_mode, devtools, swiftshader,
+        block_images, user_data_dir, extension_zip, extension_dir, servername,
         mobile_emulator, device_width, device_height, device_pixel_ratio):
     chrome_options = webdriver.ChromeOptions()
     prefs = {
@@ -236,9 +236,10 @@ def _set_chrome_options(
             chrome_options.add_argument("--headless")
     # if headless or disable_gpu:
     chrome_options.add_argument("--disable-gpu")  # (Now always on)
-    chrome_options.add_argument("--use-gl=swiftshader")
     # if (headless and "linux" in PLATFORM) or no_sandbox:
     chrome_options.add_argument("--no-sandbox")  # (Now always on)
+    if swiftshader:
+        chrome_options.add_argument("--use-gl=swiftshader")
     if "linux" in PLATFORM:
         chrome_options.add_argument("--disable-dev-shm-usage")
     return chrome_options
@@ -361,7 +362,7 @@ def get_driver(browser_name, headless=False, use_grid=False,
                disable_csp=None, enable_sync=None, use_auto_ext=None,
                no_sandbox=None, disable_gpu=None,
                incognito=None, guest_mode=None, devtools=None,
-               block_images=None, user_data_dir=None,
+               swiftshader=None, block_images=None, user_data_dir=None,
                extension_zip=None, extension_dir=None,
                test_id=None, mobile_emulator=False, device_width=None,
                device_height=None, device_pixel_ratio=None):
@@ -400,14 +401,15 @@ def get_driver(browser_name, headless=False, use_grid=False,
             proxy_string, proxy_auth, proxy_user, proxy_pass, user_agent,
             cap_file, cap_string, disable_csp, enable_sync, use_auto_ext,
             no_sandbox, disable_gpu, incognito, guest_mode, devtools,
-            block_images, user_data_dir, extension_zip, extension_dir, test_id,
+            swiftshader, block_images, user_data_dir,
+            extension_zip, extension_dir, test_id,
             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, use_auto_ext, no_sandbox, disable_gpu,
-            incognito, guest_mode, devtools, block_images,
+            incognito, guest_mode, devtools, swiftshader, block_images,
             user_data_dir, extension_zip, extension_dir,
             mobile_emulator, device_width, device_height, device_pixel_ratio)
 
@@ -416,7 +418,7 @@ def get_remote_driver(
         browser_name, headless, servername, port, proxy_string, proxy_auth,
         proxy_user, proxy_pass, user_agent, cap_file, cap_string,
         disable_csp, enable_sync, use_auto_ext, no_sandbox, disable_gpu,
-        incognito, guest_mode, devtools, block_images,
+        incognito, guest_mode, devtools, swiftshader, block_images,
         user_data_dir, extension_zip, extension_dir, test_id,
         mobile_emulator, device_width, device_height, device_pixel_ratio):
     downloads_path = download_helper.get_downloads_folder()
@@ -448,7 +450,7 @@ def get_remote_driver(
             downloads_path, headless,
             proxy_string, proxy_auth, proxy_user, proxy_pass, user_agent,
             disable_csp, enable_sync, use_auto_ext, no_sandbox, disable_gpu,
-            incognito, guest_mode, devtools, block_images,
+            incognito, guest_mode, devtools, swiftshader, block_images,
             user_data_dir, extension_zip, extension_dir, servername,
             mobile_emulator, device_width, device_height, device_pixel_ratio)
         capabilities = chrome_options.to_capabilities()
@@ -572,7 +574,7 @@ def get_local_driver(
         browser_name, headless, servername,
         proxy_string, proxy_auth, proxy_user, proxy_pass, user_agent,
         disable_csp, enable_sync, use_auto_ext, no_sandbox, disable_gpu,
-        incognito, guest_mode, devtools, block_images,
+        incognito, guest_mode, devtools, swiftshader, block_images,
         user_data_dir, extension_zip, extension_dir,
         mobile_emulator, device_width, device_height, device_pixel_ratio):
     '''
@@ -663,7 +665,7 @@ def get_local_driver(
                 proxy_string, proxy_auth, proxy_user, proxy_pass, user_agent,
                 disable_csp, enable_sync, use_auto_ext,
                 no_sandbox, disable_gpu, incognito, guest_mode, devtools,
-                block_images, user_data_dir,
+                swiftshader, block_images, user_data_dir,
                 extension_zip, extension_dir, servername,
                 mobile_emulator, device_width, device_height,
                 device_pixel_ratio)
@@ -721,9 +723,9 @@ def get_local_driver(
                 proxy_string, proxy_auth, proxy_user, proxy_pass, user_agent,
                 disable_csp, enable_sync, use_auto_ext,
                 no_sandbox, disable_gpu, incognito, guest_mode, devtools,
-                block_images, user_data_dir, extension_zip, extension_dir,
-                servername, mobile_emulator, device_width, device_height,
-                device_pixel_ratio)
+                swiftshader, block_images, user_data_dir, extension_zip,
+                extension_dir, servername, mobile_emulator,
+                device_width, device_height, device_pixel_ratio)
             if LOCAL_CHROMEDRIVER and os.path.exists(LOCAL_CHROMEDRIVER):
                 try:
                     make_driver_executable_if_not(LOCAL_CHROMEDRIVER)
diff --git a/seleniumbase/fixtures/base_case.py b/seleniumbase/fixtures/base_case.py
@@ -1592,7 +1592,7 @@ def get_new_driver(self, browser=None, headless=None,
                        disable_csp=None, enable_sync=None, use_auto_ext=None,
                        no_sandbox=None, disable_gpu=None,
                        incognito=None, guest_mode=None, devtools=None,
-                       block_images=None, user_data_dir=None,
+                       swiftshader=None, block_images=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
@@ -1616,6 +1616,7 @@ def get_new_driver(self, browser=None, headless=None,
             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)
+            swiftshader  the option to use "--use-gl=swiftshader" (Chrome-only)
             block_images - the option to block images from loading (Chrome)
             user_data_dir - Chrome's User Data Directory to use (Chrome-only)
             extension_zip - A Chrome Extension ZIP file to use (Chrome-only)
@@ -1681,6 +1682,8 @@ def get_new_driver(self, browser=None, headless=None,
             guest_mode = self.guest_mode
         if devtools is None:
             devtools = self.devtools
+        if swiftshader is None:
+            swiftshader = self.swiftshader
         if block_images is None:
             block_images = self.block_images
         if user_data_dir is None:
@@ -1728,6 +1731,7 @@ def get_new_driver(self, browser=None, headless=None,
                                                  incognito=incognito,
                                                  guest_mode=guest_mode,
                                                  devtools=devtools,
+                                                 swiftshader=swiftshader,
                                                  block_images=block_images,
                                                  user_data_dir=user_data_dir,
                                                  extension_zip=extension_zip,
@@ -5283,6 +5287,7 @@ def setUp(self, masterqa_mode=False):
             self.incognito = sb_config.incognito
             self.guest_mode = sb_config.guest_mode
             self.devtools = sb_config.devtools
+            self.swiftshader = sb_config.swiftshader
             self.user_data_dir = sb_config.user_data_dir
             self.extension_zip = sb_config.extension_zip
             self.extension_dir = sb_config.extension_dir
@@ -5445,6 +5450,7 @@ def setUp(self, masterqa_mode=False):
                                               incognito=self.incognito,
                                               guest_mode=self.guest_mode,
                                               devtools=self.devtools,
+                                              swiftshader=self.swiftshader,
                                               block_images=self.block_images,
                                               user_data_dir=self.user_data_dir,
                                               extension_zip=self.extension_zip,
diff --git a/seleniumbase/plugins/pytest_plugin.py b/seleniumbase/plugins/pytest_plugin.py
@@ -47,6 +47,7 @@ def pytest_addoption(parser):
     --disable-csp  (This disables the Content Security Policy of websites.)
     --enable-sync  (The option to enable "Chrome Sync".)
     --use-auto-ext  (The option to use Chrome's automation extension.)
+    --swiftshader  (The option to use Chrome's "--use-gl=swiftshader" 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.)
@@ -377,6 +378,12 @@ def pytest_addoption(parser):
                      default=False,
                      help="""Using this enables the "Disable GPU" feature.
                           (This setting is now always enabled by default.)""")
+    parser.addoption('--swiftshader',
+                     action="store_true",
+                     dest='swiftshader',
+                     default=False,
+                     help="""Using this enables the "--use-gl=swiftshader"
+                          feature when running tests on Chrome.""")
     parser.addoption('--incognito', '--incognito_mode', '--incognito-mode',
                      action="store_true",
                      dest='incognito',
@@ -491,6 +498,7 @@ def pytest_configure(config):
     sb_config.use_auto_ext = config.getoption('use_auto_ext')
     sb_config.no_sandbox = config.getoption('no_sandbox')
     sb_config.disable_gpu = config.getoption('disable_gpu')
+    sb_config.swiftshader = config.getoption('swiftshader')
     sb_config.incognito = config.getoption('incognito')
     sb_config.guest_mode = config.getoption('guest_mode')
     sb_config.devtools = config.getoption('devtools')
diff --git a/seleniumbase/plugins/selenium_plugin.py b/seleniumbase/plugins/selenium_plugin.py
@@ -38,6 +38,7 @@ class SeleniumBrowser(Plugin):
     --disable-csp  (This disables the Content Security Policy of websites.)
     --enable-sync  (The option to enable "Chrome Sync".)
     --use-auto-ext  (The option to use Chrome's automation extension.)
+    --swiftshader  (The option to use Chrome's "--use-gl=swiftshader" 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.)
@@ -294,6 +295,13 @@ def options(self, parser, env):
             default=False,
             help="""Using this enables the "Disable GPU" feature.
                     (This setting is now always enabled by default.)""")
+        parser.add_option(
+            '--swiftshader',
+            action="store_true",
+            dest='swiftshader',
+            default=False,
+            help="""Using this enables the "--use-gl=swiftshader"
+                    feature when running tests on Chrome.""")
         parser.add_option(
             '--incognito', '--incognito_mode', '--incognito-mode',
             action="store_true",
@@ -382,6 +390,7 @@ def beforeTest(self, test):
         test.test.use_auto_ext = self.options.use_auto_ext
         test.test.no_sandbox = self.options.no_sandbox
         test.test.disable_gpu = self.options.disable_gpu
+        test.test.swiftshader = self.options.swiftshader
         test.test.incognito = self.options.incognito
         test.test.guest_mode = self.options.guest_mode
         test.test.devtools = self.options.devtools
diff --git a/setup.py b/setup.py
@@ -54,7 +54,7 @@
 
 setup(
     name='seleniumbase',
-    version='1.42.9',
+    version='1.42.10',
     description='Fast, Easy, and Reliable Browser Automation & Testing.',
     long_description=long_description,
     long_description_content_type='text/markdown',
