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
|
# Copyright 2014-2021 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
#
# SPDX-License-Identifier: GPL-3.0-or-later
"""Tests for qutebrowser.utils.resources."""
import os.path
import zipfile
import pytest
from qutebrowser.utils import utils, resources
@pytest.mark.usefixtures('freezer')
class TestReadFile:
@pytest.fixture
def package_path(self, tmp_path):
return tmp_path / 'qutebrowser'
@pytest.fixture
def html_path(self, package_path):
path = package_path / 'html'
path.mkdir(parents=True)
for filename in ['test1.html', 'test2.html', 'README', 'unrelatedhtml']:
(path / filename).touch()
subdir = path / 'subdir'
subdir.mkdir()
(subdir / 'subdir-file.html').touch()
return path
@pytest.fixture
def html_zip(self, tmp_path, html_path):
if not hasattr(zipfile, 'Path'):
pytest.skip("Needs zipfile.Path")
zip_path = tmp_path / 'qutebrowser.zip'
with zipfile.ZipFile(zip_path, 'w') as zf:
for path in html_path.rglob('*'):
zf.write(path, path.relative_to(tmp_path))
assert sorted(zf.namelist()) == [
'qutebrowser/html/README',
'qutebrowser/html/subdir/',
'qutebrowser/html/subdir/subdir-file.html',
'qutebrowser/html/test1.html',
'qutebrowser/html/test2.html',
'qutebrowser/html/unrelatedhtml',
]
return zipfile.Path(zip_path) / 'qutebrowser'
@pytest.fixture(params=['pathlib', 'zipfile'])
def resource_root(self, request):
"""Resource files packaged either directly or via a zip."""
if request.param == 'pathlib':
request.getfixturevalue('html_path')
return request.getfixturevalue('package_path')
elif request.param == 'zipfile':
return request.getfixturevalue('html_zip')
raise utils.Unreachable(request.param)
def test_glob_resources(self, resource_root):
files = sorted(resources._glob(resource_root, 'html', '.html'))
assert files == ['html/test1.html', 'html/test2.html']
def test_glob_resources_subdir(self, resource_root):
files = sorted(resources._glob(resource_root, 'html/subdir', '.html'))
assert files == ['html/subdir/subdir-file.html']
def test_readfile(self):
"""Read a test file."""
content = resources.read_file(os.path.join('utils', 'testfile'))
assert content.splitlines()[0] == "Hello World!"
@pytest.mark.parametrize('filename', ['javascript/scroll.js',
'html/error.html'])
def test_read_cached_file(self, mocker, filename):
resources.preload()
m = mocker.patch('qutebrowser.utils.resources.importlib_resources.files')
resources.read_file(filename)
m.assert_not_called()
def test_readfile_binary(self):
"""Read a test file in binary mode."""
content = resources.read_file_binary(os.path.join('utils', 'testfile'))
assert content.splitlines()[0] == b"Hello World!"
@pytest.mark.parametrize('name', ['read_file', 'read_file_binary'])
@pytest.mark.parametrize('fake_exception', [KeyError, FileNotFoundError, None])
def test_not_found(self, name, fake_exception, monkeypatch):
"""Test behavior when a resources file wasn't found.
With fake_exception, we emulate the rather odd error handling of certain Python
versions: https://bugs.python.org/issue43063
"""
class BrokenFileFake:
def __init__(self, exc):
self.exc = exc
def read_bytes(self):
raise self.exc("File does not exist")
def read_text(self, encoding):
raise self.exc("File does not exist")
def __truediv__(self, _other):
return self
if fake_exception is not None:
monkeypatch.setattr(resources.importlib_resources, 'files',
lambda _pkg: BrokenFileFake(fake_exception))
meth = getattr(resources, name)
with pytest.raises(FileNotFoundError):
meth('doesnotexist')
|