Jan-Philip Gehrcke avatar Jan-Philip Gehrcke committed 0876c74

Update audit and docs regarding code coverage.

Comments (0)

Files changed (2)

 ===========================
 I use `pep8 <http://pypi.python.org/pypi/pep8>`_ and
 `pylint <http://pypi.python.org/pypi/pylint>`_. Have a look at ``audit.sh`` in
-the code repository.
-    
-    
+the code repository. Unit test code coverage analysis requires
+`coverage <http://pypi.python.org/pypi/coverage>`_ and
+`pytest-cov <http://pypi.python.org/pypi/pytest-cov>`_. ``audit.sh`` leaves
+behind a coverage HTML report in the ``coverage_html`` directory.
+
+
 Contact & Help
 ==============
 Your feedback and questions are highly appreciated. For now, please contact me
 #!/bin/bash
-echo "Running gipc unit tests..."
-cd test
-py.test
-cd ..
+echo "Running gipc unit tests, investigate code coverage..."
+py.test --cov gipc test
+if [ -d coverage_html ]; then
+    rm -rf coverage_html/*
+fi
+coverage html -d coverage_html
 echo -e "\n\nRunning setup.py check & readme2html..."
 python setup.py check
 python setup.py --long-description | rst2html.py > /dev/null
 echo -e "\n\nRunning PEP8 check..."
 pep8
 echo -e "\n\nRunning pylint..."
-cd gipc
-pylint --reports=n --include-ids=y --disable=C0103,W0212,W0511,W0142,R0903 gipc.py
-cd ..
+pylint --reports=n --include-ids=y --disable=C0103,W0212,W0511,W0142,R0903 gipc/gipc.py
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.