Add methods for asserting exact text

Author: mdmintz

seleniumbase/fixtures/base_case.py

@@ -2068,6 +2068,19 @@ def wait_for_text_visible(self, text, selector="html", by=By.CSS_SELECTOR,
         return page_actions.wait_for_text_visible(
             self.driver, text, selector, by, timeout)
 
+    def wait_for_exact_text_visible(self, text, selector="html",
+                                    by=By.CSS_SELECTOR,
+                                    timeout=settings.LARGE_TIMEOUT):
+        if self.timeout_multiplier and timeout == settings.LARGE_TIMEOUT:
+            timeout = self.__get_new_timeout(timeout)
+        if page_utils.is_xpath_selector(selector):
+            by = By.XPATH
+        if page_utils.is_link_text_selector(selector):
+            selector = page_utils.get_link_text_from_selector(selector)
+            by = By.LINK_TEXT
+        return page_actions.wait_for_exact_text_visible(
+            self.driver, text, selector, by, timeout)
+
     def wait_for_text(self, text, selector="html", by=By.CSS_SELECTOR,
                       timeout=settings.LARGE_TIMEOUT):
         """ The shorter version of wait_for_text_visible() """
@@ -2111,6 +2124,29 @@ def assert_text(self, text, selector="html", by=By.CSS_SELECTOR,
             self.__highlight_with_assert_success(messenger_post, selector, by)
         return True
 
+    def assert_exact_text(self, text, selector="html", by=By.CSS_SELECTOR,
+                          timeout=settings.SMALL_TIMEOUT):
+        """ Similar to assert_text(), but the text must be exact, rather than
+            exist as a subset of the full text.
+            (Extra whitespace at the beginning or the end doesn't count.)
+            Raises an exception if the element or the text is not found.
+            Returns True if successful. Default timeout = SMALL_TIMEOUT. """
+        if self.timeout_multiplier and timeout == settings.SMALL_TIMEOUT:
+            timeout = self.__get_new_timeout(timeout)
+        self.wait_for_exact_text_visible(
+            text, selector, by=by, timeout=timeout)
+
+        if self.demo_mode:
+            if page_utils.is_xpath_selector(selector):
+                by = By.XPATH
+            if page_utils.is_link_text_selector(selector):
+                selector = page_utils.get_link_text_from_selector(selector)
+                by = By.LINK_TEXT
+            messenger_post = ("ASSERT TEXT {%s} in %s: %s"
+                              % (text, by, selector))
+            self.__highlight_with_assert_success(messenger_post, selector, by)
+        return True
+
     # For backwards compatibility, earlier method names of the next
     # four methods have remained even though they do the same thing,
     # with the exception of assert_*, which won't return the element,

seleniumbase/fixtures/page_actions.py

@@ -280,6 +280,49 @@ def wait_for_text_visible(driver, text, selector, by=By.CSS_SELECTOR,
             (text, selector, timeout, plural))
 
 
+def wait_for_exact_text_visible(driver, text, selector, by=By.CSS_SELECTOR,
+                                timeout=settings.LARGE_TIMEOUT):
+    """
+    Searches for the specified element by the given selector. Returns the
+    element object if the text matches exactly with the text in the element,
+    and the text is visible.
+    Raises an exception if the text or element do not appear
+    in the specified timeout.
+    @Params
+    driver - the webdriver object (required)
+    text - the exact text that is expected for the element (required)
+    selector - the locator that is used (required)
+    by - the method to search for the locator (Default: By.CSS_SELECTOR)
+    timeout - the time to wait for elements in seconds
+    @Returns
+    A web element object that contains the text searched for
+    """
+
+    element = None
+    start_ms = time.time() * 1000.0
+    stop_ms = start_ms + (timeout * 1000.0)
+    for x in range(int(timeout * 10)):
+        try:
+            element = driver.find_element(by=by, value=selector)
+            if element.is_displayed() and text.strip() == element.text.strip():
+                return element
+            else:
+                element = None
+                raise Exception()
+        except Exception:
+            now_ms = time.time() * 1000.0
+            if now_ms >= stop_ms:
+                break
+            time.sleep(0.1)
+    plural = "s"
+    if timeout == 1:
+        plural = ""
+    if not element:
+        raise ElementNotVisibleException(
+            "Expected exact text {%s} for {%s} was not visible "
+            "after %s second%s!" % (text, selector, timeout, plural))
+
+
 def wait_for_element_absent(driver, selector, by=By.CSS_SELECTOR,
                             timeout=settings.LARGE_TIMEOUT):
     """