added sponsored item checking

Author: sarinali

modules/data/navigation.components.json

@@ -0,0 +1,188 @@
+{
+    "context": "chrome",
+    "awesome-bar": {
+        "selectorData": "urlbar-input",
+        "strategy": "id",
+        "groups": [
+            "requiredForPage",
+            "awesomeBar"
+        ]
+    },
+
+    "results-dropdown": {
+        "selectorData": "urlbar-results",
+        "strategy": "id",
+        "groups": [
+            "doNotCache"
+        ]
+    },
+
+    "tab-to-search-text-span": {
+        "selectorData": "urlbarView-dynamic-onboardTabToSearch-text-container",
+        "strategy": "class",
+        "groups": []
+    },
+
+    "search-mode-span": {
+        "selectorData": "urlbar-search-mode-indicator-title",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "overflow-item": {
+        "selectorData": "[class=\"urlbarView-title urlbarView-overflowable\"]",
+        "strategy": "css",
+        "groups": []
+    },
+
+    "search-one-off-settings-button": {
+        "selectorData": "urlbar-anon-search-settings",
+        "strategy": "id",
+        "groups": [
+            "searchOneOffs"
+        ]
+    },
+
+    "quick-actions-refresh-button": {
+        "selectorData": "urlbarView-row-3-label-0",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "refresh-intervention-card": {
+        "selectorData": "div[tip-type=\"intervention_refresh\"]",
+        "strategy": "css",
+        "groups": [
+            "doNotCache"
+        ]
+    },
+
+    "fx-refresh-text": {
+        "selectorData": "span[data-l10n-id=\"intervention-refresh-profile\"]",
+        "strategy": "css",
+        "groups": []
+    },
+
+    "fx-refresh-button": {
+        "selectorData": "span[role=\"button\"][data-l10n-id=\"intervention-refresh-profile-confirm\"]",
+        "strategy": "css",
+        "groups": []
+    },
+
+    "fx-refresh-menu": {
+        "selectorData": "span[data-l10n-id=\"urlbar-result-menu-button\"][title=\"Open menu\"]",
+        "strategy": "css",
+        "groups": []
+    },
+
+    "fx-refresh-menu-get-help-item": {
+        "selectorData": "menuitem[data-l10n-id=\"urlbar-result-menu-tip-get-help\"]",
+        "strategy": "css",
+        "groups": []
+    },
+
+    "fx-refresh-menu-get-help-item-get-help": {
+        "selectorData": "urlbarView-result-menuitem",
+        "strategy": "class",
+        "groups": []
+    },
+
+    "search-engine-suggestion-row": {
+        "selectorData": "div[class=\"urlbarView-row\"][type=\"search_engine\"]",
+        "strategy": "css",
+        "groups": []
+    },
+
+    "search-one-off-browser-button": {
+        "selectorData": "urlbar-engine-one-off-item-{source}",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "panel-ui-button": {
+        "selectorData": "PanelUI-button",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "navigation-background-component": {
+        "selectorData": "nav-bar",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "context-menu-paste-and-go": {
+        "selectorData": "paste-and-go",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "private-browsing-icon": {
+        "selectorData": "private-browsing-indicator-icon",
+        "strategy": "class",
+        "groups": []
+    },
+
+
+    "add-extra-search-engine": {
+        "selectorData": "[id*=urlbar-engine-one-off-item-engine--1][tooltiptext*='{0}']",
+        "strategy": "css",
+        "groups": []
+    },
+
+    "search-one-off-engine-button": {
+        "selectorData": "[id*=urlbar-engine-one-off-item-engine][tooltiptext^='{0}']",
+        "strategy": "css",
+        "groups": []
+    },
+
+    "downloads-button": {
+        "selectorData": "downloads-button",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "search-results-container": {
+        "selectorData": "urlbar-results",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "addon-suggestion": {
+        "selectorData": "div.urlbarView-row[type='rust_amo'] span.urlbarView-title.urlbarView-overflowable",
+        "strategy": "css",
+        "groups": []
+    },
+
+    "search-suggestion-list": {
+        "selectorData": "div.urlbarView-row[type='search_engine'] span.urlbarView-title",
+        "strategy": "css",
+        "groups": [
+            "doNotCache"
+        ]
+    },
+
+    "sponsored-site-card": {
+        "selectorData": "top-site-outer",
+        "strategy": "class",
+        "groups": []
+    },
+
+    "sponsored-site-card-menu-button": {
+        "selectorData": "button[class=\"context-menu-button icon\"]",
+        "strategy": "css",
+        "groups": []
+    },
+
+    "sponsored-site-context-menu": {
+        "selectorData": "context-menu",
+        "strategy": "class",
+        "groups": []
+    },
+
+    "sponsored-site-context-menu-list": {
+        "selectorData": "ul[class=\"context-menu-list\"]",
+        "strategy": "css",
+        "groups": []
+    }
+}

tests/address_bar_and_search/conftest.py

@@ -24,6 +24,7 @@ def set_prefs(add_prefs: dict):
         ("browser.newtabpage.activity-stream.system.showSponsored", True),
         ("browser.newtabpage.activity-stream.showSponsoredTopSites", True),
         ("browser.topsites.useRemoteSetting", True),
+        ("browser.topsites.contile.enabled", True)
     ]
     prefs.extend(add_prefs)
     return prefs

tests/address_bar_and_search/test_tile_menu_options.py

@@ -28,6 +28,12 @@
     ["Pin", "Edit", "Open in a New Window", "Open in a New Private Window", "Dismiss"]
 )
 
+REQUIRED_CONTEXT_MENU_ACTIONS_SPONSORED_TILE = set(
+    ["Open in a New Window", "Open in a New Private Window", "Dismiss", "Our sponsors & your privacy"]
+)
+
+# first value in a tuple is the index of the card, second is the status of sponsorship
+card_indices = [(3, False), (0, True)]
 
 @pytest.fixture()
 def add_prefs():
@@ -74,8 +80,8 @@ def test_default_tile_hover_states(driver: Firefox):
         in ALLOWED_RGB_AFTER_VALUES_THREE_DOTS
     )
 
-
-def test_tile_context_menu_options(driver: Firefox):
+@pytest.mark.parametrize("index, sponsored", card_indices)
+def test_tile_context_menu_options(driver: Firefox, index: int, sponsored: bool):
     """
     C1533798.2: Ensure that a website has the appropriate context menu actions in the tile.
     """
@@ -90,8 +96,8 @@ def test_tile_context_menu_options(driver: Firefox):
     driver.switch_to.window(driver.window_handles[-1])
     suggested_cards = nav.get_element("sponsored-site-card", multiple=True)
 
-    # pick the second card since its not pinned
-    card = suggested_cards[1]
+    # pick the fourth card since it is not a sponsored tile
+    card = suggested_cards[index]
     nav.hover_over_element(card)
 
     # press the three dots option
@@ -111,16 +117,24 @@ def test_tile_context_menu_options(driver: Firefox):
         for option in child_options
         if option.get_attribute("innerHTML") != ""
     ]
+
     matched_regex = util.match_regex(
         r"<button[^>]*><span[^>]*>([^<]*)</span></button>", option_html_logs
     )
 
+    # according to the status of sponsored, look at different context menu actions
+    set_in_use = set()
+    if sponsored:
+        set_in_use = REQUIRED_CONTEXT_MENU_ACTIONS_SPONSORED_TILE
+    else:
+        set_in_use = REQUIRED_CONTEXT_MENU_ACTIONS_REGULAR_TILE
+
     # ensure we match each option
     for match in matched_regex:
-        if match in REQUIRED_CONTEXT_MENU_ACTIONS_REGULAR_TILE:
-            REQUIRED_CONTEXT_MENU_ACTIONS_REGULAR_TILE.remove(match)
+        if match in set_in_use:
+            set_in_use.remove(match)
             logging.info(f"Detected the context item: {match}")
 
     assert (
-        len(REQUIRED_CONTEXT_MENU_ACTIONS_REGULAR_TILE) == 0
+        len(set_in_use) == 0
     ), "Did not find all of the required context menu actions."