refactor configuring the Workdir class for tests

- methods to setup the scm's
- move skipping to the helper methods
- unify construction

Author: RonnyPfannschmidt

CHANGELOG.md

@@ -17,7 +17,7 @@
 
 ### changed
 
-- refine activation logic and add unittest for the relevant cases instead of trying to speedrun setuptools 
+- refine activation logic and add unittest for the relevant cases instead of trying to speedrun setuptools
 
 ## v9.1.1
 

testing/conftest.py

@@ -27,16 +27,6 @@ def pytest_configure(config: pytest.Config) -> None:
     os.environ["SOURCE_DATE_EPOCH"] = "1234567890"
     os.environ["SETUPTOOLS_SCM_DEBUG"] = "1"
 
-    # Register custom markers
-    config.addinivalue_line(
-        "markers",
-        "git: mark test to use git SCM",
-    )
-    config.addinivalue_line(
-        "markers",
-        "hg: mark test to use mercurial SCM",
-    )
-
 
 VERSION_PKGS = ["setuptools", "setuptools_scm", "packaging", "build", "wheel"]
 
@@ -99,48 +89,30 @@ def debug_mode() -> Iterator[DebugMode]:
 
 
 def setup_git_wd(wd: WorkDir, monkeypatch: pytest.MonkeyPatch | None = None) -> WorkDir:
-    """Set up a WorkDir with git initialized and configured for testing."""
-    if monkeypatch:
-        monkeypatch.delenv("HOME", raising=False)
-    wd("git init")
-    wd("git config user.email [email protected]")
-    wd('git config user.name "a test"')
-    wd.add_command = "git add ."
-    wd.commit_command = "git commit -m test-{reason}"
-    wd.tag_command = "git tag {tag}"
-    return wd
+    """Set up a WorkDir with git initialized and configured for testing.
+
+    Note: This is a compatibility wrapper. Consider using wd.setup_git() directly.
+    """
+    return wd.setup_git(monkeypatch)
 
 
 def setup_hg_wd(wd: WorkDir) -> WorkDir:
-    """Set up a WorkDir with mercurial initialized and configured for testing."""
-    wd("hg init")
-    wd.add_command = "hg add ."
-    wd.commit_command = 'hg commit -m test-{reason} -u test -d "0 0"'
-    wd.tag_command = "hg tag {tag}"
-    return wd
+    """Set up a WorkDir with mercurial initialized and configured for testing.
+
+    Note: This is a compatibility wrapper. Consider using wd.setup_hg() directly.
+    """
+    return wd.setup_hg()
 
 
 @pytest.fixture
-def wd(
-    tmp_path: Path, request: pytest.FixtureRequest, monkeypatch: pytest.MonkeyPatch
-) -> WorkDir:
-    """WorkDir fixture that automatically configures SCM based on markers."""
+def wd(tmp_path: Path) -> WorkDir:
+    """Base WorkDir fixture that returns an unconfigured working directory.
+
+    Individual test modules should override this fixture to set up specific SCM configurations.
+    """
     target_wd = tmp_path.resolve() / "wd"
     target_wd.mkdir()
-    wd = WorkDir(target_wd)
-
-    # Check for SCM markers on the test function or module
-    git_marker = request.node.get_closest_marker("git")
-    hg_marker = request.node.get_closest_marker("hg")
-
-    # Configure SCM based on markers
-    if git_marker:
-        setup_git_wd(wd, monkeypatch)
-    elif hg_marker:
-        setup_hg_wd(wd)
-    # If no SCM markers, return unconfigured workdir
-
-    return wd
+    return WorkDir(target_wd)
 
 
 @pytest.fixture(scope="session")

testing/test_better_root_errors.py

@@ -16,32 +16,13 @@
 from setuptools_scm._get_version_impl import _version_missing
 from testing.wd_wrapper import WorkDir
 
-
-def setup_git_repo(wd: WorkDir) -> WorkDir:
-    """Set up a git repository for testing."""
-    wd("git init")
-    wd("git config user.email [email protected]")
-    wd('git config user.name "a test"')
-    wd.add_command = "git add ."
-    wd.commit_command = "git commit -m test-{reason}"
-    return wd
-
-
-def setup_hg_repo(wd: WorkDir) -> WorkDir:
-    """Set up a mercurial repository for testing."""
-    try:
-        wd("hg init")
-        wd.add_command = "hg add ."
-        wd.commit_command = 'hg commit -m test-{reason} -u test -d "0 0"'
-        return wd
-    except Exception:
-        pytest.skip("hg not available")
+# No longer need to import setup functions - using WorkDir methods directly
 
 
 def test_find_scm_in_parents_finds_git(wd: WorkDir) -> None:
     """Test that _find_scm_in_parents correctly finds git repositories in parent directories."""
     # Set up git repo in root
-    setup_git_repo(wd)
+    wd.setup_git()
 
     # Create a subdirectory structure
     subdir = wd.cwd / "subproject" / "nested"
@@ -57,7 +38,7 @@ def test_find_scm_in_parents_finds_git(wd: WorkDir) -> None:
 def test_find_scm_in_parents_finds_hg(wd: WorkDir) -> None:
     """Test that _find_scm_in_parents correctly finds mercurial repositories in parent directories."""
     # Set up hg repo in root
-    setup_hg_repo(wd)
+    wd.setup_hg()
 
     # Create a subdirectory structure
     subdir = wd.cwd / "subproject" / "nested"
@@ -85,7 +66,7 @@ def test_find_scm_in_parents_returns_none(wd: WorkDir) -> None:
 def test_version_missing_with_scm_in_parent(wd: WorkDir) -> None:
     """Test that _version_missing provides helpful error message when SCM is found in parent."""
     # Set up git repo in root
-    setup_git_repo(wd)
+    wd.setup_git()
 
     # Create a subdirectory structure
     subdir = wd.cwd / "subproject" / "nested"
@@ -130,7 +111,7 @@ def test_version_missing_no_scm_found(wd: WorkDir) -> None:
 def test_version_missing_with_relative_to_set(wd: WorkDir) -> None:
     """Test that when relative_to is set, we don't search parents for error messages."""
     # Set up git repo in root
-    setup_git_repo(wd)
+    wd.setup_git()
 
     # Create a subdirectory structure
     subdir = wd.cwd / "subproject" / "nested"
@@ -161,7 +142,7 @@ def test_search_parent_directories_works_as_suggested(
 ) -> None:
     """Test that the suggested search_parent_directories=True solution actually works."""
     # Set up git repo
-    setup_git_repo(wd)
+    wd.setup_git()
     wd.commit_testfile()  # Make sure there's a commit for version detection
 
     # Create a subdirectory
@@ -182,7 +163,7 @@ def test_integration_better_error_from_nested_directory(
 ) -> None:
     """Integration test: get_version from nested directory should give helpful error."""
     # Set up git repo
-    setup_git_repo(wd)
+    wd.setup_git()
 
     # Create a subdirectory
     subdir = wd.cwd / "subproject"

testing/test_file_finder.py

@@ -18,21 +18,9 @@ def inwd(
 ) -> WorkDir:
     param: str = request.param  # type: ignore[attr-defined]
     if param == "git":
-        try:
-            wd("git init")
-        except OSError:
-            pytest.skip("git executable not found")
-        wd("git config user.email [email protected]")
-        wd('git config user.name "a test"')
-        wd.add_command = "git add ."
-        wd.commit_command = "git commit -m test-{reason}"
+        wd.setup_git(monkeypatch)
     elif param == "hg":
-        try:
-            wd("hg init")
-        except OSError:
-            pytest.skip("hg executable not found")
-        wd.add_command = "hg add ."
-        wd.commit_command = 'hg commit -m test-{reason} -u test -d "0 0"'
+        wd.setup_hg()
     (wd.cwd / "file1").touch()
     adir = wd.cwd / "adir"
     adir.mkdir()
@@ -249,10 +237,7 @@ def test_archive(
 
 @pytest.fixture
 def hg_wd(wd: WorkDir, monkeypatch: pytest.MonkeyPatch) -> WorkDir:
-    try:
-        wd("hg init")
-    except OSError:
-        pytest.skip("hg executable not found")
+    wd.setup_hg()
     (wd.cwd / "file").touch()
     wd("hg add file")
     monkeypatch.chdir(wd.cwd)

testing/test_git.py

@@ -34,27 +34,14 @@
 from .conftest import DebugMode
 from .wd_wrapper import WorkDir
 
-pytestmark = pytest.mark.skipif(
-    not has_command("git", warn=False), reason="git executable not found"
-)
-
-
-def setup_git_wd(wd: WorkDir, monkeypatch: pytest.MonkeyPatch | None = None) -> WorkDir:
-    """Set up a WorkDir with git initialized and configured for testing."""
-    if monkeypatch:
-        monkeypatch.delenv("HOME", raising=False)
-    wd("git init")
-    wd("git config user.email [email protected]")
-    wd('git config user.name "a test"')
-    wd.add_command = "git add ."
-    wd.commit_command = "git commit -m test-{reason}"
-    return wd
+# Note: Git availability is now checked in WorkDir.setup_git() method
 
 
-@pytest.fixture(name="wd")
+@pytest.fixture
 def wd(wd: WorkDir, monkeypatch: pytest.MonkeyPatch, debug_mode: DebugMode) -> WorkDir:
+    """Set up git for git-specific tests."""
     debug_mode.disable()
-    setup_git_wd(wd, monkeypatch)
+    wd.setup_git(monkeypatch)
     debug_mode.enable()
     return wd
 
@@ -685,7 +672,7 @@ def test_fail_on_missing_submodules_with_uninitialized_submodules(
     # Create a test repository with a .gitmodules file but no actual submodule
     test_repo = tmp_path / "test_repo"
     test_repo.mkdir()
-    test_wd = setup_git_wd(WorkDir(test_repo))
+    test_wd = WorkDir(test_repo).setup_git()
 
     # Create a fake .gitmodules file (this simulates what happens after cloning without --recurse-submodules)
     gitmodules_content = """[submodule "external"]

testing/test_integration.py

@@ -34,8 +34,11 @@
 c = Configuration()
 
 
-# File-level marker for git tests
-pytestmark = pytest.mark.git
+# Module-level fixture for git SCM setup
+@pytest.fixture
+def wd(wd: WorkDir, monkeypatch: pytest.MonkeyPatch) -> WorkDir:
+    """Set up git for integration tests."""
+    return wd.setup_git(monkeypatch)
 
 
 def test_pyproject_support(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:

testing/test_main.py

@@ -22,11 +22,7 @@ def test_main() -> None:
 
 @pytest.fixture
 def repo(wd: WorkDir) -> WorkDir:
-    wd("git init")
-    wd("git config user.email user@host")
-    wd("git config user.name user")
-    wd.add_command = "git add ."
-    wd.commit_command = "git commit -m test-{reason}"
+    wd.setup_git()
 
     wd.write("README.rst", "My example")
     wd.add_and_commit()

testing/test_mercurial.py

@@ -10,23 +10,18 @@
 
 from setuptools_scm import Configuration
 from setuptools_scm._run_cmd import CommandNotFoundError
-from setuptools_scm._run_cmd import has_command
 from setuptools_scm.hg import archival_to_version
 from setuptools_scm.hg import parse
 from setuptools_scm.version import format_version
 from testing.wd_wrapper import WorkDir
 
-pytestmark = pytest.mark.skipif(
-    not has_command("hg", warn=False), reason="hg executable not found"
-)
+# Note: Mercurial availability is now checked in WorkDir.setup_hg() method
 
 
 @pytest.fixture
 def wd(wd: WorkDir) -> WorkDir:
-    wd("hg init")
-    wd.add_command = "hg add ."
-    wd.commit_command = 'hg commit -m test-{reason} -u test -d "0 0"'
-    return wd
+    """Set up mercurial for hg-specific tests."""
+    return wd.setup_hg()
 
 
 archival_mapping = {

testing/wd_wrapper.py

@@ -3,8 +3,16 @@
 import itertools
 
 from pathlib import Path
+from typing import TYPE_CHECKING
 from typing import Any
 
+import pytest
+
+from setuptools_scm._run_cmd import has_command
+
+if TYPE_CHECKING:
+    pass
+
 
 class WorkDir:
     """a simple model for a"""
@@ -126,3 +134,66 @@ def create_tag(self, tag: str = "1.0.0") -> None:
             self(self.tag_command, tag=tag)
         else:
             raise RuntimeError("No tag_command configured")
+
+    def configure_git_commands(self) -> None:
+        """Configure git commands without initializing the repository."""
+        self.add_command = "git add ."
+        self.commit_command = "git commit -m test-{reason}"
+        self.tag_command = "git tag {tag}"
+
+    def configure_hg_commands(self) -> None:
+        """Configure mercurial commands without initializing the repository."""
+        self.add_command = "hg add ."
+        self.commit_command = 'hg commit -m test-{reason} -u test -d "0 0"'
+        self.tag_command = "hg tag {tag}"
+
+    def setup_git(
+        self, monkeypatch: pytest.MonkeyPatch | None = None, *, init: bool = True
+    ) -> WorkDir:
+        """Set up git SCM for this WorkDir.
+
+        Args:
+            monkeypatch: Optional pytest MonkeyPatch to clear HOME environment
+            init: Whether to initialize the git repository (default: True)
+
+        Returns:
+            Self for method chaining
+
+        Raises:
+            pytest.skip: If git executable is not found
+        """
+        if not has_command("git", warn=False):
+            pytest.skip("git executable not found")
+
+        self.configure_git_commands()
+
+        if init:
+            if monkeypatch:
+                monkeypatch.delenv("HOME", raising=False)
+            self("git init")
+            self("git config user.email [email protected]")
+            self('git config user.name "a test"')
+
+        return self
+
+    def setup_hg(self, *, init: bool = True) -> WorkDir:
+        """Set up mercurial SCM for this WorkDir.
+
+        Args:
+            init: Whether to initialize the mercurial repository (default: True)
+
+        Returns:
+            Self for method chaining
+
+        Raises:
+            pytest.skip: If hg executable is not found
+        """
+        if not has_command("hg", warn=False):
+            pytest.skip("hg executable not found")
+
+        self.configure_hg_commands()
+
+        if init:
+            self("hg init")
+
+        return self