tests: Sandbox Git config during tests

Author: pawamoy

pyproject.toml

@@ -100,6 +100,7 @@ ci = [
     "pysource-minimize>=0.10",
     "pytest>=8.2",
     "pytest-cov>=5.0",
+    "pytest-gitconfig>=0.8.0",
     "pytest-randomly>=3.15",
     "pytest-xdist>=3.6",
     "mypy>=1.10",

tests/conftest.py

@@ -1 +1,17 @@
 """Configuration for the pytest test suite."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import pytest
+
+if TYPE_CHECKING:
+    from pytest_gitconfig import GitConfig
+
+
+@pytest.fixture(name="gitconfig", scope="session")
+def _default_gitconfig(default_gitconfig: GitConfig) -> GitConfig:
+    default_gitconfig.set({"user.name": "My Name"})
+    default_gitconfig.set({"user.email": "my@email.com"})
+    return default_gitconfig

tests/test_git.py

@@ -14,6 +14,8 @@
 if TYPE_CHECKING:
     from pathlib import Path
 
+    from pytest_gitconfig import GitConfig
+
 REPO_NAME = "my-repo"
 REPO_SOURCE = FIXTURES_DIR / "_repo"
 MODULE_NAME = "my_module"
@@ -36,7 +38,7 @@ def _copy_contents(src: Path, dst: Path) -> None:
 
 
 @pytest.fixture
-def git_repo(tmp_path: Path) -> Path:
+def git_repo(tmp_path: Path, gitconfig: GitConfig) -> Path:  # noqa: ARG001
     """Fixture that creates a git repo with multiple tagged versions.
 
     For each directory in `tests/test_git/_repo/`
@@ -58,8 +60,6 @@ def git_repo(tmp_path: Path) -> Path:
     repo_path = tmp_path / REPO_NAME
     repo_path.mkdir()
     run(["git", "-C", str(repo_path), "init"], check=True)
-    run(["git", "-C", str(repo_path), "config", "user.name", "Name"], check=True)
-    run(["git", "-C", str(repo_path), "config", "user.email", "my@email.com"], check=True)
     for tagdir in REPO_SOURCE.iterdir():
         ver = tagdir.name
         _copy_contents(tagdir, repo_path)