Update boilerplates

Author: mdmintz

examples/boilerplates/base_test_case.py

@@ -0,0 +1,43 @@
+'''
+You can use this as a boilerplate for your test framework.
+Define your customized library methods in a master class like this.
+Then have all your test classes inherit it.
+BaseTestCase will inherit SeleniumBase methods from BaseCase.
+'''
+
+from seleniumbase import BaseCase
+
+
+class BaseTestCase(BaseCase):
+
+    def setUp(self):
+        super(BaseTestCase, self).setUp()
+        # Add custom setUp code for your tests AFTER the super().setUp()
+
+    def tearDown(self):
+        # Add custom tearDown code for your tests BEFORE the super().tearDown()
+        super(BaseTestCase, self).tearDown()
+
+    def login_to_site(self):
+        # <<< Placeholder for actual code. Add your code here. >>>
+        # Add frequently used methods like this in your base test case class.
+        # This reduces the amount of duplicated code in your tests.
+        # If the UI changes, the fix only needs to be applied in one place.
+        pass
+
+    def example_method(self):
+        # <<< Placeholder for actual code. Add your code here. >>>
+        pass
+
+
+'''
+# Now you can do something like this in your test files:
+
+from base_test_case import BaseTestCase
+
+class MyTests(BaseTestCase):
+
+    def test_example(self):
+        self.login_to_site()
+        self.example_method()
+'''

examples/boilerplates/boilerplate_test.py

@@ -0,0 +1,10 @@
+from .base_test_case import BaseTestCase
+from .page_objects import HomePage
+
+
+class MyTestClass(BaseTestCase):
+
+    def test_boilerplate(self):
+        self.login_to_site()
+        self.example_method()
+        self.assert_element(HomePage.html)

examples/boilerplates/master_test_case.py

@@ -6,6 +6,7 @@
 
 
 class HomePage(object):
+    html = "html"
     ok_button = "#ok"
     cancel_button = "#cancel"
     see_items_button = "button.items"
@@ -26,13 +27,13 @@ class CheckoutPage(object):
 '''
 # Now you can do something like this in your test files:
 
-from master_class import MasterTestCase
-from page_objects import HomePage, ShoppingPage, CheckoutPage
+from .base_test_case import BaseTestCase
+from .page_objects import HomePage, ShoppingPage, CheckoutPage
 
-class MyTests(MasterTestCase):
+class MyTests(BaseTestCase):
 
     def test_example(self):
-        self.open(RANDOM_SHOPPING_WEBSITE)
+        self.login_to_site()
         self.click(HomePage.see_items_button)
         self.click(ShoppingPage.buyable_item)
         self.click(ShoppingPage.add_to_cart)

examples/boilerplates/page_objects.py

@@ -3,7 +3,7 @@
 '''
 
 from seleniumbase import BaseCase
-from google_objects import HomePage, ResultsPage
+from .google_objects import HomePage, ResultsPage
 
 
 class GoogleTests(BaseCase):