HG_REPOSITORIES/LPP/SciQLOP_Repos/SciQLop Files · cmake/sciqlop_code_coverage.cmake

Merge pull request from SciQLop-fork develop...

Merge pull request from SciQLop-fork develop Develop

perrinel - - Load All Authors

File last commit:

r42:268b32cf0b31


                r1055:184d761e8d0c

Download file

             sciqlop_code_coverage.cmake
        
                    191 lines
            
             | 7.2 KiB
            
                | text/x-cmake
            
             |
                CMakeLexer
            
             / cmake / sciqlop_code_coverage.cmake
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Alexandre Leroux
    
commit temp

              r41
            
      # 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.

      #

      # 2. 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.

      #

      # 3. 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.

      #

      # 2. Add the following line to your CMakeLists.txt:

      #      include(CodeCoverage)

      #

      # 3. Append necessary compiler flags:

      #      APPEND_COVERAGE_COMPILER_FLAGS()

      #

      # 4. If you need to exclude additional directories from the report, specify them

      #    using the COVERAGE_EXCLUDES variable before calling SETUP_TARGET_FOR_COVERAGE.

      #    Example:

      #      set(COVERAGE_EXCLUDES 'dir1/*' 'dir2/*')

      #

      # 5. 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:

      #    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.

      #      )

      #

      # 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}/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 --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

          ${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_COMPILER_IS_GNUCXX)

          link_libraries(gcov)

      else()

          set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --coverage")

      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(

      #     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)

          set(options NONE)

        perrinel
    
Ajout de la couverture de code avec gcov, lcov & genpath

              r42
            
          set(oneValueArgs NAME TARGET OUTPUT)

        Alexandre Leroux
    
commit temp

              r41
            
          set(multiValueArgs EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES)

          cmake_parse_arguments(Coverage "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})

          if(NOT LCOV_PATH)

        perrinel
    
Ajout de la couverture de code avec gcov, lcov & genpath

              r42
            
              message(FATAL_ERROR "lcov not found! Aborting...")

        Alexandre Leroux
    
commit temp

              r41
            
          endif() # NOT LCOV_PATH

          if(NOT GENHTML_PATH)

        perrinel
    
Ajout de la couverture de code avec gcov, lcov & genpath

              r42
            
              message(FATAL_ERROR "genhtml not found! Aborting...")

        Alexandre Leroux
    
commit temp

              r41
            
          endif() # NOT GENHTML_PATH

          # Setup target

          add_custom_target(${Coverage_TARGET}

              # Cleanup lcov

        perrinel
    
Ajout de la couverture de code avec gcov, lcov & genpath

              r42
            
              COMMAND ${LCOV_PATH} --directory . --zerocounters

        Alexandre Leroux
    
commit temp

              r41
            
              # Run tests

              COMMAND ${Coverage_EXECUTABLE}

        perrinel
    
Ajout de la couverture de code avec gcov, lcov & genpath

              r42
            
              # Capturing lcov counters and generating report

              COMMAND ${LCOV_PATH} --directory . --capture --output-file ${Coverage_NAME}.info

              COMMAND ${LCOV_PATH} --remove ${Coverage_NAME}.info ${COVERAGE_EXCLUDES} --output-file ${Coverage_NAME}.info.cleaned

              COMMAND ${GENHTML_PATH} -o  ${Coverage_OUTPUT} ${Coverage_NAME}.info.cleaned

              COMMAND ${CMAKE_COMMAND} -E remove ${Coverage_NAME}.info ${Coverage_NAME}.info.cleaned

        Alexandre Leroux
    
commit temp

              r41
            
              WORKING_DIRECTORY ${PROJECT_BINARY_DIR}

              DEPENDS ${Coverage_DEPENDENCIES}

              COMMENT "Resetting code coverage counters to zero.\nProcessing code coverage counters and generating report."

          )

          # Show info where to find the report

      #    message("Nome de la target ${Coverage_TARGET}")

      #    add_custom_command(TARGET ${Coverage_TARGET} POST_BUILD

      #        COMMAND ;

      #        COMMENT "Open ./${Coverage_NAME}/index.html in your browser to view the coverage report."

      #    )

        perrinel
    
Ajout de la couverture de code avec gcov, lcov & genpath

              r42
            
      endfunction()

        Alexandre Leroux
    
commit temp

              r41
            
      function(APPEND_COVERAGE_COMPILER_FLAGS)

          set(CMAKE_C_FLAGS "${CMAKE_CXX_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

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

Alexandre Leroux commit temp	r41	# 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.
		#
		# 2. 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.
		#
		# 3. 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.
		#
		# 2. Add the following line to your CMakeLists.txt:
		# include(CodeCoverage)
		#
		# 3. Append necessary compiler flags:
		# APPEND_COVERAGE_COMPILER_FLAGS()
		#
		# 4. If you need to exclude additional directories from the report, specify them
		# using the COVERAGE_EXCLUDES variable before calling SETUP_TARGET_FOR_COVERAGE.
		# Example:
		# set(COVERAGE_EXCLUDES 'dir1/' 'dir2/')
		#
		# 5. 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:
		# 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.
		# )
		#
		# 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}/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 --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
		${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_COMPILER_IS_GNUCXX)
		link_libraries(gcov)
		else()
		set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --coverage")
		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(
		# 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)

		set(options NONE)
perrinel Ajout de la couverture de code avec gcov, lcov & genpath	r42	set(oneValueArgs NAME TARGET OUTPUT)
Alexandre Leroux commit temp	r41	set(multiValueArgs EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES)
		cmake_parse_arguments(Coverage "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})

		if(NOT LCOV_PATH)
perrinel Ajout de la couverture de code avec gcov, lcov & genpath	r42	message(FATAL_ERROR "lcov not found! Aborting...")
Alexandre Leroux commit temp	r41	endif() # NOT LCOV_PATH

		if(NOT GENHTML_PATH)
perrinel Ajout de la couverture de code avec gcov, lcov & genpath	r42	message(FATAL_ERROR "genhtml not found! Aborting...")
Alexandre Leroux commit temp	r41	endif() # NOT GENHTML_PATH

		# Setup target
		add_custom_target(${Coverage_TARGET}

		# Cleanup lcov
perrinel Ajout de la couverture de code avec gcov, lcov & genpath	r42	COMMAND ${LCOV_PATH} --directory . --zerocounters
Alexandre Leroux commit temp	r41
		# Run tests
		COMMAND ${Coverage_EXECUTABLE}

perrinel Ajout de la couverture de code avec gcov, lcov & genpath	r42	# Capturing lcov counters and generating report
		COMMAND ${LCOV_PATH} --directory . --capture --output-file ${Coverage_NAME}.info
		COMMAND ${LCOV_PATH} --remove ${Coverage_NAME}.info ${COVERAGE_EXCLUDES} --output-file ${Coverage_NAME}.info.cleaned
		COMMAND ${GENHTML_PATH} -o ${Coverage_OUTPUT} ${Coverage_NAME}.info.cleaned
		COMMAND ${CMAKE_COMMAND} -E remove ${Coverage_NAME}.info ${Coverage_NAME}.info.cleaned
Alexandre Leroux commit temp	r41
		WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
		DEPENDS ${Coverage_DEPENDENCIES}
		COMMENT "Resetting code coverage counters to zero.\nProcessing code coverage counters and generating report."
		)

		# Show info where to find the report
		# message("Nome de la target ${Coverage_TARGET}")
		# add_custom_command(TARGET ${Coverage_TARGET} POST_BUILD
		# COMMAND ;
		# COMMENT "Open ./${Coverage_NAME}/index.html in your browser to view the coverage report."
		# )

perrinel Ajout de la couverture de code avec gcov, lcov & genpath	r42	endfunction()
Alexandre Leroux commit temp	r41
		function(APPEND_COVERAGE_COMPILER_FLAGS)
		set(CMAKE_C_FLAGS "${CMAKE_CXX_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