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
|
from __future__ import annotations
from pathlib import Path
from textwrap import dedent
from typing import Callable, Literal
import pytest
from packaging.requirements import Requirement
from pyproject_api._frontend import BackendFailed
from pyproject_api._via_fresh_subprocess import SubprocessFrontend
@pytest.fixture
def local_builder(tmp_path: Path) -> Callable[[str], Path]:
def _f(content: str) -> Path:
toml = '[build-system]\nrequires=[]\nbuild-backend = "build_tester"\nbackend-path=["."]'
(tmp_path / "pyproject.toml").write_text(toml)
(tmp_path / "build_tester.py").write_text(dedent(content))
return tmp_path
return _f
def test_missing_backend(local_builder: Callable[[str], Path]) -> None:
tmp_path = local_builder("")
toml = tmp_path / "pyproject.toml"
toml.write_text('[build-system]\nrequires=[]\nbuild-backend = "build_tester"')
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(tmp_path)[:-1])
with pytest.raises(BackendFailed) as context:
frontend.build_wheel(tmp_path / "wheel")
exc = context.value
assert exc.exc_type == "RuntimeError"
assert exc.code == 1
assert "failed to start backend" in exc.err
assert "ModuleNotFoundError: No module named " in exc.err
@pytest.mark.parametrize("cmd", ["build_wheel", "build_sdist"])
def test_missing_required_cmd(cmd: str, local_builder: Callable[[str], Path]) -> None:
tmp_path = local_builder("")
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(tmp_path)[:-1])
with pytest.raises(BackendFailed) as context:
getattr(frontend, cmd)(tmp_path)
exc = context.value
assert f"has no attribute '{cmd}'" in exc.exc_msg
assert exc.exc_type == "MissingCommand"
def test_empty_pyproject(tmp_path: Path) -> None:
(tmp_path / "pyproject.toml").write_text("[build-system]")
root, backend_paths, backend_module, backend_obj, requires, _ = SubprocessFrontend.create_args_from_folder(tmp_path)
assert root == tmp_path
assert backend_paths == ()
assert backend_module == "setuptools.build_meta"
assert backend_obj == "__legacy__"
for left, right in zip(requires, (Requirement("setuptools>=40.8.0"), Requirement("wheel"))):
assert isinstance(left, Requirement)
assert str(left) == str(right)
@pytest.fixture(scope="session")
def demo_pkg_inline() -> Path:
return Path(__file__).absolute().parent / "demo_pkg_inline"
def test_backend_no_prepare_wheel(tmp_path: Path, demo_pkg_inline: Path) -> None:
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(demo_pkg_inline)[:-1])
result = frontend.prepare_metadata_for_build_wheel(tmp_path)
assert result is None
def test_backend_build_sdist_demo_pkg_inline(tmp_path: Path, demo_pkg_inline: Path) -> None:
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(demo_pkg_inline)[:-1])
result = frontend.build_sdist(sdist_directory=tmp_path)
assert result.sdist == tmp_path / "demo_pkg_inline-1.0.0.tar.gz"
def test_backend_obj(tmp_path: Path) -> None:
toml = """
[build-system]
requires=[]
build-backend = "build.api:backend:"
backend-path=["."]
"""
api = """
class A:
def get_requires_for_build_sdist(self, config_settings=None):
return ["a"]
backend = A()
"""
(tmp_path / "pyproject.toml").write_text(dedent(toml))
build = tmp_path / "build"
build.mkdir()
(build / "__init__.py").write_text("")
(build / "api.py").write_text(dedent(api))
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(tmp_path)[:-1])
result = frontend.get_requires_for_build_sdist()
for left, right in zip(result.requires, (Requirement("a"),)):
assert isinstance(left, Requirement)
assert str(left) == str(right)
@pytest.mark.parametrize("of_type", ["wheel", "sdist"])
def test_get_requires_for_build_missing(of_type: str, local_builder: Callable[[str], Path]) -> None:
tmp_path = local_builder("")
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(tmp_path)[:-1])
result = getattr(frontend, f"get_requires_for_build_{of_type}")()
assert result.requires == ()
@pytest.mark.parametrize("of_type", ["sdist", "wheel"])
def test_bad_return_type_get_requires_for_build(of_type: str, local_builder: Callable[[str], Path]) -> None:
tmp_path = local_builder(f"def get_requires_for_build_{of_type}(config_settings=None): return 1")
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(tmp_path)[:-1])
with pytest.raises(BackendFailed) as context:
getattr(frontend, f"get_requires_for_build_{of_type}")()
exc = context.value
msg = f"'get_requires_for_build_{of_type}' on 'build_tester' returned 1 but expected type 'list of string'"
assert exc.exc_msg == msg
assert exc.exc_type == "TypeError"
def test_bad_return_type_build_sdist(local_builder: Callable[[str], Path]) -> None:
tmp_path = local_builder("def build_sdist(sdist_directory, config_settings=None): return 1")
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(tmp_path)[:-1])
with pytest.raises(BackendFailed) as context:
frontend.build_sdist(tmp_path)
exc = context.value
assert exc.exc_msg == f"'build_sdist' on 'build_tester' returned 1 but expected type {str!r}"
assert exc.exc_type == "TypeError"
def test_bad_return_type_build_wheel(local_builder: Callable[[str], Path]) -> None:
txt = "def build_wheel(wheel_directory, config_settings=None, metadata_directory=None): return 1"
tmp_path = local_builder(txt)
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(tmp_path)[:-1])
with pytest.raises(BackendFailed) as context:
frontend.build_wheel(tmp_path)
exc = context.value
assert exc.exc_msg == f"'build_wheel' on 'build_tester' returned 1 but expected type {str!r}"
assert exc.exc_type == "TypeError"
def test_bad_return_type_prepare_metadata_for_build_wheel(local_builder: Callable[[str], Path]) -> None:
tmp_path = local_builder("def prepare_metadata_for_build_wheel(metadata_directory, config_settings=None): return 1")
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(tmp_path)[:-1])
with pytest.raises(BackendFailed) as context:
frontend.prepare_metadata_for_build_wheel(tmp_path / "meta")
exc = context.value
assert exc.exc_type == "TypeError"
assert exc.exc_msg == f"'prepare_metadata_for_build_wheel' on 'build_tester' returned 1 but expected type {str!r}"
def test_prepare_metadata_for_build_wheel_meta_is_root(local_builder: Callable[[str], Path]) -> None:
tmp_path = local_builder("def prepare_metadata_for_build_wheel(metadata_directory, config_settings=None): return 1")
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(tmp_path)[:-1])
with pytest.raises(RuntimeError) as context:
frontend.prepare_metadata_for_build_wheel(tmp_path)
assert str(context.value) == f"the project root and the metadata directory can't be the same {tmp_path}"
def test_no_wheel_prepare_metadata_for_build_wheel(local_builder: Callable[[str], Path]) -> None:
txt = "def build_wheel(wheel_directory, config_settings=None, metadata_directory=None): return 'out'"
tmp_path = local_builder(txt)
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(tmp_path)[:-1])
with pytest.raises(RuntimeError, match=r"missing wheel file return by backed *"):
frontend.metadata_from_built(tmp_path, "wheel")
@pytest.mark.parametrize("target", ["wheel", "editable"])
def test_metadata_from_built_wheel(
demo_pkg_inline: Path,
tmp_path: Path,
target: Literal["wheel", "editable"],
monkeypatch: pytest.MonkeyPatch,
) -> None:
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(demo_pkg_inline)[:-1])
monkeypatch.chdir(tmp_path)
path, out, err = frontend.metadata_from_built(tmp_path, target)
assert path == tmp_path / "demo_pkg_inline-1.0.0.dist-info"
assert {p.name for p in path.iterdir()} == {"top_level.txt", "WHEEL", "RECORD", "METADATA"}
assert f" build_{target}" in out
assert not err
def test_bad_wheel_metadata_from_built_wheel(local_builder: Callable[[str], Path]) -> None:
txt = """
import sys
from pathlib import Path
from zipfile import ZipFile
def build_wheel(wheel_directory, config_settings=None, metadata_directory=None):
path = Path(wheel_directory) / "out"
with ZipFile(str(path), "w") as zip_file_handler:
pass
print(f"created wheel {path}")
return path.name
"""
tmp_path = local_builder(txt)
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(tmp_path)[:-1])
with pytest.raises(RuntimeError, match=r"no .dist-info found inside generated wheel*"):
frontend.metadata_from_built(tmp_path, "wheel")
def test_create_no_pyproject(tmp_path: Path) -> None:
result = SubprocessFrontend.create_args_from_folder(tmp_path)
assert len(result) == 6
assert result[0] == tmp_path
assert result[1] == ()
assert result[2] == "setuptools.build_meta"
assert result[3] == "__legacy__"
assert all(isinstance(i, Requirement) for i in result[4])
assert [str(i) for i in result[4]] == ["setuptools>=40.8.0", "wheel"]
assert result[5] is True
def test_backend_get_requires_for_build_editable(demo_pkg_inline: Path, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setenv("HAS_REQUIRES_EDITABLE", "1")
monkeypatch.delenv("REQUIRES_EDITABLE_BAD_RETURN", raising=False)
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(demo_pkg_inline)[:-1])
result = frontend.get_requires_for_build_editable()
assert [str(i) for i in result.requires] == ["editables"]
assert isinstance(result.requires[0], Requirement)
assert " get_requires_for_build_editable " in result.out
assert not result.err
def test_backend_get_requires_for_build_editable_miss(demo_pkg_inline: Path, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.delenv("HAS_REQUIRES_EDITABLE", raising=False)
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(demo_pkg_inline)[:-1])
result = frontend.get_requires_for_build_editable()
assert not result.requires
assert not result.out
assert not result.err
def test_backend_get_requires_for_build_editable_bad(demo_pkg_inline: Path, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setenv("HAS_REQUIRES_EDITABLE", "1")
monkeypatch.setenv("REQUIRES_EDITABLE_BAD_RETURN", "1")
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(demo_pkg_inline)[:-1])
with pytest.raises(BackendFailed) as context:
frontend.get_requires_for_build_editable()
exc = context.value
assert exc.code is None
assert not exc.err
assert " get_requires_for_build_editable " in exc.out
assert not exc.args
assert exc.exc_type == "TypeError"
assert exc.exc_msg == "'get_requires_for_build_editable' on 'build' returned [1] but expected type 'list of string'"
def test_backend_prepare_editable(tmp_path: Path, demo_pkg_inline: Path, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setenv("HAS_PREPARE_EDITABLE", "1")
monkeypatch.delenv("PREPARE_EDITABLE_BAD", raising=False)
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(demo_pkg_inline)[:-1])
result = frontend.prepare_metadata_for_build_editable(tmp_path)
assert result is not None
assert result.metadata.name == "demo_pkg_inline-1.0.0.dist-info"
assert " prepare_metadata_for_build_editable " in result.out
assert " build_editable " not in result.out
assert not result.err
def test_backend_prepare_editable_miss(tmp_path: Path, demo_pkg_inline: Path, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.delenv("HAS_PREPARE_EDITABLE", raising=False)
monkeypatch.delenv("BUILD_EDITABLE_BAD", raising=False)
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(demo_pkg_inline)[:-1])
result = frontend.prepare_metadata_for_build_editable(tmp_path)
assert result is None
def test_backend_prepare_editable_bad(tmp_path: Path, demo_pkg_inline: Path, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setenv("HAS_PREPARE_EDITABLE", "1")
monkeypatch.setenv("PREPARE_EDITABLE_BAD", "1")
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(demo_pkg_inline)[:-1])
with pytest.raises(BackendFailed) as context:
frontend.prepare_metadata_for_build_editable(tmp_path)
exc = context.value
assert exc.code is None
assert not exc.err
assert " prepare_metadata_for_build_editable " in exc.out
assert not exc.args
assert exc.exc_type == "TypeError"
assert exc.exc_msg == "'prepare_metadata_for_build_wheel' on 'build' returned 1 but expected type <class 'str'>"
def test_backend_build_editable(tmp_path: Path, demo_pkg_inline: Path, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.delenv("BUILD_EDITABLE_BAD", raising=False)
monkeypatch.setenv("HAS_PREPARE_EDITABLE", "1")
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(demo_pkg_inline)[:-1])
meta = tmp_path / "meta"
res = frontend.prepare_metadata_for_build_editable(meta)
assert res is not None
metadata = res.metadata
assert metadata is not None
assert metadata.name == "demo_pkg_inline-1.0.0.dist-info"
result = frontend.build_editable(tmp_path, metadata_directory=meta)
assert result.wheel.name == "demo_pkg_inline-1.0.0-py3-none-any.whl"
assert " build_editable " in result.out
assert not result.err
def test_backend_build_wheel(tmp_path: Path, demo_pkg_inline: Path) -> None:
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(demo_pkg_inline)[:-1])
result = frontend.build_wheel(tmp_path)
assert result.wheel.name == "demo_pkg_inline-1.0.0-py3-none-any.whl"
assert " build_wheel " in result.out
assert not result.err
def test_backend_build_editable_bad(tmp_path: Path, demo_pkg_inline: Path, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setenv("BUILD_EDITABLE_BAD", "1")
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(demo_pkg_inline)[:-1])
with pytest.raises(BackendFailed) as context:
frontend.build_editable(tmp_path)
exc = context.value
assert exc.code is None
assert not exc.err
assert " build_editable " in exc.out
assert not exc.args
assert exc.exc_type == "TypeError"
assert exc.exc_msg == "'build_editable' on 'build' returned 1 but expected type <class 'str'>"
|