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
|
import os
import platform
import re
import shutil
import sys
from unittest.mock import ANY
import pytest
import shellingham
from pdm.cli.commands.venv import backends
from pdm.cli.commands.venv.utils import get_venv_prefix
@pytest.fixture(params=[True, False])
def with_pip(request):
return request.param
@pytest.fixture()
def fake_create(monkeypatch):
def fake_create(self, location, *args, prompt=None):
bin_dir = "Scripts" if sys.platform == "win32" else "bin"
suffix = ".exe" if sys.platform == "win32" else ""
(location / bin_dir).mkdir(parents=True)
(location / bin_dir / f"python{suffix}").touch()
monkeypatch.setattr(backends.VirtualenvBackend, "perform_create", fake_create)
monkeypatch.setattr(backends.VenvBackend, "perform_create", fake_create)
monkeypatch.setattr(backends.CondaBackend, "perform_create", fake_create)
@pytest.mark.usefixtures("fake_create")
def test_venv_create(pdm, project):
project._saved_python = None
project.project_config["venv.in_project"] = False
result = pdm(["venv", "create"], obj=project)
assert result.exit_code == 0, result.stderr
venv_path = re.match(r"Virtualenv (.+) is created successfully", result.output).group(1)
assert os.path.exists(venv_path)
assert not project._saved_python
@pytest.mark.usefixtures("fake_create")
def test_venv_create_in_project(pdm, project):
project.project_config["venv.in_project"] = True
pdm(["venv", "create"], obj=project, strict=True)
venv_path = project.root / ".venv"
assert venv_path.exists()
result = pdm(["venv", "create"], obj=project)
assert result.exit_code == 1
assert "is not empty" in result.stderr
@pytest.mark.usefixtures("fake_create")
def test_venv_create_other_location(pdm, project):
pdm(["venv", "-p", project.root.as_posix(), "create"], strict=True)
venv_path = project.root / ".venv"
assert venv_path.exists()
result = pdm(["venv", "-p", project.root.as_posix(), "create"])
assert result.exit_code == 1
assert "is not empty" in result.stderr
@pytest.mark.usefixtures("fake_create")
def test_venv_show_path(pdm, project):
project.project_config["venv.in_project"] = True
pdm(["venv", "create"], obj=project, strict=True)
pdm(["venv", "create", "--name", "test"], obj=project, strict=True)
result = pdm(["venv", "--path", "in-project"], obj=project, strict=True)
assert result.output.strip() == str(project.root / ".venv")
result = pdm(["venv", "--path", "test"], obj=project)
assert result.exit_code == 0
result = pdm(["venv", "--path", "foo"], obj=project)
assert result.exit_code == 1
@pytest.mark.usefixtures("fake_create")
def test_venv_list(pdm, project):
project.project_config["venv.in_project"] = False
result = pdm(["venv", "create"], obj=project)
assert result.exit_code == 0, result.stderr
venv_path = re.match(r"Virtualenv (.+) is created successfully", result.output).group(1)
result = pdm(["venv", "list"], obj=project)
assert result.exit_code == 0, result.stderr
assert venv_path in result.output
@pytest.mark.usefixtures("fake_create")
def test_venv_remove(pdm, project):
project.project_config["venv.in_project"] = False
result = pdm(["venv", "create"], obj=project)
assert result.exit_code == 0, result.stderr
venv_path = re.match(r"Virtualenv (.+) is created successfully", result.output).group(1)
key = os.path.basename(venv_path)[len(get_venv_prefix(project)) :]
result = pdm(["venv", "remove", "non-exist"], obj=project)
assert result.exit_code != 0
result = pdm(["venv", "remove", "-y", key], obj=project)
assert result.exit_code == 0, result.stderr
assert not os.path.exists(venv_path)
@pytest.mark.usefixtures("fake_create")
def test_venv_recreate(pdm, project):
project.project_config["venv.in_project"] = False
result = pdm(["venv", "create"], obj=project)
assert result.exit_code == 0, result.stderr
result = pdm(["venv", "create"], obj=project)
assert result.exit_code != 0
result = pdm(["venv", "create", "-f"], obj=project)
assert result.exit_code == 0, result.stderr
@pytest.mark.usefixtures("venv_backends")
def test_venv_activate(pdm, mocker, project):
project.project_config["venv.in_project"] = False
result = pdm(["venv", "create"], obj=project)
assert result.exit_code == 0, result.stderr
venv_path = re.match(r"Virtualenv (.+) is created successfully", result.output).group(1)
key = os.path.basename(venv_path)[len(get_venv_prefix(project)) :]
mocker.patch("shellingham.detect_shell", return_value=("bash", None))
result = pdm(["venv", "activate", key], obj=project)
assert result.exit_code == 0, result.stderr
backend = project.config["venv.backend"]
if backend == "conda":
assert result.output.startswith("conda activate")
else:
assert result.output.strip("'\"\n").endswith("activate")
if platform.system() == "Windows":
assert not result.output.startswith("source")
assert not result.output.startswith("'")
else:
assert result.output.startswith("source")
@pytest.mark.usefixtures("venv_backends")
@pytest.mark.skipif(platform.system() == "Windows", reason="UNIX only")
def test_venv_activate_tcsh(pdm, mocker, project):
project.project_config["venv.in_project"] = False
result = pdm(["venv", "create"], obj=project)
assert result.exit_code == 0, result.stderr
venv_path = re.match(r"Virtualenv (.+) is created successfully", result.output).group(1)
key = os.path.basename(venv_path)[len(get_venv_prefix(project)) :]
mocker.patch("shellingham.detect_shell", return_value=("tcsh", None))
result = pdm(["venv", "activate", key], obj=project)
assert result.output.startswith("source") and result.output.strip("'\"\n").endswith("activate.csh")
@pytest.mark.usefixtures("venv_backends")
def test_venv_activate_custom_prompt(pdm, mocker, project):
project.project_config["venv.in_project"] = False
creator = mocker.patch("pdm.cli.commands.venv.backends.Backend.create")
result = pdm(["venv", "create"], obj=project)
assert result.exit_code == 0, result.stderr
creator.assert_called_once_with(
None, [], False, False, prompt=project.project_config["venv.prompt"], with_pip=False
)
def test_venv_activate_project_without_python(pdm, project):
project._saved_python = None
result = pdm(["venv", "activate"], obj=project)
assert result.exit_code != 0
assert "The project doesn't have a saved python.path" in result.stderr
@pytest.mark.usefixtures("fake_create")
def test_venv_activate_error(pdm, project):
project.project_config["venv.in_project"] = False
result = pdm(["venv", "create"], obj=project, strict=True)
result = pdm(["venv", "activate", "foo"], obj=project)
assert result.exit_code != 0
assert "No virtualenv with key" in result.stderr
project._saved_python = os.path.abspath("fake/bin/python")
result = pdm(["venv", "activate"], obj=project)
assert result.exit_code != 0, result.output + result.stderr
assert "Can't activate a non-venv Python" in result.stderr
@pytest.mark.usefixtures("venv_backends")
def test_venv_activate_no_shell(pdm, mocker, project):
project.project_config["venv.in_project"] = False
result = pdm(["venv", "create"], obj=project)
assert result.exit_code == 0, result.stderr
venv_path = re.match(r"Virtualenv (.+) is created successfully", result.output).group(1)
key = os.path.basename(venv_path)[len(get_venv_prefix(project)) :]
mocker.patch("shellingham.detect_shell", side_effect=shellingham.ShellDetectionFailure())
result = pdm(["venv", "activate", key], obj=project)
assert result.exit_code == 0, result.stderr
backend = project.config["venv.backend"]
if backend == "conda":
assert result.output.startswith("conda activate")
else:
assert result.output.strip("'\"\n").endswith("activate")
if platform.system() == "Windows":
assert not result.output.startswith("source")
assert not result.output.startswith("'")
else:
assert result.output.startswith("source")
@pytest.mark.usefixtures("fake_create")
@pytest.mark.parametrize("keep_pypackages", [True, False])
def test_venv_auto_create(pdm, mocker, project, keep_pypackages):
creator = mocker.patch("pdm.cli.commands.venv.backends.Backend.create")
project._saved_python = None
if keep_pypackages:
project.root.joinpath("__pypackages__").mkdir(exist_ok=True)
else:
shutil.rmtree(project.root / "__pypackages__", ignore_errors=True)
project.project_config["python.use_venv"] = True
pdm(["install", "--no-self"], obj=project)
if keep_pypackages:
creator.assert_not_called()
else:
creator.assert_called_once()
@pytest.mark.usefixtures("fake_create")
def test_venv_purge(pdm, project):
project.project_config["venv.in_project"] = False
result = pdm(["venv", "purge"], obj=project)
assert result.exit_code == 0, result.stderr
result = pdm(["venv", "create"], obj=project)
assert result.exit_code == 0, result.stderr
venv_path = re.match(r"Virtualenv (.+) is created successfully", result.output).group(1)
result = pdm(["venv", "purge"], input="y", obj=project)
assert result.exit_code == 0, result.stderr
assert not os.path.exists(venv_path)
@pytest.mark.usefixtures("fake_create")
def test_venv_purge_force(pdm, project):
project.project_config["venv.in_project"] = False
result = pdm(["venv", "create"], obj=project)
assert result.exit_code == 0, result.stderr
venv_path = re.match(r"Virtualenv (.+) is created successfully", result.output).group(1)
result = pdm(["venv", "purge", "-f"], obj=project)
assert result.exit_code == 0, result.stderr
assert not os.path.exists(venv_path)
user_options = [("none", True), ("0", False), ("all", False)]
@pytest.mark.usefixtures("venv_backends")
@pytest.mark.parametrize("user_choices, is_path_exists", user_options)
def test_venv_purge_interactive(pdm, user_choices, is_path_exists, project):
project.project_config["venv.in_project"] = False
result = pdm(["venv", "create"], obj=project)
assert result.exit_code == 0, result.stderr
venv_path = re.match(r"Virtualenv (.+) is created successfully", result.output).group(1)
result = pdm(["venv", "purge", "-i"], input=user_choices, obj=project)
assert result.exit_code == 0, result.stderr
assert os.path.exists(venv_path) == is_path_exists
def test_virtualenv_backend_create(project, mocker, with_pip):
backend = backends.VirtualenvBackend(project, None)
assert backend.ident
mock_call = mocker.patch("subprocess.check_call")
location = backend.create(with_pip=with_pip)
pip_args = [] if with_pip else ["--no-pip", "--no-setuptools", "--no-wheel"]
mock_call.assert_called_once_with(
[
sys.executable,
"-m",
"virtualenv",
str(location),
"-p",
str(backend._resolved_interpreter.executable),
*pip_args,
],
stdout=ANY,
)
def test_venv_backend_create(project, mocker, with_pip):
backend = backends.VenvBackend(project, None)
assert backend.ident
mock_call = mocker.patch("subprocess.check_call")
location = backend.create(with_pip=with_pip)
pip_args = [] if with_pip else ["--without-pip"]
mock_call.assert_called_once_with(
[
str(backend._resolved_interpreter.executable),
"-m",
"venv",
str(location),
*pip_args,
],
stdout=ANY,
)
def test_conda_backend_create(project, mocker, with_pip):
assert project.python
backend = backends.CondaBackend(project, "3.9")
assert backend.ident == "3.9"
mock_call = mocker.patch("subprocess.check_call")
location = backend.create(with_pip=with_pip)
pip_args = ["pip"] if with_pip else []
mock_call.assert_called_once_with(
[
"conda",
"create",
"--yes",
"--prefix",
str(location),
"python=3.9",
*pip_args,
],
stdout=ANY,
)
backend = backends.CondaBackend(project, None)
python_version = f"{sys.version_info.major}.{sys.version_info.minor}"
assert backend.ident.startswith(python_version)
location = backend.create()
mock_call.assert_called_with(
[
"conda",
"create",
"--yes",
"--prefix",
str(location),
f"python={python_version}",
],
stdout=ANY,
)
|