Added pytest-cov and codecov support (#50)

* moved composite actions from workflows to actions
* Added pytest-cov and codecov support
* Modified docs accordingly

Author: Florian Maas

README.md

@@ -24,6 +24,7 @@ repository to generate the file structure for a Python project that uses
 - Linting with [flake8](https://flake8.pycqa.org/en/latest/)
 - Publishing to [Pypi](https://pypi.org) or [Artifactory](https://jfrog.com/artifactory) by creating a new release on GitHub
 - Testing with [pytest](https://docs.pytest.org/en/7.1.x/)
+- Test coverage with [codecov](https://about.codecov.io/)
 - Documentation with [MkDocs](https://www.mkdocs.org/)
 - Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)
 - Compatibility testing for multiple versions of Python with [Tox](https://tox.wiki/en/latest/)

codecov.yaml

@@ -0,0 +1,18 @@
+# Badge color changes from red to green between 70% and 100%
+# PR pipeline fails if codecov falls with 1%
+
+coverage:
+  range: 70..100
+  round: down
+  precision: 1
+  status:
+    project:
+      default:
+        target: auto
+        threshold: 1%
+
+# Ignoring Paths
+# --------------
+# which folders/files to ignore
+ignore:
+  - "foo/bar.py"

cookiecutter.json

@@ -10,6 +10,7 @@
     "mkdocs": ["y", "n"],
     "tox": ["y","n"],
     "mypy" : ["y","n"],
+    "codecov" : ["y","n"],
     "dockerfile" : ["y","n"],
     "open_source_license": ["MIT license", "BSD license", "ISC license", "Apache Software License 2.0", "GNU General Public License v3", "Not open source"]
 }

docs/features/codecov.md

@@ -0,0 +1,27 @@
+# Test coverage with codecov
+
+If `codecov` is set to `"y"`, `pytest-cov` is added as a development dependency,
+and `make test` will run the tests and output a coverage report as `coverage.xml`.
+If `include_github_actions` is set to `"y"`, coverage tests with [codecov](https://about.codecov.io/) are added to the CI/CD pipeline.
+Additionally, a `codecov.yaml` file is created, with the following defaults:
+
+``` yaml
+# Badge color changes from red to green between 70% and 100%
+# PR pipeline fails if codecov falls with 1%
+
+coverage:
+  range: 70..100
+  round: down
+  precision: 1
+  status:
+    project:
+      default:
+        target: auto
+        threshold: 1%
+
+# Ignoring Paths
+# --------------
+# which folders/files to ignore
+ignore:
+  - "foo/bar.py"
+```

docs/index.md

@@ -18,6 +18,7 @@ A project generated with ``cookiecutter-poetry`` supports the following features
 - Linting with [flake8](https://flake8.pycqa.org/en/latest/)
 - Publishing to [Pypi](https://pypi.org) or [Artifactory](https://jfrog.com/artifactory) by creating a new release on GitHub
 - Testing with [pytest](https://docs.pytest.org/en/7.1.x/)
+- Test coverage with [codecov](https://about.codecov.io/)
 - Documentation with [MkDocs](https://www.mkdocs.org/)
 - Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)
 - Compatibility testing for multiple versions of Python with [Tox](https://tox.wiki/en/latest/)

docs/prompt_arguments.md

@@ -65,6 +65,11 @@ compatibility with multiple versions of Python.
 
 `"y"` or `"n"`. Adds automatic static type checking with [mypy](https://mypy.readthedocs.io/en/stable/).
 
+**mypy**
+
+`"y"` or `"n"`. Adds test coverage with [codecov](https://about.codecov.io/).
+
+
 **dockerfile**
 
 `"y"` or `"n"`. Adds a simple [Dockerfile](https://docker.com).

hooks/post_gen_project.py

@@ -23,3 +23,6 @@ def remove_dir(filepath: str) -> None:
 
     if "{{cookiecutter.dockerfile}}" != "y":
         remove_file("Dockerfile")
+
+    if "{{cookiecutter.codecov}}" != "y":
+        remove_file("codecov.yaml")

mkdocs.yml

@@ -14,6 +14,7 @@ nav:
     - Dependency management with Poetry: features/poetry.md
     - Publishing to PyPi or Artifactory: features/publishing.md
     - Testing with Pytest: features/pytest.md
+    - Test coverage with codecov: features/codecov.md
     - Documentation with MkDocs: features/mkdocs.md
     - Compatibility testing with Tox: features/tox.md
     - Static type checking with mypy: features/mypy.md

tests/test_cookiecutter.py

@@ -41,7 +41,7 @@ def test_using_pytest(cookies, tmp_path):
 
         # Install the poetry environment and run the tests.
         with run_within_dir(str(result.project_path)):
-            subprocess.check_call(shlex.split("poetry install --no-interaction --no-root")) == 0
+            subprocess.check_call(shlex.split("poetry install --no-interaction")) == 0
             subprocess.check_call(shlex.split("poetry run make test")) == 0
 
 
@@ -121,3 +121,9 @@ def test_not_dockerfile(cookies, tmp_path):
     with run_within_dir(tmp_path):
         result = cookies.bake(extra_context={"dockerfile": "n"})
         assert not os.path.isfile(f"{result.project_path}/Dockerfile")
+
+
+def test_not_codecov(cookies, tmp_path):
+    with run_within_dir(tmp_path):
+        result = cookies.bake(extra_context={"codecov": "n"})
+        assert not os.path.isfile(f"{result.project_path}/codecov.yaml")

{{cookiecutter.project_name}}/.github/actions/run-checks/action.yml

@@ -17,4 +17,9 @@ runs:
               source .venv/bin/activate
               make test
         shell: bash
-        
+        
+{%- if cookiecutter.codecov == "y" %}
+
+      - name: Upload coverage reports to Codecov with GitHub Action
+        uses: codecov/codecov-action@v3
+{%- endif %}