Skip to content

coverage.md

Latest commit

 

History

History
58 lines (38 loc) · 2.32 KB

coverage.md

File metadata and controls

58 lines (38 loc) · 2.32 KB
Raw

Test coverage

Line-level C++ coverage reports for bro and every sibling library, via OpenCppCoverage. Windows / MSVC only.

One-time setup

winget install OpenCppCoverage.OpenCppCoverage

Installs to C:\Program Files\OpenCppCoverage\OpenCppCoverage.exe, which the scripts pick up.

The Debug build needs PDBs to be present; cmake -B build with the default Visual Studio generator emits them. For bromesh specifically, tests run in Release (Debug meshoptimizer asserts hang on a modal abort dialog); see notes in its scripts/coverage.ps1.

Generating a report

Each repo has its own scripts/coverage.ps1. From the repo root:

pwsh scripts/coverage.ps1

HTML report lands at build/coverage/index.html. Open it; per-file pages live under build/coverage/Modules/. Green = covered, red = uncovered.

bro's script accepts a filter:

pwsh scripts/coverage.ps1 -Filter dom        # only tests whose path contains "dom"
pwsh scripts/coverage.ps1 -Output build/cov  # custom output dir

How it works

OpenCppCoverage attaches to a running process via PDB symbols, so no recompile is needed. The pattern across all repos:

OpenCppCoverage.exe `
  --sources <repo>\src `
  --modules <exe-substring> `
  --cover_children `
  --export_type "html:build\coverage" `
  -- <parent program that drives the tests>

--cover_children means OCC instruments every child process the parent spawns. For bro that's bro-headless.exe running JS tests; for the sibling libraries it's the native test exes invoked by ctest.

Repo Driver under --cover_children
bro scripts/_coverage_run_all.ps1 loops over tests/**/test_*.js through bro-headless.exe
qjsbind, brokit, htmlayout the single test exe directly (no ctest registration)
broaudio, brogameagent ctest --test-dir build runs every registered test exe
bromesh bromesh_test.exe directly, Release config

Bro-specific quirk

bro has no native C++ unit tests; its tests are all JS-driven through bro-headless. So bro's coverage measures engine code exercised by the JS test suite. Uncovered C++ usually means "no JS test reaches this path," not "no test file exists." Adding coverage in bro means writing new headless JS tests under tests/, not C++ test exes.