Merge pull request #1652 from seleniumbase/simplifying-and-upgrading

Simplifying, upgrading, and refactoring

Author: mdmintz

README.md

@@ -1,6 +1,6 @@
 <!-- SeleniumBase Docs -->
 
-## [<img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) Example Tests:
+## [<img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) Example Tests:
 
 <p align="left"><a align="center" href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_demo_site.py"><img align="center" src="https://seleniumbase.github.io/cdn/img/sb_demo_page.png" alt="SeleniumBase Demo Page" width="420" /></a></p>
 
@@ -13,30 +13,30 @@
 
 (NOTE: Some example tests fail on purpose to demonstrate [logging features](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md).)
 
-<h3><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32" /> Example tests with run commands to help you get started:</h3>
-
-Run an [example test](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py) in Chrome: (Default: ``--browser=chrome``)
+--------
 
-```bash
-pytest my_first_test.py
-```
+<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Example tests with run commands to help you get started:</h3>
 
-<img src="https://seleniumbase.github.io/cdn/gif/swag_labs_4.gif" title="Testing Swag Labs with SeleniumBase" /><br />
+--------
 
-Run an [example test](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_demo_site.py) on the SeleniumBase Demo Site:
+Run an [example test](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_demo_site.py): (Default option: ``--browser=chrome``)
 
 ```bash
 pytest test_demo_site.py
 ```
 
 <img src="https://seleniumbase.github.io/cdn/gif/demo_page_4.gif" title="SeleniumBase Demo Page" /><br />
 
+--------
+
 Run an example test in Firefox:
 
 ```bash
 pytest my_first_test.py --browser=firefox
 ```
 
+--------
+
 Run an example test in Demo Mode: (highlight assertions)
 
 ```bash
@@ -45,6 +45,18 @@ pytest test_swag_labs.py --demo
 
 <img src="https://seleniumbase.github.io/cdn/gif/swag_demo_3.gif" /><br />
 
+--------
+
+Run [test_coffee_cart.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_coffee_cart.py) to test the [Coffee Cart](https://seleniumbase.io/coffee/) app:
+
+```bash
+pytest test_coffee_cart.py --demo
+```
+
+<img src="https://seleniumbase.github.io/cdn/gif/coffee_cart.gif" title="SeleniumBase Coffee App Example" alt="SeleniumBase Example" title="SeleniumBase Coffee App Example" />
+
+--------
+
 Run a [Wordle-solver example](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/wordle_test.py):
 
 ```bash
@@ -53,12 +65,16 @@ pytest wordle_test.py
 
 <img src="https://seleniumbase.github.io/cdn/gif/wordle.gif" title="Solving Wordle with SeleniumBase" /><br />
 
+--------
+
 Run an example test in Headless Mode: (invisible browser)
 
 ```bash
 pytest my_first_test.py --headless
 ```
 
+--------
+
 Run an [example test](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_swag_labs.py) using Chrome's mobile device emulator: (default settings)
 
 ```bash
@@ -67,6 +83,8 @@ pytest test_swag_labs.py --mobile
 
 <img src="https://seleniumbase.github.io/cdn/gif/swag_mobile_2.gif" title="SeleniumBase Mobile Mode" /><br />
 
+--------
+
 Run another [example test](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_xkcd.py) in Demo Mode: (highlight assertions)
 
 ```bash
@@ -75,66 +93,88 @@ pytest test_xkcd.py --demo
 
 <img src="https://seleniumbase.github.io/cdn/gif/xkcd_vid.gif" title="SeleniumBase Demo Mode" /><br />
 
+--------
+
 Run a [test suite](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_suite.py) with verbose output: (see more details)
 
 ```bash
 pytest test_suite.py -v
 ```
 
+--------
+
 Run a test suite multi-threaded using [n] threads:
 
 ```bash
 pytest test_suite.py -n=4
 ```
 
+--------
+
 Run a [parameterized test](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/parameterized_test.py): (Generates multiple tests from one)
 
 ```bash
 pytest parameterized_test.py -v
 ```
 
+--------
+
 Run a test suite and generate a SeleniumBase Dashboard:
 
 ```bash
 pytest test_suite.py --dashboard
 ```
 
+--------
+
 Run a test suite and generate a pytest report:
 
 ```bash
 pytest test_suite.py --html=report.html
 ```
 
+--------
+
 Run a [failing test](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_fail.py): (See the ``latest_logs/`` folder for logs and screenshots)
 
 ```bash
 pytest test_fail.py
 ```
 
+--------
+
 Run a failing test with Debug-mode enabled: (``pdb`` activates on failures)
 
 ```bash
 pytest test_fail.py --pdb -s
 ```
 
+--------
+
 Run a test suite that demonstrates the use of pytest markers:
 
 ```bash
 pytest -m marker_test_suite -v
 ```
 
+--------
+
 Run a test suite that reuses the browser session between tests:
 
 ```bash
 pytest test_suite.py --reuse-session
 ```
 
+--------
+
 Run an [example test](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/rate_limiting_test.py) demonstrating the ``rate_limited`` Python decorator:
 
 ```bash
 pytest rate_limiting_test.py
 ```
 
+--------
+
 Run an [example test](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/upload_file_test.py) that demonstrates how to upload a file to a website:
 
 ```bash
@@ -161,12 +201,16 @@ Run an example test with nosetests:
 nosetests my_first_test.py
 ```
 
+--------
+
 Run an example test suite and generate a nosetest report:
 
 ```bash
 nosetests test_suite.py --report --show-report
 ```
 
+--------
+
 Run an example test using a nosetest configuration file:
 
 ```bash
@@ -181,7 +225,7 @@ For more advanced run commands, such as using a proxy server, see [../help_docs/
 
 If you just need to perform some quick website verification on various devices, you can use the <a href="https://seleniumbase.io/devices/">SeleniumBase Device Farm</a>. Just plug in a website URL, and it will display how the website looks on four different devices:
 
-<a href="https://seleniumbase.io/devices/"><img src="https://seleniumbase.github.io/cdn/img/github_demo2.png" width="540" title="SeleniumBase Mobile Mode" /></a><br />
+<a href="https://seleniumbase.io/devices/?url=github.com"><img src="https://seleniumbase.github.io/cdn/img/github_demo2.png" width="540" title="SeleniumBase Mobile Mode" /></a><br />
 
 --------
 
@@ -193,6 +237,18 @@ python gui_test_runner.py
 
 <img src="https://seleniumbase.github.io/cdn/img/gui_test_runner.png" title="GUI Test Runner" width="320" />
 
+(The newer [SeleniumBase Commander](https://seleniumbase.io/help_docs/commander/) improves on that.)
+
+--------
+
+🎖️ To launch the SeleniumBase Commander GUI for pytest:
+
+```bash
+sbase gui
+```
+
+<img src="https://seleniumbase.github.io/cdn/img/sbase_commander_wide.png" title="SeleniumBase Commander" width="600">
+
 --------
 
 <img src="https://seleniumbase.github.io/cdn/img/super_logo_sb.png" title="SeleniumBase" width="320" />

examples/ReadMe.md

@@ -19,6 +19,6 @@ def test_basics(self):
         self.assert_element("div#login_button_container")
 
 
-if __name__ == "__main__":  # Use "python" to call "pytest"
+if __name__ == "__main__":
     from pytest import main
-    main([__file__])
+    main([__file__, "-s"])

examples/basic_test.py

@@ -3,15 +3,14 @@
 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()
+        super().setUp()
         # <<< Run custom setUp() code for tests AFTER the super().setUp() >>>
 
     def tearDown(self):
@@ -24,7 +23,7 @@ def tearDown(self):
             pass
         # (Wrap unreliable tearDown() code in a try/except block.)
         # <<< Run custom tearDown() code BEFORE the super().tearDown() >>>
-        super(BaseTestCase, self).tearDown()
+        super().tearDown()
 
     def login(self):
         # <<< Placeholder. Add your code here. >>>

examples/boilerplates/base_test_case.py

@@ -0,0 +1,64 @@
+"""Use SeleniumBase to test a Coffee Cart App."""
+from seleniumbase import BaseCase
+BaseCase.main(__name__, __file__)
+
+
+class CoffeeCartTests(BaseCase):
+    def test_buy_one_cappuccino(self):
+        self.open("https://seleniumbase.io/coffee/")
+        self.click('div[data-test="Cappuccino"]')
+        self.assert_exact_text("cart (1)", 'a[aria-label="Cart page"]')
+        self.click('a[aria-label="Cart page"]')
+        self.assert_exact_text("Total: $19.00", 'button[data-test="checkout"]')
+        self.click('button[data-test="checkout"]')
+        self.type("input#name", "Selenium Coffee")
+        self.type("input#email", "[email protected]")
+        self.click("button#submit-payment")
+        self.assert_text("Thanks for your purchase.", "div#app div.success")
+        self.assert_exact_text("cart (0)", 'a[aria-label="Cart page"]')
+        self.assert_exact_text("Total: $0.00", 'button[data-test="checkout"]')
+
+    def test_coffee_promo_with_preview(self):
+        self.open("https://seleniumbase.io/coffee/")
+        self.click('div[data-test="Espresso"]')
+        self.click('div[data-test="Americano"]')
+        self.click('div[data-test="Cafe_Latte"]')
+        self.assert_exact_text("cart (3)", 'a[aria-label="Cart page"]')
+        self.assert_text("Get an extra cup of Mocha for $4.", "div.promo")
+        self.click("div.promo button.yes")
+        self.assert_exact_text("cart (4)", 'a[aria-label="Cart page"]')
+        self.hover('button[data-test="checkout"]')
+        self.assert_text("(Discounted) Mocha", "ul.cart-preview")
+        self.assert_exact_text("Total: $37.00", 'button[data-test="checkout"]')
+        self.click('button[data-test="checkout"]')
+        self.type("input#name", "Selenium Coffee")
+        self.type("input#email", "[email protected]")
+        self.click("button#submit-payment")
+        self.assert_text("Thanks for your purchase.", "div#app div.success")
+
+    def test_context_click_add_coffee(self):
+        self.open("https://seleniumbase.io/coffee/")
+        self.context_click('div[data-test="Espresso_Macchiato"]')
+        self.click('form button:contains("Yes")')
+        self.assert_exact_text("cart (1)", 'a[aria-label="Cart page"]')
+        self.click('a[aria-label="Cart page"]')
+        self.assert_exact_text("Total: $12.00", 'button[data-test="checkout"]')
+        self.click('button[data-test="checkout"]')
+        self.type("input#name", "Selenium Coffee")
+        self.type("input#email", "[email protected]")
+        self.click("button#submit-payment")
+        self.assert_text("Thanks for your purchase.", "div#app div.success")
+
+    def test_remove_added_coffee(self):
+        self.open("https://seleniumbase.io/coffee/")
+        self.assert_exact_text("cart (0)", 'a[aria-label="Cart page"]')
+        self.assert_exact_text("Total: $0.00", "button.pay")
+        self.click_visible_elements('div[class="cup-body"]', limit=6)
+        self.assert_exact_text("cart (6)", 'a[aria-label="Cart page"]')
+        self.assert_exact_text("Total: $74.00", 'button[data-test="checkout"]')
+        self.click('a[aria-label="Cart page"]')
+        self.click_visible_elements("button.delete")
+        self.assert_text("No coffee, go add some.", "div#app")
+        self.click('a[aria-label="Menu page"]')
+        self.assert_exact_text("cart (0)", 'a[aria-label="Cart page"]')
+        self.assert_exact_text("Total: $0.00", 'button[data-test="checkout"]')

examples/coffee_cart_tests.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 from seleniumbase import BaseCase
 
 

examples/migration/protractor/mat_paginator_test.py

@@ -28,9 +28,10 @@ def test_swag_labs(self):
         self.assert_element("div#login_button_container")
 
 
-if __name__ == "__main__":  # Use "python" to call "pytest"
+if __name__ == "__main__":  # If "python", run pytest
     from pytest import main
-    main([__file__])
+    from sys import argv
+    main([*argv, "-s"])  # Run pytest using same args
 
 
 #######################################################################

examples/my_first_test.py

@@ -4,5 +4,5 @@
 import pytest
 import subprocess
 
-pytest.main(["test_mfa_login.py", "--chrome", "-v"])
+pytest.main(["test_coffee_cart.py", "--chrome", "-v"])
 subprocess.call(["pytest", "test_mfa_login.py", "--chrome", "-v"])

examples/raw_call.py

@@ -1,11 +1,12 @@
 """Call a file with "python" instead of using "pytest" directly.
 To run, use: "python raw_file_call.py".
-Works by using pytest.main([__file__])."""
+On newer version of SeleniumBase, use:
+BaseCase.main(__name__, __file__)"""
 from seleniumbase import BaseCase
 
-if __name__ == "__main__":  # Use "python" to call "pytest"
+if __name__ == "__main__":  # If "python", run pytest
     from pytest import main
-    main([__file__])
+    main([__file__, "-s"])
 
 
 class TinyMceTest(BaseCase):
@@ -19,5 +20,5 @@ def test_tinymce(self):
         with self.frame_switch("iframe"):
             self.add_text("#tinymce", "SeleniumBase!")
             self.highlight("#tinymce")
-            self.post_message("SeleniumBase is fast!")
-        self.post_message("And SeleniumBase is fun!")
+            self.post_message("SeleniumBase is fast!", duration=1.5)
+        self.post_message("And SeleniumBase is fun!", duration=1.5)

examples/raw_file_call.py

@@ -0,0 +1,19 @@
+"""Call a file with "python" instead of using "pytest" directly.
+To run, type: "python raw_main_call.py"."""
+from seleniumbase import BaseCase
+BaseCase.main(__name__, __file__)
+
+
+class TinyMceTest(BaseCase):
+    def test_tinymce(self):
+        self.open("https://seleniumbase.io/tinymce/")
+        self.wait_for_element("div.mce-container-body")
+        self.click('span:contains("File")')
+        self.click('span:contains("New document")')
+        self.click('span:contains("Paragraph")')
+        self.click('span:contains("Heading 1")')
+        with self.frame_switch("iframe"):
+            self.add_text("#tinymce", "SeleniumBase!")
+            self.highlight("#tinymce")
+            self.post_message("SeleniumBase is fast!", duration=1.5)
+        self.post_message("And SeleniumBase is fun!", duration=1.5)