Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 1.33 KB

code_coverage.md

File metadata and controls

38 lines (24 loc) · 1.33 KB
Raw

Code Coverage

Linux GCC (gcov)

Prerequisites:

  • Install a gcov report tool, e.g. gcovr: sudo apt install gcovr

First, compile with coverage enabled. For GCC, this means providing -fprofile-arcs -ftest-coverage to both the compiler and linker. In addition, compile with debug information for more accurate results. With CMake, we can do that like so:

cmake . -B build -G Ninja -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_FLAGS="-fprofile-arcs -ftest-coverage" -DCMAKE_C_FLAGS="-fprofile-arcs -ftest-coverage" -DCMAKE_EXE_LINKER_FLAGS="-fprofile-arcs -ftest-coverage"

Then, build:

ninja -C build

NOTE: It is recommended to do a full build. Otherwise, coverage for files not included in the unit tests will be missing. This results in inaccurate reports. We can filter later with gcov to pare down the information in the report.

Next, run the unit tests to determine lines exercised:

ninja -C build run-tests

Finally, run the report. This filters for only BigWheels source files:

cd build
gcovr --gcov-ignore-parse-errors all --html-details coverage.html -f '.*/include/ppx/.*' -f '.*/src/ppx/.*' -j $(nproc) -r ..

Open coverage.html with your browser.

For more information -- including details about how gcov generates and tracks coverage -- read the gcov docs.