Merge pull request #133 from mozilla/sl/third-party-private-browsing

Third Party Content Private Browsing

Author: sarinali

modules/browser_object.py

@@ -10,3 +10,4 @@
 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_tracker_panel import *

modules/browser_object_navigation.py

@@ -183,3 +183,11 @@ def wait_for_download_animation_finish(
                 )
             except TimeoutException:
                 logging.warning("Animation did not finish or did not play.")
+
+    def open_tracker_panel(self) -> BasePage:
+        """
+        Clicks the shield icon and opens the panel associated with it
+        """
+        # self.set_chrome_context()
+        self.get_element("shield-icon").click()
+        return self

modules/browser_object_tracker_panel.py

@@ -0,0 +1,73 @@
+import logging
+from typing import List
+
+from selenium.common.exceptions import TimeoutException
+from selenium.webdriver.remote.webelement import WebElement
+
+from modules.browser_object_navigation import Navigation
+from modules.page_base import BasePage
+
+
+class TrackerPanel(BasePage):
+    """
+    BOM for the panel that shows up after clicking the shield
+    """
+
+    URL_TEMPLATE = ""
+
+    def wait_for_blocked_tracking_icon(
+        self, nav: Navigation, page: BasePage
+    ) -> BasePage:
+        """
+        Waits for the shield icon to indicate that cookies/trackers are being blocked by continuously refresing the page
+
+        Remember to open the passed in page beforehand, this waits for the page to load.
+
+        Example Usage:
+        first_tracker_website.open()
+        tracker_panel.wait_for_blocked_tracking_icon(nav, first_tracker_website)
+        """
+
+        def shield_active() -> bool:
+            nav.get_element("refresh-button").click()
+            with self.driver.context(self.driver.CONTEXT_CONTENT):
+                page.open()
+                page.wait_for_page_to_load()
+            shield_icon = self.get_element("shield-icon")
+            if (
+                shield_icon.get_attribute("data-l10n-id")
+                == "tracking-protection-icon-active-container"
+            ):
+                return True
+            return False
+
+        try:
+            with self.driver.context(self.context_id):
+                self.wait.until(lambda _: shield_active())
+        except TimeoutException:
+            logging.warning(
+                "The shield icon was not active after refreshing mulitple times, the test has timed out."
+            )
+        return self
+
+    def verify_tracker_shield_indicator(self, nav: Navigation) -> BasePage:
+        """
+        Verifies that the shield icon is in the correct mode
+        """
+        with self.driver.context(self.context_id):
+            shield_icon = self.get_element("shield-icon")
+            assert (
+                shield_icon.get_attribute("data-l10n-id")
+                == "tracking-protection-icon-active-container"
+            ), "The label detected did not correspond to the expected one: tracking-protection-icon-active-container"
+        return self
+
+    def open_and_return_cross_site_trackers(self) -> List[WebElement]:
+        with self.driver.context(self.context_id):
+            self.get_element("tracker-cross-site-tracking").click()
+            return self.get_elements("tracking-cross-site-tracking-item")
+
+    def open_and_return_allowed_trackers(self) -> List[WebElement]:
+        with self.driver.context(self.context_id):
+            self.get_element("tracker-tracking-content").click()
+            return self.get_elements("tracking-allowed-content-item")

modules/data/generic_page.components.json

@@ -33,5 +33,23 @@
         "selectorData": "button[class='cdx-button cdx-button--action-default cdx-button--weight-normal cdx-button--size-medium cdx-button--framed cdx-search-input__end-button']",
         "strategy": "css",
         "groups": []
+    },
+
+    "simulated-tracker-block-status": {
+        "selectorData": "blacklisted-blocked",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "simulated-tracker-load-status": {
+        "selectorData": "whitelisted-loaded",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "simulated-tracker-dnt-status": {
+        "selectorData": "dnt-on",
+        "strategy": "id",
+        "groups": []
     }
 }

modules/data/navigation.components.json

@@ -189,7 +189,9 @@
     "shield-icon": {
         "selectorData": "tracking-protection-icon-container",
         "strategy": "id",
-        "groups": []
+        "groups": [
+            "doNotCache"
+        ]
     },
 
     "cryptominers": {
@@ -232,5 +234,13 @@
         "selectorData": ".urlbarView-action",
         "strategy": "css",
         "groups": []
+    },
+
+    "refresh-button": {
+        "selectorData": "reload-button",
+        "strategy": "id",
+        "groups": [
+            "doNotCache"
+        ]
     }
 }

modules/data/tracker_panel.components.json

@@ -0,0 +1,65 @@
+{
+    "context": "chrome",
+    "tracker-title": {
+        "selectorData": "protections-popup-mainView-panel-header-span",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "tracker-cross-site-tracking": {
+        "selectorData": "protections-popup-category-cookies",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "tracker-tracking-content": {
+        "selectorData": "protections-popup-category-trackers",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "tracking-social-media": {
+        "selectorData": "protections-popup-category-socialblock",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "tracking-finger-prints": {
+        "selectorData": "protections-popup-category-fingerprinters",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "tracking-crypto-miners": {
+        "selectorData": "protections-popup-category-cryptominers",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "tracking-cross-site-tracking-items": {
+        "selectorData": "vbox[class='protections-popup-cookiesView-list-section']",
+        "strategy": "css",
+        "groups": []
+    },
+
+    "tracking-cross-site-tracking-item": {
+        "selectorData": "protections-popup-list-host-label",
+        "strategy": "class",
+        "groups": []
+    },
+
+    "tracking-allowed-content-item": {
+        "selectorData": "protections-popup-list-host-label",
+        "strategy": "class",
+        "groups": []
+    },
+
+    "shield-icon": {
+        "selectorData": "tracking-protection-icon-container",
+        "strategy": "id",
+        "groups": [
+            "doNotCache",
+            "requiredForPage"
+        ]
+    }
+}

modules/page_object_autofill_login.py

@@ -1,5 +1,3 @@
-from selenium.webdriver import Firefox
-
 from modules.page_object_autofill import Autofill
 
 

taskcluster/kinds/run-smoke-tests/kind.yml

@@ -24,4 +24,4 @@ tasks:
         ./collect_executables.sh;
         mv ./ci_pyproject.toml ./pyproject.toml;
         pipenv install;
-        pipenv run pytest --fx-executable ./firefox/firefox -n 4 .
+        pipenv run pytest --fx-executable ./firefox/firefox -n 4 .

tests/security_and_privacy/test_third_party_content_blocked_private_browsing.py

@@ -0,0 +1,127 @@
+from selenium.webdriver import Firefox
+
+from modules.browser_object import Navigation, PanelUi, TrackerPanel
+from modules.page_object import GenericPage
+
+ALLOWED_TRACKING_URLS = set(
+    [
+        "https://content-track-digest256.dummytracker.org",
+        "https://ads-track-digest256.dummytracker.org",
+        "https://social-track-digest256.dummytracker.org",
+        "https://analytics-track-digest256.dummytracker.org",
+    ]
+)
+BLOCKED_TRACKER_URL = "https://content-track-digest256.dummytracker.org"
+
+FIRST_TRACKER_WEBSITE = "https://senglehardt.com/test/trackingprotection/test_pages/tracking_protection.html"
+SECOND_TRACKER_WEBSITE = "https://www.itisatrap.org/firefox/its-a-tracker.html"
+
+
+def test_third_party_content_blocked_private_browsing_cross_site(driver: Firefox):
+    """
+    C446323.1: Ensure that third party content is blocked correctly
+    """
+    # instantiate objects
+    panel_ui = PanelUi(driver).open()
+    nav = Navigation(driver)
+    tracker_panel = TrackerPanel(driver)
+    tracker_website = GenericPage(driver, url=FIRST_TRACKER_WEBSITE)
+
+    # open the new window
+    panel_ui.open_private_window()
+    nav.switch_to_new_window()
+
+    # open the website, ensure the blocking is taking place by continuously refreshing website until indicated
+    tracker_website.open()
+    tracker_panel.wait_for_blocked_tracking_icon(nav, tracker_website)
+
+    # verify the indicator
+    driver.set_context(driver.CONTEXT_CHROME)
+    tracker_panel.verify_tracker_shield_indicator(nav)
+    nav.open_tracker_panel()
+
+    # verify the panel title
+    tracker_panel_title = tracker_panel.get_element("tracker-title")
+    assert (
+        tracker_panel_title.get_attribute("innerHTML")
+        == "Protections for senglehardt.com"
+    )
+
+    # fetch the items in the cross site trackers
+    cross_site_trackers = tracker_panel.open_and_return_cross_site_trackers()
+
+    # ensure that the correct blocked site is listed
+    found_tracker = False
+    for item in cross_site_trackers:
+        if item.get_attribute("value") == BLOCKED_TRACKER_URL:
+            found_tracker = True
+    assert found_tracker
+
+
+def test_third_party_content_blocked_private_browsing_allowed_tracking(driver: Firefox):
+    """
+    C446323.2: Ensure that some third party content is allowed
+    """
+    # instantiate objects
+    panel_ui = PanelUi(driver).open()
+    nav = Navigation(driver)
+    tracker_panel = TrackerPanel(driver)
+    tracker_website = GenericPage(driver, url=FIRST_TRACKER_WEBSITE)
+
+    # open a private window
+    panel_ui.open_private_window()
+    nav.switch_to_new_window()
+
+    # open the website, ensure the blocking is taking place by continuously refreshing website until indicated
+    tracker_website.open()
+    tracker_panel.wait_for_blocked_tracking_icon(nav, tracker_website)
+
+    # verify the indicator
+    driver.set_context(driver.CONTEXT_CHROME)
+    tracker_panel.verify_tracker_shield_indicator(nav)
+
+    # open the panel and verify the title
+    nav.open_tracker_panel()
+    tracker_panel_title = tracker_panel.get_element("tracker-title")
+    assert (
+        tracker_panel_title.get_attribute("innerHTML")
+        == "Protections for senglehardt.com"
+    )
+
+    # fetch allowed trackers
+    allowed_trackers = tracker_panel.open_and_return_allowed_trackers()
+
+    # verify the correct ones are allowed
+    for item in allowed_trackers:
+        assert item.get_attribute("value") in ALLOWED_TRACKING_URLS
+
+
+def test_third_party_content_private_browsing_tracking_statuses(driver: Firefox):
+    """
+    C446323.3: Ensure that the statuses of some third party content are loaded properly
+    """
+    # instantiate objects
+    panel_ui = PanelUi(driver).open()
+    nav = Navigation(driver)
+    tracker_panel = TrackerPanel(driver)
+    tracker_website = GenericPage(driver, url=SECOND_TRACKER_WEBSITE)
+
+    # open a private window
+    panel_ui.open_private_window()
+    nav.switch_to_new_window()
+
+    # open the tracker website
+    tracker_website.open()
+    tracker_panel.wait_for_blocked_tracking_icon(nav, tracker_website)
+
+    # verify the indicator
+    tracker_panel.verify_tracker_shield_indicator(nav)
+
+    # assert all of the various statuses, ensure that the correct one is displayed
+    block_status = tracker_website.get_element("simulated-tracker-block-status")
+    load_status = tracker_website.get_element("simulated-tracker-load-status")
+    dnt_status = tracker_website.get_element("simulated-tracker-dnt-status")
+
+    assert "hidden" not in block_status.get_attribute("class")
+    assert "hidden" not in load_status.get_attribute("class")
+    assert "hidden" not in dnt_status.get_attribute("class")