Get coverage to cover all test files. (#1885)

Get coverage to cover all test files. To get the coverage, just run: ``` cmake ../ -DAVIF_ENABLE_COVERAGE=ON -DAVIF_CODEC_AOM=LOCAL -DAVIF_BUILD_TESTS=ON -DAVIF_LOCAL_GTEST=ON -DAVIF_BUILD_APPS=ON -DAVIF_CODEC_AOM_DECODE=ON -DAVIF_CODEC_AOM_ENCODE=ON make -j avif_coverage ```
AOMediaCodec · Dec 18, 2023 · 1d3825f · 1d3825f
1 parent 3471f30
commit 1d3825f
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 15 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -302,10 +302,12 @@ if(AVIF_ENABLE_COVERAGE)
     if(CMAKE_C_COMPILER_ID MATCHES "Clang" OR CMAKE_C_COMPILER_ID MATCHES "GNU")
         message(STATUS "libavif: Enabling coverage for Clang")
         target_compile_options(avif_obj PUBLIC $<BUILD_INTERFACE:-fprofile-instr-generate -fcoverage-mapping -O0>)
+        target_compile_options(avif PUBLIC $<BUILD_INTERFACE:-fprofile-instr-generate -fcoverage-mapping -O0>)
         set(CMAKE_EXE_LINKER_FLAGS ${CMAKE_EXE_LINKER_FLAGS} "-fprofile-instr-generate -fcoverage-mapping")
     else()
         # TODO: Add support for other compilers
         message(WARNING "libavif: Ignoring request for coverage (AVIF_ENABLE_COVERAGE); only clang is currently supported.")
+        set(AVIF_ENABLE_COVERAGE OFF)
     endif()
 endif()
 

diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
@@ -8,27 +8,27 @@ enable_testing()
 ################################################################################
 # C tests and tools
 
+set(COVERAGE_TARGETS)
+# Macro to register a test for coverage. The first argument is the target name.
+# Other arguments, like data path, can be added.
+macro(register_test_for_coverage TEST_NAME)
+    if(AVIF_ENABLE_COVERAGE)
+        add_custom_target(
+            ${TEST_NAME}_coverage
+            COMMAND ${CMAKE_COMMAND} -E env "LLVM_PROFILE_FILE=${CMAKE_CURRENT_BINARY_DIR}/${TEST_NAME}.profraw"
+                    $<TARGET_FILE:${TEST_NAME}> ${ARGN}
+        )
+        list(APPEND COVERAGE_TARGETS ${TEST_NAME})
+    endif()
+endmacro()
+
 add_executable(aviftest aviftest.c)
 if(AVIF_CODEC_LIBGAV1_ENABLED)
     set_target_properties(aviftest PROPERTIES LINKER_LANGUAGE "CXX")
 endif()
 target_link_libraries(aviftest avif)
 add_test(NAME aviftest COMMAND aviftest ${CMAKE_CURRENT_SOURCE_DIR}/data)
-
-if(AVIF_ENABLE_COVERAGE)
-    add_custom_target(
-        avif_coverage
-        COMMAND ${CMAKE_COMMAND} -E env "LLVM_PROFILE_FILE=${CMAKE_CURRENT_BINARY_DIR}/aviftest.profraw" $<TARGET_FILE:aviftest>
-                ${CMAKE_CURRENT_SOURCE_DIR}/data
-        COMMAND ${XCRUN} llvm-profdata merge -sparse ${CMAKE_CURRENT_BINARY_DIR}/aviftest.profraw -o
-                ${CMAKE_CURRENT_BINARY_DIR}/aviftest.profdata
-        COMMAND cmake -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/coverage
-        COMMAND ${XCRUN} llvm-cov show $<TARGET_FILE:aviftest> -instr-profile=${CMAKE_CURRENT_BINARY_DIR}/aviftest.profdata
-                -project-title=libavif --format html -output-dir=${CMAKE_CURRENT_BINARY_DIR}/coverage
-        COMMAND echo Coverage report here: ${CMAKE_CURRENT_BINARY_DIR}/coverage/index.html
-        DEPENDS aviftest
-    )
-endif()
+register_test_for_coverage(aviftest ${CMAKE_CURRENT_SOURCE_DIR}/data/)
 
 add_executable(avifyuv avifyuv.c)
 if(AVIF_CODEC_LIBGAV1_ENABLED)
@@ -67,21 +67,25 @@ macro(add_avif_gtest TEST_NAME)
     add_executable(${TEST_NAME} gtest/${TEST_NAME}.cc)
     target_link_libraries(${TEST_NAME} PRIVATE aviftest_helpers GTest::gtest GTest::gtest_main ${ARGN})
     add_test(NAME ${TEST_NAME} COMMAND ${TEST_NAME})
+    register_test_for_coverage(${TEST_NAME})
 endmacro()
 macro(add_avif_internal_gtest TEST_NAME)
     add_executable(${TEST_NAME} gtest/${TEST_NAME}.cc)
     target_link_libraries(${TEST_NAME} PRIVATE aviftest_helpers_internal GTest::gtest GTest::gtest_main ${ARGN})
     add_test(NAME ${TEST_NAME} COMMAND ${TEST_NAME})
+    register_test_for_coverage(${TEST_NAME})
 endmacro()
 macro(add_avif_gtest_with_data TEST_NAME)
     add_executable(${TEST_NAME} gtest/${TEST_NAME}.cc)
     target_link_libraries(${TEST_NAME} PRIVATE aviftest_helpers GTest::gtest ${ARGN})
     add_test(NAME ${TEST_NAME} COMMAND ${TEST_NAME} ${CMAKE_CURRENT_SOURCE_DIR}/data/)
+    register_test_for_coverage(${TEST_NAME} ${CMAKE_CURRENT_SOURCE_DIR}/data/)
 endmacro()
 macro(add_avif_internal_gtest_with_data TEST_NAME)
     add_executable(${TEST_NAME} gtest/${TEST_NAME}.cc)
     target_link_libraries(${TEST_NAME} PRIVATE aviftest_helpers_internal GTest::gtest ${ARGN})
     add_test(NAME ${TEST_NAME} COMMAND ${TEST_NAME} ${CMAKE_CURRENT_SOURCE_DIR}/data/)
+    register_test_for_coverage(${TEST_NAME} ${CMAKE_CURRENT_SOURCE_DIR}/data/)
 endmacro()
 
 if(AVIF_ENABLE_GTEST OR AVIF_ENABLE_FUZZTEST)
@@ -129,6 +133,7 @@ if(AVIF_ENABLE_GTEST)
     add_executable(avifincrtest gtest/avifincrtest.cc)
     target_link_libraries(avifincrtest aviftest_helpers avifincrtest_helpers)
     add_test(NAME avifincrtest COMMAND avifincrtest ${CMAKE_CURRENT_SOURCE_DIR}/data/)
+    register_test_for_coverage(avifincrtest ${CMAKE_CURRENT_SOURCE_DIR}/data/)
 
     add_avif_internal_gtest(avifcolrtest)
     add_avif_internal_gtest_with_data(avifcolrconverttest)
@@ -360,3 +365,26 @@ if(AVIF_CODEC_AVM_ENABLED)
         endif()
     endif()
 endif()
+
+if(AVIF_ENABLE_COVERAGE)
+    set(MERGE_COMMAND llvm-profdata merge)
+    set(SHOW_COMMAND llvm-cov show --ignore-filename-regex=.*/tests/.* --ignore-filename-regex=.*/third_party/.*)
+    foreach(TARGET ${COVERAGE_TARGETS})
+        list(APPEND MERGE_COMMAND -sparse ${CMAKE_CURRENT_BINARY_DIR}/${TARGET}.profraw)
+        list(APPEND SHOW_COMMAND -object $<TARGET_FILE:${TARGET}>)
+    endforeach()
+    list(APPEND MERGE_COMMAND -o ${CMAKE_CURRENT_BINARY_DIR}/avif_coverage.profdata)
+    list(APPEND SHOW_COMMAND -instr-profile=${CMAKE_CURRENT_BINARY_DIR}/avif_coverage.profdata -project-title=libavif --format
+         html -output-dir=${CMAKE_CURRENT_BINARY_DIR}/coverage
+    )
+    add_custom_target(
+        avif_coverage
+        COMMAND ${XCRUN} ${MERGE_COMMAND}
+        COMMAND cmake -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/coverage
+        COMMAND ${XCRUN} ${SHOW_COMMAND}
+        COMMAND echo Coverage report here: ${CMAKE_CURRENT_BINARY_DIR}/coverage/index.html
+    )
+    foreach(TARGET ${COVERAGE_TARGETS})
+        add_dependencies(avif_coverage ${TARGET}_coverage)
+    endforeach()
+endif()