summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJeremy Bettis <jbettis@google.com>2022-09-08 13:00:59 -0600
committerChromeos LUCI <chromeos-scoped@luci-project-accounts.iam.gserviceaccount.com>2022-09-08 21:38:02 +0000
commit789e0883a3f83fc4703fd7c562e8a9bcce90313a (patch)
tree30d98f19353603882186e507a5c4d392e539de8b /docs
parent6ec358cf577437aa1bc1580ef08123056298eb34 (diff)
downloadchrome-ec-789e0883a3f83fc4703fd7c562e8a9bcce90313a.tar.gz
ec: Document how to get coverage report for board
Document the instructions on how to get test coverage for one legacy EC board using eldrid as the sample. BRANCH=None BUG=None TEST=Ran commands (Eldrid is 34%) Signed-off-by: Jeremy Bettis <jbettis@google.com> Change-Id: Id62e3056c58e4c0e7e0008c8b8c3cc78f30e5b39 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3883767 Auto-Submit: Jeremy Bettis <jbettis@chromium.org> Reviewed-by: Keith Short <keithshort@chromium.org> Tested-by: Jeremy Bettis <jbettis@chromium.org> Commit-Queue: Jeremy Bettis <jbettis@chromium.org>
Diffstat (limited to 'docs')
-rw-r--r--docs/code_coverage.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/code_coverage.md b/docs/code_coverage.md
index e6e9b014c2..7f0c544692 100644
--- a/docs/code_coverage.md
+++ b/docs/code_coverage.md
@@ -23,6 +23,29 @@ data into a code coverage report using the `lcov` and `genhtml` tools.
The coverage report top-level page is `build/coverage/coverage_rpt/index.html`.
+To get a report for one specific board's coverage run these commands:
+
+```
+BOARD=eldrid
+make -j$(nproc) build/coverage/initial-${BOARD}.info test-coverage
+# Merge board coverage and test coverage
+lcov -o build/coverage/${BOARD}_merged.info --rc lcov_branch_coverage=1 \
+ -a build/coverage/initial-${BOARD}.info -a build/coverage/lcov.info
+# Filter out some unhelpful paths
+lcov -o build/coverage/${BOARD}_filtered.info --rc lcov_branch_coverage=1 \
+ -r build/coverage/${BOARD}_merged.info ${PWD}'/third_party/**' \
+ ${PWD}'/build/**' '/usr/include/**' '/usr/lib/**' '${PWD}/test/**' \
+ ${PWD}'/private/fingerprint/google-fpalg/mcutest/**'
+# Restrict to only files used by the board
+grep "SF:" "build/coverage/initial-${BOARD}.info" | sort -u | \
+ sed -e 's|^SF:||' | xargs lcov --rc lcov_branch_coverage=1 \
+ -o build/coverage/${BOARD}_final.info \
+ -e build/coverage/${BOARD}_filtered.info
+# Generate HTML
+genhtml --branch-coverage -q -o build/coverage/${BOARD}_rpt \
+ -t "${BOARD} coverage" -s build/coverage/${BOARD}_final.info
+```
+
### Noise in the build output
When building for code coverage, you may see multiple warnings of the form