Open
Conversation
Add support for LLVM source-based code coverage instrumentation, enabling developers and CI to generate coverage reports for the Core Lightning codebase. Build System: - Add coverage-clang-collect and coverage-clang-report Makefile targets - Fix missing endif for PYTEST_TESTS conditional - Respect CARGO_TARGET_DIR environment variable for Rust builds Coverage Scripts (contrib/coverage/): - collect-coverage.sh: Merges .profraw files with validation and batching - generate-coverage-report.sh: Generates HTML reports using llvm-cov CI Workflow: - coverage.yaml: Daily workflow for building, testing, and publishing reports Usage: ./configure --enable-coverage CC=clang make -j$(nproc) CLN_COVERAGE_DIR=/tmp/cln-coverage make pytest make coverage-clang Changelog-Changed: Added LLVM source-based code coverage support with CI integration
cdecker
force-pushed
the
20240102-coverage
branch
from
54dea46 to
4a85b8b
Compare
Member
Author
|
@rustyrussell sorry for forgetting the script files in the coverage PR. It was being covered by |
rustyrussell
approved these changes
Feb 27, 2026
| make distclean coverage-clean | ||
| ./configure --enable-coverage --disable-valgrind CC=clang | ||
| make -j $(nproc) | ||
| PYTEST_PAR=$(nproc) make pytest || true |
Contributor
There was a problem hiding this comment.
Should we do unit tests too? Some of this stuff (like block parsing) is best done as a unit test?
Comment on lines
+32
to
+33
| - name: Rebase locally | ||
| run: git rebase master 20240102-coverage |
Contributor
There was a problem hiding this comment.
huh? I don't think this is needed once we merge?
|
|
||
| - name: Generate coverage report | ||
| run: | | ||
| make distclean coverage-clean |
Contributor
There was a problem hiding this comment.
This should be unnecessary...
Comment on lines
+46
to
+47
| mv coverage/html site/coverage | ||
|
|
|
|
||
| [sbcc]: https://clang.llvm.org/docs/SourceBasedCodeCoverage.html | ||
| [pcca]: https://github.com/ElementsProject/lightning/tree/master/contrib/prepare-code-coverage-artifact.py | ||
| [report]: https://cdecker.github.io/lightning/coverage |
Contributor
There was a problem hiding this comment.
Huh, will it appear there or will it appear on the ElementProject pages?
| @@ -0,0 +1,30 @@ | |||
| # Test Coverage | |||
|
|
|||
| > Coverage isn't everything, but it can tell you were you missed a thing. | |||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add support for LLVM source-based code coverage instrumentation, enabling developers and CI to generate coverage reports for the Core Lightning codebase.
Changes
Build System
coverage-clang-collectandcoverage-clang-reporttargets for collecting and generating coverage reportsendifforPYTEST_TESTSconditionalCARGO_TARGET_DIRenvironment variable for Rust buildsCoverage Scripts (
contrib/coverage/).profrawfiles into a single.profdatafile with validation, parallel processing, and batch handling for large file countsllvm-cov showfor all instrumented binariesCI Workflow
Usage
Notes
-fprofile-instr-generate -fcoverage-mapping).profrawfiles