Merge pull request #187 from seleniumbase/refactoring-and-tour-updates

Refactoring and tour updates

Author: mdmintz

examples/boilerplates/samples/google_test.py

@@ -12,7 +12,7 @@ def test_google_dot_com(self):
         self.open('https://google.com')
         try:
             # Remove the Privacy Checkup box if present.
-            self.assert_text('Privacy Checkup', HomePage.dialog_box, timeout=3)
+            self.assert_text('Privacy Checkup', HomePage.dialog_box, timeout=2)
             self.click('link=NO, THANKS')
         except Exception:
             pass  # Google may have removed the Privacy Checkup. Continue test.

examples/tour_examples/google_tour.py

@@ -6,28 +6,36 @@ class MyTourClass(BaseCase):
     def test_google_tour(self):
         self.open('https://google.com')
         self.wait_for_element('input[title="Search"]')
+        try:
+            # Remove the Privacy Checkup box if present.
+            self.assert_text('Privacy Checkup', '[role="dialog"]', timeout=2)
+            self.click('link=NO, THANKS')
+        except Exception:
+            pass  # Google may have removed the Privacy Checkup. Continue.
         self.create_tour(theme="dark")
         self.add_tour_step("Click to begin the Google Tour!",
                            title="SeleniumBase Guided Tours")
         self.add_tour_step("Type in your search query here.",
                            'input[title="Search"]')
-        self.add_tour_step("Then click here to search!",
-                           'input[value="Google Search"]',
-                           alignment="bottom", theme="arrows")
-        self.add_tour_step("Or click here to see the top result.",
-                           '''[value="I'm Feeling Lucky"]''',
-                           alignment="bottom", theme="arrows")
+        self.add_tour_step(
+            "Then click here to search!", 'input[value="Google Search"]',
+            alignment="bottom", theme="arrows")
+        self.add_tour_step(
+            "Or click here to see the top result.",
+            '''[value="I'm Feeling Lucky"]''',
+            alignment="bottom", theme="arrows")
         self.add_tour_step("Here's an example Google search...",
                            theme="arrows")
-        self.play_tour()
+        self.play_tour(interval=0)  # If interval is 0, tour is fully manual
 
         self.highlight_update_text('input[title="Search"]', "GitHub")
         self.highlight_click('input[value="Google Search"]')
         self.create_tour(theme="dark")
-        self.add_tour_step("Voila! Search results appear here!")
+        self.add_tour_step("Search results appear here!",
+                           title="(5-second autoplay on)")
         self.add_tour_step("Let's take another tour...",
                            title="Ready for more?", theme="square")
-        self.play_tour()
+        self.play_tour(interval=5)  # tour automatically continues after 3s
 
         self.open("https://www.google.com/maps/@42.3598616,-71.0912631,15z")
         self.wait_for_element('input#searchboxinput')
@@ -53,4 +61,4 @@ def test_google_tour(self):
                            '[title="Google apps"]', alignment="left")
         self.add_tour_step("Thanks for trying out SeleniumBase tours!",
                            title="End of Guided Tour", theme="square")
-        self.play_tour()
+        self.play_tour()  # If interval isn't set, tour is fully manual

seleniumbase/core/style_sheet.py

@@ -96,3 +96,47 @@
             padding-left: 20px;
         }
         </style>'''
+
+sh_style_test = (
+    '''
+    let test_tour = new Shepherd.Tour({
+      defaults: {
+        classes: 'shepherd-theme-dark',
+        scrollTo: true
+      }
+    });
+    ''')
+
+sh_backdrop_style = (
+    '''
+    body.shepherd-active .shepherd-target.shepherd-enabled {
+        box-shadow: 0 0 0 99999px rgba(0, 0, 0, 0.22);
+        pointer-events:  none !important;
+        z-index: 9999;
+    }
+
+    body.shepherd-active .shepherd-orphan {
+        box-shadow: 0 0 0 99999px rgba(0, 0, 0, 0.16);
+        pointer-events:  auto;
+        z-index: 9999;
+    }
+
+    body.shepherd-active
+        .shepherd-enabled.shepherd-element-attached-top {
+            position: relative;
+    }
+
+    body.shepherd-active
+        .shepherd-enabled.shepherd-element-attached-bottom {
+            position: relative;
+    }
+
+    body.shepherd-active .shepherd-step {
+        pointer-events:  auto;
+        z-index: 9999;
+    }
+
+    body.shepherd-active {
+        pointer-events:  none !important;
+    }
+    ''')

seleniumbase/fixtures/base_case.py

@@ -42,6 +42,7 @@ def test_anything(self):
 from seleniumbase.core.testcase_manager import TestcaseManager
 from seleniumbase.core import download_helper
 from seleniumbase.core import log_helper
+from seleniumbase.core import style_sheet
 from seleniumbase.fixtures import constants
 from seleniumbase.fixtures import page_actions
 from seleniumbase.fixtures import page_utils
@@ -732,7 +733,7 @@ def add_js_link(self, js_link):
                   script.src = "%s";
                   script.defer;
                   script.crossorigin = "anonymous";
-                  script.onload = function() {$("html")};
+                  script.onload = function() { null };
                   head.appendChild(script);
                }
                injectJS();""")
@@ -755,7 +756,7 @@ def add_js_code_from_link(self, js_link):
             '''var h = document.getElementsByTagName('head').item(0);'''
             '''var s = document.createElement("script");'''
             '''s.type = "text/javascript";'''
-            '''s.onload = function() {$("html")};'''
+            '''s.onload = function() { null };'''
             '''s.appendChild(document.createTextNode("%s"));'''
             '''h.appendChild(s);''')
         self.execute_script(add_js_code_script % re.escape(js_code))
@@ -860,46 +861,8 @@ def __activate_shepherd(self):
         backbone_js = constants.Backbone.MIN_JS
         spinner_css = constants.Messenger.SPINNER_CSS
 
-        backdrop_style = (
-            '''
-            body.shepherd-active .shepherd-target.shepherd-enabled {
-                box-shadow: 0 0 0 99999px rgba(0, 0, 0, 0.22);
-                pointer-events:  none !important;
-                z-index: 9999;
-            }
-
-            body.shepherd-active .shepherd-orphan {
-                box-shadow: 0 0 0 99999px rgba(0, 0, 0, 0.16);
-                pointer-events:  auto;
-                z-index: 9999;
-            }
-
-            body.shepherd-active
-                .shepherd-enabled.shepherd-element-attached-top {
-                    position: relative;
-            }
-
-            body.shepherd-active
-                .shepherd-enabled.shepherd-element-attached-bottom {
-                    position: relative;
-            }
-
-            body.shepherd-active .shepherd-step {
-                pointer-events:  auto;
-                z-index: 9999;
-            }
-
-            body.shepherd-active {
-                pointer-events:  none !important;
-            }
-            ''')
-
-        sh_style = ("""let test_tour = new Shepherd.Tour({
-                      defaults: {
-                        classes: 'shepherd-theme-dark',
-                        scrollTo: true
-                      }
-                    });""")
+        sh_style = style_sheet.sh_style_test
+        backdrop_style = style_sheet.sh_backdrop_style
 
         self.__activate_bootstrap()
         for x in range(4):
@@ -922,7 +885,7 @@ def __activate_shepherd(self):
             for x in range(int(settings.MINI_TIMEOUT * 2.0)):
                 # Shepherd needs a small amount of time to load & activate.
                 try:
-                    self.execute_script(sh_style)
+                    self.execute_script(sh_style)  # Verify Shepherd has loaded
                     self.wait_for_ready_state_complete()
                     self.execute_script(sh_style)  # Need it twice for ordering
                     time.sleep(0.05)
@@ -936,14 +899,9 @@ def __activate_shepherd(self):
             '''directive. ''' % self.driver.current_url)
 
     def __is_shepherd_activated(self):
-        sh_style = ("""let test_tour = new Shepherd.Tour({
-                      defaults: {
-                        classes: 'shepherd-theme-dark',
-                        scrollTo: true
-                      }
-                    });""")
+        sh_style = style_sheet.sh_style_test
         try:
-            self.execute_script(sh_style)
+            self.execute_script(sh_style)  # Verify Shepherd has loaded
             return True
         except Exception:
             return False
@@ -1086,7 +1044,8 @@ def play_tour(self, name=None, interval=0):
                 selector = re.search(
                     "[\S\s]+{element: '([\S\s]+)', on: [\S\s]+",
                     self._tour_steps[name][1]).group(1)
-                self.__wait_for_css_query_selector(selector)
+                self.__wait_for_css_query_selector(
+                    selector, timeout=(settings.SMALL_TIMEOUT))
             except Exception:
                 self.__post_messenger_error_message(
                     "Tour Error: {'%s'} was not found!"
@@ -1149,7 +1108,7 @@ def play_tour(self, name=None, interval=0):
                         ".currentStep.options.attachTo.element")
                     try:
                         self.__wait_for_css_query_selector(
-                            selector, timeout=(settings.MINI_TIMEOUT * 2))
+                            selector, timeout=(settings.MINI_TIMEOUT))
                     except Exception:
                         self.remove_elements("div.shepherd-content")
                         self.__post_messenger_error_message(

setup.py

@@ -7,7 +7,7 @@
 
 setup(
     name='seleniumbase',
-    version='1.13.6',
+    version='1.13.7',
     description='Web Automation & Testing Framework - http://seleniumbase.com',
     long_description='Web Automation and Testing Framework - seleniumbase.com',
     platforms='Mac * Windows * Linux * Docker',