Add options to set custom Firefox args and preferences

Author: mdmintz

seleniumbase/core/browser_launcher.py

@@ -375,6 +375,8 @@ def _set_firefox_options(
     proxy_string,
     user_agent,
     disable_csp,
+    firefox_arg,
+    firefox_pref,
 ):
     options = webdriver.FirefoxOptions()
     options.accept_untrusted_certs = True
@@ -466,6 +468,51 @@ def _set_firefox_options(
             "vnd.openxmlformats-officedocument.spreadsheetml.sheet"
         ),
     )
+    if firefox_arg:
+        # Can be a comma-separated list of Firefox args
+        firefox_arg_list = firefox_arg.split(",")
+        for firefox_arg_item in firefox_arg_list:
+            firefox_arg_item = firefox_arg_item.strip()
+            if not firefox_arg_item.startswith("--"):
+                if firefox_arg_item.startswith("-"):
+                    firefox_arg_item = "-" + firefox_arg_item
+                else:
+                    firefox_arg_item = "--" + firefox_arg_item
+            if len(firefox_arg_item) >= 3:
+                options.add_argument(firefox_arg_item)
+    if firefox_pref:
+        # Can be a comma-separated list of Firefox preference:value pairs
+        firefox_pref_list = firefox_pref.split(",")
+        for firefox_pref_item in firefox_pref_list:
+            f_pref = None
+            f_pref_value = None
+            needs_conversion = False
+            if firefox_pref_item.count(":") == 0:
+                f_pref = firefox_pref_item
+                f_pref_value = True
+            elif firefox_pref_item.count(":") == 1:
+                f_pref = firefox_pref_item.split(":")[0]
+                f_pref_value = firefox_pref_item.split(":")[1]
+                needs_conversion = True
+            else:  # More than one ":" in the set. (Too many!)
+                raise Exception(
+                    'Incorrect formatting for Firefox "pref:value" set!'
+                )
+            f_pref = firefox_pref_item.strip()
+            if needs_conversion:
+                f_pref_value = firefox_pref_item.strip()
+                if f_pref_value.lower == "true" or len(f_pref_value) == 0:
+                    f_pref_value = True
+                elif f_pref_value.lower == "false":
+                    f_pref_value = False
+                elif f_pref_value.isdigit():
+                    f_pref_value = int(f_pref_value)
+                elif f_pref_value.isdecimal():
+                    f_pref_value = float(f_pref_value)
+                else:
+                    pass  # keep as string
+            if len(f_pref) >= 1:
+                options.set_preference(f_pref, f_pref_value)
     return options
 
 
@@ -556,6 +603,8 @@ def get_driver(
     swiftshader=None,
     block_images=None,
     chromium_arg=None,
+    firefox_arg=None,
+    firefox_pref=None,
     user_data_dir=None,
     extension_zip=None,
     extension_dir=None,
@@ -626,6 +675,8 @@ def get_driver(
             swiftshader,
             block_images,
             chromium_arg,
+            firefox_arg,
+            firefox_pref,
             user_data_dir,
             extension_zip,
             extension_dir,
@@ -659,6 +710,8 @@ def get_driver(
             swiftshader,
             block_images,
             chromium_arg,
+            firefox_arg,
+            firefox_pref,
             user_data_dir,
             extension_zip,
             extension_dir,
@@ -696,6 +749,8 @@ def get_remote_driver(
     swiftshader,
     block_images,
     chromium_arg,
+    firefox_arg,
+    firefox_pref,
     user_data_dir,
     extension_zip,
     extension_dir,
@@ -783,6 +838,8 @@ def get_remote_driver(
             proxy_string,
             user_agent,
             disable_csp,
+            firefox_arg,
+            firefox_pref,
         )
         capabilities = firefox_options.to_capabilities()
         capabilities["marionette"] = True
@@ -907,6 +964,8 @@ def get_local_driver(
     swiftshader,
     block_images,
     chromium_arg,
+    firefox_arg,
+    firefox_pref,
     user_data_dir,
     extension_zip,
     extension_dir,
@@ -929,6 +988,8 @@ def get_local_driver(
             proxy_string,
             user_agent,
             disable_csp,
+            firefox_arg,
+            firefox_pref,
         )
         if LOCAL_GECKODRIVER and os.path.exists(LOCAL_GECKODRIVER):
             try:

seleniumbase/fixtures/base_case.py

@@ -2227,10 +2227,12 @@ def get_new_driver(
         swiftshader=None,
         block_images=None,
         chromium_arg=None,
+        firefox_arg=None,
+        firefox_pref=None,
         user_data_dir=None,
         extension_zip=None,
         extension_dir=None,
-        is_mobile=False,
+        is_mobile=None,
         d_width=None,
         d_height=None,
         d_p_r=None,
@@ -2263,6 +2265,8 @@ def get_new_driver(
         swiftshader - the option to use Chrome's swiftshader (Chrome-only)
         block_images - the option to block images from loading (Chrome)
         chromium_arg - the option to add a Chromium arg to Chrome/Edge
+        firefox_arg - the option to add a Firefox arg to Firefox runs
+        firefox_pref - the option to add a Firefox pref:value set (Firefox)
         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)
@@ -2346,6 +2350,10 @@ def get_new_driver(
             block_images = self.block_images
         if chromium_arg is None:
             chromium_arg = self.chromium_arg
+        if firefox_arg is None:
+            firefox_arg = self.firefox_arg
+        if firefox_pref is None:
+            firefox_pref = self.firefox_pref
         if user_data_dir is None:
             user_data_dir = self.user_data_dir
         if extension_zip is None:
@@ -2358,7 +2366,7 @@ def get_new_driver(
         if cap_string is None:
             cap_string = self.cap_string
         if is_mobile is None:
-            is_mobile = False
+            is_mobile = self.mobile_emulator
         if d_width is None:
             d_width = self.__device_width
         if d_height is None:
@@ -2399,6 +2407,8 @@ def get_new_driver(
             swiftshader=swiftshader,
             block_images=block_images,
             chromium_arg=chromium_arg,
+            firefox_arg=firefox_arg,
+            firefox_pref=firefox_pref,
             user_data_dir=user_data_dir,
             extension_zip=extension_zip,
             extension_dir=extension_dir,
@@ -8388,6 +8398,8 @@ def setUp(self, masterqa_mode=False):
             self.ad_block_on = sb_config.ad_block_on
             self.block_images = sb_config.block_images
             self.chromium_arg = sb_config.chromium_arg
+            self.firefox_arg = sb_config.firefox_arg
+            self.firefox_pref = sb_config.firefox_pref
             self.verify_delay = sb_config.verify_delay
             self.disable_csp = sb_config.disable_csp
             self.disable_ws = sb_config.disable_ws
@@ -8631,6 +8643,8 @@ def setUp(self, masterqa_mode=False):
                 swiftshader=self.swiftshader,
                 block_images=self.block_images,
                 chromium_arg=self.chromium_arg,
+                firefox_arg=self.firefox_arg,
+                firefox_pref=self.firefox_pref,
                 user_data_dir=self.user_data_dir,
                 extension_zip=self.extension_zip,
                 extension_dir=self.extension_dir,

seleniumbase/plugins/pytest_plugin.py

@@ -44,6 +44,8 @@ def pytest_addoption(parser):
     --mobile  (Use the mobile device emulator while running tests.)
     --metrics=STRING  (Set mobile metrics: "CSSWidth,CSSHeight,PixelRatio".)
     --chromium-arg=ARG  (Add a Chromium arg for Chrome/Edge, comma-separated.)
+    --firefox-arg=ARG  (Add a Firefox arg for Firefox, comma-separated.)
+    --firefox-pref=SET  (Set a Firefox preference:value set, comma-separated.)
     --extension-zip=ZIP  (Load a Chrome Extension .zip|.crx, comma-separated.)
     --extension-dir=DIR  (Load a Chrome Extension directory, comma-separated.)
     --headless  (Run tests headlessly. Default mode on Linux OS.)
@@ -422,6 +424,35 @@ def pytest_addoption(parser):
                 added to the beginning of the arg automatically.
                 Default: None.""",
     )
+    parser.addoption(
+        "--firefox_arg",
+        "--firefox-arg",
+        action="store",
+        dest="firefox_arg",
+        default=None,
+        help="""Add a Firefox argument for Firefox browser runs.
+                Format: A comma-separated list of Firefox args.
+                If an arg doesn't start with "--", that will be
+                added to the beginning of the arg automatically.
+                Default: None.""",
+    )
+    parser.addoption(
+        "--firefox_pref",
+        "--firefox-pref",
+        action="store",
+        dest="firefox_pref",
+        default=None,
+        help="""Set a Firefox preference:value combination.
+                Format: A comma-separated list of pref:value items.
+                Example usage:
+                    --firefox-pref="browser.formfill.enable:True"
+                    --firefox-pref="pdfjs.disabled:False"
+                    --firefox-pref="abc.def.xyz:42,hello.world:text"
+                Boolean and integer values to the right of the ":"
+                will be automatically converted into proper format.
+                If there's no ":" in the string, then True is used.
+                Default: None.""",
+    )
     parser.addoption(
         "--extension_zip",
         "--extension-zip",
@@ -916,6 +947,8 @@ def pytest_configure(config):
     sb_config.interval = config.getoption("interval")
     sb_config.start_page = config.getoption("start_page")
     sb_config.chromium_arg = config.getoption("chromium_arg")
+    sb_config.firefox_arg = config.getoption("firefox_arg")
+    sb_config.firefox_pref = config.getoption("firefox_pref")
     sb_config.extension_zip = config.getoption("extension_zip")
     sb_config.extension_dir = config.getoption("extension_dir")
     sb_config.with_testing_base = config.getoption("with_testing_base")

seleniumbase/plugins/selenium_plugin.py

@@ -25,6 +25,8 @@ class SeleniumBrowser(Plugin):
     --mobile  (Use the mobile device emulator while running tests.)
     --metrics=STRING  (Set mobile metrics: "CSSWidth,CSSHeight,PixelRatio".)
     --chromium-arg=ARG  (Add a Chromium arg for Chrome/Edge, comma-separated.)
+    --firefox-arg=ARG  (Add a Firefox arg for Firefox, comma-separated.)
+    --firefox-pref=SET  (Set a Firefox preference:value set, comma-separated.)
     --extension-zip=ZIP  (Load a Chrome Extension .zip|.crx, comma-separated.)
     --extension-dir=DIR  (Load a Chrome Extension directory, comma-separated.)
     --headless  (Run tests headlessly. Default mode on Linux OS.)
@@ -199,6 +201,35 @@ def options(self, parser, env):
                     added to the beginning of the arg automatically.
                     Default: None.""",
         )
+        parser.add_option(
+            "--firefox_arg",
+            "--firefox-arg",
+            action="store",
+            dest="firefox_arg",
+            default=None,
+            help="""Add a Firefox argument for Firefox browser runs.
+                    Format: A comma-separated list of Firefox args.
+                    If an arg doesn't start with "--", that will be
+                    added to the beginning of the arg automatically.
+                    Default: None.""",
+        )
+        parser.add_option(
+            "--firefox_pref",
+            "--firefox-pref",
+            action="store",
+            dest="firefox_pref",
+            default=None,
+            help="""Set a Firefox preference:value combination.
+                    Format: A comma-separated list of pref:value items.
+                    Example usage:
+                        --firefox-pref="browser.formfill.enable:True"
+                        --firefox-pref="pdfjs.disabled:False"
+                        --firefox-pref="abc.def.xyz:42,hello.world:text"
+                    Boolean and integer values to the right of the ":"
+                    will be automatically converted into proper format.
+                    If there's no ":" in the string, then True is used.
+                    Default: None.""",
+        )
         parser.add_option(
             "--extension_zip",
             "--extension-zip",
@@ -552,6 +583,8 @@ def beforeTest(self, test):
         test.test.extension_zip = self.options.extension_zip
         test.test.extension_dir = self.options.extension_dir
         test.test.chromium_arg = self.options.chromium_arg
+        test.test.firefox_arg = self.options.firefox_arg
+        test.test.firefox_pref = self.options.firefox_pref
         test.test.proxy_string = self.options.proxy_string
         test.test.user_agent = self.options.user_agent
         test.test.mobile_emulator = self.options.mobile_emulator