-
Notifications
You must be signed in to change notification settings - Fork 0
/
test_downloader.py
310 lines (273 loc) · 10.4 KB
/
test_downloader.py
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
# -*- coding: utf-8 -*-
# Copyright © 2022-present Worldr Technologies Limited. All Rights Reserved.
# type: ignore
import pathlib
import re
import stat
import tempfile
from concurrent.futures import ThreadPoolExecutor
from glob import glob
from unittest.mock import ANY, MagicMock, Mock, patch
import gnupg
import pytest
import requests
import requests_mock
from pendulum.parser import parse
from pendulum.parsing.exceptions import ParserError
from rich.progress import Progress, TaskID
from setupr.downloader import Downloader, copy_url, download, take_backup
URL = "https://worldr.com/index.html"
INDEX = "/index.html"
FAKE_VERSION = "v1.2.3"
@pytest.mark.parametrize("is_set", [True, False])
@patch("setupr.downloader.done_event")
def test_copy_url(mocked_done_event: Mock, is_set: bool) -> None:
mocked_done_event.is_set = Mock(return_value=is_set) # Branch coverage.
with tempfile.TemporaryDirectory(
prefix="setupr_tests_"
) as tmpdirname, requests_mock.Mocker() as mocked:
mocked.get(URL, text="resp", headers={"content-length": "13"})
dst = tmpdirname + "/index.html"
progress = MagicMock(spec=Progress)
copy_url(MagicMock(spec=TaskID), URL, dst, progress)
assert progress.start_task.called
assert progress.update.called
@patch("setupr.downloader.done_event")
def test_copy_url_request_exception(mocked_done_event: Mock) -> None:
mocked_done_event.is_set = Mock(return_value=False) # Branch coverage.
with tempfile.TemporaryDirectory(
prefix="setupr_tests_"
) as tmpdirname, requests_mock.Mocker() as mocked:
mocked.get(URL, text="resp", status_code=400)
dst = tmpdirname + INDEX
progress = MagicMock(spec=Progress)
with pytest.raises(requests.exceptions.RequestException):
copy_url(MagicMock(spec=TaskID), URL, dst, progress)
assert not progress.start_task.called
assert not progress.update.called
def test_download() -> None:
with tempfile.TemporaryDirectory(
prefix="setupr_tests_"
) as tmpdirname, patch(
"setupr.downloader.ThreadPoolExecutor"
) as mocked_thread_pool_executor:
pool = MagicMock(spec=ThreadPoolExecutor)
fut = Mock()
fut.result = Mock()
pool.submit = Mock(return_value=fut)
mocked_thread_pool_executor.return_value.__enter__ = Mock(
return_value=pool
)
download(
[
URL,
],
tmpdirname,
)
pool.submit.assert_called_once_with(
ANY, ANY, URL, tmpdirname + INDEX, ANY
)
assert fut.result.called
def test_download_failed() -> None:
with tempfile.TemporaryDirectory(
prefix="setupr_tests_"
) as tmpdirname, patch(
"setupr.downloader.ThreadPoolExecutor"
) as mocked_thread_pool_executor:
pool = MagicMock(spec=ThreadPoolExecutor)
fut = Mock()
fut.result = Mock(side_effect=requests.exceptions.RequestException)
pool.submit = Mock(return_value=fut)
mocked_thread_pool_executor.return_value.__enter__ = Mock(
return_value=pool
)
with pytest.raises(requests.exceptions.RequestException):
download(
[
URL,
],
tmpdirname,
)
pool.submit.assert_called_once_with(
ANY, ANY, URL, tmpdirname + INDEX, ANY
)
assert fut.result.called
def test_take_backup() -> None:
with tempfile.TemporaryDirectory(prefix="setupr_tests_") as tmpdirname:
_file = pathlib.Path(tmpdirname, "test.txt")
with open(_file, "w") as fp:
fp.write("created temporary file 0\n")
assert take_backup(_file) == _file
all_files = glob(f"{tmpdirname}/archives/test*.txt")
assert len(all_files) == 1, "There should be only one…"
date_string = re.findall(
r"_\d{4}-\d{2}-\d{2}T.*\.",
all_files[0],
flags=re.IGNORECASE,
)[0][1:-1]
assert all_files[0].startswith(f"{tmpdirname}/archives/test_")
assert all_files[0].endswith(".txt")
try:
parse(date_string)
# If we are here, then there is an ISO8601 compliant string in the
# backup file. Since we checked it starts with and ends with the
# correct input, we can be fairly sure it is the correct backup
# file.
except ParserError: # pragma: no cover
# We do not need to cover this case, it is a failure only!
pytest.fail("Could not parse date string of backup file")
def test_take_backup_no_need() -> None:
with patch.object(pathlib.Path, "is_dir", return_value=True):
sut = pathlib.Path("/file/does/not/exits/ever/no/really/it/does/not")
bak = take_backup(sut)
assert bak is sut
@pytest.fixture()
def downloader() -> Downloader:
with patch("setupr.gpg.gnupg") as mock_gpg:
mock_gpg.return_value = MagicMock(spec=gnupg.GPG)
sut = Downloader()
assert isinstance(sut._gpg._gpg, MagicMock)
return sut
@pytest.mark.parametrize(
("func", "what", "returned", "expected"),
[
("_get_files", "Elden Ring", True, False),
("_get_files", "backup", False, False),
("_get_files", "backup", True, True),
("_get_files", "debug", False, False),
("_get_files", "debug", True, True),
("_get_files", "install", False, False),
("_get_files", "install", True, True),
],
)
def test_downloader_get_files(
downloader: Downloader,
func: str,
what: str,
returned: bool,
expected: bool,
) -> None:
with patch.object(downloader, func) as m:
m.return_value = returned
assert downloader.get(what, "v1.2.3") is expected
@pytest.mark.parametrize(
("sig", "error", "expected"),
[
(True, None, True),
(True, OSError("BooM"), False),
(True, requests.exceptions.RequestException, False),
(False, None, False),
(False, OSError, False),
(False, requests.exceptions.RequestException, False),
],
)
def test_get_files(
sig: bool,
error: Exception | None,
expected: bool,
downloader: Downloader,
) -> None:
with patch("setupr.downloader.download") as mocked_download:
# This can override the return value if error is not None.
mocked_download.side_effect = error
downloader._gpg.validate_worldr_signature = MagicMock(return_value=sig)
with patch.object(
pathlib.Path, "chmod", lambda _, x: x == stat.S_IRWXU
):
assert downloader._get_files("test", FAKE_VERSION) is expected
assert mocked_download.called
@pytest.mark.parametrize(
("sha", "error", "expected"),
[
(
"4362bac71d971fc7d7b69a757de6fbcb5e1c513b393609043cae67b5341bd4af",
None,
True,
),
(
"deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
None,
False,
),
(
"4362bac71d971fc7d7b69a757de6fbcb5e1c513b393609043cae67b5341bd4af",
OSError,
False,
),
(
"4362bac71d971fc7d7b69a757de6fbcb5e1c513b393609043cae67b5341bd4af",
requests.exceptions.RequestException,
False,
),
],
)
def test_fetch(
sha: str,
error: Exception | None,
expected: bool,
downloader: Downloader,
) -> None:
dst = pathlib.Path(__file__).parent / "charon-lord-dunsany.txt"
with patch("setupr.downloader.download") as mocked_download:
mocked_download.side_effect = error
assert downloader.fetch("/dev/null", dst, sha) is expected
assert mocked_download.called
def test_execute_script_do_not_execute(downloader: Downloader) -> None:
with patch("setupr.downloader.Confirm") as mocked_confirm:
mocked_confirm.ask = MagicMock(return_value=False)
downloader._gpg.validate_worldr_signature = Mock()
mocked_confirm.return_value = False
assert downloader.execute_script("test", FAKE_VERSION, "", []) is True
assert not downloader._gpg.validate_worldr_signature.called
assert mocked_confirm.ask.called
def test_execute_script_signature_failed(downloader: Downloader) -> None:
with patch("setupr.downloader.Confirm") as mocked_confirm:
mocked_confirm.ask = MagicMock(return_value=True)
with patch("setupr.downloader.Console") as mocked_console:
downloader._gpg.validate_worldr_signature = Mock(
return_value=False
)
assert (
downloader.execute_script("test", FAKE_VERSION, "", [])
is False
)
assert downloader._gpg.validate_worldr_signature.called
assert not mocked_console.called
@pytest.mark.parametrize(
("code", "expected", "stdout", "stderr"),
[
(1, False, b"a hunter must hunt", b"grant us eyes"),
(0, True, b"", b""),
],
)
def test_execute_script(
code: int, expected: bool, stdout: str, stderr: str, downloader: Downloader
) -> None:
with patch("setupr.downloader.Confirm") as mocked_confirm:
mocked_confirm.ask = MagicMock(return_value=True)
with patch("setupr.downloader.Console") as mocked_console:
downloader._gpg.validate_worldr_signature = Mock(return_value=True)
m_console = MagicMock()
mocked_console.return_value = m_console
with patch("setupr.downloader.local") as mlocal:
proc = Mock()
proc.stdout = [b"error", b"warn", b"success", b"info"]
proc.communicate = Mock(return_value=(stdout, stderr))
proc.returncode = code
script = Mock()
script.popen = Mock(return_value=proc)
def side_effect(x):
assert "test" in x, "script does not have test in name"
assert (
FAKE_VERSION in x
), "script does not have version v1.2.3"
return script
mlocal.__getitem__.side_effect = side_effect
assert (
downloader.execute_script("test", FAKE_VERSION, "", [])
is expected
)
assert downloader._gpg.validate_worldr_signature.called
assert mocked_console.called
assert mocked_confirm.ask.called
assert proc.communicate.called