From 1c95e12b0dd2b4902a289328e8e54fde6eed0623 Mon Sep 17 00:00:00 2001 From: Dave Wallace Date: Wed, 21 Jun 2023 23:14:38 -0400 Subject: 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 Signed-off-by: Dave Wallace --- docs/developer/build-run-debug/code_coverage.rst | 45 ++++++++++++++++++++++++ docs/developer/build-run-debug/index.rst | 1 + 2 files changed, 46 insertions(+) create mode 100644 docs/developer/build-run-debug/code_coverage.rst (limited to 'docs/developer/build-run-debug') 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 -- cgit