Merge pull request #477 from seleniumbase/time-limit-feature

Add the ``--time-limit=s`` feature to fail long-running tests

Author: mdmintz

README.md

@@ -1,4 +1,4 @@
-[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_sb20.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
+[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_sb26.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
 
 [<img src="https://img.shields.io/github/release/seleniumbase/SeleniumBase.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/releases) [<img src="https://img.shields.io/pypi/v/seleniumbase.svg" alt=" " />](https://pypi.python.org/pypi/seleniumbase) [<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt=" " />](https://gitter.im/seleniumbase/SeleniumBase) [<img src="https://img.shields.io/travis/seleniumbase/SeleniumBase/master.svg?logo=travis" alt=" " />](https://travis-ci.org/seleniumbase/SeleniumBase) [<img src="https://dev.azure.com/seleniumbase/seleniumbase/_apis/build/status/seleniumbase.SeleniumBase?branchName=master" alt=" " />](https://dev.azure.com/seleniumbase/seleniumbase/_build) [<img src="https://github.com/seleniumbase/SeleniumBase/workflows/CI%20build/badge.svg">](https://github.com/seleniumbase/SeleniumBase/actions) [<img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE) [<img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/stargazers)
 
@@ -229,6 +229,7 @@ SeleniumBase provides additional Pytest command-line options for tests:
 --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.)
 --archive-logs  # (Archive old log files instead of deleting them.)
+--time-limit  # (The option to set a time limit per test before failing it.)
 --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.)
@@ -662,4 +663,4 @@ Additionally, you can use the ``@retry_on_exception()`` decorator to specificall
 
 [<img src="https://cdn2.hubspot.net/hubfs/100006/images/sb_media_logo_c.png" title="SeleniumBase" height="100">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md) <br /> [<img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE)
 
-[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_n.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
+[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_sb22.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)

examples/ReadMe.md

@@ -109,4 +109,4 @@ python gui_test_runner.py
 
 --------
 
-[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_n.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
+[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_sb23.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)

examples/raw_parameter_script.py

@@ -56,6 +56,7 @@
     sb.with_s3_logging = False
     sb.js_checking_on = False
     sb.is_pytest = False
+    sb.time_limit = None
     sb.slow_mode = False
     sb.demo_mode = False
     sb.demo_sleep = 1

examples/timeout_test.py

@@ -1,15 +1,15 @@
-""" This test fails on purpose to demonstrate the timeout feature
-    for tests that run longer than the time limit specified. """
+""" This test fails on purpose to demonstrate the time-limit feature
+    for tests that run longer than the time limit specified in seconds.
+    Usage: (inside tests) -> self.set_time_limit(SECONDS) """
 
 import pytest
-import time
 from seleniumbase import BaseCase
 
 
 class MyTestClass(BaseCase):
 
     @pytest.mark.expected_failure
-    @pytest.mark.timeout(6)  # The test will fail if it runs longer than this
-    def test_timeout_failure(self):
+    def test_time_limit_feature(self):
+        self.set_time_limit(6)  # Test fails if run-time exceeds limit
         self.open("https://xkcd.com/1658/")
-        time.sleep(7)
+        self.sleep(7)

help_docs/method_summary.md

@@ -262,6 +262,8 @@ self.js_update_text(selector, new_value, by=By.CSS_SELECTOR, timeout=None)
 
 self.jquery_update_text(selector, new_value, by=By.CSS_SELECTOR, timeout=None)
 
+self.set_time_limit(time_limit)
+
 ########
 
 self.add_css_link(css_link)

requirements.txt

@@ -22,7 +22,6 @@ pytest-html==2.0.1;python_version>="3.6"
 pytest-metadata>=1.8.0
 pytest-ordering>=0.6
 pytest-rerunfailures>=8.0
-pytest-timeout>=1.3.4
 pytest-xdist>=1.31.0
 parameterized>=0.7.1
 soupsieve==1.9.5

seleniumbase/core/browser_launcher.py

@@ -601,7 +601,8 @@ def get_local_driver(
         else:
             return webdriver.Edge()
     elif browser_name == constants.Browser.SAFARI:
-        if ("-n" in sys.argv or "".join(sys.argv) == "-c"):
+        arg_join = " ".join(sys.argv)
+        if ("-n" in sys.argv) or ("-n=" in arg_join) or (arg_join == "-c"):
             # Skip if multithreaded
             raise Exception("Can't run Safari tests in multi-threaded mode!")
         return webdriver.Safari()

seleniumbase/core/log_helper.py

@@ -121,7 +121,8 @@ def copytree(src, dst, symlinks=False, ignore=None):
 
 def archive_logs_if_set(log_path, archive_logs=False):
     """ Handle Logging """
-    if "-n" in sys.argv or "".join(sys.argv) == "-c":
+    arg_join = " ".join(sys.argv)
+    if ("-n" in sys.argv) or ("-n=" in arg_join) or (arg_join == "-c"):
         return  # Skip if multithreaded
     if log_path.endswith("/"):
         log_path = log_path[:-1]
@@ -172,7 +173,8 @@ def log_folder_setup(log_path, archive_logs=False):
             if not settings.ARCHIVE_EXISTING_LOGS and not archive_logs:
                 shutil.rmtree(archived_logs)
             else:
-                if ("-n" in sys.argv or "".join(sys.argv) == "-c"):
+                a_join = " ".join(sys.argv)
+                if ("-n" in sys.argv) or ("-n=" in a_join) or (a_join == "-c"):
                     # Logs are saved/archived now if tests are multithreaded
                     pass
                 else:

seleniumbase/core/tour_helper.py

@@ -11,8 +11,7 @@
 from seleniumbase.fixtures import constants
 from seleniumbase.fixtures import js_utils
 from seleniumbase.fixtures import page_actions
-
-EXPORTED_TOURS_FOLDER = "tours_exported"
+EXPORTED_TOURS_FOLDER = constants.Tours.EXPORTED_TOURS_FOLDER
 
 
 def activate_bootstrap(driver):

seleniumbase/fixtures/base_case.py

@@ -55,6 +55,7 @@ def test_anything(self):
 from seleniumbase.fixtures import js_utils
 from seleniumbase.fixtures import page_actions
 from seleniumbase.fixtures import page_utils
+from seleniumbase.fixtures import shared_utils
 from seleniumbase.fixtures import xpath_to_css
 logging.getLogger("requests").setLevel(logging.ERROR)
 logging.getLogger("urllib3").setLevel(logging.ERROR)
@@ -976,14 +977,15 @@ def find_visible_elements(self, selector, by=By.CSS_SELECTOR, limit=0):
     def click_visible_elements(self, selector, by=By.CSS_SELECTOR, limit=0):
         """ Finds all matching page elements and clicks visible ones in order.
             If a click reloads or opens a new page, the clicking will stop.
+            If no matching elements appear, an Exception will be raised.
+            If "limit" is set and > 0, will only click that many elements.
+            Also clicks elements that become visible from previous clicks.
             Works best for actions such as clicking all checkboxes on a page.
-            Example:  self.click_visible_elements('input[type="checkbox"]')
-            If "limit" is set and > 0, will only click that many elements. """
-        elements = []
-        try:
-            elements = self.find_visible_elements(selector, by=by)
-        except Exception:
-            elements = self.find_elements(selector, by=by)
+            Example:  self.click_visible_elements('input[type="checkbox"]') """
+        selector, by = self.__recalculate_selector(selector, by)
+        self.wait_for_element_present(
+            selector, by=by, timeout=settings.SMALL_TIMEOUT)
+        elements = self.find_elements(selector, by=by)
         click_count = 0
         for element in elements:
             if limit and limit > 0 and click_count >= limit:
@@ -1661,7 +1663,17 @@ def wait_for_angularjs(self, timeout=None, **kwargs):
         js_utils.wait_for_angularjs(self.driver, timeout, **kwargs)
 
     def sleep(self, seconds):
-        time.sleep(seconds)
+        if not sb_config.time_limit:
+            time.sleep(seconds)
+        else:
+            start_ms = time.time() * 1000.0
+            stop_ms = start_ms + (seconds * 1000.0)
+            for x in range(int(seconds * 5)):
+                shared_utils.check_if_time_limit_exceeded()
+                now_ms = time.time() * 1000.0
+                if now_ms >= stop_ms:
+                    break
+                time.sleep(0.2)
 
     def activate_jquery(self):
         """ If "jQuery is not defined", use this method to activate it for use.
@@ -2455,6 +2467,22 @@ def jquery_update_text(self, selector, new_value, by=By.CSS_SELECTOR,
             element.send_keys('\n')
         self.__demo_mode_pause_if_active()
 
+    def set_time_limit(self, time_limit):
+        if time_limit:
+            try:
+                sb_config.time_limit = float(time_limit)
+            except Exception:
+                sb_config.time_limit = None
+        else:
+            sb_config.time_limit = None
+        if sb_config.time_limit and sb_config.time_limit > 0:
+            sb_config.time_limit_ms = int(sb_config.time_limit * 1000.0)
+            self.time_limit = sb_config.time_limit
+        else:
+            self.time_limit = None
+            sb_config.time_limit = None
+            sb_config.time_limit_ms = None
+
     ############
 
     def add_css_link(self, css_link):
@@ -3237,6 +3265,7 @@ def wait_for_link_text_present(self, link_text, timeout=None):
         start_ms = time.time() * 1000.0
         stop_ms = start_ms + (timeout * 1000.0)
         for x in range(int(timeout * 5)):
+            shared_utils.check_if_time_limit_exceeded()
             try:
                 if not self.is_link_text_present(link_text):
                     raise Exception(
@@ -3257,6 +3286,7 @@ def wait_for_partial_link_text_present(self, link_text, timeout=None):
         start_ms = time.time() * 1000.0
         stop_ms = start_ms + (timeout * 1000.0)
         for x in range(int(timeout * 5)):
+            shared_utils.check_if_time_limit_exceeded()
             try:
                 if not self.is_partial_link_text_present(link_text):
                     raise Exception(
@@ -4145,6 +4175,7 @@ def setUp(self, masterqa_mode=False):
             self.demo_mode = sb_config.demo_mode
             self.demo_sleep = sb_config.demo_sleep
             self.highlights = sb_config.highlights
+            self.time_limit = sb_config.time_limit
             self.environment = sb_config.environment
             self.env = self.environment  # Add a shortened version
             self.with_selenium = sb_config.with_selenium  # Should be True
@@ -4242,15 +4273,27 @@ def setUp(self, masterqa_mode=False):
                     # pyvirtualdisplay might not be necessary anymore because
                     # Chrome and Firefox now have built-in headless displays
                     pass
+        else:
+            # (Nosetests / Not Pytest)
+            pass  # Setup performed in plugins
 
         # Verify that SeleniumBase is installed successfully
         if not hasattr(self, "browser"):
             raise Exception("""SeleniumBase plugins DID NOT load!\n\n"""
                             """*** Please REINSTALL SeleniumBase using: >\n"""
                             """    >>> "pip install -r requirements.txt"\n"""
                             """    >>> "python setup.py install" """)
+
+        # Configure the test time limit (if used)
+        self.set_time_limit(self.time_limit)
+
+        # Set the start time for the test (in ms)
+        sb_config.start_time_ms = int(time.time() * 1000.0)
+
+        # Parse the settings file
         if self.settings_file:
             settings_parser.set_settings(self.settings_file)
+
         # Mobile Emulator device metrics: CSS Width, CSS Height, & Pixel-Ratio
         if self.device_metrics:
             metrics_string = self.device_metrics