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
|
# stdlib
import tarfile
import tempfile
import zipfile
# 3rd party
import pytest
from coincidence.regressions import AdvancedDataRegressionFixture, check_file_regression
from domdf_python_tools.paths import PathPlus
from pytest_regressions.file_regression import FileRegressionFixture
from whey.builder import SDistBuilder
from whey.config import BadConfigError, load_toml
from whey.foreman import Foreman
# this package
from whey_pth import PthWheelBuilder, WheyPthParser
WHEY_NO_PTH = """\
[build-system]
requires = [ "whey",]
build-backend = "whey"
[project]
name = "whey"
version = "2021.0.0"
description = "A simple Python wheel builder for simple projects."
keywords = [ "pep517", "pep621", "build", "sdist", "wheel", "packaging", "distribution",]
dynamic = [ "classifiers", "requires-python",]
readme = "README.rst"
dependencies = [
"httpx",
"gidgethub[httpx]>4.0.0",
"django>2.1; os_name != 'nt'",
"django>2.0; os_name == 'nt'"
]
[project.license]
file = "LICENSE"
[[project.authors]]
email = "dominic@davis-foster.co.uk"
name = "Dominic Davis-Foster"
[project.urls]
Homepage = "https://whey.readthedocs.io/en/latest"
Documentation = "https://whey.readthedocs.io/en/latest"
"Issue Tracker" = "https://github.com/repo-helper/whey/issues"
"Source Code" = "https://github.com/repo-helper/whey"
[tool.whey]
base-classifiers = [ "Development Status :: 4 - Beta",]
python-versions = [ "3.6", "3.7", "3.8", "3.9", "3.10",]
python-implementations = [ "CPython", "PyPy",]
platforms = [ "Windows", "macOS", "Linux",]
license-key = "MIT"
[tool.whey.builders]
wheel = "whey_pth_wheel"
"""
COMPLETE_A = """\
[build-system]
requires = [ "whey",]
build-backend = "whey"
[project]
name = "whey"
version = "2021.0.0"
description = "A simple Python wheel builder for simple projects."
keywords = [ "pep517", "pep621", "build", "sdist", "wheel", "packaging", "distribution",]
dynamic = [ "classifiers", "requires-python",]
readme = "README.rst"
dependencies = [
"httpx",
"gidgethub[httpx]>4.0.0",
"django>2.1; os_name != 'nt'",
"django>2.0; os_name == 'nt'"
]
[project.license]
file = "LICENSE"
[[project.authors]]
email = "dominic@davis-foster.co.uk"
name = "Dominic Davis-Foster"
[project.urls]
Homepage = "https://whey.readthedocs.io/en/latest"
Documentation = "https://whey.readthedocs.io/en/latest"
"Issue Tracker" = "https://github.com/repo-helper/whey/issues"
"Source Code" = "https://github.com/repo-helper/whey"
[tool.whey]
base-classifiers = [ "Development Status :: 4 - Beta",]
python-versions = [ "3.6", "3.7", "3.8", "3.9", "3.10",]
python-implementations = [ "CPython", "PyPy",]
platforms = [ "Windows", "macOS", "Linux",]
license-key = "MIT"
[tool.whey.builders]
wheel = "whey_pth_wheel"
[tool.whey-pth]
name = "my_project.pth"
pth-content = "import _virtualenv"
"""
COMPLETE_B = """\
[build-system]
requires = [ "whey",]
build-backend = "whey"
[project]
name = "whey"
version = "2021.0.0"
description = "A simple Python wheel builder for simple projects."
keywords = [ "pep517", "pep621", "build", "sdist", "wheel", "packaging", "distribution",]
dynamic = [ "classifiers", "requires-python",]
readme = "README.rst"
dependencies = [
"httpx",
"gidgethub[httpx]>4.0.0",
"django>2.1; os_name != 'nt'",
"django>2.0; os_name == 'nt'"
]
[project.license]
file = "LICENSE"
[[project.authors]]
email = "dominic@davis-foster.co.uk"
name = "Dominic Davis-Foster"
[project.urls]
Homepage = "https://whey.readthedocs.io/en/latest"
Documentation = "https://whey.readthedocs.io/en/latest"
"Issue Tracker" = "https://github.com/repo-helper/whey/issues"
"Source Code" = "https://github.com/repo-helper/whey"
[tool.whey]
base-classifiers = [ "Development Status :: 4 - Beta",]
python-versions = [ "3.6", "3.7", "3.8", "3.9", "3.10",]
python-implementations = [ "CPython", "PyPy",]
platforms = [ "Windows", "macOS", "Linux",]
license-key = "MIT"
[tool.whey.builders]
wheel = "whey_pth_wheel"
[tool.whey-pth]
name = "my_project"
pth-content = "import _virtualenv"
"""
@pytest.mark.parametrize(
"config",
[
pytest.param(WHEY_NO_PTH, id="WHEY_NO_PTH"),
pytest.param(COMPLETE_A, id="COMPLETE_A"),
pytest.param(COMPLETE_B, id="COMPLETE_B"),
]
)
def test_build_complete(
config: str,
tmp_pathplus: PathPlus,
advanced_data_regression: AdvancedDataRegressionFixture,
file_regression: FileRegressionFixture,
capsys,
):
(tmp_pathplus / "pyproject.toml").write_clean(config)
(tmp_pathplus / "whey").mkdir()
(tmp_pathplus / "whey" / "__init__.py").write_clean("print('hello world)")
(tmp_pathplus / "README.rst").write_clean("Spam Spam Spam Spam")
(tmp_pathplus / "LICENSE").write_clean("This is the license")
(tmp_pathplus / "requirements.txt").write_clean("domdf_python_tools")
data = {}
with tempfile.TemporaryDirectory() as tmpdir:
wheel_builder = PthWheelBuilder(
project_dir=tmp_pathplus,
config=load_toml(tmp_pathplus / "pyproject.toml"),
build_dir=tmpdir,
out_dir=tmp_pathplus,
verbose=True,
colour=False,
)
wheel = wheel_builder.build_wheel()
assert (tmp_pathplus / wheel).is_file()
zip_file = zipfile.ZipFile(tmp_pathplus / wheel)
data["wheel_content"] = sorted(zip_file.namelist())
with zip_file.open("whey/__init__.py", mode='r') as fp:
assert fp.read().decode("UTF-8") == "print('hello world)\n"
with zip_file.open("whey-2021.0.0.dist-info/METADATA", mode='r') as fp:
check_file_regression(fp.read().decode("UTF-8"), file_regression)
if config != WHEY_NO_PTH:
with zip_file.open("my_project.pth", mode='r') as fp:
assert fp.read().decode("UTF-8") == "import _virtualenv\n"
with tempfile.TemporaryDirectory() as tmpdir:
sdist_builder = SDistBuilder(
project_dir=tmp_pathplus,
config=load_toml(tmp_pathplus / "pyproject.toml"),
build_dir=tmpdir,
out_dir=tmp_pathplus,
verbose=True,
colour=False,
)
sdist = sdist_builder.build_sdist()
assert (tmp_pathplus / sdist).is_file()
tar = tarfile.open(tmp_pathplus / sdist)
data["sdist_content"] = sorted(tar.getnames())
with tar.extractfile("whey-2021.0.0/whey/__init__.py") as fp: # type: ignore
assert fp.read().decode("UTF-8") == "print('hello world)\n"
with tar.extractfile("whey-2021.0.0/README.rst") as fp: # type: ignore
assert fp.read().decode("UTF-8") == "Spam Spam Spam Spam\n"
with tar.extractfile("whey-2021.0.0/LICENSE") as fp: # type: ignore
assert fp.read().decode("UTF-8") == "This is the license\n"
with tar.extractfile("whey-2021.0.0/requirements.txt") as fp: # type: ignore
assert fp.read().decode("UTF-8") == "domdf_python_tools\n"
outerr = capsys.readouterr()
data["stdout"] = outerr.out.replace(tmp_pathplus.as_posix(), "...")
data["stderr"] = outerr.err
advanced_data_regression.check(data)
@pytest.mark.parametrize(
"config",
[
pytest.param(WHEY_NO_PTH, id="WHEY_NO_PTH"),
pytest.param(COMPLETE_A, id="COMPLETE_A"),
pytest.param(COMPLETE_B, id="COMPLETE_B"),
]
)
def test_build_complete_foreman(
config: str,
tmp_pathplus: PathPlus,
advanced_data_regression: AdvancedDataRegressionFixture,
file_regression: FileRegressionFixture,
capsys,
):
(tmp_pathplus / "pyproject.toml").write_clean(config)
(tmp_pathplus / "whey").mkdir()
(tmp_pathplus / "whey" / "__init__.py").write_clean("print('hello world)")
(tmp_pathplus / "README.rst").write_clean("Spam Spam Spam Spam")
(tmp_pathplus / "LICENSE").write_clean("This is the license")
(tmp_pathplus / "requirements.txt").write_clean("domdf_python_tools")
data = {}
foreman = Foreman(project_dir=tmp_pathplus)
with tempfile.TemporaryDirectory() as tmpdir:
wheel = foreman.build_wheel(
build_dir=tmpdir,
out_dir=tmp_pathplus,
verbose=True,
colour=False,
)
assert (tmp_pathplus / wheel).is_file()
zip_file = zipfile.ZipFile(tmp_pathplus / wheel)
data["wheel_content"] = sorted(zip_file.namelist())
with zip_file.open("whey/__init__.py", mode='r') as fp:
assert fp.read().decode("UTF-8") == "print('hello world)\n"
with zip_file.open("whey-2021.0.0.dist-info/METADATA", mode='r') as fp:
check_file_regression(fp.read().decode("UTF-8"), file_regression)
if config != WHEY_NO_PTH:
with zip_file.open("my_project.pth", mode='r') as fp:
assert fp.read().decode("UTF-8") == "import _virtualenv\n"
with tempfile.TemporaryDirectory() as tmpdir:
sdist = foreman.build_sdist(
build_dir=tmpdir,
out_dir=tmp_pathplus,
verbose=True,
colour=False,
)
assert (tmp_pathplus / sdist).is_file()
tar = tarfile.open(tmp_pathplus / sdist)
data["sdist_content"] = sorted(tar.getnames())
with tar.extractfile("whey-2021.0.0/whey/__init__.py") as fp: # type: ignore
assert fp.read().decode("UTF-8") == "print('hello world)\n"
with tar.extractfile("whey-2021.0.0/README.rst") as fp: # type: ignore
assert fp.read().decode("UTF-8") == "Spam Spam Spam Spam\n"
with tar.extractfile("whey-2021.0.0/LICENSE") as fp: # type: ignore
assert fp.read().decode("UTF-8") == "This is the license\n"
with tar.extractfile("whey-2021.0.0/requirements.txt") as fp: # type: ignore
assert fp.read().decode("UTF-8") == "domdf_python_tools\n"
outerr = capsys.readouterr()
data["stdout"] = outerr.out.replace(tmp_pathplus.as_posix(), "...")
data["stderr"] = outerr.err
advanced_data_regression.check(data)
def test_build_additional_files(
tmp_pathplus: PathPlus,
advanced_data_regression: AdvancedDataRegressionFixture,
file_regression: FileRegressionFixture,
capsys,
):
(tmp_pathplus / "pyproject.toml").write_lines([
COMPLETE_A,
'',
"additional-wheel-files = [",
' "include _virtualenv.py",',
']',
])
(tmp_pathplus / "whey").mkdir()
(tmp_pathplus / "whey" / "__init__.py").write_clean("print('hello world)")
(tmp_pathplus / "_virtualenv.py").write_clean("This is the _virtualenv.py file")
(tmp_pathplus / "README.rst").write_clean("Spam Spam Spam Spam")
(tmp_pathplus / "LICENSE").write_clean("This is the license")
(tmp_pathplus / "requirements.txt").write_clean("domdf_python_tools")
data = {}
with tempfile.TemporaryDirectory() as tmpdir:
wheel_builder = PthWheelBuilder(
project_dir=tmp_pathplus,
config=load_toml(tmp_pathplus / "pyproject.toml"),
build_dir=tmpdir,
out_dir=tmp_pathplus,
verbose=True,
colour=False,
)
wheel = wheel_builder.build_wheel()
assert (tmp_pathplus / wheel).is_file()
zip_file = zipfile.ZipFile(tmp_pathplus / wheel)
data["wheel_content"] = sorted(zip_file.namelist())
with zip_file.open("whey/__init__.py", mode='r') as fp:
assert fp.read().decode("UTF-8") == "print('hello world)\n"
with zip_file.open("whey-2021.0.0.dist-info/METADATA", mode='r') as fp:
check_file_regression(fp.read().decode("UTF-8"), file_regression)
with zip_file.open("my_project.pth", mode='r') as fp:
assert fp.read().decode("UTF-8") == "import _virtualenv\n"
with zip_file.open("_virtualenv.py", mode='r') as fp:
assert fp.read().decode("UTF-8") == "This is the _virtualenv.py file\n"
outerr = capsys.readouterr()
data["stdout"] = outerr.out.replace(tmp_pathplus.as_posix(), "...")
data["stderr"] = outerr.err
advanced_data_regression.check(data)
def test_badconfig():
with pytest.raises(BadConfigError, match=r"The \[tool.whey-pth.name\] key is required."):
WheyPthParser().parse({})
with pytest.raises(BadConfigError, match=r"The \[tool.whey-pth.name\] key is required."):
WheyPthParser().parse({"pth-content": "import _virtualenv"})
with pytest.raises(BadConfigError, match=r"The \[tool.whey-pth.pth-content\] key is required."):
WheyPthParser().parse({"name": "foo"})
def test_badconfig_set_defaults():
with pytest.raises(BadConfigError, match=r"The \[tool.whey-pth.name\] key is required."):
WheyPthParser().parse({}, set_defaults=True)
with pytest.raises(BadConfigError, match=r"The \[tool.whey-pth.name\] key is required."):
WheyPthParser().parse({"pth-content": "import _virtualenv"}, set_defaults=True)
with pytest.raises(BadConfigError, match=r"The \[tool.whey-pth.pth-content\] key is required."):
WheyPthParser().parse({"name": "foo"}, set_defaults=True)
|
