merge changes in

sarinali · sarinali · commit c7ebe873c88a · 2024-07-02T11:51:14.000-04:00
diff --git a/Pipfile b/Pipfile
@@ -13,6 +13,7 @@ requests = "*"
 pytest-xdist = "*"
 pytest-html = "*"
 pypom = "*"
+jsonpath-ng = "*"
 pillow = "*"
 
 [dev-packages]
diff --git a/ci_pyproject.toml b/ci_pyproject.toml
@@ -7,6 +7,7 @@ markers = [
     "pynput: test uses pynput package",
     "incident: incident smoke tests",
     "unstable: temporary mark for unstable tests",
+    "slow: test is clocked at more than 30s on modern machines",
     "ci: basic tests to run in ci",
     "locale_de: tests run in DE locale versions",
     "locale_fr: tests run in FR locale versions",
diff --git a/conftest.py b/conftest.py
@@ -214,3 +214,8 @@ def version(driver: webdriver.Firefox):
 @pytest.fixture(scope="session", autouse=True)
 def faker_seed():
     return 19980331
+
+
+@pytest.fixture(scope="session")
+def fillable_pdf_url():
+    return "https://www.uscis.gov/sites/default/files/document/forms/i-9.pdf"
diff --git a/dev_pyproject.toml b/dev_pyproject.toml
@@ -8,6 +8,7 @@ markers = [
     "pynput: test uses pynput package",
     "incident: incident smoke tests",
     "unstable: temporary mark for unstable tests",
+    "slow: test is clocked at more than 30s on modern machines",
     "ci: basic tests to run in ci",
     "locale_de: tests run in DE locale versions",
     "locale_fr: tests run in FR locale versions",
diff --git a/modules/browser_object_find_toolbar.py b/modules/browser_object_find_toolbar.py
@@ -20,6 +20,17 @@ def open(self) -> BasePage:
             self.wait_for_page_to_load()
         return self
 
+    def open_with_key_combo(self) -> BasePage:
+        """Use Cmd/Ctrl + F to open the Find Toolbar, wait for load"""
+        with self.driver.context(self.driver.CONTEXT_CHROME):
+            if self.sys_platform() == "Darwin":
+                mod_key = Keys.COMMAND
+            else:
+                mod_key = Keys.CONTROL
+            self.perform_key_combo(mod_key, "f")
+            self.wait_for_page_to_load()
+        return self
+
     def find(self, term: str) -> BasePage:
         """Use the Find Toolbar to search"""
         with self.driver.context(self.driver.CONTEXT_CHROME):
@@ -46,8 +57,33 @@ def next_match(self) -> BasePage:
         """Click the Next Match button"""
         with self.driver.context(self.driver.CONTEXT_CHROME):
             self.get_element("next-match-button").click()
+        return self
 
     def previous_match(self) -> BasePage:
         """Click the Previous Match button"""
         with self.driver.context(self.driver.CONTEXT_CHROME):
             self.get_element("previous-match-button").click()
+        return self
+
+    def rewind_to_first_match(self) -> BasePage:
+        """Go back to match 1 of n"""
+        with self.driver.context(self.driver.CONTEXT_CHROME):
+            position = self.get_match_args()["current"]
+            total = self.get_match_args()["total"]
+            while position != 1:
+                if position < total // 2:
+                    self.previous_match()
+                else:
+                    self.next_match()
+                position = self.get_match_args()["current"]
+        return self
+
+    def navigate_matches_by_keys(self, backwards=False) -> BasePage:
+        """Use F3 and Shift+F3 to navigate matches"""
+        with self.driver.context(self.driver.CONTEXT_CHROME):
+            if backwards:
+                self.perform_key_combo(Keys.SHIFT, Keys.F3)
+            else:
+                logging.info(f"sending {Keys.F3.encode()}")
+                self.actions.send_keys(Keys.F3).perform()
+            return self
diff --git a/modules/data/about_telemetry.components.json b/modules/data/about_telemetry.components.json
@@ -0,0 +1,13 @@
+{
+  "category-raw": {
+    "selectorData": "category-raw",
+    "strategy": "id",
+    "groups": []
+  },
+
+  "rawdata-tab": {
+    "selectorData": "//li[@class='tabs-menu-item rawdata ']//a[@id='rawdata-tab']",
+    "strategy": "xpath",
+    "groups": []
+  }
+}
diff --git a/modules/data/generic_pdf.components.json b/modules/data/generic_pdf.components.json
@@ -0,0 +1,17 @@
+{
+    "text-layer": {
+        "selectorData": "textLayer",
+        "strategy": "class",
+        "groups": [
+            "requiredForPage"
+        ]
+    },
+
+    "highlighted-text": {
+        "selectorData": ".textLayer .highlight.selected.appended",
+        "strategy": "css",
+        "groups": [
+            "doNotCache"
+        ]
+    }
+}
diff --git a/modules/data/navigation.components.json b/modules/data/navigation.components.json
@@ -9,6 +9,14 @@
         ]
     },
 
+    "results-dropdown": {
+        "selectorData": "urlbar-results",
+        "strategy": "id",
+        "groups": [
+            "doNotCache"
+        ]
+    },
+
     "tab-to-search-text-span": {
         "selectorData": "urlbarView-dynamic-onboardTabToSearch-text-container",
         "strategy": "class",
@@ -115,7 +123,7 @@
         "groups": []
     },
 
-    
+
     "add-extra-search-engine": {
         "selectorData": "[id*=urlbar-engine-one-off-item-engine--1][tooltiptext*='{0}']",
         "strategy": "css",
@@ -138,6 +146,19 @@
         "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"
+        ]
+    }
 }
diff --git a/modules/page_base.py b/modules/page_base.py
@@ -306,6 +306,14 @@ def get_elements(self, name: str, labels=[]):
         """
         return self.get_element(name, multiple=True, labels=labels)
 
+    def get_parent_of(self, name: str, labels=[]) -> WebElement:
+        """
+        Given a name (and labels if needed), return the direct parent node of the element.
+        """
+
+        child = self.get_element(name, labels=labels)
+        return child.find_element(By.XPATH, "..")
+
     def element_exists(self, name: str, labels=[]) -> Page:
         """Expect helper: wait until element exists or timeout"""
         self.expect(
@@ -345,6 +353,15 @@ def element_selected(self, name: str, labels=[]) -> Page:
         )
         return self
 
+    def element_has_text(self, name: str, text: str, labels=[]) -> Page:
+        """Expect helper: wait until element has given text"""
+        self.expect(
+            EC.text_to_be_present_in_element(
+                self.get_selector(name, labels=labels), text
+            )
+        )
+        return self
+
     def url_contains(self, url_part: str) -> Page:
         """Expect helper: wait until driver URL contains given text or timeout"""
         self.expect(EC.url_contains(url_part))
@@ -482,3 +499,8 @@ def loaded(self):
             pass
         self.set_content_context()
         return _loaded
+
+    def switch_tab(self):
+        """Get list of all window handles, switch to the newly opened tab"""
+        handles = self.driver.window_handles
+        self.driver.switch_to.window(handles[-1])
diff --git a/modules/page_object.py b/modules/page_object.py
@@ -5,9 +5,11 @@
 from modules.page_object_about_newtab import *
 from modules.page_object_about_prefs import *
 from modules.page_object_about_profiles import *
+from modules.page_object_about_telemetry import *
 from modules.page_object_addons_mozilla_org import *
 from modules.page_object_autofill_credit_card import *
 from modules.page_object_autofill_test_basic import *
 from modules.page_object_example_page import *
+from modules.page_object_generic_pdf import *
 from modules.page_object_google_search import *
 from modules.page_object_wiki_firefox_logo import *
diff --git a/modules/page_object_about_telemetry.py b/modules/page_object_about_telemetry.py
@@ -0,0 +1,14 @@
+from modules.page_base import BasePage
+
+
+class AboutTelemetry(BasePage):
+    """
+    The POM for the about:telemetry page
+
+    Attributes
+    ----------
+    driver: selenium.webdriver.Firefox
+        WebDriver object under test
+    """
+
+    URL_TEMPLATE = "about:telemetry"
diff --git a/modules/page_object_generic_pdf.py b/modules/page_object_generic_pdf.py
@@ -0,0 +1,12 @@
+from modules.page_base import BasePage
+
+
+class GenericPdf(BasePage):
+    """
+    Generic POM for any page with an open PDF in it.
+    """
+
+    URL_TEMPLATE = "{pdf_url}"
+
+    def get_green_highlighted_text(self) -> str:
+        return self.get_element("highlighted-text").get_attribute("innerText")
diff --git a/modules/util.py b/modules/util.py
@@ -1,3 +1,5 @@
+import base64
+import json
 import logging
 import os
 import platform
@@ -8,6 +10,7 @@
 
 from faker import Faker
 from faker.providers import internet, misc
+from jsonpath_ng import parse
 from PIL import Image
 from pynput.keyboard import Controller, Key
 from selenium.common.exceptions import (
@@ -301,6 +304,22 @@ def normalize_phone_number(self, phone: str, default_country_code="1") -> str:
         # return with the country code and the normalized phone number
         return default_country_code + ret_val
 
+    def decode_url(self, driver: Firefox):
+        """Decode to base64"""
+        base64_data = driver.current_url.split(",")[1]
+        decoded_data = base64.b64decode(base64_data).decode("utf-8")
+        json_data = json.loads(decoded_data)
+        return json_data
+
+    def assert_json_value(self, json_data, jsonpath_expr, expected_value):
+        """Parse json and validate json search string with its value"""
+        expr = parse(jsonpath_expr)
+        match = expr.find(json_data)
+        return (
+            match[0].value == expected_value,
+            f"Expected {expected_value}, but got {match[0].value}",
+        )
+
 
 class BrowserActions:
     """
diff --git a/pyproject.toml b/pyproject.toml
@@ -8,6 +8,7 @@ markers = [
     "pynput: test uses pynput package",
     "incident: incident smoke tests",
     "unstable: temporary mark for unstable tests",
+    "slow: test is clocked at more than 30s on modern machines",
     "ci: basic tests to run in ci",
     "locale_de: tests run in DE locale versions",
     "locale_fr: tests run in FR locale versions",
diff --git a/tests/address_bar_and_search/test_addon_suggestion.py b/tests/address_bar_and_search/test_addon_suggestion.py
@@ -0,0 +1,54 @@
+import time
+
+import pytest
+from selenium.webdriver import Firefox
+from selenium.webdriver.support import expected_conditions as EC
+
+from modules.browser_object import Navigation
+
+
+@pytest.fixture()
+def add_prefs():
+    return [
+        ("browser.search.region", "US"),
+    ]
+
+
+@pytest.mark.slow
+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.
+    """
+
+    # Map input text to addon names
+    input_to_addon_name = {
+        "clips": "video-downloadhelper",
+        "grammar": "languagetool",
+        "Temp mail": "private-relay",
+        "pics search": "search_by_image",
+        "darker theme": "darkreader",
+        "privacy": "privacy-badger17",
+        "read aloud": "read-aloud",
+    }
+
+    nav = Navigation(driver).open()
+    time.sleep(20)
+    nav.set_awesome_bar()
+    time.sleep(20)
+    nav.awesome_bar.click()
+
+    for input_text, addon_name in input_to_addon_name.items():
+        nav.awesome_bar.send_keys(input_text)
+        nav.element_visible("addon-suggestion")
+        nav.get_element("addon-suggestion").click()
+
+        # Construct the expected URL
+        expected_url = f"https://addons.mozilla.org/en-US/firefox/addon/{addon_name}/"
+        nav.expect_in_content(EC.url_contains(expected_url))
+
+        nav.awesome_bar.clear()
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
@@ -0,0 +1,38 @@
+import time
+
+import pytest
+from selenium.webdriver import Firefox
+
+from modules.browser_object import Navigation
+from modules.page_object import AboutTelemetry
+from modules.util import Utilities
+
+
+# unstable: for some reason cannot pass in Taskcluster Linux VM
+@pytest.mark.unstable
+def test_google_search_counts_us(driver: Firefox):
+    """
+    C1365026, Test Google Search counts - urlbar US
+    """
+    # instantiate objects
+    nav = Navigation(driver).open()
+    nav.search("festival")
+    time.sleep(5)
+    about_telemetry = AboutTelemetry(driver).open()
+    u = Utilities()
+
+    # Click on Raw JSON, switch tab and click on Raw Data
+    about_telemetry.get_element("category-raw").click()
+    about_telemetry.switch_tab()
+    about_telemetry.get_element("rawdata-tab").click()
+
+    # Verify pings are recorded
+    json_data = u.decode_url(driver)
+    assert u.assert_json_value(
+        json_data, '$..SEARCH_COUNTS.["google-b-1-d.urlbar"].sum', 1
+    )
+    assert u.assert_json_value(
+        json_data,
+        '$..["browser.search.content.urlbar"].["google:tagged:firefox-b-1-d"]',
+        1,
+    )
diff --git a/tests/address_bar_and_search/test_suggestion_engine_selection.py b/tests/address_bar_and_search/test_suggestion_engine_selection.py
diff --git a/tests/find_toolbar/test_find_in_pdf.py b/tests/find_toolbar/test_find_in_pdf.py
diff --git a/tests/find_toolbar/test_find_toolbar_nav.py b/tests/find_toolbar/test_find_toolbar_nav.py
