Bc/Add find in PDF test (#84)

* add test and some helpers

* unused dep

* comment on custom wait event

Author: ben-c-at-moz

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"

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

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

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(

modules/page_object.py

@@ -9,5 +9,6 @@
 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 *

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")

tests/find_toolbar/test_find_in_pdf.py

@@ -0,0 +1,45 @@
+import logging
+from time import sleep
+
+from selenium.webdriver import Firefox
+from selenium.webdriver.common.keys import Keys
+
+from modules.browser_object import FindToolbar
+from modules.page_base import BasePage
+from modules.page_object import GenericPdf
+
+WORD_SEGMENT = "authori"
+MATCH_TWO_COTEXT = "representative must complete"
+
+
+class element_parent_has_text:
+    """
+    Custom WebDriverWait event:
+     if an element's parent node contains certain text, return the element (not the parent)"""
+
+    def __init__(self, pom: BasePage, name: str, text: str):
+        self.name = name
+        self.pom = pom
+        self.text = text
+
+    def __call__(self, driver: Firefox):
+        child = self.pom.get_element(self.name)
+        parent = self.pom.get_parent_of(self.name)
+        if self.text in parent.text:
+            return child
+        else:
+            return False
+
+
+def test_find_in_pdf_using_key_combos(driver: Firefox, fillable_pdf_url: str):
+    """
+    C127271: Search on a PDF page
+    """
+    pdf = GenericPdf(driver, pdf_url=fillable_pdf_url).open()
+    find_toolbar = FindToolbar(driver).open_with_key_combo()
+    find_toolbar.find(WORD_SEGMENT)
+    assert pdf.get_green_highlighted_text() == WORD_SEGMENT
+
+    find_toolbar.rewind_to_first_match()
+    find_toolbar.navigate_matches_by_keys()
+    pdf.expect(element_parent_has_text(pdf, "highlighted-text", MATCH_TWO_COTEXT))

tests/find_toolbar/test_find_toolbar_nav.py

@@ -28,9 +28,7 @@ def test_find_toolbar_navigation(driver: Firefox):
 
     # Sometimes we get a match that isn't the first
     # (This also tests that the number is correct)
-    while match_status["current"] != 1:
-        find_toolbar.previous_match()
-        match_status = find_toolbar.get_match_args()
+    find_toolbar.rewind_to_first_match()
 
     # Ensure that first match is highlighted, others are not
     processes_selector = (By.CSS_SELECTOR, "a[href='about:processes']")