Merge pull request #1653 from seleniumbase/refactoring-and-recorder-updates

Refactoring and Recorder updates

Author: mdmintz

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2022 Michael Mintz
+Copyright (c) 2014-2023 Michael Mintz
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -7,9 +7,9 @@
 <meta property="og:image" content="https://seleniumbase.github.io/cdn/img/mac_sb_logo_5b.png" />
 <link rel="icon" href="https://seleniumbase.github.io/img/logo7.png" />
 
-<h3 align="center"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/mac_sb_logo_b.png" alt="SeleniumBase" title="SeleniumBase" width="408" /></a></h3>
+<h3 align="center"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/sb_logo_10t.png" alt="SeleniumBase" title="SeleniumBase" width="350" /></a></h3>
 
-<h2 align="center">SeleniumBase: Enterprise Python Web Testing</h2>
+<h2 align="center">Python Web UI Testing Framework</h2>
 
 <p align="center"><a href="https://pypi.python.org/pypi/seleniumbase" target="_blank"><img src="https://img.shields.io/pypi/v/seleniumbase.svg?color=3399EE" alt="PyPI version" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/releases" target="_blank"><img src="https://img.shields.io/github/v/release/seleniumbase/SeleniumBase.svg?color=22AAEE" alt="GitHub version" /></a> <a href="https://seleniumbase.io"><img src="https://img.shields.io/badge/docs-seleniumbase.io-11BBAA.svg" alt="SeleniumBase Docs" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/actions" target="_blank"><img src="https://github.com/seleniumbase/SeleniumBase/workflows/CI%20build/badge.svg" alt="SeleniumBase GitHub Actions" /></a> <a href="https://gitter.im/seleniumbase/SeleniumBase" target="_blank"><img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt="SeleniumBase" /></a></p>
 
@@ -24,7 +24,7 @@
 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md">📘 APIs</a> |
 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md"> 🔡 Formats</a> |
 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md">📊 Dashboard</a> |
-<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/recorder_mode.md">⏺️ Recorder</a> |
+<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/recorder_mode.md">🔴 Recorder</a> |
 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/locale_codes.md">🗾 Locales</a> |
 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md">🌐 Grid</a>
 <br />
@@ -53,23 +53,42 @@
 
 --------
 
-
 <a id="multiple_examples"></a>
-<p align="left"><b>Example:</b> <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_coffee_cart.py" target="_blank">test_coffee_cart.py</a> from <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples" target="_blank">SeleniumBase/examples/</a></p>
+<p align="left"><b>Example:</b> <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_coffee_cart.py" target="_blank">test_coffee_cart.py</a> from <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples" target="_blank">./examples/</a></p>
 
 ```bash
 cd examples/
 pytest test_coffee_cart.py --demo
 ```
 
-<p>(<code>--demo</code> slows the test with highlighting for better visibility.)</p>
+<p>(<code>--demo</code> mode slows down tests and highlights actions)</p>
 
 <p align="left"><a href="https://seleniumbase.io/demo_page" target="_blank"><img src="https://seleniumbase.github.io/cdn/gif/coffee_cart.gif" width="480" alt="SeleniumBase Example" title="SeleniumBase Example" /></a></p>
 
+* Here's a preview of that test:
+
+```python
+from seleniumbase import BaseCase
+
+class CoffeeCartTest(BaseCase):
+    def test_coffee_cart(self):
+        self.open("https://seleniumbase.io/coffee/")
+        self.click('div[data-sb="Cappuccino"]')
+        self.click('div[data-sb="Flat-White"]')
+        self.click('div[data-sb="Cafe-Latte"]')
+        self.click('a[aria-label="Cart page"]')
+        self.assert_exact_text("Total: $53.00", "button.pay")
+        self.click("button.pay")
+        self.type("input#name", "Selenium Coffee")
+        self.type("input#email", "[email protected]")
+        self.click("button#submit-payment")
+        self.assert_text("Thanks for your purchase.", "#app")
+```
+
 --------
 
 <details>
-<summary> ▶️ How is SeleniumBase different from raw Selenium? (<b>click to expand</b>)</summary>
+<summary> ▶️ How is <b>SeleniumBase</b> different from raw Selenium? (<b>click to expand</b>)</summary>
 <div>
 
 <p>💡 SeleniumBase is a Python framework for browser automation and testing. SeleniumBase uses <a href="https://www.w3.org/TR/webdriver2/#endpoints" target="_blank">Selenium/WebDriver</a> APIs, and incorporates test-runners such as <code>pytest</code>, <code>nosetests</code>, and <code>behave</code> to provide organized structure, test discovery, test execution, test state (<i>eg. passed, failed, or skipped</i>), and command-line options for changing default settings (<i>such as choosing the browser to use</i>). With raw Selenium, you would need to set up your own options-parser for configuring tests from the command-line.</p>

examples/boilerplates/samples/file_parsing/parse_files.py

@@ -1,14 +1,10 @@
-"""
-Demonstration of parsing data from files.
-In this example, login information is pulled for tests.
-"""
-
+"""Example of parsing data from files."""
 from seleniumbase import BaseCase
 
 
 class ParseTestCase(BaseCase):
     def setUp(self):
-        super(ParseTestCase, self).setUp()
+        super().setUp()
 
     def get_login_credentials(self, user_type):
         # Example of parsing data from a file (Method 1)

examples/coffee_cart_tests.py

@@ -24,12 +24,18 @@ def test_coffee_promo_with_preview(self):
         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"]')
+        promo = False
+        total_string = "Total: $33.00"
+        if self.is_element_visible("div.promo"):
+            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"]')
+            promo = True
+            total_string = "Total: $37.00"
         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"]')
+        if promo:
+            self.assert_text("(Discounted) Mocha", "ul.cart-preview")
+        self.assert_exact_text(total_string, 'button[data-test="checkout"]')
         self.click('button[data-test="checkout"]')
         self.type("input#name", "Selenium Coffee")
         self.type("input#email", "[email protected]")

examples/example_logs/basic_test_info.txt

@@ -1,22 +1,31 @@
-examples.test_fail.MyTestClass.test_find_army_of_robots_on_xkcd_desert_island
-----------------------------------------------------
+test_fail.py::FailingTests::test_find_army_of_robots_on_xkcd_desert_island
+--------------------------------------------------------------------
 Last Page: https://xkcd.com/731/
-  Browser: firefox
-Timestamp: 1599068455  (Unix Timestamp)
-     Date: Wednesday, September 2, 2020
-     Time: 1:40:55 PM  (EDT, UTC-05:00)
-----------------------------------------------------
-Traceback: File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/unittest/case.py", line 615, in run
-    testMethod()
-  File "/Users/michael/github/SeleniumBase/examples/test_fail.py", line 17, in test_find_army_of_robots_on_xkcd_desert_island
+ Duration: 1.63s
+  Browser: Chrome 108.0.5359.124
+   Driver: chromedriver 108.0.5359.71
+Timestamp: 1672785363  (Unix Timestamp)
+     Date: Tuesday, January 3, 2023
+     Time: 5:36:03 PM  (EDT, UTC-05:00)
+--------------------------------------------------------------------
+Traceback:   File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/unittest/case.py", line 57, in testPartExecutor
+    yield
+  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/unittest/case.py", line 623, in run
+    self._callTestMethod(testMethod)
+  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/unittest/case.py", line 579, in _callTestMethod
+    if method() is not None:
+       ^^^^^^^^
+  File "/Users/michael/github/SeleniumBase/examples/test_fail.py", line 16, in test_find_army_of_robots_on_xkcd_desert_island
     self.assert_element("div#ARMY_OF_ROBOTS", timeout=1)
-  File "/Users/michael/github/SeleniumBase/seleniumbase/fixtures/base_case.py", line 4931, in assert_element
+  File "/Users/michael/github/SeleniumBase/seleniumbase/fixtures/base_case.py", line 8279, in assert_element
     self.wait_for_element_visible(selector, by=by, timeout=timeout)
-  File "/Users/michael/github/SeleniumBase/seleniumbase/fixtures/base_case.py", line 3290, in wait_for_element_visible
-    self.driver, selector, by, timeout)
-  File "/Users/michael/github/SeleniumBase/seleniumbase/fixtures/page_actions.py", line 299, in wait_for_element_visible
+  File "/Users/michael/github/SeleniumBase/seleniumbase/fixtures/base_case.py", line 7718, in wait_for_element_visible
+    return page_actions.wait_for_element_visible(
+           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+  File "/Users/michael/github/SeleniumBase/seleniumbase/fixtures/page_actions.py", line 428, in wait_for_element_visible
     timeout_exception(NoSuchElementException, message)
-  File "/Users/michael/github/SeleniumBase/seleniumbase/fixtures/page_actions.py", line 117, in timeout_exception
-    raise exc(message)
+  File "/Users/michael/github/SeleniumBase/seleniumbase/fixtures/page_actions.py", line 191, in timeout_exception
+    raise exc(msg)
+
 Exception: Message: 
  Element {div#ARMY_OF_ROBOTS} was not present after 1 second!

examples/my_first_test.py

@@ -1,6 +1,11 @@
 """A complete end-to-end test for an e-commerce website."""
 from seleniumbase import BaseCase
 
+if __name__ == "__main__":  # If "python" called
+    from pytest import main
+    from sys import argv
+    main([*argv, "-s"])  # Run pytest, same args
+
 
 class MyTestClass(BaseCase):
     def test_swag_labs(self):
@@ -28,12 +33,6 @@ def test_swag_labs(self):
         self.assert_element("div#login_button_container")
 
 
-if __name__ == "__main__":  # If "python", run pytest
-    from pytest import main
-    from sys import argv
-    main([*argv, "-s"])  # Run pytest using same args
-
-
 #######################################################################
 #
 #    ****  NOTES / USEFUL INFO  ****

examples/swag_labs_user_tests.py

@@ -91,4 +91,4 @@ def tearDown(self):
             self.js_click_if_present("a#logout_sidebar_link")
         except Exception:
             pass
-        super(SwagLabsTests, self).tearDown()
+        super().tearDown()

examples/test_coffee_cart.py

@@ -1,6 +1,11 @@
 """Use SeleniumBase to test the Coffee Cart App."""
 from seleniumbase import BaseCase
 
+if __name__ == "__main__":  # If "python" called
+    from pytest import main
+    from sys import argv
+    main([*argv, "-s"])  # Run pytest, same args
+
 
 class CoffeeCartTest(BaseCase):
     def test_coffee_cart(self):
@@ -9,15 +14,9 @@ def test_coffee_cart(self):
         self.click('div[data-sb="Flat-White"]')
         self.click('div[data-sb="Cafe-Latte"]')
         self.click('a[aria-label="Cart page"]')
-        self.assert_exact_text("Total: $53.00", 'button.pay')
-        self.click('button.pay')
+        self.assert_exact_text("Total: $53.00", "button.pay")
+        self.click("button.pay")
         self.type("input#name", "Selenium Coffee")
         self.type("input#email", "[email protected]")
         self.click("button#submit-payment")
         self.assert_text("Thanks for your purchase.", "#app .success")
-
-
-if __name__ == "__main__":  # If "python", run pytest
-    from pytest import main
-    from sys import argv
-    main([*argv, "-s"])  # Run pytest using same args

examples/test_mfa_login.py

@@ -1,5 +1,10 @@
 from seleniumbase import BaseCase
 
+if __name__ == "__main__":  # If "python" called
+    from pytest import main
+    from sys import argv
+    main([*argv, "-s"])  # Run pytest, same args
+
 
 class TestMFALogin(BaseCase):
     def test_mfa_login(self):
@@ -14,9 +19,3 @@ def test_mfa_login(self):
         self.click_link("Sign out")  # Link must be "a" tag. Not "button".
         self.assert_element('a:contains("Sign in")')
         self.assert_exact_text("You have been signed out!", "#top_message")
-
-
-if __name__ == "__main__":  # If "python", run pytest
-    from pytest import main
-    from sys import argv
-    main([*argv, "-s"])  # Run pytest using same args

examples/test_override_sb_fixture.py

@@ -20,14 +20,14 @@ def get_new_driver(self, *args, **kwargs):
             return webdriver.Chrome(options=options)
 
         def setUp(self):
-            super(BaseClass, self).setUp()
+            super().setUp()
 
         def base_method(self):
             pass
 
         def tearDown(self):
             self.save_teardown_screenshot()
-            super(BaseClass, self).tearDown()
+            super().tearDown()
 
     sb = BaseClass("base_method")
     sb.setUpClass()