added tests for template generation

Author: santacodes

pyproject.toml

@@ -30,14 +30,15 @@ classifiers = [
   "Typing :: Typed",
 ]
 dynamic = ["version"]
-dependencies = ["pybamm"]
+dependencies = ["pybamm", "cookiecutter"]
 
 [project.optional-dependencies]
 dev = [
   "pytest >=6",
   "pytest-cov >=3",
   "nox",
   "pre-commit",
+  "pytest-cookies",
 ]
 docs = [
   "sphinx",

src/pybamm_cookiecutter/__init__.py

@@ -5,6 +5,11 @@
 """
 from __future__ import annotations
 
+import pybamm
+
 from ._version import version as __version__
 
-__all__ : tuple[str] = ("__version__",)
+__all__ : list[str] = [
+    "__version__",
+    "pybamm",
+]

tests/test_package.py

@@ -0,0 +1,31 @@
+import pybamm_cookiecutter as m
+import pytest
+
+def test_version() -> None:
+    assert m.__version__
+
+@pytest.fixture
+def custom_template(tmpdir):
+    """
+    Generating a project using the template into a tempdir
+    """
+    template = tmpdir.ensure("cookiecutter-template", dir=True)
+    template.join("cookiecutter.json").write('{"project_name": "pybamm_cookie"}')
+
+    repo_dir = template.ensure("{{cookiecutter.project_name}}", dir=True)
+    repo_dir.join("README.rst").write("{{cookiecutter.project_name}}")
+
+    return template
+
+
+def test_bake_custom_project(cookies, custom_template):
+    """
+    Testing if the projects exists in the tempdir
+    """
+    result = cookies.bake(template=str(custom_template))
+
+    assert result.exit_code == 0
+    assert result.exception is None
+
+    assert result.project_path.name == "pybamm_cookie"
+    assert result.project_path.is_dir()