Merge pull request #79 from mozilla/sl/frequently-used-context-actions

Frequently Used Context Actions

Author: sarinali

modules/browser_object_context_menu.py

@@ -16,3 +16,10 @@ def get_context_item(self, item: str) -> WebElement:
         """
         with self.driver.context(self.driver.CONTEXT_CHROME):
             return self.get_element(item)
+
+    def click_context_item(self, context_element: WebElement) -> BasePage:
+        """
+        Clicks the context item.
+        """
+        with self.driver.context(self.driver.CONTEXT_CHROME):
+            context_element.click()

modules/browser_object_navigation.py

@@ -142,9 +142,10 @@ def wait_for_download_animation_finish(
         """
         Waits for the download button to finish playing the animation for downloading to local computer
         """
-        try:
-            self.wait.until(
-                lambda _: downloads_button.get_attribute("notification") == "finish"
-            )
-        except TimeoutException:
-            logging.warning("Animation did not finish or did not play.")
+        with self.driver.context(self.driver.CONTEXT_CHROME):
+            try:
+                self.wait.until(
+                    lambda _: downloads_button.get_attribute("notification") == "finish"
+                )
+            except TimeoutException:
+                logging.warning("Animation did not finish or did not play.")

modules/data/context_menu.components.json

@@ -4,5 +4,23 @@
         "selectorData": "context-searchselect",
         "strategy": "id",
         "groups": []
+    },
+
+    "context-menu-inspect": {
+        "selectorData": "context-inspect",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "context-menu-take-screenshot": {
+        "selectorData": "context-take-screenshot",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "context-menu-save-page-as": {
+        "selectorData": "context-savepage",
+        "strategy": "id",
+        "groups": []
     }
 }

modules/data/example_page.components.json

@@ -0,0 +1,22 @@
+{
+    "title-header": {
+        "selectorData": "h1",
+        "strategy": "tag",
+        "groups": []
+    },
+
+    "inspect-menu-horizontal-splitter": {
+        "selectorData": "devtools-horizontal-splitter",
+        "strategy": "class",
+        "groups": []
+    },
+
+    "take-screenshot-box": {
+        "selectorData": "screenshotsPagePanel",
+        "strategy": "id",
+        "groups": [
+            "doNotCache"
+        ]
+    }
+
+}

modules/page_base.py

@@ -398,15 +398,19 @@ def context_click_element(self, element: WebElement) -> Page:
         self.actions.context_click(element).perform()
         return self
 
-    def hide_popup(self, context_menu: str) -> Page:
+    def hide_popup(self, context_menu: str, chrome=False) -> Page:
         """
         Given the ID of the context menu, it will dismiss the menu.
 
         For example, the tab context menu corresponds to the id of tabContextMenu. Usage would be: tabs.hide_popup("tabContextMenu")
         """
         script = f"""document.querySelector("#{context_menu}").hidePopup();
         """
-        self.driver.execute_script(script)
+        if chrome:
+            with self.driver.context(self.driver.CONTEXT_CHROME):
+                self.driver.execute_script(script)
+        else:
+            self.driver.execute_script(script)
 
     def hide_popup_by_class(self, class_name: str) -> None:
         """
@@ -422,12 +426,16 @@ def hide_popup_by_class(self, class_name: str) -> None:
                 """
         self.driver.execute_script(script)
 
-    def hide_popup_by_child_node(self, node: WebElement) -> Page:
+    def hide_popup_by_child_node(self, node: WebElement, chrome=False) -> Page:
         script = """var element = arguments[0].parentNode;
                  if (element && element.hidePopup) {
                     element.hidePopup();
                  }"""
-        self.driver.execute_script(script, node)
+        if chrome:
+            with self.driver.context(self.driver.CONTEXT_CHROME):
+                self.driver.execute_script(script, node)
+        else:
+            self.driver.execute_script(script, node)
 
     @property
     def loaded(self):

modules/page_object.py

@@ -8,5 +8,6 @@
 from modules.page_object_addons_mozilla_org import *
 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_google_search import *
 from modules.page_object_wiki_firefox_logo import *

modules/page_object_example_page.py

@@ -0,0 +1,9 @@
+from modules.page_base import BasePage
+
+
+class ExamplePage(BasePage):
+    """
+    Page Object Model for the website https://example.com/
+    """
+
+    URL_TEMPLATE = "https://example.com/"

tests/menus/test_frequently_used_context_menu.py

@@ -0,0 +1,116 @@
+import platform
+from time import sleep
+
+import pytest
+from selenium.webdriver import Firefox
+
+from modules.browser_object import ContextMenu, Navigation
+from modules.page_object import ExamplePage
+from modules.util import BrowserActions, Utilities
+
+
+@pytest.mark.unstable
+def test_save_page_as(driver: Firefox):
+    """
+    C2637623.1: save page as
+    """
+    try:
+        from pynput.keyboard import Key
+    except ModuleNotFoundError:
+        pytest.skip("Could not load pynput")
+    # create objects
+    context_menu = ContextMenu(driver)
+    driver.get("https://example.com")
+    example_page = ExamplePage(driver)
+    nav = Navigation(driver)
+    util = Utilities()
+    ba = BrowserActions(driver)
+
+    # right click something that is not a hyperlink
+    title_header = example_page.get_element("title-header")
+    context_menu.context_click_element(title_header)
+
+    save_page_as = context_menu.get_context_item("context-menu-save-page-as")
+    context_menu.click_context_item(save_page_as)
+    context_menu.hide_popup_by_child_node(save_page_as, chrome=True)
+
+    downloads_button = nav.get_download_button()
+
+    # short sleep to ensure menu is shown
+    sleep(0.5)
+
+    # perform key presses to save the file
+    this_platform = platform.system()
+    if this_platform == "Linux":
+        ba.controller.press(Key.alt)
+        ba.controller.press(Key.tab)
+        ba.controller.release(Key.tab)
+        ba.controller.release(Key.alt)
+
+        ba.controller.press(Key.alt)
+        ba.controller.press(Key.tab)
+        ba.controller.release(Key.tab)
+        ba.controller.release(Key.alt)
+
+        ba.key_press_release(Key.tab)
+
+        ba.key_press_release(Key.tab)
+
+    # Press and release the Enter key
+    ba.key_press_release(Key.enter)
+
+    # Wait for the animation to complete
+    nav.wait_for_download_animation_finish(downloads_button)
+
+    # verify and delete downloaded file
+    saved_image_location = util.get_saved_file_path("Example Domain.html")
+    util.check_file_path_validility(saved_image_location)
+    util.remove_file(saved_image_location)
+
+
+def test_take_screenshot(driver: Firefox):
+    """
+    C2637623.2: take screenshot works from context menu
+    """
+    # create objects
+    context_menu = ContextMenu(driver)
+    driver.get("https://example.com")
+    example_page = ExamplePage(driver)
+
+    # ensure that the screenshot is not present
+    example_page.element_does_not_exist("take-screenshot-box")
+
+    # right click the header
+    title_header = example_page.get_element("title-header")
+    context_menu.context_click_element(title_header)
+
+    # context click the screenshot option and verify its not hidden
+    take_screenshot = context_menu.get_context_item("context-menu-take-screenshot")
+    context_menu.click_context_item(take_screenshot)
+    context_menu.hide_popup_by_child_node(take_screenshot, chrome=True)
+
+    with driver.context(driver.CONTEXT_CHROME):
+        screenshot_box = example_page.get_element("take-screenshot-box")
+        assert screenshot_box.get_attribute("hidden") is None
+
+
+def test_inspect(driver: Firefox):
+    """
+    C2637623.3: inspect works from context menu
+    """
+    # create objects
+    context_menu = ContextMenu(driver)
+    driver.get("https://example.com")
+    example_page = ExamplePage(driver)
+
+    # right click something that is not a hyperlink
+    title_header = example_page.get_element("title-header")
+    context_menu.context_click_element(title_header)
+
+    inspect_option = context_menu.get_context_item("context-menu-inspect")
+    context_menu.click_context_item(inspect_option)
+    context_menu.hide_popup_by_child_node(inspect_option, chrome=True)
+
+    # find an element present in the dev tools
+    with driver.context(driver.CONTEXT_CHROME):
+        example_page.element_exists("inspect-menu-horizontal-splitter")

tests/menus/test_hyperlink_context_menu.py

@@ -21,13 +21,12 @@ def test_open_link_in_new_window(driver: Firefox):
     hyperlink_context.context_click_element(hyperlink)
 
     # click on the open in new window option
-    with driver.context(driver.CONTEXT_CHROME):
-        open_in_new_window = hyperlink_context.get_context_item(
-            "context-menu-open-in-new-window"
-        )
-        open_in_new_window.click()
 
-        hyperlink_context.hide_popup("contentAreaContextMenu")
+    open_in_new_window = hyperlink_context.get_context_item(
+        "context-menu-open-in-new-window"
+    )
+    hyperlink_context.click_context_item(open_in_new_window)
+    hyperlink_context.hide_popup("contentAreaContextMenu", chrome=True)
 
     # verify there are two instances (two windows)
     tabs.wait_for_num_tabs(2)
@@ -53,13 +52,11 @@ def test_open_link_in_private_window(driver: Firefox):
     hyperlink_context.context_click_element(hyperlink)
 
     # click on the open in new window option
-    with driver.context(driver.CONTEXT_CHROME):
-        open_in_new_window = hyperlink_context.get_context_item(
-            "context-menu-open-in-private-window"
-        )
-        open_in_new_window.click()
-
-        hyperlink_context.hide_popup("contentAreaContextMenu")
+    open_in_new_window = hyperlink_context.get_context_item(
+        "context-menu-open-in-private-window"
+    )
+    hyperlink_context.click_context_item(open_in_new_window)
+    hyperlink_context.hide_popup("contentAreaContextMenu", chrome=True)
 
     # verify there are two instances (two windows)
     tabs.wait_for_num_tabs(2)
@@ -89,13 +86,9 @@ def test_copy_link(driver: Firefox):
     hyperlink_context.context_click_element(hyperlink)
 
     # click on the open in new window option
-    with driver.context(driver.CONTEXT_CHROME):
-        open_in_new_window = hyperlink_context.get_context_item(
-            "context-menu-copy-link"
-        )
-        open_in_new_window.click()
-
-        hyperlink_context.hide_popup("contentAreaContextMenu")
+    open_in_new_window = hyperlink_context.get_context_item("context-menu-copy-link")
+    hyperlink_context.click_context_item(open_in_new_window)
+    hyperlink_context.hide_popup("contentAreaContextMenu", chrome=True)
 
     # open a new tab
     tabs.new_tab_by_button()

tests/menus/test_image_context_menu_actions.py

@@ -26,12 +26,11 @@ def test_open_image_in_new_tab(driver: Firefox):
     wiki_image_page.context_click_element(image_logo)
 
     # open in a new tab
-    with driver.context(driver.CONTEXT_CHROME):
-        open_in_new_tab = image_context_menu.get_context_item(
-            "context-menu-open-image-in-new-tab"
-        )
-        open_in_new_tab.click()
-        wiki_image_page.hide_popup_by_child_node(open_in_new_tab)
+    open_in_new_tab = image_context_menu.get_context_item(
+        "context-menu-open-image-in-new-tab"
+    )
+    image_context_menu.click_context_item(open_in_new_tab)
+    wiki_image_page.hide_popup_by_child_node(open_in_new_tab, chrome=True)
 
     # switch to the second tab and verify the URL
     tabs.wait_for_num_tabs(2)
@@ -64,12 +63,9 @@ def test_save_image_as(driver: Firefox):
     wiki_image_page.context_click_element(image_logo)
 
     # save it
-    with driver.context(driver.CONTEXT_CHROME):
-        save_image_as = image_context_menu.get_context_item(
-            "context-menu-save-image-as"
-        )
-        save_image_as.click()
-        wiki_image_page.hide_popup_by_child_node(save_image_as)
+    save_image_as = image_context_menu.get_context_item("context-menu-save-image-as")
+    image_context_menu.click_context_item(save_image_as)
+    wiki_image_page.hide_popup_by_child_node(save_image_as, chrome=True)
 
     # create the pynput controller
     downloads_button = nav.get_download_button()
@@ -97,8 +93,7 @@ def test_save_image_as(driver: Firefox):
     ba.key_press_release(Key.enter)
 
     # Wait for the animation to complete
-    with driver.context(driver.CONTEXT_CHROME):
-        nav.wait_for_download_animation_finish(downloads_button)
+    nav.wait_for_download_animation_finish(downloads_button)
 
     saved_image_location = util.get_saved_file_path("Firefox_logo,_2019.svg.png")
 
@@ -111,6 +106,7 @@ def test_copy_image_link(driver: Firefox):
     """
     C2637622.3: copy an image link and verify its correct
     """
+    # create objs
     nav = Navigation(driver).open()
     wiki_image_page = WikiFirefoxLogo(driver).open()
     image_context_menu = ImageContextMenu(driver)
@@ -124,12 +120,11 @@ def test_copy_image_link(driver: Firefox):
     wiki_image_page.context_click_element(image_logo)
 
     # copy the link
-    with driver.context(driver.CONTEXT_CHROME):
-        copy_image_link = image_context_menu.get_context_item(
-            "context-menu-copy-image-link"
-        )
-        copy_image_link.click()
-        wiki_image_page.hide_popup_by_child_node(copy_image_link)
+    copy_image_link = image_context_menu.get_context_item(
+        "context-menu-copy-image-link"
+    )
+    image_context_menu.click_context_item(copy_image_link)
+    wiki_image_page.hide_popup_by_child_node(copy_image_link, chrome=True)
 
     # open a new tab
     tabs.new_tab_by_button()