Merge pull request #551 from mozilla/vs/refactoring

vs/Part1-Refactoring

Author: vsangereanMOZ

tests/address_bar_and_search/test_adaptive_history_autofill.py

@@ -6,6 +6,10 @@
 from modules.browser_object import Navigation
 from modules.browser_object_tabbar import TabBar
 
+WAIT_TIMEOUT = 10
+TEST_URL = "https://www.nationalgeographic.com/science/"
+EXPECTED_TITLE = "Science"
+
 
 @pytest.fixture()
 def test_case():
@@ -14,58 +18,45 @@ def test_case():
 
 @pytest.fixture()
 def add_to_prefs_list():
-    return [
-        ("browser.urlbar.autoFill.adaptiveHistory.enabled", True),
-    ]
+    return [("browser.urlbar.autoFill.adaptiveHistory.enabled", True)]
 
 
 def test_add_adaptive_history_autofill(driver: Firefox):
     """
-    C1814373 - Test to verify that typing the first three characters of a previously visited URL in the address bar
-    triggers the adaptive history autofill.
+    C1814373 - Verify adaptive history autofill triggers from address bar input.
     """
-
     nav = Navigation(driver)
     tabs = TabBar(driver)
 
-    nav.search("https://www.nationalgeographic.com/science/")
-    WebDriverWait(driver, 10).until(
-        lambda d: tabs.get_tab_title(tabs.get_tab(1)) == "Science"
+    nav.search(TEST_URL)
+    WebDriverWait(driver, WAIT_TIMEOUT).until(
+        lambda d: tabs.get_tab_title(tabs.get_tab(1)) == EXPECTED_TITLE
     )
 
     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):
-        x_icon = tabs.get_elements("tab-x-icon")
-        x_icon[0].click()
+        tabs.get_elements("tab-x-icon")[0].click()
 
-    # Type the first 3 characters of the visited URL in the address bar and select the suggested URL
     nav.type_in_awesome_bar("nat")
     with driver.context(driver.CONTEXT_CHROME):
         nav.get_element("firefox-suggest").click()
-    nav.expect_in_content(
-        EC.url_contains("https://www.nationalgeographic.com/science/")
-    )
 
-    # Open a new tab, type the first 3 characters of the visited URL
+    nav.expect_in_content(EC.url_contains(TEST_URL))
+
     tabs.new_tab_by_button()
     tabs.wait_for_num_tabs(2)
     driver.switch_to.window(driver.window_handles[-1])
     nav.type_in_awesome_bar("nat")
 
     tabs.set_chrome_context()
-    autofill_adaptive_element = nav.get_element(
-        "search-result-autofill-adaptive-element"
-    )
+    autofill_element = nav.get_element("search-result-autofill-adaptive-element")
 
-    # Assertion to verify that the 'autofill_adaptive' type is found
-    assert autofill_adaptive_element.get_attribute("type") == "autofill_adaptive", (
-        f"Expected element type to be 'autofill_adaptive' but found '{autofill_adaptive_element.get_attribute('type')}'"
+    assert autofill_element.get_attribute("type") == "autofill_adaptive", (
+        f"Expected type 'autofill_adaptive', got '{autofill_element.get_attribute('type')}'"
     )
-
-    # Assertion to check the autofilled URL is the expected one
-    assert "nationalgeographic.com/science" in autofill_adaptive_element.text, (
-        "URL 'https://www.nationalgeographic.com/science' not found in autofill suggestions."
+    assert "nationalgeographic.com/science" in autofill_element.text, (
+        f"Autofill text did not contain expected URL. Got: {autofill_element.text}"
     )

tests/address_bar_and_search/test_add_engine_address_bar.py

@@ -1,9 +1,7 @@
 import pytest
 from selenium.webdriver import Firefox
-from selenium.webdriver.support import expected_conditions as EC
 
-from modules.browser_object import Navigation, TabBar
-from modules.browser_object_context_menu import ContextMenu
+from modules.browser_object import ContextMenu, Navigation, TabBar
 
 
 @pytest.fixture()
@@ -18,27 +16,23 @@ def hard_quit():
 
 def test_add_search_engine_from_address_bar(driver: Firefox):
     """
-    C1365478: Open Search Engines can be added using the address bar context click option.
+    C1365478 - Verify that Open Search engines can be added via the address bar context menu.
     """
     nav = Navigation(driver)
     menu = ContextMenu(driver)
     tabs = TabBar(driver)
 
-    # Visit the URL and wait until it is loaded
     driver.get("https://youtube.com")
-    nav.custom_wait(timeout=20).until(EC.url_contains("www.youtube.com"))
+    nav.custom_wait(timeout=20).until(lambda d: "youtube.com" in d.current_url)
 
     with driver.context(driver.CONTEXT_CHROME):
-        # Right-Click the address bar and select the "Add YouTube" option
         nav.context_click_in_awesome_bar()
         menu.click_context_item("context-menu-add-search-engine")
 
-        # Open a new tab and close the previous tab
         tabs.new_tab_by_button()
-        previous_tab = tabs.get_tab_by_title("YouTube")
-        tabs.close_tab(previous_tab)
+        youtube_tab = tabs.get_tab_by_title("YouTube")
+        tabs.close_tab(youtube_tab)
 
-        # Confirm that YouTube is an option in the search mode list
         nav.click_on("searchmode-switcher")
         nav.element_exists("search-mode-switcher-option", labels=["YouTube"])
         nav.click_on("searchmode-switcher")

tests/address_bar_and_search/test_addon_suggestion.py

@@ -1,28 +1,31 @@
-from time import sleep
-
 import pytest
+from selenium.common.exceptions import TimeoutException
 from selenium.webdriver import Firefox
 from selenium.webdriver.support import expected_conditions as EC
+from selenium.webdriver.support.ui import WebDriverWait
 
 from modules.browser_object import Navigation
 
+ADDONS_BASE_URL = "https://addons.mozilla.org/en-US/firefox/addon/"
+
 
 @pytest.fixture()
 def test_case():
     return "2234714"
 
 
+@pytest.fixture()
+def add_to_prefs_list():
+    return [
+        ("browser.urlbar.suggest.addons", True),
+        ("browser.urlbar.addons.featureGate", True),
+    ]
+
+
 def test_addon_suggestion_based_on_search_input(driver: Firefox):
     """
-    C2234714: Test that add-on suggestions match the URL bar input.
-
-    To avoid lengthy waits caused by network traffic during browser startup,
-    this test loops through the list of addons in a single browser session
-    instead of using parameterization. This reduces the overall test duration
-    by waiting for the network traffic only once.
+    C2234714 - Verify that the address bar suggests relevant add-ons based on search input.
     """
-
-    # Map input text to addon names
     input_to_addon_name = {
         "clips": "video-downloadhelper",
         "grammar": "languagetool",
@@ -35,14 +38,19 @@ def test_addon_suggestion_based_on_search_input(driver: Firefox):
 
     nav = Navigation(driver)
     nav.set_awesome_bar()
-    sleep(2)
 
     for input_text, addon_name in input_to_addon_name.items():
         nav.type_in_awesome_bar(input_text)
-        nav.element_visible("addon-suggestion")
+        try:
+            nav.element_visible("addon-suggestion")
+        except TimeoutException:
+            raise AssertionError(
+                f"Addon suggestion not visible for input: '{input_text}'"
+            )
+
         nav.select_element_in_nav("addon-suggestion")
 
-        # Construct the expected URL
-        expected_url = f"https://addons.mozilla.org/en-US/firefox/addon/{addon_name}/"
+        expected_url = f"{ADDONS_BASE_URL}{addon_name}/"
         nav.expect_in_content(EC.url_contains(expected_url))
+
         nav.clear_awesome_bar()

tests/address_bar_and_search/test_default_search_provider_change_awesome_bar.py

@@ -4,6 +4,10 @@
 from modules.browser_object import Navigation
 from modules.page_object import AboutPrefs
 
+WAIT_TIMEOUT = 10
+SEARCH_ENGINE = "DuckDuckGo"
+EXPECTED_PLACEHOLDER = f"Search with {SEARCH_ENGINE} or enter address"
+
 
 @pytest.fixture()
 def test_case():
@@ -13,25 +17,14 @@ def test_case():
 @pytest.mark.ci
 def test_default_search_provider_change_awesome_bar(driver: Firefox):
     """
-    C2860208 - This test makes sure that the default search provider can be changed and settings are applied
+    C2860208 - Verify that changing the default search provider updates the address bar placeholder.
     """
-    # Create objects
     nav = Navigation(driver)
-    about_prefs = AboutPrefs(driver)
+    prefs = AboutPrefs(driver)
 
-    # Make sure we start at about:newtab
     driver.get("about:newtab")
-
-    # Click the USB and click the 'Search Settings' button.
     nav.open_searchmode_switcher_settings()
+    prefs.search_engine_dropdown().select_option(SEARCH_ENGINE)
 
-    # Set a different provider as a default search engine
-    about_prefs.search_engine_dropdown().select_option("DuckDuckGo")
-
-    # Open a new tab
     driver.get("about:newtab")
-
-    # Verify that the search provider has been changed to the selected search engine
-    nav.element_attribute_contains(
-        "awesome-bar", "placeholder", "Search with DuckDuckGo or enter address"
-    )
+    nav.element_attribute_contains("awesome-bar", "placeholder", EXPECTED_PLACEHOLDER)

tests/address_bar_and_search/test_default_search_provider_change_legacy_search_bar.py

@@ -5,6 +5,11 @@
 from modules.browser_object import Navigation, PanelUi, TabBar
 from modules.page_object import AboutPrefs, CustomizeFirefox
 
+SEARCH_TERM = "what is life?"
+SEARCH_ENGINE = "DuckDuckGo"
+EXPECTED_ENGINE_DISPLAY = "DuckDuckGo Search"
+SEARCH_SETTINGS_URL = "about:preferences#search"
+
 
 @pytest.fixture()
 def test_case():
@@ -13,51 +18,35 @@ def test_case():
 
 def test_default_search_provider_change_legacy_search_bar(driver: Firefox):
     """
-    C1365245 - This test makes sure that the default search
-    provider can be changed and settings are applied
+    C1365245 - Verify that changing the default search provider is reflected in the legacy search bar.
     """
-
-    search_term = "what is life?"
-
-    # Create objects
     panel_ui = PanelUi(driver)
-    customize_firefox = CustomizeFirefox(driver)
+    customize = CustomizeFirefox(driver)
     nav = Navigation(driver)
     tabs = TabBar(driver)
-    about_prefs = AboutPrefs(driver, category="search")
+    prefs = AboutPrefs(driver, category="search")
 
-    # Open the customize page and add the search bar to the toolbar
     panel_ui.open_panel_menu()
     panel_ui.navigate_to_customize_toolbar()
-    customize_firefox.add_widget_to_toolbar("search-bar")
+    customize.add_widget_to_toolbar("search-bar")
 
-    # Type the search term, click 'Change search settings'
     tabs.new_tab_by_button()
-    nav.type_in_search_bar(search_term)
+    nav.type_in_search_bar(SEARCH_TERM)
     nav.click_on_change_search_settings_button()
-
-    # Check the current URL is the search settings page
     driver.switch_to.window(driver.window_handles[2])
-    assert driver.current_url == "about:preferences#search"
+    assert driver.current_url == SEARCH_SETTINGS_URL
 
-    # Open a site, open search settings again and check if it's opened in a different tab
     driver.get("https://9gag.com/")
-    nav.type_in_search_bar(search_term)
+    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 == "about:preferences#search"
+    assert driver.current_url == SEARCH_SETTINGS_URL
 
-    # Set a different provider as a default search engine
-    about_prefs.open()
-    about_prefs.search_engine_dropdown().select_option("DuckDuckGo")
+    prefs.open()
+    prefs.search_engine_dropdown().select_option(SEARCH_ENGINE)
+    nav.type_in_search_bar(SEARCH_TERM)
 
-    # Open the search bar, type the search term and check if the search engine is the one set
-    nav.type_in_search_bar(search_term)
     with driver.context(driver.CONTEXT_CHROME):
-        search_engine_name_element = driver.find_element(
-            By.CSS_SELECTOR, ".searchbar-engine-name"
-        )
-
-        assert search_engine_name_element.get_attribute("value") == "DuckDuckGo Search"
+        engine_name = driver.find_element(By.CSS_SELECTOR, ".searchbar-engine-name")
+        assert engine_name.get_attribute("value") == EXPECTED_ENGINE_DISPLAY

tests/address_bar_and_search/test_refresh_firefox_dialog.py

@@ -3,6 +3,10 @@
 
 from modules.browser_object import Navigation
 
+SEARCH_QUERY = "refresh firefox"
+REFRESH_BUTTON_ID = "refresh-button-awesome-bar"
+DIALOG_ID = "refresh-firefox-dialog"
+
 
 @pytest.fixture()
 def test_case():
@@ -11,15 +15,11 @@ def test_case():
 
 def test_refresh_firefox_dialog(driver: Firefox):
     """
-    C2914620: Refresh Firefox dialog
+    C2914620 - Verify that the 'Refresh Firefox' dialog appears from the address bar.
     """
-    # instantiate objects and type in search bar
     nav = Navigation(driver)
     nav.set_awesome_bar()
-    nav.type_in_awesome_bar("refresh firefox")
-
-    # Click on the "Refresh Firefox" button
-    nav.click_on("refresh-button-awesome-bar")
+    nav.type_in_awesome_bar(SEARCH_QUERY)
 
-    # Refresh Firefox dialog is correctly displayed
-    nav.element_visible("refresh-firefox-dialog")
+    nav.click_on(REFRESH_BUTTON_ID)
+    nav.element_visible(DIALOG_ID)