From 7f942bf766480e5f0343ef20f8f15272d2c4c7c7 Mon Sep 17 00:00:00 2001
From: Sergey Yakubov <sergey.yakubov@desy.de>
Date: Tue, 28 Nov 2017 20:14:39 +0100
Subject: [PATCH] test coverage
---
.gitignore | 5 +
CMakeLists.txt | 6 +-
CMakeModules/CodeCoverage.cmake | 246 ++++++++++++++++++
CMakeModules/astyle.cmake | 4 +-
CMakeModules/check_test.sh | 24 ++
CMakeModules/gtest.cmake | 20 --
CMakeModules/testing_cpp.cmake | 29 +++
producer/api/CMakeLists.txt | 4 +
.../inotify-event-detector-cpp/CMakeLists.txt | 4 +-
9 files changed, 318 insertions(+), 24 deletions(-)
create mode 100644 CMakeModules/CodeCoverage.cmake
create mode 100755 CMakeModules/check_test.sh
delete mode 100644 CMakeModules/gtest.cmake
create mode 100644 CMakeModules/testing_cpp.cmake
diff --git a/.gitignore b/.gitignore
index c078042b7..2c6d07726 100644
--- a/.gitignore
+++ b/.gitignore
@@ -115,3 +115,8 @@ build
### Doxygen ###
doxygen
+### eclipse ###
+.cproject
+.project
+.settings
+
diff --git a/CMakeLists.txt b/CMakeLists.txt
index e623dd46f..a8785623e 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -9,12 +9,16 @@ option(BUILD_DOCS "Uses doxygen to build the documentaion" OFF)
set(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/CMakeModules/)
include(astyle)
-include(gtest)
+
+if(BUILD_TESTS)
+ include(testing_cpp)
+endif()
add_subdirectory(producer/api)
add_subdirectory(common/cpp)
add_subdirectory(producer/inotify-event-detector-cpp)
+
if(BUILD_DOCS)
include(doxygen)
endif()
diff --git a/CMakeModules/CodeCoverage.cmake b/CMakeModules/CodeCoverage.cmake
new file mode 100644
index 000000000..c170c6a0a
--- /dev/null
+++ b/CMakeModules/CodeCoverage.cmake
@@ -0,0 +1,246 @@
+# 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 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}/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(ERROR "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()
+
+# 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)
+ set(oneValueArgs NAME)
+ set(multiValueArgs EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES)
+ cmake_parse_arguments(Coverage "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
+
+ if(NOT LCOV_PATH)
+ message(FATAL_ERROR "lcov not found! Aborting...")
+ endif() # NOT LCOV_PATH
+
+ if(NOT GENHTML_PATH)
+ message(FATAL_ERROR "genhtml not found! Aborting...")
+ endif() # NOT GENHTML_PATH
+
+ # Setup target
+ add_custom_target(${Coverage_NAME}
+
+ # Cleanup lcov
+ COMMAND ${LCOV_PATH} --directory . --zerocounters
+ COMMAND rm -f ${PROJECT_BINARY_DIR}/${Coverage_NAME}.txt
+
+
+ # Create baseline to make sure untouched files show up in the report
+ COMMAND ${LCOV_PATH} -b ${CMAKE_CURRENT_SOURCE_DIR} -no-external -c -i -d ${PROJECT_BINARY_DIR} -o ${Coverage_NAME}.base
+
+ # Run tests
+ COMMAND ${Coverage_EXECUTABLE}
+
+ # Capturing lcov counters and generating report
+ COMMAND ${LCOV_PATH} -b ${CMAKE_CURRENT_SOURCE_DIR} -no-external --directory . --capture --output-file ${Coverage_NAME}.info
+ # add baseline counters
+ COMMAND ${LCOV_PATH} -b ${CMAKE_CURRENT_SOURCE_DIR} -no-external -a ${Coverage_NAME}.base -a ${Coverage_NAME}.info --output-file ${Coverage_NAME}.total
+ 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
+ | grep -A 3 "Overall coverage rate" | grep lines | cut -d ":" -f 2 | cut -d "." -f 1
+ > ${PROJECT_BINARY_DIR}/${Coverage_NAME}.txt
+ COMMAND ${CMAKE_COMMAND} -E remove ${Coverage_NAME}.base ${Coverage_NAME}.info ${Coverage_NAME}.total ${PROJECT_BINARY_DIR}/${Coverage_NAME}.info.cleaned
+
+# COMMAND echo bar OUTPUT_VARIABLE FOO)
+
+
+ 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
+ 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
+
+# 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_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)
+
+ 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(COBERTURA_EXCLUDES "")
+ foreach(EXCLUDE ${COVERAGE_EXCLUDES})
+ set(COBERTURA_EXCLUDES "-e ${EXCLUDE} ${COBERTURA_EXCLUDES}")
+ endforeach()
+
+ add_custom_target(${Coverage_NAME}
+
+ # Run tests
+ ${Coverage_EXECUTABLE}
+
+ # Running gcovr
+ COMMAND ${GCOVR_PATH} -x -r ${CMAKE_SOURCE_DIR} ${COBERTURA_EXCLUDES}
+ -o ${Coverage_NAME}.xml
+ WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
+ DEPENDS ${Coverage_DEPENDENCIES}
+ COMMENT "Running gcovr to produce Cobertura code coverage report."
+ )
+
+ # 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_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
diff --git a/CMakeModules/astyle.cmake b/CMakeModules/astyle.cmake
index 68c8ad10a..a6ad6663b 100644
--- a/CMakeModules/astyle.cmake
+++ b/CMakeModules/astyle.cmake
@@ -1,7 +1,7 @@
function(astyle target source_files)
find_program(ASTYLE_EXECUTABLE astyle)
if(ASTYLE_EXECUTABLE)
- message("Found astyle, using astyle to format code of target ${target}.")
+ message(STATUS "Found astyle, using astyle to format code of target ${target}.")
add_custom_command(
TARGET ${target} PRE_BUILD
COMMAND
@@ -9,6 +9,6 @@ function(astyle target source_files)
WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR} VERBATIM
)
else()
- message("Unable to find astyle. Skipping code formatting for ${target}")
+ message(WARNING "Unable to find astyle. Skipping code formatting for ${target}")
endif()
endfunction()
diff --git a/CMakeModules/check_test.sh b/CMakeModules/check_test.sh
new file mode 100755
index 000000000..969aef2d9
--- /dev/null
+++ b/CMakeModules/check_test.sh
@@ -0,0 +1,24 @@
+#!/bin/bash
+
+set -e
+
+TARGET=$1
+BINARY_DIR=$2
+HIDRA2_MINIMUM_COVERAGE=$3
+
+make ${TARGET}
+
+coverage=`cat ${BINARY_DIR}/${TARGET}.txt`
+
+if (( coverage < HIDRA2_MINIMUM_COVERAGE )); then
+ exec >&2
+ echo
+ echo "*****"
+ echo
+ echo $TARGET coverage is ${coverage}% - less than required ${HIDRA2_MINIMUM_COVERAGE}%
+ echo
+ echo "*****"
+ echo
+ exit 1
+fi
+
diff --git a/CMakeModules/gtest.cmake b/CMakeModules/gtest.cmake
deleted file mode 100644
index c6c128486..000000000
--- a/CMakeModules/gtest.cmake
+++ /dev/null
@@ -1,20 +0,0 @@
-if(BUILD_TESTS)
- enable_testing()
-endif()
-
-function(gtest target test_source_files test_libraries)
- if(BUILD_TESTS)
- find_package (Threads)
-
- include_directories(${gtest_SOURCE_DIR}/include ${gtest_SOURCE_DIR})
- add_executable(test-${target} ${test_source_files})
- target_link_libraries(test-${target} gtest gtest_main ${CMAKE_THREAD_LIBS_INIT})
- target_link_libraries(test-${target} ${test_libraries})
- add_test(NAME test-${target} COMMAND test-${target})
- astyle(test-${target} ${test_source_files})
-
- message("Added test 'test-${target}'")
- else()
- message("Skip test 'test-${target}'")
- endif()
-endfunction()
diff --git a/CMakeModules/testing_cpp.cmake b/CMakeModules/testing_cpp.cmake
new file mode 100644
index 000000000..3d31c67bf
--- /dev/null
+++ b/CMakeModules/testing_cpp.cmake
@@ -0,0 +1,29 @@
+enable_testing()
+set (HIDRA2_MINIMUM_COVERAGE 70)
+
+find_package (Threads)
+
+function(gtest target test_source_files test_libraries)
+ include_directories(${gtest_SOURCE_DIR}/include ${gtest_SOURCE_DIR})
+ add_executable(test-${target} ${test_source_files})
+ target_link_libraries(test-${target} gtest gtest_main ${CMAKE_THREAD_LIBS_INIT})
+ target_link_libraries(test-${target} ${test_libraries})
+ add_test(NAME test-${target} COMMAND test-${target})
+
+ astyle(test-${target} ${test_source_files})
+
+ message(STATUS "Added test 'test-${target}'")
+
+ if(CMAKE_COMPILER_IS_GNUCXX)
+ include(CodeCoverage)
+ APPEND_COVERAGE_COMPILER_FLAGS()
+ SETUP_TARGET_FOR_COVERAGE(NAME coverage-${target} EXECUTABLE test-${target} ${target})
+ add_test(NAME coveragetest-${target}
+ COMMAND ${CMAKE_MODULE_PATH}/check_test.sh
+ coverage-${target} ${CMAKE_BINARY_DIR} ${HIDRA2_MINIMUM_COVERAGE}
+ )
+ SET_TESTS_PROPERTIES(coveragetest-${target} PROPERTIES DEPENDS test-${target})
+ set(CMAKE_C_FLAGS ${CMAKE_C_FLAGS} PARENT_SCOPE)
+ set(CMAKE_CXX_FLAGS ${CMAKE_CXX_FLAGS} PARENT_SCOPE)
+ endif()
+endfunction()
diff --git a/producer/api/CMakeLists.txt b/producer/api/CMakeLists.txt
index 57fda5855..97a0876ee 100644
--- a/producer/api/CMakeLists.txt
+++ b/producer/api/CMakeLists.txt
@@ -18,4 +18,8 @@ astyle(${TARGET_NAME} ${SOURCE_FILES})
################################
set(TEST_SOURCE_FILES unittests/test_producer.cpp)
set(TEST_LIBRARIES producer-api)
+
+
gtest(${TARGET_NAME} ${TEST_SOURCE_FILES} ${TEST_LIBRARIES})
+
+
diff --git a/producer/inotify-event-detector-cpp/CMakeLists.txt b/producer/inotify-event-detector-cpp/CMakeLists.txt
index 174a0bc48..f940663aa 100644
--- a/producer/inotify-event-detector-cpp/CMakeLists.txt
+++ b/producer/inotify-event-detector-cpp/CMakeLists.txt
@@ -17,4 +17,6 @@ astyle(${TARGET_NAME} ${SOURCE_FILES})
# Testing
################################
set(TEST_SOURCE_FILES unittests/test_inotify_client.cpp)
-gtest(${TARGET_NAME} ${TEST_SOURCE_FILES} "")
+
+
+#gtest(${TARGET_NAME} ${TEST_SOURCE_FILES} "")
--
GitLab