mirrors/CLI11
1
0
Fork 0
mirror of https://github.com/CLIUtils/CLI11.git synced 2025-04-29 20:23:55 +00:00
Code Issues Releases Wiki Activity

Updating coverage

Browse Source
This commit is contained in:
Henry Fredrick Schreiner 2018-04-28 09:01:07 -04:00 committed by Henry Schreiner
parent 952f2913e3
commit 89975e51e7
4 changed files with 169 additions and 117 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.codecov.yml
View File

@ -1,3 +1,4 @@
ignore: ignore:
- "tests" - "tests"
- "examples"

5
CMakeLists.txt
View File

@ -61,11 +61,6 @@ include(CMakeDependentOption)
# Allow IDE's to group targets into folders # Allow IDE's to group targets into folders
set_property(GLOBAL PROPERTY USE_FOLDERS ON) set_property(GLOBAL PROPERTY USE_FOLDERS ON)
if(CMAKE_BUILD_TYPE STREQUAL Coverage)
include(CodeCoverage)
setup_target_for_coverage(CLI11_coverage ctest coverage)
endif()
file(GLOB CLI11_headers "${CMAKE_CURRENT_SOURCE_DIR}/include/CLI/*") file(GLOB CLI11_headers "${CMAKE_CURRENT_SOURCE_DIR}/include/CLI/*")
# To see in IDE, must be listed for target # To see in IDE, must be listed for target

238
cmake/CodeCoverage.cmake
View File

@ -1,4 +1,4 @@
# Copyright (c) 2012 - 2015, Lars Bilke # Copyright (c) 2012 - 2017, Lars Bilke
# All rights reserved. # All rights reserved.
# #
# Redistribution and use in source and binary forms, with or without modification, # 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 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# #
# # CHANGES:
# #
# 2012-01-31, Lars Bilke # 2012-01-31, Lars Bilke
# - Enable Code Coverage # - Enable Code Coverage
@ -35,164 +35,210 @@
# - Added support for Clang. # - Added support for Clang.
# - Some additional usage instructions. # - 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: # 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. # 1. Copy this file into your cmake modules path.
# #
# 2. Add the following line to your CMakeLists.txt: # 2. Add the following line to your CMakeLists.txt:
# INCLUDE(CodeCoverage) # include(CodeCoverage)
# #
# 3. Set compiler flags to turn off optimization and enable coverage: # 3. Append necessary compiler flags:
# SET(CMAKE_CXX_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage") # APPEND_COVERAGE_COMPILER_FLAGS()
# SET(CMAKE_C_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage")
# #
# 3. Use the function SETUP_TARGET_FOR_COVERAGE to create a custom make target # 4. If you need to exclude additional directories from the report, specify them
# which runs your test executable and produces a lcov code coverage report: # using the COVERAGE_EXCLUDES variable before calling SETUP_TARGET_FOR_COVERAGE.
# Example: # Example:
# SETUP_TARGET_FOR_COVERAGE( # set(COVERAGE_EXCLUDES 'dir1/*' 'dir2/*')
# 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.
# )
# #
# 4. Build a Debug build: # 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 .. # cmake -DCMAKE_BUILD_TYPE=Debug ..
# make # make
# make my_coverage_target # make my_coverage_target
# #
#
include(CMakeParseArguments)
# Check prereqs # Check prereqs
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 )
FIND_PROGRAM( GCOV_PATH gcov) if(NOT GCOV_PATH)
FIND_PROGRAM( LCOV_PATH lcov ) message(FATAL_ERROR "gcov not found! Aborting...")
FIND_PROGRAM( GENHTML_PATH genhtml ) endif() # NOT GCOV_PATH
FIND_PROGRAM( GCOVR_PATH gcovr PATHS ${CMAKE_SOURCE_DIR}/tests)
IF(NOT GCOV_PATH) if("${CMAKE_CXX_COMPILER_ID}" MATCHES "(Apple)?[Cc]lang")
MESSAGE(FATAL_ERROR "gcov not found! Aborting...") if("${CMAKE_CXX_COMPILER_VERSION}" VERSION_LESS 3)
ENDIF() # NOT GCOV_PATH 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()
IF("${CMAKE_CXX_COMPILER_ID}" MATCHES "(Apple)?[Cc]lang") set(COVERAGE_COMPILER_FLAGS "-g -O0 --coverage -fprofile-arcs -ftest-coverage"
IF("${CMAKE_CXX_COMPILER_VERSION}" VERSION_LESS 3) CACHE INTERNAL "")
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
SET(CMAKE_CXX_FLAGS_COVERAGE set(CMAKE_CXX_FLAGS_COVERAGE
"-g -O0 --coverage" ${COVERAGE_COMPILER_FLAGS}
CACHE STRING "Flags used by the C++ compiler during coverage builds." CACHE STRING "Flags used by the C++ compiler during coverage builds."
FORCE ) FORCE )
SET(CMAKE_C_FLAGS_COVERAGE set(CMAKE_C_FLAGS_COVERAGE
"-g -O0 --coverage" ${COVERAGE_COMPILER_FLAGS}
CACHE STRING "Flags used by the C compiler during coverage builds." CACHE STRING "Flags used by the C compiler during coverage builds."
FORCE ) FORCE )
SET(CMAKE_EXE_LINKER_FLAGS_COVERAGE set(CMAKE_EXE_LINKER_FLAGS_COVERAGE
"--coverage" ""
CACHE STRING "Flags used for linking binaries during coverage builds." CACHE STRING "Flags used for linking binaries during coverage builds."
FORCE ) FORCE )
SET(CMAKE_SHARED_LINKER_FLAGS_COVERAGE set(CMAKE_SHARED_LINKER_FLAGS_COVERAGE
"--coverage" ""
CACHE STRING "Flags used by the shared libraries linker during coverage builds." CACHE STRING "Flags used by the shared libraries linker during coverage builds."
FORCE ) FORCE )
MARK_AS_ADVANCED( mark_as_advanced(
CMAKE_CXX_FLAGS_COVERAGE CMAKE_CXX_FLAGS_COVERAGE
CMAKE_C_FLAGS_COVERAGE CMAKE_C_FLAGS_COVERAGE
CMAKE_EXE_LINKER_FLAGS_COVERAGE CMAKE_EXE_LINKER_FLAGS_COVERAGE
CMAKE_SHARED_LINKER_FLAGS_COVERAGE ) CMAKE_SHARED_LINKER_FLAGS_COVERAGE )
IF ( NOT (CMAKE_BUILD_TYPE STREQUAL "Debug" OR CMAKE_BUILD_TYPE STREQUAL "Coverage")) if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
MESSAGE( WARNING "Code coverage results with an optimized (non-Debug) build may be misleading" ) message(WARNING "Code coverage results with an optimised (non-Debug) build may be misleading")
ENDIF() # NOT CMAKE_BUILD_TYPE STREQUAL "Debug" 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 # Defines a target for running and collection code coverage information
# Param _testrunner The name of the target which runs the tests. # Builds dependencies, runs the given executable and outputs reports.
# MUST return ZERO always, even on errors. # NOTE! The executable should always have a ZERO as exit code otherwise
# If not, no coverage report will be created! # the coverage generation will not complete.
# Param _outputname lcov output is generated as _outputname.info #
# HTML report is generated in _outputname/index.html # SETUP_TARGET_FOR_COVERAGE(
# Optional fourth parameter is passed as arguments to _testrunner # NAME testrunner_coverage # New target name
# Pass them in list form, e.g.: "-j;2" for -j 2 # EXECUTABLE testrunner -j ${PROCESSOR_COUNT} # Executable in PROJECT_BINARY_DIR
FUNCTION(SETUP_TARGET_FOR_COVERAGE _targetname _testrunner _outputname) # DEPENDENCIES testrunner # Dependencies to build first
# )
function(SETUP_TARGET_FOR_COVERAGE)
IF(NOT LCOV_PATH) set(options NONE)
MESSAGE(FATAL_ERROR "lcov not found! Aborting...") set(oneValueArgs NAME)
ENDIF() # NOT LCOV_PATH set(multiValueArgs EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES)
cmake_parse_arguments(Coverage "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
IF(NOT GENHTML_PATH) if(NOT LCOV_PATH)
MESSAGE(FATAL_ERROR "genhtml not found! Aborting...") message(FATAL_ERROR "lcov not found! Aborting...")
ENDIF() # NOT GENHTML_PATH endif() # NOT LCOV_PATH
SET(coverage_info "${CMAKE_BINARY_DIR}/${_outputname}.info") if(NOT GENHTML_PATH)
SET(coverage_cleaned "${coverage_info}.cleaned") message(FATAL_ERROR "genhtml not found! Aborting...")
endif() # NOT GENHTML_PATH
SEPARATE_ARGUMENTS(test_command UNIX_COMMAND "${_testrunner}")
# Setup target # Setup target
ADD_CUSTOM_TARGET(${_targetname} add_custom_target(${Coverage_NAME}
# Cleanup lcov # Cleanup lcov
${LCOV_PATH} --directory . --zerocounters COMMAND ${LCOV_PATH} --directory . --zerocounters
# Create baseline to make sure untouched files show up in the report
COMMAND ${LCOV_PATH} -c -i -d . -o ${Coverage_NAME}.base
# Run tests # Run tests
COMMAND ${test_command} ${ARGV3} COMMAND ${Coverage_EXECUTABLE}
# Capturing lcov counters and generating report # Capturing lcov counters and generating report
COMMAND ${LCOV_PATH} --directory . --capture --output-file ${coverage_info} COMMAND ${LCOV_PATH} --directory . --capture --output-file ${Coverage_NAME}.info
COMMAND ${LCOV_PATH} --remove ${coverage_info} '*/tests/*' '*gtest*' '*gmock*' '/usr/*' --output-file ${coverage_cleaned} # add baseline counters
COMMAND ${GENHTML_PATH} -o ${_outputname} ${coverage_cleaned} COMMAND ${LCOV_PATH} -a ${Coverage_NAME}.base -a ${Coverage_NAME}.info --output-file ${Coverage_NAME}.total
COMMAND ${CMAKE_COMMAND} -E remove ${coverage_info} ${coverage_cleaned} COMMAND ${LCOV_PATH} --remove ${Coverage_NAME}.total ${COVERAGE_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
WORKING_DIRECTORY ${CMAKE_BINARY_DIR} WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
DEPENDS ${Coverage_DEPENDENCIES}
COMMENT "Resetting code coverage counters to zero.\nProcessing code coverage counters and generating report." COMMENT "Resetting code coverage counters to zero.\nProcessing code coverage counters and generating report."
) )
# Show info where to find the report # Show where to find the lcov info report
ADD_CUSTOM_COMMAND(TARGET ${_targetname} POST_BUILD add_custom_command(TARGET ${Coverage_NAME} POST_BUILD
COMMAND ; COMMAND ;
COMMENT "Open ./${_outputname}/index.html in your browser to view the coverage report." COMMENT "Lcov code coverage info report saved in ${Coverage_NAME}.info."
) )
ENDFUNCTION() # SETUP_TARGET_FOR_COVERAGE # 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."
)
# Param _targetname The name of new the custom make target endfunction() # SETUP_TARGET_FOR_COVERAGE
# 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)
IF(NOT PYTHON_EXECUTABLE) # Defines a target for running and collection code coverage information
MESSAGE(FATAL_ERROR "Python not found! Aborting...") # Builds dependencies, runs the given executable and outputs reports.
ENDIF() # NOT PYTHON_EXECUTABLE # NOTE! The executable should always have a ZERO as exit code otherwise
# the coverage generation will not complete.
#
# SETUP_TARGET_FOR_COVERAGE_COBERTURA(
# 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_COBERTURA)
IF(NOT GCOVR_PATH) set(options NONE)
MESSAGE(FATAL_ERROR "gcovr not found! Aborting...") set(oneValueArgs NAME)
ENDIF() # NOT GCOVR_PATH set(multiValueArgs EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES)
cmake_parse_arguments(Coverage "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
ADD_CUSTOM_TARGET(${_targetname} 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(COBERTURA_EXCLUDES "")
foreach(EXCLUDE ${COVERAGE_EXCLUDES})
set(COBERTURA_EXCLUDES "-e ${EXCLUDE} ${COBERTURA_EXCLUDES}")
endforeach()
add_custom_target(${Coverage_NAME}
# Run tests # Run tests
${_testrunner} ${ARGV3} ${Coverage_EXECUTABLE}
# Running gcovr # Running gcovr
COMMAND ${GCOVR_PATH} -x -r ${CMAKE_SOURCE_DIR} -e '${CMAKE_SOURCE_DIR}/tests/' -o ${_outputname}.xml COMMAND ${GCOVR_PATH} -x -r ${CMAKE_SOURCE_DIR} ${COBERTURA_EXCLUDES}
WORKING_DIRECTORY ${CMAKE_BINARY_DIR} -o ${Coverage_NAME}.xml
WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
DEPENDS ${Coverage_DEPENDENCIES}
COMMENT "Running gcovr to produce Cobertura code coverage report." COMMENT "Running gcovr to produce Cobertura code coverage report."
) )
# Show info where to find the report # Show info where to find the report
ADD_CUSTOM_COMMAND(TARGET ${_targetname} POST_BUILD add_custom_command(TARGET ${Coverage_NAME} POST_BUILD
COMMAND ; COMMAND ;
COMMENT "Cobertura code coverage report saved in ${_outputname}.xml." COMMENT "Cobertura code coverage report saved in ${Coverage_NAME}.xml."
) )
ENDFUNCTION() # SETUP_TARGET_FOR_COVERAGE_COBERTURA endfunction() # SETUP_TARGET_FOR_COVERAGE_COBERTURA
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

10
tests/CMakeLists.txt
View File

@ -103,3 +103,13 @@ if(Boost_FOUND)
target_compile_definitions(OptionalTest PUBLIC CLI11_BOOST_OPTIONAL) target_compile_definitions(OptionalTest PUBLIC CLI11_BOOST_OPTIONAL)
endif() endif()
if(CMAKE_BUILD_TYPE STREQUAL Coverage)
include(CodeCoverage)
setup_target_for_coverage(
NAME CLI11_coverage
EXECUTABLE ctest
DEPENDENCIES
${CLI11_TESTS}
${CLI11_MULTIONLY_TESTS})
endif()