feat: swap to cruft and add basic github actions syntax unit tests

Author: 56kyle

noxfile.py

@@ -49,7 +49,7 @@
 @nox.session(name="generate-demo", python=DEFAULT_TEMPLATE_PYTHON_VERSION)
 def generate_demo(session: Session) -> None:
     """Generates a project demo using the cookiecutter-robust-python template."""
-    session.install("cookiecutter", "platformdirs", "loguru", "typer")
+    session.install("cookiecutter", "cruft", "platformdirs", "loguru", "typer")
     session.run("python", GENERATE_DEMO_SCRIPT, *GENERATE_DEMO_OPTIONS, *session.posargs)
 
 

scripts/util.py

@@ -11,6 +11,7 @@
 from typing import Callable
 from typing import Generator
 
+import cruft
 import typer
 from cookiecutter.main import cookiecutter
 from cookiecutter.utils import work_in
@@ -78,12 +79,12 @@ def generate_demo(
     demos_cache_folder.mkdir(exist_ok=True)
     if no_cache:
         _remove_existing_demo(demo_path=demos_cache_folder / demo_name)
-    cookiecutter(
-        template=str(repo_folder),
-        no_input=True,
+    cruft.create(
+        template_git_url=str(repo_folder),
+        output_dir=demos_cache_folder,
         extra_context={"project_name": demo_name, **kwargs},
-        overwrite_if_exists=True,
-        output_dir=str(demos_cache_folder),
+        no_input=True,
+        overwrite_if_exists=True
     )
     return demos_cache_folder / demo_name
 

tests/conftest.py

@@ -5,6 +5,8 @@
 from typing import Any
 
 import pytest
+import toml
+import yaml
 from _pytest.fixtures import FixtureRequest
 from _pytest.tmpdir import TempPathFactory
 from cookiecutter.main import cookiecutter
@@ -21,6 +23,32 @@ def demos_folder(tmp_path_factory: TempPathFactory) -> Path:
     return tmp_path_factory.mktemp("demos")
 
 
+@pytest.fixture(scope="session")
+def robust_yaml(request: FixtureRequest, robust_file: str) -> dict[str, Any]:
+    return getattr(request, "param", yaml.safe_load(robust_file))
+
+
+@pytest.fixture(scope="session")
+def robust_toml(request: FixtureRequest, robust_file: str) -> dict[str, Any]:
+    return getattr(request, "param", toml.load(robust_file))
+
+
+@pytest.fixture(scope="session")
+def robust_file(request: FixtureRequest, robust_file__path: Path) -> str:
+    text: str = robust_file__path.read_text()
+    return getattr(request, "param", text)
+
+
+@pytest.fixture(scope="session")
+def robust_file__path(request: FixtureRequest, robust_demo: Path, robust_file__path__relative: str) -> Path:
+    return getattr(request, "param", robust_demo / robust_file__path__relative)
+
+
+@pytest.fixture(scope="session")
+def robust_file__path__relative(request: FixtureRequest) -> str:
+    return getattr(request, "param", "./pyproject.toml")
+
+
 @pytest.fixture(scope="session")
 def robust_demo(
     request: FixtureRequest,

tests/unit_tests/__init__.py

@@ -0,0 +1 @@
+"""Unit tests for cookiecutter-robust-python."""

tests/unit_tests/test_github_workflows.py

@@ -0,0 +1,23 @@
+from functools import partial
+from typing import Any
+
+import pytest
+
+from util import templates_matching
+
+
+@pytest.mark.parametrize(
+    argnames="robust_demo__add_rust_extension",
+    argvalues=[False, True],
+    indirect=True,
+    ids=["base", "maturin"]
+)
+class TestWorkflow:
+    @pytest.mark.parametrize(
+        argnames="robust_file__path__relative",
+        argvalues=templates_matching(".github/workflows/*.yml"),
+        indirect=True,
+        ids=lambda path: path.name
+    )
+    def test_workflow_basic_loading(self, robust_yaml: dict[str, Any]) -> None:
+        assert robust_yaml

tests/util.py

@@ -0,0 +1,9 @@
+"""Module containing utility functions used by tests."""
+from pathlib import Path
+
+from constants import COOKIECUTTER_FOLDER
+
+
+def templates_matching(pattern: str) -> list[Path]:
+    """Return a list of relative file paths matching the given pattern."""
+    return list(COOKIECUTTER_FOLDER.glob(pattern))