Merge pull request #2221 from seleniumbase/update-logging-webrtc-and-link-checking

Update logging options, WebRTC preferences, and link-checking methods

Author: mdmintz

examples/boilerplates/samples/google_test.py

@@ -6,9 +6,13 @@
 class GoogleTests(BaseCase):
     def test_google_dot_com(self):
         self.open("https://google.com/ncr")
-        self.sleep(0.4)
+        self.assert_title_contains("Google")
+        self.sleep(0.25)
         self.save_screenshot_to_logs()  # ("./latest_logs" folder)
-        self.sleep(0.2)
+        self.sleep(0.15)
+        self.hide_elements('iframe')  # Hide "Sign in" pop-up
+        self.sleep(0.15)
+        self.save_screenshot_to_logs()
         self.type(HomePage.search_box, "github.com")
         self.assert_element(HomePage.search_button)
         self.assert_element(HomePage.feeling_lucky_button)

examples/boilerplates/samples/test_page_objects.py

@@ -6,11 +6,17 @@
 class GooglePage:
     def go_to_google(self, sb):
         sb.open("https://google.com/ncr")
-        sb.sleep(0.1)
-        sb.hide_elements('iframe')  # Hide "Sign in" pop-up
-        sb.sleep(0.2)
+
+    def assert_google_title(self, sb):
+        sb.assert_title_contains("Google")
+
+    def hide_sign_in_pop_up(self, sb):
+        sb.sleep(0.25)
+        sb.hide_elements('iframe')
+        sb.sleep(0.15)
 
     def do_search(self, sb, search_term):
+        sb.sleep(0.05)
         sb.click('[title="Search"]')
         sb.type('[title="Search"]', search_term + "\n")
 
@@ -30,6 +36,8 @@ def test_page_objects(self):
         search_term = "SeleniumBase.io Docs"
         expected_text = "SeleniumBase"
         GooglePage().go_to_google(self)
+        GooglePage().assert_google_title(self)
+        GooglePage().hide_sign_in_pop_up(self)
         GooglePage().do_search(self, search_term)
         self.assert_text(expected_text, "#search")
         GooglePage().click_search_result(self, expected_text)

examples/capabilities/ReadMe.md

@@ -2,7 +2,7 @@
 
 <h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> Using Desired Capabilities</h3>
 
-You can specify browser capabilities when running SeleniumBase tests on a remote Selenium Grid server such as <a href="https://www.browserstack.com/automate/capabilities" target="_blank">BrowserStack</a>, <a href="https://wiki.saucelabs.com/display/DOCS/Platform+Configurator#/" target="_blank">Sauce Labs</a>, or another.
+You can specify browser capabilities when running SeleniumBase tests on a remote Selenium Grid server such as <a href="https://www.browserstack.com/automate/capabilities" target="_blank">BrowserStack</a>, <a href="https://saucelabs.com/products/platform-configurator" target="_blank">Sauce Labs</a>, or another.
 
 Sample run commands may look like this when run from the [SeleniumBase/examples/](https://github.com/seleniumbase/SeleniumBase/tree/master/examples) folder: (The browser is now specified in the capabilities file.)
 
@@ -47,7 +47,7 @@ capabilities = {
 
 <ul>
     <li><a href="https://www.browserstack.com/automate/capabilities" target="_blank">BrowserStack desired capabilities</a></li>
-    <li><a href="https://wiki.saucelabs.com/display/DOCS/Platform+Configurator#/" target="_blank">Sauce Labs desired capabilities</a></li>
+    <li><a href="https://saucelabs.com/products/platform-configurator" target="_blank">Sauce Labs desired capabilities</a></li>
 </ul>
 
 <div><b>Parsing desired capabilities:</b></div>

examples/capabilities/sample_cap_file_SL.py

@@ -1,5 +1,5 @@
 # Desired capabilities example file for Sauce Labs
-# Generate from https://wiki.saucelabs.com/display/DOCS/Platform+Configurator#/
+# Generate from https://saucelabs.com/products/platform-configurator
 capabilities = {
     "browserName": "chrome",
     "browserVersion": "latest",

examples/raw_parameter_script.py

@@ -71,6 +71,7 @@
     sb.no_sandbox = False
     sb.disable_js = False
     sb.disable_gpu = False
+    sb.log_cdp_events = False
     sb._multithreaded = False
     sb._reuse_session = False
     sb._crumbs = False

examples/test_todomvc.py

@@ -10,6 +10,10 @@ def test_todomvc(self, framework):
         self.clear_local_storage()
         self.click('a[href="examples/%s"]' % framework)
         self.assert_element("section.todoapp")
+        self.assert_text("todos", "header h1")
+        self.wait_for_ready_state_complete()
+        title = self.get_title()
+        self.assert_in(framework, title.lower())
         new_todo_input = "input.new-todo"
         todo_count_span = "span.todo-count"
         self.type(new_todo_input, "Learn Python\n")

help_docs/customizing_test_runs.md

@@ -452,7 +452,7 @@ pytest --settings-file=custom_settings.py
 
 <h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> Running tests on a remote Selenium Grid:</h3>
 
-🌐 SeleniumBase lets you run tests on remote Selenium Grids such as [BrowserStack](https://www.browserstack.com/automate#)'s Selenium Grid, [Sauce Labs](https://saucelabs.com/products/open-source-frameworks/selenium)'s Selenium Grid, other Grids, and even your own Grid:
+🌐 SeleniumBase lets you run tests on remote Selenium Grids such as [BrowserStack](https://www.browserstack.com/automate#)'s Selenium Grid, [Sauce Labs](https://saucelabs.com/products/platform-configurator)'s Selenium Grid, other Grids, and even your own Grid:
 
 🌐 For setting browser desired capabilities while running Selenium remotely, see the ReadMe located here: https://github.com/seleniumbase/SeleniumBase/tree/master/examples/capabilities
 

help_docs/desired_capabilities.md

@@ -2,7 +2,7 @@
 
 ## [<img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) Using Desired Capabilities
 
-You can specify browser capabilities when running SeleniumBase tests on a remote Selenium Grid server such as <a href="https://www.browserstack.com/automate/capabilities" target="_blank">BrowserStack</a> or <a href="https://wiki.saucelabs.com/display/DOCS/Platform+Configurator#/" target="_blank">Sauce Labs</a>.
+You can specify browser capabilities when running SeleniumBase tests on a remote Selenium Grid server such as <a href="https://www.browserstack.com/automate/capabilities" target="_blank">BrowserStack</a> or <a href="https://saucelabs.com/products/platform-configurator" target="_blank">Sauce Labs</a>.
 
 Sample run commands may look like this when run from the [SeleniumBase/examples/](https://github.com/seleniumbase/SeleniumBase/tree/master/examples) folder: (The browser is now specified in the capabilities file.)
 
@@ -47,7 +47,7 @@ capabilities = {
 
 <ul>
     <li><a href="https://www.browserstack.com/automate/capabilities" target="_blank">BrowserStack desired capabilities</a></li>
-    <li><a href="https://wiki.saucelabs.com/display/DOCS/Platform+Configurator#/" target="_blank">Sauce Labs desired capabilities</a></li>
+    <li><a href="https://saucelabs.com/products/platform-configurator" target="_blank">Sauce Labs desired capabilities</a></li>
 </ul>
 
 <div><b>Parsing desired capabilities:</b></div>

help_docs/how_it_works.md

@@ -4,17 +4,17 @@
 
 <a id="how_seleniumbase_works"></a>
 
-👁️🔎 At the core, SeleniumBase works by extending [pytest](https://docs.pytest.org/en/latest/) as a direct plugin. SeleniumBase automatically spins up web browsers for tests (using [Selenium WebDriver](https://www.selenium.dev/documentation/webdriver/)), and then gives those tests access to the SeleniumBase libraries through the [BaseCase class](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/base_case.py). Tests are also given access to [SeleniumBase command-line options](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md) and [SeleniumBase methods](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md), which provide additional functionality.
+👁️🔎 The primary [SeleniumBase syntax format](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md) works by extending [pytest](https://docs.pytest.org/en/latest/) as a direct plugin. SeleniumBase automatically spins up web browsers for tests (using [Selenium WebDriver](https://www.selenium.dev/documentation/webdriver/)), and then gives those tests access to the SeleniumBase libraries through the [BaseCase class](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/base_case.py). Tests are also given access to [SeleniumBase command-line options](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md) and [SeleniumBase methods](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md), which provide additional functionality.
 
 👁️🔎 ``pytest`` uses a feature called test discovery to automatically find and run Python methods that start with ``test_`` when those methods are located in Python files that start with ``test_`` or end with ``_test.py``.
 
-👁️🔎 The most common way of using **SeleniumBase** is by importing ``BaseCase``:
+👁️🔎 The primary [SeleniumBase syntax format](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md) starts by importing ``BaseCase``:
 
 ```python
 from seleniumbase import BaseCase
 ```
 
-👁️🔎 This line activates ``pytest`` when a file is called directly with ``python``:
+👁️🔎 This next line activates ``pytest`` when a file is called directly with ``python`` by accident:
 
 ```python
 BaseCase.main(__name__, __file__)
@@ -29,12 +29,16 @@ class MyTestClass(BaseCase):
 👁️🔎 Test methods inside ``BaseCase`` classes become SeleniumBase tests: (These tests automatically launch a web browser before starting, and quit the web browser after ending. Default settings can be changed via command-line options.)
 
 ```python
+class MyTestClass(BaseCase):
     def test_abc(self):
+        # ...
 ```
 
-👁️🔎 SeleniumBase APIs can be called from tests via ``self``:
+👁️🔎 [SeleniumBase APIs](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md) can be called from tests via ``self``:
 
 ```python
+class MyTestClass(BaseCase):
+    def test_abc(self):
         self.open("https://example.com")
 ```
 
@@ -44,22 +48,20 @@ class MyTestClass(BaseCase):
 from seleniumbase import BaseCase
 BaseCase.main(__name__, __file__)
 
-class TestMFALogin(BaseCase):
-    def test_mfa_login(self):
-        self.open("https://seleniumbase.io/realworld/login")
+class TestSimpleLogin(BaseCase):
+    def test_simple_login(self):
+        self.open("https://seleniumbase.io/simple/login")
         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")')  # Use :contains() on any tag
-        self.save_screenshot_to_logs()  # ("./latest_logs" folder for test)
-        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")
+        self.click('a:contains("Sign in")')
+        self.assert_exact_text("Welcome!", "h1")
+        self.assert_element("img#image1")
+        self.highlight("#image1")
+        self.click_link("Sign out")
+        self.assert_text("signed out", "#top_message")
 ```
 
-(See the example, [test_mfa_login.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_mfa_login.py), for reference.)
+(See the example, [test_simple_login.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_simple_login.py), for reference.)
 
 👁️🔎 Here are some examples of running tests with ``pytest``:
 
@@ -71,7 +73,29 @@ pytest -k agent
 pytest offline_examples/
 ```
 
-(See <a href="https://seleniumbase.io/help_docs/syntax_formats/">Syntax_Formats</a> for more ways of structuring <b>SeleniumBase</b> tests.)
+👁️🔎 Here's a [SeleniumBase syntax format](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md) that uses the raw `driver`. Unlike the format mentioned earlier, it can be run with `python` instead of `pytest`. The `driver` includes original `driver` methods and new ones added by SeleniumBase:
+
+```python
+from seleniumbase import Driver
+
+driver = Driver()
+try:
+    driver.get("https://seleniumbase.io/simple/login")
+    driver.type("#username", "demo_user")
+    driver.type("#password", "secret_pass")
+    driver.click('a:contains("Sign in")')
+    driver.assert_exact_text("Welcome!", "h1")
+    driver.assert_element("img#image1")
+    driver.highlight("#image1")
+    driver.click_link("Sign out")
+    driver.assert_text("signed out", "#top_message")
+finally:
+    driver.quit()
+```
+
+(See the example, [raw_login_driver.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/raw_login_driver.py), for reference.)
+
+👁️🔎 Note that regular SeleniumBase formats (ones that use `BaseCase`, the `SB` context manager, or the `sb` `pytest` fixture) have more methods than the improved `driver` format. The regular formats also have more features. Some features, (such as the [SeleniumBase dashboard](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md)), require a `pytest` format.
 
 --------
 

help_docs/method_summary.md

@@ -282,6 +282,7 @@ self.get_new_driver(
     undetectable=None,
     uc_cdp_events=None,
     uc_subprocess=None,
+    log_cdp_events=None,
     no_sandbox=None,
     disable_gpu=None,
     headless2=None,