Merge pull request #120 from anx-bhagmann/coverage

Add code coverage to main GitHub workflow and upload to Codecov

Author: nezhar

.github/workflows/test.yml

@@ -47,7 +47,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install flake8
+        pip install flake8 codecov
 
     - name: Lint with flake8
       run: |
@@ -73,9 +73,21 @@ jobs:
 
     - name: Setup environment
       run: |
+        pip install -e .
         python setup.py install
 
     - name: Run tests
       run: |
-        cd tests
-        python manage.py test
+        # prepare Django project: link all necessary data from the test project into the root directory
+        # Hint: Simply changing the directory does not work (leads to missing files in coverage report)
+        ln -s ./tests/test test
+        ln -s ./tests/manage.py manage.py
+        ln -s ./tests/settings.py settings.py
+        ln -s ./tests/urls.py urls.py
+
+        # run tests with coverage
+        coverage run --source='./django_rest_passwordreset' manage.py test
+        coverage xml
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v1

README.md

@@ -2,6 +2,7 @@
 
 [![PyPI version](https://img.shields.io/pypi/v/django-rest-passwordreset.svg)](https://pypi.org/project/django-rest-passwordreset/)
 [![build-and-test actions status](https://github.com/anexia-it/django-rest-passwordreset/workflows/build-and-test/badge.svg)](https://github.com/anexia-it/django-rest-passwordreset/actions)
+[![Codecov](https://img.shields.io/codecov/c/gh/anexia-it/django-rest-passwordreset)](https://codecov.io/gh/anexia-it/django-rest-passwordreset)
 
 This python package provides a simple password reset strategy for django rest framework, where users can request password 
 reset tokens via their registered e-mail address.