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
|
import json
import os
import shutil
import socket
import subprocess
import sys
from contextlib import closing
from http import HTTPStatus
from pathlib import Path
from typing import Iterator
from urllib.error import HTTPError, URLError
from urllib.request import urlopen
import pytest # type: ignore[import-not-found]
from helpers import WIN
from pipx import commands, interpreter, paths, shared_libs, standalone_python, venv
PIPX_TESTS_DIR = Path(".pipx_tests")
PIPX_TESTS_PACKAGE_LIST_DIR = Path("testdata/tests_packages")
@pytest.fixture(scope="session")
def root() -> Path:
return Path(__file__).parents[1]
@pytest.fixture()
def mocked_github_api(monkeypatch, root):
"""
Fixture to replace the github index with a local copy,
to prevent unit tests from exceeding github's API request limit.
"""
with open(root / "testdata" / "standalone_python_index_20250818.json") as f:
index = json.load(f)
monkeypatch.setattr(standalone_python, "get_or_update_index", lambda _: index)
def pytest_addoption(parser):
parser.addoption(
"--all-packages",
action="store_true",
dest="all_packages",
default=False,
help="Run only the long, slow tests installing the maximum list of packages.",
)
parser.addoption(
"--net-pypiserver",
action="store_true",
dest="net_pypiserver",
default=False,
help="Start local pypi server and use in tests.",
)
def pytest_configure(config):
markexpr = getattr(config.option, "markexpr", "")
if config.option.all_packages:
new_markexpr = (f"{markexpr} or " if markexpr else "") + "all_packages"
else:
new_markexpr = (f"{markexpr} and " if markexpr else "") + "not all_packages"
config.option.markexpr = new_markexpr
def pipx_temp_env_helper(pipx_shared_dir, tmp_path, monkeypatch, request, utils_temp_dir, pypi):
home_dir = Path(tmp_path) / "subdir" / "pipxhome"
bin_dir = Path(tmp_path) / "otherdir" / "pipxbindir"
man_dir = Path(tmp_path) / "otherdir" / "pipxmandir"
global_home_dir = Path(tmp_path) / "global" / "pipxhome"
global_bin_dir = Path(tmp_path) / "global_otherdir" / "pipxbindir"
global_man_dir = Path(tmp_path) / "global_otherdir" / "pipxmandir"
# Patch in test specific paths
monkeypatch.setattr(paths, "OVERRIDE_PIPX_HOME", home_dir)
monkeypatch.setattr(paths, "OVERRIDE_PIPX_BIN_DIR", bin_dir)
monkeypatch.setattr(paths, "OVERRIDE_PIPX_MAN_DIR", man_dir)
monkeypatch.setattr(paths, "OVERRIDE_PIPX_SHARED_LIBS", pipx_shared_dir)
monkeypatch.setattr(paths, "OVERRIDE_PIPX_GLOBAL_HOME", global_home_dir)
monkeypatch.setattr(paths, "OVERRIDE_PIPX_GLOBAL_BIN_DIR", global_bin_dir)
monkeypatch.setattr(paths, "OVERRIDE_PIPX_GLOBAL_MAN_DIR", global_man_dir)
# Refresh paths.ctx to commit the overrides
paths.ctx.make_local()
# Reset internal state of shared_libs
monkeypatch.setattr(shared_libs, "shared_libs", shared_libs._SharedLibs())
monkeypatch.setattr(venv, "shared_libs", shared_libs.shared_libs)
monkeypatch.setattr(interpreter, "DEFAULT_PYTHON", sys.executable)
if "PIPX_DEFAULT_PYTHON" in os.environ:
monkeypatch.delenv("PIPX_DEFAULT_PYTHON")
# macOS needs /usr/bin in PATH to compile certain packages, but
# applications in /usr/bin cause test_install.py tests to raise warnings
# which make tests fail (e.g. on Github ansible apps exist in /usr/bin)
monkeypatch.setenv("PATH_ORIG", str(paths.ctx.bin_dir) + os.pathsep + os.environ["PATH"])
monkeypatch.setenv("PATH_TEST", str(paths.ctx.bin_dir))
monkeypatch.setenv("PATH", str(paths.ctx.bin_dir) + os.pathsep + str(utils_temp_dir))
# On Windows, monkeypatch pipx.commands.common._can_symlink_cache to
# indicate that paths.ctx.bin_dir and paths.ctx.man_dir
# cannot use symlinks, even if we're running as administrator and
# symlinks are actually possible.
if WIN:
monkeypatch.setitem(commands.common._can_symlink_cache, paths.ctx.bin_dir, False)
monkeypatch.setitem(commands.common._can_symlink_cache, paths.ctx.man_dir, False)
if not request.config.option.net_pypiserver:
# IMPORTANT: use 127.0.0.1 not localhost
# Using localhost on Windows creates enormous slowdowns
# (for some reason--perhaps IPV6/IPV4 tries, timeouts?)
monkeypatch.setenv("PIP_INDEX_URL", pypi)
@pytest.fixture(scope="session", autouse=True)
def pipx_local_pypiserver(request, root: Path, tmp_path_factory) -> Iterator[str]:
"""Starts local pypiserver once per session unless --net-pypiserver was
passed to pytest"""
if request.config.option.net_pypiserver:
# need both yield and return because other codepath has both
yield ""
return
pipx_cache_dir = root / PIPX_TESTS_DIR / "package_cache"
check_test_packages_cmd = [
sys.executable,
"scripts/update_package_cache.py",
"--check-only",
str(PIPX_TESTS_PACKAGE_LIST_DIR),
str(pipx_cache_dir),
]
update_test_packages_cmd = [
sys.executable,
"scripts/update_package_cache.py",
str(PIPX_TESTS_PACKAGE_LIST_DIR),
str(pipx_cache_dir),
]
check_test_packages_process = subprocess.run(check_test_packages_cmd, check=False, cwd=root)
if check_test_packages_process.returncode != 0:
raise Exception(
f"Directory {pipx_cache_dir!s} does not contain all "
"package distribution files necessary to run pipx tests. Please "
"run the following command to populate it: "
f"{' '.join(update_test_packages_cmd)}"
)
def find_free_port():
with closing(socket.socket(socket.AF_INET, socket.SOCK_STREAM)) as s:
s.bind(("", 0))
return s.getsockname()[1]
server_log = tmp_path_factory.mktemp("log") / "pypiserver.log"
if server_log.exists():
server_log.unlink()
port = find_free_port()
os.environ["NO_PROXY"] = "127.0.0.1"
cache = str(pipx_cache_dir / f"{sys.version_info[0]}.{sys.version_info[1]}")
server = str(Path(sys.executable).parent / "pypi-server")
cmd = [server, "run", "--verbose", "--disable-fallback", "--host", "127.0.0.1", "--port", str(port), cache]
cmd += ["--log-file", str(server_log)]
pypiserver_process = subprocess.Popen(cmd, cwd=root)
url = f"http://127.0.0.1:{port}/simple/"
while True:
try:
with urlopen(url) as response:
if response.code == HTTPStatus.OK:
break
except (URLError, HTTPError):
continue
yield url
pypiserver_process.terminate()
@pytest.fixture(scope="session")
def pipx_session_shared_dir(tmp_path_factory):
"""Makes a temporary pipx shared libs directory only once per session"""
return tmp_path_factory.mktemp("session_shareddir")
@pytest.fixture(scope="session")
def utils_temp_dir(tmp_path_factory):
tmp_path = tmp_path_factory.mktemp("session_utilstempdir")
utils = ["git"]
for util in utils:
at_path = shutil.which(util)
assert at_path is not None
util_path = Path(at_path)
try:
(tmp_path / util_path.name).symlink_to(util_path)
except FileExistsError:
pass
return tmp_path
@pytest.fixture
def pipx_temp_env(tmp_path, monkeypatch, pipx_session_shared_dir, request, utils_temp_dir, pipx_local_pypiserver):
"""Sets up temporary paths for pipx to install into.
Shared libs are setup once per session, all other pipx dirs, constants are
recreated for every test function.
Also adds environment variables as necessary to make pip installations
seamless.
"""
pipx_temp_env_helper(pipx_session_shared_dir, tmp_path, monkeypatch, request, utils_temp_dir, pipx_local_pypiserver)
yield
paths.ctx.make_local()
@pytest.fixture
def pipx_ultra_temp_env(tmp_path, monkeypatch, request, utils_temp_dir, pipx_local_pypiserver):
"""Sets up temporary paths for pipx to install into.
Fully temporary environment, every test function starts as if pipx has
never been run before, including empty shared libs directory.
Also adds environment variables as necessary to make pip installations
seamless.
"""
shared_dir = Path(tmp_path) / "shareddir"
pipx_temp_env_helper(shared_dir, tmp_path, monkeypatch, request, utils_temp_dir, pipx_local_pypiserver)
yield
paths.ctx.make_local()
|
