Peter M. Groen / hueplusplus

Commit 3fb907aada5158c00b6e34d8610a69f056a74e11

Authored by Moritz Wirger
1 parent 788c9529

Push missing CodeCoverage file

Inline Side-by-side
Showing 1 changed file with 234 additions and 0 deletions
hueplusplus/test/CodeCoverage.cmake 0 → 100755
  View file @3fb907a
  1 +# Copyright (c) 2012 - 2017, Lars Bilke
  2 +# All rights reserved.
  3 +#
  4 +# Redistribution and use in source and binary forms, with or without modification,
  5 +# are permitted provided that the following conditions are met:
  6 +#
  7 +# 1. Redistributions of source code must retain the above copyright notice, this
  8 +# list of conditions and the following disclaimer.
  9 +#
  10 +# 2. Redistributions in binary form must reproduce the above copyright notice,
  11 +# this list of conditions and the following disclaimer in the documentation
  12 +# and/or other materials provided with the distribution.
  13 +#
  14 +# 3. Neither the name of the copyright holder nor the names of its contributors
  15 +# may be used to endorse or promote products derived from this software without
  16 +# specific prior written permission.
  17 +#
  18 +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  19 +# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  20 +# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  21 +# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
  22 +# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23 +# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  24 +# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  25 +# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27 +# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 +#
  29 +# CHANGES:
  30 +#
  31 +# 2012-01-31, Lars Bilke
  32 +# - Enable Code Coverage
  33 +#
  34 +# 2013-09-17, Joakim Söderberg
  35 +# - Added support for Clang.
  36 +# - Some additional usage instructions.
  37 +#
  38 +# 2016-02-03, Lars Bilke
  39 +# - Refactored functions to use named parameters
  40 +#
  41 +# 2017-06-02, Lars Bilke
  42 +# - Merged with modified version from github.com/ufz/ogs
  43 +#
  44 +#
  45 +# USAGE:
  46 +#
  47 +# 1. Copy this file into your cmake modules path.
  48 +#
  49 +# 2. Add the following line to your CMakeLists.txt:
  50 +# include(CodeCoverage)
  51 +#
  52 +# 3. Append necessary compiler flags:
  53 +# APPEND_COVERAGE_COMPILER_FLAGS()
  54 +#
  55 +# 4. If you need to exclude additional directories from the report, specify them
  56 +# using the COVERAGE_EXCLUDES variable before calling SETUP_TARGET_FOR_COVERAGE.
  57 +# Example:
  58 +# set(COVERAGE_EXCLUDES 'dir1/*' 'dir2/*')
  59 +#
  60 +# 5. Use the functions described below to create a custom make target which
  61 +# runs your test executable and produces a code coverage report.
  62 +#
  63 +# 6. Build a Debug build:
  64 +# cmake -DCMAKE_BUILD_TYPE=Debug ..
  65 +# make
  66 +# make my_coverage_target
  67 +#
  68 +
  69 +include(CMakeParseArguments)
  70 +
  71 +# Check prereqs
  72 +find_program( GCOV_PATH gcov )
  73 +find_program( LCOV_PATH lcov )
  74 +find_program( GENHTML_PATH genhtml )
  75 +find_program( GCOVR_PATH gcovr PATHS ${CMAKE_SOURCE_DIR}/scripts/test)
  76 +find_program( SIMPLE_PYTHON_EXECUTABLE python )
  77 +
  78 +if(NOT GCOV_PATH)
  79 + message(FATAL_ERROR "gcov not found! Aborting...")
  80 +endif() # NOT GCOV_PATH
  81 +
  82 +if("${CMAKE_CXX_COMPILER_ID}" MATCHES "(Apple)?[Cc]lang")
  83 + if("${CMAKE_CXX_COMPILER_VERSION}" VERSION_LESS 3)
  84 + message(FATAL_ERROR "Clang version must be 3.0.0 or greater! Aborting...")
  85 + endif()
  86 +elseif(NOT CMAKE_COMPILER_IS_GNUCXX)
  87 + message(FATAL_ERROR "Compiler is not GNU gcc! Aborting...")
  88 +endif()
  89 +
  90 +set(COVERAGE_COMPILER_FLAGS "-g -O0 --coverage -fprofile-arcs -ftest-coverage"
  91 + CACHE INTERNAL "")
  92 +
  93 +set(CMAKE_CXX_FLAGS_COVERAGE
  94 + ${COVERAGE_COMPILER_FLAGS}
  95 + CACHE STRING "Flags used by the C++ compiler during coverage builds."
  96 + FORCE )
  97 +set(CMAKE_C_FLAGS_COVERAGE
  98 + ${COVERAGE_COMPILER_FLAGS}
  99 + CACHE STRING "Flags used by the C compiler during coverage builds."
  100 + FORCE )
  101 +set(CMAKE_EXE_LINKER_FLAGS_COVERAGE
  102 + ""
  103 + CACHE STRING "Flags used for linking binaries during coverage builds."
  104 + FORCE )
  105 +set(CMAKE_SHARED_LINKER_FLAGS_COVERAGE
  106 + ""
  107 + CACHE STRING "Flags used by the shared libraries linker during coverage builds."
  108 + FORCE )
  109 +mark_as_advanced(
  110 + CMAKE_CXX_FLAGS_COVERAGE
  111 + CMAKE_C_FLAGS_COVERAGE
  112 + CMAKE_EXE_LINKER_FLAGS_COVERAGE
  113 + CMAKE_SHARED_LINKER_FLAGS_COVERAGE )
  114 +
  115 +if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
  116 + message(WARNING "Code coverage results with an optimised (non-Debug) build may be misleading")
  117 +endif() # NOT CMAKE_BUILD_TYPE STREQUAL "Debug"
  118 +
  119 +if(CMAKE_C_COMPILER_ID STREQUAL "GNU")
  120 + link_libraries(gcov)
  121 +else()
  122 + set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --coverage")
  123 +endif()
  124 +
  125 +# Defines a target for running and collection code coverage information
  126 +# Builds dependencies, runs the given executable and outputs reports.
  127 +# NOTE! The executable should always have a ZERO as exit code otherwise
  128 +# the coverage generation will not complete.
  129 +#
  130 +# SETUP_TARGET_FOR_COVERAGE(
  131 +# NAME testrunner_coverage # New target name
  132 +# EXECUTABLE testrunner -j ${PROCESSOR_COUNT} # Executable in PROJECT_BINARY_DIR
  133 +# DEPENDENCIES testrunner # Dependencies to build first
  134 +# )
  135 +function(SETUP_TARGET_FOR_COVERAGE)
  136 +
  137 + set(options NONE)
  138 + set(oneValueArgs NAME)
  139 + set(multiValueArgs EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES)
  140 + cmake_parse_arguments(Coverage "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
  141 +
  142 + if(NOT LCOV_PATH)
  143 + message(FATAL_ERROR "lcov not found! Aborting...")
  144 + endif() # NOT LCOV_PATH
  145 +
  146 + if(NOT GENHTML_PATH)
  147 + message(FATAL_ERROR "genhtml not found! Aborting...")
  148 + endif() # NOT GENHTML_PATH
  149 +
  150 + # Setup target
  151 + add_custom_target(${Coverage_NAME}
  152 +
  153 + # Cleanup lcov
  154 + COMMAND ${LCOV_PATH} --directory . --zerocounters
  155 +
  156 + # Run tests
  157 + COMMAND ${Coverage_EXECUTABLE}
  158 +
  159 + # Capturing lcov counters and generating report
  160 + COMMAND ${LCOV_PATH} --directory . --capture --output-file ${Coverage_NAME}.info
  161 + COMMAND ${LCOV_PATH} --remove ${Coverage_NAME}.info ${COVERAGE_EXCLUDES} --output-file ${Coverage_NAME}.info.cleaned
  162 + COMMAND ${GENHTML_PATH} -o ${Coverage_NAME} ${Coverage_NAME}.info.cleaned
  163 + COMMAND ${CMAKE_COMMAND} -E remove ${Coverage_NAME}.info ${Coverage_NAME}.info.cleaned
  164 +
  165 + WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
  166 + DEPENDS ${Coverage_DEPENDENCIES}
  167 + COMMENT "Resetting code coverage counters to zero.\nProcessing code coverage counters and generating report."
  168 + )
  169 +
  170 + # Show info where to find the report
  171 + add_custom_command(TARGET ${Coverage_NAME} POST_BUILD
  172 + COMMAND ;
  173 + COMMENT "Open ./${Coverage_NAME}/index.html in your browser to view the coverage report."
  174 + )
  175 +
  176 +endfunction() # SETUP_TARGET_FOR_COVERAGE
  177 +
  178 +# Defines a target for running and collection code coverage information
  179 +# Builds dependencies, runs the given executable and outputs reports.
  180 +# NOTE! The executable should always have a ZERO as exit code otherwise
  181 +# the coverage generation will not complete.
  182 +#
  183 +# SETUP_TARGET_FOR_COVERAGE_COBERTURA(
  184 +# NAME ctest_coverage # New target name
  185 +# EXECUTABLE ctest -j ${PROCESSOR_COUNT} # Executable in PROJECT_BINARY_DIR
  186 +# DEPENDENCIES executable_target # Dependencies to build first
  187 +# )
  188 +function(SETUP_TARGET_FOR_COVERAGE_COBERTURA)
  189 +
  190 + set(options NONE)
  191 + set(oneValueArgs NAME)
  192 + set(multiValueArgs EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES)
  193 + cmake_parse_arguments(Coverage "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
  194 +
  195 + if(NOT SIMPLE_PYTHON_EXECUTABLE)
  196 + message(FATAL_ERROR "python not found! Aborting...")
  197 + endif() # NOT SIMPLE_PYTHON_EXECUTABLE
  198 +
  199 + if(NOT GCOVR_PATH)
  200 + message(FATAL_ERROR "gcovr not found! Aborting...")
  201 + endif() # NOT GCOVR_PATH
  202 +
  203 + # Combine excludes to several -e arguments
  204 + set(COBERTURA_EXCLUDES "")
  205 + foreach(EXCLUDE ${COVERAGE_EXCLUDES})
  206 + set(COBERTURA_EXCLUDES "-e ${EXCLUDE} ${COBERTURA_EXCLUDES}")
  207 + endforeach()
  208 +
  209 + add_custom_target(${Coverage_NAME}
  210 +
  211 + # Run tests
  212 + ${Coverage_EXECUTABLE}
  213 +
  214 + # Running gcovr
  215 + COMMAND ${GCOVR_PATH} -x -r ${CMAKE_SOURCE_DIR} ${COBERTURA_EXCLUDES}
  216 + -o ${Coverage_NAME}.xml
  217 + WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
  218 + DEPENDS ${Coverage_DEPENDENCIES}
  219 + COMMENT "Running gcovr to produce Cobertura code coverage report."
  220 + )
  221 +
  222 + # Show info where to find the report
  223 + add_custom_command(TARGET ${Coverage_NAME} POST_BUILD
  224 + COMMAND ;
  225 + COMMENT "Cobertura code coverage report saved in ${Coverage_NAME}.xml."
  226 + )
  227 +
  228 +endfunction() # SETUP_TARGET_FOR_COVERAGE_COBERTURA
  229 +
  230 +function(APPEND_COVERAGE_COMPILER_FLAGS)
  231 + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${COVERAGE_COMPILER_FLAGS}" PARENT_SCOPE)
  232 + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${COVERAGE_COMPILER_FLAGS}" PARENT_SCOPE)
  233 + message(STATUS "Appending code coverage compiler flags: ${COVERAGE_COMPILER_FLAGS}")
  234 +endfunction() # APPEND_COVERAGE_COMPILER_FLAGS
... ...