diff options
author | Paul Fagerburg <pfagerburg@google.com> | 2020-05-19 16:25:06 -0600 |
---|---|---|
committer | Commit Bot <commit-bot@chromium.org> | 2020-05-20 16:44:15 +0000 |
commit | 192f1de90e1e6d97f24dd56b361ba9ddc3e110c2 (patch) | |
tree | d5b0385e063ee21e8ffdbf6949c3bb6f12b60008 /docs | |
parent | 75ce8415401cd3ec726b46df71b9a9caacf2181a (diff) | |
download | chrome-ec-192f1de90e1e6d97f24dd56b361ba9ddc3e110c2.tar.gz |
docs: add howto for code coverage
Add documentation for how to build the unit tests for code coverage.
BUG=b:156553508
BRANCH=none
TEST=renders in gerrit
Signed-off-by: Paul Fagerburg <pfagerburg@chromium.org>
Change-Id: Iaf7a4e231f6817f51848af101dac6c73afe3f59a
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2209427
Reviewed-by: Jack Rosenthal <jrosenth@chromium.org>
Reviewed-by: Jett Rink <jettrink@chromium.org>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/code_coverage.md | 53 | ||||
-rw-r--r-- | docs/sitemap.md | 1 |
2 files changed, 54 insertions, 0 deletions
diff --git a/docs/code_coverage.md b/docs/code_coverage.md new file mode 100644 index 0000000000..92f091e52d --- /dev/null +++ b/docs/code_coverage.md @@ -0,0 +1,53 @@ +# Code Coverage + +Provides an overview of how to use code coverage tools when running the unit +tests in the EC codebase. + +[TOC] + +## Availability + +Code coverage is only available for host-based unit tests, as opposed to +manual tests that run on target hardware. + +## Building for code coverage + +To build host-based unit tests for code coverage, invoke `make` with the +`coverage` target, as follows: + +`make coverage -j` + +This target will compile and link the unit tests with `--coverage` flag (which +pulls in the `gcov` libraries), run the tests, and then process the profiling +data into a code coverage report using the `lcov` and `genhtml` tools. + +The coverage report top-level page is `build/host/coverage_rpt/index.html`. + +### `make clobber` is required + +**Always** `make clobber` when switching from building with code coverage +to building without code coverage, or from building without code coverage +to building with code coverage. `make clean` is not sufficient. + +`make buildall -j ; make clobber ; make coverage -j` + +`make coverage -j ; make clobber ; make buildall -j` + +If you do not `make clobber`, you will get link-time errors such as: + +``` +core/host/task.c:558: undefined reference to `__gcov_init' +build/host/online_calibration/RO/core/host/timer.o:(.data+0x5b0): undefined reference to `__gcov_merge_add' +``` + +Note that `make clobber` will delete the coverage report. + +### Noise in the build output + +When building for code coverage, you may see multiple warnings of the form +`geninfo: WARNING: no data found for /mnt/host/source/src/platform/ec/core/host/cpu.h` +and +`genhtml: WARNING: function data mismatch at /mnt/host/source/src/platform/ec/common/math_util.c:134` + +These warnings can be ignored. (FYI, the "function data mismatch" warnings +appear to be caused in part by using relative paths instead of absolute paths.) diff --git a/docs/sitemap.md b/docs/sitemap.md index 850c531285..82e5914a0f 100644 --- a/docs/sitemap.md +++ b/docs/sitemap.md @@ -29,6 +29,7 @@ ## Testing * [Unit Tests](./unit_tests.md) +* [Code Coverage](./code_coverage.md) ## Updaters |