Debian Codegraph @

tests/selenium/widgets_test.py

raw
1 #!/usr/bin/env python
2
3 import unittest
4
5 import pbtest
6
7 from time import sleep
8
9 from selenium.webdriver.common.by import By
10 from selenium.common.exceptions import (
11 NoSuchElementException,
12 StaleElementReferenceException,
13 TimeoutException
14 )
15 from selenium.webdriver.common.keys import Keys
16 from selenium.webdriver.support.ui import Select
17
18
19 class WidgetsTest(pbtest.PBSeleniumTest):
20
21 FIXTURES_URL = "https://efforg.github.io/privacybadger-test-fixtures/html/"
22 FIXTURES_HOST = "efforg.github.io"
23 BASIC_FIXTURE_URL = FIXTURES_URL + "widget_basic.html"
24 DYNAMIC_FIXTURE_URL = FIXTURES_URL + "widget_dynamic.html"
25 THIRD_PARTY_DOMAIN = "privacybadger-tests.eff.org"
26 TYPE3_WIDGET_NAME = "Type 3 Widget"
27 TYPE4_WIDGET_NAME = "Type 4 Widget"
28 TYPE4_WIDGET_CLASS = "pb-type4-test-widget"
29
30 def setUp(self):
31 self.set_up_widgets()
32
33 def set_up_widgets(self):
34 """Reinitializes Privacy Badger's widget replacement definitions."""
35
36 widgetsJson = {
37 self.TYPE3_WIDGET_NAME: {
38 "domain": self.THIRD_PARTY_DOMAIN,
39 "buttonSelectors": [
40 "iframe#pb-type3-test-widget"
41 ],
42 "replacementButton": {
43 "unblockDomains": [
44 self.THIRD_PARTY_DOMAIN
45 ],
46 "type": 3
47 }
48 },
49 self.TYPE4_WIDGET_NAME: {
50 "domains": [
51 self.THIRD_PARTY_DOMAIN
52 ],
53 "buttonSelectors": [
54 "div." + self.TYPE4_WIDGET_CLASS
55 ],
56 "scriptSelectors": [
57 "script." + self.TYPE4_WIDGET_CLASS
58 ],
59 "replacementButton": {
60 "unblockDomains": [
61 self.THIRD_PARTY_DOMAIN
62 ],
63 "type": 4
64 }
65 }
66 }
67
68 # reinitialize widgets using above JSON
69 self.load_url(self.options_url)
70 self.driver.execute_async_script((
71 "let done = arguments[arguments.length - 1];"
72 "(async function (widgetsJson) {"
73 " const { default: widgetLoader } = await import('../js/socialwidgetloader.js');"
74 " chrome.runtime.sendMessage({"
75 " type: 'setWidgetList',"
76 " value: widgetLoader.initializeWidgets(widgetsJson)"
77 " }, done);"
78 "}(arguments[0]));"
79 ), widgetsJson)
80
81 def switch_to_frame(self, selector):
82 self.wait_for_and_switch_to_frame(selector, timeout=1)
83
84 def assert_widget(self, kind="type3"):
85 if kind == "type3":
86 self._assert_type3_widget()
87 elif kind == "type4":
88 self._assert_type4_widget()
89 else:
90 self.fail("Unknown widget type")
91
92 def _assert_type3_widget(self):
93 try:
94 self.switch_to_frame('iframe[src]')
95 except (StaleElementReferenceException, TimeoutException):
96 self.fail("Unable to find widget frame")
97
98 try:
99 self.wait_for_text('body', "Hello world!")
100 except TimeoutException:
101 self.fail("Unable to find expected widget text")
102
103 self.driver.switch_to.default_content()
104
105 def _assert_type4_widget(self):
106 try:
107 self.wait_for_text('div.' + self.TYPE4_WIDGET_CLASS,
108 "A third-party widget script was here")
109 except TimeoutException:
110 self.fail("Unable to find expected widget output")
111
112 def assert_replacement(self, widget_name=None):
113 if not widget_name:
114 widget_name = self.TYPE3_WIDGET_NAME
115
116 try:
117 self.switch_to_frame(f'iframe[srcdoc*="{widget_name}"]')
118 except (StaleElementReferenceException, TimeoutException):
119 self.fail("Unable to find widget placeholder frame")
120
121 try:
122 self.find_el_by_css("button[id^='btn-once-']")
123 self.find_el_by_css("button[id^='btn-site-']")
124 except TimeoutException:
125 self.fail("Unable to find expected widget placeholder buttons")
126
127 self.driver.switch_to.default_content()
128
129 def assert_widget_blocked(self):
130 try:
131 self.switch_to_frame('iframe[src]')
132 except TimeoutException:
133 self.fail("Widget frame should still be here")
134
135 frame_text = self.txt_by_css('body')
136 # TODO doesn't work in non-English locales
137 if frame_text != "This page has been blocked by an extension":
138 assert not frame_text, "Widget frame should be empty"
139
140 self.driver.switch_to.default_content()
141
142 def assert_no_widget(self):
143 try:
144 self.switch_to_frame('iframe[src]')
145 self.fail("Widget frame should be missing")
146 except TimeoutException:
147 pass
148 self.driver.switch_to.default_content()
149
150 def assert_no_replacement(self, widget_name=None):
151 if not widget_name:
152 widget_name = self.TYPE3_WIDGET_NAME
153 try:
154 self.switch_to_frame(f'iframe[srcdoc*="{widget_name}"]')
155 self.fail("Widget placeholder frame should be missing")
156 except TimeoutException:
157 pass
158 self.driver.switch_to.default_content()
159
160 def activate_widget(self, widget_name=None, once=True):
161 if not widget_name:
162 widget_name = self.TYPE3_WIDGET_NAME
163 id_prefix = 'btn-once' if once else 'btn-site'
164 self.switch_to_frame(f'iframe[srcdoc*="{widget_name}"]')
165 self.find_el_by_css(f"button[id^='{id_prefix}']").click()
166 self.driver.switch_to.default_content()
167 # wait a bit for the widget to get reinserted
168 sleep(1)
169
170 def test_replacement_basic(self):
171 # visit the basic widget fixture
172 self.load_url(self.BASIC_FIXTURE_URL)
173 # verify the widget is present
174 self.assert_widget()
175
176 # block the test widget's domain
177 self.block_domain(self.THIRD_PARTY_DOMAIN)
178
179 # revisit the fixture
180 self.load_url(self.BASIC_FIXTURE_URL)
181 # verify the widget got replaced
182 self.assert_replacement()
183
184 def test_replacement_dynamic(self):
185 # visit the dynamic widget fixture
186 self.load_url(self.DYNAMIC_FIXTURE_URL)
187 # verify the widget is initially missing
188 self.assert_no_widget()
189
190 # verify the widget shows up once you click on the trigger element
191 self.find_el_by_css('#widget-trigger').click()
192 self.assert_widget()
193
194 # block the test widget's domain
195 self.block_domain(self.THIRD_PARTY_DOMAIN)
196
197 # revisit the fixture
198 self.load_url(self.DYNAMIC_FIXTURE_URL)
199 # click on the trigger element
200 self.find_el_by_css('#widget-trigger').click()
201 # verify the widget got replaced
202 self.assert_replacement()
203
204 def test_activation(self):
205 self.block_domain(self.THIRD_PARTY_DOMAIN)
206 self.load_url(self.BASIC_FIXTURE_URL)
207 self.assert_replacement()
208
209 # click the "allow once" button
210 self.activate_widget()
211
212 # verify the original widget is restored
213 self.assert_widget()
214
215 # verify the type 4 widget is still replaced
216 try:
217 self.driver.find_element(By.CSS_SELECTOR,
218 'div.' + self.TYPE4_WIDGET_CLASS)
219 self.fail("Widget output container div should be missing")
220 except NoSuchElementException:
221 pass
222 self.assert_replacement(self.TYPE4_WIDGET_NAME)
223
224 self.activate_widget(self.TYPE4_WIDGET_NAME)
225
226 # assert all script attributes were copied
227 script_el = self.driver.find_element(By.CSS_SELECTOR,
228 'script.' + self.TYPE4_WIDGET_CLASS)
229 assert script_el.get_dom_attribute('async') == "true"
230 assert script_el.get_dom_attribute('data-foo') == "bar"
231
232 self.assert_widget("type4")
233
234 def test_activation_site(self):
235 self.block_domain(self.THIRD_PARTY_DOMAIN)
236 self.load_url(self.BASIC_FIXTURE_URL)
237 self.assert_replacement()
238
239 # click the "allow once" button
240 self.activate_widget()
241
242 # verify the original widget is restored
243 self.assert_widget()
244
245 # open a new window (to get around widget activation caching)
246 self.open_window()
247 self.load_url(self.BASIC_FIXTURE_URL)
248
249 # verify the widget got replaced
250 self.assert_replacement()
251
252 # click the "allow on site" button
253 self.activate_widget(once=False)
254
255 # verify the original widget is restored
256 self.assert_widget()
257
258 # open a new window (to get around widget activation caching)
259 self.open_window()
260 self.load_url(self.BASIC_FIXTURE_URL)
261
262 # verify basic widget is neither replaced nor blocked
263 self.assert_no_replacement()
264 self.assert_widget()
265
266 # remove the site exception
267 self.load_url(self.options_url)
268 self.wait_for_script("return window.OPTIONS_INITIALIZED")
269 self.find_el_by_css('a[href="#tab-manage-widgets"]').click()
270 select = Select(self.driver.find_element(By.ID, 'widget-site-exceptions-select'))
271 select.select_by_value(self.FIXTURES_HOST)
272 self.driver.find_element(By.ID, 'widget-site-exceptions-remove-button').click()
273
274 # verify basic widget is replaced again
275 self.open_window()
276 self.load_url(self.BASIC_FIXTURE_URL)
277 self.assert_replacement()
278
279 def test_disabling_site(self):
280 self.block_domain(self.THIRD_PARTY_DOMAIN)
281
282 self.disable_badger_on_site(self.BASIC_FIXTURE_URL)
283
284 # verify basic widget is neither replaced nor blocked
285 self.load_url(self.BASIC_FIXTURE_URL)
286 self.assert_no_replacement()
287 self.assert_widget()
288 # type 4 replacement should also be missing
289 self.assert_no_replacement(self.TYPE4_WIDGET_NAME)
290 # while the type 4 widget script should have executed
291 self.assert_widget("type4")
292
293 # verify dynamic widget is neither replaced nor blocked
294 self.load_url(self.DYNAMIC_FIXTURE_URL)
295 self.find_el_by_css('#widget-trigger').click()
296 self.assert_no_replacement()
297 self.assert_widget()
298
299 def test_disabling_replacement_for_one_widget(self):
300 self.block_domain(self.THIRD_PARTY_DOMAIN)
301
302 # add the widget to the list of exceptions
303 self.load_url(self.options_url)
304 self.wait_for_script("return window.OPTIONS_INITIALIZED")
305 self.find_el_by_css('a[href="#tab-manage-widgets"]').click()
306 self.find_el_by_css('input[type="search"]').send_keys(
307 self.TYPE3_WIDGET_NAME, Keys.ENTER)
308
309 # verify basic widget is no longer replaced
310 self.load_url(self.BASIC_FIXTURE_URL)
311 self.assert_no_replacement()
312 self.assert_widget_blocked()
313 # verify the type 4 widget is still replaced
314 self.assert_replacement(self.TYPE4_WIDGET_NAME)
315
316 # verify dynamic widget is no longer replaced
317 self.load_url(self.DYNAMIC_FIXTURE_URL)
318 self.find_el_by_css('#widget-trigger').click()
319 self.assert_no_replacement()
320 self.assert_widget_blocked()
321
322 def test_no_replacement_when_cookieblocked(self):
323 self.cookieblock_domain(self.THIRD_PARTY_DOMAIN)
324 self.load_url(self.BASIC_FIXTURE_URL)
325
326 self.assert_no_replacement()
327 self.assert_no_replacement(self.TYPE4_WIDGET_NAME)
328
329 self.assert_widget()
330 self.assert_widget("type4")
331
332
333 if __name__ == "__main__":
334 unittest.main()