Merge pull request #74 from mozilla/hy/google_search_counts_us

hy/google search counts us

Author: sv-hyacoub

Pipfile

@@ -13,6 +13,7 @@ requests = "*"
 pytest-xdist = "*"
 pytest-html = "*"
 pypom = "*"
+jsonpath-ng = "*"
 pillow = "*"
 
 [dev-packages]

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": []
+  }
+}

modules/page_base.py

@@ -473,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])

modules/page_object.py

@@ -12,3 +12,4 @@
 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 *

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"

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

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)