Merge pull request #366 from seleniumbase/demo-mode-updates

Demo Mode updates / JS library version updates

Author: mdmintz

README.md

@@ -1,7 +1,7 @@
 [<img src="https://cdn2.hubspot.net/hubfs/100006/images/sb_media_logo.png" title="SeleniumBase" height="129">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)<br />
 [<img src="https://cdn2.hubspot.net/hubfs/100006/images/SB_Logo4d4.png" title="SeleniumBase" height="56">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
 
-[<img src="https://img.shields.io/github/release/seleniumbase/SeleniumBase.svg" />](https://github.com/seleniumbase/SeleniumBase/releases) [<img src="https://dev.azure.com/seleniumbase/seleniumbase/_apis/build/status/seleniumbase.SeleniumBase?branchName=master" />](https://dev.azure.com/seleniumbase/seleniumbase/_build/latest?definitionId=1&branchName=master) [<img src="https://travis-ci.org/seleniumbase/SeleniumBase.svg?branch=master" alt="Build Status" />](https://travis-ci.org/seleniumbase/SeleniumBase) [<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt="Join the SeleniumBase Gitter chat" />](https://gitter.im/seleniumbase/SeleniumBase) [<img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" alt="MIT License" />](https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE) [<img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg" alt="Stars" />](https://github.com/seleniumbase/SeleniumBase/stargazers)  [<img src="https://img.shields.io/github/repo-size/seleniumbase/seleniumbase.svg" alt="Size" />](https://github.com/seleniumbase/SeleniumBase/releases)<br />
+[<img src="https://img.shields.io/github/release/seleniumbase/SeleniumBase.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/releases) [<img src="https://dev.azure.com/seleniumbase/seleniumbase/_apis/build/status/seleniumbase.SeleniumBase?branchName=master" alt=" " />](https://dev.azure.com/seleniumbase/seleniumbase/_build/latest?definitionId=1&branchName=master) [<img src="https://travis-ci.org/seleniumbase/SeleniumBase.svg?branch=master" alt=" " />](https://travis-ci.org/seleniumbase/SeleniumBase) [<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt=" " />](https://gitter.im/seleniumbase/SeleniumBase) [<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) [<img src="https://img.shields.io/github/repo-size/seleniumbase/seleniumbase.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/releases)<br />
 
 Fast, easy, and reliable test automation.
 
@@ -15,7 +15,7 @@ SeleniumBase is an all-in-one test automation framework that uses WebDriver APIs
 
 ## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Quick Start:
 
-You'll need **[Python](https://www.python.org/downloads/)** [<img src="https://img.shields.io/badge/python-2.7,_3.5,_3.6,_3.7+-22AADD.svg" alt="Python versions" />](https://www.python.org/downloads/)
+You'll need **[Python](https://www.python.org/downloads/)** [<img src="https://img.shields.io/badge/python-2.7,_3.5,_3.6,_3.7+-22AADD.svg" alt=" " />](https://www.python.org/downloads/)
 
 ### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Install/upgrade ``pip``:
 
@@ -28,7 +28,7 @@ python -m easy_install -U pip
 
 You may want to use a **Python Virtual Environment** to isolate Python dependencies between projects. (The Seleniumbase virtualenv tutorial can be found **[here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md)**, and the official virtualenv tutorial can be found **[here](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/)**.)
 
-### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Install ``seleniumbase``: [<img src="https://img.shields.io/badge/pypi-seleniumbase-22AAEE.svg" alt="pypi" />](https://pypi.python.org/pypi/seleniumbase)
+### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Install ``seleniumbase``: [<img src="https://img.shields.io/badge/pypi-seleniumbase-22AAEE.svg" alt=" " />](https://pypi.python.org/pypi/seleniumbase)
 ```bash
 pip install seleniumbase
 ```
@@ -446,7 +446,7 @@ If you want to type in special keys, that's easy too. Here's an example:
 
 ```python
 from selenium.webdriver.common.keys import Keys
-self.find_element("textarea").send_keys(Keys.SPACE + Keys.BACK_SPACE + '\n')  # the backspace should cancel out the space, leaving you with the newline
+self.find_element("textarea").send_keys(Keys.SPACE + Keys.BACK_SPACE + '\n')  # The backspace should cancel out the space, leaving you with the newline
 ```
 
 #### Getting the text from an element on a page
@@ -564,7 +564,7 @@ What if your test opens up a new tab/window and now you have more than one page?
 Ex:
 
 ```python
-self.switch_to_window(1)  # this switches to the new tab (0 is the first one)
+self.switch_to_window(1)  # This switches to the new tab (0 is the first one)
 ```
 
 **ProTip™:** iFrames follow the same principle as new windows - you need to specify the iFrame if you want to take action on something in there
@@ -574,7 +574,7 @@ Ex:
 self.switch_to_frame('ContentManagerTextBody_ifr')
 # Now you can act inside the iFrame
 # .... Do something cool (here)
-self.switch_to_default_content()  # exit the iFrame when you're done
+self.switch_to_default_content()  # Exit the iFrame when you're done
 ```
 
 #### Handle Pop-Up Alerts
@@ -690,13 +690,13 @@ from seleniumbase.fixtures.email_manager import EmailManager, EmailException
 num_email_results = 0
 email_subject = "This is the subject to search for (maybe include a timestamp)"
 email_manager = EmailManager("{YOUR SELENIUM GMAIL ACCOUNT EMAIL ADDRESS}")
-# the password for this would be stored in seleniumbase/config/settings.py
+# The password for this would be stored in seleniumbase/config/settings.py
 try:
     html_text = email_manager.search(SUBJECT="%s" % email_subject, timeout=60)
     num_email_results = len(html_text)
 except EmailException:
     num_email_results = 0
-self.assert_true(num_email_results)  # true if not zero
+self.assert_true(num_email_results)  # True if not zero
 ```
 
 Now you can parse through the email if you're looking for specific text or want to navigate to a link listed there.
@@ -708,8 +708,8 @@ Now you can parse through the email if you're looking for specific text or want
 <i>**Questions or Comments?**</i><br />
 [![Join the chat at https://gitter.im/seleniumbase/SeleniumBase](https://badges.gitter.im/seleniumbase/SeleniumBase.svg)](https://gitter.im/seleniumbase/SeleniumBase?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)<br />
 
-If you see something, say something! We are very active in resolving issues. [<img src="https://img.shields.io/github/issues-closed-raw/seleniumbase/SeleniumBase.svg" alt="Closed Issues" />](https://github.com/seleniumbase/SeleniumBase/issues?q=is%3Aissue+is%3Aclosed)
+If you see something, say something! We are very active in resolving issues. [<img src="https://img.shields.io/github/issues-closed-raw/seleniumbase/SeleniumBase.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/issues?q=is%3Aissue+is%3Aclosed)
 
 [https://github.com/mdmintz](https://github.com/mdmintz)<br />
 
-[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_7a.png" title="SeleniumBase" height="45">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md) <br /> [<img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" alt="MIT License" />](https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE)
+[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_7a.png" title="SeleniumBase" height="45">](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)

examples/master_qa/basic_masterqa_test.py

@@ -6,7 +6,7 @@ class MasterQATests(MasterQA):
     def test_masterqa(self):
         self.open("https://xkcd.com/1700/")
         self.verify("Do you see a webcomic?")
-        self.highlight_click("link=Store")
+        self.open("https://store.xkcd.com/collections/everything")
         self.highlight_click('[title="things for walls"]')
         self.verify('Do you see posters for sale?')
         self.highlight_update_text("input.search-input", "book\n")

examples/master_qa/masterqa_test.py

@@ -16,7 +16,7 @@ def test_xkcd(self):
         self.verify("Can you find the moon?")
         self.click('a[rel="next"]')
         self.verify("Do the drones look safe?")
-        self.click_link_text('Store')
+        self.open("https://store.xkcd.com/collections/everything")
         self.update_text("input.search-input", "book\n")
         self.verify("Do you see books in the search results?")
         self.open("https://xkcd.com/213/")

examples/visual_testing/layout_test.py

@@ -20,6 +20,7 @@ def test_applitools_helloworld(self):
         self.check_window(name="helloworld", level=2)
         with self.assertRaises(Exception):
             self.check_window(name="helloworld", level=3)
-        # Now that we know the exception was raised as expected,
+        # Now that we know the Exception was raised as expected,
         # let's print out the comparison results by running in Level-0.
+        # (NOTE: Running with level-0 will print but NOT raise an Exception.)
         self.check_window(name="helloworld", level=0)

seleniumbase/fixtures/base_case.py

@@ -1661,7 +1661,7 @@ def get_link_status_code(self, link, allow_redirects=False, timeout=5):
     def assert_link_status_code_is_not_404(self, link):
         status_code = str(self.get_link_status_code(link))
         bad_link_str = 'Error: "%s" returned a 404!' % link
-        self.assert_not_equal(status_code, "404", bad_link_str)
+        self.assertNotEqual(status_code, "404", bad_link_str)
 
     def assert_no_404_errors(self, multithreaded=True):
         """ Assert no 404 errors from page links obtained from:
@@ -1676,6 +1676,10 @@ def assert_no_404_errors(self, multithreaded=True):
         else:
             for link in links:
                 self.assert_link_status_code_is_not_404(link)
+        if self.demo_mode:
+            messenger_post = ("ASSERT NO 404 ERRORS")
+            js_utils.post_messenger_success_message(
+                self.driver, messenger_post, self.message_duration)
 
     def print_unique_links_with_status_codes(self):
         """ Finds all unique links in the html of the page source
@@ -1790,19 +1794,39 @@ def assert_downloaded_file(self, file):
 
     def assert_true(self, expr, msg=None):
         self.assertTrue(expr, msg=msg)
+        if self.demo_mode:
+            messenger_post = ("ASSERT TRUE: {%s}" % expr)
+            js_utils.post_messenger_success_message(
+                self.driver, messenger_post, self.message_duration)
 
     def assert_false(self, expr, msg=None):
         self.assertFalse(expr, msg=msg)
+        if self.demo_mode:
+            messenger_post = ("ASSERT FALSE: {%s}" % expr)
+            js_utils.post_messenger_success_message(
+                self.driver, messenger_post, self.message_duration)
 
     def assert_equal(self, first, second, msg=None):
         self.assertEqual(first, second, msg=msg)
+        if self.demo_mode:
+            messenger_post = ("ASSERT EQUAL: {%s == %s}" % (first, second))
+            js_utils.post_messenger_success_message(
+                self.driver, messenger_post, self.message_duration)
 
     def assert_not_equal(self, first, second, msg=None):
         self.assertNotEqual(first, second, msg=msg)
+        if self.demo_mode:
+            messenger_post = ("ASSERT NOT EQUAL: {%s != %s}" % (first, second))
+            js_utils.post_messenger_success_message(
+                self.driver, messenger_post, self.message_duration)
 
     def assert_title(self, title):
         """ Asserts that the web page title matches the expected title. """
         assert self.get_title() == title
+        if self.demo_mode:
+            messenger_post = ("ASSERT TITLE: {%s}" % title)
+            js_utils.post_messenger_success_message(
+                self.driver, messenger_post, self.message_duration)
 
     def assert_no_js_errors(self):
         """ Asserts that there are no JavaScript "SEVERE"-level page errors.
@@ -1811,6 +1835,7 @@ def assert_no_js_errors(self):
                 * See https://github.com/SeleniumHQ/selenium/issues/1161
             Based on the following Stack Overflow solution:
                 * https://stackoverflow.com/a/41150512/7058266 """
+        time.sleep(0.1)  # May take a moment for errors to appear after loads.
         try:
             browser_logs = self.driver.get_log('browser')
         except (ValueError, WebDriverException):
@@ -2317,7 +2342,7 @@ def assert_exact_text(self, text, selector="html", by=By.CSS_SELECTOR,
 
         if self.demo_mode:
             selector, by = self.__recalculate_selector(selector, by)
-            messenger_post = ("ASSERT TEXT {%s} in %s: %s"
+            messenger_post = ("ASSERT EXACT TEXT {%s} in %s: %s"
                               % (text, by, selector))
             self.__highlight_with_assert_success(messenger_post, selector, by)
         return True
@@ -2387,6 +2412,11 @@ def assert_partial_link_text(self, partial_link_text,
         if self.timeout_multiplier and timeout == settings.SMALL_TIMEOUT:
             timeout = self.__get_new_timeout(timeout)
         self.wait_for_partial_link_text(partial_link_text, timeout=timeout)
+        if self.demo_mode:
+            messenger_post = (
+                "ASSERT PARTIAL LINK TEXT {%s}." % partial_link_text)
+            self.__highlight_with_assert_success(
+                messenger_post, partial_link_text, by=By.PARTIAL_LINK_TEXT)
         return True
 
     ############
@@ -2591,6 +2621,13 @@ def check_window(self, name="default", level=0, baseline=False):
         if level != 0 and level != 1 and level != 2 and level != 3:
             raise Exception('Parameter "level" must be set to 0, 1, 2, or 3!')
 
+        if self.demo_mode:
+            raise Exception(
+                "WARNING: Using Demo Mode will break layout tests "
+                "that use the check_window() method due to custom "
+                "HTML edits being made on the page!\n"
+                "Please rerun without using Demo Mode!")
+
         module = self.__class__.__module__
         if '.' in module and len(module.split('.')[-1]) > 1:
             module = module.split('.')[-1]
@@ -2685,22 +2722,22 @@ def check_window(self, name="default", level=0, baseline=False):
             page_data_domain = self.get_domain_url(page_url_data)
             unittest.TestCase.maxDiff = 1000
             if level == 1 or level == 2 or level == 3:
-                self.assert_equal(page_domain, page_data_domain, domain_fail)
-                self.assert_equal(level_1, level_1_data, level_1_failure)
+                self.assertEqual(page_domain, page_data_domain, domain_fail)
+                self.assertEqual(level_1, level_1_data, level_1_failure)
             unittest.TestCase.maxDiff = None
             if level == 2 or level == 3:
-                self.assert_equal(level_2, level_2_data, level_2_failure)
+                self.assertEqual(level_2, level_2_data, level_2_failure)
             if level == 3:
-                self.assert_equal(level_3, level_3_data, level_3_failure)
+                self.assertEqual(level_3, level_3_data, level_3_failure)
             if level == 0:
                 try:
                     unittest.TestCase.maxDiff = 1000
-                    self.assert_equal(
+                    self.assertEqual(
                         page_domain, page_data_domain, domain_fail)
-                    self.assert_equal(level_1, level_1_data, level_1_failure)
+                    self.assertEqual(level_1, level_1_data, level_1_failure)
                     unittest.TestCase.maxDiff = None
-                    self.assert_equal(level_2, level_2_data, level_2_failure)
-                    self.assert_equal(level_3, level_3_data, level_3_failure)
+                    self.assertEqual(level_2, level_2_data, level_2_failure)
+                    self.assertEqual(level_3, level_3_data, level_3_failure)
                 except Exception as e:
                     print(e)  # Level-0 Dry Run (Only print the differences)
 

seleniumbase/fixtures/constants.py

@@ -61,7 +61,7 @@ class Underscore:
 
 
 class Backbone:
-    VER = "1.3.3"
+    VER = "1.4.0"
     MIN_JS = ("//cdnjs.cloudflare.com/ajax/libs/"
               "backbone.js/%s/backbone-min.js" % VER)
 
@@ -117,7 +117,7 @@ class Shepherd:
 
 
 class Tether:
-    VER = "1.4.4"
+    VER = "1.4.7"
     MIN_JS = ("//cdnjs.cloudflare.com/ajax/libs/"
               "tether/%s/js/tether.min.js" % VER)
 

seleniumbase/resources/shepherd/backbone-min.js

@@ -17,7 +17,7 @@
 
 setup(
     name='seleniumbase',
-    version='1.31.1',
+    version='1.31.2',
     description='Fast, Easy, and Reliable Browser Automation & Testing.',
     long_description=long_description,
     long_description_content_type='text/markdown',