Added new test infrastructure

.github/workflows/test_on_push.yml

@@ -1,4 +1,4 @@
-name: Test template generation
+name: Test template and generated project
 
 on:
   workflow_dispatch:
@@ -7,7 +7,6 @@ on:
     branches:
     - main
 
-
 jobs:
   style:
     runs-on: ubuntu-latest
@@ -32,7 +31,7 @@ jobs:
         os: [ubuntu-latest, macos-13, macos-14, windows-latest]
         python-version: ["3.9", "3.10", "3.11", "3.12"]
     name:
-      Template Tests (${{ matrix.os }} / Python ${{ matrix.python-version }})
+      Template Generation/Project Tests (${{ matrix.os }} / Python ${{ matrix.python-version }})
     steps:
       - name: Checkout pybamm-cookiecutter
         uses: actions/checkout@v4
@@ -51,13 +50,15 @@ jobs:
       - name: Install nox
         run: uv pip install nox[uv]
 
-      - name: Test Template Generation
-        run: |
-          nox -s test-generation
+      - name: Test template generation
+        run: nox -s template-tests
+
+      - name: Test project
+        run: nox -s project-tests
 
       - name: Run coverage tests
         if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
-        run: python -m nox -s coverage
+        run: nox -s coverage
 
       - name: Upload coverage report
         if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
@@ -86,4 +87,36 @@ jobs:
         run: python -m pip install nox
 
       - name: Check if the documentation can be built
-        run: python -m nox -s docs
+        run: nox -s docs
+
+  generated_project_tests:
+      needs: [template_test]
+
+      runs-on: ${{ matrix.os }}
+      strategy:
+        fail-fast: false
+        matrix:
+          os: [ubuntu-latest, macos-13, macos-14, windows-latest]
+          python-version: ["3.9", "3.10", "3.11", "3.12"]
+      name:
+        Generated Project Tests (${{ matrix.os }} / Python ${{ matrix.python-version }})
+      steps:
+        - name: Checkout pybamm-cookiecutter
+          uses: actions/checkout@v4
+
+        - name: Set up Python ${{ matrix.python-version }}
+          uses: actions/setup-python@v5
+          with:
+            python-version: ${{ matrix.python-version }}
+
+        - name: Install cookiecutter and pipx
+          run: python -m pip install cookiecutter pipx
+
+        - name: Generate a project using cookiecutter
+          run: cookiecutter . --no-input
+
+        - name: Install nox and test generated project
+          working-directory: ./pybamm-example-project
+          run: |
+            pipx install nox
+            pipx run nox -s generated-project-tests

cookiecutter.json

@@ -18,9 +18,11 @@
     "backend": [
         "hatch"
     ],
+    "hatch_vcs": false,
     "mypy": false,
     "__year": "{% now 'utc', '%Y' %}",
     "__project_slug": "{{ cookiecutter.project_name | lower | replace('-', '_') | replace('.', '_') }}",
+    "_copy_without_render": ["*.yml"],
     "__type": "{{ 'pure' }}",
     "__answers": "",
     "__ci": "{{ cookiecutter.platform }}",
@@ -40,7 +42,8 @@
         "license": "Select a license",
         "backend": {
             "__prompt__": "Choose a build backend",
-            "hatch": "Hatchling (recommended for pure Python projects)"
+            "hatch": "Hatchling (recommended for pure Python projects)",
+              "hatch_vcs": "Enable hatch version control (vcs)?"
         },
         "mypy": "Use mypy and static types"
     }

hooks/post_gen_project.py

@@ -20,5 +20,4 @@ def prepare_git() -> None:
     )
 
 if __name__ == "__main__":
-    print("Executing script!!")
     prepare_git()

noxfile.py

@@ -36,12 +36,19 @@ def build_docs(session: nox.Session) -> None:
                 "build/html/",
             )
 
-@nox.session(name="test-generation")
+@nox.session(name="template-tests")
 def run_template_generation(session):
     """Run the tests for testing template generation"""
     session.install("setuptools", silent=False)
     session.install("-e", ".[dev]", silent=False)
-    session.run("pytest", "tests")
+    session.run("pytest", "tests/template_tests")
+
+@nox.session(name="project-tests")
+def run_project_tests(session):
+    """Run the tests for testing template generation"""
+    session.install("setuptools", silent=False)
+    session.install("-e", ".[dev]", silent=False)
+    session.run("pytest", "tests/project_tests")
 
 @nox.session(name="coverage")
 def run_coverage(session):

{{cookiecutter.project_name}}/.github/workflows/test_on_push.yml

@@ -0,0 +1,90 @@
+name: Project Tests
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+    - main
+
+jobs:
+  style:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+
+      - name: Check style
+        run: |
+          python -m pip install pre-commit
+          pre-commit run -a
+
+  test_project:
+    needs: style
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-13, macos-14, windows-latest]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    name:
+      Template Generation/Project Tests (${{ matrix.os }} / Python ${{ matrix.python-version }})
+    steps:
+      - name: Checkout pybamm-cookiecutter
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python ${{ matrix.python-version }}
+        id: setup-python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Set up uv
+        uses: yezz123/setup-uv@v4
+        with:
+          uv-venv: ".venv"
+
+      - name: Install nox
+        run: uv pip install nox[uv]
+
+      - name: Test project units
+        run: nox -s generated-project-tests
+
+      - name: Test user tests
+        run: nox -s user-tests
+
+      - name: Run coverage tests
+        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
+        run: nox -s coverage
+
+      - name: Upload coverage report
+        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
+        uses: codecov/[email protected]
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  run_doctests:
+    needs: style
+    runs-on: ubuntu-latest
+    name: Doctests (ubuntu-latest / Python 3.12)
+
+    steps:
+      - name: Check out pybamm-cookiecutter repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+          cache: 'pip'
+
+      - name: Install nox
+        run: python -m pip install nox
+
+      - name: Check if the documentation can be built
+        run: nox -s docs

{{cookiecutter.project_name}}/noxfile.py

@@ -1,20 +1,66 @@
 import nox
+from pathlib import Path
+import os
 
 # Options to modify nox behaviour
+nox.options.default_venv_backend = "uv|virtualenv"
 nox.options.reuse_existing_virtualenvs = True
 
+VENV_DIR = Path("./venv").resolve()
+
 @nox.session(name="docs")
-def build_docs(session):
+def build_docs(session: nox.Session) -> None:
     """Build the documentation and load it in a browser tab, rebuilding on changes."""
-    envbindir = session.bin
     session.install("-e", ".[docs]")
     with session.chdir("docs/"):
-        session.run(
-            "sphinx-autobuild",
-            "-j",
-            "auto",
-            "--open-browser",
-            "-qT",
-            ".",
-            f"{envbindir}/../tmp/html",
-        )
+        # For local development
+        if session.interactive:
+            session.run(
+                "sphinx-autobuild",
+                "-j",
+                "auto",
+                "--open-browser",
+                "-qT",
+                ".",
+                "build/html/",
+            )
+        # For CI testing if documentation builds
+        else:
+            session.run(
+                "sphinx-build",
+                "-b",
+                "html",
+                "-W",
+                "--keep-going",
+                ".",
+                "build/html/",
+            )
+
+@nox.session(name="generated-project-tests")
+def run_generated_project_tests(session):
+    """Run the tests for testing units inside generated project"""
+    session.install("setuptools", silent=False)
+    session.install("-e", ".[dev]", silent=False)
+    session.run("pytest", "tests/generated_project_tests")
+
+@nox.session(name="user-tests")
+def run_user_tests(session):
+    """Run the tests for testing user written tests"""
+    session.install("setuptools", silent=False)
+    session.install("-e", ".[dev]", silent=False)
+    session.run("pytest", "tests/user_tests")
+
+@nox.session(name="coverage")
+def run_coverage(session):
+    """Run the coverage tests and generate an XML report."""
+    session.posargs.append("--cov=src/pybamm_cookiecutter")
+    session.posargs.append("--cov-report=xml")
+    run_user_tests(session)
+
+@nox.session(name="dev")
+def set_dev(session):
+    """Install pybamm-cookiecutter in editable mode"""
+    session.install("virtualenv")
+    session.run("virtualenv", os.fsdecode(VENV_DIR), silent=True)
+    python = os.fsdecode(VENV_DIR.joinpath("bin/python"))
+    session.run(python, "-m", "pip", "install", "-e", ".[dev]")

{{cookiecutter.project_name}}/pyproject.toml

@@ -2,7 +2,9 @@
 {%- if cookiecutter.backend == "hatch" %}
 requires = [
   "hatchling",
-  "hatch-vcs"
+{%- if cookiecutter.hatch_vcs == true %}
+  "hatch-vcs",
+{%- endif %}
 ]
 build-backend = "hatchling.build"
 {%- endif %}
@@ -86,12 +88,19 @@ SPM = "{{ cookiecutter.__project_slug }}.models.input.SPM:SPM"
 {# keep this line here for newline #}
 {%- if cookiecutter.backend == "hatch" %}
 [tool.hatch]
+{%- if cookiecutter.hatch_vcs == true %}
 version.source = "vcs"
 build.hooks.vcs.version-file = "src/{{ cookiecutter.__project_slug }}/_version.py"
+{%- endif %}
 envs.default.dependencies = [
   "pybamm",
 ]
 {%- endif %}
+
+{%- if cookiecutter.hatch_vcs == false %}
+[tool.hatch.version]
+path = "src/{{ cookiecutter.__project_slug }}/__init__.py"
+{%- endif %}
 {# keep this line here for newline #}
 {%- if cookiecutter.mypy %}
 [tool.mypy]

{{cookiecutter.project_name}}/src/{{cookiecutter.__project_slug}}/__init__.py

@@ -7,7 +7,11 @@
 from __future__ import annotations
 {%- endif %}
 
+{%- if cookiecutter.hatch_vcs %}
 from ._version import version as __version__
+{%- else %}
+__version__ = "0.1.0"
+{%- endif %}
 import pybamm
 from .entry_point import Model, parameter_sets, models
 {# keep this line here for newline #}
@@ -16,7 +20,9 @@
 {%- else %}
 __all__ = [
 {%- endif %}
+{%- if cookiecutter.hatch_vcs %}
     "__version__",
+{%- endif %}
     "pybamm",
     "parameter_sets",
     "Model",

{{cookiecutter.project_name}}/tests/generated_project_tests/test_entry_points.py

@@ -0,0 +1,45 @@
+import pytest
+import {{ cookiecutter.__project_slug }}
+import importlib.util
+import sys
+from pathlib import Path
+
+
+def test_parameter_sets_entry_points():
+    """Test if the parameter_sets via entry points are loaded correctly."""
+
+    entry_points = list({{ cookiecutter.__project_slug }}.parameter_sets)
+    parameter_sets = Path("src/{{ cookiecutter.__project_slug }}/parameters/input/").glob("*.py")
+    # Making a list of parameter sets in the parameters/input directory
+    parameter_sets = [x.stem for x in parameter_sets]
+
+    assert parameter_sets == entry_points, "Entry points missing either in pyproject.toml or in the input directory"
+
+
+def test_parameter_sets_entry_point_load():
+    """Testing if the values get loaded via parameter entry points and are equal when loaded through entry points"""
+    # Loading parameter_sets through entry points
+    parameters = {{ cookiecutter.__project_slug }}.parameter_sets['Chen2020']
+    # Loading parameter sets through the source file by dynamically loading Chen2020.py as a module
+    spec = importlib.util.spec_from_file_location("Chen2020mod", "src/{{ cookiecutter.__project_slug }}/parameters/input/Chen2020.py")
+    chen_module = importlib.util.module_from_spec(spec)
+    sys.modules["Chen2020mod"] = chen_module
+    spec.loader.exec_module(chen_module)
+    parameters_from_file = chen_module.get_parameter_values()
+    assert parameters.keys() == parameters_from_file.keys(), f"The keys in the module and local input file are not the same, expected {parameters.keys} got {parameters_from_file.keys()}"
+
+def test_model_entry_points():
+    """Test if the models via entry points are loaded correctly."""
+
+    entry_points = list({{ cookiecutter.__project_slug }}.models)
+    models = Path("src/{{ cookiecutter.__project_slug }}/models/input/").glob("*.py")
+    # Making a list Parameter sets in the parameters/input directory
+    models = [x.stem for x in models]
+
+    assert models == entry_points, "Entry points missing either in pyproject.toml or in the input directory"
+
+def test_model_entry_point_load():
+    """Testing if the model gets initialised and returned."""
+    # Loading parameter_sets through entry points
+    model_instance = {{ cookiecutter.__project_slug }}.Model("SPM")
+    assert model_instance is not None