Skip to content

test-cache: Fix XDG tests, make tests more consistent #880

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

test-cache: Fix XDG tests, make tests more consistent #880

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
08b98a4
fix(test_cache): Correct XDG testing logic
hseg Feb 10, 2025
4d1de2d
fix(test_cache): Make tests more consistent
hseg Feb 10, 2025
2f03ce1
ci: add Windows test job
woodruffw Feb 27, 2025
da31efe
Merge branch 'main' into fix-xdg-tests
woodruffw Feb 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 26 additions & 17 deletions test/test_cache.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,35 @@ def _patch_platformdirs(monkeypatch: MonkeyPatch, sys_platform: str) -> None:
# as cache definition is stored in the top level `__init__.py` file of the
# `platformdirs` package
importlib.reload(platformdirs)
# Setting directory-controlling environment variables to known state
if sys_platform == "win32":
monkeypatch.setenv("LOCALAPPDATA", "/tmp/AppData/Local")
elif sys_platform == "linux":
monkeypatch.setenv("XDG_CACHE_HOME", "/tmp/home/.cache")


def test_get_cache_dir(monkeypatch):
@pytest.mark.parametrize(
"sys_platform",
[
pytest.param("linux", id="on Linux"),
pytest.param("win32", id="on Windows"),
pytest.param("darwin", id="on MacOS"),
],
)
def test_get_cache_dir(monkeypatch, sys_platform):
# Check cross-platforms
_patch_platformdirs(monkeypatch, sys_platform)

# When we supply a cache directory, always use that
cache_dir = _get_cache_dir(Path("/tmp/foo/cache_dir"))
assert cache_dir.as_posix() == "/tmp/foo/cache_dir"
cache_dir = Path("/tmp/foo/cache_dir")
assert _get_cache_dir(cache_dir) == cache_dir

get_pip_cache = pretend.call_recorder(lambda: Path("/fake/pip/cache/dir"))
cache_dir = Path("/fake/pip/cache/dir")
get_pip_cache = pretend.call_recorder(lambda: cache_dir)
monkeypatch.setattr(cache, "_get_pip_cache", get_pip_cache)

# When `pip cache dir` works, we use it. In this case, it's mocked.
cache_dir = _get_cache_dir(None, use_pip=True)
assert cache_dir.as_posix() == "/fake/pip/cache/dir"
assert _get_cache_dir(None, use_pip=True) == cache_dir


def test_get_pip_cache():
Expand All @@ -48,7 +62,7 @@ def test_get_pip_cache():
[
pytest.param(
"linux",
Path.home() / ".cache" / "pip-audit",
Path("/tmp") / "home" / ".cache" / "pip-audit",
id="on Linux",
),
pytest.param(
Expand All @@ -66,17 +80,17 @@ def test_get_pip_cache():
def test_get_cache_dir_do_not_use_pip(monkeypatch, sys_platform, expected):
# Check cross-platforms
_patch_platformdirs(monkeypatch, sys_platform)

# Even with None, we never use the pip cache if we're told not to.
cache_dir = _get_cache_dir(None, use_pip=False)
assert cache_dir == expected
assert _get_cache_dir(None, use_pip=False) == expected


@pytest.mark.parametrize(
"sys_platform,expected",
[
pytest.param(
"linux",
Path.home() / ".cache" / "pip-audit",
Path("/tmp") / "home" / ".cache" / "pip-audit",
id="on Linux",
),
pytest.param(
Expand Down Expand Up @@ -105,7 +119,7 @@ def test_get_cache_dir_pip_disabled_in_environment(monkeypatch, sys_platform, ex
[
pytest.param(
"linux",
Path.home() / ".cache" / "pip-audit",
Path("/tmp") / "home" / ".cache" / "pip-audit",
id="on Linux",
),
pytest.param(
Expand All @@ -126,14 +140,9 @@ def test_get_cache_dir_old_pip(monkeypatch, sys_platform, expected):
# Check cross-platforms
_patch_platformdirs(monkeypatch, sys_platform)

# When we supply a cache directory, always use that
cache_dir = _get_cache_dir(Path("/tmp/foo/cache_dir"))
assert cache_dir.as_posix() == "/tmp/foo/cache_dir"

# In this case, we can't query `pip` to figure out where its HTTP cache is
# Instead, we use `~/.pip-audit-cache`
cache_dir = _get_cache_dir(None)
assert cache_dir == expected
assert _get_cache_dir(None) == expected


def test_cache_warns_about_old_pip(monkeypatch, cache_dir):
Expand Down