add code coverage check

Author: nuest

.github/workflows/ci.yml

@@ -63,7 +63,18 @@ jobs:
 
     - name: Run Tests
       run: |
-        python -Wa manage.py test tests
+        coverage run --source='publications' --omit='*/migrations/**' manage.py test tests
+
+    - name: Save coverage to files
+      run: |
+        coverage html
+        coverage xml
+
+    - name: Get code coverage
+      uses: orgoro/coverage@v3.2
+      with:
+          coverageFile: coverage.xml
+          token: ${{ secrets.GITHUB_TOKEN }}
 
   uitests:
     # disable until UI tests are fixed, see https://github.com/GeoinformationSystems/optimap/issues/142

README.md

@@ -261,13 +261,30 @@ python -Wa manage.py test
 
 # configure logging level for cleaner test progress output
 OPTIMAP_LOGGING_LEVEL=WARNING python manage.py test tests
+```
+
+### Run UI tests
+
+Running UI tests needs either compose configuration or a manage.py runserver in a seperate shell.
 
-# running UI tests needs either compose configuration or a manage.py runserver in a seperate shell
+```bash
 docker-compose up --build
 
 python -Wa manage.py test tests-ui
 ```
 
+### Check test coverage
+
+```bash
+coverage run --source='publications' --omit='*/migrations/**' manage.py test tests
+
+coverage report
+
+# save the reports
+coverage html
+coverage xml
+```
+
 ### Develop tests
 
 For developing the UI tests, you can remove the `headless=True` in the statements for starting the browsers so you can "watch along" and inspect the HTML when a breakpoint is hit as the tests are executed.

requirements-dev.txt

@@ -3,3 +3,4 @@ pyvirtualdisplay
 responses
 xmldiff
 fiona
+coverage