Merge pull request #1171 from seleniumbase/new-methods-a-fix-and-refactoring

New methods, a fix, and some refactoring

Author: mdmintz

examples/test_agent.py

@@ -4,8 +4,41 @@
 class UserAgentTests(BaseCase):
     def test_user_agent(self):
         self.open("http://whatsmyuseragent.org/")
-        user_agent = self.get_text(".user-agent p")
-        print("\n\nUser-Agent:\n%s\n" % user_agent)
+        user_agent_detected = self.get_text(".user-agent p")
+        original_user_agent = user_agent_detected
+        if not self.user_agent:
+            # Using the built-in user-agent string
+            print("\n\nUser-Agent:\n%s\n" % user_agent_detected)
+        else:
+            # User-agent was overridden using: --agent=STRING
+            print("\n\nUser-Agent override:\n%s\n" % user_agent_detected)
         print(self.get_text(".ip-address p"))
-        print("\nThe browser will close automatically in 7 seconds...")
-        self.sleep(7)
+        self.sleep(3)
+
+        # Now change the user-agent using "execute_cdp_cmd()"
+        if not self.is_chromium():
+            msg = "\n* execute_cdp_cmd() is only for Chromium browsers"
+            print(msg)
+            self.skip(msg)
+        print("\n--------------------------")
+        try:
+            self.driver.execute_cdp_cmd(
+                "Network.setUserAgentOverride", {
+                    "userAgent": "Mozilla/5.0 "
+                                 "(Nintendo Switch; WifiWebAuthApplet) "
+                                 "AppleWebKit/606.4 (KHTML, like Gecko) "
+                                 "NF/6.0.1.15.4 NintendoBrowser/5.1.0.20393"
+                }
+            )
+            self.open("http://whatsmyuseragent.org/")
+            user_agent_detected = self.get_text(".user-agent p")
+            print("\nUser-Agent (after override):\n%s\n" % user_agent_detected)
+            print(self.get_text(".ip-address p"))
+            self.sleep(3)
+        finally:
+            # Reset the user-agent back to the original
+            self.driver.execute_cdp_cmd(
+                "Network.setUserAgentOverride", {
+                    "userAgent": original_user_agent
+                }
+            )

examples/test_demo_site.py

@@ -31,7 +31,7 @@ def test_demo_site(self):
 
         # Verify that a button click changes text on the page
         self.assert_text("This Text is Green", "#pText")
-        self.click("#myButton")
+        self.click('button:contains("Click Me")')
         self.assert_text("This Text is Purple", "#pText")
 
         # Assert that the given SVG is visible on the page

examples/user_agent_test.py

@@ -4,9 +4,39 @@
 class UserAgentTests(BaseCase):
     def test_user_agent(self):
         self.open("https://www.whatsmyua.info/")
-        user_agent = self.get_text("#custom-ua-string")
-        print("\n\nUser-Agent = %s\n" % user_agent)
-        print("Displaying User-Agent Info:")
-        print(self.get_text("#useragent"))
-        print("\nThe browser will close automatically in 7 seconds...")
-        self.sleep(7)
+        user_agent_detected = self.get_text("#custom-ua-string")
+        original_user_agent = user_agent_detected
+        if not self.user_agent:
+            # Using the built-in user-agent string
+            print("\n\nUser-Agent = %s\n" % user_agent_detected)
+        else:
+            # User-agent was overridden using: --agent=STRING
+            print("\n\nUser-Agent override = %s\n" % user_agent_detected)
+        self.sleep(3)
+
+        try:
+            # Now change the user-agent using "execute_cdp_cmd()"
+            if not self.is_chromium():
+                msg = "\n* execute_cdp_cmd() is only for Chromium browsers"
+                print(msg)
+                self.skip(msg)
+            print("--------------------------")
+            self.driver.execute_cdp_cmd(
+                "Network.setUserAgentOverride", {
+                    "userAgent": "Mozilla/5.0 "
+                                 "(Nintendo Switch; WifiWebAuthApplet) "
+                                 "AppleWebKit/606.4 (KHTML, like Gecko) "
+                                 "NF/6.0.1.15.4 NintendoBrowser/5.1.0.20393"
+                }
+            )
+            self.open("https://www.whatsmyua.info/")
+            user_agent_detected = self.get_text("#custom-ua-string")
+            print("\nUser-Agent (after override) = %s" % user_agent_detected)
+            self.sleep(3)
+        finally:
+            # Reset the user-agent back to the original
+            self.driver.execute_cdp_cmd(
+                "Network.setUserAgentOverride", {
+                    "userAgent": original_user_agent
+                }
+            )

help_docs/method_summary.md

@@ -110,6 +110,10 @@ self.remove_attribute(selector, attribute, by=By.CSS_SELECTOR, timeout=None)
 
 self.remove_attributes(selector, attribute, by=By.CSS_SELECTOR)
 
+self.get_property(selector, property, by=By.CSS_SELECTOR, timeout=None)
+
+self.get_text_content(selector, by=By.CSS_SELECTOR, timeout=None)
+
 self.get_property_value(selector, property, by=By.CSS_SELECTOR, timeout=None)
 
 self.get_image_url(selector, by=By.CSS_SELECTOR, timeout=None)

requirements.txt

@@ -116,7 +116,7 @@ Pillow==8.4.0;python_version>="3.6" and python_version<"3.7"
 Pillow==9.0.0;python_version>="3.7"
 typing-extensions==3.10.0.2;python_version<"3.6"
 typing-extensions==4.0.0;python_version>="3.6" and python_version<"3.8"
-rich==10.16.2;python_version>="3.6" and python_version<"4.0"
+rich==11.0.0;python_version>="3.6" and python_version<"4.0"
 tornado==5.1.1;python_version<"3.5"
 tornado==6.1;python_version>="3.5"
 pdfminer.six==20191110;python_version<"3.5"

seleniumbase/__version__.py

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "2.3.10"
+__version__ = "2.3.11"

seleniumbase/console_scripts/rich_helper.py

@@ -37,7 +37,9 @@ def display_code(code):
 def fix_emoji_spacing(code):
     try:
         # Fix the display width of certain emojis that take up two spaces
-        double_width_emojis = ["🗺️", "🖼️", "🗄️", "⏺️", "♻️", "🗂️", "🖥️"]
+        double_width_emojis = [
+            "🗺️", "🖼️", "🗄️", "⏺️", "♻️", "🗂️", "🖥️", "🕹️", "🎞️"
+        ]
         for emoji in double_width_emojis:
             if emoji in code:
                 code = code.replace(emoji, emoji + " ")

seleniumbase/fixtures/base_case.py

@@ -72,7 +72,7 @@ def test_anything(self):
     reload(sys)  # noqa: F821
     sys.setdefaultencoding("utf8")
 selenium4 = False
-if sys.version_info[0] == 3 and sys.version_info[1] >= 7:
+if sys.version_info >= (3, 7):
     selenium4 = True
 
 
@@ -1403,6 +1403,50 @@ def remove_attributes(self, selector, attribute, by=By.CSS_SELECTOR):
         except Exception:
             pass
 
+    def get_property(
+        self, selector, property, by=By.CSS_SELECTOR, timeout=None
+    ):
+        """Returns the property value of an element.
+        This is not the same as self.get_property_value(), which returns
+        the value of an element's computed style using a different algorithm.
+        If no result is found, an empty string (instead of None) is returned.
+        Example:
+            html_text = self.get_property(SELECTOR, "textContent")
+        """
+        self.__check_scope()
+        if not timeout:
+            timeout = settings.SMALL_TIMEOUT
+        if self.timeout_multiplier and timeout == settings.SMALL_TIMEOUT:
+            timeout = self.__get_new_timeout(timeout)
+        selector, by = self.__recalculate_selector(selector, by)
+        self.wait_for_ready_state_complete()
+        time.sleep(0.01)
+        element = page_actions.wait_for_element_present(
+            self.driver, selector, by, timeout
+        )
+        try:
+            property_value = element.get_property(property)
+        except (StaleElementReferenceException, ENI_Exception):
+            self.wait_for_ready_state_complete()
+            time.sleep(0.14)
+            element = page_actions.wait_for_element_present(
+                self.driver, selector, by, timeout
+            )
+            property_value = element.get_property(property)
+        if not property_value:
+            return ""
+        return property_value
+
+    def get_text_content(self, selector, by=By.CSS_SELECTOR, timeout=None):
+        """Returns the text that appears in the HTML for an element.
+        This is different from "self.get_text(selector, by=By.CSS_SELECTOR)"
+        because that only returns the visible text on a page for an element,
+        rather than the HTML text that's being returned from this method."""
+        self.__check_scope()
+        return self.get_property(
+            selector, property="textContent", by=by, timeout=timeout
+        )
+
     def get_property_value(
         self, selector, property, by=By.CSS_SELECTOR, timeout=None
     ):
@@ -3895,12 +3939,18 @@ def __are_quotes_escaped(self, string):
     def __escape_quotes_if_needed(self, string):
         return js_utils.escape_quotes_if_needed(string)
 
+    def __is_in_frame(self):
+        return js_utils.is_in_frame(self.driver)
+
     def bring_active_window_to_front(self):
         """Brings the active browser window to the front.
         This is useful when multiple drivers are being used."""
         self.__check_scope()
         try:
-            self.switch_to_window(self.driver.current_window_handle)
+            if not self.__is_in_frame():
+                # Only bring the window to the front if not in a frame
+                # because the driver resets itself to default content.
+                self.switch_to_window(self.driver.current_window_handle)
         except Exception:
             pass
 

seleniumbase/fixtures/js_utils.py

@@ -212,6 +212,24 @@ def escape_quotes_if_needed(string):
     return string
 
 
+def is_in_frame(driver):
+    """
+    Returns True if the driver has switched to a frame.
+    Returns False if the driver was on default content.
+    """
+    return driver.execute_script(
+        """
+        var frame = window.frameElement;
+        if (frame) {
+            return true;
+        }
+        else {
+            return false;
+        }
+        """
+    )
+
+
 def safe_execute_script(driver, script):
     """When executing a script that contains a jQuery command,
     it's important that the jQuery library has been loaded first.

seleniumbase/fixtures/page_utils.py

@@ -2,6 +2,7 @@
 This module contains useful utility methods.
 """
 import codecs
+import os
 import re
 import requests
 
@@ -247,7 +248,8 @@ def _download_file_to(file_url, destination_folder, new_file_name=None):
     else:
         file_name = file_url.split("/")[-1]
     r = requests.get(file_url)
-    with open(destination_folder + "/" + file_name, "wb") as code:
+    file_path = os.path.join(destination_folder, file_name)
+    with open(file_path, "wb") as code:
         code.write(r.content)