wip: restructure testing

Author: RonnyPfannschmidt

testing/conftest.py

@@ -22,11 +22,21 @@
 from .wd_wrapper import WorkDir
 
 
-def pytest_configure() -> None:
+def pytest_configure(config: pytest.Config) -> None:
     # 2009-02-13T23:31:30+00:00
     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"]
 
@@ -38,7 +48,15 @@ def pytest_report_header() -> list[str]:
     for pkg in VERSION_PKGS:
         pkg_version = version(pkg)
         path = __import__(pkg).__file__
-        res.append(f"{pkg} version {pkg_version} from {path!r}")
+        if path and "site-packages" in path:
+            # Replace everything up to and including site-packages with site::
+            parts = path.split("site-packages", 1)
+            if len(parts) > 1:
+                path = "site::" + parts[1]
+        elif path and str(Path.cwd()) in path:
+            # Replace current working directory with CWD::
+            path = path.replace(str(Path.cwd()), "CWD::")
+        res.append(f"{pkg} version {pkg_version} from {path}")
     return res
 
 
@@ -80,11 +98,49 @@ def debug_mode() -> Iterator[DebugMode]:
         yield debug_mode
 
 
+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 test@example.com")
+    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
+
+
+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
+
+
 @pytest.fixture
-def wd(tmp_path: Path) -> WorkDir:
+def wd(
+    tmp_path: Path, request: pytest.FixtureRequest, monkeypatch: pytest.MonkeyPatch
+) -> WorkDir:
+    """WorkDir fixture that automatically configures SCM based on markers."""
     target_wd = tmp_path.resolve() / "wd"
     target_wd.mkdir()
-    return WorkDir(target_wd)
+    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
 
 
 @pytest.fixture(scope="session")

testing/test_integration.py

@@ -33,14 +33,8 @@
 c = Configuration()
 
 
-@pytest.fixture
-def wd(wd: WorkDir) -> WorkDir:
-    wd("git init")
-    wd("git config user.email test@example.com")
-    wd('git config user.name "a test"')
-    wd.add_command = "git add ."
-    wd.commit_command = "git commit -m test-{reason}"
-    return wd
+# File-level marker for git tests
+pytestmark = pytest.mark.git
 
 
 def test_pyproject_support(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:

testing/wd_wrapper.py

@@ -12,6 +12,7 @@ class WorkDir:
     commit_command: str
     signed_commit_command: str
     add_command: str
+    tag_command: str
 
     def __repr__(self) -> str:
         return f"<WD {self.cwd}>"
@@ -68,3 +69,60 @@ def get_version(self, **kw: Any) -> str:
         version = get_version(root=self.cwd, fallback_root=self.cwd, **kw)
         print(self.cwd.name, version, sep=": ")
         return version
+
+    def create_basic_setup_py(
+        self, name: str = "test-package", use_scm_version: str = "True"
+    ) -> None:
+        """Create a basic setup.py file with setuptools_scm configuration."""
+        self.write(
+            "setup.py",
+            f"""__import__('setuptools').setup(
+    name="{name}",
+    use_scm_version={use_scm_version},
+)""",
+        )
+
+    def create_basic_pyproject_toml(
+        self, name: str = "test-package", dynamic_version: bool = True
+    ) -> None:
+        """Create a basic pyproject.toml file with setuptools_scm configuration."""
+        dynamic_section = 'dynamic = ["version"]' if dynamic_version else ""
+        self.write(
+            "pyproject.toml",
+            f"""[build-system]
+requires = ["setuptools>=64", "setuptools_scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "{name}"
+{dynamic_section}
+
+[tool.setuptools_scm]
+""",
+        )
+
+    def create_basic_setup_cfg(self, name: str = "test-package") -> None:
+        """Create a basic setup.cfg file with metadata."""
+        self.write(
+            "setup.cfg",
+            f"""[metadata]
+name = {name}
+""",
+        )
+
+    def create_test_file(
+        self, filename: str = "test.txt", content: str = "test content"
+    ) -> None:
+        """Create a test file and commit it to the repository."""
+        # Create parent directories if they don't exist
+        path = self.cwd / filename
+        path.parent.mkdir(parents=True, exist_ok=True)
+        self.write(filename, content)
+        self.add_and_commit()
+
+    def create_tag(self, tag: str = "1.0.0") -> None:
+        """Create a tag using the configured tag_command."""
+        if hasattr(self, "tag_command"):
+            self(self.tag_command, tag=tag)
+        else:
+            raise RuntimeError("No tag_command configured")