Review and extend to examples

scheibel · scheibel · commit 50872d077471 · 2018-10-27T20:45:04.000+02:00
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -31,10 +31,10 @@ if (${CMAKE_VERSION} VERSION_GREATER "3.2")
 endif()
 
 # Include custom cmake modules
+include(cmake/Coverage.cmake)
+include(cmake/GenerateTemplateExportHeader.cmake)
 include(cmake/GetGitRevisionDescription.cmake)
 include(cmake/HealthCheck.cmake)
-include(cmake/GenerateTemplateExportHeader.cmake)
-include(cmake/Coverage.cmake)
 
 
 # 
@@ -71,11 +71,12 @@ string(TOUPPER ${META_PROJECT_ID} META_PROJECT_ID)
 # 
 
 # Project options
-option(BUILD_SHARED_LIBS     "Build shared instead of static libraries."              ON)
-option(OPTION_SELF_CONTAINED "Create a self-contained install with all dependencies." OFF)
-option(OPTION_BUILD_TESTS    "Build tests."                                           ON)
-option(OPTION_BUILD_DOCS     "Build documentation."                                   OFF)
-option(OPTION_BUILD_EXAMPLES "Build examples."                                        OFF)
+option(BUILD_SHARED_LIBS      "Build shared instead of static libraries."              ON)
+option(OPTION_SELF_CONTAINED  "Create a self-contained install with all dependencies." OFF)
+option(OPTION_BUILD_TESTS     "Build tests."                                           ON)
+option(OPTION_BUILD_DOCS      "Build documentation."                                   OFF)
+option(OPTION_BUILD_EXAMPLES  "Build examples."                                        OFF)
+option(OPTION_ENABLE_COVERAGE "Add coverage information."                              OFF)
 
 
 # 
@@ -98,13 +99,6 @@ set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR})
 file(WRITE "${PROJECT_BINARY_DIR}/VERSION" "${META_NAME_VERSION}")
 
 
-# 
-# Compiler settings and options
-# 
-
-include(cmake/CompileOptions.cmake)
-
-
 #
 # Project Health Check Setup
 #
@@ -115,7 +109,14 @@ add_check_template_target(${META_CMAKE_INIT_SHA})
 # Configure health check tools
 enable_cppcheck(ON)
 enable_clang_tidy(ON)
-enable_coverage(ON)
+enable_coverage(${OPTION_ENABLE_COVERAGE})
+
+
+# 
+# Compiler settings and options
+# 
+
+include(cmake/CompileOptions.cmake)
 
 
 # 
diff --git a/cmake/CompileOptions.cmake b/cmake/CompileOptions.cmake
@@ -131,6 +131,11 @@ if ("${CMAKE_CXX_COMPILER_ID}" MATCHES "GNU" OR "${CMAKE_CXX_COMPILER_ID}" MATCH
         $<$<VERSION_LESS:${CMAKE_VERSION},3.1>:
             -std=c++11
         >
+        
+        $<$<BOOL:${OPTION_COVERAGE_ENABLED}>:
+            -fprofile-arcs
+            -ftest-coverage
+        >
     )
 endif ()
 
@@ -144,6 +149,15 @@ set(DEFAULT_LINKER_OPTIONS)
 # Use pthreads on mingw and linux
 if("${CMAKE_CXX_COMPILER_ID}" MATCHES "GNU" OR "${CMAKE_SYSTEM_NAME}" MATCHES "Linux")
     set(DEFAULT_LINKER_OPTIONS
+        ${DEFAULT_LINKER_OPTIONS}
         -pthread
     )
+    
+    if (${OPTION_COVERAGE_ENABLED})
+        set(DEFAULT_LINKER_OPTIONS
+        ${DEFAULT_LINKER_OPTIONS}
+        -fprofile-arcs
+        -ftest-coverage
+    )
+    endif ()
 endif()
diff --git a/cmake/Coverage.cmake b/cmake/Coverage.cmake
@@ -3,9 +3,11 @@ include(${CMAKE_CURRENT_LIST_DIR}/Gcov.cmake)
 
 set(OPTION_COVERAGE_ENABLED OFF)
 
-set(EXCLUDE_COVERAGE
+set(LCOV_EXCLUDE_COVERAGE
+    ${LCOV_EXCLUDE_COVERAGE}
     "\"*/googletest/*\""
     "\"*v1*\""
+    "\"/usr/*\""
 )
 
 # Function to register a target for enabled coverage report
@@ -20,16 +22,17 @@ function(generate_coverage_report target)
         )
     endif()
     
-    if (OPTION_COVERAGE_ENABLED)
+    if (${OPTION_COVERAGE_ENABLED})
         generate_lcov_report(coverage-${target} ${target} ${ARGN})
+        add_dependencies(coverage coverage-${target})
     endif()
 endfunction()
 
 # Enable or disable coverage
 function(enable_coverage status)
     if(NOT ${status})
         set(OPTION_COVERAGE_ENABLED ${status} PARENT_SCOPE)
-        message(STATUS "Coverage report skipped: Manually disabled")
+        message(STATUS "Coverage lcov skipped: Manually disabled")
         
         return()
     endif()
@@ -38,7 +41,7 @@ function(enable_coverage status)
     
     if(NOT lcov_FOUND)
         set(OPTION_COVERAGE_ENABLED OFF PARENT_SCOPE)
-        message(STATUS "Coverage report skipped: lcov not found")
+        message(STATUS "Coverage lcov skipped: lcov not found")
         
         return()
     endif()
diff --git a/cmake/Findgcov.cmake b/cmake/Findgcov.cmake
@@ -1,14 +1,14 @@
 
-# FindGcov results:
-# GCOV_FOUND
-# GCOV_EXECUTABLE
+# Findgcov results:
+# gcov_FOUND
+# gcov_EXECUTABLE
 
 include(FindPackageHandleStandardArgs)
 
 # work around CMP0053, see http://public.kitware.com/pipermail/cmake/2014-November/059117.html
 set(PROGRAMFILES_x86_ENV "PROGRAMFILES(x86)")
 
-find_program(GCOV_EXECUTABLE
+find_program(gcov_EXECUTABLE
     NAMES
         gcov
     PATHS
@@ -18,11 +18,11 @@ find_program(GCOV_EXECUTABLE
         "$ENV{${PROGRAMFILES_x86_ENV}}/gcov"
 )
 
-find_package_handle_standard_args(Gcov
+find_package_handle_standard_args(gcov
 	FOUND_VAR
-        Gcov_FOUND
+        gcov_FOUND
     REQUIRED_VARS
-        GCOV_EXECUTABLE
+        gcov_EXECUTABLE
 )
 
-mark_as_advanced(GCOV_EXECUTABLE)
+mark_as_advanced(gcov_EXECUTABLE)
diff --git a/cmake/Findlcov.cmake b/cmake/Findlcov.cmake
@@ -1,5 +1,5 @@
 
-# FindGcovr results:
+# Findlcov results:
 # lcov_FOUND
 # lcov_EXECUTABLE
 
@@ -36,6 +36,7 @@ find_package_handle_standard_args(lcov
         genhtml_EXECUTABLE
 )
 
-mark_as_advanced(lcov_EXECUTABLE
+mark_as_advanced(
+    lcov_EXECUTABLE
     genhtml_EXECUTABLE
 )
diff --git a/cmake/Gcov.cmake b/cmake/Gcov.cmake
@@ -3,66 +3,102 @@
 #lcov -d build/source/tests/fiblib-test/CMakeFiles/fiblib-test.dir -c -o build/coverage/fiblib-test.info
 #genhtml -o build/coverage/html build/coverage/fiblib-test.info
 
+set(LCOV_EXCLUDE_COVERAGE)
 
 # Function to register a target for coverage
 function(generate_lcov_report coverage_target target)
     if(NOT TARGET coverage-init)
         add_custom_target(
-            coverage-init
+            coverage-zero
             COMMAND
                 ${lcov_EXECUTABLE}
-                    --directory ${CMAKE_CURRENT_BINARY_DIR}
                     --zerocounters
+                    --base-directory ${CMAKE_BINARY_DIR}
+                    --directory ${CMAKE_SOURCE_DIR}
+                    -q
+            WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+        )
+        
+        add_custom_target(
+            coverage-init
+            COMMAND
+                ${lcov_EXECUTABLE}
+                    --no-external
+                    --capture
+                    --initial
+                    --base-directory ${CMAKE_BINARY_DIR}
+                    --directory ${CMAKE_SOURCE_DIR}
+                    --output-file ${CMAKE_BINARY_DIR}/coverage-base.info
                     -q
-            WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+            WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+            BYPRODUCTS ${CMAKE_BINARY_DIR}/coverage-base.info
         )
 
         add_custom_target(
             coverage-info
             COMMAND
                 ${lcov_EXECUTABLE}
-                    --directory ${CMAKE_CURRENT_BINARY_DIR}
                     --capture
-                    --output-file ${CMAKE_CURRENT_BINARY_DIR}/coverage.info
+                    --no-external
+                    --base-directory ${CMAKE_BINARY_DIR}
+                    --directory ${CMAKE_SOURCE_DIR}
+                    --output-file ${CMAKE_BINARY_DIR}/coverage-captured.info
                     -q
-            WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-            BYPRODUCTS ${CMAKE_CURRENT_BINARY_DIR}/coverage.info
+            WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+            BYPRODUCTS ${CMAKE_BINARY_DIR}/coverage-captured.info
         )
 
         add_custom_target(
-            coverage-clean
+            coverage-merge
             COMMAND
                 ${lcov_EXECUTABLE}
-                    --directory ${CMAKE_CURRENT_BINARY_DIR}
-                    --remove ${CMAKE_CURRENT_BINARY_DIR}/coverage.info
-                    ${EXCLUDE_COVERAGE}
-                    --output-file ${CMAKE_CURRENT_BINARY_DIR}/coverage-clean.info
+                    --add-tracefile ${CMAKE_BINARY_DIR}/coverage-base.info
+                    --add-tracefile ${CMAKE_BINARY_DIR}/coverage-captured.info
+                    --output-file ${CMAKE_BINARY_DIR}/coverage-merged.info
                     -q
-            WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-            DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/coverage.info
-            BYPRODUCTS ${CMAKE_CURRENT_BINARY_DIR}/coverage-clean.info
+            WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+            BYPRODUCTS ${CMAKE_BINARY_DIR}/coverage-merged.info
+        )
+
+        add_custom_target(
+            coverage-filter
+            COMMAND
+                ${lcov_EXECUTABLE}
+                    --base-directory ${CMAKE_BINARY_DIR}
+                    --directory ${CMAKE_SOURCE_DIR}
+                    --remove ${CMAKE_BINARY_DIR}/coverage-merged.info
+                    ${LCOV_EXCLUDE_COVERAGE}
+                    --output-file ${CMAKE_BINARY_DIR}/coverage-filtered.info
+                    -q
+            WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+            BYPRODUCTS ${CMAKE_BINARY_DIR}/coverage-filtered.info
         )
 
         add_custom_target(
             coverage-report
             COMMAND
                 ${genhtml_EXECUTABLE}
-                    --output-directory ${CMAKE_CURRENT_BINARY_DIR}/coverage 
-                    --title "cmake-init test coverage"
+                    --output-directory ${CMAKE_BINARY_DIR}/coverage 
+                    --title "${META_PROJECT_NAME} Test Coverage"
                     --num-spaces 4 
-                    ${CMAKE_CURRENT_BINARY_DIR}/coverage-clean.info
-            WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-            DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/coverage-clean.info
+                    ${CMAKE_BINARY_DIR}/coverage-filtered.info
+            WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+            DEPENDS ${CMAKE_BINARY_DIR}/coverage-filtered.info
         )
 
+        add_dependencies(coverage-init coverage-zero)
+        #add_dependencies(coverage-info coverage-init)
+        add_dependencies(coverage-merge coverage-info)
+        add_dependencies(coverage-filter coverage-merge)
+        add_dependencies(coverage-report coverage-filter)
         add_dependencies(coverage coverage-report)
     endif()
 
     add_custom_target(${coverage_target}
-        COMMAND $<TARGET_FILE:${target}> --gtest_output=xml:gtests-${target}.xml
-        DEPENDS ${target}
+        COMMAND $<TARGET_FILE:${target}>
     )
-    add_dependencies(${coverage_target} coverage-init)
+    
     add_dependencies(coverage-info ${coverage_target})
+    add_dependencies(${coverage_target} coverage-init)
 
 endfunction()
diff --git a/source/examples/fibcmd/CMakeLists.txt b/source/examples/fibcmd/CMakeLists.txt
@@ -113,6 +113,8 @@ perform_health_checks(
     ${sources}
 )
 
+generate_coverage_report(${target})
+
 
 # 
 # Deployment
diff --git a/source/tests/CMakeLists.txt b/source/tests/CMakeLists.txt
@@ -70,20 +70,6 @@ target_link_libraries(gmock-dev
     gmock
 )
 
-set(DEFAULT_COMPILE_TEST_OPTIONS)
-set(DEFAULT_LINKER_TEST_OPTIONS)
-
-if(OPTION_COVERAGE_ENABLED)
-    set(DEFAULT_COMPILE_TEST_OPTIONS ${DEFAULT_COMPILE_TEST_OPTIONS}
-        -fprofile-arcs
-        -ftest-coverage
-    )
-    set(DEFAULT_LINKER_TEST_OPTIONS
-        -fprofile-arcs
-        -ftest-coverage
-    )
-endif()
-
 
 # 
 # Target 'test'
diff --git a/source/tests/fiblib-test/CMakeLists.txt b/source/tests/fiblib-test/CMakeLists.txt
@@ -88,7 +88,6 @@ target_compile_definitions(${target}
 target_compile_options(${target}
     PRIVATE
     ${DEFAULT_COMPILE_OPTIONS}
-    ${DEFAULT_COMPILE_TEST_OPTIONS}
 )
 
 
@@ -99,5 +98,4 @@ target_compile_options(${target}
 target_link_libraries(${target}
     PRIVATE
     ${DEFAULT_LINKER_OPTIONS}
-    ${DEFAULT_LINKER_TEST_OPTIONS}
 )

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`
`2`		`-# FindGcovr results:`
	`2`	`+# Findlcov results:`
`3`	`3`	`# lcov_FOUND`
`4`	`4`	`# lcov_EXECUTABLE`
`5`	`5`
`@@ -36,6 +36,7 @@ find_package_handle_standard_args(lcov`
`36`	`36`	`genhtml_EXECUTABLE`
`37`	`37`	`)`
`38`	`38`
`39`		`-mark_as_advanced(lcov_EXECUTABLE`
	`39`	`+mark_as_advanced(`
	`40`	`+ lcov_EXECUTABLE`
`40`	`41`	`genhtml_EXECUTABLE`
`41`	`42`	`)`
Original file line number	Diff line number	Diff line change
`@@ -113,6 +113,8 @@ perform_health_checks(`
`113`	`113`	`${sources}`
`114`	`114`	`)`
`115`	`115`
	`116`	`+generate_coverage_report(${target})`
	`117`	`+`
`116`	`118`
`117`	`119`	`#`
`118`	`120`	`# Deployment`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,6 @@ target_compile_definitions(${target}`
`88`	`88`	`target_compile_options(${target}`
`89`	`89`	`PRIVATE`
`90`	`90`	`${DEFAULT_COMPILE_OPTIONS}`
`91`		`- ${DEFAULT_COMPILE_TEST_OPTIONS}`
`92`	`91`	`)`
`93`	`92`
`94`	`93`
`@@ -99,5 +98,4 @@ target_compile_options(${target}`
`99`	`98`	`target_link_libraries(${target}`
`100`	`99`	`PRIVATE`
`101`	`100`	`${DEFAULT_LINKER_OPTIONS}`
`102`		`- ${DEFAULT_LINKER_TEST_OPTIONS}`
`103`	`101`	`)`