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 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
|
from __future__ import annotations
import concurrent.futures
import shutil
import traceback
from pathlib import Path
from typing import TYPE_CHECKING
from typing import TypeVar
import pytest
from packaging.tags import Tag
from poetry.core.packages.utils.link import Link
from poetry.utils.cache import ArtifactCache
from poetry.utils.cache import FileCache
from poetry.utils.env import MockEnv
if TYPE_CHECKING:
from typing import Any
from pytest_mock import MockerFixture
from tests.conftest import Config
from tests.types import FixtureDirGetter
T = TypeVar("T")
@pytest.fixture
def repository_cache_dir(config: Config) -> Path:
return config.repository_cache_directory
@pytest.fixture
def poetry_file_cache(repository_cache_dir: Path) -> FileCache[Any]:
return FileCache(repository_cache_dir / "cache")
def test_cache_validates(repository_cache_dir: Path) -> None:
with pytest.raises(ValueError) as e:
FileCache(repository_cache_dir / "cache", hash_type="unknown")
assert str(e.value) == "FileCache.hash_type is unknown value: 'unknown'."
def test_cache_get_put_has(repository_cache_dir: Path) -> None:
cache: FileCache[Any] = FileCache(repository_cache_dir / "cache")
cache.put("key1", "value")
cache.put("key2", {"a": ["json-encoded", "value"]})
assert cache.get("key1") == "value"
assert cache.get("key2") == {"a": ["json-encoded", "value"]}
assert cache.has("key1")
assert cache.has("key2")
assert not cache.has("key3")
def test_cache_forget(repository_cache_dir: Path) -> None:
cache: FileCache[Any] = FileCache(repository_cache_dir / "cache")
cache.put("key1", "value")
cache.put("key2", "value")
assert cache.has("key1")
assert cache.has("key2")
cache.forget("key1")
assert not cache.has("key1")
assert cache.has("key2")
def test_cache_flush(repository_cache_dir: Path) -> None:
cache: FileCache[Any] = FileCache(repository_cache_dir / "cache")
cache.put("key1", "value")
cache.put("key2", "value")
assert cache.has("key1")
assert cache.has("key2")
cache.flush()
assert not cache.has("key1")
assert not cache.has("key2")
def test_cache_remember(repository_cache_dir: Path, mocker: MockerFixture) -> None:
cache: FileCache[Any] = FileCache(repository_cache_dir / "cache")
method = mocker.Mock(return_value="value2")
cache.put("key1", "value1")
assert cache.remember("key1", method) == "value1"
method.assert_not_called()
assert cache.remember("key2", method) == "value2"
method.assert_called()
def test_cache_get_limited_minutes(
repository_cache_dir: Path, mocker: MockerFixture
) -> None:
cache: FileCache[Any] = FileCache(repository_cache_dir / "cache")
start_time = 1111111111
mocker.patch("time.time", return_value=start_time)
cache.put("key1", "value", minutes=5)
cache.put("key2", "value", minutes=5)
assert cache.get("key1") is not None
assert cache.get("key2") is not None
mocker.patch("time.time", return_value=start_time + 5 * 60 + 1)
# check to make sure that the cache deletes for has() and get()
assert not cache.has("key1")
assert cache.get("key2") is None
def test_missing_cache_file(poetry_file_cache: FileCache[Any]) -> None:
poetry_file_cache.put("key1", "value")
key1_path = (
poetry_file_cache.path
/ "81/74/09/96/87/a2/66/21/8174099687a26621f4e2cdd7cc03b3dacedb3fb962255b1aafd033cabe831530"
)
assert key1_path.exists()
key1_path.unlink() # corrupt cache by removing a key file
assert poetry_file_cache.get("key1") is None
def test_missing_cache_path(poetry_file_cache: FileCache[Any]) -> None:
poetry_file_cache.put("key1", "value")
key1_partial_path = poetry_file_cache.path / "81/74/09/96/87/a2/"
assert key1_partial_path.exists()
shutil.rmtree(
key1_partial_path
) # corrupt cache by removing a subdirectory containing a key file
assert poetry_file_cache.get("key1") is None
@pytest.mark.parametrize(
"corrupt_payload",
[
"", # empty file
b"\x00", # null
"99999999", # truncated file
'999999a999"value"', # corrupt lifetime
b'9999999999"va\xd8\x00"', # invalid unicode
"fil3systemFa!led", # garbage file
],
)
def test_detect_corrupted_cache_key_file(
corrupt_payload: str | bytes, poetry_file_cache: FileCache[Any]
) -> None:
poetry_file_cache.put("key1", "value")
key1_path = (
poetry_file_cache.path
/ "81/74/09/96/87/a2/66/21/8174099687a26621f4e2cdd7cc03b3dacedb3fb962255b1aafd033cabe831530"
)
assert key1_path.exists()
# original content: 9999999999"value"
if isinstance(corrupt_payload, str):
with open(key1_path, "w", encoding="utf-8") as f:
f.write(corrupt_payload) # write corrupt data
else:
with open(key1_path, "wb") as f:
f.write(corrupt_payload) # write corrupt data
assert poetry_file_cache.get("key1") is None
def test_get_cache_directory_for_link(tmp_path: Path) -> None:
cache = ArtifactCache(cache_dir=tmp_path)
directory = cache.get_cache_directory_for_link(
Link("https://files.pythonhosted.org/poetry-1.1.0.tar.gz")
)
expected = Path(
f"{tmp_path.as_posix()}/41/9c/6e/"
"ef83f08fcf4dac7cd78d843e7974d601a19c90e4bb90bb76b4a7a61548"
)
assert directory == expected
@pytest.mark.parametrize("subdirectory", [None, "subdir"])
def test_get_cache_directory_for_git(tmp_path: Path, subdirectory: str | None) -> None:
cache = ArtifactCache(cache_dir=tmp_path)
directory = cache.get_cache_directory_for_git(
url="https://github.com/demo/demo.git", ref="123456", subdirectory=subdirectory
)
if subdirectory:
expected = Path(
f"{tmp_path.as_posix()}/53/08/33/"
"7851e5806669aa15ab0c555b13bd5523978057323c6a23a9cee18ec51c"
)
else:
expected = Path(
f"{tmp_path.as_posix()}/61/14/30/"
"7c57f8fd71e4eee40b18893b9b586cba45177f15e300f4fb8b14ccc933"
)
assert directory == expected
def test_get_cached_archives(fixture_dir: FixtureDirGetter) -> None:
distributions = fixture_dir("distributions")
cache = ArtifactCache(cache_dir=Path())
archives = cache._get_cached_archives(distributions)
assert archives
assert set(archives) == set(distributions.glob("*.whl")) | set(
distributions.glob("*.tar.gz")
)
@pytest.mark.parametrize(
("link", "strict", "available_packages"),
[
(
"https://files.pythonhosted.org/demo-0.1.0.tar.gz",
True,
[
Path("/cache/demo-0.1.0-py2.py3-none-any"),
Path("/cache/demo-0.1.0-cp38-cp38-macosx_10_15_x86_64.whl"),
Path("/cache/demo-0.1.0-cp37-cp37-macosx_10_15_x86_64.whl"),
],
),
(
"https://example.com/demo-0.1.0-cp38-cp38-macosx_10_15_x86_64.whl",
False,
[],
),
],
)
def test_get_not_found_cached_archive_for_link(
mocker: MockerFixture,
link: str,
strict: bool,
available_packages: list[Path],
) -> None:
env = MockEnv(
version_info=(3, 8, 3),
marker_env={"interpreter_name": "cpython", "interpreter_version": "3.8.3"},
supported_tags=[
Tag("cp38", "cp38", "macosx_10_15_x86_64"),
Tag("py3", "none", "any"),
],
)
cache = ArtifactCache(cache_dir=Path())
mocker.patch.object(
cache,
"_get_cached_archives",
return_value=available_packages,
)
archive = cache.get_cached_archive_for_link(Link(link), strict=strict, env=env)
assert archive is None
@pytest.mark.parametrize(
("link", "cached", "strict"),
[
(
"https://files.pythonhosted.org/demo-0.1.0.tar.gz",
"/cache/demo-0.1.0-cp38-cp38-macosx_10_15_x86_64.whl",
False,
),
(
"https://example.com/demo-0.1.0-cp38-cp38-macosx_10_15_x86_64.whl",
"/cache/demo-0.1.0-cp38-cp38-macosx_10_15_x86_64.whl",
False,
),
(
"https://files.pythonhosted.org/demo-0.1.0.tar.gz",
"/cache/demo-0.1.0.tar.gz",
True,
),
(
"https://example.com/demo-0.1.0-cp38-cp38-macosx_10_15_x86_64.whl",
"/cache/demo-0.1.0-cp38-cp38-macosx_10_15_x86_64.whl",
True,
),
],
)
def test_get_found_cached_archive_for_link(
mocker: MockerFixture,
link: str,
cached: str,
strict: bool,
) -> None:
env = MockEnv(
version_info=(3, 8, 3),
marker_env={"interpreter_name": "cpython", "interpreter_version": "3.8.3"},
supported_tags=[
Tag("cp38", "cp38", "macosx_10_15_x86_64"),
Tag("py3", "none", "any"),
],
)
cache = ArtifactCache(cache_dir=Path())
mocker.patch.object(
cache,
"_get_cached_archives",
return_value=[
Path("/cache/demo-0.1.0-py2.py3-none-any"),
Path("/cache/demo-0.1.0.tar.gz"),
Path("/cache/demo-0.1.0-cp38-cp38-macosx_10_15_x86_64.whl"),
Path("/cache/demo-0.1.0-cp37-cp37-macosx_10_15_x86_64.whl"),
],
)
archive = cache.get_cached_archive_for_link(Link(link), strict=strict, env=env)
assert Path(cached) == archive
def test_get_cached_archive_for_link_no_race_condition(
tmp_path: Path, mocker: MockerFixture
) -> None:
cache = ArtifactCache(cache_dir=tmp_path)
link = Link("https://files.pythonhosted.org/demo-0.1.0.tar.gz")
def replace_file(_: str, dest: Path) -> None:
dest.unlink(missing_ok=True)
# write some data (so it takes a while) to provoke possible race conditions
dest.write_text("a" * 2**20, encoding="utf-8")
download_mock = mocker.Mock(side_effect=replace_file)
def get_archive(link: Link) -> Path:
path: Path = cache.get_cached_archive_for_link(
link, strict=True, download_func=download_mock
)
return path
with concurrent.futures.ThreadPoolExecutor() as executor:
tasks = []
for _ in range(4):
tasks.append(executor.submit(get_archive, link))
concurrent.futures.wait(tasks)
results = set()
for task in tasks:
try:
results.add(task.result())
except Exception:
pytest.fail(traceback.format_exc())
assert results == {cache.get_cache_directory_for_link(link) / link.filename}
download_mock.assert_called_once()
def test_get_cached_archive_for_git() -> None:
"""Smoke test that checks that no assertion is raised."""
cache = ArtifactCache(cache_dir=Path())
archive = cache.get_cached_archive_for_git("url", "ref", "subdirectory", MockEnv())
assert archive is None
|