Merge pull request #588 from seleniumbase/improved-exception-handling

Improve exception-handling, and more

Author: mdmintz

examples/timeout_test.py

@@ -1,6 +1,9 @@
 """ 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) """
+    for tests that run longer than the time limit specified (seconds).
+    The time-limit clock starts after the browser has fully launched,
+    which is after pytest starts it's own internal clock for tests.
+    Usage: (inside tests) =>  self.set_time_limit(SECONDS)
+    Usage: (command-line) =>  --time-limit=SECONDS """
 
 import pytest
 from seleniumbase import BaseCase
@@ -10,6 +13,6 @@ class MyTestClass(BaseCase):
 
     @pytest.mark.expected_failure
     def test_time_limit_feature(self):
-        self.set_time_limit(6)  # Test fails if run-time exceeds limit
+        self.set_time_limit(5)  # Fail test if time exceeds 5 seconds
         self.open("https://xkcd.com/1658/")
         self.sleep(7)

examples/translations/english_test_1.py

@@ -0,0 +1,21 @@
+from seleniumbase import BaseCase
+
+
+class MyTestClass(BaseCase):
+
+    def test_example_1(self):
+        url = "https://store.xkcd.com/collections/everything"
+        self.open(url)
+        self.update_text("input.search-input", "xkcd book\n")
+        self.assert_exact_text("xkcd: volume 0", "h3")
+        self.click("li.checkout-link")
+        self.assert_text("Shopping Cart", "#page-title")
+        self.assert_element("div#umbrella")
+        self.open("https://xkcd.com/353/")
+        self.assert_title("xkcd: Python")
+        self.assert_element('img[alt="Python"]')
+        self.click('a[rel="license"]')
+        self.assert_text("back to this page")
+        self.go_back()
+        self.click("link=About")
+        self.assert_text("xkcd.com", "h2")

requirements.txt

@@ -1,7 +1,7 @@
 pip>=20.1.1
 packaging>=20.4
 setuptools>=44.1.0;python_version<"3.5"
-setuptools>=46.4.0;python_version>="3.5"
+setuptools>=47.1.1;python_version>="3.5"
 setuptools-scm>=4.1.1
 wheel>=0.34.2
 six==1.15.0

seleniumbase/common/exceptions.py

@@ -0,0 +1,12 @@
+""" SeleniumBase Exceptions
+    NoSuchFileException => Used by self.assert_downloaded_file(...)
+    TimeLimitExceededException => Used by "--time-limit=SECONDS"
+"""
+
+
+class NoSuchFileException(Exception):
+    pass
+
+
+class TimeLimitExceededException(Exception):
+    pass

seleniumbase/fixtures/base_case.py

@@ -4955,12 +4955,6 @@ def setUp(self, masterqa_mode=False):
                             """    >>> "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)
@@ -5049,6 +5043,14 @@ def setUp(self, masterqa_mode=False):
             if self._reuse_session:
                 sb_config.shared_driver = self.driver
 
+        # Configure the test time limit (if used).
+        self.set_time_limit(self.time_limit)
+
+        # Set the start time for the test (in ms).
+        # Although the pytest clock starts before setUp() begins,
+        # the time-limit clock starts at the end of the setUp() method.
+        sb_config.start_time_ms = int(time.time() * 1000.0)
+
     def __set_last_page_screenshot(self):
         """ self.__last_page_screenshot is only for pytest html report logs
             self.__last_page_screenshot_png is for all screenshot log files """

seleniumbase/fixtures/errors.py

@@ -1,21 +1,21 @@
 """
-This module contains test-state related exceptions.
+SeleniumBase MySQL plugin-related exceptions.
 Raising one of these in a test will cause the
-test-state to be logged appropriately in the database
+test-state to be logged appropriately in the DB
 for tests that use the SeleniumBase MySQL plugin.
 """
 
 
 class BlockedTest(Exception):
-    """Raise this to mark a test as Blocked"""
+    """ Raise this to mark a test as Blocked in the DB. """
     pass
 
 
 class SkipTest(Exception):
-    """Raise this to mark a test as Skipped."""
+    """ Raise this to mark a test as Skipped in the DB. """
     pass
 
 
 class DeprecatedTest(Exception):
-    """Raise this to mark a test as Deprecated."""
+    """ Raise this to mark a test as Deprecated in the DB. """
     pass

seleniumbase/fixtures/js_utils.py

@@ -25,6 +25,13 @@ def wait_for_ready_state_complete(driver, timeout=settings.EXTREME_TIMEOUT):
     stop_ms = start_ms + (timeout * 1000.0)
     for x in range(int(timeout * 10)):
         shared_utils.check_if_time_limit_exceeded()
+        try:
+            # If there's an alert, skip
+            driver.switch_to.alert
+            return
+        except Exception:
+            # If there's no alert, continue
+            pass
         try:
             ready_state = driver.execute_script("return document.readyState")
         except WebDriverException:
@@ -49,6 +56,13 @@ def execute_async_script(driver, script, timeout=settings.EXTREME_TIMEOUT):
 
 
 def wait_for_angularjs(driver, timeout=settings.LARGE_TIMEOUT, **kwargs):
+    try:
+        # If there's an alert, skip
+        driver.switch_to.alert
+        return
+    except Exception:
+        # If there's no alert, continue
+        pass
     if not settings.WAIT_FOR_ANGULARJS:
         return
 

seleniumbase/fixtures/page_actions.py

@@ -114,8 +114,8 @@ def hover_element(driver, element):
 
 
 def timeout_exception(exception, message):
-    message = s_utils.format_exc(exception, message)
-    raise Exception(message)
+    exc, message = s_utils.format_exc(exception, message)
+    raise exc(message)
 
 
 def hover_and_click(driver, hover_selector, click_selector,

seleniumbase/fixtures/shared_utils.py

@@ -7,6 +7,8 @@
 from selenium.webdriver.remote.errorhandler import NoAlertPresentException
 from selenium.webdriver.remote.errorhandler import NoSuchFrameException
 from selenium.webdriver.remote.errorhandler import NoSuchWindowException
+from seleniumbase.common.exceptions import NoSuchFileException
+from seleniumbase.common.exceptions import TimeLimitExceededException
 from seleniumbase import config as sb_config
 
 
@@ -15,27 +17,48 @@ def format_exc(exception, message):
     Formats an exception message to make the output cleaner.
     """
     if exception == Exception:
-        pass
+        exc = Exception
+        return exc, message
     elif exception == ElementNotVisibleException:
-        message = "ElementNotVisibleException: %s" % message
+        exc = ElementNotVisibleException
+    elif exception == "ElementNotVisibleException":
+        exc = ElementNotVisibleException
     elif exception == NoSuchElementException:
-        message = "NoSuchElementException: %s" % message
+        exc = NoSuchElementException
+    elif exception == "NoSuchElementException":
+        exc = NoSuchElementException
     elif exception == NoAlertPresentException:
-        message = "NoAlertPresentException: %s" % message
+        exc = NoAlertPresentException
+    elif exception == "NoAlertPresentException":
+        exc = NoAlertPresentException
     elif exception == NoSuchFrameException:
-        message = "NoSuchFrameException: %s" % message
+        exc = NoSuchFrameException
+    elif exception == "NoSuchFrameException":
+        exc = NoSuchFrameException
     elif exception == NoSuchWindowException:
-        message = "NoSuchWindowException: %s" % message
+        exc = NoSuchWindowException
+    elif exception == "NoSuchWindowException":
+        exc = NoSuchWindowException
+    elif exception == "NoSuchFileException":
+        exc = NoSuchFileException
     elif type(exception) is str:
+        exc = Exception
         message = "%s: %s" % (exception, message)
+        return exc, message
     else:
-        pass
+        exc = Exception
+        return exc, message
+    message = _format_message(message)
+    return exc, message
+
+
+def _format_message(message):
+    message = "\n " + message
     return message
 
 
 def __time_limit_exceeded(message):
-    raise Exception(
-        "TimeLimitExceeded: %s" % message)
+    raise TimeLimitExceededException(message)
 
 
 def check_if_time_limit_exceeded():
@@ -52,4 +75,5 @@ def check_if_time_limit_exceeded():
             message = (
                 "This test has exceeded the time limit of %s second%s!"
                 "" % (display_time_limit, plural))
+            message = _format_message(message)
             __time_limit_exceeded(message)

seleniumbase/translate/translator.py

@@ -493,14 +493,14 @@ def main():
 
             new_sb_lines = []
             for line in seleniumbase_lines:
-                line_length = len(line)
-                line_length2 = len(line)
-                line_length = get_width(line)
+                line_length2 = len(line)  # Normal Python string length used
+                line_length = get_width(line)  # Special characters count 2X
                 if line_length > code_width:
                     code_width = line_length
 
                 if console_width:
-                    # If line is larger than console_width, try to optimize it
+                    # If line is larger than console_width, try to optimize it.
+                    # Smart Python word wrap to be used with valid indentation.
                     if line_length + w > console_width:  # 5 is line number ws
                         if line.count('  # ') == 1:  # Has comments like this
                             if get_width(
@@ -582,6 +582,38 @@ def main():
                             else:
                                 new_sb_lines.append(line)
                             continue
+                        elif line.count('= "') == 1 and line.count('://') == 1:
+                            whitespace = line_length2 - len(line.lstrip())
+                            new_ws = line[0:whitespace] + "    "
+                            line1 = line.split('://')[0] + '://" \\'
+                            line2 = new_ws + '"' + line.split('://')[1]
+                            new_sb_lines.append(line1)
+                            if get_width(line2) + w > console_width:
+                                if line2.count('/') > 0:
+                                    slash_one = line2.find('/')
+                                    line2a = line2[:slash_one+1] + '" \\'
+                                    line2b = new_ws + '"' + line2[slash_one+1:]
+                                    new_sb_lines.append(line2a)
+                                    new_sb_lines.append(line2b)
+                                    continue
+                            new_sb_lines.append(line2)
+                            continue
+                        elif line.count("= '") == 1 and line.count('://') == 1:
+                            whitespace = line_length2 - len(line.lstrip())
+                            new_ws = line[0:whitespace] + "    "
+                            line1 = line.split('://')[0] + '://" \\'
+                            line2 = new_ws + "'" + line.split('://')[1]
+                            new_sb_lines.append(line1)
+                            if get_width(line2) + w > console_width:
+                                if line2.count('/') > 0:
+                                    slash_one = line2.find('/')
+                                    line2a = line2[:slash_one+1] + "' \\"
+                                    line2b = new_ws + "'" + line2[slash_one+1:]
+                                    new_sb_lines.append(line2a)
+                                    new_sb_lines.append(line2b)
+                                    continue
+                            new_sb_lines.append(line2)
+                            continue
                     new_sb_lines.append(line)
 
             if new_sb_lines: