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
|
import json
import posixpath
import zipfile
from base64 import urlsafe_b64encode
from hashlib import sha256
import pytest
from installer.exceptions import InstallerError
from installer.records import parse_record_file
from installer.sources import WheelFile, WheelSource
class TestWheelSource:
def test_takes_two_arguments(self):
WheelSource("distribution", "version")
WheelSource(distribution="distribution", version="version")
def test_correctly_computes_properties(self):
source = WheelSource(distribution="distribution", version="version")
assert source.data_dir == "distribution-version.data"
assert source.dist_info_dir == "distribution-version.dist-info"
def test_raises_not_implemented_error(self):
source = WheelSource(distribution="distribution", version="version")
with pytest.raises(NotImplementedError):
source.dist_info_filenames
with pytest.raises(NotImplementedError):
source.read_dist_info("METADATA")
with pytest.raises(NotImplementedError):
source.get_contents()
with pytest.raises(NotImplementedError):
source.validate_record()
def replace_file_in_zip(path: str, filename: str, content: "str | None") -> None:
"""Helper function for replacing a file in the zip.
Exists because ZipFile doesn't support remove.
"""
files = {}
# Copy everything except `filename`, and replace it with `content`.
with zipfile.ZipFile(path) as archive:
for file in archive.namelist():
if file == filename:
if content is None:
continue # Remove the file
files[file] = content.encode()
else:
files[file] = archive.read(file)
# Replace original archive
with zipfile.ZipFile(path, mode="w") as archive:
for name, content in files.items():
archive.writestr(name, content)
class TestWheelFile:
def test_rejects_not_okay_name(self, tmp_path):
# Create an empty zipfile
path = tmp_path / "not_a_valid_name.whl"
with zipfile.ZipFile(str(path), "w"):
pass
with pytest.raises(ValueError, match="Not a valid wheel filename: .+"):
with WheelFile.open(str(path)):
pass
def test_provides_correct_dist_info_filenames(self, fancy_wheel):
with WheelFile.open(fancy_wheel) as source:
assert sorted(source.dist_info_filenames) == [
"METADATA",
"RECORD",
"WHEEL",
"entry_points.txt",
"top_level.txt",
]
def test_correctly_reads_from_dist_info_files(self, fancy_wheel):
files = {}
with zipfile.ZipFile(fancy_wheel) as archive:
for file in archive.namelist():
if ".dist-info" not in file:
continue
files[posixpath.basename(file)] = archive.read(file).decode("utf-8")
got_files = {}
with WheelFile.open(fancy_wheel) as source:
for file in files:
got_files[file] = source.read_dist_info(file)
assert got_files == files
def test_provides_correct_contents(self, fancy_wheel):
# Know the contents of the wheel
files = {}
with zipfile.ZipFile(fancy_wheel) as archive:
for file in archive.namelist():
if file[-1:] == "/":
continue
files[file] = archive.read(file)
expected_record_lines = (
files["fancy-1.0.0.dist-info/RECORD"].decode("utf-8").splitlines()
)
expected_records = list(parse_record_file(expected_record_lines))
# Check that the object's output is appropriate
got_records = []
got_files = {}
with WheelFile.open(fancy_wheel) as source:
for record_elements, stream, is_executable in source.get_contents():
got_records.append(record_elements)
got_files[record_elements[0]] = stream.read()
assert not is_executable
assert sorted(got_records) == sorted(expected_records)
assert got_files == files
def test_finds_dist_info(self, fancy_wheel):
denorm = fancy_wheel.rename(fancy_wheel.parent / "Fancy-1.0.0-py3-none-any.whl")
# Python 3.7: rename doesn't return the new name:
denorm = fancy_wheel.parent / "Fancy-1.0.0-py3-none-any.whl"
with WheelFile.open(denorm) as source:
assert source.dist_info_filenames
def test_requires_dist_info_name_match(self, fancy_wheel):
misnamed = fancy_wheel.rename(
fancy_wheel.parent / "misnamed-1.0.0-py3-none-any.whl"
)
# Python 3.7: rename doesn't return the new name:
misnamed = fancy_wheel.parent / "misnamed-1.0.0-py3-none-any.whl"
with pytest.raises(InstallerError) as ctx:
with WheelFile.open(misnamed) as source:
source.dist_info_filenames
error = ctx.value
print(error)
assert error.filename == str(misnamed)
assert error.dist_info == "fancy-1.0.0.dist-info"
assert "" in error.reason
assert error.dist_info in str(error)
def test_enforces_single_dist_info(self, fancy_wheel):
with zipfile.ZipFile(fancy_wheel, "a") as archive:
archive.writestr(
"name-1.0.0.dist-info/random.txt",
b"This is a random file.",
)
with pytest.raises(InstallerError) as ctx:
with WheelFile.open(fancy_wheel) as source:
source.dist_info_filenames
error = ctx.value
print(error)
assert error.filename == str(fancy_wheel)
assert error.dist_info == str(["fancy-1.0.0.dist-info", "name-1.0.0.dist-info"])
assert "exactly one .dist-info" in error.reason
assert error.dist_info in str(error)
def test_rejects_no_record_on_validate(self, fancy_wheel):
# Remove RECORD
replace_file_in_zip(
fancy_wheel,
filename="fancy-1.0.0.dist-info/RECORD",
content=None,
)
with WheelFile.open(fancy_wheel) as source:
with pytest.raises(
WheelFile.validation_error, match="Unable to retrieve `RECORD`"
):
source.validate_record(validate_contents=False)
def test_rejects_invalid_record_entry(self, fancy_wheel):
with WheelFile.open(fancy_wheel) as source:
record_file_contents = source.read_dist_info("RECORD")
replace_file_in_zip(
fancy_wheel,
filename="fancy-1.0.0.dist-info/RECORD",
content="\n".join(
line.replace("sha256=", "") for line in record_file_contents
),
)
with WheelFile.open(fancy_wheel) as source:
with pytest.raises(
WheelFile.validation_error,
match="Unable to retrieve `RECORD`",
):
source.validate_record()
def test_rejects_record_missing_file_on_validate(self, fancy_wheel):
with WheelFile.open(fancy_wheel) as source:
record_file_contents = source.read_dist_info("RECORD")
# Remove the first two entries from the RECORD file
new_record_file_contents = "\n".join(record_file_contents.split("\n")[2:])
replace_file_in_zip(
fancy_wheel,
filename="fancy-1.0.0.dist-info/RECORD",
content=new_record_file_contents,
)
with WheelFile.open(fancy_wheel) as source:
with pytest.raises(
WheelFile.validation_error, match="not mentioned in RECORD"
):
source.validate_record(validate_contents=False)
def test_rejects_record_missing_hash(self, fancy_wheel):
with WheelFile.open(fancy_wheel) as source:
record_file_contents = source.read_dist_info("RECORD")
new_record_file_contents = "\n".join(
line.split(",")[0] + ",," # file name with empty size and hash
for line in record_file_contents.split("\n")
)
replace_file_in_zip(
fancy_wheel,
filename="fancy-1.0.0.dist-info/RECORD",
content=new_record_file_contents,
)
with WheelFile.open(fancy_wheel) as source:
with pytest.raises(
WheelFile.validation_error,
match="hash / size of (.+) is not included in RECORD",
):
source.validate_record(validate_contents=False)
def test_accept_wheel_with_signature_file(self, fancy_wheel):
with WheelFile.open(fancy_wheel) as source:
record_file_contents = source.read_dist_info("RECORD")
hash_b64_nopad = (
urlsafe_b64encode(sha256(record_file_contents.encode()).digest())
.decode("utf-8")
.rstrip("=")
)
jws_content = json.dumps({"hash": f"sha256={hash_b64_nopad}"})
with zipfile.ZipFile(fancy_wheel, "a") as archive:
archive.writestr("fancy-1.0.0.dist-info/RECORD.jws", jws_content)
with WheelFile.open(fancy_wheel) as source:
source.validate_record()
def test_reject_signature_file_in_record(self, fancy_wheel):
with WheelFile.open(fancy_wheel) as source:
record_file_contents = source.read_dist_info("RECORD")
record_hash_nopad = (
urlsafe_b64encode(sha256(record_file_contents.encode()).digest())
.decode("utf-8")
.rstrip("=")
)
jws_content = json.dumps({"hash": f"sha256={record_hash_nopad}"})
with zipfile.ZipFile(fancy_wheel, "a") as archive:
archive.writestr("fancy-1.0.0.dist-info/RECORD.jws", jws_content)
# Add signature file to RECORD
jws_content = jws_content.encode()
jws_hash_nopad = (
urlsafe_b64encode(sha256(jws_content).digest()).decode("utf-8").rstrip("=")
)
replace_file_in_zip(
fancy_wheel,
filename="fancy-1.0.0.dist-info/RECORD",
content=record_file_contents.rstrip("\n")
+ f"\nfancy-1.0.0.dist-info/RECORD.jws,sha256={jws_hash_nopad},{len(jws_content)}\n",
)
with WheelFile.open(fancy_wheel) as source:
with pytest.raises(
WheelFile.validation_error,
match="digital signature file (.+) is incorrectly contained in RECORD.",
):
source.validate_record(validate_contents=False)
def test_rejects_record_contain_self_hash(self, fancy_wheel):
with WheelFile.open(fancy_wheel) as source:
record_file_contents = source.read_dist_info("RECORD")
new_record_file_lines = []
for line in record_file_contents.split("\n"):
if not line:
continue
filename, hash_, size = line.split(",")
if filename.split("/")[-1] == "RECORD":
hash_ = "sha256=pREiHcl39jRySUXMCOrwmSsnOay8FB7fOJP5mZQ3D3A"
size = str(len(record_file_contents))
new_record_file_lines.append(",".join((filename, hash_, size)))
replace_file_in_zip(
fancy_wheel,
filename="fancy-1.0.0.dist-info/RECORD",
content="\n".join(new_record_file_lines),
)
with WheelFile.open(fancy_wheel) as source:
with pytest.raises(
WheelFile.validation_error,
match="RECORD file incorrectly contains hash / size.",
):
source.validate_record(validate_contents=False)
def test_rejects_record_validation_failed(self, fancy_wheel):
with WheelFile.open(fancy_wheel) as source:
record_file_contents = source.read_dist_info("RECORD")
new_record_file_lines = []
for line in record_file_contents.split("\n"):
if not line:
continue
filename, hash_, size = line.split(",")
if filename.split("/")[-1] != "RECORD":
hash_ = "sha256=pREiHcl39jRySUXMCOrwmSsnOay8FB7fOJP5mZQ3D3A"
new_record_file_lines.append(",".join((filename, hash_, size)))
replace_file_in_zip(
fancy_wheel,
filename="fancy-1.0.0.dist-info/RECORD",
content="\n".join(new_record_file_lines),
)
with WheelFile.open(fancy_wheel) as source:
with pytest.raises(
WheelFile.validation_error,
match="hash / size of (.+) didn't match RECORD",
):
source.validate_record()
|
