incubator-nuttx/tools/gcov.sh

96 lines
2.7 KiB
Bash
Executable File

#!/usr/bin/env bash
# tools/gcov.sh
#
# SPDX-License-Identifier: Apache-2.0
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to you under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
ROOT_DIR=$(cd $(dirname $0)/../../; pwd)
show_help() {
echo "Usage: $0 [-d gcov_dir] [-t gcov_tool]"
echo " -d gcov_dir: directory to store gcov data and report"
echo " -t gcov_tool: path to gcov tool, e.g. ./nuttx/tools/gcov.sh -t arm-none-eabi-gcov"
exit 1
}
while getopts "d:t:h" opt
do
case $opt in
d)
GCOV_DIR=$OPTARG
;;
t)
GCOV_TOOL="--gcov-tool $OPTARG"
;;
h)
show_help
;;
?)
show_help
;;
esac
done
if [ $# == 1 ]; then
GCOV_DIR=$1
else
GCOV_DIR=${ROOT_DIR}/gcov
fi
if [ -z "$GCOV_TOOL" ]; then
echo "Error: -t is a required option."
show_help
exit 1
fi
type lcov > /dev/null 2>&1
if [ $? -ne 0 ]; then
echo "Code coverage generation tool is not detected, please install lcov"
exit 1
fi
mkdir -p ${GCOV_DIR} ${GCOV_DIR}/data
cd ${GCOV_DIR}
# Collect gcda/gcno files
find ${ROOT_DIR}/ -name "*.gcno" -exec cp {} ${GCOV_DIR}/data > /dev/null 2>&1 \;
find ${ROOT_DIR}/ -name "*.gcda" -exec cp {} ${GCOV_DIR}/data > /dev/null 2>&1 \;
files=$(find ${GCOV_DIR}/data -name "*.gcda" 2> /dev/null | wc -l)
if [ "$files" == "0" ] ;then
echo "gcda file not found in directory ${ROOT_DIR}"
echo "Please run ./nuttx before using gcov.sh to generate the coverage report"
echo "Or copy the gcda file in the device to ${ROOT_DIR}"
exit 1
fi
# Generate coverage text report
lcov -c -d ${GCOV_DIR}/data -o coverage.info --rc lcov_branch_coverage=1 ${GCOV_TOOL} --ignore-errors gcov
# Generate coverage page report
genhtml --branch-coverage -o result coverage.info --ignore-errors source
if [ $? -ne 0 ]; then
echo "Failed to generate coverage file"
exit 1
fi
echo -e "Copy the following link and open it in the browser to view the coverage report"
echo "file://${GCOV_DIR}/result/index.html"