CMakeCommon/CodeCoverage.cmake

   1 # Copyright (c) 2012 - 2013, 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 # USAGE:
  39
  40 # 0. (Mac only) If you use Xcode 5.1 make sure to patch geninfo as described here:
  41 #      http://stackoverflow.com/a/22404544/80480
  42 #
  43 # 1. Copy this file into your cmake modules path.
  44 #
  45 # 2. Add the following line to your CMakeLists.txt:
  46 #      INCLUDE(CodeCoverage)
  47 #
  48 # 3. Set compiler flags to turn off optimization and enable coverage:
  49 #    SET(CMAKE_CXX_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage")
  50 #        SET(CMAKE_C_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage")
  51 #
  52 # 3. Use the function SETUP_TARGET_FOR_COVERAGE to create a custom make target
  53 #    which runs your test executable and produces a lcov code coverage report:
  54 #    Example:
  55 #        SETUP_TARGET_FOR_COVERAGE(
  56 #                               my_coverage_target  # Name for custom target.
  57 #                               test_driver         # Name of the test driver executable that runs the tests.
  58 #                                                                       # NOTE! This should always have a ZERO as exit code
  59 #                                                                       # otherwise the coverage generation will not complete.
  60 #                               coverage            # Name of output directory.
  61 #                               )
  62 #
  63 # 4. Build a Debug build:
  64 #        cmake -DCMAKE_BUILD_TYPE=Debug ..
  65 #        make
  66 #        make my_coverage_target
  67 #
  68 #
  69
  70 # Check prereqs
  71 FIND_PROGRAM( GCOV_PATH gcov )
  72 FIND_PROGRAM( LCOV_PATH lcov )
  73 FIND_PROGRAM( GENHTML_PATH genhtml )
  74 FIND_PROGRAM( GCOVR_PATH gcovr PATHS ${CMAKE_SOURCE_DIR}/tests)
  75
  76 IF(NOT GCOV_PATH)
  77         MESSAGE(FATAL_ERROR "gcov not found! Aborting...")
  78 ENDIF() # NOT GCOV_PATH
  79
  80 IF(NOT CMAKE_COMPILER_IS_GNUCXX)
  81         # Clang version 3.0.0 and greater now supports gcov as well.
  82         MESSAGE(WARNING "Compiler is not GNU gcc! Clang Version 3.0.0 and greater supports gcov as well, but older versions don't.")
  83
  84         IF(NOT "${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
  85                 MESSAGE(FATAL_ERROR "Compiler is not GNU gcc! Aborting...")
  86         ENDIF()
  87 ENDIF() # NOT CMAKE_COMPILER_IS_GNUCXX
  88
  89 SET(CMAKE_CXX_FLAGS_COVERAGE
  90     "-g -O0 --coverage -fprofile-arcs -ftest-coverage"
  91     CACHE STRING "Flags used by the C++ compiler during coverage builds."
  92     FORCE )
  93 SET(CMAKE_C_FLAGS_COVERAGE
  94     "-g -O0 --coverage -fprofile-arcs -ftest-coverage"
  95     CACHE STRING "Flags used by the C compiler during coverage builds."
  96     FORCE )
  97 SET(CMAKE_EXE_LINKER_FLAGS_COVERAGE
  98     ""
  99     CACHE STRING "Flags used for linking binaries during coverage builds."
 100     FORCE )
 101 SET(CMAKE_SHARED_LINKER_FLAGS_COVERAGE
 102     ""
 103     CACHE STRING "Flags used by the shared libraries linker during coverage builds."
 104     FORCE )
 105 MARK_AS_ADVANCED(
 106     CMAKE_CXX_FLAGS_COVERAGE
 107     CMAKE_C_FLAGS_COVERAGE
 108     CMAKE_EXE_LINKER_FLAGS_COVERAGE
 109     CMAKE_SHARED_LINKER_FLAGS_COVERAGE )
 110
 111 IF ( NOT (CMAKE_BUILD_TYPE STREQUAL "Debug" OR CMAKE_BUILD_TYPE STREQUAL "Coverage"))
 112   MESSAGE( WARNING "Code coverage results with an optimized (non-Debug) build may be misleading" )
 113 ENDIF() # NOT CMAKE_BUILD_TYPE STREQUAL "Debug"
 114
 115
 116 # Param _targetname     The name of new the custom make target
 117 # Param _testrunner     The name of the target which runs the tests.
 118 #                                               MUST return ZERO always, even on errors.
 119 #                                               If not, no coverage report will be created!
 120 # Param _outputname     lcov output is generated as _outputname.info
 121 #                       HTML report is generated in _outputname/index.html
 122 # Optional fourth parameter is passed as arguments to _testrunner
 123 #   Pass them in list form, e.g.: "-j;2" for -j 2
 124 FUNCTION(SETUP_TARGET_FOR_COVERAGE _targetname _testrunner _outputname)
 125
 126         IF(NOT LCOV_PATH)
 127                 MESSAGE(FATAL_ERROR "lcov not found! Aborting...")
 128         ENDIF() # NOT LCOV_PATH
 129
 130         IF(NOT GENHTML_PATH)
 131                 MESSAGE(FATAL_ERROR "genhtml not found! Aborting...")
 132         ENDIF() # NOT GENHTML_PATH
 133
 134         # Setup target
 135         ADD_CUSTOM_TARGET(${_targetname}
 136
 137                 # Cleanup lcov
 138                 ${LCOV_PATH} --directory . --zerocounters
 139
 140                 # Run tests
 141                 COMMAND ${_testrunner} ${ARGV3}
 142
 143                 # Capturing lcov counters and generating report
 144                 COMMAND ${LCOV_PATH} --directory . --capture --output-file ${_outputname}.info
 145                 COMMAND ${LCOV_PATH} --remove ${_outputname}.info 'tests/*' '/usr/*' --output-file ${_outputname}.info.cleaned
 146                 COMMAND ${GENHTML_PATH} -o ${_outputname} ${_outputname}.info.cleaned
 147                 COMMAND ${CMAKE_COMMAND} -E remove ${_outputname}.info ${_outputname}.info.cleaned
 148
 149                 WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
 150                 COMMENT "Resetting code coverage counters to zero.\nProcessing code coverage counters and generating report."
 151         )
 152
 153         # Show info where to find the report
 154         ADD_CUSTOM_COMMAND(TARGET ${_targetname} POST_BUILD
 155                 COMMAND ;
 156                 COMMENT "Open ./${_outputname}/index.html in your browser to view the coverage report."
 157         )
 158
 159 ENDFUNCTION() # SETUP_TARGET_FOR_COVERAGE
 160
 161 # Param _targetname     The name of new the custom make target
 162 # Param _testrunner     The name of the target which runs the tests
 163 # Param _outputname     cobertura output is generated as _outputname.xml
 164 # Optional fourth parameter is passed as arguments to _testrunner
 165 #   Pass them in list form, e.g.: "-j;2" for -j 2
 166 FUNCTION(SETUP_TARGET_FOR_COVERAGE_COBERTURA _targetname _testrunner _outputname)
 167
 168         IF(NOT PYTHON_EXECUTABLE)
 169                 MESSAGE(FATAL_ERROR "Python not found! Aborting...")
 170         ENDIF() # NOT PYTHON_EXECUTABLE
 171
 172         IF(NOT GCOVR_PATH)
 173                 MESSAGE(FATAL_ERROR "gcovr not found! Aborting...")
 174         ENDIF() # NOT GCOVR_PATH
 175
 176         ADD_CUSTOM_TARGET(${_targetname}
 177
 178                 # Run tests
 179                 ${_testrunner} ${ARGV3}
 180
 181                 # Running gcovr
 182                 COMMAND ${GCOVR_PATH} -x -r ${CMAKE_SOURCE_DIR} -e '${CMAKE_SOURCE_DIR}/tests/'  -o ${_outputname}.xml
 183                 WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
 184                 COMMENT "Running gcovr to produce Cobertura code coverage report."
 185         )
 186
 187         # Show info where to find the report
 188         ADD_CUSTOM_COMMAND(TARGET ${_targetname} POST_BUILD
 189                 COMMAND ;
 190                 COMMENT "Cobertura code coverage report saved in ${_outputname}.xml."
 191         )
 192
 193 ENDFUNCTION() # SETUP_TARGET_FOR_COVERAGE_COBERTURA