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 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
|
# SPDX-FileCopyrightText: Florian Bruhin (The Compiler) <mail@qutebrowser.org>
#
# SPDX-License-Identifier: GPL-3.0-or-later
import logging
import pytest
QWebEngineSettings = pytest.importorskip("qutebrowser.qt.webenginecore").QWebEngineSettings
from qutebrowser.config import configdata
from qutebrowser.utils import usertypes, version, utils
from qutebrowser.browser.webengine import darkmode
from qutebrowser.misc import objects
@pytest.fixture(autouse=True)
def patch_backend(monkeypatch):
monkeypatch.setattr(objects, 'backend', usertypes.Backend.QtWebEngine)
@pytest.fixture
def gentoo_versions():
return version.WebEngineVersions(
webengine=utils.VersionNumber(5, 15, 2),
chromium='87.0.4280.144',
source='faked',
)
class TestSetting:
@pytest.mark.parametrize("value, mapping, expected", [
("val", None, ("key", "val")),
(5, None, ("key", "5")),
(True, darkmode._BOOLS, ("key", "true")),
("excluded", {"excluded": None}, None),
])
def test_chromium_tuple(self, value, mapping, expected):
setting = darkmode._Setting(option="opt", chromium_key="key", mapping=mapping)
assert setting.chromium_tuple(value) == expected
def test_with_prefix(self):
mapping = {"val": "mapped"}
setting = darkmode._Setting(option="opt", chromium_key="key", mapping=mapping)
prefixed = setting.with_prefix("prefix")
assert prefixed == darkmode._Setting(
option="opt", chromium_key="prefixkey", mapping=mapping
)
class TestDefinition:
@pytest.fixture
def setting1(self) -> darkmode._Setting:
return darkmode._Setting("opt1", "key1")
@pytest.fixture
def setting2(self) -> darkmode._Setting:
return darkmode._Setting("opt2", "key2")
@pytest.fixture
def setting3(self) -> darkmode._Setting:
return darkmode._Setting("opt3", "key3")
@pytest.fixture
def definition(
self, setting1: darkmode._Setting, setting2: darkmode._Setting
) -> darkmode._Definition:
return darkmode._Definition(setting1, setting2, mandatory=set(), prefix="")
def _get_settings(self, definition: darkmode._Definition) -> list[darkmode._Setting]:
return [setting for _key, setting in definition.prefixed_settings()]
@pytest.mark.parametrize("prefix", ["", "prefix"])
def test_prefixed_settings(
self,
prefix: str,
definition: darkmode._Definition,
setting1: darkmode._Setting,
setting2: darkmode._Setting,
):
assert definition.prefix == "" # default value
definition.prefix = prefix
prefixed = self._get_settings(definition)
assert prefixed == [setting1.with_prefix(prefix), setting2.with_prefix(prefix)]
def test_switch_names(
self,
definition: darkmode._Definition,
setting1: darkmode._Setting,
setting2: darkmode._Setting,
setting3: darkmode._Setting,
):
switch_names = {
setting1.option: "opt1-switch",
None: "default-switch",
}
definition = darkmode._Definition(
setting1,
setting2,
setting3,
mandatory=set(),
prefix="",
switch_names=switch_names,
)
settings = list(definition.prefixed_settings())
assert settings == [
("opt1-switch", setting1),
("default-switch", setting2),
("default-switch", setting3),
]
def test_copy_remove_setting(
self,
definition: darkmode._Definition,
setting1: darkmode._Setting,
setting2: darkmode._Setting,
):
copy = definition.copy_remove_setting(setting2.option)
orig_settings = self._get_settings(definition)
copy_settings = self._get_settings(copy)
assert orig_settings == [setting1, setting2]
assert copy_settings == [setting1]
def test_copy_remove_setting_not_found(self, definition: darkmode._Definition):
with pytest.raises(ValueError, match="Setting not-found not found in "):
definition.copy_remove_setting("not-found")
def test_copy_add_setting(
self,
definition: darkmode._Definition,
setting1: darkmode._Setting,
setting2: darkmode._Setting,
setting3: darkmode._Setting,
):
copy = definition.copy_add_setting(setting3)
orig_settings = self._get_settings(definition)
copy_settings = self._get_settings(copy)
assert orig_settings == [setting1, setting2]
assert copy_settings == [setting1, setting2, setting3]
def test_copy_add_setting_already_exists(
self,
definition: darkmode._Definition,
setting1: darkmode._Setting,
setting2: darkmode._Setting,
):
copy = definition.copy_add_setting(setting2)
orig_settings = self._get_settings(definition)
copy_settings = self._get_settings(copy)
assert orig_settings == [setting1, setting2]
assert copy_settings == [setting1, setting2, setting2]
def test_copy_replace_setting(
self,
definition: darkmode._Definition,
setting1: darkmode._Setting,
setting2: darkmode._Setting,
):
replaced = darkmode._Setting(setting2.option, setting2.chromium_key + "-replaced")
copy = definition.copy_replace_setting(setting2.option, replaced.chromium_key)
orig_settings = self._get_settings(definition)
copy_settings = self._get_settings(copy)
assert orig_settings == [setting1, setting2]
assert copy_settings == [setting1, replaced]
def test_copy_replace_setting_not_found(
self, definition: darkmode._Definition, setting3: darkmode._Setting
):
with pytest.raises(ValueError, match="Setting opt3 not found in "):
definition.copy_replace_setting(setting3.option, setting3.chromium_key)
@pytest.mark.parametrize('value, webengine_version, expected', [
# Auto
("auto", "5.15.2", [("preferredColorScheme", "2")]), # QTBUG-89753
("auto", "5.15.3", []),
("auto", "6.2.0", []),
# Unset
(None, "5.15.2", [("preferredColorScheme", "2")]), # QTBUG-89753
(None, "5.15.3", []),
(None, "6.2.0", []),
# Dark
("dark", "5.15.2", [("preferredColorScheme", "1")]),
("dark", "5.15.3", [("preferredColorScheme", "0")]),
("dark", "6.2.0", [("preferredColorScheme", "0")]),
# Light
("light", "5.15.2", [("preferredColorScheme", "2")]),
("light", "5.15.3", [("preferredColorScheme", "1")]),
("light", "6.2.0", [("preferredColorScheme", "1")]),
])
def test_colorscheme(config_stub, value, webengine_version, expected):
versions = version.WebEngineVersions.from_pyqt(webengine_version)
if value is not None:
config_stub.val.colors.webpage.preferred_color_scheme = value
darkmode_settings = darkmode.settings(versions=versions, special_flags=[])
assert darkmode_settings['blink-settings'] == expected
def test_colorscheme_gentoo_workaround(config_stub, gentoo_versions):
config_stub.val.colors.webpage.preferred_color_scheme = "dark"
darkmode_settings = darkmode.settings(versions=gentoo_versions, special_flags=[])
assert darkmode_settings['blink-settings'] == [("preferredColorScheme", "0")]
@pytest.mark.parametrize('settings, expected', [
# Disabled
({}, [('preferredColorScheme', '2')]),
# Enabled without customization
(
{'enabled': True},
[
('preferredColorScheme', '2'),
('forceDarkModeEnabled', 'true'),
('forceDarkModeImagePolicy', '2'),
]
),
# Algorithm
(
{'enabled': True, 'algorithm': 'brightness-rgb'},
[
('preferredColorScheme', '2'),
('forceDarkModeEnabled', 'true'),
('forceDarkModeInversionAlgorithm', '2'),
('forceDarkModeImagePolicy', '2'),
],
),
])
def test_basics(config_stub, settings, expected):
for k, v in settings.items():
config_stub.set_obj('colors.webpage.darkmode.' + k, v)
# Using Qt 5.15.2 because it has the least special cases.
versions = version.WebEngineVersions.from_pyqt('5.15.2')
darkmode_settings = darkmode.settings(versions=versions, special_flags=[])
assert darkmode_settings['blink-settings'] == expected
QT_515_2_SETTINGS = {'blink-settings': [
('preferredColorScheme', '2'), # QTBUG-89753
('forceDarkModeEnabled', 'true'),
('forceDarkModeInversionAlgorithm', '2'),
('forceDarkModeImagePolicy', '2'),
('forceDarkModeTextBrightnessThreshold', '100'),
]}
QT_515_3_SETTINGS = {
'blink-settings': [('forceDarkModeEnabled', 'true')],
'dark-mode-settings': [
('InversionAlgorithm', '1'),
('ImagePolicy', '2'),
('TextBrightnessThreshold', '100'),
],
}
QT_64_SETTINGS = {
'blink-settings': [('forceDarkModeEnabled', 'true')],
'dark-mode-settings': [
('InversionAlgorithm', '1'),
('ImagePolicy', '2'),
('ForegroundBrightnessThreshold', '100'), # name changed
],
}
QT_66_SETTINGS = {
'blink-settings': [('forceDarkModeEnabled', 'true')],
'dark-mode-settings': [
('InversionAlgorithm', '1'),
('ImagePolicy', '2'),
('ForegroundBrightnessThreshold', '100'),
("ImageClassifierPolicy", "0"), # added
],
}
QT_67_SETTINGS = {
# blink-settings removed
'dark-mode-settings': [
('InversionAlgorithm', '1'),
('ImagePolicy', '2'),
('ForegroundBrightnessThreshold', '100'),
("ImageClassifierPolicy", "0"),
],
}
@pytest.mark.parametrize(
"qversion, expected",
[
("5.15.2", QT_515_2_SETTINGS),
("5.15.3", QT_515_3_SETTINGS),
("6.4", QT_64_SETTINGS),
("6.6", QT_66_SETTINGS),
pytest.param(
"6.7",
QT_67_SETTINGS,
marks=pytest.mark.skipif(
not hasattr(QWebEngineSettings.WebAttribute, "ForceDarkMode"),
reason="needs PyQt 6.7",
),
),
],
)
def test_qt_version_differences(config_stub, qversion, expected):
settings = {
'enabled': True,
'algorithm': 'brightness-rgb',
'threshold.foreground': 100,
}
for k, v in settings.items():
config_stub.set_obj('colors.webpage.darkmode.' + k, v)
versions = version.WebEngineVersions.from_pyqt(qversion)
darkmode_settings = darkmode.settings(versions=versions, special_flags=[])
assert darkmode_settings == expected
@pytest.mark.parametrize('setting, value, exp_key, exp_val', [
('contrast', -0.5,
'Contrast', '-0.5'),
('policy.page', 'smart',
'PagePolicy', '1'),
('policy.images', 'smart',
'ImagePolicy', '2'),
('threshold.foreground', 100,
'TextBrightnessThreshold', '100'),
('threshold.background', 100,
'BackgroundBrightnessThreshold', '100'),
])
def test_customization(config_stub, setting, value, exp_key, exp_val):
config_stub.val.colors.webpage.darkmode.enabled = True
config_stub.set_obj('colors.webpage.darkmode.' + setting, value)
expected = [
('preferredColorScheme', '2'),
('forceDarkModeEnabled', 'true'),
]
if exp_key != 'ImagePolicy':
expected.append(('forceDarkModeImagePolicy', '2'))
expected.append(('forceDarkMode' + exp_key, exp_val))
versions = version.WebEngineVersions.from_api(
qtwe_version='5.15.2',
chromium_version=None,
)
darkmode_settings = darkmode.settings(versions=versions, special_flags=[])
assert darkmode_settings['blink-settings'] == expected
@pytest.mark.parametrize('qtwe_version, setting, value, expected', [
('6.6.1', 'policy.images', 'always', [('ImagePolicy', '0')]),
('6.6.1', 'policy.images', 'never', [('ImagePolicy', '1')]),
('6.6.1', 'policy.images', 'smart', [('ImagePolicy', '2'), ('ImageClassifierPolicy', '0')]),
('6.6.1', 'policy.images', 'smart-simple', [('ImagePolicy', '2'), ('ImageClassifierPolicy', '1')]),
('6.5.3', 'policy.images', 'smart', [('ImagePolicy', '2')]),
('6.5.3', 'policy.images', 'smart-simple', [('ImagePolicy', '2')]),
])
def test_image_policy(config_stub, qtwe_version: str, setting: str, value: str, expected: list[tuple[str, str]]):
config_stub.val.colors.webpage.darkmode.enabled = True
config_stub.set_obj('colors.webpage.darkmode.' + setting, value)
versions = version.WebEngineVersions.from_api(
qtwe_version=qtwe_version,
chromium_version=None,
)
darkmode_settings = darkmode.settings(versions=versions, special_flags=[])
assert darkmode_settings['dark-mode-settings'] == expected
@pytest.mark.parametrize('webengine_version, expected', [
('5.15.2', darkmode.Variant.qt_515_2),
('5.15.3', darkmode.Variant.qt_515_3),
('6.2.0', darkmode.Variant.qt_515_3),
('6.3.0', darkmode.Variant.qt_515_3),
('6.4.0', darkmode.Variant.qt_64),
('6.5.0', darkmode.Variant.qt_64),
('6.6.0', darkmode.Variant.qt_66),
])
def test_variant(webengine_version, expected):
versions = version.WebEngineVersions.from_pyqt(webengine_version)
assert darkmode._variant(versions) == expected
def test_variant_qt67() -> None:
versions = version.WebEngineVersions.from_pyqt("6.7.0")
# We can't monkeypatch the enum, so compare against the real situation
if hasattr(QWebEngineSettings.WebAttribute, "ForceDarkMode"):
expected = darkmode.Variant.qt_67
else:
expected = darkmode.Variant.qt_66
assert darkmode._variant(versions) == expected
def test_variant_gentoo_workaround(gentoo_versions):
assert darkmode._variant(gentoo_versions) == darkmode.Variant.qt_515_3
@pytest.mark.parametrize('value, is_valid, expected', [
('invalid_value', False, darkmode.Variant.qt_515_3),
('qt_515_2', True, darkmode.Variant.qt_515_2),
])
def test_variant_override(monkeypatch, caplog, value, is_valid, expected):
versions = version.WebEngineVersions.from_pyqt('5.15.3')
monkeypatch.setenv('QUTE_DARKMODE_VARIANT', value)
with caplog.at_level(logging.WARNING):
assert darkmode._variant(versions) == expected
log_msg = 'Ignoring invalid QUTE_DARKMODE_VARIANT=invalid_value'
assert (log_msg in caplog.messages) != is_valid
@pytest.mark.parametrize('flag, expected', [
('--blink-settings=key=value', [('key', 'value')]),
('--blink-settings=key=equal=rights', [('key', 'equal=rights')]),
('--blink-settings=one=1,two=2', [('one', '1'), ('two', '2')]),
('--enable-features=feat', []),
])
def test_pass_through_existing_settings(config_stub, flag, expected):
config_stub.val.colors.webpage.darkmode.enabled = True
versions = version.WebEngineVersions.from_pyqt('5.15.2')
settings = darkmode.settings(versions=versions, special_flags=[flag])
dark_mode_expected = [
('preferredColorScheme', '2'),
('forceDarkModeEnabled', 'true'),
('forceDarkModeImagePolicy', '2'),
]
assert settings['blink-settings'] == expected + dark_mode_expected
def test_options(configdata_init):
"""Make sure all darkmode options have the right attributes set."""
for name, opt in configdata.DATA.items():
if not name.startswith('colors.webpage.darkmode.'):
continue
if name != 'colors.webpage.darkmode.enabled':
assert not opt.supports_pattern, name
assert opt.restart, name
if opt.backends:
# On older Qt versions, this is an empty list.
assert opt.backends == [usertypes.Backend.QtWebEngine], name
if opt.raw_backends is not None:
assert not opt.raw_backends['QtWebKit'], name
|