| 1 |
#!/usr/bin/env python |
| 2 |
|
| 3 |
import unittest |
| 4 |
|
| 5 |
import pbtest |
| 6 |
|
| 7 |
from selenium.webdriver.support import expected_conditions as EC |
| 8 |
from selenium.webdriver.support.ui import WebDriverWait |
| 9 |
|
| 10 |
|
| 11 |
class ServiceWorkersTest(pbtest.PBSeleniumTest): |
| 12 |
"""Verifies interaction with sites that use Service Worker caches""" |
| 13 |
|
| 14 |
FIXTURE_URL = ( |
| 15 |
"https://efforg.github.io/privacybadger-test-fixtures/html/" |
| 16 |
"service_workers.html" |
| 17 |
) |
| 18 |
FIXTURE_HOST = "efforg.github.io" |
| 19 |
THIRD_PARTY_HOST = "privacybadger-tests.eff.org" |
| 20 |
|
| 21 |
def get_first_tab_data(self): |
| 22 |
"""Returns the top-level document's URL/host for the first tab.""" |
| 23 |
tab_data = self.driver.execute_async_script( |
| 24 |
"let done = arguments[arguments.length - 1];" |
| 25 |
"chrome.runtime.sendMessage({ type: 'getTabData' }, tabData => {" |
| 26 |
" let min_tab_id = Math.min(...Object.keys(tabData));" |
| 27 |
" done(tabData[min_tab_id].frames[0]);" |
| 28 |
"});") |
| 29 |
return tab_data |
| 30 |
|
| 31 |
def init_sw_page(self): |
| 32 |
# visit the Service Worker page to activate the worker |
| 33 |
self.load_url(self.FIXTURE_URL) |
| 34 |
|
| 35 |
# Service Workers are off by default in Firefox 60 ESR |
| 36 |
if not self.js("return 'serviceWorker' in navigator;"): |
| 37 |
self.skipTest("Service Workers are disabled") |
| 38 |
|
| 39 |
# wait for the worker to initialize its cache |
| 40 |
self.wait_for_script("return window.WORKER_READY;") |
| 41 |
|
| 42 |
# visit a different site (doesn't matter what it is, |
| 43 |
# just needs to be an http site with a different domain) |
| 44 |
self.load_url("https://dnt-test.trackersimulator.org/") |
| 45 |
|
| 46 |
def test_returning_to_sw_cached_page(self): |
| 47 |
self.init_sw_page() |
| 48 |
|
| 49 |
# return to the SW page |
| 50 |
self.driver.back() |
| 51 |
|
| 52 |
# open new window (to avoid clearing badger.tabData) and verify results |
| 53 |
self.open_window() |
| 54 |
self.load_url(self.options_url) |
| 55 |
tab_data = self.get_first_tab_data() |
| 56 |
assert tab_data['host'] == self.FIXTURE_HOST, ( |
| 57 |
"Unexpected first-tab hostname in tabData") |
| 58 |
|
| 59 |
def test_redirect_to_sw_cached_page(self): |
| 60 |
self.init_sw_page() |
| 61 |
|
| 62 |
# visit a page that 302-redirects back to our fixture |
| 63 |
self.load_url("https://www.eff.org/privacy-badger-service-workers-navigation-test-redirect") |
| 64 |
|
| 65 |
# wait for URL to change |
| 66 |
WebDriverWait(self.driver, 10).until(EC.url_to_be(self.FIXTURE_URL)) |
| 67 |
|
| 68 |
# open new window (to avoid clearing badger.tabData) and verify results |
| 69 |
self.open_window() |
| 70 |
self.load_url(self.options_url) |
| 71 |
tab_data = self.get_first_tab_data() |
| 72 |
assert tab_data['url'] == self.FIXTURE_URL, ( |
| 73 |
"Unexpected first-tab URL in tabData") |
| 74 |
|
| 75 |
def test_blocking_sw_initiated_requests(self): |
| 76 |
self.clear_tracker_data() |
| 77 |
self.block_domain(self.THIRD_PARTY_HOST) |
| 78 |
|
| 79 |
self.init_sw_page() |
| 80 |
|
| 81 |
self.load_url(self.FIXTURE_URL) |
| 82 |
|
| 83 |
# check what happened |
| 84 |
selector = '#third-party-load-result' |
| 85 |
self.wait_for_script( |
| 86 |
"return document.querySelector(arguments[0]).textContent", |
| 87 |
selector) |
| 88 |
assert self.find_el_by_css(selector).text == "error", ( |
| 89 |
"third-party should have gotten blocked") |
| 90 |
|
| 91 |
# also check the popup |
| 92 |
self.open_popup(self.FIXTURE_URL) |
| 93 |
sliders = self.get_tracker_state() |
| 94 |
assert self.THIRD_PARTY_HOST in sliders['blocked'], ( |
| 95 |
"third-party should be reported as blocked") |
| 96 |
|
| 97 |
def test_disabling_on_site(self): |
| 98 |
self.clear_tracker_data() |
| 99 |
self.block_domain(self.THIRD_PARTY_HOST) |
| 100 |
|
| 101 |
self.init_sw_page() |
| 102 |
|
| 103 |
self.disable_badger_on_site(self.FIXTURE_HOST) |
| 104 |
|
| 105 |
self.load_url(self.FIXTURE_URL) |
| 106 |
|
| 107 |
# check what happened |
| 108 |
selector = '#third-party-load-result' |
| 109 |
self.wait_for_script( |
| 110 |
"return document.querySelector(arguments[0]).textContent", |
| 111 |
selector) |
| 112 |
assert self.find_el_by_css(selector).text == "success", ( |
| 113 |
"third-party should have been allowed to load") |
| 114 |
|
| 115 |
|
| 116 |
if __name__ == "__main__": |
| 117 |
unittest.main() |