Run code coverage on your local machine

This change introduces a new make target called "coverage" it will
compile your code using special GCC flags, run the tests, and then
generate a nice HTML output.

This new make target will only be available if you build using GCC in
Debug mode.

To build the code coverage and open it in your browser do this:

    mkdir debug
    cd debug
    cmake -DCMAKE_BUILD_TYPE=Debug -DENABLE_COVERAGE=ON ..
    make -j20
    make coverage
    xdg-open coverage/index.html

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 2cdb9fb4858566341fd845b3d0cb2a81916f70e7..c6763469a8425bc0ba354e6a02bff241245c3bcc 100644 (file)
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -151,10 +151,62 @@ OPTION(ENABLE_XATTR "Enable extended attribute support" ON)
 OPTION(ENABLE_ACL "Enable ACL support" ON)
 OPTION(ENABLE_ICONV "Enable iconv support" ON)
 OPTION(ENABLE_TEST "Enable unit and regression tests" ON)
+OPTION(ENABLE_COVERAGE "Enable code coverage (GCC only, automatically sets ENABLE_TEST to ON)" FALSE)
 SET(POSIX_REGEX_LIB "AUTO" CACHE STRING "Choose what library should provide POSIX regular expression support")
 SET(ENABLE_SAFESEH "AUTO" CACHE STRING "Enable use of /SAFESEH linker flag (MSVC only)")
 SET(WINDOWS_VERSION "" CACHE STRING "Set Windows version to use (Windows only)")
 
+#################################################################
+# Add build target for code coverage (GCC only)
+#################################################################
+IF(ENABLE_COVERAGE)
+  # Find programs we need 
+  FIND_PROGRAM(LCOV_EXECUTABLE lcov DOC "Full path to lcov executable")
+  FIND_PROGRAM(GENHTML_EXECUTABLE genhtml DOC "Full path to genhtml executable")
+  MARK_AS_ADVANCED(LCOV_EXECUTABLE GENHTML_EXECUTABLE)
+  
+  IF(NOT CMAKE_COMPILER_IS_GNUCC)
+    MESSAGE(FATAL_ERROR "Coverage can only be built on GCC")
+  ELSEIF(NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
+    MESSAGE(FATAL_ERROR "Coverage can only be built in Debug mode")
+  ELSEIF(NOT LCOV_EXECUTABLE)
+    MESSAGE(FATAL_ERROR "lcov executable not found")
+  ELSEIF(NOT GENHTML_EXECUTABLE)
+    MESSAGE(FATAL_ERROR "genhtml executable not found")
+  ENDIF(NOT CMAKE_COMPILER_IS_GNUCC)
+
+  # Enable testing if not already done
+  SET(ENABLE_TEST ON)
+
+  #################################################################
+  # Set special compiler and linker flags for test coverage
+  #################################################################
+  # 0. Enable debug: -g
+  SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -g")
+  # 1. Disable optimizations: -O0
+  SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -O0")
+  # 2. Enable all kind of warnings:
+  SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -W")
+  # 3. Enable special coverage flag (HINT: --coverage is a synonym for -fprofile-arcs -ftest-coverage)
+  SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} --coverage")
+  SET(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} --coverage")
+  SET(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --coverage")
+  #################################################################
+
+  ADD_CUSTOM_TARGET(coverage
+    COMMAND ${CMAKE_COMMAND} -E echo "Beginning test coverage. Output is written to coverage.log."
+    COMMAND ${CMAKE_COMMAND} -E echo "COVERAGE-STEP-1/5: Reset all execution counts to zero"
+    COMMAND ${LCOV_EXECUTABLE} --directory . --zerocounters > coverage.log 2>&1
+    COMMAND ${CMAKE_COMMAND} -E echo "COVERAGE-STEP-2/5: Run testrunner"
+    COMMAND ${CMAKE_CTEST_COMMAND} >> coverage.log 2>&1
+    COMMAND ${CMAKE_COMMAND} -E echo "COVERAGE-STEP-3/5: Collect coverage data"
+    COMMAND ${LCOV_EXECUTABLE} --capture --directory . --output-file "./coverage.info" >> coverage.log 2>&1
+    COMMAND ${CMAKE_COMMAND} -E echo "COVERAGE-STEP-4/5: Generate HTML from coverage data"
+    COMMAND ${GENHTML_EXECUTABLE} "coverage.info" --title="libarchive-${LIBARCHIVE_VERSION_STRING}" --show-details --legend --output-directory "./coverage"  >> coverage.log 2>&1
+    COMMAND ${CMAKE_COMMAND} -E echo "COVERAGE-STEP-5/5: Open test coverage HTML output in browser: ./coverage/index.html"
+    COMMENT "Runs testrunner and generates coverage output (formats: .info and .html)")
+ENDIF(ENABLE_COVERAGE)
+
 IF(ENABLE_TEST)
        ENABLE_TESTING()
 ENDIF(ENABLE_TEST)