Coverage
Wallet-core is a stable project, we value stability and safety over new features.
Test coverage is one important facet of assuring code quality, and we are strict about high test coverage.
The
Linux CI CI build (executed on PRs and commits) contains coverage measurement, and summary is available in the build output:Summary coverage rate:
lines......: 94.5% (14576 of 15426 lines)
functions..: 95.0% (2688 of 2830 functions)
Detailed coverage report can be generated locally. It includes file and line-level info on coverage.
Steps:
- Run
tools/generate-fileto make sure new added files are generated - Run
cmakewith-DCODE_COVERAGE=ONto enable coverage measurement
cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DCODE_COVERAGE=ON
- Build tests
make -Cbuild -j12 tests TrezorCryptoTests
- Cleanup any old coverage files, and run unit tests
find . -name "*.gcda" -exec rm {} \;
./build/trezor-crypto/crypto/tests/TrezorCryptoTests
./build/tests/tests tests --gtest_output=xml
- Generate coverage info (slow). With the
htmlargument the script will generate HTML report as well:
./tools/coverage html
if you see genhtml (from lcov) error on macOS like below:
c++filt: Unknown command line argument '--no-strip-underscores'. Try: '/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/c++filt --help'
c++filt: Did you mean '--no-strip-underscore'?
genhtml: ERROR: c++filt output not as expected (0 vs 11) lines
please upgrade
lcov to min. 1.16, or patch genhtml (for example /usr/local/Cellar/lcov/1.15/libexec/bin/), change --no-strip-underscores to --no-strip-underscoreOpen the generated
coverage/index.html to view the report.Last modified 1mo ago