add diff-cover target, updated tools, readme

Author: kovach

DEVELOPMENT.md

@@ -0,0 +1,19 @@
+libswiftnav development
+=======================
+
+Follow these instructions if you intend to make changes to libswiftnav.
+
+Tools needed:
+ * doxygen
+ * pip install gcovr diff-cover
+
+To get started, run::
+  ./checks/setup-hooks.sh [DIR]
+
+from within the libswiftnav root directory. The default build-dir will be `build`.
+
+This makes the directory if it doesn't already exist, runs cmake with `Coverage` mode enabled
+inside it, and installs a git pre-commit hook that runs style and code-coverage checkers
+in this build directory. These checks require doxygen, gcovr, and diff-cover
+
+To manually run the coverage task, use `make coverage`. For syntax, use `make style`.

checks/checkoutput.sh

@@ -1,2 +1,2 @@
-echo "HEY: git diff $1 | $2 --no-tree - > check_output.txt"
+#echo "HEY: git diff $1 | $2 --no-tree - > check_output.txt"
 git diff $1 | $2 --no-tree - > check_output.txt

checks/pre-commit

@@ -0,0 +1,7 @@
+set -e
+echo "precommit running. checking build located at ${subdir}."
+cd ${subdir}
+../checks/run-coverage.sh
+
+#echo "commit failed"
+exit 1

checks/run-coverage.sh

@@ -0,0 +1,7 @@
+# requires gcovr and diff-cover
+# pip install gcovr diff-cover
+set -e
+gcovr -r .. --object-directory . --xml -o ../.coverage.xml
+gcovr -r .. --object-directory . --html -o coverage.html
+( cd .. && diff-cover .coverage.xml --fail-under=85 --html-report .diffreport.html )
+mv ../.diffreport.html ./diffreport.html

checks/setup-hooks.sh

@@ -0,0 +1,10 @@
+# set up build directory
+builddir=${1:-build/} # by default use build/
+echo "Build directory: ${builddir}"
+mkdir -p $builddir
+( cd $builddir && cmake -DCMAKE_BUILD_TYPE=Coverage .. )
+
+hooks="`git rev-parse --git-dir`/hooks"
+echo "Installing hook at: ${hooks}"
+# insert value of builddir as first line of pre-commit
+echo "subdir=$builddir" | cat - checks/pre-commit > "$hooks/pre-commit"

tests/CMakeLists.txt

@@ -51,8 +51,29 @@ else (CMAKE_CROSSCOMPILING)
       COMMENT "Running unit tests"
       COMMAND test_libswiftnav
     )
+
+    # for convenience:
+    add_custom_target(tests
+      DEPENDS test_libswiftnav
+      COMMAND test_libswiftnav
+    )
+    add_custom_target(test
+      DEPENDS test_libswiftnav
+      COMMAND test_libswiftnav
+    )
+
     file(COPY data/waas_check.bin DESTINATION ${CMAKE_BINARY_DIR}/tests)
     file(COPY data/waas_data.bin DESTINATION ${CMAKE_BINARY_DIR}/tests)
 
+    # TODO run even if tests fail?
+    # TODO check that we're in a coverage build
+    add_custom_command(
+      DEPENDS test
+      OUTPUT diffreport.html
+      COMMAND ../checks/run-coverage.sh
+      WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+    )
+    add_custom_target(coverage DEPENDS diffreport.html)
+
   endif (NOT CHECK_FOUND)
 endif (CMAKE_CROSSCOMPILING)