Bc/private downloads (#142)

ben-c-at-moz · web-flow · commit 4107aa03094f · 2024-07-29T13:57:25.000-07:00
* beginning of test

* beginning of test

* add toolbar check

* almost there, context menu won't close

* close the context menu

* close the context menu

* close the context menu

* actually check downloads context menu options

* delete files after test

* fix download remover

* check geckodriver version

* doorhanger test unstable

* remove alert function - it's not good

* fix bad window switch

* screenshot non-empty downloads

* stop failing on about:downloads not empty, but log
diff --git a/collect_executables.sh b/collect_executables.sh
@@ -105,6 +105,7 @@ do
     sleep 0.2
 done
 chmod +x geckodriver
+./geckodriver --version
 
 if [[ $SYSTEM_NAME == "linux" ]]
 then
diff --git a/modules/browser_object.py b/modules/browser_object.py
@@ -1,3 +1,4 @@
+from modules.browser_object_about_downloads_context_menu import *
 from modules.browser_object_about_prefs_cc_popup import *
 from modules.browser_object_autofill_popup import *
 from modules.browser_object_credit_card_popup import *
@@ -10,4 +11,5 @@
 from modules.browser_object_search_bar_context_menu import *
 from modules.browser_object_tab_context_menu import *
 from modules.browser_object_tabbar import *
+from modules.browser_object_toolbar import *
 from modules.browser_object_tracker_panel import *
diff --git a/modules/browser_object_about_downloads_context_menu.py b/modules/browser_object_about_downloads_context_menu.py
@@ -0,0 +1,19 @@
+import logging
+
+from modules.browser_object_context_menu import ContextMenu
+
+
+class AboutDownloadsContextMenu(ContextMenu):
+    """
+    Browser object model for the context menu for right clicking a download in About:Downloads
+    """
+
+    def has_all_options_available(self) -> ContextMenu:
+        """Timeout unless all items labeled downloadOption are present, else return self"""
+        with self.driver.context(self.context_id):
+            for elname in [
+                k for k, v in self.elements.items() if "downloadOption" in v["groups"]
+            ]:
+                logging.info(f"elname {elname}")
+                self.element_exists(elname)
+        return self
diff --git a/modules/browser_object_toolbar.py b/modules/browser_object_toolbar.py
@@ -0,0 +1,33 @@
+from time import sleep
+
+from selenium.webdriver.support import expected_conditions as EC
+
+from modules.page_base import BasePage
+
+
+class Toolbar(BasePage):
+    """BOM for the toolbar, other than the awesome bar and the panel UI"""
+
+    URL_TEMPLATE = ""
+
+    def wait_for_item_to_download(self, filename: str) -> BasePage:
+        """Check the downloads tool in the toolbar to wait for a given file to download"""
+        original_timeout = self.driver.timeouts.implicit_wait
+        try:
+            # Whatever our timeout, we want to lengthen it because downloads
+            self.driver.implicitly_wait(original_timeout * 2)
+            self.element_visible("downloads-item-by-file", labels=[filename])
+            self.expect_not(
+                EC.element_attribute_to_include(
+                    self.get_selector("downloads-button"), "animate"
+                )
+            )
+            with self.driver.context(self.context_id):
+                self.driver.execute_script(
+                    "arguments[0].setAttribute('hidden', true)",
+                    self.get_element("downloads-button"),
+                )
+        finally:
+            self.driver.implicitly_wait(original_timeout)
+
+        return self
diff --git a/modules/data/about_downloads.components.json b/modules/data/about_downloads.components.json
@@ -0,0 +1,13 @@
+{
+    "no-downloads-label": {
+        "selectorData": "downloadsListEmptyDescription",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "download-target": {
+        "selectorData": "downloadTarget",
+        "strategy": "class",
+        "groups": []
+    }
+}
diff --git a/modules/data/about_downloads_context_menu.components.json b/modules/data/about_downloads_context_menu.components.json
@@ -0,0 +1,76 @@
+{
+    "context": "chrome",
+    "do-not-cache": true,
+    "downloads-panel": {
+        "selectorData": "downloadsPanel",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "menu-root": {
+        "selectorData": "downloadsContextMenu",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "open-in-system-viewer": {
+        "selectorData": "downloadUseSystemDefaultMenuItem",
+        "strategy": "class",
+        "groups": [
+        ]
+    },
+
+    "always-open-in-system-viewer": {
+        "selectorData": "downloadAlwaysUseSystemDefaultMenuItem",
+        "strategy": "class",
+        "groups": [
+        ]
+    },
+
+    "show-in-file-browser": {
+        "selectorData": "downloadShowMenuItem",
+        "strategy": "class",
+        "groups": [
+        ]
+    },
+
+    "go-to-download-page": {
+        "selectorData": "downloadOpenReferrerMenuItem",
+        "strategy": "class",
+        "groups": [
+            "downloadOption"
+        ]
+    },
+
+    "copy-download-link": {
+        "selectorData": "downloadCopyLocationMenuItem",
+        "strategy": "class",
+        "groups": [
+            "downloadOption"
+        ]
+    },
+
+    "delete": {
+        "selectorData": "downloadDeleteFileMenuItem",
+        "strategy": "class",
+        "groups": [
+            "downloadOption"
+        ]
+    },
+
+    "remove-from-history": {
+        "selectorData": "downloadRemoveFromHistoryMenuItem",
+        "strategy": "class",
+        "groups": [
+            "downloadOption"
+        ]
+    },
+
+    "clear-downloads": {
+        "selectorData": "menuitem[data-l10n-id='downloads-cmd-clear-downloads']",
+        "strategy": "css",
+        "groups": [
+            "downloadOption"
+        ]
+    }
+}
diff --git a/modules/data/generic_page.components.json b/modules/data/generic_page.components.json
@@ -51,5 +51,11 @@
         "selectorData": "dnt-on",
         "strategy": "id",
         "groups": []
+    },
+
+    "pdf-link": {
+        "selectorData": "a[href$='.pdf']",
+        "strategy": "css",
+        "groups": []
     }
 }
diff --git a/modules/data/hyperlink_context_menu.components.json b/modules/data/hyperlink_context_menu.components.json
@@ -13,6 +13,12 @@
         "groups": []
     },
 
+    "context-menu-save-link": {
+        "selectorData": "context-savelink",
+        "strategy": "id",
+        "groups": []
+    },
+
     "context-menu-open-in-private-window": {
         "selectorData": "context-openlinkprivate",
         "strategy": "id",
diff --git a/modules/data/toolbar.components.json b/modules/data/toolbar.components.json
@@ -0,0 +1,22 @@
+{
+    "context": "chrome",
+    "do-not-cache": true,
+
+    "downloads-button": {
+        "selectorData": "downloads-button",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "downloads-item-by-file": {
+        "selectorData": ".downloadMainArea image[src*='{filename}']",
+        "strategy": "css",
+        "groups": []
+    },
+
+    "blank-space-to-left": {
+        "selectorData": "customizableui-special-spring1",
+        "strategy": "id",
+        "groups": []
+    }
+}
diff --git a/modules/page_base.py b/modules/page_base.py
@@ -8,7 +8,11 @@
 from typing import List, Union
 
 from pypom import Page
-from selenium.common.exceptions import NoSuchElementException, TimeoutException
+from selenium.common.exceptions import (
+    NoAlertPresentException,
+    NoSuchElementException,
+    TimeoutException,
+)
 from selenium.webdriver import ActionChains, Firefox
 from selenium.webdriver.common.by import By
 from selenium.webdriver.common.keys import Keys
@@ -330,12 +334,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:
+    def get_parent_of(
+        self, reference: Union[str, tuple, WebElement], labels=[]
+    ) -> WebElement:
         """
-        Given a name (and labels if needed), return the direct parent node of the element.
+        Given a name + labels, a WebElement, or a tuple, return the direct parent node of the element.
         """
 
-        child = self.get_element(name, labels=labels)
+        child = self.fetch(reference, labels=labels)
         return child.find_element(By.XPATH, "..")
 
     def element_exists(self, name: str, labels=[]) -> Page:
@@ -386,6 +392,13 @@ def element_has_text(self, name: str, text: str, labels=[]) -> Page:
         )
         return self
 
+    def element_not_visible(self, name: str, labels=[]) -> Page:
+        """Expect helper: wait until element is not visible or timeout"""
+        self.expect_not(
+            EC.visibility_of_element_located(self.get_selector(name, labels=labels))
+        )
+        return self
+
     def url_contains(self, url_part: str) -> Page:
         """Expect helper: wait until driver URL contains given text or timeout"""
         self.expect(EC.url_contains(url_part))
@@ -616,8 +629,7 @@ def hide_popup_by_child_node(
                  if (element && element.hidePopup) {
                     element.hidePopup();
                  }"""
-        with self.driver.context(self.context_id):
-            self.driver.execute_script(script, node)
+        self.driver.execute_script(script, node)
 
     @property
     def loaded(self):
diff --git a/modules/page_object.py b/modules/page_object.py
@@ -1,5 +1,6 @@
 from modules.page_object_about_addons import *
 from modules.page_object_about_config import *
+from modules.page_object_about_downloads import *
 from modules.page_object_about_glean import *
 from modules.page_object_about_logins import *
 from modules.page_object_about_newtab import *
diff --git a/modules/page_object_about_downloads.py b/modules/page_object_about_downloads.py
@@ -0,0 +1,32 @@
+from modules.page_base import BasePage
+
+
+class AboutDownloads(BasePage):
+    """
+    The POM for the about:downloads page
+
+    Attributes
+    ----------
+    driver: selenium.webdriver.Firefox
+        WebDriver object under test
+    """
+
+    URL_TEMPLATE = "about:downloads"
+
+    def is_empty(self) -> bool:
+        """Checks to see if downloads page is empty"""
+        found = False
+        try:
+            self.element_visible("no-downloads-label")
+            found = True
+        finally:
+            return found
+
+    def get_downloads(self) -> list:
+        """Get all download targets"""
+        return self.get_elements("download-target")
+
+    def wait_for_num_downloads(self, num: int) -> BasePage:
+        """Wait for the number of downloads to equal num"""
+        self.expect(lambda _: len(self.get_downloads()) == num)
+        return self
diff --git a/tests/security_and_privacy/test_downloads_from_private_not_leaked.py b/tests/security_and_privacy/test_downloads_from_private_not_leaked.py
diff --git a/tests/security_and_privacy/test_private_browser_password_doorhanger.py b/tests/security_and_privacy/test_private_browser_password_doorhanger.py

Original file line number	Diff line number	Diff line change
`@@ -51,5 +51,11 @@`
`51`	`51`	`"selectorData": "dnt-on",`
`52`	`52`	`"strategy": "id",`
`53`	`53`	`"groups": []`
	`54`	`+ },`
	`55`	`+`
	`56`	`+ "pdf-link": {`
	`57`	`+ "selectorData": "a[href$='.pdf']",`
	`58`	`+ "strategy": "css",`
	`59`	`+ "groups": []`
`54`	`60`	`}`
`55`	`61`	`}`