C++ code coverage support

conda/environments/rmm_dev_cuda10.1.yml

@@ -18,3 +18,4 @@ dependencies:
 - cudatoolkit=10.1
 - spdlog>=1.8.5,<1.9
 - cython>=0.29,<0.30
+- gcovr>=5.0

conda/environments/rmm_dev_cuda10.2.yml

@@ -18,3 +18,4 @@ dependencies:
 - cudatoolkit=10.2
 - spdlog>=1.8.5,<1.9
 - cython>=0.29,<0.30
+- gcovr>=5.0

conda/environments/rmm_dev_cuda11.0.yml

@@ -18,3 +18,4 @@ dependencies:
 - cudatoolkit=11.0
 - spdlog>=1.8.5,<1.9
 - cython>=0.29,<0.30
+- gcovr>=5.0

gcovr.cfg

@@ -0,0 +1,4 @@
+exclude=build/.*
+exclude=tests/.*
+html=yes
+html-details=yes

tests/CMakeLists.txt

@@ -14,8 +14,13 @@
 
 # Build options
 option(DISABLE_DEPRECATION_WARNING "Disable warnings generated from deprecated declarations." OFF)
+option(CODE_COVERAGE "Enable generating code coverage with gcov." OFF)
 
-# compiler function
+if(CODE_COVERAGE)
+  if(NOT (CMAKE_BUILD_TYPE STREQUAL "Debug"))
+    message(WARNING "Generating code coverage for optimised (non-Debug) builds not recommended")
+  endif()
+endif()
 
 # This function takes in a test name and test source and handles setting all of the associated
 # properties and linking to build the test
@@ -41,6 +46,33 @@ function(ConfigureTestInternal TEST_NAME)
                            PUBLIC $<$<COMPILE_LANGUAGE:CXX>:-Wno-deprecated-declarations>)
   endif()
 
+  if(CODE_COVERAGE)
+    if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
+
+      set(KEEP_DIR ${CMAKE_CURRENT_BINARY_DIR}/tmp)
+      make_directory(${KEEP_DIR})
+      target_compile_options(${TEST_NAME} PUBLIC $<$<COMPILE_LANGUAGE:CUDA>:--keep
+                                                 --keep-dir=${KEEP_DIR}>)
+      target_compile_options(
+        ${TEST_NAME}
+        PUBLIC
+          $<$<COMPILE_LANGUAGE:CUDA>:-Xcompiler=--coverage,-fprofile-abs-path,-fkeep-inline-functions,-fno-elide-constructors>
+      )
+      target_compile_options(
+        ${TEST_NAME} PUBLIC $<$<COMPILE_LANGUAGE:CXX>:--coverage -fprofile-abs-path
+                            -fkeep-inline-functions -fno-elide-constructors>)
+      target_link_options(${TEST_NAME} PRIVATE --coverage)
+      target_link_libraries(${TEST_NAME} gcov)
+    endif()
+
+    # Add coverage-generated files to clean target
+    list(APPEND COVERAGE_CLEAN_FILES "**/*.gcno" "**/*.gcda")
+    set_property(
+      TARGET ${TEST_NAME}
+      APPEND
+      PROPERTY ADDITIONAL_CLEAN_FILES ${COVERAGE_CLEAN_FILES})
+  endif()
+
   add_test(NAME ${TEST_NAME} COMMAND ${TEST_NAME})
 endfunction()