Enhance CLI main function to accept PyProjectData for improved testing

- Updated the main function signature to include an optional _given_pyproject_data parameter.
- Modified test cases to utilize injected PyProjectData instead of relying on file creation.
- Added helper functions to create PyProjectData for testing scenarios.

Author: RonnyPfannschmidt

src/setuptools_scm/_cli.py

@@ -11,10 +11,13 @@
 from setuptools_scm import Configuration
 from setuptools_scm._file_finders import find_files
 from setuptools_scm._get_version_impl import _get_version
+from setuptools_scm._integration.pyproject_reading import PyProjectData
 from setuptools_scm.discover import walk_potential_roots
 
 
-def main(args: list[str] | None = None) -> int:
+def main(
+    args: list[str] | None = None, *, _given_pyproject_data: PyProjectData | None = None
+) -> int:
     opts = _get_cli_opts(args)
     inferred_root: str = opts.root or "."
 
@@ -24,6 +27,7 @@ def main(args: list[str] | None = None) -> int:
         config = Configuration.from_file(
             pyproject,
             root=(os.path.abspath(opts.root) if opts.root is not None else None),
+            pyproject_data=_given_pyproject_data,
         )
     except (LookupError, FileNotFoundError) as ex:
         # no pyproject.toml OR no [tool.setuptools_scm]

testing/test_cli.py

@@ -7,19 +7,46 @@
 import pytest
 
 from setuptools_scm._cli import main
+from setuptools_scm._integration.pyproject_reading import PyProjectData
 
 from .conftest import DebugMode
-from .test_git import wd as wd_fixture  # noqa: F401 (evil fixture reuse)
 from .wd_wrapper import WorkDir
 
+
+@pytest.fixture
+def wd(wd: WorkDir, monkeypatch: pytest.MonkeyPatch, debug_mode: DebugMode) -> WorkDir:
+    """Set up git for CLI tests."""
+    debug_mode.disable()
+    wd.setup_git(monkeypatch)
+    debug_mode.enable()
+    return wd
+
+
 PYPROJECT_TOML = "pyproject.toml"
 PYPROJECT_SIMPLE = "[tool.setuptools_scm]"
 PYPROJECT_ROOT = '[tool.setuptools_scm]\nroot=".."'
 
+# PyProjectData constants for testing
+PYPROJECT_DATA_SIMPLE = PyProjectData.for_testing(section_present=True)
+PYPROJECT_DATA_WITH_PROJECT = PyProjectData.for_testing(
+    section_present=True, project_present=True, project_name="test"
+)
+
 
-def get_output(args: list[str]) -> str:
+def _create_version_file_pyproject_data() -> PyProjectData:
+    """Create PyProjectData with version_file configuration for testing."""
+    data = PyProjectData.for_testing(
+        section_present=True, project_present=True, project_name="test"
+    )
+    data.section["version_file"] = "ver.py"
+    return data
+
+
+def get_output(
+    args: list[str], *, _given_pyproject_data: PyProjectData | None = None
+) -> str:
     with redirect_stdout(io.StringIO()) as out:
-        main(args)
+        main(args, _given_pyproject_data=_given_pyproject_data)
     return out.getvalue()
 
 
@@ -59,24 +86,20 @@ def test_cli_force_version_files(
 ) -> None:
     debug_mode.disable()
     wd.commit_testfile()
-    wd.write(
-        PYPROJECT_TOML,
-        """
-[project]
-name = "test"
-[tool.setuptools_scm]
-version_file = "ver.py"
-""",
-    )
     monkeypatch.chdir(wd.cwd)
 
     version_file = wd.cwd.joinpath("ver.py")
     assert not version_file.exists()
 
-    get_output([])
+    # Create pyproject data with version_file configuration
+    pyproject_data = _create_version_file_pyproject_data()
+
+    get_output([], _given_pyproject_data=pyproject_data)
     assert not version_file.exists()
 
-    output = get_output(["--force-write-version-files"])
+    output = get_output(
+        ["--force-write-version-files"], _given_pyproject_data=pyproject_data
+    )
     assert version_file.exists()
 
     assert output[:5] in version_file.read_text("utf-8")
@@ -87,13 +110,16 @@ def test_cli_create_archival_file_stable(
 ) -> None:
     """Test creating stable .git_archival.txt file."""
     wd.commit_testfile()
-    wd.write(PYPROJECT_TOML, PYPROJECT_SIMPLE)
     monkeypatch.chdir(wd.cwd)
 
     archival_file = wd.cwd / ".git_archival.txt"
     assert not archival_file.exists()
 
-    result = main(["create-archival-file", "--stable"])
+    # Use injected pyproject data instead of creating a file
+    pyproject_data = PYPROJECT_DATA_SIMPLE
+    result = main(
+        ["create-archival-file", "--stable"], _given_pyproject_data=pyproject_data
+    )
     assert result == 0
     assert archival_file.exists()
 
@@ -115,13 +141,16 @@ def test_cli_create_archival_file_full(
 ) -> None:
     """Test creating full .git_archival.txt file with branch information."""
     wd.commit_testfile()
-    wd.write(PYPROJECT_TOML, PYPROJECT_SIMPLE)
     monkeypatch.chdir(wd.cwd)
 
     archival_file = wd.cwd / ".git_archival.txt"
     assert not archival_file.exists()
 
-    result = main(["create-archival-file", "--full"])
+    # Use injected pyproject data instead of creating a file
+    pyproject_data = PYPROJECT_DATA_SIMPLE
+    result = main(
+        ["create-archival-file", "--full"], _given_pyproject_data=pyproject_data
+    )
     assert result == 0
     assert archival_file.exists()
 
@@ -144,15 +173,18 @@ def test_cli_create_archival_file_exists_no_force(
     wd: WorkDir, monkeypatch: pytest.MonkeyPatch
 ) -> None:
     """Test that existing .git_archival.txt file prevents creation without --force."""
+    wd.setup_git(monkeypatch)
     wd.commit_testfile()
-    wd.write(PYPROJECT_TOML, PYPROJECT_SIMPLE)
     monkeypatch.chdir(wd.cwd)
 
     archival_file = wd.cwd / ".git_archival.txt"
     archival_file.write_text("existing content", encoding="utf-8")
 
     # Should fail without --force
-    result = main(["create-archival-file", "--stable"])
+    pyproject_data = PYPROJECT_DATA_SIMPLE
+    result = main(
+        ["create-archival-file", "--stable"], _given_pyproject_data=pyproject_data
+    )
     assert result == 1
 
     # Content should be unchanged
@@ -163,15 +195,19 @@ def test_cli_create_archival_file_exists_with_force(
     wd: WorkDir, monkeypatch: pytest.MonkeyPatch
 ) -> None:
     """Test that --force overwrites existing .git_archival.txt file."""
+    wd.setup_git(monkeypatch)
     wd.commit_testfile()
-    wd.write(PYPROJECT_TOML, PYPROJECT_SIMPLE)
     monkeypatch.chdir(wd.cwd)
 
     archival_file = wd.cwd / ".git_archival.txt"
     archival_file.write_text("existing content", encoding="utf-8")
 
     # Should succeed with --force
-    result = main(["create-archival-file", "--stable", "--force"])
+    pyproject_data = PYPROJECT_DATA_SIMPLE
+    result = main(
+        ["create-archival-file", "--stable", "--force"],
+        _given_pyproject_data=pyproject_data,
+    )
     assert result == 0
 
     # Content should be updated
@@ -184,41 +220,48 @@ def test_cli_create_archival_file_requires_stable_or_full(
     wd: WorkDir, monkeypatch: pytest.MonkeyPatch
 ) -> None:
     """Test that create-archival-file requires either --stable or --full."""
+    wd.setup_git(monkeypatch)
     wd.commit_testfile()
-    wd.write(PYPROJECT_TOML, PYPROJECT_SIMPLE)
     monkeypatch.chdir(wd.cwd)
 
     # Should fail without --stable or --full
+    pyproject_data = PYPROJECT_DATA_SIMPLE
     with pytest.raises(SystemExit):
-        main(["create-archival-file"])
+        main(["create-archival-file"], _given_pyproject_data=pyproject_data)
 
 
 def test_cli_create_archival_file_mutually_exclusive(
     wd: WorkDir, monkeypatch: pytest.MonkeyPatch
 ) -> None:
     """Test that --stable and --full are mutually exclusive."""
+    wd.setup_git(monkeypatch)
     wd.commit_testfile()
-    wd.write(PYPROJECT_TOML, PYPROJECT_SIMPLE)
     monkeypatch.chdir(wd.cwd)
 
     # Should fail with both --stable and --full
+    pyproject_data = PYPROJECT_DATA_SIMPLE
     with pytest.raises(SystemExit):
-        main(["create-archival-file", "--stable", "--full"])
+        main(
+            ["create-archival-file", "--stable", "--full"],
+            _given_pyproject_data=pyproject_data,
+        )
 
 
 def test_cli_create_archival_file_existing_gitattributes(
     wd: WorkDir, monkeypatch: pytest.MonkeyPatch
 ) -> None:
     """Test behavior when .gitattributes already has export-subst configuration."""
     wd.commit_testfile()
-    wd.write(PYPROJECT_TOML, PYPROJECT_SIMPLE)
     monkeypatch.chdir(wd.cwd)
 
     # Create .gitattributes with export-subst configuration
     gitattributes_file = wd.cwd / ".gitattributes"
     gitattributes_file.write_text(".git_archival.txt  export-subst\n", encoding="utf-8")
 
-    result = main(["create-archival-file", "--stable"])
+    pyproject_data = PYPROJECT_DATA_SIMPLE
+    result = main(
+        ["create-archival-file", "--stable"], _given_pyproject_data=pyproject_data
+    )
     assert result == 0
 
     archival_file = wd.cwd / ".git_archival.txt"
@@ -230,10 +273,12 @@ def test_cli_create_archival_file_no_gitattributes(
 ) -> None:
     """Test behavior when .gitattributes doesn't exist or lacks export-subst."""
     wd.commit_testfile()
-    wd.write(PYPROJECT_TOML, PYPROJECT_SIMPLE)
     monkeypatch.chdir(wd.cwd)
 
-    result = main(["create-archival-file", "--stable"])
+    pyproject_data = PYPROJECT_DATA_SIMPLE
+    result = main(
+        ["create-archival-file", "--stable"], _given_pyproject_data=pyproject_data
+    )
     assert result == 0
 
     archival_file = wd.cwd / ".git_archival.txt"