feature/coverage (#141)

* add coverage.sh

* fix permission on coverage.sh

* improve coverage sh script

* add coverage.xml to .igtignore

* improve doc on coverage.sh

* add doc for ./coverage.sh in contributing guide

Author: guillaumeraille

.gitignore

@@ -12,6 +12,7 @@ examples/.ipynb_checkpoints/
 runs/
 .coverage
 htmlcov
+coverage.xml
 .darts
 docs_env
 .DS_Store

README.md

@@ -113,7 +113,9 @@ Before working on a contribution (a new feature or a fix) make sure you can't fi
 3. Clone the forked repository locally.
 4. Create a clean python env and install requirements with pip: `pip install -r requirements/main.txt -r requirements/dev.txt -r requirements/release.txt`
 5. Create a new branch with your fix / feature from the **develop** branch.
-6. Create a pull request from your new branch to the **develop** branch.
+6. Check that your code pass the tests / design new unit tests: `python -m unittest`.
+7. Verify your tests coverage with `./coverage.sh` (additionaly you can generate xml report and use VSCode Coverage gutter to identify untested lines with `./coverage.sh xml`).
+8. Create a pull request from your new branch to the **develop** branch.
 
 ## Contact Us
 

coverage.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+# run and display coverage report properly filtered in terminal, xml or html
+# usage: ./coverage.sh [ xml | html ]
+usage()
+{
+    echo "usage: ./coverage.sh [ xml | html ]"
+}
+
+#### Main
+coverage run --source=. -m unittest
+if [ -z "$1" ]; then
+    coverage report -m --fail-under=80 --omit='darts/tests*,*__init__.py'
+else
+    case $1 in
+        xml )  coverage xml --fail-under=80 --omit='darts/tests*,*__init__.py' ;;
+        html ) coverage html --fail-under=80 --omit='darts/tests*,*__init__.py' ;;
+        * )    usage; exit 1;;
+    esac
+fi