Merge pull request #584 from mozilla/vs/Refactoring3

VS/Refactoring address bar and search

Author: vsangereanMOZ

modules/browser_object_navigation.py

@@ -106,6 +106,11 @@ def set_search_mode_via_awesome_bar(self, mode: str) -> BasePage:
         )
         return self
 
+    @BasePage.context_chrome
+    def click_firefox_suggest(self) -> None:
+        """Click the Firefox suggested result."""
+        self.get_element("firefox-suggest").click()
+
     @BasePage.context_chrome
     def search(self, term: str, mode=None) -> BasePage:
         """
@@ -215,6 +220,7 @@ def set_search_mode(self, search_mode: str) -> BasePage:
         self.get_element("search-mode-switcher-option", labels=[search_mode]).click()
         return self
 
+    @BasePage.context_chrome
     def context_click_in_awesome_bar(self) -> BasePage:
         self.set_awesome_bar()
         actions = ActionChains(self.driver)
@@ -390,3 +396,8 @@ def confirm_bookmark_exists(self, match_string: str) -> BasePage:
         )
         assert matches_short_string or matches_long_string
         return self
+
+    @BasePage.context_chrome
+    def get_legacy_search_engine_label(self) -> str:
+        """Return the displayed engine name from the legacy search bar."""
+        return self.driver.find_element(By.CSS_SELECTOR, ".searchbar-engine-name").get_attribute("value")

modules/browser_object_tabbar.py

@@ -77,6 +77,11 @@ def reopen_closed_tab_by_keys(self, sys_platform: str) -> BasePage:
             ).key_up(Keys.SHIFT).key_up(Keys.CONTROL).perform()
         return self
 
+    @BasePage.context_chrome
+    def close_first_tab_by_icon(self) -> None:
+        """Click the close icon on the first tab."""
+        self.get_elements("tab-x-icon")[0].click()
+
     @BasePage.context_chrome
     def click_tab_by_title(self, title: str) -> BasePage:
         """Given a full page title, click the corresponding tab"""

modules/page_base.py

@@ -255,7 +255,7 @@ def get_selector(self, name: str, labels=[]) -> list:
         return selector
 
     def get_element(
-        self, name: str, multiple=False, parent_element=None, labels=[]
+            self, name: str, multiple=False, parent_element=None, labels=[]
     ) -> Union[list[WebElement], WebElement]:
         """
         Given a key for a self.elements dict entry, return the Selenium WebElement(s).
@@ -377,7 +377,7 @@ def get_elements(self, name: str, labels=[]):
         return self.get_element(name, multiple=True, labels=labels)
 
     def get_parent_of(
-        self, reference: Union[str, tuple, WebElement], labels=[]
+            self, reference: Union[str, tuple, WebElement], labels=[]
     ) -> WebElement:
         """
         Given a name + labels, a WebElement, or a tuple, return the direct parent node of the element.
@@ -400,15 +400,15 @@ def element_visible(self, name: str, labels=[]) -> Page:
         """Expect helper: wait until element is visible or timeout"""
         self.expect(
             lambda _: self.get_element(name, labels=labels)
-            and self.get_element(name, labels=labels).is_displayed()
+                      and self.get_element(name, labels=labels).is_displayed()
         )
         return self
 
     def element_not_visible(self, name: str, labels=[]) -> Page:
         """Expect helper: wait until element is not visible or timeout"""
         self.expect(
             lambda _: self.get_elements(name, labels=labels) == []
-            or not self.get_element(name, labels=labels).is_displayed()
+                      or not self.get_element(name, labels=labels).is_displayed()
         )
         return self
 
@@ -422,7 +422,7 @@ def element_selected(self, name: str, labels=[]) -> Page:
         """Expect helper: wait until element is selected or timeout"""
         self.expect(
             lambda _: self.get_element(name, labels=labels)
-            and self.get_element(name, labels=labels).is_selected()
+                      and self.get_element(name, labels=labels).is_selected()
         )
         return self
 
@@ -432,13 +432,13 @@ def element_has_text(self, name: str, text: str, labels=[]) -> Page:
         return self
 
     def expect_element_attribute_contains(
-        self, name: str, attr_name: str, attr_value: Union[str, float, int], labels=[]
+            self, name: str, attr_name: str, attr_value: Union[str, float, int], labels=[]
     ) -> Page:
         """Expect helper: wait until element attribute contains certain value"""
         self.expect(
             lambda _: self.get_element(name, labels=labels)
-            and str(attr_value)
-            in self.get_element(name, labels=labels).get_attribute(attr_name)
+                      and str(attr_value)
+                      in self.get_element(name, labels=labels).get_attribute(attr_name)
         )
         return self
 
@@ -468,7 +468,7 @@ def verify_opened_image_url(self, url_substr: str, pattern: str) -> Page:
         return self
 
     def fill(
-        self, name: str, term: str, clear_first=True, press_enter=True, labels=[]
+            self, name: str, term: str, clear_first=True, press_enter=True, labels=[]
     ) -> Page:
         """
         Get a fillable element and fill it with text. Return self.
@@ -527,7 +527,7 @@ def click_on(self, reference: Union[str, tuple, WebElement], labels=[]) -> Page:
         return self
 
     def multi_click(
-        self, iters: int, reference: Union[str, tuple, WebElement], labels=[]
+            self, iters: int, reference: Union[str, tuple, WebElement], labels=[]
     ) -> Page:
         """Perform multiple clicks at once on an element by name, selector, or WebElement"""
         with self.driver.context(self.context_id):
@@ -559,7 +559,7 @@ def triple_click(self, reference: Union[str, tuple, WebElement], labels=[]) -> P
         return self.multi_click(3, reference, labels)
 
     def context_click(
-        self, reference: Union[str, tuple, WebElement], labels=[]
+            self, reference: Union[str, tuple, WebElement], labels=[]
     ) -> Page:
         """Context (right-) click on an element"""
         with self.driver.context(self.context_id):
@@ -595,7 +595,7 @@ def undo(self) -> Page:
         return self
 
     def paste_to_element(
-        self, sys_platform, reference: Union[str, tuple, WebElement], labels=[]
+            self, sys_platform, reference: Union[str, tuple, WebElement], labels=[]
     ) -> Page:
         """Paste the copied item into the element"""
         with self.driver.context(self.context_id):
@@ -608,7 +608,7 @@ def paste_to_element(
         return self
 
     def copy_image_from_element(
-        self, keyboard, reference: Union[str, tuple, WebElement], labels=[]
+            self, keyboard, reference: Union[str, tuple, WebElement], labels=[]
     ) -> Page:
         """Copy from the given element using right click (pynput)"""
         with self.driver.context(self.context_id):
@@ -623,7 +623,7 @@ def copy_image_from_element(
         return self
 
     def copy_selection(
-        self, keyboard, reference: Union[str, tuple, WebElement], labels=[]
+            self, keyboard, reference: Union[str, tuple, WebElement], labels=[]
     ) -> Page:
         """Copy from the current selection using right click (pynput)"""
         with self.driver.context(self.context_id):
@@ -636,7 +636,7 @@ def copy_selection(
         return self
 
     def click_and_hide_menu(
-        self, reference: Union[str, tuple, WebElement], labels=[]
+            self, reference: Union[str, tuple, WebElement], labels=[]
     ) -> Page:
         """Click an option in a context menu, then hide it"""
         with self.driver.context(self.driver.CONTEXT_CHROME):
@@ -667,7 +667,7 @@ def scroll_to_element(self, reference: Union[str, tuple, WebElement], labels=[])
         return self
 
     def get_all_children(
-        self, reference: Union[str, tuple, WebElement], labels=[]
+            self, reference: Union[str, tuple, WebElement], labels=[]
     ) -> List[WebElement]:
         """
         Gets all the children of a webelement
@@ -679,7 +679,7 @@ def get_all_children(
         return children
 
     def wait_for_no_children(
-        self, parent: Union[str, tuple, WebElement], labels=[]
+            self, parent: Union[str, tuple, WebElement], labels=[]
     ) -> Page:
         """
         Waits for 0 children under the given parent, the wait is instant (note, this changes the driver implicit wait and changes it back)
@@ -840,7 +840,7 @@ def handle_os_download_confirmation(self, keyboard: Controller, sys_platform: st
         keyboard.release(Key.enter)
 
     def hide_popup_by_child_node(
-        self, reference: Union[str, tuple, WebElement], labels=[], retry=False
+            self, reference: Union[str, tuple, WebElement], labels=[], retry=False
     ) -> Page:
         try:
             with self.driver.context(self.context_id):

modules/util.py

@@ -106,6 +106,12 @@ def __init__(self):
         self.fake = None
         self.locale = None
 
+    def assert_search_code_in_url(self, driver, nav, expected_code):
+        assert expected_code in driver.current_url, (
+            f"Expected '{expected_code}' in URL, got: {driver.current_url}"
+        )
+        nav.clear_awesome_bar()
+
     def remove_file(self, path: str):
         try:
             os.remove(path)

tests/address_bar_and_search/test_adaptive_history_autofill.py

@@ -40,13 +40,11 @@ def test_add_adaptive_history_autofill(driver: Firefox):
     tabs.new_tab_by_button()
     tabs.wait_for_num_tabs(2)
     driver.switch_to.window(driver.window_handles[1])
-    with driver.context(driver.CONTEXT_CHROME):
-        tabs.get_elements("tab-x-icon")[0].click()
+    tabs.close_first_tab_by_icon()
 
     # Step 3: Type in address bar, click adaptive suggestion
     nav.type_in_awesome_bar("nat")
-    with driver.context(driver.CONTEXT_CHROME):
-        nav.get_element("firefox-suggest").click()
+    nav.click_firefox_suggest()
     nav.expect_in_content(EC.url_contains(TEST_URL))
 
     # Step 4: Open new tab and check for autofill suggestion

tests/address_bar_and_search/test_add_engine_address_bar.py

@@ -13,29 +13,33 @@ def test_case():
 
 
 @pytest.fixture()
-def hard_quit():
+def hard_quit() -> bool:
+    """Ensure Firefox quits cleanly after the test."""
     return True
 
 
 def test_add_search_engine_from_address_bar(driver: Firefox):
     """
-    C1365478 - Verify that Open Search engines can be added via the address bar context menu.
+    C1365478 - Verify that OpenSearch engines can be added via the address bar context menu.
     """
     nav = Navigation(driver)
     menu = ContextMenu(driver)
     tabs = TabBar(driver)
 
+    # Step 1: Open target site
     driver.get(TEST_URL)
     nav.custom_wait(timeout=20).until(lambda d: "youtube.com" in d.current_url)
 
-    with driver.context(driver.CONTEXT_CHROME):
-        nav.context_click_in_awesome_bar()
-        menu.click_context_item("context-menu-add-search-engine")
+    # Step 2: Open context menu on address bar and click "Add search engine"
+    nav.context_click_in_awesome_bar()
+    menu.click_context_item("context-menu-add-search-engine")
 
-        tabs.new_tab_by_button()
-        youtube_tab = tabs.get_tab_by_title(EXPECTED_ENGINE)
-        tabs.close_tab(youtube_tab)
+    # Step 3: A new tab should open with the engine config page, close it
+    tabs.new_tab_by_button()
+    youtube_tab = tabs.get_tab_by_title(EXPECTED_ENGINE)
+    tabs.close_tab(youtube_tab)
 
-        nav.click_on("searchmode-switcher")
-        nav.element_exists("search-mode-switcher-option", labels=[EXPECTED_ENGINE])
-        nav.click_on("searchmode-switcher")
+    # Step 4: Open search mode switcher and verify engine is listed
+    nav.click_on("searchmode-switcher")
+    nav.element_exists("search-mode-switcher-option", labels=[EXPECTED_ENGINE])
+    nav.click_on("searchmode-switcher")  # close dropdown

tests/address_bar_and_search/test_default_search_provider_change_awesome_bar.py

@@ -22,12 +22,13 @@ def test_default_search_provider_change_awesome_bar(driver: Firefox):
     nav = Navigation(driver)
     prefs = AboutPrefs(driver)
 
+    # Step 1: Open new tab and go to search engine settings
     driver.get("about:newtab")
     nav.open_searchmode_switcher_settings()
 
+    # Step 2: Change the default search engine
     prefs.search_engine_dropdown().select_option(SEARCH_ENGINE)
 
+    # Step 3: Re-open new tab and verify placeholder
     driver.get("about:newtab")
-    nav.expect_element_attribute_contains(
-        "awesome-bar", "placeholder", EXPECTED_PLACEHOLDER
-    )
+    nav.expect_element_attribute_contains("awesome-bar", "placeholder", EXPECTED_PLACEHOLDER)

tests/address_bar_and_search/test_default_search_provider_change_legacy_search_bar.py

@@ -1,6 +1,5 @@
 import pytest
 from selenium.webdriver import Firefox
-from selenium.webdriver.common.by import By
 
 from modules.browser_object import Navigation, PanelUi, TabBar
 from modules.page_object import AboutPrefs, CustomizeFirefox
@@ -26,32 +25,31 @@ def test_default_search_provider_change_legacy_search_bar(driver: Firefox):
     tabs = TabBar(driver)
     prefs = AboutPrefs(driver, category="search")
 
-    # Add legacy search bar to toolbar
+    # Step 1: Add legacy search bar to toolbar
     panel_ui.open_panel_menu()
     panel_ui.navigate_to_customize_toolbar()
     customize.add_widget_to_toolbar("search-bar")
 
-    # Open a new tab and trigger search settings navigation
+    # Step 2: Open a new tab and trigger search settings from search bar
     tabs.new_tab_by_button()
     nav.type_in_search_bar(SEARCH_TERM)
     nav.click_on_change_search_settings_button()
     driver.switch_to.window(driver.window_handles[2])
     assert driver.current_url == SEARCH_SETTINGS_URL
 
-    # Validate navigation returns to site and settings page opens in new tab
+    # Step 3: Open site, repeat nav to settings (validates correct tab handling)
     driver.get("https://9gag.com/")
     nav.type_in_search_bar(SEARCH_TERM)
     nav.click_on_change_search_settings_button()
     assert driver.current_url == "https://9gag.com/"
     driver.switch_to.window(driver.window_handles[3])
     assert driver.current_url == SEARCH_SETTINGS_URL
 
-    # Change the default search engine
+    # Step 4: Change the default search engine
     prefs.open()
     prefs.search_engine_dropdown().select_option(SEARCH_ENGINE)
 
-    # Perform another search and validate engine label
+    # Step 5: Perform another search and validate engine label (via decorated method)
     nav.type_in_search_bar(SEARCH_TERM)
-    with driver.context(driver.CONTEXT_CHROME):
-        engine_name = driver.find_element(By.CSS_SELECTOR, ".searchbar-engine-name")
-        assert engine_name.get_attribute("value") == EXPECTED_ENGINE_DISPLAY
+    engine_label = nav.get_legacy_search_engine_label()
+    assert engine_label == EXPECTED_ENGINE_DISPLAY