Merge pull request #274 from seleniumbase/tour-update

Save the URL with exported SeleniumBase tours

Author: mdmintz

help_docs/method_summary.md

@@ -114,7 +114,7 @@ self.add_tour_step(message, selector=None, name=None,
 
 self.play_tour(name=None)
 
-self.export_tour(name=None, filename="my_tour.js")
+self.export_tour(name=None, filename="my_tour.js", url=None)
 
 self.activate_jquery_confirm()
 

seleniumbase/core/tour_helper.py

@@ -631,7 +631,7 @@ def play_introjs_tour(
                 time.sleep(0.1)
 
 
-def export_tour(tour_steps, name=None, filename="my_tour.js"):
+def export_tour(tour_steps, name=None, filename="my_tour.js", url=None):
     """ Exports a tour as a JS file.
         It will include necessary resources as well, such as jQuery.
         You'll be able to copy the tour directly into the Console of
@@ -642,6 +642,8 @@ def export_tour(tour_steps, name=None, filename="my_tour.js"):
         raise Exception("Tour {%s} does not exist!" % name)
     if not filename.endswith('.js'):
         raise Exception('Tour file must end in ".js"!')
+    if not url:
+        url = "data:,"
 
     tour_type = None
     if "Bootstrap" in tour_steps[name][0]:
@@ -656,6 +658,10 @@ def export_tour(tour_steps, name=None, filename="my_tour.js"):
         raise Exception('Unknown tour type!')
 
     instructions = (
+        '''////////  Load Tour Start Page (if not there now)  ////////\n\n'''
+        '''if (window.location.href != "%s") {\n'''
+        '''    window.location.href="%s";\n'''
+        '''}\n\n'''
         '''////////  Resources  ////////\n\n'''
         '''function injectCSS(css_link) {'''
         '''var head = document.getElementsByTagName("head")[0];'''
@@ -682,7 +688,7 @@ def export_tour(tour_steps, name=None, filename="my_tour.js"):
         '''style.type = "text/css";'''
         '''style.appendChild(document.createTextNode(css));'''
         '''head.appendChild(style);'''
-        '''};\n''')
+        '''};\n''' % (url, url))
 
     if tour_type == "bootstrap":
         jquery_js = constants.JQuery.MIN_JS
@@ -752,16 +758,14 @@ def export_tour(tour_steps, name=None, filename="my_tour.js"):
             // Start the tour
             tour.start();
             $tour = tour;
-            $tour.restart();\n
-            """)
+            $tour.restart();\n""")
     elif tour_type == "hopscotch":
         instructions += (
             """]
             };
             // Start the tour!
             hopscotch.startTour(tour);
-            $tour = hopscotch;\n
-            """)
+            $tour = hopscotch;\n""")
     elif tour_type == "introjs":
         instructions += (
             """]
@@ -777,14 +781,12 @@ def export_tour(tour_steps, name=None, filename="my_tour.js"):
             intro.start();
             $tour = intro;
             };
-            startIntro();\n
-            """)
+            startIntro();\n""")
     elif tour_type == "shepherd":
         instructions += (
             """
             tour.start();
-            $tour = tour;\n
-            """)
+            $tour = tour;\n""")
     else:
         pass
 

seleniumbase/fixtures/base_case.py

@@ -1181,10 +1181,10 @@ def play_tour(self, name=None, interval=0):
                 self.driver, self._tour_steps,
                 self.message_duration, name=name, interval=interval)
 
-    def export_tour(self, name=None, filename="my_tour.js"):
+    def export_tour(self, name=None, filename="my_tour.js", url=None):
         """ Exports a tour as a JS file.
-            You can call self.export_tour() anywhere where you could
-            normally use self.play_tour()
+            You can call self.export_tour() anywhere where you would
+            normally use self.play_tour() to play a tour.
             It will include necessary resources as well, such as jQuery.
             You'll be able to copy the tour directly into the Console of
             any web browser to play the tour outside of SeleniumBase runs.
@@ -1193,7 +1193,10 @@ def export_tour(self, name=None, filename="my_tour.js"):
                    use this to select the tour you wish to add steps to.
             filename - The name of the JavaScript file that you wish to
                    save the tour to. """
-        tour_helper.export_tour(self._tour_steps, name=name, filename=filename)
+        if not url:
+            url = self.get_current_url()
+        tour_helper.export_tour(
+            self._tour_steps, name=name, filename=filename, url=url)
 
     def activate_jquery_confirm(self):
         """ See https://craftpip.github.io/jquery-confirm/ for usage. """

setup.py

@@ -17,7 +17,7 @@
 
 setup(
     name='seleniumbase',
-    version='1.19.1',
+    version='1.19.2',
     description='Easy, Fast, Reliable Browser Automation & Testing Framework',
     long_description=long_description,
     long_description_content_type='text/markdown',