Merge pull request #896 from seleniumbase/update-console-scripts-and-dashboard

Update console scripts and dashboard display

Author: mdmintz

docs/requirements.txt

@@ -11,7 +11,7 @@ importlib-metadata==4.0.1;python_version>="3.6"
 lunr==0.5.8
 mkdocs==1.1.2
 mkdocs-material==7.1.3
-mkdocs-exclude-search==0.5.1;python_version>="3.6"
+mkdocs-exclude-search==0.5.2;python_version>="3.6"
 mkdocs-simple-hooks==0.1.3
 mkdocs-material-extensions==1.0.1
 mkdocs-minify-plugin==0.4.0

examples/boilerplates/base_test_case.py

@@ -1,16 +1,15 @@
-'''
+"""
 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.
 With Python 3, simplify "super(...)" to super().setUp() and super().tearDown()
-'''
+"""
 
 from seleniumbase import BaseCase
 
 
 class BaseTestCase(BaseCase):
-
     def setUp(self):
         super(BaseTestCase, self).setUp()
         # <<< Run custom setUp() code for tests AFTER the super().setUp() >>>
@@ -38,7 +37,7 @@ def example_method(self):
         pass
 
 
-'''
+"""
 # Now you can do something like this in your test files:
 
 from base_test_case import BaseTestCase
@@ -51,4 +50,4 @@ def test_example(self):
         self.type("input", "Name")
         self.click("form button")
         ...
-'''
+"""

examples/boilerplates/boilerplate_test.py

@@ -3,7 +3,6 @@
 
 
 class MyTestClass(BaseTestCase):
-
     def test_boilerplate(self):
         self.login()
         self.example_method()

examples/boilerplates/classic_obj_test.py

@@ -2,8 +2,7 @@
 from seleniumbase import BaseCase
 
 
-class DataPage():
-
+class DataPage:
     def go_to_data_url(self, sb):
         sb.open("data:text/html,<p>Hello!</p><input />")
 
@@ -12,7 +11,6 @@ def add_input_text(self, sb, text):
 
 
 class ObjTests(BaseCase):
-
     def test_data_url_page(self):
         DataPage().go_to_data_url(self)
         self.assert_text("Hello!", "p")

examples/boilerplates/file_parsing/parse_files.py

@@ -1,46 +1,50 @@
-'''
+"""
 Demonstration of parsing data from files.
 In this example, login information is pulled for tests.
-'''
+"""
 
 from seleniumbase import BaseCase
 
 
 class ParseTestCase(BaseCase):
-
     def setUp(self):
         super(ParseTestCase, self).setUp()
 
     def get_login_credentials(self, user_type):
         # Example of parsing data from a file (Method 1)
-        with open('qa_login_example.txt') as f:
+        with open("qa_login_example.txt") as f:
             file_lines = [line.rstrip() for line in f]
         for line in file_lines:
-            line_items = line.split(',')
+            line_items = line.split(",")
             if line_items[0] == user_type:
                 return line_items[1], line_items[2]
 
     def get_all_login_credentials(self):
         # Example of parsing data from a file (Method 2)
         keys = {}
-        with open('staging_login_example.txt') as f:
+        with open("staging_login_example.txt") as f:
             file_lines = [line.rstrip() for line in f]
         for line in file_lines:
-            line_items = line.split(',')
-            if line_items[0] == 'admin':
-                keys['admin'] = (
-                    {'username': line_items[1], 'password': line_items[2]})
-            if line_items[0] == 'employee':
-                keys['employee'] = (
-                    {'username': line_items[1], 'password': line_items[2]})
-            if line_items[0] == 'customer':
-                keys['customer'] = (
-                    {'username': line_items[1], 'password': line_items[2]})
+            line_items = line.split(",")
+            if line_items[0] == "admin":
+                keys["admin"] = {
+                    "username": line_items[1],
+                    "password": line_items[2],
+                }
+            if line_items[0] == "employee":
+                keys["employee"] = {
+                    "username": line_items[1],
+                    "password": line_items[2],
+                }
+            if line_items[0] == "customer":
+                keys["customer"] = {
+                    "username": line_items[1],
+                    "password": line_items[2],
+                }
         return keys
 
 
 class ParseTests(ParseTestCase):
-
     def test_get_login_credentials(self):
         print("\nExample 1 of getting login info from parsing a config file:")
         print("")

examples/boilerplates/page_objects.py

@@ -1,8 +1,8 @@
-'''
+"""
 Example of using the Page Object Pattern for tests, using CSS selectors.
 Helps make your code more Readable, Maintainable, and Reusable.
 Import a file like this at the top of your test files.
-'''
+"""
 
 
 class Page(object):
@@ -28,7 +28,7 @@ class CheckoutPage(object):
     shop_more = "#shop-more"
 
 
-'''
+"""
 # Now you can do something like this in your test files:
 
 from .base_test_case import BaseTestCase
@@ -44,4 +44,4 @@ def test_example(self):
         self.click(CheckoutPage.buy_now)
         self.assert_element("#success")
         self.assert_text("Order Received!", "#h2")
-'''
+"""

examples/boilerplates/samples/google_objects.py

@@ -6,10 +6,10 @@ class HomePage(object):
     search_box = 'input[title="Search"]'
     list_box = '[role="listbox"]'
     search_button = 'input[value="Google Search"]'
-    feeling_lucky_button = '''input[value="I'm Feeling Lucky"]'''
+    feeling_lucky_button = """input[value="I'm Feeling Lucky"]"""
 
 
 class ResultsPage(object):
     google_logo = 'img[alt="Google"]'
-    images_link = 'link=Images'
-    search_results = 'div#center_col'
+    images_link = "link=Images"
+    search_results = "div#center_col"

examples/boilerplates/samples/google_test.py

@@ -5,13 +5,12 @@
 
 
 class GoogleTests(BaseCase):
-
     def test_google_dot_com(self):
-        self.open('https://google.com/ncr')
-        self.type(HomePage.search_box, 'github')
+        self.open("https://google.com/ncr")
+        self.type(HomePage.search_box, "github")
         self.assert_element(HomePage.list_box)
         self.assert_element(HomePage.search_button)
         self.assert_element(HomePage.feeling_lucky_button)
         self.click(HomePage.search_button)
-        self.assert_text('github.com', ResultsPage.search_results)
+        self.assert_text("github.com", ResultsPage.search_results)
         self.assert_element(ResultsPage.images_link)

examples/boilerplates/samples/sb_swag_test.py

@@ -1,17 +1,15 @@
 """ Classic Page Object Model with the "sb" fixture """
 
 
-class LoginPage():
-
+class LoginPage:
     def login_to_swag_labs(self, sb, username):
         sb.open("https://www.saucedemo.com")
         sb.type("#user-name", username)
         sb.type("#password", "secret_sauce")
         sb.click('input[type="submit"]')
 
 
-class MyTests():
-
+class MyTests:
     def test_swag_labs_login(self, sb):
         LoginPage().login_to_swag_labs(sb, "standard_user")
         sb.assert_element("#inventory_container")

examples/boilerplates/samples/swag_labs_test.py

@@ -3,8 +3,7 @@
 from seleniumbase import BaseCase
 
 
-class LoginPage():
-
+class LoginPage:
     def login_to_swag_labs(self, sb, username):
         sb.open("https://www.saucedemo.com")
         sb.type("#user-name", username)
@@ -13,7 +12,6 @@ def login_to_swag_labs(self, sb, username):
 
 
 class MyTests(BaseCase):
-
     def test_swag_labs_login(self):
         LoginPage().login_to_swag_labs(self, "standard_user")
         self.assert_element("#inventory_container")