CMake: major improvements of unit tests and code converage

The collector doesn't depend on GoogleTest package provided by OS anymore.
Instead it downloads predefined version directly from official GitHub page.
Converage build mode has been replaced by new configuration option ENABLE_TESTS_COVERAGE.

Author: Lukas955

CMakeLists.txt

@@ -39,25 +39,23 @@ if (NOT COMPILER_SUPPORT_GNUXX11)
 endif()
 
 # ------------------------------------------------------------------------------
-# Build options
-set(TESTS_DEFAULT    OFF)
-
 # Set default build type if not specified by user
-if (NOT CMAKE_BUILD_TYPE)
-    set (CMAKE_BUILD_TYPE Release
-        CACHE STRING "Choose type of build (Release/Debug/Coverage)." FORCE)
-endif()
-
-string(TOUPPER ${CMAKE_BUILD_TYPE} BUILD_TYPE_UPPER)
-# Enable unit tests, by default, for coverage builds
-if (${BUILD_TYPE_UPPER} STREQUAL "COVERAGE")
-    set(TESTS_DEFAULT ON)
+set(DEFAULT_BUILD_TYPE "Release")
+if (NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
+    # Use the default build type if not specified
+    message(STATUS "Setting build type to '${DEFAULT_BUILD_TYPE}' as none was specified.")
+    set(CMAKE_BUILD_TYPE "${DEFAULT_BUILD_TYPE}" CACHE
+        STRING "Choose the type of build." FORCE)
+    # Set the possible values of build type for cmake-gui
+    set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS
+        "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
 endif()
 
 option(ENABLE_DOC_MANPAGE    "Enable manual page building"              ON)
 option(ENABLE_DOC_DOXYGEN    "Enable code documentation building"       OFF)
-option(ENABLE_TESTS          "Build Unit tests (make test)"     ${TESTS_DEFAULT})
+option(ENABLE_TESTS          "Build Unit tests (make test)"             OFF)
 option(ENABLE_TESTS_VALGRIND "Build Unit tests with Valgrind Memcheck"  OFF)
+option(ENABLE_TESTS_COVERAGE "Enable support for code coverage"         OFF)
 option(PACKAGE_BUILDER_RPM   "Enable RPM package builder (make rpm)"    OFF)
 option(PACKAGE_BUILDER_DEB   "Enable DEB package builder (make deb)"    OFF)
 
@@ -68,11 +66,15 @@ option(PACKAGE_BUILDER_DEB   "Enable DEB package builder (make deb)"    OFF)
 set(CMAKE_C_FLAGS            "${CMAKE_C_FLAGS} -fvisibility=hidden -std=gnu11")
 set(CMAKE_C_FLAGS_RELEASE    "-O2 -DNDEBUG")
 set(CMAKE_C_FLAGS_DEBUG      "-g -O0 -Wall -Wextra -pedantic")
-set(CMAKE_C_FLAGS_COVERAGE   "${CMAKE_C_FLAGS_DEBUG} --coverage -fprofile-arcs -ftest-coverage")
 set(CMAKE_CXX_FLAGS          "${CMAKE_CXX_FLAGS} -fvisibility=hidden -std=gnu++11")
 set(CMAKE_CXX_FLAGS_RELEASE  "-O2 -DNDEBUG")
 set(CMAKE_CXX_FLAGS_DEBUG    "-g -O0 -Wall -Wextra -pedantic")
-set(CMAKE_CXX_FLAGS_COVERAGE "${CMAKE_CXX_FLAGS_DEBUG} --coverage -fprofile-arcs -ftest-coverage")
+
+if (ENABLE_TESTS AND ENABLE_TESTS_COVERAGE)
+    # Additional flags for code coverage
+    set(CMAKE_C_FLAGS    "${CMAKE_C_FLAGS}   --coverage -fprofile-arcs -ftest-coverage")
+    set(CMAKE_CXX_FLAGS  "${CMAKE_CXX_FLAGS} --coverage -fprofile-arcs -ftest-coverage")
+endif()
 
 # ------------------------------------------------------------------------------
 # Project components
@@ -88,6 +90,7 @@ endif()
 
 # ------------------------------------------------------------------------------
 # Status messages
+string(TOUPPER ${CMAKE_BUILD_TYPE} BUILD_TYPE_UPPER)
 MESSAGE(STATUS
     "\n\n"
     "IPFIXcol version.:   ${IPFIXCOL_VERSION}\n"

CMakeModules/unit_tests.cmake

@@ -1,10 +1,65 @@
 # ------------------------------------------------------------------------------
 # Download GTest
 
-# GTest required threads support
+# Source: https://gist.github.com/ClintLiddick/51deffb768a7319e715071aa7bd3a3ab
+
 find_package(Threads REQUIRED)
-find_package(GTest 1.6.0 REQUIRED)
-include_directories(${GTEST_INCLUDE_DIRS})
+
+include(ExternalProject)
+ExternalProject_Add(
+  googletest
+  GIT_REPOSITORY   https://github.com/google/googletest.git
+  GIT_TAG          "release-1.8.1"
+  UPDATE_COMMAND   ""
+  INSTALL_COMMAND  ""
+  LOG_DOWNLOAD     ON
+  LOG_CONFIGURE    ON
+  LOG_BUILD        ON
+)
+
+ExternalProject_Get_Property(googletest source_dir)
+set(GTEST_INCLUDE_DIRS ${source_dir}/googletest/include)
+set(GMOCK_INCLUDE_DIRS ${source_dir}/googlemock/include)
+
+ExternalProject_Get_Property(googletest binary_dir)
+set(GTEST_LIBRARY_PATH ${binary_dir}/googlemock/gtest/${CMAKE_FIND_LIBRARY_PREFIXES}gtest.a)
+set(GTEST_LIBRARY gtest)
+add_library(${GTEST_LIBRARY} UNKNOWN IMPORTED)
+set_target_properties(${GTEST_LIBRARY} PROPERTIES
+  IMPORTED_LOCATION ${GTEST_LIBRARY_PATH}
+  IMPORTED_LINK_INTERFACE_LIBRARIES ${CMAKE_THREAD_LIBS_INIT})
+add_dependencies(${GTEST_LIBRARY} googletest)
+
+set(GTEST_MAIN_LIBRARY_PATH ${binary_dir}/googlemock/gtest/${CMAKE_FIND_LIBRARY_PREFIXES}gtest_main.a)
+set(GTEST_MAIN_LIBRARY gtest_main)
+add_library(${GTEST_MAIN_LIBRARY} UNKNOWN IMPORTED)
+set_target_properties(${GTEST_MAIN_LIBRARY} PROPERTIES
+  IMPORTED_LOCATION ${GTEST_MAIN_LIBRARY_PATH}
+  IMPORTED_LINK_INTERFACE_LIBRARIES ${CMAKE_THREAD_LIBS_INIT})
+add_dependencies(${GTEST_MAIN_LIBRARY} googletest)
+
+set(GMOCK_LIBRARY_PATH ${binary_dir}/googlemock/${CMAKE_FIND_LIBRARY_PREFIXES}gmock.a)
+set(GMOCK_LIBRARY gmock)
+add_library(${GMOCK_LIBRARY} UNKNOWN IMPORTED)
+set_target_properties(${GMOCK_LIBRARY} PROPERTIES
+  IMPORTED_LOCATION ${GMOCK_LIBRARY_PATH}
+  IMPORTED_LINK_INTERFACE_LIBRARIES ${CMAKE_THREAD_LIBS_INIT})
+add_dependencies(${GMOCK_LIBRARY} googletest)
+
+set(GMOCK_MAIN_LIBRARY_PATH ${binary_dir}/googlemock/${CMAKE_FIND_LIBRARY_PREFIXES}gmock_main.a)
+set(GMOCK_MAIN_LIBRARY gmock_main)
+add_library(${GMOCK_MAIN_LIBRARY} UNKNOWN IMPORTED)
+set_target_properties(${GMOCK_MAIN_LIBRARY} PROPERTIES
+  IMPORTED_LOCATION ${GMOCK_MAIN_LIBRARY_PATH}
+  IMPORTED_LINK_INTERFACE_LIBRARIES ${CMAKE_THREAD_LIBS_INIT})
+add_dependencies(${GMOCK_MAIN_LIBRARY} ${GTEST_LIBRARY})
+
+include_directories(
+    ${GTEST_INCLUDE_DIRS}
+    ${GMOCK_INCLUDE_DIRS}
+)
+
+message (STATUS "Include dirs: " ${GTEST_INCLUDE_DIRS} ${GMOCK_INCLUDE_DIRS})
 
 # ------------------------------------------------------------------------------
 # Valgrind
@@ -40,7 +95,7 @@ function(unit_tests_register_test _file)
 
     # Add executable
     add_executable(${CASE_NAME} ${ARGV})
-    target_link_libraries(${CASE_NAME} PUBLIC ${GTEST_LIBRARIES} ipfixcol2base)
+    target_link_libraries(${CASE_NAME} PUBLIC ${GTEST_LIBRARY} ${GMOCK_LIBRARY} ipfixcol2base)
 
     # Add the test
     add_test(NAME ${CASE_NAME} COMMAND "$<TARGET_FILE:${CASE_NAME}>")
@@ -60,7 +115,7 @@ endfunction()
 function(unit_tests_register_target _target)
     # Get a test name
     set(CASE_NAME "test_${_target}")
-    target_link_libraries(${_target} PUBLIC ${GTEST_LIBRARIES})
+    target_link_libraries(${_target} PUBLIC ${GTEST_LIBRARY} ${GMOCK_LIBRARY})
 
     # Add test(s)
     add_test(NAME ${CASE_NAME} COMMAND "$<TARGET_FILE:${_target}>")
@@ -111,7 +166,7 @@ function(coverage_add_target)
         COMMAND "${PATH_LCOV}" --directory . --zerocounters --quiet
 
         # Run tests
-        COMMAND "${CMAKE_CTEST_COMMAND}" --quiet
+        COMMAND "${CMAKE_CTEST_COMMAND}"
 
         # Capture the counters
         COMMAND "${PATH_LCOV}"
@@ -122,7 +177,7 @@ function(coverage_add_target)
             --output-file "${COVERAGE_FILE_RAW}"
         # Remove coverage of Google Test files, system headers, etc.
         COMMAND "${PATH_LCOV}"
-            --remove "${COVERAGE_FILE_RAW}" 'gtest/*' 'tests/*' '/usr/*'
+            --remove "${COVERAGE_FILE_RAW}" '${CMAKE_BINARY_DIR}/*' '${CMAKE_SOURCE_DIR}/tests/*' '/usr/*'
             --rc lcov_branch_coverage=1
             --quiet --output-file "${COVERAGE_FILE_CLEAN}"
         # Generate HTML report
@@ -139,8 +194,5 @@ function(coverage_add_target)
         WORKING_DIRECTORY "${CMAKE_BINARY_DIR}"
         COMMENT "To see the coverage report, open ${COVERAGE_DIR}index.html"
         COMMAND ;
-        )
-
-endfunction()
-
-
+    )
+endfunction()

tests/unit/CMakeLists.txt

@@ -17,7 +17,6 @@ add_subdirectory(core/netflow)
 
 # Enable code coverage target (i.e. make coverage) when appropriate build
 # type is chosen.
-if (${BUILD_TYPE_UPPER} STREQUAL "COVERAGE")
+if (ENABLE_TESTS AND ENABLE_TESTS_COVERAGE)
     coverage_add_target()
 endif()
-