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
|
from __future__ import annotations
import logging
import os
import subprocess
import sys
from argparse import Namespace
from pathlib import Path
from unittest.mock import patch
from uuid import uuid4
import pytest
from virtualenv.discovery.builtin import Builtin, LazyPathDump, get_interpreter, get_paths
from virtualenv.discovery.py_info import PythonInfo
from virtualenv.info import IS_WIN, fs_supports_symlink
@pytest.mark.skipif(not fs_supports_symlink(), reason="symlink not supported")
@pytest.mark.parametrize("case", ["mixed", "lower", "upper"])
@pytest.mark.parametrize("specificity", ["more", "less", "none"])
def test_discovery_via_path(monkeypatch, case, specificity, tmp_path, caplog, session_app_data): # noqa: PLR0913
caplog.set_level(logging.DEBUG)
current = PythonInfo.current_system(session_app_data)
name = "somethingVeryCryptic"
threaded = "t" if current.free_threaded else ""
if case == "lower":
name = name.lower()
elif case == "upper":
name = name.upper()
if specificity == "more":
# e.g. spec: python3, exe: /bin/python3.12
core_ver = current.version_info.major
exe_ver = ".".join(str(i) for i in current.version_info[0:2]) + threaded
elif specificity == "less":
# e.g. spec: python3.12.1, exe: /bin/python3
core_ver = ".".join(str(i) for i in current.version_info[0:3])
exe_ver = current.version_info.major
elif specificity == "none":
# e.g. spec: python3.12.1, exe: /bin/python
core_ver = ".".join(str(i) for i in current.version_info[0:3])
exe_ver = ""
core = "" if specificity == "none" else f"{name}{core_ver}{threaded}"
exe_name = f"{name}{exe_ver}{'.exe' if sys.platform == 'win32' else ''}"
target = tmp_path / current.install_path("scripts")
target.mkdir(parents=True)
executable = target / exe_name
os.symlink(sys.executable, str(executable))
pyvenv_cfg = Path(sys.executable).parents[1] / "pyvenv.cfg"
if pyvenv_cfg.exists():
(target / pyvenv_cfg.name).write_bytes(pyvenv_cfg.read_bytes())
new_path = os.pathsep.join([str(target), *os.environ.get("PATH", "").split(os.pathsep)])
monkeypatch.setenv("PATH", new_path)
interpreter = get_interpreter(core, [])
assert interpreter is not None
def test_discovery_via_path_not_found(tmp_path, monkeypatch):
monkeypatch.setenv("PATH", str(tmp_path))
interpreter = get_interpreter(uuid4().hex, [])
assert interpreter is None
def test_discovery_via_path_in_nonbrowseable_directory(tmp_path, monkeypatch):
bad_perm = tmp_path / "bad_perm"
bad_perm.mkdir(mode=0o000)
# path entry is unreadable
monkeypatch.setenv("PATH", str(bad_perm))
interpreter = get_interpreter(uuid4().hex, [])
assert interpreter is None
# path entry parent is unreadable
monkeypatch.setenv("PATH", str(bad_perm / "bin"))
interpreter = get_interpreter(uuid4().hex, [])
assert interpreter is None
def test_relative_path(session_app_data, monkeypatch):
sys_executable = Path(PythonInfo.current_system(app_data=session_app_data).system_executable)
cwd = sys_executable.parents[1]
monkeypatch.chdir(str(cwd))
relative = str(sys_executable.relative_to(cwd))
result = get_interpreter(relative, [], session_app_data)
assert result is not None
def test_uv_python(monkeypatch, tmp_path_factory, mocker):
monkeypatch.delenv("UV_PYTHON_INSTALL_DIR", raising=False)
monkeypatch.delenv("XDG_DATA_HOME", raising=False)
monkeypatch.setenv("PATH", "")
mocker.patch.object(PythonInfo, "satisfies", return_value=False)
# UV_PYTHON_INSTALL_DIR
uv_python_install_dir = tmp_path_factory.mktemp("uv_python_install_dir")
with patch("virtualenv.discovery.builtin.PathPythonInfo.from_exe") as mock_from_exe, monkeypatch.context() as m:
m.setenv("UV_PYTHON_INSTALL_DIR", str(uv_python_install_dir))
get_interpreter("python", [])
mock_from_exe.assert_not_called()
bin_path = uv_python_install_dir.joinpath("some-py-impl", "bin")
bin_path.mkdir(parents=True)
bin_path.joinpath("python").touch()
get_interpreter("python", [])
mock_from_exe.assert_called_once()
assert mock_from_exe.call_args[0][0] == str(bin_path / "python")
# XDG_DATA_HOME
xdg_data_home = tmp_path_factory.mktemp("xdg_data_home")
with patch("virtualenv.discovery.builtin.PathPythonInfo.from_exe") as mock_from_exe, monkeypatch.context() as m:
m.setenv("XDG_DATA_HOME", str(xdg_data_home))
get_interpreter("python", [])
mock_from_exe.assert_not_called()
bin_path = xdg_data_home.joinpath("uv", "python", "some-py-impl", "bin")
bin_path.mkdir(parents=True)
bin_path.joinpath("python").touch()
get_interpreter("python", [])
mock_from_exe.assert_called_once()
assert mock_from_exe.call_args[0][0] == str(bin_path / "python")
# User data path
user_data_path = tmp_path_factory.mktemp("user_data_path")
with patch("virtualenv.discovery.builtin.PathPythonInfo.from_exe") as mock_from_exe, monkeypatch.context() as m:
m.setattr("virtualenv.discovery.builtin.user_data_path", lambda x: user_data_path / x)
get_interpreter("python", [])
mock_from_exe.assert_not_called()
bin_path = user_data_path.joinpath("uv", "python", "some-py-impl", "bin")
bin_path.mkdir(parents=True)
bin_path.joinpath("python").touch()
get_interpreter("python", [])
mock_from_exe.assert_called_once()
assert mock_from_exe.call_args[0][0] == str(bin_path / "python")
def test_discovery_fallback_fail(session_app_data, caplog):
caplog.set_level(logging.DEBUG)
builtin = Builtin(
Namespace(app_data=session_app_data, try_first_with=[], python=["magic-one", "magic-two"], env=os.environ),
)
result = builtin.run()
assert result is None
assert "accepted" not in caplog.text
def test_discovery_fallback_ok(session_app_data, caplog):
caplog.set_level(logging.DEBUG)
builtin = Builtin(
Namespace(app_data=session_app_data, try_first_with=[], python=["magic-one", sys.executable], env=os.environ),
)
result = builtin.run()
assert result is not None, caplog.text
assert result.executable == sys.executable, caplog.text
assert "accepted" in caplog.text
@pytest.fixture
def mock_get_interpreter(mocker):
return mocker.patch(
"virtualenv.discovery.builtin.get_interpreter",
lambda key, *args, **kwargs: getattr(mocker.sentinel, key), # noqa: ARG005
)
@pytest.mark.usefixtures("mock_get_interpreter")
def test_returns_first_python_specified_when_only_env_var_one_is_specified(mocker, monkeypatch, session_app_data):
monkeypatch.setenv("VIRTUALENV_PYTHON", "python_from_env_var")
builtin = Builtin(
Namespace(app_data=session_app_data, try_first_with=[], python=["python_from_env_var"], env=os.environ),
)
result = builtin.run()
assert result == mocker.sentinel.python_from_env_var
@pytest.mark.usefixtures("mock_get_interpreter")
def test_returns_second_python_specified_when_more_than_one_is_specified_and_env_var_is_specified(
mocker, monkeypatch, session_app_data
):
monkeypatch.setenv("VIRTUALENV_PYTHON", "python_from_env_var")
builtin = Builtin(
Namespace(
app_data=session_app_data,
try_first_with=[],
python=["python_from_env_var", "python_from_cli"],
env=os.environ,
),
)
result = builtin.run()
assert result == mocker.sentinel.python_from_cli
def test_discovery_absolute_path_with_try_first(tmp_path, session_app_data):
good_env = tmp_path / "good"
bad_env = tmp_path / "bad"
# Create two real virtual environments
subprocess.check_call([sys.executable, "-m", "virtualenv", str(good_env)])
subprocess.check_call([sys.executable, "-m", "virtualenv", str(bad_env)])
# On Windows, the executable is in Scripts/python.exe
scripts_dir = "Scripts" if IS_WIN else "bin"
exe_name = "python.exe" if IS_WIN else "python"
good_exe = good_env / scripts_dir / exe_name
bad_exe = bad_env / scripts_dir / exe_name
# The spec is an absolute path, this should be a hard requirement.
# The --try-first-with option should be rejected as it does not match the spec.
interpreter = get_interpreter(
str(good_exe),
try_first_with=[str(bad_exe)],
app_data=session_app_data,
)
assert interpreter is not None
assert Path(interpreter.executable) == good_exe
def test_discovery_via_path_with_file(tmp_path, monkeypatch):
a_file = tmp_path / "a_file"
a_file.touch()
monkeypatch.setenv("PATH", str(a_file))
interpreter = get_interpreter(uuid4().hex, [])
assert interpreter is None
def test_absolute_path_does_not_exist(tmp_path):
"""
Test that virtualenv does not fail when an absolute path that does not exist is provided.
"""
# Create a command that uses an absolute path that does not exist
# and a valid python executable.
command = [
sys.executable,
"-m",
"virtualenv",
"-p",
"/this/path/does/not/exist",
"-p",
sys.executable,
str(tmp_path / "dest"),
]
# Run the command
process = subprocess.run(
command,
capture_output=True,
text=True,
check=False,
encoding="utf-8",
)
# Check that the command was successful
assert process.returncode == 0, process.stderr
def test_absolute_path_does_not_exist_fails(tmp_path):
"""
Test that virtualenv fails when a single absolute path that does not exist is provided.
"""
# Create a command that uses an absolute path that does not exist
command = [
sys.executable,
"-m",
"virtualenv",
"-p",
"/this/path/does/not/exist",
str(tmp_path / "dest"),
]
# Run the command
process = subprocess.run(
command,
capture_output=True,
text=True,
check=False,
encoding="utf-8",
)
# Check that the command failed
assert process.returncode != 0, process.stderr
def test_get_paths_no_path_env(monkeypatch):
monkeypatch.delenv("PATH", raising=False)
paths = list(get_paths({}))
assert paths
def test_lazy_path_dump_debug(monkeypatch, tmp_path):
monkeypatch.setenv("_VIRTUALENV_DEBUG", "1")
a_dir = tmp_path
executable_file = "a_file.exe" if IS_WIN else "a_file"
(a_dir / executable_file).touch(mode=0o755)
(a_dir / "b_file").touch(mode=0o644)
dumper = LazyPathDump(0, a_dir, os.environ)
output = repr(dumper)
assert executable_file in output
assert "b_file" not in output
@pytest.mark.usefixtures("mock_get_interpreter")
def test_returns_first_python_specified_when_no_env_var_is_specified(mocker, monkeypatch, session_app_data):
monkeypatch.delenv("VIRTUALENV_PYTHON", raising=False)
builtin = Builtin(
Namespace(app_data=session_app_data, try_first_with=[], python=["python_from_cli"], env=os.environ),
)
result = builtin.run()
assert result == mocker.sentinel.python_from_cli
|