patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

tests/bsim: Add a script to generate coverage reports

Browse source 
For users convenience, as it is a typical usecase to
want to see the actual coverage of a set of tests.

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
This commit is contained in:
Alberto Escolar Piedras 2023-04-21 10:13:33 +02:00 committed by Carles Cufí
parent 4b8574d7b1
commit ad3c3909ae
4 changed files with 68 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/develop/test/bsim.rst
View file

@ -63,7 +63,12 @@ Test coverage and BabbleSim
***************************
As the :ref:`nrf52_bsim<nrf52_bsim>` is based on the POSIX architecture, you can easily collect test
coverage information. See :ref:`the page on coverage generation <coverage_posix>` for more info.
coverage information.
You can use the script :code:`tests/bsim/generate_coverage_report.sh` to generate an html
coverage report from tests.
Check :ref:`the page on coverage generation <coverage_posix>` for more info.
.. _BabbleSim:
https://BabbleSim.github.io

7
tests/bsim/README.md
View file

@ -38,6 +38,13 @@ tests/bsim/net/sockets/echo_test/tests_scripts/echo_test_802154.sh
```
Generating coverage reports
---------------------------
You can use `tests/bsim/generate_coverage_report.sh` to generate a coverage report
of the BabbleSim tests which have been run. Check its help for more info.
Conventions about these tests scripts
-------------------------------------

54
tests/bsim/generate_coverage_report.sh Executable file
View file

@ -0,0 +1,54 @@
#! /usr/bin/env bash
# Copyright 2023 Nordic Semiconductor ASA
# SPDX-License-Identifier: Apache-2.0
set -eu
function display_help(){
echo "\
_generate_coverage_report.sh [-help]
Generate an html coverage report for BabbleSim tests
You can call it from the Zephyr top level as:
tests/bsim/_generate_coverage_report.sh
Coverage files will be searched for in the folder pointed by
the variable WORK_DIR which by default is
${ZEPHYR_BASE}/bsim_out
By default the output will be placed in \${WORK_DIR}/lcov_html/.
You can override this by setting the variable OUTPUT_DIR
By default it takes all coverage information generated by all run tests
but you can limit the search by setting WORK_DIR to some subfolder
You can also merge in the twister coverage report by setting
the variable TWISTER_COVERAGE_FILE, for example as:
TWISTER_COVERAGE_FILE=\${ZEPHYR_BASE}/twister-out/coverage.info
after having run twister, for example as
twister -p nrf52_bsim -T tests/bluetooth/ --coverage
Note: Generating a coverage report for many tests is a lengthy process
"
}
# Parse command line
if [ $# -ge 1 ]; then
if grep -Eiq "(\?|-\?|-h|help|-help|--help)" <<< $1 ; then
display_help
exit 0
fi
fi
WORK_DIR="${WORK_DIR:-${ZEPHYR_BASE}/bsim_out}"
OUTPUT_DIR="${OUTPUT_DIR:-${WORK_DIR}}"
TWISTER_COVERAGE_FILE="${TWISTER_COVERAGE_FILE:-""}"
lcov --capture --directory ${WORK_DIR} --output-file ${OUTPUT_DIR}/coverage.pre.info \
-q --rc lcov_branch_coverage=1
lcov --remove ${OUTPUT_DIR}/coverage.pre.info *generated* \
--output-file ${OUTPUT_DIR}/coverage.info -q --rc lcov_branch_coverage=1
genhtml ${OUTPUT_DIR}/coverage.info ${TWISTER_COVERAGE_FILE} --output-directory \
${OUTPUT_DIR}/lcov_html -q --ignore-errors source --branch-coverage --highlight --legend
echo -e "\033[0;32mGenerated: ${OUTPUT_DIR}/lcov_html/index.html\033[0m"

2
tests/bsim/run_parallel.sh
View file

@ -50,7 +50,7 @@ elif [ -n "${TESTS_LIST}" ]; then
else
SEARCH_PATH="${SEARCH_PATH:-.}"
all_cases=`find ${SEARCH_PATH} -name "*.sh" | \
grep -Ev "(/_|run_parallel|compile.sh)"`
grep -Ev "(/_|run_parallel|compile.sh|generate_coverage_report.sh)"`
#we dont run ourselves
fi