Merge branch 'main' into as/add-on-suggestion

ben-c-at-moz · web-flow · commit 5419ead36652 · 2024-07-01T08:22:35.000-07: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/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/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",
@@ -107,7 +115,7 @@
         "groups": []
     },
 
-    
+
     "add-extra-search-engine": {
         "selectorData": "[id*=urlbar-engine-one-off-item-engine--1][tooltiptext*='{0}']",
         "strategy": "css",
@@ -132,4 +140,11 @@
         "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))
@@ -456,3 +473,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
@@ -9,5 +9,7 @@
 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 *
+from modules.page_object_about_telemetry 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,9 +1,13 @@
+import base64
+import json
 import logging
 import os
 import platform
 import re
 from os import remove
 from random import shuffle
+from typing import Union
+from jsonpath_ng import parse
 from typing import Literal, Union
 
 from faker import Faker
@@ -301,6 +305,19 @@ 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:
     """
@@ -365,15 +382,15 @@ def search(self, term: str, with_enter=True):
                 url_bar.send_keys(term)
 
     def filter_elements_by_attr(
-        self, elements: list[WebElement], attr: str, value: str
+            self, elements: list[WebElement], attr: str, value: str
     ) -> list[WebElement]:
         """
         Given a list of WebElements, return the ones where attribute `attr` has value `value`.
         """
         return [el for el in elements if el.get_attribute(attr) == value]
 
     def pick_element_from_list_by_text(
-        self, elements: list[WebElement], substr: str
+            self, elements: list[WebElement], substr: str
     ) -> WebElement:
         """
         Given a list of WebElements, return the one where innerText matches `substr`.
@@ -464,7 +481,7 @@ def __init__(self, driver: Firefox):
         self.driver = driver
 
     def get_shadow_content(
-        self, element: WebElement
+            self, element: WebElement
     ) -> list[Union[WebElement, ShadowRoot]]:
         """
         Given a WebElement, return the shadow DOM root or roots attached to it. Returns a list.
@@ -498,7 +515,7 @@ def shadow_from_script():
         return []
 
     def css_selector_matches_element(
-        self, element: Union[WebElement, ShadowRoot], selector: list
+            self, element: Union[WebElement, ShadowRoot], selector: list
     ) -> bool:
         if type(element) == ShadowRoot:
             return False
@@ -508,7 +525,7 @@ def css_selector_matches_element(
         )
 
     def find_shadow_chrome_element(
-        self, nodes: list[WebElement], selector: list
+            self, nodes: list[WebElement], selector: list
     ) -> Union[WebElement, None]:
         logging.info("Selecting element in Chrome Context Shadow DOM...")
         if selector[0] not in self.allowed_selectors_shadow_chrome_element:
@@ -534,11 +551,11 @@ def find_shadow_chrome_element(
         return None
 
     def find_shadow_element(
-        self,
-        shadow_parent: Union[WebElement, ShadowRoot],
-        selector: list,
-        multiple=False,
-        context="content",
+            self,
+            shadow_parent: Union[WebElement, ShadowRoot],
+            selector: list,
+            multiple=False,
+            context="content",
     ) -> WebElement:
         """
         Given a WebElement with a shadow root attached, find a selector in the
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,31 @@
+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
@@ -0,0 +1,37 @@
+import pytest
+from selenium.webdriver import Firefox, Keys
+from selenium.webdriver.support import expected_conditions as EC
+
+from modules.browser_object import Navigation
+
+sites = ["Google", "Amazon", "Bing", "DuckDuckGo", "eBay"]
+
+
+@pytest.fixture()
+def add_prefs():
+    return [
+        ("browser.search.region", "US"),
+    ]
+
+
+@pytest.mark.parametrize("site", sites)
+def test_search_suggestion_for_engine_selection(driver: Firefox, site: str):
+    nav = Navigation(driver).open()
+    nav.type_in_awesome_bar("@")
+    nav.element_has_text("results-dropdown", f"Search with {site}")
+
+    suggestion_list_items = nav.get_elements("search-suggestion-list")
+
+    # Filter elements to find the one that matches the desired site
+    suggestion_list_item = next(
+        (item for item in suggestion_list_items if site in item.text), None
+    )
+
+    if suggestion_list_item:
+        suggestion_list_item.click()
+        nav.type_in_awesome_bar("cobra" + Keys.ENTER)
+        nav.expect_in_content(EC.url_contains(site.lower()))
+    else:
+        pytest.fail(f"No search suggestion found for site: {site}")
+
+    nav.clear_awesome_bar()
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
