Merge pull request #1543 from seleniumbase/add-option-to-disable-js

Add option to disable JavaScript in tests

Author: mdmintz

README.md

@@ -522,10 +522,11 @@ pytest my_first_test.py --pdb
 --rec-behave  # (Same as Recorder Mode, but also generates behave-gherkin.)
 --rec-sleep  # (If the Recorder is enabled, also records self.sleep calls.)
 --rec-print  # (If the Recorder is enabled, prints output after tests end.)
+--disable-js  # (Disable JavaScript on websites. Pages might break!)
 --disable-csp  # (Disable the Content Security Policy of websites.)
 --disable-ws  # (Disable Web Security on Chromium-based browsers.)
 --enable-ws  # (Enable Web Security on Chromium-based browsers.)
---enable-sync  # (Enable "Chrome Sync".)
+--enable-sync  # (Enable "Chrome Sync" on websites.)
 --use-auto-ext  # (Use Chrome's automation extension.)
 --undetected | --uc  # (Use undetected-chromedriver to evade bot-detection.)
 --remote-debug  # (Enable Chrome's Remote Debugger on http://localhost:9222)

examples/raw_parameter_script.py

@@ -67,6 +67,7 @@
     sb.use_auto_ext = False
     sb.undetectable = False
     sb.no_sandbox = False
+    sb.disable_js = False
     sb.disable_gpu = False
     sb._multithreaded = False
     sb._reuse_session = False

help_docs/customizing_test_runs.md

@@ -156,10 +156,11 @@ pytest my_first_test.py --settings-file=custom_settings.py
 --rec-behave  # (Same as Recorder Mode, but also generates behave-gherkin.)
 --rec-sleep  # (If the Recorder is enabled, also records self.sleep calls.)
 --rec-print  # (If the Recorder is enabled, prints output after tests end.)
+--disable-js  # (Disable JavaScript on websites. Pages might break!)
 --disable-csp  # (Disable the Content Security Policy of websites.)
 --disable-ws  # (Disable Web Security on Chromium-based browsers.)
 --enable-ws  # (Enable Web Security on Chromium-based browsers.)
---enable-sync  # (Enable "Chrome Sync".)
+--enable-sync  # (Enable "Chrome Sync" on websites.)
 --use-auto-ext  # (Use Chrome's automation extension.)
 --undetected | --uc  # (Use undetected-chromedriver to evade bot-detection.)
 --remote-debug  # (Enable Chrome's Remote Debugger on http://localhost:9222)

seleniumbase/__version__.py

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "4.5.4"
+__version__ = "4.5.5"

seleniumbase/behave/behave_sb.py

@@ -66,6 +66,7 @@
 -D rec-behave  (Same as Recorder Mode, but also generates behave-gherkin.)
 -D rec-sleep  (If the Recorder is enabled, also records self.sleep calls.)
 -D rec-print  (If the Recorder is enabled, prints output after tests end.)
+-D disable-js  (Disable JavaScript on Chromium. May break websites!)
 -D disable-csp  (Disable the Content Security Policy of websites.)
 -D disable-ws  (Disable Web Security on Chromium-based browsers.)
 -D enable-ws  (Enable Web Security on Chromium-based browsers.)
@@ -161,6 +162,7 @@ def get_configured_sb(context):
     sb.database_env = "test"
     sb.log_path = "latest_logs" + os.sep
     sb.archive_logs = False
+    sb.disable_js = False
     sb.disable_csp = False
     sb.disable_ws = False
     sb.enable_ws = False
@@ -471,6 +473,10 @@ def get_configured_sb(context):
         if low_key in ["archive-logs", "archive_logs"]:
             sb.archive_logs = True
             continue
+        # Handle: -D disable-js / disable_js
+        if low_key in ["disable-js", "disable_js"]:
+            sb.disable_js = True
+            continue
         # Handle: -D disable-csp / disable_csp
         if low_key in ["disable-csp", "disable_csp"]:
             sb.disable_csp = True
@@ -821,6 +827,8 @@ def get_configured_sb(context):
     sb_config.pdb_option = sb.pdb_option
     sb_config.rec_behave = sb.rec_behave
     sb_config.rec_print = sb.rec_print
+    sb_config.disable_js = sb.disable_js
+    sb_config.disable_csp = sb.disable_csp
     sb_config.record_sleep = sb.record_sleep
     sb_config._is_timeout_changed = False
     sb_config._SMALL_TIMEOUT = settings.SMALL_TIMEOUT

seleniumbase/core/browser_launcher.py

@@ -348,6 +348,7 @@ def _set_chrome_options(
     proxy_pac_url,
     user_agent,
     recorder_ext,
+    disable_js,
     disable_csp,
     enable_ws,
     enable_sync,
@@ -405,6 +406,8 @@ def _set_chrome_options(
         prefs["intl.accept_languages"] = locale_code
     if block_images:
         prefs["profile.managed_default_content_settings.images"] = 2
+    if disable_js:
+        prefs["profile.managed_default_content_settings.javascript"] = 2
     if do_not_track:
         prefs["enable_do_not_track"] = True
     if external_pdf:
@@ -660,6 +663,7 @@ def _set_firefox_options(
     proxy_bypass_list,
     proxy_pac_url,
     user_agent,
+    disable_js,
     disable_csp,
     firefox_arg,
     firefox_pref,
@@ -732,6 +736,8 @@ def _set_firefox_options(
         "security.mixed_content.block_active_content", False
     )
     options.set_preference("security.warn_submit_insecure", False)
+    if disable_js:
+        options.set_preference("javascript.enabled", False)
     if settings.DISABLE_CSP_ON_FIREFOX or disable_csp:
         options.set_preference("security.csp.enable", False)
     options.set_preference(
@@ -883,6 +889,7 @@ def get_driver(
     cap_file=None,
     cap_string=None,
     recorder_ext=False,
+    disable_js=False,
     disable_csp=False,
     enable_ws=False,
     enable_sync=False,
@@ -980,6 +987,7 @@ def get_driver(
         headless
         and (
             proxy_auth
+            or disable_js
             or ad_block_on
             or disable_csp
             or recorder_ext
@@ -1032,6 +1040,7 @@ def get_driver(
             cap_file,
             cap_string,
             recorder_ext,
+            disable_js,
             disable_csp,
             enable_ws,
             enable_sync,
@@ -1076,6 +1085,7 @@ def get_driver(
             proxy_pac_url,
             user_agent,
             recorder_ext,
+            disable_js,
             disable_csp,
             enable_ws,
             enable_sync,
@@ -1124,6 +1134,7 @@ def get_remote_driver(
     cap_file,
     cap_string,
     recorder_ext,
+    disable_js,
     disable_csp,
     enable_ws,
     enable_sync,
@@ -1222,6 +1233,7 @@ def get_remote_driver(
             proxy_pac_url,
             user_agent,
             recorder_ext,
+            disable_js,
             disable_csp,
             enable_ws,
             enable_sync,
@@ -1314,6 +1326,7 @@ def get_remote_driver(
             proxy_bypass_list,
             proxy_pac_url,
             user_agent,
+            disable_js,
             disable_csp,
             firefox_arg,
             firefox_pref,
@@ -1448,6 +1461,7 @@ def get_remote_driver(
             proxy_pac_url,
             user_agent,
             recorder_ext,
+            disable_js,
             disable_csp,
             enable_ws,
             enable_sync,
@@ -1641,6 +1655,7 @@ def get_local_driver(
     proxy_pac_url,
     user_agent,
     recorder_ext,
+    disable_js,
     disable_csp,
     enable_ws,
     enable_sync,
@@ -1685,6 +1700,7 @@ def get_local_driver(
             proxy_bypass_list,
             proxy_pac_url,
             user_agent,
+            disable_js,
             disable_csp,
             firefox_arg,
             firefox_pref,
@@ -1930,6 +1946,8 @@ def get_local_driver(
             prefs["intl.accept_languages"] = locale_code
         if block_images:
             prefs["profile.managed_default_content_settings.images"] = 2
+        if disable_js:
+            prefs["profile.managed_default_content_settings.javascript"] = 2
         if do_not_track:
             prefs["enable_do_not_track"] = True
         if external_pdf:
@@ -2236,6 +2254,7 @@ def get_local_driver(
                 proxy_pac_url,
                 user_agent,
                 recorder_ext,
+                disable_js,
                 disable_csp,
                 enable_ws,
                 enable_sync,
@@ -2297,6 +2316,7 @@ def get_local_driver(
                 proxy_pac_url,
                 user_agent,
                 recorder_ext,
+                disable_js,
                 disable_csp,
                 enable_ws,
                 enable_sync,
@@ -2674,6 +2694,7 @@ def get_local_driver(
                         proxy_pac_url,
                         user_agent,
                         recorder_ext,
+                        disable_js,
                         disable_csp,
                         enable_ws,
                         enable_sync,

seleniumbase/fixtures/base_case.py

@@ -3164,6 +3164,7 @@ def get_new_driver(
         cap_file=None,
         cap_string=None,
         recorder_ext=None,
+        disable_js=None,
         disable_csp=None,
         enable_ws=None,
         enable_sync=None,
@@ -3211,6 +3212,7 @@ def get_new_driver(
         cap_file - the file containing desired capabilities for the browser
         cap_string - the string with desired capabilities for the browser
         recorder_ext - the option to enable the SBase Recorder extension
+        disable_js - the option to disable JavaScript (May break websites!)
         disable_csp - an option to disable Chrome's Content Security Policy
         enable_ws - the option to enable the Web Security feature (Chrome)
         enable_sync - the option to enable the Chrome Sync feature (Chrome)
@@ -3298,6 +3300,8 @@ def get_new_driver(
             user_agent = self.user_agent
         if recorder_ext is None:
             recorder_ext = self.recorder_ext
+        if disable_js is None:
+            disable_js = self.disable_js
         if disable_csp is None:
             disable_csp = self.disable_csp
         if enable_ws is None:
@@ -3383,6 +3387,7 @@ def get_new_driver(
             cap_file=cap_file,
             cap_string=cap_string,
             recorder_ext=recorder_ext,
+            disable_js=disable_js,
             disable_csp=disable_csp,
             enable_ws=enable_ws,
             enable_sync=enable_sync,
@@ -12645,6 +12650,7 @@ def setUp(self, masterqa_mode=False):
             elif self.record_sleep and not self.recorder_mode:
                 self.recorder_mode = True
                 self.recorder_ext = True
+            self.disable_js = sb_config.disable_js
             self.disable_csp = sb_config.disable_csp
             self.disable_ws = sb_config.disable_ws
             self.enable_ws = sb_config.enable_ws
@@ -12938,6 +12944,7 @@ def setUp(self, masterqa_mode=False):
                 cap_file=self.cap_file,
                 cap_string=self.cap_string,
                 recorder_ext=self.recorder_ext,
+                disable_js=self.disable_js,
                 disable_csp=self.disable_csp,
                 enable_ws=self.enable_ws,
                 enable_sync=self.enable_sync,

seleniumbase/plugins/pytest_plugin.py

@@ -84,10 +84,11 @@ def pytest_addoption(parser):
     --rec-behave  (Same as Recorder Mode, but also generates behave-gherkin.)
     --rec-sleep  (If the Recorder is enabled, also records self.sleep calls.)
     --rec-print  (If the Recorder is enabled, prints output after tests end.)
+    --disable-js  (Disable JavaScript on websites. Pages might break!)
     --disable-csp  (Disable the Content Security Policy of websites.)
     --disable-ws  (Disable Web Security on Chromium-based browsers.)
     --enable-ws  (Enable Web Security on Chromium-based browsers.)
-    --enable-sync  (Enable "Chrome Sync".)
+    --enable-sync  (Enable "Chrome Sync" on websites.)
     --use-auto-ext  (Use Chrome's automation extension.)
     --undetected | --uc  (Use undetected-chromedriver to evade bot-detection.)
     --remote-debug  (Enable Chrome's Remote Debugger on http://localhost:9222)
@@ -834,6 +835,15 @@ def pytest_addoption(parser):
         help="""If Recorder Mode is enabled,
                 prints output after tests end.""",
     )
+    parser.addoption(
+        "--disable_js",
+        "--disable-js",
+        action="store_true",
+        dest="disable_js",
+        default=False,
+        help="""The option to disable JavaScript on web pages.
+                Warning: Most web pages will stop working!""",
+    )
     parser.addoption(
         "--disable_csp",
         "--disable-csp",
@@ -1344,6 +1354,7 @@ def pytest_configure(config):
     elif sb_config.record_sleep and not sb_config.recorder_mode:
         sb_config.recorder_mode = True
         sb_config.recorder_ext = True
+    sb_config.disable_js = config.getoption("disable_js")
     sb_config.disable_csp = config.getoption("disable_csp")
     sb_config.disable_ws = config.getoption("disable_ws")
     sb_config.enable_ws = config.getoption("enable_ws")
@@ -1363,9 +1374,9 @@ def pytest_configure(config):
     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.crumbs = config.getoption("crumbs")
     sb_config._disable_beforeunload = config.getoption("_disable_beforeunload")
-    sb_config.shared_driver = None  # The default driver for session reuse
     sb_config.window_size = config.getoption("window_size")
     sb_config.maximize_option = config.getoption("maximize_option")
     sb_config.save_screenshot = config.getoption("save_screenshot")

seleniumbase/plugins/selenium_plugin.py

@@ -62,10 +62,11 @@ class SeleniumBrowser(Plugin):
     --rec-behave  (Same as Recorder Mode, but also generates behave-gherkin.)
     --rec-sleep  (If the Recorder is enabled, also records self.sleep calls.)
     --rec-print  (If the Recorder is enabled, prints output after tests end.)
+    --disable-js  (Disable JavaScript on websites. Pages might break!)
     --disable-csp  (Disable the Content Security Policy of websites.)
     --disable-ws  (Disable Web Security on Chromium-based browsers.)
     --enable-ws  (Enable Web Security on Chromium-based browsers.)
-    --enable-sync  (Enable "Chrome Sync".)
+    --enable-sync  (Enable "Chrome Sync" on websites.)
     --use-auto-ext  (Use Chrome's automation extension.)
     --undetected | --uc  (Use undetected-chromedriver to evade bot-detection.)
     --remote-debug  (Enable Chrome's Remote Debugger on http://localhost:9222)
@@ -558,6 +559,15 @@ def options(self, parser, env):
             help="""If Recorder Mode is enabled,
                     prints output after tests end.""",
         )
+        parser.add_option(
+            "--disable_js",
+            "--disable-js",
+            action="store_true",
+            dest="disable_js",
+            default=False,
+            help="""The option to disable JavaScript on web pages.
+                    Warning: Most web pages will stop working!""",
+        )
         parser.add_option(
             "--disable_csp",
             "--disable-csp",
@@ -870,6 +880,7 @@ def beforeTest(self, test):
         elif self.options.record_sleep:
             test.test.recorder_mode = True
             test.test.recorder_ext = True
+        test.test.disable_js = self.options.disable_js
         test.test.disable_csp = self.options.disable_csp
         test.test.disable_ws = self.options.disable_ws
         test.test.enable_ws = self.options.enable_ws