Merge pull request #282 from seleniumbase/add-exact-text-methods

Adding exact text methods and other improvements

Author: mdmintz

examples/my_first_test.py

@@ -4,19 +4,19 @@
 class MyTestClass(BaseCase):
 
     def test_basic(self):
-        self.open('https://xkcd.com/353/')           # Navigate to the web page
+        self.open("https://xkcd.com/353/")           # Navigate browser to page
         self.assert_element('img[alt="Python"]')       # Assert element on page
         self.click('a[rel="license"]')                  # Click element on page
-        self.assert_text('free to copy', 'div center')    # Assert text on page
+        self.assert_text("free to copy", "div center")    # Assert text in area
         self.open("https://xkcd.com/1481/")
         title = self.get_attribute("#comic img", "title")    # Get an attribute
         self.assert_true("86,400 seconds per day" in title)
-        self.click('link=Blag')                                 # Click on link
-        self.assert_text('The blag of the webcomic', 'h2')
-        self.update_text('input#s', 'Robots!\n')                    # Type text
-        self.assert_text('Hooray robots!', '#content')
-        self.open('https://xkcd.com/1319/')
-        self.assert_text('Automation', 'div#ctitle')
+        self.click("link=Blag")                                 # Click on link
+        self.assert_text("The blag of the webcomic", "h2")
+        self.update_text("input#s", "Robots!\n")                    # Type text
+        self.assert_text("Hooray robots!", "#content")
+        self.open("https://xkcd.com/1319/")
+        self.assert_exact_text("Automation", "#ctitle")
 
         ####
 

help_docs/method_summary.md

@@ -261,6 +261,9 @@ self.assert_element(
 self.wait_for_text_visible(text, selector="html", by=By.CSS_SELECTOR,
     timeout=settings.LARGE_TIMEOUT)
 
+self.wait_for_exact_text_visible(text, selector="html", by=By.CSS_SELECTOR,
+    timeout=settings.LARGE_TIMEOUT)
+
 self.wait_for_text(text, selector="html", by=By.CSS_SELECTOR,
     timeout=settings.LARGE_TIMEOUT)
 
@@ -273,6 +276,9 @@ self.assert_text_visible(text, selector="html", by=By.CSS_SELECTOR,
 self.assert_text(text, selector="html", by=By.CSS_SELECTOR,
     timeout=settings.SMALL_TIMEOUT)
 
+self.assert_exact_text(text, selector="html", by=By.CSS_SELECTOR,
+    timeout=settings.SMALL_TIMEOUT)
+
 ########
 
 self.wait_for_link_text_visible(link_text, timeout=settings.LARGE_TIMEOUT)

integrations/node_js/my_first_test.py

@@ -16,4 +16,4 @@ def test_basic(self):
         self.update_text('input#s', 'Robots!\n')
         self.assert_text('Hooray robots!', '#content')
         self.open('http://xkcd.com/1319/')
-        self.assert_text('Automation', 'div#ctitle')
+        self.assert_exact_text('Automation', '#ctitle')

requirements.txt

@@ -8,7 +8,7 @@ unittest2
 selenium==3.141.0
 requests==2.21.0
 urllib3==1.24.1
-pytest>=4.2.0
+pytest>=4.2.1
 pytest-cov>=2.6.1
 pytest-html>=1.20.0
 pytest-rerunfailures>=6.0
@@ -18,7 +18,6 @@ beautifulsoup4>=4.6.0
 colorama==0.4.1
 pyotp>=2.2.7
 boto>=2.49.0
-more-itertools>=5.0.0,<6.0.0
 flake8==3.7.5
 PyVirtualDisplay==0.2.1
 -e .

seleniumbase/console_scripts/sb_mkdir.py

@@ -93,7 +93,7 @@ def main():
         data.append("        self.update_text('input#s', 'Robots!\\n')")
         data.append("        self.assert_text('Hooray robots!', '#content')")
         data.append("        self.open('https://xkcd.com/1319/')")
-        data.append("        self.assert_text('Automation', 'div#ctitle')")
+        data.append("        self.assert_exact_text('Automation', '#ctitle')")
         data.append("")
         file_path = "%s/%s" % (dir_name, "my_first_test.py")
         file = codecs.open(file_path, "w+", "utf-8")

seleniumbase/fixtures/base_case.py

@@ -437,13 +437,16 @@ def get_current_url(self):
         return self.driver.current_url
 
     def get_page_source(self):
+        self.wait_for_ready_state_complete()
         return self.driver.page_source
 
     def get_page_title(self):
+        self.wait_for_ready_state_complete()
         return self.driver.title
 
     def get_title(self):
         """ The shorter version of self.get_page_title() """
+        self.wait_for_ready_state_complete()
         return self.driver.title
 
     def go_back(self):
@@ -2065,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() """
@@ -2108,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):
     """

setup.py

@@ -17,7 +17,7 @@
 
 setup(
     name='seleniumbase',
-    version='1.19.5',
+    version='1.19.6',
     description='Reliable Browser Automation & Testing Framework',
     long_description=long_description,
     long_description_content_type='text/markdown',
@@ -61,7 +61,7 @@
         'selenium==3.141.0',
         'requests==2.21.0',  # Changing this may effect "urllib3"
         'urllib3==1.24.1',  # Keep this lib in sync with "requests"
-        'pytest>=4.2.0',
+        'pytest>=4.2.1',
         'pytest-cov>=2.6.1',
         'pytest-html>=1.20.0',
         'pytest-rerunfailures>=6.0',
@@ -71,7 +71,6 @@
         'colorama==0.4.1',
         'pyotp>=2.2.7',
         'boto>=2.49.0',
-        'more-itertools>=5.0.0,<6.0.0',  # Keep this for Python 2 compatibility
         'flake8>=3.6.0,<3.8.0',
         'PyVirtualDisplay==0.2.1',
     ],