Bc/new fxa (#88)

* new model script

* fix up new_model, add basic fxa test

* add more fixtures, POM

* test up to confirming account in browser

* finish test, add some additional helpers

* docs for new_model.py

* update unstable test; lint

* lint

* mark unstable

* documentation

* doc; test unstable

Author: ben-c-at-moz

Pipfile

@@ -15,6 +15,7 @@ pytest-html = "*"
 pypom = "*"
 jsonpath-ng = "*"
 pillow = "*"
+pyfxa = "*"
 
 [dev-packages]
 werkzeug = "*"

modules/browser_object_panel_ui.py

@@ -65,3 +65,30 @@ def navigate_to_about_addons(self):
         self.select_panel_setting("customize-toolbar")
         with self.driver.context(self.driver.CONTEXT_CHROME):
             self.get_element("manage-themes").click()
+
+    def click_sync_sign_in_button(self) -> BasePage:
+        """
+        Click FxA sync button.
+        """
+        with self.driver.context(self.driver.CONTEXT_CHROME):
+            self.open_panel_menu()
+            self.select_panel_setting("fxa-sign-in")
+        return self
+
+    def manage_fxa_account(self) -> BasePage:
+        """
+        Open the FxA management flow.
+        """
+        with self.driver.context(self.driver.CONTEXT_CHROME):
+            self.click_sync_sign_in_button()
+            self.get_element("fxa-manage-account-button").click()
+        return self
+
+    def confirm_sync_in_progress(self) -> BasePage:
+        """
+        Check that FxA Sync Label is set to "Syncing…"
+        """
+        with self.driver.context(self.driver.CONTEXT_CHROME):
+            self.click_sync_sign_in_button()
+            self.element_has_text("fxa-sync-label", "Syncing")
+        return self

modules/browser_object_tabbar.py

@@ -1,7 +1,7 @@
 import logging
 from typing import Union
 
-from selenium.common.exceptions import NoSuchElementException, TimeoutException
+from selenium.common.exceptions import NoSuchElementException
 from selenium.webdriver import Keys
 from selenium.webdriver.common.by import By
 from selenium.webdriver.remote.webelement import WebElement
@@ -237,12 +237,3 @@ def get_bar_y():
             self.actions.move_by_offset(0, (sign * pixels))
             self.actions.release()
             self.actions.perform()
-
-    def wait_for_num_tabs(self, num_tabs: int) -> BasePage:
-        """
-        Waits for the driver.window_handles to be updated accordingly with the number of tabs requested
-        """
-        try:
-            self.wait.until(lambda _: len(self.driver.window_handles) == num_tabs)
-        except TimeoutException:
-            logging.warn("Timeout waiting for the number of windows to be:", num_tabs)

modules/data/fxa_new_account.components.json

@@ -0,0 +1,71 @@
+{
+    "login-email-input": {
+        "selectorData": "input[type='email']",
+        "strategy": "css",
+        "groups": [
+            "requiredForPage"
+        ]
+    },
+
+    "submit-button": {
+        "selectorData": "button[type='submit']",
+        "strategy": "css",
+        "groups": [
+            "doNotCache"
+        ]
+    },
+
+    "password-input": {
+        "selectorData": "[data-testid='new-password-input-field']",
+        "strategy": "css",
+        "groups": []
+    },
+
+    "password-repeat-input": {
+        "selectorData": "[data-testid='verify-password-input-field']",
+        "strategy": "css",
+        "groups": []
+    },
+
+    "age-input": {
+        "selectorData": "[data-testid='age-input-field']",
+        "strategy": "css",
+        "groups": []
+    },
+
+    "card-header": {
+        "selectorData": "card-header",
+        "strategy": "class",
+        "groups": []
+    },
+
+    "otp-input": {
+        "selectorData": "[data-testid='confirm-signup-code-input-field']",
+        "strategy": "css",
+        "groups": []
+    },
+
+    "connected-heading": {
+        "selectorData": "fxa-connected-heading",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "continue-browsing-link": {
+        "selectorData": "cad-not-now",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "login-password-input": {
+        "selectorData": "input#password",
+        "strategy": "css",
+        "groups": []
+    },
+
+    "sign-in-button": {
+        "selectorData": "use-logged-in",
+        "strategy": "id",
+        "groups": []
+    }
+}

modules/data/generic_page.components.json

@@ -0,0 +1,7 @@
+{
+    "body": {
+        "selectorData": "body",
+        "strategy": "tag",
+        "groups": []
+    }
+}

modules/data/panel_ui.components.json

@@ -4,7 +4,40 @@
         "selectorData": "PanelUI-menu-button",
         "strategy": "id",
         "groups": [
-            "requiredForPage"
+            "requiredForPage",
+            "doNotCache"
+        ]
+    },
+
+    "sync-user-button": {
+        "selectorData": "toolbarbutton[id='fxa-toolbar-menu-button']",
+        "strategy": "css",
+        "groups": []
+    },
+
+    "fxa-manage-account-button": {
+        "selectorData": "fxa-manage-account-button",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "sync-fxa": {
+        "selectorData": "appMenu-fxa-status2",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "fxa-sign-in": {
+        "selectorData": "#appMenu-fxa-status2 toolbarbutton",
+        "strategy": "css",
+        "groups": []
+    },
+
+    "fxa-sync-label": {
+        "selectorData": "syncnow-label",
+        "strategy": "class",
+        "groups": [
+            "doNotCache"
         ]
     },
 

modules/page_base.py

@@ -11,6 +11,7 @@
 from selenium.common.exceptions import NoSuchElementException, TimeoutException
 from selenium.webdriver import ActionChains, Firefox
 from selenium.webdriver.common.by import By
+from selenium.webdriver.common.keys import Keys
 from selenium.webdriver.remote.webelement import WebElement
 from selenium.webdriver.support import expected_conditions as EC
 from selenium.webdriver.support.wait import WebDriverWait
@@ -100,6 +101,16 @@ def set_content_context(self):
         if self._xul_source_snippet in self.driver.page_source:
             self.driver.set_context(self.driver.CONTEXT_CONTENT)
 
+    def custom_wait(self, **kwargs) -> WebDriverWait:
+        """
+        Create a custom WebDriverWait object, refer to Selenium docs
+        for explanations of the arguments.
+        Examples:
+          self.custom_wait(timeout=45).until(<condition>)
+          self.custom_wait(poll_frequency=1).until(<condition>)
+        """
+        return WebDriverWait(self.driver, **kwargs)
+
     def expect(self, condition) -> Page:
         """Use the Page's wait object to assert a condition or wait until timeout"""
         logging.info("Expecting...")
@@ -231,12 +242,15 @@ def get_element(
             logging.info(f"Getting multiple elements by name {name}")
         if labels:
             logging.info(f"Labels: {labels}")
+        logging.info(f"Groups: {self.elements[name]['groups']}")
         cache_name = name
         if labels:
             labelscode = "".join(labels)
             cache_name = f"{name}{labelscode}"
             if cache_name not in self.elements:
                 self.elements[cache_name] = deepcopy(self.elements[name])
+        if multiple:
+            logging.info(f"Multiples: Not caching {cache_name}...")
         if not multiple and "seleniumObject" in self.elements[cache_name]:
             # no caching for multiples
             cached_element = self.elements[cache_name]["seleniumObject"]
@@ -257,6 +271,7 @@ def get_element(
                     shadow_parent, selector, context=self.context
                 )
                 if "doNotCache" not in element_data["groups"]:
+                    logging.info(f"Not caching {cache_name}...")
                     self.elements[cache_name]["seleniumObject"] = shadow_element
                 return shadow_element
             else:
@@ -278,6 +293,7 @@ def get_element(
         if not multiple:
             found_element = self.driver.find_element(*selector)
             if "doNotCache" not in element_data["groups"]:
+                logging.info(f"Caching {cache_name}...")
                 self.elements[cache_name]["seleniumObject"] = found_element
             logging.info(f"Returning element {cache_name}.\n")
             return found_element
@@ -367,6 +383,43 @@ def url_contains(self, url_part: str) -> Page:
         self.expect(EC.url_contains(url_part))
         return self
 
+    def fill(
+        self, name: str, term: str, clear_first=True, press_enter=True, labels=[]
+    ) -> Page:
+        """
+        Get a fillable element and fill it with text. Return self.
+
+        ...
+
+        Arguments
+        ---------
+
+        name: str
+            The key of the entry in self.elements, parsed from the elements JSON
+
+        labels: list[str]
+            Strings that replace instances of {.*} in the "selectorData" subentry of
+            self.elements[name]
+
+        term: str
+            The text to enter into the element
+
+        clear_first: bool
+            Call .clear() on the element first. Default True
+
+        press_enter: bool
+            Press Keys.ENTER after filling the element. Default True
+        """
+        if self.context == "chrome":
+            self.set_chrome_context()
+        el = self.get_element(name, labels=labels)
+        self.element_clickable(name, labels=labels)
+        if clear_first:
+            el.clear()
+        end = Keys.ENTER if press_enter else ""
+        el.send_keys(f"{term}{end}")
+        return self
+
     def multi_click(
         self, iters: int, reference: Union[str, tuple, WebElement], labels=[]
     ) -> Page:
@@ -415,6 +468,16 @@ def context_click_element(self, element: WebElement) -> Page:
         self.actions.context_click(element).perform()
         return self
 
+    def wait_for_num_tabs(self, num_tabs: int) -> Page:
+        """
+        Waits for the driver.window_handles to be updated accordingly with the number of tabs requested
+        """
+        try:
+            self.wait.until(lambda _: len(self.driver.window_handles) == num_tabs)
+        except TimeoutException:
+            logging.warn("Timeout waiting for the number of windows to be:", num_tabs)
+        return self
+
     def hide_popup(self, context_menu: str, chrome=False) -> Page:
         """
         Given the ID of the context menu, it will dismiss the menu.

modules/page_object.py

@@ -10,6 +10,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_fxa_new_account import *
+from modules.page_object_generics import *
 from modules.page_object_google_search import *
 from modules.page_object_wiki_firefox_logo import *

modules/page_object_fxa_new_account.py

@@ -0,0 +1,40 @@
+from modules.page_base import BasePage
+
+
+class FxaNewAccount(BasePage):
+    """
+    Page Object Model for FxA signup flow.
+    Initialize with fxa_url=<the url of the FxA instance>
+    """
+
+    URL_TEMPLATE = "{fxa_url}"
+
+    def sign_up_sign_in(self, email: str) -> BasePage:
+        """From the entry point, enter email to sign up or sign in"""
+        self.fill("login-email-input", email, press_enter=False)
+        self.get_element("submit-button").click()
+        return self
+
+    def create_new_account(self, password: str, age=30) -> BasePage:
+        """Fill out the password and age fields, then submit and wait for code"""
+        self.fill("password-input", password, press_enter=False)
+        self.fill("password-repeat-input", password, press_enter=False)
+        self.fill("age-input", str(age), press_enter=False)
+        self.get_element("submit-button").click()
+        self.element_has_text("card-header", "Enter confirmation code")
+        return self
+
+    def confirm_new_account(self, otp: str) -> BasePage:
+        """Given an OTP, confirm the account, submit, and wait for account activation"""
+        self.fill("otp-input", otp, press_enter=False)
+        self.get_element("submit-button").click()
+        self.element_exists("connected-heading")
+        return self
+
+    def finish_account_setup(self, password: str) -> BasePage:
+        """Walk through the 'Finish Account Setup' flow"""
+        self.wait_for_num_tabs(2)
+        self.driver.switch_to.window(self.driver.window_handles[-1])
+        self.fill("login-password-input", password, press_enter=False)
+        self.get_element("submit-button").click()
+        return self

modules/page_object_generic_pdf.py renamed to modules/page_object_generics.py

@@ -1,6 +1,14 @@
 from modules.page_base import BasePage
 
 
+class GenericPage(BasePage):
+    """
+    Generic POM for a page we don't care to map
+    """
+
+    URL_TEMPLATE = "{url}"
+
+
 class GenericPdf(BasePage):
     """
     Generic POM for any page with an open PDF in it.