Merge pull request #1976 from seleniumbase/add-dark-mode-option

Add Dark Mode option, and more

Author: mdmintz

README.md

@@ -57,7 +57,7 @@
 
 --------
 
-<p align="left"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/sb_logo_p3.png" alt="SeleniumBase" title="SeleniumBase" width="232" /></a></p>
+<p align="left"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/super_logo_sb2.png" alt="SeleniumBase" title="SeleniumBase" width="232" /></a></p>
 
 <blockquote>
 <p dir="auto"><strong>Explore the README:</strong></p>
@@ -439,6 +439,7 @@ self.sleep(seconds)  # Do nothing for the given amount of time.
 self.save_screenshot(name)  # Save a screenshot in .png format.
 self.assert_element(selector)  # Verify the element is visible.
 self.assert_text(text, selector)  # Verify text in the element.
+self.assert_exact_text(text, selector)  # Verify text is exact.
 self.assert_title(title)  # Verify the title of the web page.
 self.assert_downloaded_file(file)  # Verify file was downloaded.
 self.assert_no_404_errors()  # Verify there are no broken links.
@@ -485,10 +486,10 @@ behave calculator.feature -D rs -D dashboard
 
 With a SeleniumBase [pytest.ini](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/pytest.ini) file present, you can modify default discovery settings. The Python class name can be anything because ``seleniumbase.BaseCase`` inherits ``unittest.TestCase`` to trigger autodiscovery.
 
-<p>✅ You can do a pre-flight check to see which tests would get discovered by <code translate="no">pytest</code> before the real flight:</p>
+<p>✅ You can do a pre-flight check to see which tests would get discovered by <code translate="no">pytest</code> before the actual run:</p>
 
 ```bash
-pytest --collect-only -q
+pytest --co -q
 ```
 
 <p>✅ You can be more specific when calling <code translate="no">pytest</code> or <code translate="no">pynose</code> on a file:</p>
@@ -567,7 +568,8 @@ pytest test_coffee_cart.py --trace
 -q  # Quiet mode. Print fewer details in the console output when running tests.
 -x  # Stop running the tests after the first failure is reached.
 --html=report.html  # Creates a detailed pytest-html report after tests finish.
---collect-only | --co  # Show what tests would get run. (Without running them)
+--co | --collect-only  # Show what tests would get run. (Without running them)
+--co -q  # (Both options together!) - Do a dry run with full test names shown.
 -n=NUM  # Multithread the tests using that many threads. (Speed up test runs!)
 -s  # See print statements. (Should be on by default with pytest.ini present.)
 --junit-xml=report.xml  # Creates a junit-xml report after tests finish.
@@ -656,6 +658,7 @@ pytest test_coffee_cart.py --trace
 --swiftshader  # (Use Chrome's "--use-gl=swiftshader" feature.)
 --incognito  # (Enable Chrome's Incognito mode.)
 --guest  # (Enable Chrome's Guest mode.)
+--dark  # (Enable Chrome's Dark mode.)
 --devtools  # (Open Chrome's DevTools when the browser opens.)
 --rs | --reuse-session  # (Reuse browser session for all tests.)
 --rcs | --reuse-class-session  # (Reuse session for tests in class.)
@@ -1157,22 +1160,39 @@ self.switch_to_window(1)  # This switches to the new tab (0 is the first one)
 
 <h3>🔵 How to handle iframes:</h3>
 
-🔵 <b>ProTip™:</b> iframes follow the same principle as new windows: You must first switch to the iframe if you want to perform actions in there:
+🔵 <b>iframes</b> follow the same principle as new windows: You must first switch to the iframe if you want to perform actions in there:
 
 ```python
 self.switch_to_frame("iframe")
 # ... Now perform actions inside the iframe
 self.switch_to_parent_frame()  # Exit the current iframe
 ```
 
-To exit from multiple iframes, use ``self.switch_to_default_content()``. If inside a single iframe, this has the same effect as ``self.switch_to_parent_frame()``.
+To exit from multiple iframes, use ``self.switch_to_default_content()``. (If inside a single iframe, this has the same effect as ``self.switch_to_parent_frame()``.)
+
+```python
+self.switch_to_frame('iframe[name="frame1"]')
+self.switch_to_frame('iframe[name="frame2"]')
+# ... Now perform actions inside the inner iframe
+self.switch_to_default_content()  # Back to the main page
+```
 
 🔵 You can also use a context manager to act inside iframes:
 
 ```python
 with self.frame_switch("iframe"):
     # ... Now perform actions while inside the code block
-# You have left the iframe!
+# You have left the iframe
+```
+
+This also works with nested iframes:
+
+```python
+with self.frame_switch('iframe[name="frame1"]'):
+    with self.frame_switch('iframe[name="frame2"]'):
+        # ... Now perform actions while inside the code block
+    # You are now back inside the first iframe
+# You have left all the iframes
 ```
 
 <h3>🔵 How to execute custom jQuery scripts:</h3>

examples/hack_the_planet.py

@@ -179,8 +179,8 @@ def test_all_your_base_are_belong_to_us(self):
         self.highlight("#ctitle", loops=7, scroll=False)
 
         self.open("https://www.nintendo.com/whatsnew/")
-        self.set_text_content("#main h2", aybabtu)
-        self.highlight("#main h2", loops=10, scroll=False)
+        self.set_text_content("main section h1", aybabtu)
+        self.highlight("main section h1", loops=10, scroll=False)
 
         if not self.headless:
             self.open("https://support.gog.com/hc/en-us?product=gog")

examples/iframe_tests.py

@@ -6,6 +6,7 @@
 class FrameTests(BaseCase):
     def test_iframe_basics(self):
         self.open("https://seleniumbase.io/w3schools/iframes.html")
+        self.assert_title("iframe Testing")
         self.click("button#runbtn")
         self.switch_to_frame("iframeResult")  # Enter the iframe
         self.assert_text("HTML Iframes", "h2")
@@ -22,6 +23,7 @@ def test_iframe_basics(self):
 
     def test_iframes_with_context_manager(self):
         self.open("https://seleniumbase.io/w3schools/iframes.html")
+        self.assert_title("iframe Testing")
         self.click("button#runbtn")
         with self.frame_switch("iframeResult"):
             self.assert_text("HTML Iframes", "h2")
@@ -36,6 +38,7 @@ def test_iframes_with_context_manager(self):
 
     def test_set_content_to_frame(self):
         self.open("https://seleniumbase.io/w3schools/iframes.html")
+        self.assert_title("iframe Testing")
         self.click("button#runbtn")
         self.set_content_to_frame("iframeResult")
         self.highlight('iframe[title="Iframe Example"]')

examples/raw_parameter_script.py

@@ -52,6 +52,7 @@
     sb.user_agent = None
     sb.incognito = False
     sb.guest_mode = False
+    sb.dark_mode = False
     sb.devtools = False
     sb.mobile_emulator = False
     sb.device_metrics = None

examples/uc_cdp_events.py

@@ -3,7 +3,7 @@
 
 if __name__ == "__main__":
     from pytest import main
-    main([__file__, "--uc", "--uc-cdp", "-s"])
+    main([__file__, "--uc", "--uc-cdp", "--incognito", "-s"])
 
 
 class CDPTests(BaseCase):
@@ -23,8 +23,10 @@ def fail_me(self):
         self.fail('Selenium was detected! Try using: "pytest --uc"')
 
     def test_display_cdp_events(self):
-        if not (self.undetectable and self.uc_cdp_events):
-            self.get_new_driver(undetectable=True, uc_cdp_events=True)
+        if not (self.undetectable and self.uc_cdp_events and self.incognito):
+            self.get_new_driver(
+                undetectable=True, uc_cdp_events=True, incognito=True
+            )
         self.open("https://nowsecure.nl/#relax")
         try:
             self.verify_success()

help_docs/ReadMe.md

@@ -69,6 +69,7 @@
 <div><a href="https://seleniumbase.io/examples/tour_examples/ReadMe/"><b>Tour Examples</b></a></div>
 <div><a href="https://seleniumbase.io/examples/presenter/ReadMe/"><b>Presentation Maker</b></a></div>
 <div><a href="https://seleniumbase.io/examples/chart_maker/ReadMe/"><b>Chart Maker</b></a></div>
+<div><a href="https://seleniumbase.io/help_docs/handling_iframes/"><b>Handling iframes</b></a></div>
 <div><a href="https://seleniumbase.io/help_docs/mysql_installation/"><b>MySQL Installation Overview</b></a></div>
 <div><a href="https://seleniumbase.io/seleniumbase/utilities/selenium_grid/ReadMe/"><b>Using the Selenium Grid</b></a></div>
 <div><a href="https://seleniumbase.io/help_docs/desired_capabilities/"><b>Browser Desired Capabilities</b></a></div>
@@ -135,7 +136,8 @@
 <div><a href="https://seleniumbase.dev/examples/tour_examples/"><b>Tour Examples</b></a></div>
 <div><a href="https://seleniumbase.dev/examples/presenter/"><b>Presentation Maker</b></a></div>
 <div><a href="https://seleniumbase.dev/examples/chart_maker/ReadMe/"><b>Chart Maker</b></a></div>
-<div><a href="https://seleniumbase.dev/help_docs/mysql_installation"><b>MySQL Installation Overview</b></a></div>
+<div><a href="https://seleniumbase.dev/help_docs/mysql_installation"><b>Handling iframes</b></a></div>
+<div><a href="https://seleniumbase.dev/help_docs/handling_iframes"><b>MySQL Installation Overview</b></a></div>
 <div><a href="https://seleniumbase.dev/seleniumbase/utilities/selenium_grid/"><b>Using the Selenium Grid</b></a></div>
 <div><a href="https://seleniumbase.dev/help_docs/desired_capabilities"><b>Browser Desired Capabilities</b></a></div>
 <div><a href="https://seleniumbase.dev/help_docs/using_safari_driver"><b>Safari Driver Detailed Info</b></a></div>

help_docs/customizing_test_runs.md

@@ -11,7 +11,7 @@
 pytest my_first_test.py
 
 # Run a test in Firefox
-pytest test_swag_labs.py --browser=firefox
+pytest test_swag_labs.py --firefox
 
 # Run a test in Demo Mode (highlight assertions)
 pytest test_demo_site.py --demo
@@ -22,11 +22,11 @@ pytest test_demo_site.py --headless
 # Run tests multi-threaded using [n] threads
 pytest test_suite.py -n4
 
-# Reuse the browser session for all tests ("--rs")
-pytest test_suite.py --reuse-session
+# Reuse the browser session for all tests ("--reuse-session")
+pytest test_suite.py --rs
 
 # Reuse the browser session, but erase cookies between tests
-pytest test_suite.py --reuse-session --crumbs
+pytest test_suite.py --rs --crumbs
 
 # Create a real-time dashboard for test results
 pytest test_suite.py --dashboard
@@ -91,7 +91,8 @@ pytest my_first_test.py --settings-file=custom_settings.py
 -q  # Quiet mode. Print fewer details in the console output when running tests.
 -x  # Stop running the tests after the first failure is reached.
 --html=report.html  # Creates a detailed pytest-html report after tests finish.
---collect-only | --co  # Show what tests would get run. (Without running them)
+--co | --collect-only  # Show what tests would get run. (Without running them)
+--co -q  # (Both options together!) - Do a dry run with full test names shown.
 -n=NUM  # Multithread the tests using that many threads. (Speed up test runs!)
 -s  # See print statements. (Should be on by default with pytest.ini present.)
 --junit-xml=report.xml  # Creates a junit-xml report after tests finish.
@@ -179,6 +180,7 @@ pytest my_first_test.py --settings-file=custom_settings.py
 --swiftshader  # (Use Chrome's "--use-gl=swiftshader" feature.)
 --incognito  # (Enable Chrome's Incognito mode.)
 --guest  # (Enable Chrome's Guest mode.)
+--dark  # (Enable Chrome's Dark mode.)
 --devtools  # (Open Chrome's DevTools when the browser opens.)
 --rs | --reuse-session  # (Reuse browser session for all tests.)
 --rcs | --reuse-class-session  # (Reuse session for tests in class.)

help_docs/handling_iframes.md

@@ -0,0 +1,63 @@
+<!-- SeleniumBase Docs -->
+
+## [<img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) How to handle iframes
+
+🖼️ <b>iframes</b> follow the same principle as new windows: You must first switch to the iframe if you want to perform actions in there:
+
+```python
+self.switch_to_frame("iframe")
+# ... Now perform actions inside the iframe
+self.switch_to_parent_frame()  # Exit the current iframe
+```
+
+To exit from multiple iframes, use ``self.switch_to_default_content()``. (If inside a single iframe, this has the same effect as ``self.switch_to_parent_frame()``.)
+
+```python
+self.switch_to_frame('iframe[name="frame1"]')
+self.switch_to_frame('iframe[name="frame2"]')
+# ... Now perform actions inside the inner iframe
+self.switch_to_default_content()  # Back to the main page
+```
+
+🖼️ You can also use a context manager to act inside iframes:
+
+```python
+with self.frame_switch("iframe"):
+    # ... Now perform actions while inside the code block
+# You have left the iframe
+```
+
+This also works with nested iframes:
+
+```python
+with self.frame_switch('iframe[name="frame1"]'):
+    with self.frame_switch('iframe[name="frame2"]'):
+        # ... Now perform actions while inside the code block
+    # You are now back inside the first iframe
+# You have left all the iframes
+```
+
+🖼️ In special cases, you may want to set the page to the content of an iframe:
+
+```python
+self.set_content_to_frame("iframe")
+```
+
+To back out of one call of that, use:
+
+```python
+self.set_content_to_parent()
+```
+
+To back out of all nested calls of that, use:
+
+```python
+self.set_content_to_default()
+```
+
+🖼️ See [examples/iframe_tests.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/iframe_tests.py) for tests that use all available iframe commands.
+
+--------
+
+<p align="center"><div align="center"><a href="https://seleniumbase.io">
+<img src="https://img.shields.io/badge/docs-%20seleniumbase.io-11BBDD.svg" alt="SeleniumBase.io Docs" /></a> <a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://img.shields.io/badge/✅%20💛%20View%20Code-on%20GitHub%20🌎%20🚀-02A79E.svg" alt="SeleniumBase.io Docs" /></a></div></p>

help_docs/webdriver_installation.md

@@ -23,7 +23,7 @@ sbase get chromedriver 114
 sbase get chromedriver 114.0.5735.90
 sbase get chromedriver latest
 sbase get chromedriver latest-1
-sbase get edgedriver 114.0.1823.82
+sbase get edgedriver 115.0.1901.183
 ```
 
 (NOTE: ``sbase`` is a shortcut for ``seleniumbase``)

mkdocs.yml

@@ -153,17 +153,18 @@ nav:
     - 🔘 W3Schools radio buttons: https://seleniumbase.io/w3schools/radio_buttons
   - Additional Help Docs:
     - 📑 Table of Contents: help_docs/ReadMe.md
+    - 🖼️ How to handle iframes: help_docs/handling_iframes.md
     - 🔐 Decorators / Security: seleniumbase/common/ReadMe.md
-    - 🐳 Docker Start Guide: integrations/docker/ReadMe.md
     - 🗂️ Case Plans (examples): examples/case_summary.md
     - 🧭 Using Safari Driver: help_docs/using_safari_driver.md
+    - 🐳 Docker Start Guide: integrations/docker/ReadMe.md
     - 👤 Shadow DOM Support: help_docs/shadow_dom.md
     - 👥 macOS Hidden Files: help_docs/hidden_files_info.md
     - 🗄️ MySQL Instructions: help_docs/mysql_installation.md
     - 📃 Desired Capabilities: help_docs/desired_capabilities.md
     - 📜 Useful grep commands: help_docs/useful_grep_commands.md
-    - ⚙️ WebDriver Installation: help_docs/webdriver_installation.md
-    - ✔️ Verifying WebDriver: help_docs/verify_webdriver.md
+    - ⚙️ Downloading drivers: help_docs/webdriver_installation.md
+    - ✔️ Verifying drivers: help_docs/verify_webdriver.md
   - Behave-BDD Integration:
     - 🐝 Behave-BDD ReadMe: examples/behave_bdd/ReadMe.md
     - 🐝 Behave-BDD GUI App: help_docs/behave_gui.md