Skip to content

Commit

Permalink
Merge pull request #12199 from tamird/mkdir-test-init
Browse files Browse the repository at this point in the history
Add test for Cache.mkdir
  • Loading branch information
bluetech authored Apr 9, 2024
2 parents 9989063 + e06c337 commit 1f001cd
Showing 1 changed file with 37 additions and 7 deletions.
44 changes: 37 additions & 7 deletions testing/test_cacheprovider.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
# mypy: allow-untyped-defs
from enum import auto
from enum import Enum
import os
from pathlib import Path
import shutil
from typing import Any
from typing import Generator
from typing import List
from typing import Sequence
from typing import Tuple

from _pytest.compat import assert_never
from _pytest.config import ExitCode
from _pytest.monkeypatch import MonkeyPatch
from _pytest.pytester import Pytester
Expand Down Expand Up @@ -175,7 +180,9 @@ def test_custom_cache_dir_with_env_var(


@pytest.mark.parametrize("env", ((), ("TOX_ENV_DIR", "/tox_env_dir")))
def test_cache_reportheader(env, pytester: Pytester, monkeypatch: MonkeyPatch) -> None:
def test_cache_reportheader(
env: Sequence[str], pytester: Pytester, monkeypatch: MonkeyPatch
) -> None:
pytester.makepyfile("""def test_foo(): pass""")
if env:
monkeypatch.setenv(*env)
Expand Down Expand Up @@ -507,7 +514,7 @@ def test_hello():
"""
)

def rlf(fail_import, fail_run):
def rlf(fail_import: int, fail_run: int) -> Any:
monkeypatch.setenv("FAILIMPORT", str(fail_import))
monkeypatch.setenv("FAILTEST", str(fail_run))

Expand Down Expand Up @@ -555,7 +562,9 @@ def test_pass():
"""
)

def rlf(fail_import, fail_run, args=()):
def rlf(
fail_import: int, fail_run: int, args: Sequence[str] = ()
) -> Tuple[Any, Any]:
monkeypatch.setenv("FAILIMPORT", str(fail_import))
monkeypatch.setenv("FAILTEST", str(fail_run))

Expand Down Expand Up @@ -1254,20 +1263,41 @@ def test_readme_failed(self, pytester: Pytester) -> None:
assert self.check_readme(pytester) is True


def test_gitignore(pytester: Pytester) -> None:
class Action(Enum):
"""Action to perform on the cache directory."""

MKDIR = auto()
SET = auto()


@pytest.mark.parametrize("action", list(Action))
def test_gitignore(
pytester: Pytester,
action: Action,
) -> None:
"""Ensure we automatically create .gitignore file in the pytest_cache directory (#3286)."""
from _pytest.cacheprovider import Cache

config = pytester.parseconfig()
cache = Cache.for_config(config, _ispytest=True)
cache.set("foo", "bar")
if action == Action.MKDIR:
cache.mkdir("foo")
elif action == Action.SET:
cache.set("foo", "bar")
else:
assert_never(action)
msg = "# Created by pytest automatically.\n*\n"
gitignore_path = cache._cachedir.joinpath(".gitignore")
assert gitignore_path.read_text(encoding="UTF-8") == msg

# Does not overwrite existing/custom one.
gitignore_path.write_text("custom", encoding="utf-8")
cache.set("something", "else")
if action == Action.MKDIR:
cache.mkdir("something")
elif action == Action.SET:
cache.set("something", "else")
else:
assert_never(action)
assert gitignore_path.read_text(encoding="UTF-8") == "custom"


Expand Down

0 comments on commit 1f001cd

Please sign in to comment.