Merge pull request #413 from seleniumbase/slow-mode

Add "Slow Mode". Usage: "--slow"

Author: mdmintz

README.md

@@ -218,6 +218,7 @@ SeleniumBase provides additional Pytest command-line options for tests:
 --start_page=URL  # (The starting URL for the web browser when tests begin.)
 --log_path=LOG_PATH  # (The directory where log files get saved to.)
 --archive_logs  # (Archive old log files instead of deleting them.)
+--slow  # (The option to slow down the automation.)
 --demo  # (The option to visually see test actions as they occur.)
 --demo_sleep=SECONDS  # (The option to wait longer after Demo Mode actions.)
 --highlights=NUM  # (Number of highlight animations for Demo Mode actions.)

examples/raw_parameter_script.py

@@ -52,6 +52,7 @@
     sb.with_s3_logging = False
     sb.js_checking_on = False
     sb.is_pytest = False
+    sb.slow_mode = False
     sb.demo_mode = False
     sb.demo_sleep = 1
     sb.message_duration = 2

help_docs/customizing_test_runs.md

@@ -197,7 +197,8 @@ SeleniumBase provides additional Pytest command-line options for tests:
 --start_page=URL  # (The starting URL for the web browser when tests begin.)
 --log_path=LOG_PATH  # (The directory where log files get saved to.)
 --archive_logs  # (Archive old log files instead of deleting them.)
---demo_mode  # (The option to visually see test actions as they occur.)
+--slow  # (The option to slow down the automation.)
+--demo  # (The option to visually see test actions as they occur.)
 --demo_sleep=SECONDS  # (The option to wait longer after Demo Mode actions.)
 --highlights=NUM  # (Number of highlight animations for Demo Mode actions.)
 --message_duration=SECONDS  # (The time length for Messenger alerts.)

requirements.txt

@@ -2,7 +2,7 @@ pip>=19.3.1
 setuptools>=41.6.0
 setuptools-scm>=3.3.3
 wheel>=0.33.6
-six>=1.12.0
+six>=1.13.0
 nose>=1.3.7
 ipdb>=0.12.2
 idna==2.8

seleniumbase/fixtures/base_case.py

@@ -167,6 +167,8 @@ def click(self, selector, by=By.CSS_SELECTOR, timeout=None, delay=0):
                 self.__demo_mode_pause_if_active()
             else:
                 self.__demo_mode_pause_if_active(tiny=True)
+        elif self.slow_mode:
+            self.__slow_mode_pause_if_active()
 
     def slow_click(self, selector, by=By.CSS_SELECTOR, timeout=None):
         """ Similar to click(), but pauses for a brief moment before clicking.
@@ -221,6 +223,8 @@ def double_click(self, selector, by=By.CSS_SELECTOR, timeout=None):
                 self.__demo_mode_pause_if_active()
             else:
                 self.__demo_mode_pause_if_active(tiny=True)
+        elif self.slow_mode:
+            self.__slow_mode_pause_if_active()
 
     def click_chain(self, selectors_list, by=By.CSS_SELECTOR,
                     timeout=None, spacing=0):
@@ -338,6 +342,8 @@ def update_text(self, selector, new_value, by=By.CSS_SELECTOR,
                 self.__demo_mode_pause_if_active()
             else:
                 self.__demo_mode_pause_if_active(tiny=True)
+        elif self.slow_mode:
+            self.__slow_mode_pause_if_active()
 
     def add_text(self, selector, text, by=By.CSS_SELECTOR, timeout=None):
         """ The more-reliable version of driver.send_keys()
@@ -384,6 +390,8 @@ def add_text(self, selector, text, by=By.CSS_SELECTOR, timeout=None):
                 self.__demo_mode_pause_if_active()
             else:
                 self.__demo_mode_pause_if_active(tiny=True)
+        elif self.slow_mode:
+            self.__slow_mode_pause_if_active()
 
     def send_keys(self, selector, text, by=By.CSS_SELECTOR, timeout=None):
         """ Same as add_text() """
@@ -437,13 +445,15 @@ def go_back(self):
         if self.browser == "safari":
             self.driver.refresh()
         self.wait_for_ready_state_complete()
+        self.__demo_mode_pause_if_active()
 
     def go_forward(self):
         self.__last_page_load_url = None
         self.driver.forward()
         if self.browser == "safari":
             self.driver.refresh()
         self.wait_for_ready_state_complete()
+        self.__demo_mode_pause_if_active()
 
     def is_element_present(self, selector, by=By.CSS_SELECTOR):
         selector, by = self.__recalculate_selector(selector, by)
@@ -626,6 +636,8 @@ def click_link_text(self, link_text, timeout=None):
                 self.__demo_mode_pause_if_active()
             else:
                 self.__demo_mode_pause_if_active(tiny=True)
+        elif self.slow_mode:
+            self.__slow_mode_pause_if_active()
 
     def click_link(self, link_text, timeout=None):
         """ Same as self.click_link_text() """
@@ -738,6 +750,8 @@ def click_partial_link_text(self, partial_link_text, timeout=None):
                 self.__demo_mode_pause_if_active()
             else:
                 self.__demo_mode_pause_if_active(tiny=True)
+        elif self.slow_mode:
+            self.__slow_mode_pause_if_active()
 
     def get_text(self, selector, by=By.CSS_SELECTOR, timeout=None):
         if not timeout:
@@ -1094,6 +1108,8 @@ def hover_and_click(self, hover_selector, click_selector,
                 self.__demo_mode_pause_if_active()
             else:
                 self.__demo_mode_pause_if_active(tiny=True)
+        elif self.slow_mode:
+            self.__slow_mode_pause_if_active()
         return element
 
     def hover_and_double_click(self, hover_selector, click_selector,
@@ -1141,6 +1157,8 @@ def hover_and_double_click(self, hover_selector, click_selector,
                 self.__demo_mode_pause_if_active()
             else:
                 self.__demo_mode_pause_if_active(tiny=True)
+        elif self.slow_mode:
+            self.__slow_mode_pause_if_active()
         return element
 
     def __select_option(self, dropdown_selector, option,
@@ -1184,6 +1202,8 @@ def __select_option(self, dropdown_selector, option,
                 self.__demo_mode_pause_if_active()
             else:
                 self.__demo_mode_pause_if_active(tiny=True)
+        elif self.slow_mode:
+            self.__slow_mode_pause_if_active()
 
     def select_option_by_text(self, dropdown_selector, option,
                               dropdown_by=By.CSS_SELECTOR,
@@ -1604,7 +1624,7 @@ def scroll_to(self, selector, by=By.CSS_SELECTOR, timeout=None):
             timeout = settings.SMALL_TIMEOUT
         if self.timeout_multiplier and timeout == settings.SMALL_TIMEOUT:
             timeout = self.__get_new_timeout(timeout)
-        if self.demo_mode:
+        if self.demo_mode or self.slow_mode:
             self.slow_scroll_to(selector, by=by, timeout=timeout)
             return
         element = self.wait_for_element_visible(
@@ -3634,14 +3654,22 @@ def __make_css_match_first_element_only(self, selector):
 
     def __demo_mode_pause_if_active(self, tiny=False):
         if self.demo_mode:
+            wait_time = settings.DEFAULT_DEMO_MODE_TIMEOUT
             if self.demo_sleep:
                 wait_time = float(self.demo_sleep)
-            else:
-                wait_time = settings.DEFAULT_DEMO_MODE_TIMEOUT
             if not tiny:
                 time.sleep(wait_time)
             else:
                 time.sleep(wait_time / 3.4)
+        elif self.slow_mode:
+            self.__slow_mode_pause_if_active()
+
+    def __slow_mode_pause_if_active(self):
+        if self.slow_mode:
+            wait_time = settings.DEFAULT_DEMO_MODE_TIMEOUT
+            if self.demo_sleep:
+                wait_time = float(self.demo_sleep)
+            time.sleep(wait_time)
 
     def __demo_mode_scroll_if_active(self, selector, by):
         if self.demo_mode:
@@ -3651,6 +3679,19 @@ def __demo_mode_highlight_if_active(self, selector, by):
         if self.demo_mode:
             # Includes self.slow_scroll_to(selector, by=by) by default
             self.highlight(selector, by=by)
+        elif self.slow_mode:
+            # Just do the slow scroll part of the highlight() method
+            selector, by = self.__recalculate_selector(selector, by)
+            element = self.wait_for_element_visible(
+                selector, by=by, timeout=settings.SMALL_TIMEOUT)
+            try:
+                self.__slow_scroll_to_element(element)
+            except (StaleElementReferenceException, ENI_Exception):
+                self.wait_for_ready_state_complete()
+                time.sleep(0.05)
+                element = self.wait_for_element_visible(
+                    selector, by=by, timeout=settings.SMALL_TIMEOUT)
+                self.__slow_scroll_to_element(element)
 
     def __scroll_to_element(self, element):
         js_utils.scroll_to_element(self.driver, element)
@@ -3781,6 +3822,7 @@ def setUp(self, masterqa_mode=False):
                                     self._testMethodName)
             self.browser = sb_config.browser
             self.data = sb_config.data
+            self.slow_mode = sb_config.slow_mode
             self.demo_mode = sb_config.demo_mode
             self.demo_sleep = sb_config.demo_sleep
             self.highlights = sb_config.highlights
@@ -3991,6 +4033,7 @@ def tearDown(self):
         You'll need to add the following line to the subclass's tearDown():
         super(SubClassOfBaseCase, self).tearDown()
         """
+        self.__slow_mode_pause_if_active()
         has_exception = False
         if sys.version_info[0] >= 3 and hasattr(self, '_outcome'):
             if hasattr(self._outcome, 'errors') and self._outcome.errors:

seleniumbase/plugins/pytest_plugin.py

@@ -29,6 +29,7 @@ def pytest_addoption(parser):
     --start_page=URL  (The starting URL for the web browser when tests begin.)
     --log_path=LOG_PATH  (The directory where log files get saved to.)
     --archive_logs  (Archive old log files instead of deleting them.)
+    --slow  (The option to slow down the automation.)
     --demo  (The option to visually see test actions as they occur.)
     --demo_sleep=SECONDS  (The option to wait longer after Demo Mode actions.)
     --highlights=NUM  (Number of highlight animations for Demo Mode actions.)
@@ -228,12 +229,17 @@ def pytest_addoption(parser):
                      default=True,
                      help="""This is used by the BaseCase class to tell apart
                           pytest runs from nosetest runs. (Automatic)""")
+    parser.addoption('--slow_mode', '--slow-mode', '--slow',
+                     action="store_true",
+                     dest='slow_mode',
+                     default=False,
+                     help="""Using this slows down the automation.""")
     parser.addoption('--demo_mode', '--demo-mode', '--demo',
                      action="store_true",
                      dest='demo_mode',
                      default=False,
-                     help="""Using this slows down the automation so that
-                          you can see what it's actually doing.""")
+                     help="""Using this slows down the automation and lets you
+                          visually see what the tests are actually doing.""")
     parser.addoption('--demo_sleep', '--demo-sleep',
                      action='store',
                      dest='demo_sleep',
@@ -344,6 +350,7 @@ def pytest_configure(config):
     sb_config.database_env = config.getoption('database_env')
     sb_config.log_path = config.getoption('log_path')
     sb_config.archive_logs = config.getoption('archive_logs')
+    sb_config.slow_mode = config.getoption('slow_mode')
     sb_config.demo_mode = config.getoption('demo_mode')
     sb_config.demo_sleep = config.getoption('demo_sleep')
     sb_config.highlights = config.getoption('highlights')

seleniumbase/plugins/selenium_plugin.py

@@ -22,7 +22,8 @@ class SeleniumBrowser(Plugin):
     --headless  (The option to run tests headlessly. The default on Linux OS.)
     --headed  (The option to run tests with a GUI on Linux OS.)
     --start_page=URL  (The starting URL for the web browser when tests begin.)
-    --demo_mode  (The option to visually see test actions as they occur.)
+    --slow  (The option to slow down the automation.)
+    --demo  (The option to visually see test actions as they occur.)
     --demo_sleep=SECONDS  (The option to wait longer after Demo Mode actions.)
     --highlights=NUM  (Number of highlight animations for Demo Mode actions.)
     --message_duration=SECONDS  (The time length for Messenger alerts.)
@@ -146,13 +147,19 @@ def options(self, parser, env):
             help="""Designates the starting URL for the web browser
                     when each test begins.
                     Default: None.""")
+        parser.add_option(
+            '--slow_mode', '--slow-mode', '--slow',
+            action="store_true",
+            dest='slow_mode',
+            default=False,
+            help="""Using this slows down the automation.""")
         parser.add_option(
             '--demo_mode', '--demo-mode', '--demo',
             action="store_true",
             dest='demo_mode',
             default=False,
-            help="""Using this slows down the automation so that
-                    you can see what it's actually doing.""")
+            help="""Using this slows down the automation and lets you
+                    visually see what the tests are actually doing.""")
         parser.add_option(
             '--demo_sleep', '--demo-sleep',
             action='store',
@@ -265,6 +272,7 @@ def beforeTest(self, test):
         test.test.extension_dir = self.options.extension_dir
         test.test.proxy_string = self.options.proxy_string
         test.test.user_agent = self.options.user_agent
+        test.test.slow_mode = self.options.slow_mode
         test.test.demo_mode = self.options.demo_mode
         test.test.demo_sleep = self.options.demo_sleep
         test.test.highlights = self.options.highlights

setup.py

@@ -45,7 +45,7 @@
 
 setup(
     name='seleniumbase',
-    version='1.32.21',
+    version='1.32.22',
     description='Fast, Easy, and Reliable Browser Automation & Testing.',
     long_description=long_description,
     long_description_content_type='text/markdown',