Merge pull request #488 from mozilla/tracy/unify-open-switch-to-window

Tracy-Walker · web-flow · commit 0f7afdef596a · 2025-02-28T13:30:32.000-06:00
Unify opening browser windows.
diff --git a/l10n_CM/Unified/test_demo_ad_email_phone_captured_in_doorhanger_and_stored.py b/l10n_CM/Unified/test_demo_ad_email_phone_captured_in_doorhanger_and_stored.py
@@ -38,12 +38,17 @@ def test_demo_ad_email_phone_captured_in_doorhanger_and_stored(
 
     # containing phone field
     expected_phone = address_autofill_data.telephone
-    actual_phone = autofill_popup.get_cc_doorhanger_data("address-doorhanger-phone")
-    normalize_expected = util.normalize_regional_phone_numbers(expected_phone, region)
-    normalized_actual = util.normalize_regional_phone_numbers(actual_phone, region)
-    assert normalized_actual == normalize_expected, (
-        f"Phone number mismatch for {region} | Expected: {normalize_expected}, Got: {normalized_actual}"
-    )
+    # Skip verification if phone number isn't provided
+    if expected_phone:
+        with driver.context(driver.CONTEXT_CHROME):
+            actual_phone = autofill_popup.get_element("address-doorhanger-phone").text
+        normalize_expected = util.normalize_regional_phone_numbers(
+            expected_phone, region
+        )
+        normalized_actual = util.normalize_regional_phone_numbers(actual_phone, region)
+        assert normalized_actual == normalize_expected, (
+            f"Phone number mismatch for {region} | Expected: {normalize_expected}, Got: {normalized_actual}"
+        )
 
     # Click the "Save" button
     autofill_popup.click_doorhanger_button("save")
diff --git a/modules/page_base.py b/modules/page_base.py
@@ -3,6 +3,7 @@
 import os
 import platform
 import re
+import sys
 import time
 from copy import deepcopy
 from pathlib import Path
@@ -678,20 +679,55 @@ def wait_for_num_tabs(self, num_tabs: int) -> Page:
 
     def switch_to_new_tab(self) -> Page:
         """Get list of all window handles, switch to the newly opened tab"""
-        self.driver.switch_to.window(self.driver.window_handles[-1])
+        with self.driver.context(self.driver.CONTEXT_CONTENT):
+            self.driver.switch_to.window(self.driver.window_handles[-1])
         return self
 
     def switch_to_new_window(self) -> Page:
         """Switch to the most recently opened window. Can be a standard or private window"""
-        all_window_handles = self.driver.window_handles
-        self.driver.switch_to.window(all_window_handles[-1])
+        with self.driver.context(self.driver.CONTEXT_CONTENT):
+            all_window_handles = self.driver.window_handles
+            self.driver.switch_to.window(all_window_handles[-1])
         return self
 
     def wait_for_num_windows(self, num: int) -> Page:
         """Wait for the number of open tabs + windows to equal given int"""
         with self.driver.context(self.driver.CONTEXT_CONTENT):
             return self.wait_for_num_tabs(num)
 
+    def open_and_switch_to_new_window(self, browser_window: str) -> Page:
+        """
+        Opens a new browser window of the given type, then switches to it.
+
+        Parameters:
+            browser_window: Can be a standard 'window', 'tab' or 'private' browser window.
+        """
+        if browser_window == "private":
+            self.open_and_switch_to_private_window_via_keyboard()
+        else:
+            self.driver.switch_to.new_window(browser_window)
+        return self
+
+    def open_and_switch_to_private_window_via_keyboard(self) -> Page:
+        """
+        Opens a new private browsing window via keyboard shortcut and switch to it
+        """
+        # Keep track of window count to ensure we get a new one to switch to
+        window_count = len(self.driver.window_handles)
+
+        with self.driver.context(self.driver.CONTEXT_CHROME):
+            os_name = sys.platform
+            mod_key = Keys.COMMAND if os_name == "darwin" else Keys.CONTROL
+            self.actions.key_down(mod_key)
+            self.actions.key_down(Keys.SHIFT)
+            self.actions.send_keys("p")
+            self.actions.key_up(Keys.SHIFT)
+            self.actions.key_up(mod_key).perform()
+        expected_window_count = window_count + 1
+        self.wait_for_num_windows(expected_window_count)
+        self.switch_to_new_window()
+        return self
+
     def switch_to_frame(self, frame: str, labels=[]) -> Page:
         """Switch to inline document frame"""
         with self.driver.context(self.driver.CONTEXT_CHROME):
diff --git a/tests/bookmarks_and_history/test_clear_all_history.py b/tests/bookmarks_and_history/test_clear_all_history.py
@@ -20,7 +20,8 @@ def test_clear_all_history(driver: Firefox):
     """
     C172045: Verify that the user can Clear all the History
     """
-    panel_ui = PanelUi(driver).open()
+    panel_ui = PanelUi(driver)
+    panel_ui.open()
     gen_page = GenericPage(driver)
     panel_ui.open_history_menu()
     ba = BrowserActions(driver)
diff --git a/tests/bookmarks_and_history/test_clear_recent_history_displayed.py b/tests/bookmarks_and_history/test_clear_recent_history_displayed.py
@@ -13,7 +13,8 @@ def test_clear_recent_history_displayed(driver: Firefox):
     """
     C172043: Clear recent history panel displayed
     """
-    panel_ui = PanelUi(driver).open()
+    panel_ui = PanelUi(driver)
+    panel_ui.open()
 
     panel_ui.open_panel_menu()
     with driver.context(driver.CONTEXT_CHROME):
diff --git a/tests/bookmarks_and_history/test_open_websites_from_history.py b/tests/bookmarks_and_history/test_open_websites_from_history.py
@@ -29,7 +29,8 @@ def test_open_websites_from_history(driver: Firefox):
     """
     C118807: Verify that the user can open websites from the Toolbar History submenu
     """
-    panel_ui = PanelUi(driver).open()
+    panel_ui = PanelUi(driver)
+    panel_ui.open()
 
     panel_ui.open_history_menu()
 
diff --git a/tests/bookmarks_and_history/test_opened_website_in_new_window_present_in_toolbar_history.py b/tests/bookmarks_and_history/test_opened_website_in_new_window_present_in_toolbar_history.py
@@ -27,13 +27,8 @@ def test_the_website_opened_in_new_window_is_present_in_history_menu(driver: Fir
     for url in WEBSITES:
         GenericPage(driver, url=url).open()
 
-    tabs = TabBar(driver)
     panel_ui = PanelUi(driver)
-
-    panel_ui.open_panel_menu()
-    panel_ui.select_panel_setting("panel-ui-new-window")
-    tabs.wait_for_num_tabs(2)
-    tabs.switch_to_new_window()
+    panel_ui.open_and_switch_to_new_window("window")
 
     page = GenericPage(driver, url=YOUTUBE_URL)
     page.open()
diff --git a/tests/bookmarks_and_history/test_opened_website_present_in_toolbar_history.py b/tests/bookmarks_and_history/test_opened_website_present_in_toolbar_history.py
@@ -26,7 +26,8 @@ def test_the_most_recent_website_is_present_in_history_menu(driver: Firefox):
     for url in WEBSITES:
         GenericPage(driver, url=url).open()
 
-    panel_ui = PanelUi(driver).open()
+    panel_ui = PanelUi(driver)
+    panel_ui.open()
     panel_ui.open_history_menu()
 
     # Verify YouTube is present in the history menu and is on top of the list as the most recent website visited
diff --git a/tests/bookmarks_and_history/test_private_window_website_not_in_history.py b/tests/bookmarks_and_history/test_private_window_website_not_in_history.py
@@ -19,8 +19,7 @@ def test_opened_website_in_private_window_not_captured_in_history_list(driver: F
     """
 
     panel_ui = PanelUi(driver)
-    panel_ui.open_private_window()
-    panel_ui.switch_to_new_window()
+    panel_ui.open_and_switch_to_new_window("private")
 
     GenericPage(driver, url=YOUTUBE_URL).open()
 
diff --git a/tests/networking/test_http_site.py b/tests/networking/test_http_site.py
@@ -31,13 +31,18 @@ def set_prefs():
 def test_http_site(driver: Firefox):
     """C2300294 Check that HTTP is allowed when appropriate"""
 
+    # Instantiate objects
+
     # Basic functionality
     prefs = AboutPrefs(driver, category="privacy")
+    nav = Navigation(driver)
+    panel_ui = PanelUi(driver)
+
+    # Basic functionality
     prefs.open()
     prefs.select_https_only_setting(prefs.HTTPS_ONLY_STATUS.HTTPS_ONLY_DISABLED)
-    driver.switch_to.new_window("tab")
+    panel_ui.open_and_switch_to_new_window("tab")
     driver.get(HTTP_SITE)
-    nav = Navigation(driver)
     nav.element_attribute_contains("lock-icon", "tooltiptext", CONNECTION_NOT_SECURE)
 
     # Blocking
@@ -58,9 +63,8 @@ def test_http_site(driver: Firefox):
     nav.element_attribute_contains("lock-icon", "tooltiptext", CONNECTION_NOT_SECURE)
 
     # Private browsing - blocked
-    hamburger = PanelUi(driver)
-    hamburger.open_private_window()
-    nav.switch_to_new_window()
+    panel_ui.open_and_switch_to_new_window("private")
+
     try:
         driver.get(HTTP_SITE)
         assert "badssl" not in driver.current_url, "Site should not be displayed"
diff --git a/tests/scrolling_panning_zooming/test_zoom_text_only.py b/tests/scrolling_panning_zooming/test_zoom_text_only.py
@@ -97,15 +97,16 @@ def test_zoom_text_only_from_settings(
     """
     # Initializing objects
     nav = Navigation(driver)
+    panel_ui = PanelUi(driver)
 
     # Save the original positions of elements for comparison
-    driver.switch_to.new_window("tab")
+    panel_ui.open_and_switch_to_new_window("tab")
     nav.search(WEBSITE_2)
     web_page.wait.until(lambda _: web_page.title_contains("DuckDuckGo"))
     original_positions = save_original_positions(driver, web_page)
 
     # Set the pref to zoom text only
-    driver.switch_to.new_window("tab")
+    panel_ui.open_and_switch_to_new_window("tab")
     about_prefs = AboutPrefs(driver, category="General").open()
     about_prefs.click_on("zoom-text-only")
 
@@ -132,15 +133,16 @@ def test_zoom_text_only_after_restart(
     """
     # Initializing objects
     nav = Navigation(driver)
+    panel_ui = PanelUi(driver)
 
     # Save the original positions of elements for comparison
-    driver.switch_to.new_window("tab")
+    panel_ui.open_and_switch_to_new_window("tab")
     nav.search(WEBSITE_2)
     web_page.wait.until(lambda _: web_page.title_contains("DuckDuckGo"))
     original_positions = save_original_positions(driver, web_page)
 
     # Set default zoom level
-    driver.switch_to.new_window("tab")
+    panel_ui.open_and_switch_to_new_window("tab")
     about_prefs = AboutPrefs(driver, category="General").open()
     about_prefs.set_default_zoom_level(110)
 
diff --git a/tests/security_and_privacy/test_cookies_not_saved_private_browsing.py b/tests/security_and_privacy/test_cookies_not_saved_private_browsing.py
@@ -18,13 +18,11 @@ def test_cookies_not_saved_private_browsing(driver: Firefox):
     # Instantiate objs
     about_prefs = AboutPrefs(driver, category="privacy")
     panel_ui = PanelUi(driver)
-    nav = Navigation(driver)
     google_search = GoogleSearch(driver)
     ba = BrowserActions(driver)
 
     # Open new private window
-    panel_ui.open_private_window()
-    nav.switch_to_new_window()
+    panel_ui.open_and_switch_to_new_window("private")
 
     # Open the Google page and perform a search
     google_search.open()
diff --git a/tests/security_and_privacy/test_downloads_from_private_not_leaked.py b/tests/security_and_privacy/test_downloads_from_private_not_leaked.py
@@ -35,12 +35,10 @@ def test_downloads_from_private_not_leaked(driver: Firefox, delete_files, screen
 
     # We've deleted relevant downloads_file just to be safe
     non_private_window = driver.current_window_handle
-    panelui = PanelUi(driver)
-    panelui.open_panel_menu()
-    panelui.select_panel_setting("new-private-window-option")
-
+    panel_ui = PanelUi(driver)
     nav = Navigation(driver)
-    nav.switch_to_new_window()
+
+    panel_ui.open_and_switch_to_new_window("private")
 
     about_downloads = AboutDownloads(driver)
     about_downloads.open()
diff --git a/tests/security_and_privacy/test_https_enabled_private_browsing.py b/tests/security_and_privacy/test_https_enabled_private_browsing.py
@@ -2,7 +2,7 @@
 from selenium.webdriver import Firefox
 from selenium.webdriver.support.wait import WebDriverWait
 
-from modules.browser_object import Navigation, PanelUi
+from modules.browser_object import PanelUi
 from modules.page_object import AboutPrefs
 
 
@@ -19,15 +19,15 @@ def test_https_first_mode_in_private_browsing(driver: Firefox):
     C1362731 Check that https First Mode is properly enabled and working in Private Browsing
     """
 
-    # Navigate to the HTTP Site in a Private Window
+    # Instantiate objects
     prefs = AboutPrefs(driver, category="privacy")
+    panel_ui = PanelUi(driver)
+
+    # Navigate to the HTTP Site in a Private Window
     prefs.open()
     prefs.select_https_only_setting(prefs.HTTPS_ONLY_STATUS.HTTPS_ONLY_PRIVATE)
-    hamburger = PanelUi(driver)
-    hamburger.open_private_window()
-
-    nav = Navigation(driver)
-    nav.switch_to_new_window()
+    panel_ui.open_and_switch_to_new_window("private")
+    driver.get("about:blank")
     driver.get(HTTP_SITE)
 
     # Wait for the URL to be redirected to HTTPS
diff --git a/tests/security_and_privacy/test_never_remember_browsing_history.py b/tests/security_and_privacy/test_never_remember_browsing_history.py
@@ -57,7 +57,8 @@ def test_never_remember_browsing_history_from_panel(driver: Firefox):
     """
     C102381.2: Ensure that setting the browser to never remember history does not actually save any history
     """
-    panel_ui = PanelUi(driver).open()
+    panel_ui = PanelUi(driver)
+    panel_ui.open()
     tabs = TabBar(driver)
     # util = Utilities()
 
diff --git a/tests/security_and_privacy/test_private_browser_password_doorhanger.py b/tests/security_and_privacy/test_private_browser_password_doorhanger.py
@@ -26,11 +26,9 @@ def test_no_password_doorhanger_private_browsing(driver: Firefox):
     # Instantiate objects
     login_auto_fill = LoginAutofill(driver)
     panel_ui = PanelUi(driver)
-    nav = Navigation(driver)
 
     # Open Private Window
-    panel_ui.open_private_window()
-    nav.switch_to_new_window()
+    panel_ui.open_and_switch_to_new_window("private")
 
     # Open the form, fill the user and password
     login_auto_fill.open()
diff --git a/tests/security_and_privacy/test_private_session_awesome_bar_exclusion.py b/tests/security_and_privacy/test_private_session_awesome_bar_exclusion.py
@@ -29,8 +29,7 @@ def test_websites_visited_in_private_browser_not_displayed_in_awesome_bar(
     nav = Navigation(driver)
     panel_ui = PanelUi(driver)
 
-    panel_ui.open_private_window()
-    panel_ui.switch_to_new_window()
+    panel_ui.open_and_switch_to_new_window("private")
 
     for url in WEBSITES:
         driver.get(url)
diff --git a/tests/security_and_privacy/test_private_session_history_exclusion.py b/tests/security_and_privacy/test_private_session_history_exclusion.py
@@ -14,11 +14,6 @@ def test_case():
 AMAZON_URL = "https://www.amazon.com/"
 
 
-@pytest.fixture()
-def add_prefs():
-    return []
-
-
 def test_websites_visited_in_private_browser_not_displayed_in_history(driver: Firefox):
     """
     C101663 - Verify the visited websites from the Private Browsing session are not displayed inside the normal session
@@ -27,9 +22,9 @@ def test_websites_visited_in_private_browser_not_displayed_in_history(driver: Fi
 
     initial_window_handle = driver.current_window_handle
 
-    panel_ui = PanelUi(driver).open()
-    panel_ui.open_private_window()
-    panel_ui.switch_to_new_window()
+    panel_ui = PanelUi(driver)
+    panel_ui.open()
+    panel_ui.open_and_switch_to_new_window("private")
 
     driver.get(YOUTUBE_URL)
     driver.get(FACEBOOK_URL)
diff --git a/tests/security_and_privacy/test_third_party_content_blocked_private_browsing.py b/tests/security_and_privacy/test_third_party_content_blocked_private_browsing.py
diff --git a/tests/security_and_privacy/test_undo_close_tab_private_browsing.py b/tests/security_and_privacy/test_undo_close_tab_private_browsing.py
diff --git a/tests/theme_and_toolbar/test_customize_themes_and_redirect.py b/tests/theme_and_toolbar/test_customize_themes_and_redirect.py
