Add option for tests (#447)

* wip add tests

* stub tests

* Simple failing tests and make test command

* Do not run tests inside template

Author: r-b-g-b

Makefile

@@ -54,7 +54,7 @@ clean-test: ## remove test and coverage artifacts
 	rm -f .coverage
 	rm -fr htmlcov/
 	rm -fr .pytest_cache
-	
+
 dist: clean ## builds source and wheel package
 	python -m build
 	ls -l dist
@@ -71,7 +71,7 @@ docs-serve:
 ###     TESTS
 
 test: _prep
-	pytest -vvv --durations=0
+	pytest -vvv --durations=0 tests
 
 test-fastest: _prep
 	pytest -vvv -FFF

ccds-help.json

@@ -216,6 +216,36 @@
             }
         ]
     },
+    {
+        "field": "testing_framework",
+        "help": {
+            "description": "Framework used for testing your code.",
+            "more_information": ""
+        },
+        "choices": [
+            {
+                "choice": "none",
+                "help": {
+                    "description": "No testing framework.",
+                    "more_information": ""
+                }
+            },
+            {
+                "choice": "pytest",
+                "help": {
+                    "description": "Use the pytest framework for testing.",
+                    "more_information": "[Docs](https://docs.pytest.org/en/latest/)"
+                }
+            },
+            {
+                "choice": "unittest",
+                "help": {
+                    "description": "Use Python's built-in testing framework.",
+                    "more_information": "[Docs](https://docs.python.org/3/library/unittest.html)"
+                }
+            }
+        ]
+    },
     {
         "field": "linting_and_formatting",
         "help": {

ccds.json

@@ -28,11 +28,16 @@
         "none",
         "basic"
     ],
+    "testing_framework": [
+        "none",
+        "pytest",
+        "unittest"
+    ],
     "linting_and_formatting": [
         "ruff",
         "flake8+black+isort"
     ],
     "open_source_license": ["No license file", "MIT", "BSD-3-Clause"],
     "docs": ["mkdocs", "none"],
     "include_code_scaffold": ["Yes", "No"]
-}
+}

hooks/post_gen_project.py

@@ -45,6 +45,27 @@
     "python-dotenv",
 ]
 
+# Select testing framework
+tests_path = Path("tests")
+
+# {% if cookiecutter.testing_framework == "pytest" %}
+packages_to_install += ["pytest"]
+# {% endif %}
+
+# {% if cookiecutter.testing_framework == "none" %}
+shutil.rmtree(tests_path)
+
+# {% else %}
+tests_subpath = tests_path / "{{ cookiecutter.testing_framework }}"
+for obj in tests_subpath.iterdir():
+    shutil.move(str(obj), str(tests_path))
+
+# Remove all remaining tests templates
+for tests_template in tests_path.iterdir():
+    if tests_template.is_dir() and not tests_template.name == "tests":
+        shutil.rmtree(tests_template)
+# {% endif %}
+
 # Use the selected documentation package specified in the config,
 # or none if none selected
 docs_path = Path("docs")

{{ cookiecutter.repo_name }}/Makefile

@@ -31,7 +31,7 @@ requirements:
 	conda env update --name $(PROJECT_NAME) --file environment.yml --prune
 	{% elif "Pipfile" == cookiecutter.dependency_file -%}
 	pipenv install
-	{% endif %}
+{% endif %}
 {% endif %}
 
 
@@ -68,6 +68,17 @@ format:
 	black {{ cookiecutter.module_name }}
 {% endif %}
 
+{% if cookiecutter.testing_framework != 'none' %}
+## Run tests
+.PHONY: test
+test:
+{%- if cookiecutter.testing_framework == 'unittest' %}
+	python -m unittest discover -s tests
+{%- elif cookiecutter.testing_framework == 'pytest' %}
+	python -m pytest tests
+{%- endif -%}
+{%- endif -%}
+
 {% if not cookiecutter.dataset_storage.none %}
 ## Download Data from storage system
 .PHONY: sync_data_down
@@ -118,7 +129,7 @@ create_environment:
 	@echo ">>> New uv virtual environment created. Activate with:"
 	@echo ">>> Windows: .\\\\.venv\\\\Scripts\\\\activate"
 	@echo ">>> Unix/macOS: source ./.venv/bin/activate"
-	{% endif %}
+{% endif %}
 {% endif %}
 
 

{{ cookiecutter.repo_name }}/tests/pytest/test_data.py

@@ -0,0 +1,5 @@
+import pytest
+
+
+def test_code_is_tested():
+    assert False

{{ cookiecutter.repo_name }}/tests/unittest/test_data.py

@@ -0,0 +1,11 @@
+import unittest
+
+
+class TestCodeIsTested(unittest.TestCase):
+
+    def test_code_is_tested(self):
+        self.assertTrue(False)
+
+
+if __name__ == '__main__':
+    unittest.main()