Merge pull request #217 from seleniumbase/exporting-tours

Add the ability to export a website tour as a .js file

Author: mdmintz

README.md

@@ -49,7 +49,7 @@ pytest my_first_test.py --demo_mode
 ```
 
 <img src="https://cdn2.hubspot.net/hubfs/100006/sb_demo_mode.gif" title="SeleniumBase" height="270"><br>
-(Above: Actual demo of [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py) running on [xkcd.com](http://xkcd.com/353/))
+(Above: Actual demo of [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py) running on [xkcd.com](https://xkcd.com/353/))
 
 There are many more examples to try out from the [SeleniumBase/examples](https://github.com/seleniumbase/SeleniumBase/blob/master/examples) directory, which you can run easily if you clone SeleniumBase.
 
@@ -181,18 +181,18 @@ from seleniumbase import BaseCase
 class MyTestClass(BaseCase):
 
     def test_basic(self):
-        self.open('http://xkcd.com/353/')
+        self.open('https://xkcd.com/353/')
         self.assert_element('img[alt="Python"]')
         self.click('a[rel="license"]')
         self.assert_text('free to copy', 'div center')
-        self.open("http://xkcd.com/1481/")
+        self.open("https://xkcd.com/1481/")
         title = self.get_attribute("#comic img", "title")
         self.assertTrue("86,400 seconds per day" in title)
         self.click('link=Blag')
         self.assert_text('The blag of the webcomic', 'h2')
         self.update_text('input#s', 'Robots!\n')
         self.assert_text('Hooray robots!', '#content')
-        self.open('http://xkcd.com/1319/')
+        self.open('https://xkcd.com/1319/')
         self.assert_text('Automation', 'div#ctitle')
 ```
 (<i>By default, [CSS Selectors](https://www.w3schools.com/cssref/css_selectors.asp) are used for finding page elements.</i>)
@@ -393,7 +393,7 @@ from seleniumbase import BaseCase
 class MyTestClass(BaseCase):
 
     def test_find_army_of_robots_on_xkcd_desert_island(self):
-        self.open("http://xkcd.com/731/")
+        self.open("https://xkcd.com/731/")
         self.assert_element("div#ARMY_OF_ROBOTS", timeout=1)  # This should fail
 ```
 
@@ -661,7 +661,7 @@ from seleniumbase import BaseCase
 class MyTestClass(BaseCase):
 
     def test_delayed_asserts(self):
-        self.open('http://xkcd.com/993/')
+        self.open('https://xkcd.com/993/')
         self.wait_for_element('#comic')
         self.delayed_assert_element('img[alt="Brand Identity"]')
         self.delayed_assert_element('img[alt="Rocket Ship"]')  # Will Fail
@@ -685,6 +685,15 @@ self.driver.find_elements_by_partial_link_text("GitHub")
 ```
 (In general, you'll want to use the SeleniumBase versions of methods when available.)
 
+#### Retry Failing Tests Automatically
+
+You can use ``--reruns #`` to retry failing tests that many times. Use ``--reruns-delay #`` to wait that many seconds between retries. Example:
+```
+pytest --reruns 5 --reruns-delay 1
+```
+
+Additionally, you can use the ``@retry_on_exception()`` decorator to specifically retry failing methods. (First import: ``from seleniumbase import decorators``) To learn more about SeleniumBase decorators, [click here](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/common).
+
 ####  Checking Email: 
 Let's say you have a test that sends an email, and now you want to check that the email was received:
 

examples/basic_script.py

@@ -8,9 +8,9 @@
 class MyTestClass(BaseCase):
 
     def test_basic(self):
-        self.open('http://xkcd.com/353/')
+        self.open('https://xkcd.com/353/')
         self.click('a[rel="license"]')
-        self.open('http://xkcd.com/1481/')
+        self.open('https://xkcd.com/1481/')
         self.click("link=Blag")
         self.update_text('input#s', 'Robots!\n')
-        self.open('http://xkcd.com/1319/')
+        self.open('https://xkcd.com/1319/')

examples/delayed_assert_test.py

@@ -4,7 +4,7 @@
 class MyTestClass(BaseCase):
 
     def test_delayed_asserts(self):
-        self.open('http://xkcd.com/993/')
+        self.open('https://xkcd.com/993/')
         self.wait_for_element('#comic')
         self.delayed_assert_element('img[alt="Brand Identity"]')
         self.delayed_assert_element('img[alt="Rocket Ship"]')  # Will Fail

examples/my_first_test.py

@@ -4,18 +4,18 @@
 class MyTestClass(BaseCase):
 
     def test_basic(self):
-        self.open('http://xkcd.com/353/')            # Navigate to the web page
+        self.open('https://xkcd.com/353/')            # Navigate to the web 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.open("http://xkcd.com/1481/")
+        self.open("https://xkcd.com/1481/")
         title = self.get_attribute("#comic img", "title")    # Get an attribute
         self.assertTrue("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('http://xkcd.com/1319/')
+        self.open('https://xkcd.com/1319/')
         self.assert_text('Automation', 'div#ctitle')
 
         ####

examples/my_test_suite.py

@@ -6,7 +6,7 @@
 class MyTestSuite(BaseCase):
 
     def test_1(self):
-        self.open("http://xkcd.com/1663/")
+        self.open("https://xkcd.com/1663/")
         self.find_text("Garden", "div#ctitle", timeout=3)
         for p in range(4):
             self.click('a[rel="next"]')
@@ -15,17 +15,17 @@ def test_1(self):
     def test_2(self):
         # This test should FAIL
         print("\n(This test fails on purpose)")
-        self.open("http://xkcd.com/1675/")
+        self.open("https://xkcd.com/1675/")
         raise Exception("FAKE EXCEPTION: This test fails on purpose.")
 
     def test_3(self):
-        self.open("http://xkcd.com/1406/")
+        self.open("https://xkcd.com/1406/")
         self.find_text("Universal Converter Box", "div#ctitle", timeout=3)
-        self.open("http://xkcd.com/608/")
+        self.open("https://xkcd.com/608/")
         self.find_text("Form", "div#ctitle", timeout=3)
 
     def test_4(self):
         # This test should FAIL
         print("\n(This test fails on purpose)")
-        self.open("http://xkcd.com/1670/")
+        self.open("https://xkcd.com/1670/")
         self.find_element("FakeElement.DoesNotExist", timeout=0.5)

examples/test_fail.py

@@ -7,6 +7,6 @@
 class MyTestClass(BaseCase):
 
     def test_find_army_of_robots_on_xkcd_desert_island(self):
-        self.open("http://xkcd.com/731/")
+        self.open("https://xkcd.com/731/")
         print("\n(This test fails on purpose)")
         self.assert_element("div#ARMY_OF_ROBOTS", timeout=1)

examples/tour_examples/ReadMe.md

@@ -97,3 +97,15 @@ class MyTourClass(BaseCase):
 ```bash
 pytest google_tour.py
 ```
+
+### Exporting a Tour:
+
+If you want to save the tour you created as a Javascript file, use:
+
+``self.export_tour()``
+
+OR
+
+``self.export_tour(name=None, filename="my_tour.js")``
+
+(``name`` is optional, needed only if you were creating multiple tours at once. ``filename`` is the name of the file to save the Javascript to.) Once you've exported your tour, you can use it outside of SeleniumBase. You can even copy the tour's Javascript code to the Console of your web browser to play the tour from there (you need to be on the correct web page for it to work).

examples/tour_examples/xkcd_tour.py

@@ -0,0 +1,22 @@
+from seleniumbase import BaseCase
+
+
+class MyTestClass(BaseCase):
+
+    def test_basic(self):
+        self.open('https://xkcd.com/1117/')
+        self.assert_element('img[alt="My Sky"]')
+        self.create_shepherd_tour()
+        self.add_tour_step("Welcome to XKCD!")
+        self.add_tour_step("This is the XKCD logo.", "#masthead img")
+        self.add_tour_step("Here's the daily webcomic.", "#comic img")
+        self.add_tour_step("This is the title.", "#ctitle", alignment="top")
+        self.add_tour_step("Click here for the next comic.", 'a[rel="next"]')
+        self.add_tour_step("Or here for the previous comic.", 'a[rel="prev"]')
+        self.add_tour_step("Learn about the author here.", 'a[rel="author"]')
+        self.add_tour_step("Click for the license here.", 'a[rel="license"]')
+        self.add_tour_step("This selects a random comic.", 'a[href*="random"]')
+        self.add_tour_step("Thanks for taking this tour!")
+        # self.export_tour()  # Use this to export the tour as a .js file
+        self.play_tour()
+

help_docs/method_summary.md

@@ -110,6 +110,8 @@ self.add_tour_step(message, selector=None, name=None,
 
 self.play_tour(name=None)
 
+self.export_tour(name=None, filename="my_tour.js")
+
 self.activate_messenger()
 
 self.post_message(message, style="info", duration=None)

seleniumbase/common/ReadMe.md

@@ -11,7 +11,7 @@
 Example demonstrating a rate-limited printing functionality:
 ```python
 import unittest
-from seleniumbase.common import decorators
+from seleniumbase import decorators
 
 
 class MyTestClass(unittest.TestCase):