Bisect_ppx – OCaml code coverage with nice HTML reports

[antron]

Bisect_ppx is the OCaml code coverage tool. Depend on it like any other PPX, then run your test suite. Each file gets a coverage report:

This gives a pretty decent sense of the gaps in your testing. It’s especially helpful when working with multiple contributors.

For a live example, see the report Bisect_ppx generates for itself.

Usage is pretty simple. There are instructions for ocamlfind, Ocamlbuild, OASIS, and Jbuilder. It basically consists of:

1. making your source files depend on the bisect_ppx package,
2. running your test suite, and
3. passing the resulting raw coverage statistics through Bisect_ppx’s report tool.

ocveralls by Julien Sagot submits Bisect_ppx reports to coveralls.io.

This announcement is prompted by the recent release of Bisect_ppx 1.3.0, which is a good opportunity to introduce the tool to Discourse

Bisect_ppx has actually been out for several years. It is in use by Lwt, ctypes, Oml, and Markup.ml, among other projects. It was originally Bisect, by Xavier Clerc.

Happy testing!

aantron/bisect_ppx

[rgrinberg]

The gif is still using ocamlbuild

[antron]

We’ll be making a new one later You can open an issue

[bluddy]

Any chance of renaming to something like coverage_ppx? Bisect_ppx gave me the completely wrong idea about the project.

[antron]

Yeah, I also found it strange when I first found the project. I don’t know how practical changing the name is at this point, but I opened an issue about it for any discussion.

[rdavison]

Excellent! Thanks Anton! Also, FWIW, I’m also in favor of changing its name to coverage_ppx.

[antron]

@rdavison for the record, Bisect_ppx is currently maintained by myself and Leonid Rozenberg (@leonidr).

[rdavison]

My apologies, thanks for the correction Anton, and thanks to all involved