!squash

Author: tony

cookiecutter.json

@@ -8,7 +8,7 @@
     "author_email": "[email protected]",
     "github_username": "username",
     "github_repo": "{{ cookiecutter.project_slug }}",
-    "version": "0.0.1",
+    "version": "0.1.0",
     "python_version": "3.9",
     "license": ["MIT", "BSD-3", "GPL-3.0", "Apache-2.0"],
     "include_docs": ["y", "n"],

hooks/post_gen_project.py

@@ -142,7 +142,7 @@ def generate_apache2_license():
             # Create a basic test file
             with open("tests/test_cli.py", "w") as f:
                 f.write("""#!/usr/bin/env python
-"""Test CLI for {{cookiecutter.package_name}}."""
+\"\"\"Test CLI for {{cookiecutter.package_name}}.\"\"\"
 
 from __future__ import annotations
 
@@ -157,7 +157,7 @@ def generate_apache2_license():
 
 
 def test_run():
-    """Test run."""
+    \"\"\"Test run.\"\"\"
     # Test that the function doesn't error
     proc = {{cookiecutter.package_name}}.run(cmd="echo", cmd_args=["hello"])
     assert proc is None
@@ -216,10 +216,10 @@ def test_run():
 
     steps:
       - uses: actions/checkout@v3
-      - name: Set up Python ${{ matrix.python-version }}
+      - name: Set up Python ${{ "{{" }} matrix.python-version {{ "}}" }}
         uses: actions/setup-python@v4
         with:
-          python-version: ${{ matrix.python-version }}
+          python-version: ${{ "{{" }} matrix.python-version {{ "}}" }}
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip

tests/README.md

@@ -0,0 +1,47 @@
+# Testing the Cookiecutter Template
+
+This directory contains tests for the cookiecutter template. The tests use [pytest-cookies](https://github.com/hackebrot/pytest-cookies), a pytest plugin for testing cookiecutter templates.
+
+## Running the Tests
+
+1. Install pytest and pytest-cookies:
+
+```bash
+pip install pytest pytest-cookies
+```
+
+2. Run the tests:
+
+```bash
+pytest -xvs tests/test_cookiecutter.py
+```
+
+Alternatively, if you're using `uv` (the fast Python package installer and resolver):
+
+```bash
+uv run pytest -xvs tests/test_cookiecutter.py
+```
+
+## Test Overview
+
+The tests in `test_cookiecutter.py` cover the following scenarios:
+
+1. **Default template generation**: Tests that the template generates correctly with default values.
+2. **Test execution in generated project**: Tests that the generated project's own tests run successfully.
+3. **VCS path registry**: Tests proper configuration of supported version control systems.
+4. **License file generation**: Tests that the correct license file is generated based on selection.
+5. **GitHub Actions workflow creation**: Tests optional GitHub Actions workflow generation.
+6. **Documentation creation**: Tests optional documentation generation.
+7. **pyproject.toml configuration**: Tests proper project metadata configuration.
+8. **README badge inclusion**: Tests conditional inclusion of status badges in README.
+9. **Package structure**: Tests proper Python package directory structure.
+
+## Debugging
+
+If you encounter issues with the tests, you can keep the generated projects for inspection by adding the `--keep-baked-projects` flag:
+
+```bash
+pytest -xvs tests/test_cookiecutter.py --keep-baked-projects
+```
+
+This can be helpful for debugging test failures as you can inspect the actual generated files.