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
|
from __future__ import annotations
import zipfile
from email.message import Message
from pathlib import Path
from textwrap import dedent
import pytest
from _pytest.fixtures import SubRequest
from pytest import TempPathFactory
import wheel
from commands.util import run_command
from wheel._commands.convert import convert_pkg_info, egg_filename_re
from wheel.wheelfile import WheelFile
PKG_INFO = """\
Metadata-Version: 2.1
Name: Sampledist
Version: 1.0.0
Author: Alex Grönholm
Author-email: alex.gronholm@example.com
Home-page: https://example.com
Download-URL: https://example.com/sampledist
License: Sample license text
second row
third row
fourth row
Description: Sample Distribution
===================
Test description
""".encode()
REQUIRES_TXT = b"""\
somepackage>=1.5
otherpackage>=1.7
[:python_version < '3']
six
"""
EXPECTED_METADATA = """\
Metadata-Version: 2.4
Name: Sampledist
Version: 1.0.0
Author: Alex Grönholm
Author-email: alex.gronholm@example.com
Project-URL: Homepage, https://example.com
Project-URL: Download, https://example.com/sampledist
License: Sample license text
second row
third row
fourth row
Requires-Dist: somepackage>=1.5
Requires-Dist: otherpackage>=1.7
Requires-Dist: six; python_version < "3"
Sample Distribution
===================
Test description
""".encode()
@pytest.fixture(
params=[
pytest.param(("py3.7", "win32"), id="win32"),
pytest.param(("py3.7", "win_amd64"), id="amd64"),
pytest.param((None, "any"), id="pure"),
]
)
def pyver_arch(request: SubRequest) -> tuple[str | None, str]:
return request.param
@pytest.fixture
def pyver(pyver_arch: tuple[str | None, str]) -> str | None:
return pyver_arch[0]
@pytest.fixture
def arch(pyver_arch: tuple[str | None, str]) -> str:
return pyver_arch[1]
@pytest.fixture
def expected_wheelfile(arch: str) -> bytes:
root_is_purelib = str(arch == "any").lower()
text = dedent(
f"""\
Wheel-Version: 1.0
Generator: wheel {wheel.__version__}
Root-Is-Purelib: {root_is_purelib}
"""
)
if arch == "any":
text += "Tag: py2-none-any\nTag: py3-none-any\n\n"
else:
text += f"Tag: py37-cp37-{arch}\n\n"
return text.encode("utf-8")
@pytest.fixture
def bdist_wininst_path(arch: str, pyver: str | None, tmp_path: Path) -> str:
# As bdist_wininst is no longer present in Python, and carrying .exe files in the
# tarball is risky, we have to fake this a bit
if pyver:
filename = f"Sampledist-1.0.0-{arch.replace('_', '-')}-{pyver}.exe"
pyver_suffix = f"-{pyver}"
else:
filename = f"Sampledist-1.0.0-{arch.replace('_', '-')}.exe"
pyver_suffix = ""
bdist_path = tmp_path / filename
prefix = "PURELIB" if arch == "any" else "PLATLIB"
with zipfile.ZipFile(bdist_path, "w") as zip:
zip.writestr(f"{prefix}/", b"")
zip.writestr(f"{prefix}/sampledist/", b"")
zip.writestr(f"{prefix}/Sampledist-1.0.0{pyver_suffix}.egg-info/", b"")
zip.writestr(f"{prefix}/sampledist/__init__.py", b"")
if arch != "any":
zip.writestr(f"{prefix}/sampledist/_extmodule.cp37-{arch}.pyd", b"")
zip.writestr(
f"{prefix}/Sampledist-1.0.0{pyver_suffix}.egg-info/dependency_links.txt",
b"",
)
zip.writestr(
f"{prefix}/Sampledist-1.0.0{pyver_suffix}.egg-info/PKG-INFO",
PKG_INFO,
)
zip.writestr(
f"{prefix}/Sampledist-1.0.0{pyver_suffix}.egg-info/SOURCES.txt", b""
)
zip.writestr(
f"{prefix}/Sampledist-1.0.0{pyver_suffix}.egg-info/top_level.txt", b""
)
zip.writestr(
f"{prefix}/Sampledist-1.0.0{pyver_suffix}.egg-info/entry_points.txt", b""
)
zip.writestr(
f"{prefix}/Sampledist-1.0.0{pyver_suffix}.egg-info/requires.txt",
REQUIRES_TXT,
)
zip.writestr(f"{prefix}/Sampledist-1.0.0{pyver_suffix}.egg-info/zip-safe", b"")
zip.writestr("SCRIPTS/somecommand", b"#!python\nprint('hello')")
return str(bdist_path)
@pytest.fixture
def egg_path(arch: str, pyver: str | None, tmp_path: Path) -> Path:
if pyver:
filename = f"Sampledist-1.0.0-{pyver}-{arch}.egg"
else:
filename = "Sampledist-1.0.0.egg"
bdist_path = tmp_path / filename
with zipfile.ZipFile(bdist_path, "w") as zip:
zip.writestr("sampledist/", b"")
zip.writestr("EGG-INFO/", b"")
zip.writestr("sampledist/__init__.py", b"")
zip.writestr(f"sampledist/_extmodule.cp37-{arch}.pyd", b"")
zip.writestr("EGG-INFO/dependency_links.txt", b"")
zip.writestr("EGG-INFO/PKG-INFO", PKG_INFO)
zip.writestr("EGG-INFO/SOURCES.txt", b"")
zip.writestr("EGG-INFO/top_level.txt", b"")
zip.writestr("EGG-INFO/entry_points.txt", b"")
zip.writestr("EGG-INFO/requires.txt", REQUIRES_TXT)
zip.writestr("EGG-INFO/zip-safe", b"")
return bdist_path
@pytest.fixture
def expected_wheel_filename(pyver: str | None, arch: str) -> str:
if arch != "any":
pyver = pyver.replace(".", "") if pyver else "py2.py3"
abiver = pyver.replace("py", "cp")
return f"sampledist-1.0.0-{pyver}-{abiver}-{arch}.whl"
else:
return "sampledist-1.0.0-py2.py3-none-any.whl"
def test_egg_re() -> None:
"""Make sure egg_info_re matches."""
egg_names_path = Path(__file__).parent.parent / "testdata" / "eggnames.txt"
with egg_names_path.open(encoding="utf-8") as egg_names:
for line in egg_names:
line = line.strip()
if line:
assert egg_filename_re.match(line), line
def test_convert_egg_file(
egg_path: Path,
tmp_path: Path,
arch: str,
expected_wheelfile: bytes,
expected_wheel_filename: str,
) -> None:
output = run_command("convert", "-v", "--dest", tmp_path, egg_path)
wheel_path = next(path for path in tmp_path.iterdir() if path.suffix == ".whl")
assert wheel_path.name == expected_wheel_filename
with WheelFile(wheel_path) as wf:
assert wf.read("sampledist-1.0.0.dist-info/METADATA") == EXPECTED_METADATA
assert wf.read("sampledist-1.0.0.dist-info/WHEEL") == expected_wheelfile
assert wf.read("sampledist-1.0.0.dist-info/entry_points.txt") == b""
assert output == f"{egg_path}...OK\n"
def test_convert_egg_directory(
egg_path: Path,
tmp_path: Path,
tmp_path_factory: TempPathFactory,
pyver: str | None,
arch: str,
expected_wheelfile: bytes,
expected_wheel_filename: str,
) -> None:
with zipfile.ZipFile(egg_path) as egg_file:
egg_dir_path = tmp_path_factory.mktemp("eggdir") / Path(egg_path).name
egg_dir_path.mkdir()
egg_file.extractall(egg_dir_path)
output = run_command("convert", "-v", "--dest", tmp_path, egg_dir_path)
wheel_path = next(path for path in tmp_path.iterdir() if path.suffix == ".whl")
assert wheel_path.name == expected_wheel_filename
with WheelFile(wheel_path) as wf:
assert wf.read("sampledist-1.0.0.dist-info/METADATA") == EXPECTED_METADATA
assert wf.read("sampledist-1.0.0.dist-info/WHEEL") == expected_wheelfile
assert wf.read("sampledist-1.0.0.dist-info/entry_points.txt") == b""
assert output == f"{egg_dir_path}...OK\n"
def test_convert_bdist_wininst(
bdist_wininst_path: str,
tmp_path: Path,
arch: str,
expected_wheelfile: bytes,
expected_wheel_filename: str,
) -> None:
output = run_command("convert", "-v", "--dest", tmp_path, bdist_wininst_path)
wheel_path = next(path for path in tmp_path.iterdir() if path.suffix == ".whl")
assert wheel_path.name == expected_wheel_filename
with WheelFile(wheel_path) as wf:
assert (
wf.read("sampledist-1.0.0.data/scripts/somecommand")
== b"#!python\nprint('hello')"
)
assert wf.read("sampledist-1.0.0.dist-info/METADATA") == EXPECTED_METADATA
assert wf.read("sampledist-1.0.0.dist-info/WHEEL") == expected_wheelfile
assert wf.read("sampledist-1.0.0.dist-info/entry_points.txt") == b""
assert output == f"{bdist_wininst_path}...OK\n"
def test_convert_pkg_info_with_empty_description() -> None:
# Regression test for https://github.com/pypa/wheel/issues/645
pkginfo = """\
Metadata-Version: 2.1
Name: Sampledist
Version: 1.0.0
Home-page: https://example.com
Download-URL: https://example.com/sampledist
Description:"""
message = Message()
convert_pkg_info(pkginfo, message)
assert message.get_all("Name") == ["Sampledist"]
assert message.get_payload() == "\n"
def test_convert_pkg_info_with_one_line_description() -> None:
pkginfo = """\
Metadata-Version: 2.1
Name: Sampledist
Version: 1.0.0
Home-page: https://example.com
Download-URL: https://example.com/sampledist
Description: My cool package"""
message = Message()
convert_pkg_info(pkginfo, message)
assert message.get_all("Name") == ["Sampledist"]
assert message.get_payload() == "My cool package\n\n\n"
|