Merge pull request #376 from seleniumbase/new-methods-scripts-and-updates

New methods, scripts, updates, and tests

Author: mdmintz

README.md

@@ -1,4 +1,4 @@
-[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_3.png" title="SeleniumBase" height="45">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
+[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_3.png" title="SeleniumBase" align="center" height="45">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
 
 [<img src="https://img.shields.io/github/release/seleniumbase/SeleniumBase.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/releases) [<img src="https://dev.azure.com/seleniumbase/seleniumbase/_apis/build/status/seleniumbase.SeleniumBase?branchName=master" alt=" " />](https://dev.azure.com/seleniumbase/seleniumbase/_build/latest?definitionId=1&branchName=master) [<img src="https://travis-ci.org/seleniumbase/SeleniumBase.svg?branch=master" alt=" " />](https://travis-ci.org/seleniumbase/SeleniumBase) [<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt=" " />](https://gitter.im/seleniumbase/SeleniumBase) [<img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE) [<img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/stargazers)<br />
 
@@ -23,9 +23,9 @@ With Python installed and on your System PATH, you can get the latest ``pip`` wi
 python -m easy_install -U pip
 ```
 
-### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Setup a Virtual Environment: (Optional)
+### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Setup a Python Virtual Env:
 
-You may want to use a **Python Virtual Environment** to isolate Python dependencies between projects. Instructions on creating one can be found **[here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md)**. (<i>Learn more about virtual environments on the official site **[here](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/)**.</i>)
+It is **recommended** to use a **Python Virtual Environment** to isolate Python dependencies between projects. Instructions on creating one can be found **[here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md)**. (<i>Learn more about virtual environments on the **[official site](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/)**.</i>)
 
 ### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Install ``seleniumbase``: [<img src="https://img.shields.io/badge/pypi-seleniumbase-22AAEE.svg" alt=" " />](https://pypi.python.org/pypi/seleniumbase)
 ```bash

examples/ReadMe.md

@@ -70,16 +70,13 @@ Run a test that demonstrates how to upload a file to a website:
 pytest upload_file_test.py
 ```
 
-For more advanced run commands, such as using a proxy server,  see [../help_docs/customizing_test_runs.md](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md)
+For more advanced run commands, such as using a proxy server, see [../help_docs/customizing_test_runs.md](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md)
 
 --------
 
-To makes things easier, here's a simple GUI program that allows you to kick off a few example scripts by pressing a button:
+To makes things easier, here's a simple GUI program that allows you to run a few example scripts by pressing a button:
 
 ```bash
 python gui_test_runner.py
 ```
-
-<img src="https://cdn2.hubspot.net/hubfs/100006/images/The_GUI_Runner.png" title="GUI Test Runner" height="400">
-
-(NOTE: If you see any ``*.pyc`` files appear as you run tests, that's perfectly normal. Compiled bytecode is a natural result of running Python code.)
+<img src="https://cdn2.hubspot.net/hubfs/100006/images/gui_test_runner_py.png" title="GUI Test Runner">

examples/decryption_test.py

@@ -0,0 +1,24 @@
+"""
+This test demonstrates the use of encryption/decryption.
+(Technically, obfuscation/unobfuscation.)
+"""
+
+from seleniumbase import BaseCase
+from seleniumbase import encryption
+
+
+class MyTestClass(BaseCase):
+
+    def test_rate_limited_printing(self):
+        self.open("https://www.saucedemo.com/")
+        self.update_text("#user-name", "standard_user")
+
+        encrypted_password = "$^*ENCRYPT=S3BDTAdCWzMmKEY8Gjg=?&#$"
+        print("Encrypted Password = %s" % encrypted_password)
+        password = encryption.decrypt(encrypted_password)
+        print("Password = %s" % password)
+        self.update_text("#password", password)
+
+        self.click('input[type="submit"]')
+        self.assert_text("Products", "div.product_label")
+        self.assert_element("#inventory_container")

examples/gui_test_runner.py

@@ -1,73 +1,74 @@
 '''
 GUI TEST RUNNER
 Run by Typing: "python gui_test_runner.py"
+(Use Python 3 - There are GUI issues when using Python 2)
 '''
 
-try:
-    # Python 2
-    from Tkinter import Tk, Frame, Button, Label
-except Exception:
-    # Python 3
-    from tkinter import Tk, Frame, Button, Label
 import os
+import sys
+if sys.version_info[0] >= 3:
+    from tkinter import Tk, Frame, Button, Label
+else:
+    from Tkinter import Tk, Frame, Button, Label
 
 
 class App:
 
     def __init__(self, master):
-        frame = Frame()
+        frame = Frame(master)
         frame.pack()
-        root.title("Select Test Job To Run")
         self.label = Label(root, width=40).pack()
         self.title = Label(frame, text="", fg="black").pack()
         self.title1 = Label(
-            frame, text="Basic Test Run in Chrome:", fg="blue").pack()
+            frame, text=("Run a Test in Chrome:"), fg="blue").pack()
         self.run1 = Button(
             frame, command=self.run_1,
-            text=("pytest my_first_test.py"
-                  " --browser=chrome")).pack()
+            text=("pytest my_first_test.py --browser=chrome"),
+            fg="green").pack()
         self.title2 = Label(
-            frame, text="Basic Test Run in Firefox:", fg="blue").pack()
+            frame, text=("Run a Test in Firefox:"), fg="blue").pack()
         self.run2 = Button(
             frame, command=self.run_2,
-            text=("pytest my_first_test.py"
-                  " --browser=firefox")).pack()
+            text=("pytest my_first_test.py --browser=firefox"),
+            fg="green").pack()
         self.title3 = Label(
-            frame, text="Basic Test Run in Demo Mode:", fg="blue").pack()
+            frame, text="Run a Test with Demo Mode:", fg="blue").pack()
         self.run3 = Button(
             frame, command=self.run_3,
-            text=("pytest my_first_test.py"
-                  " --browser=chrome --demo_mode")).pack()
+            text=("pytest my_first_test.py --browser=chrome --demo_mode"),
+            fg="green").pack()
         self.title4 = Label(
             frame,
-            text="Basic Failing Test Run with Screenshots:",
+            text="Run a Parameterized Test:",
             fg="blue").pack()
         self.run4 = Button(
             frame, command=self.run_4,
-            text=("nosetests test_fail.py"
-                  " --browser=chrome --demo_mode")).pack()
+            text=("pytest parameterized_test.py --browser=chrome"),
+            fg="green").pack()
         self.title5 = Label(
             frame,
-            text="Basic Failing Test Suite Run with Test Report:",
+            text="Run a Failing Test (automatic screenshots):",
             fg="blue").pack()
         self.run5 = Button(
             frame, command=self.run_5,
-            text=("nosetests test_suite.py --report --show_report")).pack()
+            text=("pytest test_fail.py --browser=chrome"),
+            fg="red").pack()
         self.title6 = Label(
             frame,
-            text="Basic Failing Test Run showing the Multiple-Checks feature:",
+            text="Run a Failing Test Suite with a Test Report:",
             fg="blue").pack()
         self.run6 = Button(
             frame, command=self.run_6,
-            text=("nosetests delayed_assert_test.py --browser=chrome")).pack()
+            text=("pytest test_suite.py --browser=chrome --html=report.html"),
+            fg="red").pack()
         self.title7 = Label(
             frame,
-            text="Use MySQL DB Reporting: (See ReadMe.md for Setup Steps!)",
+            text="Run a Failing Test with Delayed Asserts:",
             fg="blue").pack()
         self.run7 = Button(
             frame, command=self.run_7,
-            text=("nosetests test_suite.py"
-                  " --browser=chrome --with-db_reporting")).pack()
+            text=("pytest test_delayed_asserts.py --browser=chrome"),
+            fg="red").pack()
         self.end_title = Label(frame, text="", fg="black").pack()
         self.quit = Button(frame, text="QUIT", command=frame.quit).pack()
 
@@ -81,29 +82,28 @@ def run_2(self):
 
     def run_3(self):
         os.system(
-            'pytest my_first_test.py --demo_mode'
-            ' --browser=chrome')
+            'pytest my_first_test.py --browser=chrome --demo_mode')
 
     def run_4(self):
         os.system(
-            'nosetests test_fail.py --browser=chrome --demo_mode')
+            'pytest parameterized_test.py --browser=chrome')
 
     def run_5(self):
         os.system(
-            'nosetests test_suite.py --report --show_report')
+            'pytest test_fail.py --browser=chrome')
 
     def run_6(self):
         os.system(
-            'nosetests delayed_assert_test.py --browser=chrome')
+            'pytest test_suite.py --browser=chrome --html=report.html')
 
     def run_7(self):
         os.system(
-            'nosetests test_suite.py'
-            ' --browser=chrome --with-db_reporting')
+            'pytest test_delayed_asserts.py --browser=chrome')
 
 
 if __name__ == "__main__":
     root = Tk()
-    root.minsize(532, 444)
+    root.title("Select Test Job To Run")
+    root.minsize(500, 420)
     app = App(root)
     root.mainloop()

examples/raw_parameter_script.py

@@ -25,47 +25,47 @@
     # Example run command:  "python raw_parameter_script.py"
     from my_first_test import MyTestClass  # (relative imports DON'T work)
 
-    b = MyTestClass("test_basic")
-    b.browser = "chrome"
-    b.headless = False
-    b.headed = False
-    b.start_page = None
-    b.servername = "localhost"
-    b.port = 4444
-    b.data = None
-    b.environment = "test"
-    b.user_agent = None
-    b.extension_zip = None
-    b.extension_dir = None
-    b.database_env = "test"
-    b.log_path = "latest_logs/"
-    b.archive_logs = False
-    b.disable_csp = False
-    b.enable_sync = False
-    b.visual_baseline = False
-    b.maximize_option = False
-    b.save_screenshot_after_test = False
-    b.timeout_multiplier = None
-    b.pytest_html_report = None
-    b.report_on = False
-    b.with_db_reporting = False
-    b.with_s3_logging = False
-    b.js_checking_on = False
-    b.is_pytest = False
-    b.demo_mode = False
-    b.demo_sleep = 1
-    b.message_duration = 2
-    b.settings_file = None
-    b.user_data_dir = None
-    b.proxy_string = None
-    b.ad_block_on = False
-    b.highlights = None
-    b.check_js = False
-    b.cap_file = None
+    sb = MyTestClass("test_basic")
+    sb.browser = "chrome"
+    sb.headless = False
+    sb.headed = False
+    sb.start_page = None
+    sb.servername = "localhost"
+    sb.port = 4444
+    sb.data = None
+    sb.environment = "test"
+    sb.user_agent = None
+    sb.extension_zip = None
+    sb.extension_dir = None
+    sb.database_env = "test"
+    sb.log_path = "latest_logs/"
+    sb.archive_logs = False
+    sb.disable_csp = False
+    sb.enable_sync = False
+    sb.visual_baseline = False
+    sb.maximize_option = False
+    sb.save_screenshot_after_test = False
+    sb.timeout_multiplier = None
+    sb.pytest_html_report = None
+    sb.report_on = False
+    sb.with_db_reporting = False
+    sb.with_s3_logging = False
+    sb.js_checking_on = False
+    sb.is_pytest = False
+    sb.demo_mode = False
+    sb.demo_sleep = 1
+    sb.message_duration = 2
+    sb.settings_file = None
+    sb.user_data_dir = None
+    sb.proxy_string = None
+    sb.ad_block_on = False
+    sb.highlights = None
+    sb.check_js = False
+    sb.cap_file = None
 
-    b.setUp()
+    sb.setUp()
     try:
-        b.test_basic()
+        sb.test_basic()
     finally:
-        b.tearDown()
-        del b
+        sb.tearDown()
+        del sb

examples/delayed_assert_test.py renamed to examples/test_delayed_asserts.py

@@ -1,6 +1,6 @@
 ## SeleniumBase Website Tours
 
-SeleniumBase Tours utilize your choice of 4 different JavaScript libraries for prototyping tours, demos, walkthroughs, and onboarding experiences on any website: **[Shepherd](https://shipshapecode.github.io/shepherd/docs/welcome/)**, **[Bootstrap Tour](http://bootstraptour.com/)**, **[IntroJS](https://introjs.com/)**, and **[Hopscotch](http://linkedin.github.io/hopscotch/)**. Choose your favorite one to use!
+SeleniumBase Tours utilize your choice of 4 different JavaScript libraries for prototyping walkthroughs, onboarding experiences, and digital adoption solutions on any website:<br>**[Shepherd](https://shipshapecode.github.io/shepherd/docs/welcome/)**, **[Bootstrap Tour](http://bootstraptour.com/)**, **[IntroJS](https://introjs.com/)**, and **[Hopscotch](http://linkedin.github.io/hopscotch/)**.<br>Choose your favorite one to use!
 
 Example tour:
 
@@ -9,7 +9,7 @@ cd examples/tour_examples
 pytest google_tour.py
 ```
 
-<img src="https://cdn2.hubspot.net/hubfs/100006/google_tour_3.gif" title="SeleniumBase Tour of Google" height="260"><br>
+<img src="https://cdn2.hubspot.net/hubfs/100006/google_tour_3.gif" title="SeleniumBase Tour of Google"><br>
 
 
 ### Creating a new tour: