1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
# Copyright 2018-2021 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
#
# This file is part of qutebrowser.
#
# qutebrowser is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# qutebrowser is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with qutebrowser. If not, see <https://www.gnu.org/licenses/>.
"""Test webenginetab."""
import logging
import textwrap
import pytest
QtWebEngineWidgets = pytest.importorskip("PyQt5.QtWebEngineWidgets")
QWebEnginePage = QtWebEngineWidgets.QWebEnginePage
QWebEngineScriptCollection = QtWebEngineWidgets.QWebEngineScriptCollection
QWebEngineScript = QtWebEngineWidgets.QWebEngineScript
from qutebrowser.browser import greasemonkey
from qutebrowser.utils import usertypes
webenginetab = pytest.importorskip(
"qutebrowser.browser.webengine.webenginetab")
pytestmark = pytest.mark.usefixtures('greasemonkey_manager')
class ScriptsHelper:
"""Helper to get the processed (usually Greasemonkey) scripts."""
def __init__(self, tab):
self._tab = tab
def get_scripts(self, prefix='GM-'):
return [
s for s in self._tab._widget.page().scripts().toList()
if s.name().startswith(prefix)
]
def get_script(self):
scripts = self.get_scripts()
assert len(scripts) == 1
return scripts[0]
def inject(self, scripts):
self._tab._scripts._inject_greasemonkey_scripts(scripts)
return self.get_scripts()
class TestWebengineScripts:
"""Test the _WebEngineScripts utility class."""
@pytest.fixture
def scripts_helper(self, webengine_tab):
return ScriptsHelper(webengine_tab)
def test_greasemonkey_undefined_world(self, scripts_helper, caplog):
"""Make sure scripts with non-existent worlds are rejected."""
scripts = [
greasemonkey.GreasemonkeyScript(
[('qute-js-world', 'Mars'), ('name', 'test')], None)
]
with caplog.at_level(logging.ERROR, 'greasemonkey'):
injected = scripts_helper.inject(scripts)
assert len(caplog.records) == 1
msg = caplog.messages[0]
assert "has invalid value for '@qute-js-world': Mars" in msg
assert not injected
@pytest.mark.parametrize("worldid", [-1, 257])
def test_greasemonkey_out_of_range_world(self, worldid, scripts_helper, caplog):
"""Make sure scripts with out-of-range worlds are rejected."""
scripts = [
greasemonkey.GreasemonkeyScript(
[('qute-js-world', worldid), ('name', 'test')], None)
]
with caplog.at_level(logging.ERROR, 'greasemonkey'):
injected = scripts_helper.inject(scripts)
assert len(caplog.records) == 1
msg = caplog.messages[0]
assert "has invalid value for '@qute-js-world': " in msg
assert "should be between 0 and" in msg
assert not injected
@pytest.mark.parametrize("worldid", [0, 10])
def test_greasemonkey_good_worlds_are_passed(self, worldid,
scripts_helper, caplog):
"""Make sure scripts with valid worlds have it set."""
scripts = [
greasemonkey.GreasemonkeyScript(
[('name', 'foo'), ('qute-js-world', worldid)], None
)
]
with caplog.at_level(logging.ERROR, 'greasemonkey'):
scripts_helper.inject(scripts)
assert scripts_helper.get_script().worldId() == worldid
def test_greasemonkey_document_end_workaround(self, monkeypatch, scripts_helper):
"""Make sure document-end is forced when needed."""
monkeypatch.setattr(greasemonkey.objects, 'backend',
usertypes.Backend.QtWebEngine)
scripts = [
greasemonkey.GreasemonkeyScript([
('name', 'Iridium'),
('namespace', 'https://github.com/ParticleCore'),
('run-at', 'document-start'),
], None)
]
scripts_helper.inject(scripts)
script = scripts_helper.get_script()
assert script.injectionPoint() == QWebEngineScript.DocumentReady
@pytest.mark.parametrize('run_at, expected', [
# UserScript::DocumentElementCreation
('document-start', QWebEngineScript.DocumentCreation),
# UserScript::DocumentLoadFinished
('document-end', QWebEngineScript.DocumentReady),
# UserScript::AfterLoad
('document-idle', QWebEngineScript.Deferred),
# default according to https://wiki.greasespot.net/Metadata_Block#.40run-at
(None, QWebEngineScript.DocumentReady),
])
def test_greasemonkey_run_at_values(self, scripts_helper, run_at, expected):
if run_at is None:
script = """
// ==UserScript==
// @name qutebrowser test userscript
// ==/UserScript==
"""
else:
script = f"""
// ==UserScript==
// @name qutebrowser test userscript
// @run-at {run_at}
// ==/UserScript==
"""
script = textwrap.dedent(script.lstrip('\n'))
scripts = [greasemonkey.GreasemonkeyScript.parse(script)]
scripts_helper.inject(scripts)
assert scripts_helper.get_script().injectionPoint() == expected
@pytest.mark.parametrize('header1, header2, expected_names', [
(
["// @namespace ns1", "// @name same"],
["// @namespace ns2", "// @name same"],
['GM-ns1/same', 'GM-ns2/same'],
),
(
["// @name same"],
["// @name same"],
['GM-same', 'GM-same-2'],
),
(
["// @name same"],
["// @name sam"],
['GM-same', 'GM-sam'],
),
])
def test_greasemonkey_duplicate_name(self, scripts_helper,
header1, header2, expected_names):
template = """
// ==UserScript==
{header}
// ==/UserScript==
"""
template = textwrap.dedent(template.lstrip('\n'))
source1 = template.format(header="\n".join(header1))
script1 = greasemonkey.GreasemonkeyScript.parse(source1)
source2 = template.format(header="\n".join(header2))
script2 = greasemonkey.GreasemonkeyScript.parse(source2)
scripts_helper.inject([script1, script2])
names = [script.name() for script in scripts_helper.get_scripts()]
assert names == expected_names
source3 = textwrap.dedent(template.lstrip('\n')).format(header="// @name other")
script3 = greasemonkey.GreasemonkeyScript.parse(source3)
scripts_helper.inject([script3])
def test_notification_permission_workaround():
"""Make sure the value for QWebEnginePage::Notifications is correct."""
try:
notifications = QWebEnginePage.Notifications
except AttributeError:
pytest.skip("No Notifications member")
permissions = webenginetab._WebEnginePermissions
assert permissions._options[notifications] == 'content.notifications.enabled'
assert permissions._messages[notifications] == 'show notifications'
|
