Update example tests

Author: mdmintz

examples/performance_test.py

@@ -0,0 +1,52 @@
+"""
+Performance test example.
+
+Uses decorators.print_runtime(), which prints the runtime duration
+of a method or "with"-block after the method (or block) completes.
+Also raises an exception when exceeding the time "limit" if set.
+
+Arguments ->
+    description  # Optional - Shows description in print output.
+    limit  # Optional - Fail if the duration is above the limit.
+
+Method / Function example usage ->
+    from seleniumbase import decorators
+
+    @decorators.print_runtime("My Method")
+    def my_method():
+        # code ...
+        # code ...
+
+"with"-block example usage ->
+    from seleniumbase import decorators
+
+    with decorators.print_runtime("My Code Block"):
+        # code ...
+        # code ...
+"""
+from seleniumbase import BaseCase
+from seleniumbase import decorators
+
+
+class PerformanceClass(BaseCase):
+    @decorators.print_runtime("Open Swag Labs and Log In")
+    def login_to_swag_labs(self):
+        with decorators.print_runtime("Open Swag Labs"):
+            self.open("https://www.saucedemo.com")
+        self.type("#user-name", "standard_user")
+        self.type("#password", "secret_sauce\n")
+
+    def test_performance_of_swag_labs(self):
+        self.login_to_swag_labs()
+        self.assert_element("div.inventory_list")
+        self.assert_exact_text("PRODUCTS", "span.title")
+        with decorators.print_runtime("Add backpack and see cart"):
+            self.click('button[name*="backpack"]')
+            self.click("#shopping_cart_container a")
+            self.assert_text("Backpack", "div.cart_item")
+        with decorators.print_runtime("Remove backpack from cart"):
+            self.click('button:contains("Remove")')  # HTML innerText
+            self.assert_text_not_visible("Backpack", "div.cart_item")
+        with decorators.print_runtime("Log out from Swag Labs", 3):
+            self.js_click("a#logout_sidebar_link")
+            self.assert_element("div#login_button_container")

examples/time_limit_test.py

@@ -1,18 +1,27 @@
-""" This test fails on purpose to demonstrate the time-limit feature
-    for tests that run longer than the time limit specified (seconds).
-    The time-limit clock starts after the browser has fully launched,
-    which is after pytest starts it's own internal clock for tests.
-    Usage: (inside tests) =>  self.set_time_limit(SECONDS)
-    Usage: (command-line) =>  --time-limit=SECONDS """
-
 import pytest
 from seleniumbase import BaseCase
+from seleniumbase import decorators
 
 
 class TimeLimitTests(BaseCase):
     @pytest.mark.expected_failure
-    def test_time_limit_feature(self):
-        self.set_time_limit(5)  # Fail test if time exceeds 5 seconds
-        self.open("https://xkcd.com/1658/")
+    def test_runtime_limit_decorator(self):
+        """This test fails on purpose to show the runtime_limit() decorator
+        for code blocks that run longer than the time limit specified."""
+        print("\n(This test should fail)")
+        self.open("https://xkcd.com/1190")
+        with decorators.runtime_limit(0.5):
+            self.sleep(0.75)
+
+    @pytest.mark.expected_failure
+    def test_set_time_limit_method(self):
+        """This test fails on purpose to show the set_time_limit() method
+        for tests that run longer than the time limit specified (seconds).
+        The time-limit clock starts after the browser has fully launched,
+        which is after pytest starts it's own internal clock for tests.
+        Usage: (inside tests) =>  self.set_time_limit(SECONDS)
+        Usage: (command-line) =>  --time-limit=SECONDS"""
+        self.set_time_limit(2.5)  # Fail test if time exceeds 2.5 seconds
         print("\n(This test should fail)")
-        self.sleep(7)
+        self.open("https://xkcd.com/1658")
+        self.sleep(3)