coverage script for pipeline and docker setup instructions

README.md

@@ -46,6 +46,7 @@ $ sudo make -C lcov-1.11/ install
 lcov --directory . --capture --output-file coverage.info
 lcov --list coverage.info
 ```
+_A `cover.sh [target_percentage]` script is also provided for coverage check after `rebar3 eunit`._
 
 ## Testing
 There are some eunit tests which can be executed through `rebar3 do clean, compile, eunit` (Oracle Server connect info **MUST** be supplied through `tests/connect.config` first).

cover.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+target_coverage=${1:-100}
+
+rm -f coverage.info
+# capture coverage info
+lcov --quiet --directory . --capture --output-file coverage.info
+# header files are not covered
+lcov --quiet --remove coverage.info "*/odpi/src/*.c" "*.h" --output-file coverage.info
+
+# Sample structure of lcov --summary coverage.info
+# Reading tracefile coverage.info
+# Summary coverage rate:
+#   lines......: 13.2% (142 of 1078 lines)
+#   functions..: 21.1% (12 of 57 functions)
+#   branches...: no data found
+#
+# grep to find the 'lines...' line with total % (e,g, 13.2 above)
+lc_summary=$(lcov --summary coverage.info 2>&1 | grep -zo "lines[.]\+: [0-9.]\+" | tr '\0' '\n')
+# stip off the rest to get the number
+current_coverage=$(echo $lc_summary | sed 's/lines\.*: \(.*\)/\1/')
+
+# calculate difference to target
+result=$(awk 'BEGIN { print('$current_coverage'<'$target_coverage')?"F":"P"}')
+if [ "$result" = "P" ]; then
+  exit 0
+else
+  lcov --list coverage.info
+  echo "------------------------"
+  echo "TARGET  : $target_coverage %"
+  echo "CURRENT : $current_coverage %"
+  echo "------------------------"
+  exit 1
+fi

rebar.config

@@ -28,10 +28,12 @@
 
 {profiles, [
     {test, [
-        {pre_hooks,
-          [{"(win32)", compile, "nmake -F c_src/Makefile.win32"}
-          ,{"(linux|darwin)",  compile, "make -f c_src/Makefile test"}]
-        },
+        {pre_hooks, [
+          {"(win32)", compile, "nmake -F c_src/Makefile.win32"},
+          {"(linux|darwin)",  compile, "make -f c_src/Makefile test"},
+          {"(linux|darwin)",  eunit, "lcov --directory . --zerocounters"}
+        ]},
+        {post_hooks, [{"(linux|darwin)", eunit, "bash cover.sh"}]},
         {dist_node, [{setcookie, 'testcookie'}, {name, '[email protected]'}]}
     ]}
 ]}.