diff options
| author |   Dave Wallace <dwallacelf@gmail.com> | 2023-06-21 23:14:38 -0400 |
|---|---|---|
| committer |   Andrew Yourtchenko <ayourtch@gmail.com> | 2023-06-22 13:35:28 +0000 |
| commit | 1c95e12b0dd2b4902a289328e8e54fde6eed0623 (patch) | |
| tree | da7dd11cd7fc638f1189238bf2180aa6ce3f987a /docs | |
| parent | fdf6fbe2e771d88beddb6ca8d8bbd39599beeb9c (diff) | |
tests docs: fix lcov code coverage report generation
- Updated/rebased version of https://gerrit.fd.io/r/c/vpp/+/34199
Type: test
Change-Id: I43913ecfd11a4578bdb10c4be76253fe38d57976
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/developer/build-run-debug/code_coverage.rst | 45 | ||||
| -rw-r--r-- | docs/developer/build-run-debug/index.rst | 1 | ||||
| -rw-r--r-- | docs/developer/extras/index.rst | 1 | ||||
| l--------- | docs/developer/extras/lcov.rst | 1 | ||||
| -rw-r--r-- | docs/spelling_wordlist.txt | 1 |
5 files changed, 46 insertions, 3 deletions
diff --git a/docs/developer/build-run-debug/code_coverage.rst b/docs/developer/build-run-debug/code_coverage.rst new file mode 100644 index 00000000000..efe750cda21 --- /dev/null +++ b/docs/developer/build-run-debug/code_coverage.rst @@ -0,0 +1,45 @@ +.. _lcov_code_coverage: + +Code coverage with lcov +======================= + +Prerequisites +------------- + +Ensure required packages are installed: + +:: + + $ make install-deps + +The Linux gcov and lcov tools can be fussy about gcc / g++ compiler +versions. As of this writing, Ubuntu 22.04 gcov / lcov works with +the latest gcc version (``11.3.0``). + +Generate coverage for a test case +--------------------------------- + +As a first run, in order to generate the coverage report of +a specific plugin or test, run for example + +:: + + $ make test-cov TEST=fib + +Then open the file ``.build-root/test-coverage/html/index.html`` in a Chrome browser. + +Improving test coverage +----------------------- + +When doing modifications on the test cases, you can run + +:: + + # This will run the test & report the result in the coverage data + $ make test-cov-build TEST=fib + + # This will generate the html report with the current coverage data + $ make test-cov-post + + # To reset the coverage data use + $ make test-cov-prep diff --git a/docs/developer/build-run-debug/index.rst b/docs/developer/build-run-debug/index.rst index f8bfeab0bf8..c99615ffcf5 100644 --- a/docs/developer/build-run-debug/index.rst +++ b/docs/developer/build-run-debug/index.rst @@ -12,3 +12,4 @@ Build, Run & Debug testing_vpp gdb_examples cross_compile_macos + code_coverage diff --git a/docs/developer/extras/index.rst b/docs/developer/extras/index.rst index a0f2d9b876a..2ee96be768e 100644 --- a/docs/developer/extras/index.rst +++ b/docs/developer/extras/index.rst @@ -7,7 +7,6 @@ VPP extra tools .. toctree:: :maxdepth: 2 - lcov snap strongswan vpp_config diff --git a/docs/developer/extras/lcov.rst b/docs/developer/extras/lcov.rst deleted file mode 120000 index 9f8de245ea6..00000000000 --- a/docs/developer/extras/lcov.rst +++ /dev/null @@ -1 +0,0 @@ -../../../extras/lcov/README.rst
\ No newline at end of file diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index 80db33a354e..d28c6df56ca 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -397,7 +397,6 @@ Gerrit gethostbyname gettingsources gettingstarted -ggcov gid Gigabit GigE |