working on comments on suite refactor

Author: philimon-reset

modules/browser_object_navigation.py

@@ -27,6 +27,7 @@ class Navigation(BasePage):
     def __init__(self, driver: Firefox, **kwargs):
         super().__init__(driver, **kwargs)
         self.search_bar = None
+        self.awesome_bar = None
         self.change_search_settings_button = None
 
     @BasePage.context_content
@@ -185,7 +186,7 @@ def context_click_in_awesome_bar(self) -> BasePage:
         actions = ActionChains(self.driver)
         actions.context_click(self.awesome_bar).perform()
         return self
-     
+
     def get_download_button(self) -> WebElement:
         """
         Gets the download button WebElement

modules/browser_object_tabbar.py

@@ -35,10 +35,10 @@ def __init__(self):
 
     SCROLL_DIRECTION = ScrollDirection()
 
+    @BasePage.context_chrome
     def new_tab_by_button(self) -> BasePage:
         """Use the New Tab button (+) to open a new tab"""
-        with self.driver.context(self.driver.CONTEXT_CHROME):
-            self.get_element("newtab-button").click()
+        self.get_element("newtab-button").click()
         return self
 
     def new_tab_by_keys(self, sys_platform: str) -> BasePage:
@@ -77,60 +77,59 @@ def reopen_closed_tab_by_keys(self, sys_platform: str) -> BasePage:
             ).key_up(Keys.SHIFT).key_up(Keys.CONTROL).perform()
         return self
 
+    @BasePage.context_chrome
     def click_tab_by_title(self, title: str) -> BasePage:
         """Given a full page title, click the corresponding tab"""
-        with self.driver.context(self.driver.CONTEXT_CHROME):
-            self.get_element("tab-by-title", labels=[title]).click()
+        self.get_element("tab-by-title", labels=[title]).click()
         return self
 
-    def get_tab_by_title(self, title: str) -> BasePage:
+    @BasePage.context_chrome
+    def get_tab_by_title(self, title: str) -> WebElement:
         """Given a full page title, return the corresponding tab"""
-        with self.driver.context(self.driver.CONTEXT_CHROME):
-            return self.get_element("tab-by-title", labels=[title])
+        return self.get_element("tab-by-title", labels=[title])
 
+    @BasePage.context_chrome
     def click_tab_by_index(self, index: int) -> BasePage:
         """Given a tab index (int), click the corresponding tab"""
-        with self.driver.context(self.driver.CONTEXT_CHROME):
-            self.get_element("tab-by-index", labels=[str(index)]).click()
+        self.get_element("tab-by-index", labels=[str(index)]).click()
         return self
 
+    @BasePage.context_chrome
     def get_tab(self, identifier: Union[str, int]) -> Union[WebElement, None]:
         """Return a tab root based on either a title or an index"""
-        with self.driver.context(self.driver.CONTEXT_CHROME):
-            if isinstance(identifier, int):
-                tab = self.get_element("tab-by-index", labels=[str(identifier)])
-            elif isinstance(identifier, str):
-                tab = self.get_element("tab-by-title", labels=[identifier])
-            else:
-                # if we get an unexpected type, we shouldn't assume that the user wants sys exit
-                # but we have to cause problems for them nonetheless
-                assert False, "Error getting tab root"
-                tab = None
-            return tab
+        if isinstance(identifier, int):
+            tab = self.get_element("tab-by-index", labels=[str(identifier)])
+        elif isinstance(identifier, str):
+            tab = self.get_element("tab-by-title", labels=[identifier])
+        else:
+            # if we get an unexpected type, we shouldn't assume that the user wants sys exit,
+            # but we have to cause problems for them nonetheless
+            assert False, "Error getting tab root"
+        return tab
 
+    @BasePage.context_chrome
     def is_pinned(self, tab_root: WebElement) -> bool:
         """Is this tab pinned?"""
-        with self.driver.context(self.driver.CONTEXT_CHROME):
-            pinned = tab_root.get_attribute("pinned")
-            if pinned in ["true", "false"]:
-                return pinned == "true"
-            else:
-                assert False, "Error checking tab pinned status"
+        pinned = tab_root.get_attribute("pinned")
+        if pinned in ["true", "false"]:
+            return pinned == "true"
+        else:
+            assert False, "Error checking tab pinned status"
 
+    @BasePage.context_chrome
     def click_tab_mute_button(self, identifier: Union[str, int]) -> BasePage:
         """Click the tab icon overlay, no matter what's happening with media"""
         logging.info(f"toggling tab mute for {identifier}")
         tab = self.get_tab(identifier)
-        with self.driver.context(self.driver.CONTEXT_CHROME):
-            self.actions.move_to_element(tab).perform()
-            self.get_element("tab-icon-overlay").click()
+        self.actions.move_to_element(tab).perform()
+        self.get_element("tab-icon-overlay").click()
         return self
 
+    @BasePage.context_chrome
     def get_tab_title(self, tab_element: WebElement) -> str:
         """Given a tab root element, get the title text of the tab"""
-        with self.driver.context(self.driver.CONTEXT_CHROME):
-            tab_label = tab_element.find_element(*self.get_selector("tab-title"))
-            return tab_label.text
+        tab_label = tab_element.find_element(*self.get_selector("tab-title"))
+        return tab_label.text
 
     def expect_tab_sound_status(
         self, identifier: Union[str, int], status: MediaStatus
@@ -147,35 +146,35 @@ def expect_title_contains(self, text: str) -> BasePage:
         self.expect(EC.title_contains(text))
         return self
 
+    @BasePage.context_chrome
     def open_all_tabs_list(self) -> BasePage:
         """Click the Tab Visibility / List All Tabs button"""
-        with self.driver.context(self.driver.CONTEXT_CHROME):
-            self.get_element("list-all-tabs-button").click()
-            self.expect(
-                EC.text_to_be_present_in_element_attribute(
-                    self.get_selector("list-all-tabs-button"), "open", "true"
-                )
+        self.get_element("list-all-tabs-button").click()
+        self.expect(
+            EC.text_to_be_present_in_element_attribute(
+                self.get_selector("list-all-tabs-button"), "open", "true"
             )
+        )
         return self
 
+    @BasePage.context_chrome
     def count_tabs_in_all_tabs_menu(self) -> int:
         """Return the number of entries in the all tabs menu"""
-        with self.driver.context(self.driver.CONTEXT_CHROME):
-            all_tabs_menu = self.get_element("all-tabs-menu")
-            all_tabs_entries = all_tabs_menu.find_elements(
-                self.get_selector("all-tabs-entry")
-            )
+        all_tabs_menu = self.get_element("all-tabs-menu")
+        all_tabs_entries = all_tabs_menu.find_elements(
+            self.get_selector("all-tabs-entry")
+        )
         return len(all_tabs_entries)
 
+    @BasePage.context_chrome
     def scroll_tabs(self, direction: ScrollDirection) -> BasePage:
         """Scroll tabs in tab bar using the < and > scroll buttons"""
         logging.info(f"Scrolling tabs {direction}")
-        with self.driver.context(self.driver.CONTEXT_CHROME):
-            try:
-                scroll_button = self.get_element(f"tab-scrollbox-{direction}-button")
-                scroll_button.click()
-            except NoSuchElementException:
-                logging.info("Could not scroll any further!")
+        try:
+            scroll_button = self.get_element(f"tab-scrollbox-{direction}-button")
+            scroll_button.click()
+        except NoSuchElementException:
+            logging.info("Could not scroll any further!")
         return self
 
     def get_text_of_all_tabs_entry(self, selected=False, index=0) -> str:
@@ -238,6 +237,7 @@ def get_location_of_all_tabs_entry(self, selected=False, index=0) -> dict:
             entry = entries[index]
         return entry.find_element(By.CLASS_NAME, "all-tabs-button").location
 
+    @BasePage.context_chrome
     def scroll_on_all_tabs_menu(self, down=True, pixels=200) -> BasePage:
         """
         Scroll the List All Tabs menu down or up.
@@ -253,30 +253,29 @@ def scroll_on_all_tabs_menu(self, down=True, pixels=200) -> BasePage:
         pixels: int
             The number of pixels to scroll the bar
         """
-        with self.driver.context(self.driver.CONTEXT_CHROME):
-            menu = self.get_element("all-tabs-menu")
-            logging.info(f"menu location: {menu.location}")
-            logging.info(f"menu size: {menu.size}")
-
-            # HACK: Can't figure out what the scrollbox selector is, but it's ~4 pixels
-            #  off the edge of the menu.
-            x_start = (menu.size["width"] / 2.0) - 4.0
-            # +Y is down, -Y is up
-            sign = 1 if down else -1
-
-            self.actions.move_to_element_with_offset(menu, x_start, 0)
-            self.actions.click_and_hold()
-            self.actions.move_by_offset(0, (sign * pixels))
-            self.actions.release()
-            self.actions.perform()
-
+        menu = self.get_element("all-tabs-menu")
+        logging.info(f"menu location: {menu.location}")
+        logging.info(f"menu size: {menu.size}")
+
+        # HACK: Can't figure out what the scrollbox selector is, but it's ~4 pixels
+        #  off the edge of the menu.
+        x_start = (menu.size["width"] / 2.0) - 4.0
+        # +Y is down, -Y is up
+        sign = 1 if down else -1
+
+        self.actions.move_to_element_with_offset(menu, x_start, 0)
+        self.actions.click_and_hold()
+        self.actions.move_by_offset(0, (sign * pixels))
+        self.actions.release()
+        self.actions.perform()
+
+    @BasePage.context_chrome
     def close_tab(self, tab: WebElement) -> BasePage:
         """
         Given the index of the tab, it closes that tab.
         """
         # cur_tab = self.click_tab_by_index(index)
-        with self.driver.context(self.driver.CONTEXT_CHROME):
-            self.get_element("tab-x-icon", parent_element=tab).click()
+        self.get_element("tab-x-icon", parent_element=tab).click()
         return self
 
     def open_web_page_in_new_tab(self, web_page: BasePage, num_tabs: int) -> BasePage:

modules/data/about_prefs.components.json

@@ -451,6 +451,18 @@
         "groups": []
     },
 
+    "actions-menu": {
+        "selectorData": "richlistitem[type='{.*}'] menulist.actionsMenu",
+        "strategy": "css",
+        "groups": []
+    },
+
+    "actions-menu-option": {
+        "selectorData": "richlistitem[type='{.*}'] menuitem[label='{.*}']",
+        "strategy": "css",
+        "groups": []
+    },
+
     "exceptions-item": {
         "selectorData": "//*[@id='permissionsBox']//*[@origin]",
         "strategy": "xpath",

modules/page_base.py

@@ -249,7 +249,7 @@ def get_selector(self, name: str, labels=[]) -> list:
         match = braces.findall(selector[1])
         for i in range(len(labels)):
             logging.info(f"Replace {match[i]} with {labels[i]}")
-            selector[1] = selector[1].replace(match[i], labels[i])
+            selector[1] = selector[1].replace(match[i], labels[i], 1)
         logging.info("Returned selector.")
         return selector
 

modules/page_object_prefs.py

@@ -200,9 +200,7 @@ def fill_autofill_panel_information(
         self.actions.send_keys(Keys.ENTER).perform()
         return self
 
-    def fill_cc_panel_information(
-        self, credit_card_fill_information: CreditCardBase
-    ) -> BasePage:
+    def fill_cc_panel_information(self, credit_card_fill_information: CreditCardBase):
         """
         Takes the sample cc object and fills it into the popup panel in the about:prefs section
         under saved payment methods.
@@ -237,7 +235,7 @@ def get_saved_payments_popup_iframe(self) -> WebElement:
         iframe = self.get_element("browser-popup")
         return iframe
 
-    def update_cc_field_panel(self, num_tabs: int, new_info: str) -> BasePage:
+    def update_cc_field_panel(self, num_tabs: int, new_info: str):
         """
         Updates a field in the credit card popup panel in about:prefs by pressing the number of tabs and sending the new information
         ...
@@ -413,6 +411,17 @@ def set_default_zoom_level(self, zoom_percentage: int) -> BasePage:
         self.click_on("default-zoom-dropdown")
         return self
 
+    def select_content_and_action(self, content_type: str, action: str) -> BasePage:
+        """
+        From the applications list that handles how downloaded media is used,
+        select a content type and action
+        """
+        el = self.get_element("actions-menu", labels=[content_type])
+        el.click()
+        self.click_on("actions-menu-option", labels=[content_type, action])
+        self.wait.until(lambda _: el.get_attribute("label") == action)
+        return self
+
 
 class AboutAddons(BasePage):
     """

modules/util.py

@@ -22,6 +22,8 @@
 from selenium.webdriver.common.keys import Keys
 from selenium.webdriver.remote.shadowroot import ShadowRoot
 from selenium.webdriver.remote.webelement import WebElement
+from selenium.webdriver.support import expected_conditions as EC
+from selenium.webdriver.support.wait import WebDriverWait
 
 from modules.classes.autofill_base import AutofillAddressBase
 from modules.classes.credit_card import CreditCardBase
@@ -409,6 +411,7 @@ class BrowserActions:
 
     def __init__(self, driver: Firefox):
         self.driver = driver
+        self.wait = WebDriverWait(driver, timeout=2)
 
     def clear_and_fill(self, webelement: WebElement, term: str, press_enter=True):
         """
@@ -476,6 +479,22 @@ def switch_to_content_context(self):
         """
         self.driver.switch_to.default_content()
 
+    def select_file_opening_option(self, option: str = "handleInternally"):
+        """
+        select an option when file opening window prompt is shown
+        """
+        with self.driver.context(self.driver.CONTEXT_CHROME):
+            self.driver.switch_to.window(self.driver.window_handles[-1])
+            self.driver.find_element(By.ID, option).click()
+            confirm_button = self.driver.find_element(By.ID, "unknownContentTypeWindow")
+            self.wait.until_not(
+                EC.element_attribute_to_include(
+                    (By.CSS_SELECTOR, ".dialog-button-box > button:nth-child(6)"),
+                    "disabled",
+                )
+            )
+            confirm_button.send_keys(Keys.ENTER)
+
     def get_all_colors_in_element(self, selector: tuple) -> set:
         """
         Given an element selector, return all the unique colors in that element.

tests/find_toolbar/conftest.py

@@ -23,6 +23,6 @@ def find_toolbar(driver: Firefox):
 
 
 @pytest.fixture()
-def ba(driver: Firefox):
-    browser_actions = BrowserActions(driver)
-    yield browser_actions
+def browser_actions(driver: Firefox):
+    ba = BrowserActions(driver)
+    yield ba

tests/find_toolbar/test_find_in_pdf.py

@@ -12,7 +12,7 @@ def test_case():
 
 
 WORD_SEGMENT = "authori"
-MATCH_TWO_CONTEXT = "representative must complete"
+MATCH_TWO_COMPLETION = "representative must complete"
 
 
 class element_parent_has_text:
@@ -51,4 +51,4 @@ def test_find_in_pdf_using_key_combos(
 
     find_toolbar.rewind_to_first_match()
     find_toolbar.navigate_matches_by_keys()
-    pdf.expect(element_parent_has_text(pdf, "highlighted-text", MATCH_TWO_CONTEXT))
+    pdf.expect(element_parent_has_text(pdf, "highlighted-text", MATCH_TWO_COMPLETION))

tests/find_toolbar/test_find_toolbar_nav.py

@@ -28,13 +28,13 @@ def are_lists_different(a: int, b: int) -> bool:
 
 
 def test_find_toolbar_navigation(
-    driver: Firefox, find_toolbar: FindToolbar, ba: BrowserActions
+    driver: Firefox, find_toolbar: FindToolbar, browser_actions: BrowserActions
 ):
     """
     C127249: Navigate through found items
 
     Arguments:
-        ba: instantiation of BrowserActions BOM.
+        browser_actions: instantiation of BrowserActions BOM.
         find_toolbar: instantiation of FindToolbar BOM.
     """
     driver.get(TARGET_PAGE)
@@ -49,16 +49,16 @@ def test_find_toolbar_navigation(
     find_toolbar.rewind_to_first_match()
 
     # Ensure that first match is highlighted, others are not
-    first_match_colors = ba.get_all_colors_in_element(first_match)
-    fourth_match_colors = ba.get_all_colors_in_element(fourth_match)
+    first_match_colors = browser_actions.get_all_colors_in_element(first_match)
+    fourth_match_colors = browser_actions.get_all_colors_in_element(fourth_match)
 
     assert len(first_match_colors) > len(fourth_match_colors)
     assert are_lists_different(len(first_match_colors), len(fourth_match_colors))
 
     # Navigate with keyboard and button
     find_toolbar.navigate_matches_n_times(3)
-    first_match_colors = ba.get_all_colors_in_element(first_match)
-    fourth_match_colors = ba.get_all_colors_in_element(fourth_match)
+    first_match_colors = browser_actions.get_all_colors_in_element(first_match)
+    fourth_match_colors = browser_actions.get_all_colors_in_element(fourth_match)
 
     assert len(first_match_colors) < len(fourth_match_colors)
     assert are_lists_different(len(first_match_colors), len(fourth_match_colors))