CHORE: Code coverage reports

- Create code coverage reports with pytest-cov.
- Configured CI for Codecov reports.

Author: truhanen

.github/workflows/codecov.yml

@@ -0,0 +1,35 @@
+name: "Codecov workflow"
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install Poetry
+        run: pip3 install poetry
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+
+      - name: Install dependencies
+        run: |
+          poetry install
+
+      - name: Run tests
+        run: |
+          poetry run gird test
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3

.gitignore

@@ -1,5 +1,6 @@
 .idea
 dist
-.gird
 test/benchmark/.cache
-test/benchmark/tmp
+test/benchmark/tmp
+.coverage
+coverage.xml

README.md

@@ -61,8 +61,8 @@ WHEEL_PATH = get_wheel_path()
 
 RULE_PYTEST = rule(
     target=Phony("pytest"),
-    recipe="pytest -n auto",
-    help="Run pytest.",
+    recipe="pytest -n auto --cov=gird --cov-report=xml",
+    help="Run pytest & get code coverage report.",
 )
 
 RULE_CHECK_FORMATTING = rule(
@@ -120,13 +120,13 @@ Respective output from `gird list`:
 
 ```
 pytest
-    Run pytest.
+    Run pytest & get code coverage report.
 check_formatting
     Check formatting with Black & isort.
 check_readme_updated
     Check that README.md is updated based on README_template.md.
 test
-    - Run pytest.
+    - Run pytest & get code coverage report.
     - Check formatting with Black & isort.
     - Check that README.md is updated based on README_template.md.
 README.md

girdfile.py

@@ -8,8 +8,8 @@
 
 RULE_PYTEST = rule(
     target=Phony("pytest"),
-    recipe="pytest -n auto",
-    help="Run pytest.",
+    recipe="pytest -n auto --cov=gird --cov-report=xml",
+    help="Run pytest & get code coverage report.",
 )
 
 RULE_CHECK_FORMATTING = rule(

poetry.lock

@@ -25,6 +25,7 @@ jinja2 = "^3.1.2"
 twine = "^4.0.2"
 tomli = "^2.0.1"
 pytest-xdist = "^3.2.0"
+pytest-cov = "^4.0.0"
 
 [tool.isort]
 profile = "black"