421 lines
15 KiB
CMake
421 lines
15 KiB
CMake
# Copyright (c) 2012 - 2017, Lars Bilke All rights reserved.
|
|
#
|
|
# Redistribution and use in source and binary forms, with or without
|
|
# modification, are permitted provided that the following conditions are met:
|
|
#
|
|
# 1. Redistributions of source code must retain the above copyright notice, this
|
|
# list of conditions and the following disclaimer.
|
|
#
|
|
# 1. Redistributions in binary form must reproduce the above copyright notice,
|
|
# this list of conditions and the following disclaimer in the documentation
|
|
# and/or other materials provided with the distribution.
|
|
#
|
|
# 1. Neither the name of the copyright holder nor the names of its contributors
|
|
# may be used to endorse or promote products derived from this software
|
|
# without specific prior written permission.
|
|
#
|
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
#
|
|
# CHANGES:
|
|
#
|
|
# 2012-01-31, Lars Bilke - Enable Code Coverage
|
|
#
|
|
# 2013-09-17, Joakim Söderberg - Added support for Clang. - Some additional
|
|
# usage instructions.
|
|
#
|
|
# 2016-02-03, Lars Bilke - Refactored functions to use named parameters
|
|
#
|
|
# 2017-06-02, Lars Bilke - Merged with modified version from github.com/ufz/ogs
|
|
#
|
|
# USAGE:
|
|
#
|
|
# 1. Copy this file into your cmake modules path.
|
|
#
|
|
# 1. Add the following line to your CMakeLists.txt: include(CodeCoverage)
|
|
#
|
|
# 1. Append necessary compiler flags: APPEND_COVERAGE_COMPILER_FLAGS()
|
|
#
|
|
# 1. If you need to exclude additional directories from the report, specify them
|
|
# using the COVERAGE_LCOV_EXCLUDES variable before calling
|
|
# SETUP_TARGET_FOR_COVERAGE_LCOV. Example: set(COVERAGE_LCOV_EXCLUDES 'dir1/*'
|
|
# 'dir2/*')
|
|
#
|
|
# 1. Use the functions described below to create a custom make target which runs
|
|
# your test executable and produces a code coverage report.
|
|
#
|
|
# 1. Build a Debug build: cmake -DCMAKE_BUILD_TYPE=Debug .. make make
|
|
# my_coverage_target
|
|
#
|
|
|
|
include(CMakeParseArguments)
|
|
|
|
# Check prereqs
|
|
find_program(GCOV_PATH
|
|
NAMES ${CMAKE_SOURCE_DIR}/tests/llvm-gcov.sh gcov
|
|
PATHS ENV PATH)
|
|
find_program(LCOV_PATH
|
|
NAMES lcov
|
|
lcov.bat
|
|
lcov.exe
|
|
lcov.perl
|
|
PATHS ENV PATH)
|
|
find_program(LLVM_COV_PATH
|
|
NAMES
|
|
llvm-cov110
|
|
llvm-cov-11
|
|
llvm-cov100
|
|
llvm-cov-10
|
|
llvm-cov90
|
|
llvm-cov-9
|
|
llvm-cov80
|
|
llvm-cov-8
|
|
llvm-cov70
|
|
llvm-cov-7
|
|
llvm-cov
|
|
PATHS ENV PATH)
|
|
find_program(LLVM_PROFDATA_PATH
|
|
NAMES
|
|
llvm-profdata110
|
|
llvm-profdata-11
|
|
llvm-profdata100
|
|
llvm-profdata-10
|
|
llvm-profdata90
|
|
llvm-profdata-9
|
|
llvm-profdata80
|
|
llvm-profdata-8
|
|
llvm-profdata70
|
|
llvm-profdata-7
|
|
llvm-profdata
|
|
PATHS ENV PATH)
|
|
find_program(GENHTML_PATH NAMES genhtml genhtml.perl genhtml.bat)
|
|
find_program(GCOVR_PATH gcovr PATHS ${CMAKE_SOURCE_DIR}/scripts/test)
|
|
find_program(SIMPLE_PYTHON_EXECUTABLE python)
|
|
|
|
if(NOT GCOV_PATH)
|
|
message(FATAL_ERROR "gcov not found! Aborting...")
|
|
endif() # NOT GCOV_PATH
|
|
|
|
if("${CMAKE_CXX_COMPILER_ID}" MATCHES "(Apple)?[Cc]lang")
|
|
if("${CMAKE_CXX_COMPILER_VERSION}" VERSION_LESS 3)
|
|
message(FATAL_ERROR "Clang version must be 3.0.0 or greater! Aborting...")
|
|
endif()
|
|
elseif(NOT CMAKE_COMPILER_IS_GNUCXX)
|
|
message(FATAL_ERROR "Compiler is not GNU gcc! Aborting...")
|
|
endif()
|
|
|
|
set(
|
|
COVERAGE_COMPILER_FLAGS
|
|
-g -O0 -fprofile-arcs -ftest-coverage -fprofile-instr-generate -fcoverage-mapping
|
|
CACHE INTERNAL "")
|
|
|
|
set(CMAKE_CXX_FLAGS_COVERAGE ${COVERAGE_COMPILER_FLAGS}
|
|
CACHE STRING "Flags used by the C++ compiler during coverage builds."
|
|
FORCE)
|
|
set(CMAKE_C_FLAGS_COVERAGE ${COVERAGE_COMPILER_FLAGS}
|
|
CACHE STRING "Flags used by the C compiler during coverage builds."
|
|
FORCE)
|
|
set(CMAKE_EXE_LINKER_FLAGS_COVERAGE ""
|
|
CACHE STRING "Flags used for linking binaries during coverage builds."
|
|
FORCE)
|
|
set(CMAKE_SHARED_LINKER_FLAGS_COVERAGE ""
|
|
CACHE STRING
|
|
"Flags used by the shared libraries linker during coverage builds."
|
|
FORCE)
|
|
mark_as_advanced(CMAKE_CXX_FLAGS_COVERAGE
|
|
CMAKE_C_FLAGS_COVERAGE
|
|
CMAKE_EXE_LINKER_FLAGS_COVERAGE
|
|
CMAKE_SHARED_LINKER_FLAGS_COVERAGE)
|
|
|
|
if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
|
|
message(
|
|
WARNING
|
|
"Code coverage results with an optimised (non-Debug) build may be misleading"
|
|
)
|
|
endif() # NOT CMAKE_BUILD_TYPE STREQUAL "Debug"
|
|
|
|
if(CMAKE_C_COMPILER_ID STREQUAL "GNU")
|
|
link_libraries(gcov)
|
|
else()
|
|
add_link_options($<$<NOT:$<COMPILE_LANG_AND_ID:C,GNU>>:-fprofile-instr-generate>)
|
|
endif()
|
|
|
|
# Defines a target for running and collection code coverage information Builds
|
|
# dependencies, runs the given executable and outputs reports. NOTE! The
|
|
# executable should always have a ZERO as exit code otherwise the coverage
|
|
# generation will not complete.
|
|
#
|
|
# SETUP_TARGET_FOR_COVERAGE_LCOV_HTML( NAME testrunner_coverage # New target
|
|
# name EXECUTABLE testrunner -j ${PROCESSOR_COUNT} # Executable in
|
|
# PROJECT_BINARY_DIR DEPENDENCIES testrunner # Dependencies
|
|
# to build first )
|
|
function(SETUP_TARGET_FOR_COVERAGE_LCOV_HTML)
|
|
|
|
set(options NONE)
|
|
set(oneValueArgs NAME)
|
|
set(multiValueArgs
|
|
EXECUTABLE
|
|
EXECUTABLE_ARGS
|
|
DEPENDENCIES
|
|
LCOV_ARGS
|
|
GENHTML_ARGS)
|
|
cmake_parse_arguments(Coverage
|
|
"${options}"
|
|
"${oneValueArgs}"
|
|
"${multiValueArgs}"
|
|
${ARGN})
|
|
|
|
if(NOT LCOV_PATH)
|
|
message(FATAL_ERROR "lcov not found! Aborting...")
|
|
endif() # NOT LCOV_PATH
|
|
|
|
if(NOT GENHTML_PATH)
|
|
message(FATAL_ERROR "genhtml not found! Aborting...")
|
|
endif() # NOT GENHTML_PATH
|
|
|
|
# Setup target
|
|
add_custom_target(
|
|
${Coverage_NAME}
|
|
# Cleanup lcov
|
|
COMMAND ${LCOV_PATH} ${Coverage_LCOV_ARGS}
|
|
--gcov-tool ${GCOV_PATH} -directory .
|
|
--zerocounters # Create baseline to make sure untouched files show
|
|
# up in the report
|
|
COMMAND ${LCOV_PATH} ${Coverage_LCOV_ARGS}
|
|
--gcov-tool ${GCOV_PATH} -c -i -d . -o ${Coverage_NAME}.base
|
|
# Run tests
|
|
COMMAND ${Coverage_EXECUTABLE} ${Coverage_EXECUTABLE_ARGS}
|
|
# Capturing lcov counters and generating report
|
|
COMMAND ${LCOV_PATH} ${Coverage_LCOV_ARGS}
|
|
--gcov-tool ${GCOV_PATH}
|
|
--directory .
|
|
--capture
|
|
--output-file ${Coverage_NAME}.info
|
|
# add baseline counters
|
|
COMMAND ${LCOV_PATH} ${Coverage_LCOV_ARGS}
|
|
--gcov-tool ${GCOV_PATH} -a ${Coverage_NAME}.base -a
|
|
${Coverage_NAME}.info
|
|
--output-file ${Coverage_NAME}.total
|
|
COMMAND ${LCOV_PATH} ${Coverage_LCOV_ARGS}
|
|
--gcov-tool ${GCOV_PATH}
|
|
--remove ${Coverage_NAME}.total ${COVERAGE_LCOV_EXCLUDES}
|
|
--output-file ${PROJECT_BINARY_DIR}/${Coverage_NAME}.info.cleaned
|
|
# Generate HTML
|
|
COMMAND ${GENHTML_PATH} ${Coverage_GENHTML_ARGS} -o ${Coverage_NAME}
|
|
${PROJECT_BINARY_DIR}/${Coverage_NAME}.info.cleaned
|
|
# Clean up
|
|
COMMAND ${CMAKE_COMMAND} -E remove ${Coverage_NAME}.base
|
|
${Coverage_NAME}.total ${PROJECT_BINARY_DIR}/${Coverage_NAME}.info
|
|
WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
|
|
DEPENDS ${Coverage_DEPENDENCIES}
|
|
COMMENT
|
|
"Resetting code coverage counters to zero.\nProcessing code coverage counters and generating report."
|
|
)
|
|
|
|
# Show where to find the lcov info report
|
|
add_custom_command(
|
|
TARGET ${Coverage_NAME} POST_BUILD
|
|
COMMAND ;
|
|
COMMENT
|
|
"Lcov code coverage info report saved in ${Coverage_NAME}.info.cleaned")
|
|
|
|
# Show info where to find the report
|
|
add_custom_command(
|
|
TARGET ${Coverage_NAME} POST_BUILD
|
|
COMMAND ;
|
|
COMMENT
|
|
"Open ./${Coverage_NAME}/index.html in your browser to view the coverage report."
|
|
)
|
|
|
|
endfunction() # SETUP_TARGET_FOR_COVERAGE_LCOV_HTML
|
|
|
|
# Defines a target for running and collection code coverage information Builds
|
|
# dependencies, runs the given executable and outputs reports. NOTE! The
|
|
# executable should always have a ZERO as exit code otherwise the coverage
|
|
# generation will not complete.
|
|
#
|
|
# SETUP_TARGET_FOR_COVERAGE_LCOV_TXT( NAME testrunner_coverage # New target name
|
|
# EXECUTABLE testrunner -j ${PROCESSOR_COUNT} # Executable in PROJECT_BINARY_DIR
|
|
# DEPENDENCIES testrunner # Dependencies to build first )
|
|
function(SETUP_TARGET_FOR_COVERAGE_LCOV_TXT)
|
|
|
|
set(options NONE)
|
|
set(oneValueArgs NAME)
|
|
set(multiValueArgs
|
|
EXECUTABLE
|
|
EXECUTABLE_ARGS
|
|
DEPENDENCIES
|
|
LCOV_ARGS
|
|
GENHTML_ARGS)
|
|
cmake_parse_arguments(Coverage
|
|
"${options}"
|
|
"${oneValueArgs}"
|
|
"${multiValueArgs}"
|
|
${ARGN})
|
|
|
|
if(NOT LCOV_PATH)
|
|
message(FATAL_ERROR "lcov not found! Aborting...")
|
|
endif() # NOT LCOV_PATH
|
|
|
|
# Setup target
|
|
add_custom_target(
|
|
${Coverage_NAME}
|
|
# Run tests
|
|
COMMAND ${Coverage_EXECUTABLE} ${Coverage_EXECUTABLE_ARGS}
|
|
# Generate coverage.txt for sonar
|
|
COMMAND ${LLVM_PROFDATA_PATH} merge default.profraw -output
|
|
${Coverage_NAME}.profdata
|
|
COMMAND ${LLVM_COV_PATH} show -instr-profile=${Coverage_NAME}.profdata
|
|
${CMAKE_CURRENT_BINARY_DIR}/${Coverage_EXECUTABLE} >
|
|
${Coverage_NAME}.txt
|
|
# Generate HTML
|
|
# Clean up
|
|
COMMAND ${CMAKE_COMMAND} -E remove ${Coverage_NAME}.profdata default.profraw
|
|
WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
|
|
DEPENDS ${Coverage_DEPENDENCIES}
|
|
COMMENT
|
|
"Resetting code coverage counters to zero.\nProcessing code coverage counters and generating report."
|
|
)
|
|
|
|
# Show where to find the lcov info report
|
|
add_custom_command(
|
|
TARGET ${Coverage_NAME} POST_BUILD
|
|
COMMAND ;
|
|
COMMENT "Lcov code coverage info report saved in ${Coverage_NAME}.txt.")
|
|
|
|
endfunction() # SETUP_TARGET_FOR_COVERAGE_LCOV_TXT
|
|
|
|
# Defines a target for running and collection code coverage information Builds
|
|
# dependencies, runs the given executable and outputs reports. NOTE! The
|
|
# executable should always have a ZERO as exit code otherwise the coverage
|
|
# generation will not complete.
|
|
#
|
|
# SETUP_TARGET_FOR_COVERAGE_GCOVR_XML( NAME ctest_coverage #
|
|
# New target name EXECUTABLE ctest -j ${PROCESSOR_COUNT} # Executable in
|
|
# PROJECT_BINARY_DIR DEPENDENCIES executable_target # Dependencies to
|
|
# build first )
|
|
function(SETUP_TARGET_FOR_COVERAGE_GCOVR_XML)
|
|
|
|
set(options NONE)
|
|
set(oneValueArgs NAME)
|
|
set(multiValueArgs EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES)
|
|
cmake_parse_arguments(Coverage
|
|
"${options}"
|
|
"${oneValueArgs}"
|
|
"${multiValueArgs}"
|
|
${ARGN})
|
|
|
|
if(NOT SIMPLE_PYTHON_EXECUTABLE)
|
|
message(FATAL_ERROR "python not found! Aborting...")
|
|
endif() # NOT SIMPLE_PYTHON_EXECUTABLE
|
|
|
|
if(NOT GCOVR_PATH)
|
|
message(FATAL_ERROR "gcovr not found! Aborting...")
|
|
endif() # NOT GCOVR_PATH
|
|
|
|
# Combine excludes to several -e arguments
|
|
set(GCOVR_EXCLUDES "")
|
|
foreach(EXCLUDE ${COVERAGE_GCOVR_EXCLUDES})
|
|
list(APPEND GCOVR_EXCLUDES "-e")
|
|
list(APPEND GCOVR_EXCLUDES "${EXCLUDE}")
|
|
endforeach()
|
|
|
|
add_custom_target(
|
|
${Coverage_NAME}
|
|
# Run tests
|
|
${Coverage_EXECUTABLE} ${Coverage_EXECUTABLE_ARGS}
|
|
# Running gcovr
|
|
COMMAND ${GCOVR_PATH}
|
|
--xml -r ${PROJECT_SOURCE_DIR} ${GCOVR_EXCLUDES}
|
|
--object-directory=${PROJECT_BINARY_DIR} -o ${Coverage_NAME}.xml
|
|
WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
|
|
DEPENDS ${Coverage_DEPENDENCIES}
|
|
COMMENT "Running gcovr to produce Cobertura code coverage report.")
|
|
|
|
# Show info where to find the report
|
|
add_custom_command(
|
|
TARGET ${Coverage_NAME} POST_BUILD
|
|
COMMAND ;
|
|
COMMENT "Cobertura code coverage report saved in ${Coverage_NAME}.xml.")
|
|
|
|
endfunction() # SETUP_TARGET_FOR_COVERAGE_GCOVR_XML
|
|
|
|
# Defines a target for running and collection code coverage information Builds
|
|
# dependencies, runs the given executable and outputs reports. NOTE! The
|
|
# executable should always have a ZERO as exit code otherwise the coverage
|
|
# generation will not complete.
|
|
#
|
|
# SETUP_TARGET_FOR_COVERAGE_GCOVR_HTML( NAME ctest_coverage #
|
|
# New target name EXECUTABLE ctest -j ${PROCESSOR_COUNT} # Executable in
|
|
# PROJECT_BINARY_DIR DEPENDENCIES executable_target # Dependencies to
|
|
# build first )
|
|
function(SETUP_TARGET_FOR_COVERAGE_GCOVR_HTML)
|
|
|
|
set(options NONE)
|
|
set(oneValueArgs NAME)
|
|
set(multiValueArgs EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES)
|
|
cmake_parse_arguments(Coverage
|
|
"${options}"
|
|
"${oneValueArgs}"
|
|
"${multiValueArgs}"
|
|
${ARGN})
|
|
|
|
if(NOT SIMPLE_PYTHON_EXECUTABLE)
|
|
message(FATAL_ERROR "python not found! Aborting...")
|
|
endif() # NOT SIMPLE_PYTHON_EXECUTABLE
|
|
|
|
if(NOT GCOVR_PATH)
|
|
message(FATAL_ERROR "gcovr not found! Aborting...")
|
|
endif() # NOT GCOVR_PATH
|
|
|
|
# Combine excludes to several -e arguments
|
|
set(GCOVR_EXCLUDES "")
|
|
foreach(EXCLUDE ${COVERAGE_GCOVR_EXCLUDES})
|
|
list(APPEND GCOVR_EXCLUDES "-e")
|
|
list(APPEND GCOVR_EXCLUDES "${EXCLUDE}")
|
|
endforeach()
|
|
|
|
add_custom_target(
|
|
${Coverage_NAME}
|
|
# Run tests
|
|
${Coverage_EXECUTABLE} ${Coverage_EXECUTABLE_ARGS}
|
|
# Create folder
|
|
COMMAND ${CMAKE_COMMAND} -E make_directory
|
|
${PROJECT_BINARY_DIR}/${Coverage_NAME}
|
|
# Running gcovr
|
|
COMMAND ${GCOVR_PATH}
|
|
--html
|
|
--html-details -r ${PROJECT_SOURCE_DIR} ${GCOVR_EXCLUDES}
|
|
--object-directory=${PROJECT_BINARY_DIR} -o
|
|
${Coverage_NAME}/index.html
|
|
WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
|
|
DEPENDS ${Coverage_DEPENDENCIES}
|
|
COMMENT "Running gcovr to produce HTML code coverage report.")
|
|
|
|
# Show info where to find the report
|
|
add_custom_command(
|
|
TARGET ${Coverage_NAME} POST_BUILD
|
|
COMMAND ;
|
|
COMMENT
|
|
"Open ${CMAKE_CURRENT_BINARY_DIR}/${Coverage_NAME}/index.html in your browser to view the coverage report."
|
|
)
|
|
|
|
endfunction() # SETUP_TARGET_FOR_COVERAGE_GCOVR_HTML
|
|
|
|
function(APPEND_COVERAGE_COMPILER_FLAGS)
|
|
foreach(_opt ${COVERAGE_COMPILER_FLAGS})
|
|
add_compile_options($<$<COMPILE_LANGUAGE:C>:${_opt}>)
|
|
add_compile_options($<$<COMPILE_LANGUAGE:CXX>:${_opt}>)
|
|
endforeach()
|
|
message(
|
|
STATUS "Appending code coverage compiler flags: ${COVERAGE_COMPILER_FLAGS}")
|
|
endfunction() # APPEND_COVERAGE_COMPILER_FLAGS
|