Merge pull request #845 from seleniumbase/shadow-dom-support-and-more

Add support for Shadow DOM interaction and more

Author: mdmintz

README.md

@@ -451,6 +451,7 @@ ui_tests/
         ├── __init__.py
         ├── google_objects.py
         ├── google_test.py
+        ├── sb_swag_test.py
         └── swag_labs_test.py
 ```
 

examples/boilerplates/samples/sb_swag_test.py

@@ -0,0 +1,18 @@
+""" Classic Page Object Model with the "sb" fixture """
+
+
+class LoginPage():
+
+    def login_to_swag_labs(self, sb, username):
+        sb.open("https://www.saucedemo.com/")
+        sb.type("#user-name", username)
+        sb.type("#password", "secret_sauce")
+        sb.click('input[type="submit"]')
+
+
+class MyTests():
+
+    def test_swag_labs_login(self, sb):
+        LoginPage().login_to_swag_labs(sb, "standard_user")
+        sb.assert_element("#inventory_container")
+        sb.assert_text("Products", "div.product_label")

examples/boilerplates/samples/swag_labs_test.py

@@ -1,11 +1,12 @@
-""" Example test that uses the Page Object Model """
+""" Classic Page Object Model with BaseCase inheritance """
 
 from seleniumbase import BaseCase
 
 
 class LoginPage():
 
     def login_to_swag_labs(self, sb, username):
+        sb.open("https://www.saucedemo.com/")
         sb.type("#user-name", username)
         sb.type("#password", "secret_sauce")
         sb.click('input[type="submit"]')
@@ -14,7 +15,6 @@ def login_to_swag_labs(self, sb, username):
 class MyTests(BaseCase):
 
     def test_swag_labs_login(self):
-        self.open("https://www.saucedemo.com/")
         LoginPage().login_to_swag_labs(self, "standard_user")
         self.assert_element("#inventory_container")
         self.assert_text("Products", "div.product_label")

examples/ip_cow_test.py

@@ -0,0 +1,64 @@
+""" Shadow DOM test.
+    First download files from PyPI.
+    Then search for them on a multi-layered Shadow DOM page.
+    This uses the "::shadow" selector for piercing shadow-root elements.
+    Here's the URL that contains Shadow DOM: chrome://downloads/ """
+
+
+from seleniumbase import BaseCase
+
+
+class ShadowDomTests(BaseCase):
+
+    def download_tar_file_from_pypi(self, package):
+        self.open("https://pypi.org/project/%s/#files" % package)
+        pkg_header = self.get_text("h1.package-header__name").strip()
+        pkg_name = pkg_header.replace(" ", "-")
+        tar_file = pkg_name + ".tar.gz"
+        tar_selector = 'div#files a[href$="%s"]' % tar_file
+        self.click(tar_selector)
+        return tar_file
+
+    def test_shadow_dom(self):
+        if self.browser != "chrome":
+            print("\n  This test is for Google Chrome only!")
+            self.skip('This test is for Google Chrome only!')
+        if self.headless:
+            print("\n  This test does not run in headless mode!")
+            self.skip('This test does not run in headless mode!')
+
+        file_name_1 = self.download_tar_file_from_pypi("sbase")
+        file_name_2 = self.download_tar_file_from_pypi("tensorpy")
+
+        self.open("chrome://downloads/")
+        search_icon = (
+            "downloads-manager::shadow downloads-toolbar::shadow"
+            " cr-toolbar::shadow cr-toolbar-search-field::shadow"
+            " cr-icon-button")
+        search_input = (
+            "downloads-manager::shadow downloads-toolbar::shadow"
+            " cr-toolbar::shadow cr-toolbar-search-field::shadow"
+            " #searchInput")
+        clear_search_icon = (
+            "downloads-manager::shadow downloads-toolbar::shadow"
+            " cr-toolbar::shadow cr-toolbar-search-field::shadow"
+            " #clearSearch")
+        file_link = (
+            "downloads-manager::shadow #downloadsList"
+            " downloads-item::shadow #file-link")
+        remove_button = (
+            "downloads-manager::shadow #downloadsList"
+            " downloads-item::shadow #remove")
+        no_downloads_area = "downloads-manager::shadow #no-downloads"
+
+        self.assert_element(search_icon)
+        self.type(search_input, "sbase")
+        self.assert_text(file_name_1, file_link)
+        print("\n  Download 1: %s" % self.get_text(file_link))
+        self.type(search_input, "tensorpy")
+        self.assert_text(file_name_2, file_link)
+        print("  Download 2: %s" % self.get_text(file_link))
+        self.click(clear_search_icon)
+        self.click(remove_button)
+        self.click(remove_button)
+        self.assert_text("Files you download appear here", no_downloads_area)

examples/test_shadow_dom.py

@@ -0,0 +1,22 @@
+from seleniumbase import BaseCase
+
+
+class MyTourClass(BaseCase):
+
+    def test_octocat_tour(self):
+        self.maximize_window()
+        self.open("https://seleniumbase.io/error_page/")
+        self.wait_for_element("#parallax_octocat")
+        self.create_tour(theme="bootstrap")
+        self.add_tour_step("Welcome to the Octocat Tour!")
+        self.add_tour_step("This is Octocat", "#parallax_octocat")
+        self.add_tour_step("This is Octobi-Wan Catnobi", "#octobi_wan_catnobi")
+        self.add_tour_step("<h1><b>Ooops!!!</b></h1>", "#parallax_error_text")
+        self.add_tour_step("This is a Star Wars speeder.", "#speeder")
+        self.add_tour_step("This is a sign with a 500-Error", "#parallax_sign")
+        self.add_tour_step(
+            "This is not the page you're looking for.", 'img[alt*="404"]')
+        self.add_tour_step("<b>Have a great day!</b>", title="☀️ ☀️ ☀️ ☀️")
+        self.add_tour_step("<b>And may the Force be with you!</b>", title="⭐")
+        self.export_tour(filename="octocat_tour.js")
+        self.play_tour()

examples/tour_examples/octocat_tour.py

@@ -32,6 +32,7 @@
 * Can handle Google Authenticator logins with [Python's one-time password library](https://pyotp.readthedocs.io/en/latest/).
 * Is backwards-compatible with Python [WebDriver](https://www.selenium.dev/projects/) methods. (Use: ``self.driver``)
 * Can execute JavaScript code from Python calls. (Use: ``self.execute_script()``)
+* Can pierce through Shadow DOM selectors. (Add ``::shadow`` to CSS fragments.)
 * Includes integrations for [MySQL](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/core/testcase_manager.py), [Selenium Grid](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/utilities/selenium_grid), [Azure](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/azure/jenkins/ReadMe.md), [GCP](https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/google_cloud/ReadMe.md), [AWS](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/plugins/s3_logging_plugin.py), and [Docker](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/docker/ReadMe.md).
 * Includes a tool for [converting Selenium IDE recordings](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/utilities/selenium_ide) into SeleniumBase scripts.
 * Can load and make assertions on PDF files from websites or the local file system.

help_docs/features_list.md

@@ -157,11 +157,11 @@ self.load_html_file(html_file, new_page=True)
 
 self.open_html_file(html_file)
 
-self.execute_script(script)
+self.execute_script(script, *args, **kwargs)
 
 self.execute_async_script(script, timeout=None)
 
-self.safe_execute_script(script)
+self.safe_execute_script(script, *args, **kwargs)
 
 self.set_window_rect(x, y, width, height)
 

help_docs/method_summary.md

@@ -116,46 +116,46 @@ With SeleniumBase, you can use Page Objects to break out code from tests, but re
 ```python
 from seleniumbase import BaseCase
 
-class DataPage():
+class LoginPage():
 
-    def go_to_data_url(self, sb):
-        sb.open("data:text/html,<p>Hello!</p><input />")
+    def login_to_swag_labs(self, sb, username):
+        sb.open("https://www.saucedemo.com/")
+        sb.type("#user-name", username)
+        sb.type("#password", "secret_sauce")
+        sb.click('input[type="submit"]')
 
-    def add_input_text(self, sb, text):
-        sb.type("input", text)
+class MyTests(BaseCase):
 
-class ObjTests(BaseCase):
-
-    def test_data_url_page(self):
-        DataPage().go_to_data_url(self)
-        self.assert_text("Hello!", "p")
-        DataPage().add_input_text(self, "Goodbye!")
+    def test_swag_labs_login(self):
+        LoginPage().login_to_swag_labs(self, "standard_user")
+        self.assert_element("#inventory_container")
+        self.assert_text("Products", "div.product_label")
 ```
 
-(See <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/boilerplates/classic_obj_test.py">examples/boilerplates/classic_obj_test.py</a> for the full test.)
+(See <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/boilerplates/samples/swag_labs_test.py">examples/boilerplates/samples/swag_labs_test.py</a> for the full test.)
 
 <h3><img src="https://seleniumbase.io/img/green_logo.png" title="SeleniumBase" width="32" /> 6. The classic Page Object Model with the <code>sb</code> pytest fixture</h3>
 
 This is similar to the classic Page Object Model with <code>BaseCase</code> inheritance, except that this time we pass the <code>sb</code> pytest fixture from the test into the <code>sb</code> arg of the page object class method, (instead of passing <code>self</code>). Now that you're using <code>sb</code> as a pytest fixture, you no longer need to import <code>BaseCase</code> anywhere in your code. See the example below:
 
 ```python
-class DataPage():
-
-    def go_to_data_url(self, sb):
-        sb.open("data:text/html,<p>Hello!</p><input />")
+class LoginPage():
 
-    def add_input_text(self, sb, text):
-        sb.type("input", text)
+    def login_to_swag_labs(self, sb, username):
+        sb.open("https://www.saucedemo.com/")
+        sb.type("#user-name", username)
+        sb.type("#password", "secret_sauce")
+        sb.click('input[type="submit"]')
 
-class ObjTests():
+class MyTests():
 
-    def test_data_url_page(self, sb):
-        DataPage().go_to_data_url(sb)
-        sb.assert_text("Hello!", "p")
-        DataPage().add_input_text(sb, "Goodbye!")
+    def test_swag_labs_login(self, sb):
+        LoginPage().login_to_swag_labs(sb, "standard_user")
+        sb.assert_element("#inventory_container")
+        sb.assert_text("Products", "div.product_label")
 ```
 
-(See <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/boilerplates/sb_fixture_test.py">examples/boilerplates/sb_fixture_test.py</a> for the full test.)
+(See <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/boilerplates/samples/sb_swag_test.py">examples/boilerplates/samples/sb_swag_test.py</a> for the full test.)
 
 <h3><img src="https://seleniumbase.io/img/green_logo.png" title="SeleniumBase" width="32" /> 7. Using the <code>request</code> fixture to get the <code>sb</code> fixture (no class)</h3>
 

help_docs/syntax_formats.md

@@ -3,7 +3,7 @@ pip>=21.0.1;python_version>="3.6"
 packaging>=20.9
 setuptools>=44.1.1;python_version<"3.5"
 setuptools>=50.3.2;python_version>="3.5" and python_version<"3.6"
-setuptools>=54.1.2;python_version>="3.6"
+setuptools>=54.2.0;python_version>="3.6"
 setuptools-scm==5.0.2;python_version<"3.6"
 setuptools-scm>=6.0.1;python_version>="3.6"
 wheel>=0.36.2
@@ -47,7 +47,7 @@ pytest-xdist==2.2.1;python_version>="3.5"
 parameterized==0.8.1
 soupsieve==1.9.6;python_version<"3.5"
 soupsieve==2.0.1;python_version>="3.5" and python_version<"3.6"
-soupsieve==2.2;python_version>="3.6"
+soupsieve==2.2.1;python_version>="3.6"
 beautifulsoup4==4.9.3
 cryptography==2.9.2;python_version<"3.5"
 cryptography==3.0;python_version>="3.5" and python_version<"3.6"
@@ -59,7 +59,7 @@ pygments==2.8.1;python_version>="3.5"
 traitlets==4.3.3;python_version<"3.7"
 traitlets==5.0.5;python_version>="3.7"
 prompt-toolkit==1.0.18;python_version<"3.6"
-prompt-toolkit==3.0.17;python_version>="3.6"
+prompt-toolkit==3.0.18;python_version>="3.6"
 ipython==5.10.0;python_version<"3.5"
 ipython==6.5.0;python_version>="3.5" and python_version<"3.6"
 ipython==7.16.1;python_version>="3.6" and python_version<"3.7"