I have heard writing tests is a good starting point for contributing to Bitcoin Core. How do I work out which parts or specific lines of the codebase need additional test coverage?
asked Sep 25, 2020 at 23:08
Add a comment
|
2 Answers
Marco Falke has a site that analyzes the current line, function and branch coverage for unit tests, functional tests and fuzz tests.
Alternatively, vasild runs clang's tools and then a script to highlight which lines in the coverage report have been modified by a particular patch (PR).
answered Sep 25, 2020 at 23:08
-
1The link to MarcoFalke's website is dead, marcofalke.github.io/b-c-cov seems to be the new one. Commented Jul 14, 2023 at 11:22
-
If your intention is to contribute to Bitcoin Core, you must be able to build these reports locally. So that you can compare if your changes have been effective at increasing coverage.
The general steps are:
- Download the code and compile it
- Install LCOV for report generation
- Configure bitcoin to enable line coverage, ie
--enable-lcov - Execute the coverage task, ie
make cov
Once you have the dev environment correctly setup, the commands are:
./configure --enable-lcov
make cov
The official docs are located here: developer-notes.md#compiling-for-test-coverage
-
3Here's a guide I wrote: givan.se/generate-bitcoin-line-coverage-reports– givanseCommented Feb 27, 2022 at 2:31