Code Coverage (#1368)

.gitignore

@@ -56,3 +56,6 @@ setup.log
 
 # Backup of opam lock file
 hazel.opam.locked.old
+
+# Code coverage
+_coverage/

Makefile

@@ -66,5 +66,13 @@ test:
 watch-test:
 	dune build @ocaml-index @fmt @runtest --auto-promote --watch
 
+coverage:
+	dune build @src/fmt @test/fmt --auto-promote src test --profile dev
+	dune runtest --instrument-with bisect_ppx --force
+	bisect-ppx-report summary
+
+generate-coverage-html:
+	bisect-ppx-report html
+
 clean:
 	dune clean

README.md

@@ -197,6 +197,9 @@ You can run all of the unit tests located in `test` by running `make test`.
 
 Unit tests are written using the [Alcotest framework](https://github.com/mirage/alcotest).
 
+#### Coverage
+Code coverage is provided by [bisect_ppx](https://github.com/aantron/bisect_ppx). To collect coverage statistics from tests run `make coverage`. After coverage statistics are generated, running `make generate-coverage-html` will generate a local webpage at `_coverage/index.html` that can be viewed to see line coverage per module.
+
 ### Continuous Integration
 
 When you push your branch to the main `hazelgrove/hazel` repository, we 

dune-project

@@ -26,9 +26,11 @@
   (menhir
    (>= 2.0))
   yojson
-  reason
+  (reason (>= 3.12.0))
   ppx_yojson_conv_lib
   ppx_yojson_conv
+  incr_dom
+  bisect_ppx
   (omd (>= 2.0.0~alpha4))
   ezjs_idb
   bonsai

src/haz3lcore/dune

@@ -4,6 +4,8 @@
  (name haz3lcore)
  (libraries util sexplib unionFind uuidm virtual_dom yojson core)
  (js_of_ocaml)
+ (instrumentation
+  (backend bisect_ppx))
  (preprocess
   (pps
    ppx_yojson_conv

src/haz3lweb/dune

@@ -8,6 +8,8 @@
 (library
  (name workerServer)
  (modules WorkerServer)
+ (instrumentation
+  (backend bisect_ppx))
  (libraries
   bonsai
   bonsai.web
@@ -29,6 +31,8 @@
 
 (library
  (name haz3lweb)
+ (instrumentation
+  (backend bisect_ppx))
  (modules
   (:standard \ Main)
   \

src/pretty/dune

@@ -3,6 +3,8 @@
 (library
  (name pretty)
  (libraries util sexplib)
+ (instrumentation
+  (backend bisect_ppx))
  (preprocess
   (pps ppx_let ppx_sexp_conv)))
 

src/util/dune

@@ -2,6 +2,8 @@
  (name util)
  (libraries re base ptmap bonsai bonsai.web virtual_dom yojson)
  (js_of_ocaml)
+ (instrumentation
+  (backend bisect_ppx))
  (preprocess
   (pps
    ppx_yojson_conv

test/dune

@@ -2,7 +2,7 @@
 
 (test
  (name haz3ltest)
- (libraries haz3lcore alcotest junit junit_alcotest)
+ (libraries haz3lcore alcotest junit junit_alcotest bisect_ppx.runtime)
  (modes js)
  (preprocess
-  (pps js_of_ocaml-ppx)))
+  (pps js_of_ocaml-ppx ppx_deriving.show)))

test/haz3ltest.re

@@ -13,3 +13,4 @@ let (suite, _) =
     ],
   );
 Junit.to_file(Junit.make([suite]), "junit_tests.xml");
+Bisect.Runtime.write_coverage_data();