|
|
|
|
@@ -1,4 +1,4 @@
|
|
|
|
|
# Copyright (c) 2012 - 2015, Lars Bilke
|
|
|
|
|
# Copyright (c) 2012 - 2017, Lars Bilke
|
|
|
|
|
# All rights reserved.
|
|
|
|
|
#
|
|
|
|
|
# Redistribution and use in source and binary forms, with or without modification,
|
|
|
|
|
@@ -26,7 +26,7 @@
|
|
|
|
|
# (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
|
|
|
|
|
@@ -35,167 +35,269 @@
|
|
|
|
|
# - 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:
|
|
|
|
|
|
|
|
|
|
# 0. (Mac only) If you use Xcode 5.1 make sure to patch geninfo as described here:
|
|
|
|
|
# http://stackoverflow.com/a/22404544/80480
|
|
|
|
|
#
|
|
|
|
|
# 1. Copy this file into your cmake modules path.
|
|
|
|
|
#
|
|
|
|
|
# 2. Add the following line to your CMakeLists.txt:
|
|
|
|
|
# INCLUDE(CodeCoverage)
|
|
|
|
|
# include(CodeCoverage)
|
|
|
|
|
#
|
|
|
|
|
# 3. Set compiler flags to turn off optimization and enable coverage:
|
|
|
|
|
# SET(CMAKE_CXX_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage")
|
|
|
|
|
# SET(CMAKE_C_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage")
|
|
|
|
|
# 3. Append necessary compiler flags:
|
|
|
|
|
# APPEND_COVERAGE_COMPILER_FLAGS()
|
|
|
|
|
#
|
|
|
|
|
# 3. Use the function SETUP_TARGET_FOR_COVERAGE to create a custom make target
|
|
|
|
|
# which runs your test executable and produces a lcov code coverage report:
|
|
|
|
|
# 4. 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:
|
|
|
|
|
# SETUP_TARGET_FOR_COVERAGE(
|
|
|
|
|
# my_coverage_target # Name for custom target.
|
|
|
|
|
# test_driver # Name of the test driver executable that runs the tests.
|
|
|
|
|
# # NOTE! This should always have a ZERO as exit code
|
|
|
|
|
# # otherwise the coverage generation will not complete.
|
|
|
|
|
# coverage # Name of output directory.
|
|
|
|
|
# )
|
|
|
|
|
# set(COVERAGE_LCOV_EXCLUDES 'dir1/*' 'dir2/*')
|
|
|
|
|
#
|
|
|
|
|
# 4. Build a Debug build:
|
|
|
|
|
# cmake -DCMAKE_BUILD_TYPE=Debug ..
|
|
|
|
|
# make
|
|
|
|
|
# make my_coverage_target
|
|
|
|
|
# 5. Use the functions described below to create a custom make target which
|
|
|
|
|
# runs your test executable and produces a code coverage report.
|
|
|
|
|
#
|
|
|
|
|
# 6. Build a Debug build:
|
|
|
|
|
# cmake -DCMAKE_BUILD_TYPE=Debug ..
|
|
|
|
|
# make
|
|
|
|
|
# make my_coverage_target
|
|
|
|
|
#
|
|
|
|
|
|
|
|
|
|
include(CMakeParseArguments)
|
|
|
|
|
|
|
|
|
|
# Check prereqs
|
|
|
|
|
FIND_PROGRAM( GCOV_PATH gcov )
|
|
|
|
|
FIND_PROGRAM( LCOV_PATH lcov )
|
|
|
|
|
FIND_PROGRAM( GENHTML_PATH genhtml )
|
|
|
|
|
FIND_PROGRAM( GCOVR_PATH gcovr PATHS ${CMAKE_SOURCE_DIR}/tests)
|
|
|
|
|
find_program( GCOV_PATH gcov )
|
|
|
|
|
find_program( LCOV_PATH NAMES lcov lcov.bat lcov.exe lcov.perl)
|
|
|
|
|
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(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() # CHECK VALID COMPILER
|
|
|
|
|
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(CMAKE_CXX_FLAGS_COVERAGE
|
|
|
|
|
"-g -O0 --coverage -fprofile-arcs -ftest-coverage"
|
|
|
|
|
set(COVERAGE_COMPILER_FLAGS "-g -O0 --coverage -fprofile-arcs -ftest-coverage"
|
|
|
|
|
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
|
|
|
|
|
"-g -O0 --coverage -fprofile-arcs -ftest-coverage"
|
|
|
|
|
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
|
|
|
|
|
set(CMAKE_EXE_LINKER_FLAGS_COVERAGE
|
|
|
|
|
""
|
|
|
|
|
CACHE STRING "Flags used for linking binaries during coverage builds."
|
|
|
|
|
FORCE )
|
|
|
|
|
SET(CMAKE_SHARED_LINKER_FLAGS_COVERAGE
|
|
|
|
|
set(CMAKE_SHARED_LINKER_FLAGS_COVERAGE
|
|
|
|
|
""
|
|
|
|
|
CACHE STRING "Flags used by the shared libraries linker during coverage builds."
|
|
|
|
|
FORCE )
|
|
|
|
|
MARK_AS_ADVANCED(
|
|
|
|
|
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" OR CMAKE_BUILD_TYPE STREQUAL "Coverage"))
|
|
|
|
|
MESSAGE( WARNING "Code coverage results with an optimized (non-Debug) build may be misleading" )
|
|
|
|
|
ENDIF() # NOT CMAKE_BUILD_TYPE STREQUAL "Debug"
|
|
|
|
|
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()
|
|
|
|
|
set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --coverage")
|
|
|
|
|
endif()
|
|
|
|
|
|
|
|
|
|
# Param _targetname The name of new the custom make target
|
|
|
|
|
# Param _testrunner The name of the target which runs the tests.
|
|
|
|
|
# MUST return ZERO always, even on errors.
|
|
|
|
|
# If not, no coverage report will be created!
|
|
|
|
|
# Param _outputname lcov output is generated as _outputname.info
|
|
|
|
|
# HTML report is generated in _outputname/index.html
|
|
|
|
|
# Optional fourth parameter is passed as arguments to _testrunner
|
|
|
|
|
# Pass them in list form, e.g.: "-j;2" for -j 2
|
|
|
|
|
FUNCTION(SETUP_TARGET_FOR_COVERAGE _targetname _testrunner _outputname)
|
|
|
|
|
# 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(
|
|
|
|
|
# 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)
|
|
|
|
|
|
|
|
|
|
IF(NOT LCOV_PATH)
|
|
|
|
|
MESSAGE(FATAL_ERROR "lcov not found! Aborting...")
|
|
|
|
|
ENDIF() # NOT LCOV_PATH
|
|
|
|
|
set(options NONE)
|
|
|
|
|
set(oneValueArgs NAME)
|
|
|
|
|
set(multiValueArgs EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES)
|
|
|
|
|
cmake_parse_arguments(Coverage "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
|
|
|
|
|
|
|
|
|
|
IF(NOT GENHTML_PATH)
|
|
|
|
|
MESSAGE(FATAL_ERROR "genhtml not found! Aborting...")
|
|
|
|
|
ENDIF() # NOT GENHTML_PATH
|
|
|
|
|
if(NOT LCOV_PATH)
|
|
|
|
|
message(FATAL_ERROR "lcov not found! Aborting...")
|
|
|
|
|
endif() # NOT LCOV_PATH
|
|
|
|
|
|
|
|
|
|
SET(coverage_info "${CMAKE_BINARY_DIR}/${_outputname}.info")
|
|
|
|
|
IF(MINGW)
|
|
|
|
|
# Replace C:/ with /C for MINGW
|
|
|
|
|
STRING(REGEX REPLACE "^([a-zA-Z]):" "/\\1" coverage_info ${coverage_info})
|
|
|
|
|
ENDIF()
|
|
|
|
|
SET(coverage_cleaned "${coverage_info}.cleaned")
|
|
|
|
|
if(NOT GENHTML_PATH)
|
|
|
|
|
message(FATAL_ERROR "genhtml not found! Aborting...")
|
|
|
|
|
endif() # NOT GENHTML_PATH
|
|
|
|
|
|
|
|
|
|
SEPARATE_ARGUMENTS(test_command UNIX_COMMAND "${_testrunner}")
|
|
|
|
|
# Setup target
|
|
|
|
|
add_custom_target(${Coverage_NAME}
|
|
|
|
|
|
|
|
|
|
# Setup target
|
|
|
|
|
ADD_CUSTOM_TARGET(${_targetname}
|
|
|
|
|
# Cleanup lcov
|
|
|
|
|
COMMAND ${LCOV_PATH} --gcov-tool ${GCOV_PATH} -directory . --zerocounters
|
|
|
|
|
# Create baseline to make sure untouched files show up in the report
|
|
|
|
|
COMMAND ${LCOV_PATH} --gcov-tool ${GCOV_PATH} -c -i -d . -o ${Coverage_NAME}.base
|
|
|
|
|
|
|
|
|
|
# Cleanup lcov
|
|
|
|
|
${LCOV_PATH} --directory . --zerocounters
|
|
|
|
|
# Run tests
|
|
|
|
|
COMMAND ${Coverage_EXECUTABLE}
|
|
|
|
|
|
|
|
|
|
# Run tests
|
|
|
|
|
COMMAND ${test_command} ${ARGV3}
|
|
|
|
|
# Capturing lcov counters and generating report
|
|
|
|
|
COMMAND ${LCOV_PATH} --gcov-tool ${GCOV_PATH} --directory . --capture --output-file ${Coverage_NAME}.info
|
|
|
|
|
# add baseline counters
|
|
|
|
|
COMMAND ${LCOV_PATH} --gcov-tool ${GCOV_PATH} -a ${Coverage_NAME}.base -a ${Coverage_NAME}.info --output-file ${Coverage_NAME}.total
|
|
|
|
|
COMMAND ${LCOV_PATH} --gcov-tool ${GCOV_PATH} --remove ${Coverage_NAME}.total ${COVERAGE_LCOV_EXCLUDES} --output-file ${PROJECT_BINARY_DIR}/${Coverage_NAME}.info.cleaned
|
|
|
|
|
COMMAND ${GENHTML_PATH} -o ${Coverage_NAME} ${PROJECT_BINARY_DIR}/${Coverage_NAME}.info.cleaned
|
|
|
|
|
COMMAND ${CMAKE_COMMAND} -E remove ${Coverage_NAME}.base ${Coverage_NAME}.total ${PROJECT_BINARY_DIR}/${Coverage_NAME}.info.cleaned
|
|
|
|
|
|
|
|
|
|
# Capturing lcov counters and generating report
|
|
|
|
|
COMMAND ${LCOV_PATH} --directory . --capture --output-file ${coverage_info}
|
|
|
|
|
COMMAND ${LCOV_PATH} --remove ${coverage_info} 'tests/*' '/usr/*' --output-file ${coverage_cleaned}
|
|
|
|
|
COMMAND ${GENHTML_PATH} -o ${_outputname} ${coverage_cleaned}
|
|
|
|
|
COMMAND ${CMAKE_COMMAND} -E remove ${coverage_info} ${coverage_cleaned}
|
|
|
|
|
WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
|
|
|
|
|
DEPENDS ${Coverage_DEPENDENCIES}
|
|
|
|
|
COMMENT "Resetting code coverage counters to zero.\nProcessing code coverage counters and generating report."
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
|
|
|
|
|
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."
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
# Show info where to find the report
|
|
|
|
|
ADD_CUSTOM_COMMAND(TARGET ${_targetname} POST_BUILD
|
|
|
|
|
COMMAND ;
|
|
|
|
|
COMMENT "Open ./${_outputname}/index.html in your browser to view the coverage report."
|
|
|
|
|
)
|
|
|
|
|
# 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
|
|
|
|
|
endfunction() # SETUP_TARGET_FOR_COVERAGE_LCOV
|
|
|
|
|
|
|
|
|
|
# Param _targetname The name of new the custom make target
|
|
|
|
|
# Param _testrunner The name of the target which runs the tests
|
|
|
|
|
# Param _outputname cobertura output is generated as _outputname.xml
|
|
|
|
|
# Optional fourth parameter is passed as arguments to _testrunner
|
|
|
|
|
# Pass them in list form, e.g.: "-j;2" for -j 2
|
|
|
|
|
FUNCTION(SETUP_TARGET_FOR_COVERAGE_COBERTURA _targetname _testrunner _outputname)
|
|
|
|
|
# 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)
|
|
|
|
|
|
|
|
|
|
IF(NOT PYTHON_EXECUTABLE)
|
|
|
|
|
MESSAGE(FATAL_ERROR "Python not found! Aborting...")
|
|
|
|
|
ENDIF() # NOT PYTHON_EXECUTABLE
|
|
|
|
|
set(options NONE)
|
|
|
|
|
set(oneValueArgs NAME)
|
|
|
|
|
set(multiValueArgs EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES)
|
|
|
|
|
cmake_parse_arguments(Coverage "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
|
|
|
|
|
|
|
|
|
|
IF(NOT GCOVR_PATH)
|
|
|
|
|
MESSAGE(FATAL_ERROR "gcovr not found! Aborting...")
|
|
|
|
|
ENDIF() # NOT GCOVR_PATH
|
|
|
|
|
if(NOT SIMPLE_PYTHON_EXECUTABLE)
|
|
|
|
|
message(FATAL_ERROR "python not found! Aborting...")
|
|
|
|
|
endif() # NOT SIMPLE_PYTHON_EXECUTABLE
|
|
|
|
|
|
|
|
|
|
ADD_CUSTOM_TARGET(${_targetname}
|
|
|
|
|
if(NOT GCOVR_PATH)
|
|
|
|
|
message(FATAL_ERROR "gcovr not found! Aborting...")
|
|
|
|
|
endif() # NOT GCOVR_PATH
|
|
|
|
|
|
|
|
|
|
# Run tests
|
|
|
|
|
${_testrunner} ${ARGV3}
|
|
|
|
|
# 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()
|
|
|
|
|
|
|
|
|
|
# Running gcovr
|
|
|
|
|
COMMAND ${GCOVR_PATH} -x -r ${CMAKE_SOURCE_DIR} -e '${CMAKE_SOURCE_DIR}/tests/' -o ${_outputname}.xml
|
|
|
|
|
WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
|
|
|
|
|
COMMENT "Running gcovr to produce Cobertura code coverage report."
|
|
|
|
|
)
|
|
|
|
|
add_custom_target(${Coverage_NAME}
|
|
|
|
|
# Run tests
|
|
|
|
|
${Coverage_EXECUTABLE}
|
|
|
|
|
|
|
|
|
|
# Show info where to find the report
|
|
|
|
|
ADD_CUSTOM_COMMAND(TARGET ${_targetname} POST_BUILD
|
|
|
|
|
COMMAND ;
|
|
|
|
|
COMMENT "Cobertura code coverage report saved in ${_outputname}.xml."
|
|
|
|
|
)
|
|
|
|
|
# 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."
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
ENDFUNCTION() # SETUP_TARGET_FOR_COVERAGE_COBERTURA
|
|
|
|
|
# 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}
|
|
|
|
|
|
|
|
|
|
# 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 ./${Coverage_NAME}/index.html in your browser to view the coverage report."
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
endfunction() # SETUP_TARGET_FOR_COVERAGE_GCOVR_HTML
|
|
|
|
|
|
|
|
|
|
function(APPEND_COVERAGE_COMPILER_FLAGS)
|
|
|
|
|
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${COVERAGE_COMPILER_FLAGS}" PARENT_SCOPE)
|
|
|
|
|
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${COVERAGE_COMPILER_FLAGS}" PARENT_SCOPE)
|
|
|
|
|
message(STATUS "Appending code coverage compiler flags: ${COVERAGE_COMPILER_FLAGS}")
|
|
|
|
|
endfunction() # APPEND_COVERAGE_COMPILER_FLAGS
|
Jonathan White