Add and update methods related to iframes

Author: mdmintz

help_docs/method_summary.md

@@ -207,9 +207,15 @@ self.switch_to_frame(frame, timeout=None)
 
 self.switch_to_default_content()
 
+self.switch_to_parent_frame()
+
 self.set_content_to_frame(frame, timeout=None)
 
-self.set_content_to_default(nested=True)
+self.set_content_to_default(nested=False)
+# Duplicates: self.set_content_to_default_content(nested=False)
+
+self.set_content_to_parent()
+# Duplicates: self.set_content_to_parent_frame()
 
 self.open_new_window(switch_to=True)
 # Duplicates: self.open_new_tab(switch_to=True)

seleniumbase/fixtures/base_case.py

@@ -2569,9 +2569,9 @@ def switch_to_frame(self, frame, timeout=None):
 
     def switch_to_default_content(self):
         """Brings driver control outside the current iframe.
-        (If the driver control is inside an iframe, the driver control
-        will be set to one level above the current frame. If the driver
-        control is not currently in an iframe, nothing will happen.)"""
+        If the driver is currently set inside an iframe or nested iframes,
+        then the driver control will exit from all entered iframes.
+        If the driver is not currently set in an iframe, nothing happens."""
         self.__check_scope()
         if self.recorder_mode and self._rec_overrides_switch:
             url = self.get_current_url()
@@ -2589,18 +2589,39 @@ def switch_to_default_content(self):
                         return
         self.driver.switch_to.default_content()
 
+    def switch_to_parent_frame(self):
+        """Brings driver control outside the current iframe.
+        If the driver is currently set inside an iframe or nested iframes,
+        the driver control will be set to one level above the current frame.
+        If the driver is not currently set in an iframe, nothing happens."""
+        self.__check_scope()
+        if self.recorder_mode and self._rec_overrides_switch:
+            url = self.get_current_url()
+            if url and len(url) > 0:
+                if ("http:") in url or ("https:") in url or ("file:") in url:
+                    r_a = self.get_session_storage_item("recorder_activated")
+                    if r_a == "yes":
+                        self.__set_c_from_switch = True
+                        self.set_content_to_default(nested=True)
+                        self.__set_c_from_switch = False
+                        time_stamp = self.execute_script("return Date.now();")
+                        origin = self.get_origin()
+                        action = ["sw_pf", "", origin, time_stamp]
+                        self.__extra_actions.append(action)
+                        return
+        self.driver.switch_to.parent_frame()
+
     def set_content_to_frame(self, frame, timeout=None):
         """Replaces the page html with an iframe's html from that page.
-        If the iFrame contains an "src" field that includes a valid URL,
+        If the iframe contains an "src" field that includes a valid URL,
         then instead of replacing the current html, this method will then
-        open up the "src" URL of the iFrame in a new browser tab.
+        open up the "src" URL of the iframe in a new browser tab.
         To return to default content, use: self.set_content_to_default().
         This method also sets the state of the browser window so that the
         self.set_content_to_default() method can bring the user back to
         the original content displayed, which is similar to how the methods
         self.switch_to_frame(frame) and self.switch_to_default_content()
-        work together to get the user into frames and out of all of them.
-        """
+        work together to get the user into frames and out of all of them."""
         self.__check_scope()
         if not timeout:
             timeout = settings.SMALL_TIMEOUT
@@ -2663,12 +2684,12 @@ def set_content_to_frame(self, frame, timeout=None):
             action = ["s_c_f", o_frame, origin, time_stamp]
             self.__extra_actions.append(action)
 
-    def set_content_to_default(self, nested=True):
+    def set_content_to_default(self, nested=False):
         """After using self.set_content_to_frame(), this reverts the page back.
         If self.set_content_to_frame() hasn't been called here, only refreshes.
-        If "nested" is set to False when the content was set to nested iFrames,
-        then the control will only move above the last iFrame that was entered.
-        """
+        If "nested" is set to True when the content is set to a nested iframe,
+        then the page control will only exit from the current iframe entered,
+        instead of exiting out of all iframes entered."""
         self.__check_scope()
         swap_cnt = self.execute_script("return document.cframe_swap;")
         tab_sta = self.execute_script("return document.cframe_tab;")
@@ -2679,7 +2700,10 @@ def set_content_to_default(self, nested=True):
             action = ["sk_op", "", origin, time_stamp]
             self.__extra_actions.append(action)
 
-        if nested:
+        if not nested:
+            # Sets the page to the outer-most content.
+            # If page control was inside nested iframes, exits them all.
+            # If only in one iframe, has the same effect as nested=True.
             if (
                 len(self.__page_sources) > 0
                 and (
@@ -2705,6 +2729,9 @@ def set_content_to_default(self, nested=True):
             self.execute_script("document.cframe_swap = 0;")
             self.__page_sources = []
         else:
+            # (If Nested is True)
+            # Sets the page to the content outside the current nested iframe.
+            # If only in one iframe, has the same effect as nested=True.
             just_refresh = False
             if swap_cnt and int(swap_cnt) > 0 and len(self.__page_sources) > 0:
                 self.execute_script("document.cframe_swap -= 1;")
@@ -2736,6 +2763,24 @@ def set_content_to_default(self, nested=True):
             action = ["s_c_d", nested, origin, time_stamp]
             self.__extra_actions.append(action)
 
+    def set_content_to_default_content(self, nested=False):
+        """Same as self.set_content_to_default()."""
+        self.set_content_to_default(nested=nested)
+
+    def set_content_to_parent(self):
+        """Same as self.set_content_to_parent_frame().
+        Same as self.set_content_to_default(nested=True).
+        Sets the page to the content outside the current nested iframe.
+        Reverts self.set_content_to_frame()."""
+        self.set_content_to_default(nested=True)
+
+    def set_content_to_parent_frame(self):
+        """Same as self.set_content_to_parent().
+        Same as self.set_content_to_default(nested=True).
+        Sets the page to the content outside the current nested iframe.
+        Reverts self.set_content_to_frame()."""
+        self.set_content_to_default(nested=True)
+
     def open_new_window(self, switch_to=True):
         """Opens a new browser tab/window and switches to it by default."""
         self.__check_scope()
@@ -3643,6 +3688,7 @@ def __process_recorded_actions(self):
         ext_actions.append("as_et")
         ext_actions.append("sw_fr")
         ext_actions.append("sw_dc")
+        ext_actions.append("sw_pf")
         ext_actions.append("s_c_f")
         ext_actions.append("s_c_d")
         ext_actions.append("sh_fc")
@@ -3878,6 +3924,8 @@ def __process_recorded_actions(self):
                     sb_actions.append("self.%s('%s')" % (method, action[1]))
             elif action[0] == "sw_dc":
                 sb_actions.append("self.switch_to_default_content()")
+            elif action[0] == "sw_pf":
+                sb_actions.append("self.switch_to_parent_frame()")
             elif action[0] == "s_c_f":
                 method = "set_content_to_frame"
                 if '"' not in action[1]:
@@ -3888,9 +3936,10 @@ def __process_recorded_actions(self):
                 method = "set_content_to_default"
                 nested = action[1]
                 if nested:
+                    method = "set_content_to_parent"
                     sb_actions.append("self.%s()" % method)
                 else:
-                    sb_actions.append("self.%s(nested=False)" % method)
+                    sb_actions.append("self.%s()" % method)
             elif action[0] == "as_el":
                 method = "assert_element"
                 if '"' not in action[1]:
@@ -7001,7 +7050,7 @@ def add_slide(
         image - Attach an image (from a URL link) to the slide.
         code - Attach code of any programming language to the slide.
                Language-detection will be used to add syntax formatting.
-        iframe - Attach an iFrame (from a URL link) to the slide.
+        iframe - Attach an iframe (from a URL link) to the slide.
         content2 - HTML content to display after adding an image or code.
         notes - Additional notes to include with the slide.
                 ONLY SEEN if show_notes is set for the presentation.