Add the "--interval=SECONDS" option for autoplaying tour steps

Author: mdmintz

seleniumbase/fixtures/base_case.py

@@ -3976,6 +3976,8 @@ def save_presentation(
             raise Exception('Presentation file must end in ".html"!')
         if not interval:
             interval = 0
+        if interval == 0 and self.interval:
+            interval = float(self.interval)
         if not type(interval) is int and not type(interval) is float:
             raise Exception('Expecting a numeric value for "interval"!')
         if interval < 0:
@@ -4046,6 +4048,8 @@ def begin_presentation(
             raise Exception('Presentation file must end in ".html"!')
         if not interval:
             interval = 0
+        if interval == 0 and self.interval:
+            interval = float(self.interval)
         if not type(interval) is int and not type(interval) is float:
             raise Exception('Expecting a numeric value for "interval"!')
         if interval < 0:
@@ -4569,6 +4573,8 @@ def display_chart(self, chart_name=None, filename=None, interval=0):
             filename = "my_chart.html"
         if not interval:
             interval = 0
+        if interval == 0 and self.interval:
+            interval = float(self.interval)
         if not type(interval) is int and not type(interval) is float:
             raise Exception('Expecting a numeric value for "interval"!')
         if interval < 0:
@@ -5131,6 +5137,11 @@ def play_tour(self, name=None, interval=0):
         if self.headless:
             return  # Tours should not run in headless mode.
 
+        if not interval:
+            interval = 0
+        if interval == 0 and self.interval:
+            interval = float(self.interval)
+
         if not name:
             name = "default"
         if name not in self._tour_steps:
@@ -6670,6 +6681,7 @@ def setUp(self, masterqa_mode=False):
             self.headless_active = False
             self.headed = sb_config.headed
             self.locale_code = sb_config.locale_code
+            self.interval = sb_config.interval
             self.start_page = sb_config.start_page
             self.log_path = sb_config.log_path
             self.with_testing_base = sb_config.with_testing_base

seleniumbase/plugins/pytest_plugin.py

@@ -45,6 +45,7 @@ def pytest_addoption(parser):
     --headless  (Run tests headlessly. Default mode on Linux OS.)
     --headed  (Run tests with a GUI on Linux OS.)
     --locale=LOCALE_CODE  (Set the Language Locale Code for the web browser.)
+    --interval=SECONDS  (The autoplay interval for presentations & tour steps)
     --start-page=URL  (The starting URL for the web browser when tests begin.)
     --archive-logs  (Archive existing log files instead of deleting them.)
     --archive-downloads  (Archive old downloads instead of deleting them.)
@@ -350,6 +351,15 @@ def pytest_addoption(parser):
                           The Locale alters visible text on supported websites.
                           See: https://seleniumbase.io/help_docs/locale_codes/
                           Default: None. (The web browser's default mode.)""")
+    parser.addoption('--interval',
+                     action='store',
+                     dest='interval',
+                     default=None,
+                     help="""This globally overrides the default interval,
+                          (in seconds), of features that include autoplay
+                          functionality, such as tours and presentations.
+                          Overrides from methods take priority over this.
+                          (Headless Mode skips tours and presentations.)""")
     parser.addoption('--start_page', '--start-page', '--url',
                      action='store',
                      dest='start_page',
@@ -658,6 +668,7 @@ def pytest_configure(config):
     sb_config.headless = config.getoption('headless')
     sb_config.headed = config.getoption('headed')
     sb_config.locale_code = config.getoption('locale_code')
+    sb_config.interval = config.getoption('interval')
     sb_config.start_page = config.getoption('start_page')
     sb_config.extension_zip = config.getoption('extension_zip')
     sb_config.extension_dir = config.getoption('extension_dir')

seleniumbase/plugins/selenium_plugin.py

@@ -26,6 +26,7 @@ class SeleniumBrowser(Plugin):
     --headless  (Run tests headlessly. Default mode on Linux OS.)
     --headed  (Run tests with a GUI on Linux OS.)
     --locale=LOCALE_CODE  (Set the Language Locale Code for the web browser.)
+    --interval=SECONDS  (The autoplay interval for presentations & tour steps)
     --start-page=URL  (The starting URL for the web browser when tests begin.)
     --time-limit=SECONDS  (Safely fail any test that exceeds the time limit.)
     --slow  (Slow down the automation. Faster than using Demo Mode.)
@@ -193,6 +194,16 @@ def options(self, parser, env):
                     The Locale alters visible text on supported websites.
                     See: https://seleniumbase.io/help_docs/locale_codes/
                     Default: None. (The web browser's default mode.)""")
+        parser.add_option(
+            '--interval',
+            action='store',
+            dest='interval',
+            default=None,
+            help="""This globally overrides the default interval,
+                    (in seconds), of features that include autoplay
+                    functionality, such as tours and presentations.
+                    Overrides from methods take priority over this.
+                    (Headless Mode skips tours and presentations.)""")
         parser.add_option(
             '--start_page', '--start-page', '--url',
             action='store',
@@ -405,6 +416,7 @@ def beforeTest(self, test):
         test.test.headless = self.options.headless
         test.test.headed = self.options.headed
         test.test.locale_code = self.options.locale_code
+        test.test.interval = self.options.interval
         test.test.start_page = self.options.start_page
         test.test.servername = self.options.servername
         test.test.port = self.options.port