Merge pull request #568 from mozilla/tracy/fix_search_suggests_test

Tracy-Walker · web-flow · commit 92f268df07ee · 2025-05-06T12:33:12.000-05:00
Tracy/fix search suggests test
diff --git a/SELECTOR_INFO.md b/SELECTOR_INFO.md
@@ -2616,7 +2616,7 @@ Path to .json: modules/data/navigation.components.json
 ```
 ```
 Selector name: sponsored-suggestion
-Selector Data: urlbarView-row-body-description
+Selector Data: urlbarView-group-aria-label
 Description: Sponsored search results
 Location: URL bar search results
 Path to .json: modules/data/navigation.components.json
@@ -2629,6 +2629,13 @@ Location: URL bar search results
 Path to .json: modules/data/navigation.components.json
 ```
 ```
+Selector name: suggestion-titles
+Selector Data: urlbarView-title
+Description: Firefox suggestion search results item titles
+Location: URL bar suggestion results
+Path to .json: modules/data/navigation.components.json
+```
+```
 Selector name: search-result-autofill-adaptive-element
 Selector Data: .//*[@type='autofill_adaptive']
 Description: Search result autofill adaptive element
diff --git a/modules/data/navigation.components.json b/modules/data/navigation.components.json
@@ -165,7 +165,7 @@
 
     "sponsored-suggestion": {
         "doNotCache": true,
-        "selectorData": "urlbarView-row-body-description",
+        "selectorData": "urlbarView-group-aria-label",
         "strategy": "class",
         "groups": []
     },
@@ -177,6 +177,13 @@
         "groups": []
     },
 
+    "suggestion-titles": {
+        "doNotCache": true,
+        "selectorData": "urlbarView-title",
+        "strategy": "class",
+        "groups": []
+},
+
     "search-result-autofill-adaptive-element": {
         "selectorData": ".//*[@type='autofill_adaptive']",
         "strategy": "xpath",
diff --git a/tests/address_bar_and_search/test_add_engine_address_bar.py b/tests/address_bar_and_search/test_add_engine_address_bar.py
@@ -6,6 +6,7 @@
 TEST_URL = "https://youtube.com"
 EXPECTED_ENGINE = "YouTube"
 
+
 @pytest.fixture()
 def test_case():
     return "1365478"
diff --git a/tests/address_bar_and_search/test_addon_suggestion.py b/tests/address_bar_and_search/test_addon_suggestion.py
@@ -42,7 +42,9 @@ def test_addon_suggestion_based_on_search_input(driver: Firefox):
         nav.type_in_awesome_bar(input_text)
 
         if not nav.element_visible("addon-suggestion"):
-            raise AssertionError(f"Addon suggestion not visible for input: '{input_text}'")
+            raise AssertionError(
+                f"Addon suggestion not visible for input: '{input_text}'"
+            )
 
         nav.select_element_in_nav("addon-suggestion")
         expected_url = f"{ADDONS_BASE_URL}{addon_slug}/"
diff --git a/tests/address_bar_and_search/test_default_search_provider_change_awesome_bar.py b/tests/address_bar_and_search/test_default_search_provider_change_awesome_bar.py
@@ -28,4 +28,6 @@ def test_default_search_provider_change_awesome_bar(driver: Firefox):
     prefs.search_engine_dropdown().select_option(SEARCH_ENGINE)
 
     driver.get("about:newtab")
-    nav.expect_element_attribute_contains("awesome-bar", "placeholder", EXPECTED_PLACEHOLDER)
+    nav.expect_element_attribute_contains(
+        "awesome-bar", "placeholder", EXPECTED_PLACEHOLDER
+    )
diff --git a/tests/address_bar_and_search/test_glean_basic.py b/tests/address_bar_and_search/test_glean_basic.py
@@ -11,7 +11,7 @@
 from werkzeug.wrappers import Request, Response
 
 from modules.browser_object import Navigation
-from modules.page_object import AboutGlean, AboutPrefs, GenericPage, AboutConfig
+from modules.page_object import AboutConfig, AboutGlean, AboutPrefs, GenericPage
 from modules.util import Utilities
 
 # Constants
@@ -34,7 +34,9 @@ def test_case():
     return "2234689"
 
 
-def _verify_glean_ping(ping_actual: str, ping_expected: str, engine_actual: str, engine_expected: str):
+def _verify_glean_ping(
+    ping_actual: str, ping_expected: str, engine_actual: str, engine_expected: str
+):
     assert ping_actual == ping_expected
     assert engine_actual.lower() == engine_expected.lower()
 
@@ -50,7 +52,9 @@ def glean_handler(request: Request) -> Response:
             engine_name = body
             for key in PING_METRIC_PATH:
                 engine_name = engine_name[key]
-            expected_engine = ENGINE_NAME_INITIAL if pings_with_id == 0 else ENGINE_NAME_UPDATED
+            expected_engine = (
+                ENGINE_NAME_INITIAL if pings_with_id == 0 else ENGINE_NAME_UPDATED
+            )
             _verify_glean_ping(
                 ping_actual=incoming_ping_id,
                 ping_expected=ping_id_global,
diff --git a/tests/address_bar_and_search/test_google_search_counts_us.py b/tests/address_bar_and_search/test_google_search_counts_us.py
@@ -9,7 +9,6 @@
 from modules.page_object import AboutTelemetry
 from modules.util import Utilities
 
-
 # Constants
 SEARCH_TERM = "festival"
 SEARCH_PROVIDER_PATH = '$..SEARCH_COUNTS.["google-b-1-d.urlbar"].sum'
@@ -48,10 +47,10 @@ def test_google_search_counts_us(driver: Firefox):
     # === Decode telemetry and validate search provider data ===
     json_data = utils.decode_url(driver)
 
-    assert utils.assert_json_value(
-        json_data, SEARCH_PROVIDER_PATH, 1
-    ), f"Expected 1 Google search in path: {SEARCH_PROVIDER_PATH}"
+    assert utils.assert_json_value(json_data, SEARCH_PROVIDER_PATH, 1), (
+        f"Expected 1 Google search in path: {SEARCH_PROVIDER_PATH}"
+    )
 
-    assert utils.assert_json_value(
-        json_data, SEARCH_TAG_PATH, 1
-    ), f"Expected 1 tagged Google search in path: {SEARCH_TAG_PATH}"
+    assert utils.assert_json_value(json_data, SEARCH_TAG_PATH, 1), (
+        f"Expected 1 tagged Google search in path: {SEARCH_TAG_PATH}"
+    )
diff --git a/tests/address_bar_and_search/test_sap_google_adclick.py b/tests/address_bar_and_search/test_sap_google_adclick.py
@@ -1,5 +1,6 @@
-import pytest
 from time import sleep
+
+import pytest
 from selenium.webdriver import Firefox
 
 from modules.browser_object_navigation import Navigation
diff --git a/tests/address_bar_and_search/test_search_engine_selector.py b/tests/address_bar_and_search/test_search_engine_selector.py
@@ -5,7 +5,14 @@
 from modules.browser_object import Navigation
 
 SEARCH_TERM = "soccer"
-SEARCH_ENGINES = ["Google", "Amazon.com", "Bing", "DuckDuckGo", "eBay", "Wikipedia (en)"]
+SEARCH_ENGINES = [
+    "Google",
+    "Amazon.com",
+    "Bing",
+    "DuckDuckGo",
+    "eBay",
+    "Wikipedia (en)",
+]
 
 
 @pytest.fixture()
@@ -27,6 +34,5 @@ def test_search_engine_selector_and_validator(driver: Firefox, search_engine: st
     nav.search(SEARCH_TERM)
     nav.expect_in_content(lambda d: expected_url_fragment in d.current_url)
 
-
     assert expected_url_fragment in driver.current_url
     nav.clear_awesome_bar()
diff --git a/tests/address_bar_and_search/test_search_modes_for_sites.py b/tests/address_bar_and_search/test_search_modes_for_sites.py
@@ -18,7 +18,9 @@ def test_case():
 
 
 @pytest.mark.parametrize("search_engine, prefix, url", SEARCH_MODES)
-def test_search_modes_for_sites(driver: Firefox, search_engine: str, prefix: str, url: str):
+def test_search_modes_for_sites(
+    driver: Firefox, search_engine: str, prefix: str, url: str
+):
     """
     C2234690 - Verify that typing the first two letters of a search engine activates its mode in the address bar.
     """
diff --git a/tests/address_bar_and_search/test_search_suggestions.py b/tests/address_bar_and_search/test_search_suggestions.py
@@ -1,5 +1,6 @@
-import pytest
 from time import sleep
+
+import pytest
 from selenium.webdriver import Firefox
 
 from modules.browser_object_navigation import Navigation
@@ -9,19 +10,18 @@
 # Constants
 SEARCH_TERM_SPONSORED = "iphone"
 SEARCH_TERM_NON_SPONSORED = "wiki"
-RETRY_LIMIT = 20
-SLEEP_BETWEEN_RETRIES = 3
+RETRY_LIMIT = 5
+SECONDS = 3
 
 
 @pytest.fixture()
 def test_case():
     return "1618400"
 
 
-@pytest.mark.unstable(reason="Sponsorship status sometimes does not appear")
-def test_preferences_all_toggles_enabled(driver: Firefox):
+def test_search_suggests_enabled(driver: Firefox):
     """
-    C1618400: Preferences - All toggles buttons Enabled
+    C1618400: Firefox Suggest displays sponsored and non-sponsored suggestions when enabled in Preferences
     """
     nav = Navigation(driver)
     prefs = AboutPrefs(driver, category="search")
@@ -45,27 +45,34 @@ def test_preferences_all_toggles_enabled(driver: Firefox):
     )
 
     # Check for sponsored suggestion
+    # Trigger the suggests once. First time, it's not populated correctly in automation
+    with driver.context(driver.CONTEXT_CHROME):
+        actions.search(SEARCH_TERM_SPONSORED, with_enter=False)
+        sleep(SECONDS)
+
+    # Then load up suggests again and check for sponsored suggestion
     found_sponsored = False
-    for _ in range(RETRY_LIMIT):
+    retries = 0
+    while not found_sponsored and retries < RETRY_LIMIT:
         actions.search(SEARCH_TERM_SPONSORED, with_enter=False)
+        sleep(SECONDS)  # Give Firefox time to populate suggests list
         with driver.context(driver.CONTEXT_CHROME):
-            sponsored_elements = nav.get_elements("sponsored-suggestion")
             found_sponsored = any(
-                el.get_attribute("innerText") == "Sponsored"
-                for el in sponsored_elements
+                item.get_attribute("aria-label") == "Sponsored"
+                for item in nav.get_elements("sponsored-suggestion")
             )
-        if found_sponsored:
-            break
-        sleep(SLEEP_BETWEEN_RETRIES)
-
-    assert found_sponsored, f"No sponsored suggestion found after {RETRY_LIMIT} retries."
+        retries += 1
+    assert found_sponsored, (
+        f"No sponsored suggestion found after {RETRY_LIMIT} retries."
+    )
 
     # Check for non-sponsored suggestion
     actions.search(SEARCH_TERM_NON_SPONSORED, with_enter=False)
+    sleep(SECONDS)  # Give Firefox time to populate suggests list
     with driver.context(driver.CONTEXT_CHROME):
         nav.get_element("firefox-suggest")
-        nav.get_element("sponsored-suggestion")
-        assert not any(
-            el.get_attribute("innerText") == "Sponsored"
-            for el in nav.get_elements("sponsored-suggestion")
-        ), "Sponsored suggestion found when not expected."
+        titles = nav.get_elements("suggestion-titles")
+        found_non_sponsored = any(
+            "Wikipedia - wiki.phtml" in title.text for title in titles
+        )
+    assert found_non_sponsored, f"Non-sponsored suggestion not found"
diff --git a/tests/address_bar_and_search/test_tile_menu_options.py b/tests/address_bar_and_search/test_tile_menu_options.py
@@ -46,6 +46,7 @@ def test_case():
 # first value in a tuple is the index of the card, second is the status of sponsorship
 card_indices = [(4, False), (0, True)]
 
+
 @pytest.mark.unstable(reason="Sponsorship status sometimes does not appear")
 def test_default_tile_hover_states(driver: Firefox):
     """
diff --git a/tests/bookmarks_and_history/test_opened_website_in_new_tab_present_in_toolbar_history.py b/tests/bookmarks_and_history/test_opened_website_in_new_tab_present_in_toolbar_history.py
@@ -42,4 +42,6 @@ def test_the_website_opened_in_new_tab_is_present_in_history_menu(driver: Firefo
     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
-    panel_ui.expect_element_attribute_contains("recent-history-content", "value", "YouTube")
+    panel_ui.expect_element_attribute_contains(
+        "recent-history-content", "value", "YouTube"
+    )
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
@@ -36,4 +36,6 @@ def test_the_website_opened_in_new_window_is_present_in_history_menu(driver: Fir
     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
-    panel_ui.expect_element_attribute_contains("recent-history-content", "value", "YouTube")
+    panel_ui.expect_element_attribute_contains(
+        "recent-history-content", "value", "YouTube"
+    )
diff --git a/tests/networking/test_http_site.py b/tests/networking/test_http_site.py
@@ -43,7 +43,9 @@ def test_http_site(driver: Firefox):
     prefs.select_https_only_setting(prefs.HTTPS_ONLY_STATUS.HTTPS_ONLY_DISABLED)
     panel_ui.open_and_switch_to_new_window("tab")
     driver.get(HTTP_SITE)
-    nav.expect_element_attribute_contains("lock-icon", "tooltiptext", CONNECTION_NOT_SECURE)
+    nav.expect_element_attribute_contains(
+        "lock-icon", "tooltiptext", CONNECTION_NOT_SECURE
+    )
 
     # Blocking
     driver.switch_to.window(driver.window_handles[0])
@@ -60,7 +62,9 @@ def test_http_site(driver: Firefox):
     prefs.select_https_only_setting(prefs.HTTPS_ONLY_STATUS.HTTPS_ONLY_PRIVATE)
     driver.switch_to.window(driver.window_handles[1])
     driver.refresh()
-    nav.expect_element_attribute_contains("lock-icon", "tooltiptext", CONNECTION_NOT_SECURE)
+    nav.expect_element_attribute_contains(
+        "lock-icon", "tooltiptext", CONNECTION_NOT_SECURE
+    )
 
     # Private browsing - blocked
     panel_ui.open_and_switch_to_new_window("private")
diff --git a/tests/notifications/test_audio_video_permissions_notification.py b/tests/notifications/test_audio_video_permissions_notification.py
@@ -53,7 +53,9 @@ def test_camera_and_microphone_permissions_notification(
     # Verify that the notification is displayed
     nav.element_visible("popup-notification")
     nav.expect_element_attribute_contains("popup-notification", "label", "Allow ")
-    nav.expect_element_attribute_contains("popup-notification", "name", "mozilla.github.io")
+    nav.expect_element_attribute_contains(
+        "popup-notification", "name", "mozilla.github.io"
+    )
     nav.expect_element_attribute_contains(
         "popup-notification", "endlabel", " to use your camera and microphone?"
     )
diff --git a/tests/notifications/test_camera_permissions_notification.py b/tests/notifications/test_camera_permissions_notification.py
@@ -50,7 +50,9 @@ def test_camera_permissions_notification(driver: Firefox, temp_selectors):
 
     # Verify that the notification is displayed
     nav.expect_element_attribute_contains("popup-notification", "label", "Allow ")
-    nav.expect_element_attribute_contains("popup-notification", "name", "mozilla.github.io")
+    nav.expect_element_attribute_contains(
+        "popup-notification", "name", "mozilla.github.io"
+    )
     nav.expect_element_attribute_contains(
         "popup-notification", "endlabel", " to use your camera?"
     )
diff --git a/tests/notifications/test_microphone_permissions_notification.py b/tests/notifications/test_microphone_permissions_notification.py
@@ -51,7 +51,9 @@ def test_microphone_permissions_notification(driver: Firefox, temp_selectors):
     # Verify that the notification is displayed
     nav.element_visible("popup-notification")
     nav.expect_element_attribute_contains("popup-notification", "label", "Allow ")
-    nav.expect_element_attribute_contains("popup-notification", "name", "mozilla.github.io")
+    nav.expect_element_attribute_contains(
+        "popup-notification", "name", "mozilla.github.io"
+    )
     nav.expect_element_attribute_contains(
         "popup-notification", "endlabel", " to use your microphone?"
     )
diff --git a/tests/notifications/test_webextension_completed_installation_successfully_displayed.py b/tests/notifications/test_webextension_completed_installation_successfully_displayed.py
@@ -43,7 +43,9 @@ def test_webextension_completed_installation_successfully_displayed(
     nav.click_on("popup-notification-add")
 
     # The WebExtension completed installation panel is successfully displayed
-    nav.expect_element_attribute_contains("popup-notification-primary-button", "label", "OK")
+    nav.expect_element_attribute_contains(
+        "popup-notification-primary-button", "label", "OK"
+    )
     nav.expect_element_attribute_contains(
         "popup-notification-panel", "name", "Popup Blocker (strict)"
     )
diff --git a/tests/password_manager/test_add_primary_password.py b/tests/password_manager/test_add_primary_password.py
@@ -33,7 +33,9 @@ def test_add_primary_password(driver: Firefox):
     ba.switch_to_iframe_context(primary_pw_popup)
 
     # Current password field is empty and cannot be changed
-    about_prefs.expect_element_attribute_contains("current-password", "disabled", "true")
+    about_prefs.expect_element_attribute_contains(
+        "current-password", "disabled", "true"
+    )
 
     # Primary password can be changed
     about_prefs.get_element("enter-new-password").send_keys(PRIMARY_PASSWORD)
diff --git a/tests/password_manager/test_can_view_password_when_PP_enabled.py b/tests/password_manager/test_can_view_password_when_PP_enabled.py
@@ -41,7 +41,9 @@ def test_password_can_be_shown(driver: Firefox):
     ba.switch_to_iframe_context(primary_pw_popup)
 
     # Current password field is empty and cannot be changed
-    about_prefs.expect_element_attribute_contains("current-password", "disabled", "true")
+    about_prefs.expect_element_attribute_contains(
+        "current-password", "disabled", "true"
+    )
 
     # Primary password can be changed
     about_prefs.get_element("enter-new-password").send_keys("securePassword1")
diff --git a/tests/password_manager/test_multiple_saved_logins.py b/tests/password_manager/test_multiple_saved_logins.py
@@ -107,5 +107,9 @@ def use_credential_n(n: int):
     driver.switch_to.window(driver.window_handles[0])
     for i in range(1, 4):
         use_credential_n(i)
-        web_page.expect_element_attribute_contains("username-field", "value", f"username{i}")
-        web_page.expect_element_attribute_contains("password-field", "value", f"password{i}")
+        web_page.expect_element_attribute_contains(
+            "username-field", "value", f"username{i}"
+        )
+        web_page.expect_element_attribute_contains(
+            "password-field", "value", f"password{i}"
+        )
