Bisect_ppx 2.6.0: code coverage analysis

[aantron]

Changelog:

Changes

• Port to ppxlib (Port the ppx from omp to ppxlib aantron/bisect_ppx#327, Sonja Heinze).
• CSS: use ligature fonts, if installed (Add Fira Code to the font stack in the report CSS aantron/bisect_ppx#339).
• Internal: switch to Dune cram tests, finding lots of bugs in the process (aantron/bisect_ppx@beb80b3, aantron/bisect_ppx@593a7c2, Replace remaining OUnit tests by cram tests aantron/bisect_ppx#352).

Bugs fixed

• Workaround for typing issue with instrumentation of or-patterns under GADTs; includes a new match instrumenter (Typechecking issue with GADTs under or-patterns aantron/bisect_ppx#325, reported by Mehdi Bouaziz).
• The second subexpression of (||) and (&&) is in tail position iff the whole expression is in tail position; Bisect was unconditionally wrapping the second expression in successor code (Instrumentation breaks tail recursivity aantron/bisect_ppx#359, reported by Benjamin Monate).
• HTML: words that have an instrumentation point on one of their characters were not searchable (HTML report: words that have a point on them are not searchable (Chromium) aantron/bisect_ppx#346).
• Don't clobber the global random number generator (Bisect's runtime seeds the global random number generator aantron/bisect_ppx#344).
• (or) nested inside (||) not properly instrumented (Associative instrumentation of logical or is not triggered if the nested operator is (or) aantron/bisect_ppx#347).
• Subexpressions of Pexp_newtype were always treated as if they were in tail position (Pexp_newtype's subexpression is not necessarily in tail position aantron/bisect_ppx#348).
• assert instrumentation was placed at the wrong point in the generated code (Review Pexp_assert instrumentation; ~at_end: should probably be ~post: aantron/bisect_ppx#349).
• assert false should not be instrumented; the point is unreachable (Don't instrument out-edge of assert false aantron/bisect_ppx#355).
• Instrumentation of or-patterns inside local open patterns could trigger unused open warning (Unused open warning with exception pattern aantron/bisect_ppx#350).

Removed

These removals were planned and announced in the 2.0.0 release.

• PPX option --mode (Remove deprecated command-line arguments aantron/bisect_ppx#200).
• PPX option --no-comment-parsing (Remove support for BISECT-IGNORE comments aantron/bisect_ppx#202).
• PPX option --exclude (Remove (deprecate) PPX --exclude option aantron/bisect_ppx#244).
• PPX option --exclude-file, which has been renamed to --exclusions (Rename --exclude-file to --exclusions aantron/bisect_ppx#245).
• Reporter options --html, --text, --coveralls, which have been replaced by html, summary, send-to subcommands, respectively (Remove single-dashed options, then use cmdliner aantron/bisect_ppx#145).
• Support for discovering .out files. Bisect switched to extension .coverage in 2.0.0 (Suggestion: change extension of .out files aantron/bisect_ppx#110).
• --dump, --csv, and the old-style text report (Remove deprecated features aantron/bisect_ppx#251).
• The old command line, including single-dashed (-) multi-character options, and usage of bisect-ppx-report without a subcommand (such as bisect-ppx-report html) (Remove single-dashed options, then use cmdliner aantron/bisect_ppx#145).

[camelus]

Commit: d880486

A pull request by opam-seasoned @aantron.

🌤️ opam-lint warnings d880486

• cuid.0.1 has some warnings:

  • warning 47: Synopsis (or description first line) should start with a capital and not end with a dot

• These packages passed lint tests: bisect_ppx.2.6.0, cuid.0.2, eigen.0.3.0, exit.0.0.1, gobba.0.4.1, gobba.0.4.2, hc.0.0.1, memo.0.0.1, omg.0.0.1, opazl.0.0.1, owl.1.0.0, partition_map.0.9.0, reed-solomon-erasure.1.0.1, reed-solomon-erasure.1.0.2, so.0.0.1

---

☀️ Installability check (+1)

• new installable packages (1): bisect_ppx.2.6.0

[mseri]

There are some failures due to

# .ppx/47e007fefa63695257b4d9874e3138b7/ppx.exe: unknown option '-conditional'.

This used to be a flag for bisect_ppx, right? Can you have a look?

[aantron]

Thanks for the notice, @mseri. I've added constraints.

The -conditional flag was deprecated in 2.0.0 in March 2020, in favor of --conditional. Adding that extra leading dash is probably the quickest way to fix each repo.

However, --conditional itself has been replaced by a better Dune integration, available since Dune 2.7.0. See the new instructions. The new integration makes it easy to turn Bisect into a proper dev dependency, so that downstream users do not depend on Bisect.

I'm ccing the maintainers of the affected packages:

• @marcoonroad — cuid
• @zapashcanon — exit, hc, memo, omg, opazl, so
• @0x0f0f0f — gobba
• @darrenldl — reed-solomon-erasure

For packages that had older releases, I checked the repos for whether they use -conditional at the appropriate tags, and constrained those releases accordingly.

[kit-ty-kate]

Looks alright now. Thanks a lot!