Update examples

mdmintz · mdmintz · commit 5c1ac1fb47c6 · 2022-05-13T16:19:05.000-04:00
diff --git a/examples/boilerplates/ReadMe.md b/examples/boilerplates/ReadMe.md
@@ -2,8 +2,8 @@
 
 <h2><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Example Boilerplates:</h2>
 
-* Boilerplates are located in the [SeleniumBase => examples/boilerplates/](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/boilerplates) folder.
-* Boilerplates can help you structure tests using common design patterns such as the Page Object Model.
+* Boilerplate files are located in the [SeleniumBase => examples/boilerplates/](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/boilerplates) folder.
+* Boilerplates can help you structure tests using common design patterns such as the Page Object Model. For all 20 SeleniumBase design patterns, see: [Syntax Formats](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md)
 
 <h2><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Boilerplate Files:</h2>
 
diff --git a/examples/boilerplates/base_test_case.py b/examples/boilerplates/base_test_case.py
@@ -15,7 +15,7 @@ def setUp(self):
         # <<< Run custom setUp() code for tests AFTER the super().setUp() >>>
 
     def tearDown(self):
-        self.save_teardown_screenshot()
+        self.save_teardown_screenshot()  # If test fails, or if "--screenshot"
         if self.has_exception():
             # <<< Run custom code if the test failed. >>>
             pass
diff --git a/examples/boilerplates/samples/file_parsing/__init__.py b/examples/boilerplates/samples/file_parsing/__init__.py
diff --git a/examples/boilerplates/samples/file_parsing/parse_files.py b/examples/boilerplates/samples/file_parsing/parse_files.py
diff --git a/examples/boilerplates/samples/file_parsing/qa_login_example.txt b/examples/boilerplates/samples/file_parsing/qa_login_example.txt
diff --git a/examples/boilerplates/samples/file_parsing/staging_login_example.txt b/examples/boilerplates/samples/file_parsing/staging_login_example.txt
diff --git a/examples/edge_test.py b/examples/edge_test.py
@@ -13,7 +13,7 @@ def test_edge(self):
             print('  (Run this test using "--edge" or "--browser=edge")')
             self.skip('Use "--edge" or "--browser=edge"')
         if self.headless:
-            self.open("data:,")
+            self.open_if_not_url("about:blank")
             print("\n  This test is NOT designed for Headless Mode!")
             self.skip('Do NOT use "--headless" with this test!')
         self.open("edge://settings/help")
diff --git a/examples/github_test.py b/examples/github_test.py
@@ -3,19 +3,10 @@
 
 class GitHubTests(BaseCase):
     def test_github(self):
-        # Selenium can trigger GitHub's anti-automation system:
-        # "You have triggered an abuse detection mechanism."
-        # "Please wait a few minutes before you try again."
-        # To avoid this automation blocker, two steps are being taken:
-        # 1. self.slow_click() is being used to slow down Selenium actions.
-        # 2. The browser's User Agent is modified to avoid Selenium-detection
-        #    when running in headless mode.
         if self.headless:
-            self.get_new_driver(
-                agent="""Mozilla/5.0 """
-                """AppleWebKit/537.36 (KHTML, like Gecko) """
-                """Chrome/Version 100.0.4896.88 Safari/537.36"""
-            )
+            self.open_if_not_url("about:blank")
+            print("\n  This test is NOT designed for Headless Mode!")
+            self.skip('Do NOT use "--headless" with this test!')
         self.open("https://github.com/search?q=SeleniumBase")
         self.slow_click('a[href="/seleniumbase/SeleniumBase"]')
         self.click_if_visible('[data-action="click:signup-prompt#dismiss"]')
diff --git a/examples/my_first_test.py b/examples/my_first_test.py
@@ -135,9 +135,8 @@ def test_swag_labs(self):
         #
         # 7. self.js_click(SELECTOR) can be used to click on hidden elements.
         #
-        # 8. If a URL starts with "://", then "https://" is automatically used.
-        #    Example: [self.open("://URL")] becomes [self.open("https://URL")]
-        #    This helps by reducing the line length by 5 characters.
+        # 8. self.open(URL) will automatically complete URLs missing a prefix.
+        #    Example: google.com will become https://google.com before opened.
         #
         # 9. For the full method list, see one of the following:
         #    * SeleniumBase/seleniumbase/fixtures/base_case.py
diff --git a/examples/raw_parameter_script.py b/examples/raw_parameter_script.py
@@ -31,6 +31,7 @@
 if pure_python:
     sb = MyTestClass("test_swag_labs")
     sb.browser = "chrome"
+    sb.is_behave = False
     sb.headless = False
     sb.headed = False
     sb.xvfb = False
@@ -43,6 +44,7 @@
     sb.var1 = None
     sb.var2 = None
     sb.var3 = None
+    sb.variables = {}
     sb.account = None
     sb.environment = "test"
     sb.user_agent = None
@@ -98,7 +100,6 @@
     sb.swiftshader = False
     sb.ad_block_on = False
     sb.highlights = None
-    sb.check_js = False
     sb.interval = None
     sb.cap_file = None
     sb.cap_string = None
diff --git a/examples/test_apple_site.py b/examples/test_apple_site.py
@@ -4,9 +4,10 @@
 
 class AppleTests(BaseCase):
     def test_apple_developer_site_webdriver_instructions(self):
-        self.demo_mode = True
-        self.demo_sleep = 0.5
-        self.message_duration = 2.0
+        if not (self.headless or self.xvfb):
+            self.demo_mode = True
+            self.demo_sleep = 0.5
+            self.message_duration = 2.0
         if self.headless and (
             self.browser == "chrome" or self.browser == "edge"
         ):
diff --git a/examples/test_mfa_login.py b/examples/test_mfa_login.py
@@ -7,10 +7,10 @@ def test_mfa_login(self):
         self.type("#username", "demo_user")
         self.type("#password", "secret_pass")
         self.enter_mfa_code("#totpcode", "GAXG2MTEOR3DMMDG")  # 6-digit
+        self.assert_text("Welcome!", "h1")
         self.highlight("img#image1")  # A fancier assert_element() call
         self.click('a:contains("This Page")')
-        self.assert_text("Welcome!", "h1")
         self.save_screenshot_to_logs()  # In "./latest_logs/" folder.
         self.click_link("Sign out")  # Must be "a" tag. Not "button".
         self.assert_element('a:contains("Sign in")')
-        self.assert_text("You have been signed out!", "#top_message")
+        self.assert_exact_text("You have been signed out!", "#top_message")
diff --git a/examples/youtube_search_test.py b/examples/youtube_search_test.py
@@ -22,13 +22,3 @@ def test_youtube_autocomplete_results(self):
         )
         self.click(result_selector)
         self.assert_element_present('a[aria-label*="SeleniumBase"]')
-
-    def test_youtube_search_results(self):
-        """Verify finding a specific video by performing a YouTube search."""
-        self.open("https://www.youtube.com/c/MichaelMintz")
-        search_term = "SeleniumBase Common API Methods"
-        search_selector = "input#search"
-        self.type(search_selector, search_term + "\n")
-        self.ad_block()
-        self.demo_mode = True
-        self.assert_element('.text-wrapper > div:contains("%s")' % search_term)

Original file line number	Diff line number	Diff line change
`@@ -135,9 +135,8 @@ def test_swag_labs(self):`
`135`	`135`	`#`
`136`	`136`	`# 7. self.js_click(SELECTOR) can be used to click on hidden elements.`
`137`	`137`	`#`
`138`		`- # 8. If a URL starts with "://", then "https://" is automatically used.`
`139`		`- # Example: [self.open("://URL")] becomes [self.open("https://URL")]`
`140`		`- # This helps by reducing the line length by 5 characters.`
	`138`	`+ # 8. self.open(URL) will automatically complete URLs missing a prefix.`
	`139`	`+ # Example: google.com will become https://google.com before opened.`
`141`	`140`	`#`
`142`	`141`	`# 9. For the full method list, see one of the following:`
`143`	`142`	`# * SeleniumBase/seleniumbase/fixtures/base_case.py`