From: Sergey Bronnikov via Tarantool-patches <tarantool-patches@dev.tarantool.org> To: tarantool-patches@dev.tarantool.org, Sergey Kaplun <skaplun@tarantool.org>, max.kokryashkin@gmail.com Subject: [Tarantool-patches] [PATCH 1/2 v2] cmake: add code coverage support Date: Tue, 1 Aug 2023 21:46:08 +0300 [thread overview] Message-ID: <bce119d7dd029f179e4edc6e5afbbde8f4d097dc.1690915289.git.sergeyb@tarantool.org> (raw) In-Reply-To: <cover.1690915289.git.sergeyb@tarantool.org> From: Sergey Bronnikov <sergeyb@tarantool.org> The patch adds building code coverage report using gcovr [1] and gcov. gcovr is a better version of lcov, see [2]. There were two new CMake targets added: LuaJIT-coverage proccess *.gcno and *.gcda files with gcov, builds a detailed HTML report and prints a summary, target coverage executes LuaJIT-tests and then runs LuaJIT-coverage. Target LuaJIT-coverage is useful for building code coverage report for a custom set of regression tests. ``` $ cmake -S . -B build -DENABLE_COVERAGE=ON $ cmake --build build --parallel --target coverage <snipped> lines: 84.1% (26056 out of 30997) functions: 88.8% (2055 out of 2314) branches: 71.5% (14801 out of 20703) ``` 1. https://gcovr.com/ 2. https://gcovr.com/en/stable/faq.html#what-is-the-difference-between-lcov-and-gcovr --- CMakeLists.txt | 9 ++++++ cmake/CodeCoverage.cmake | 45 +++++++++++++++++++++++++++ test/CMakeLists.txt | 7 +++++ test/tarantool-c-tests/CMakeLists.txt | 6 +++- 4 files changed, 66 insertions(+), 1 deletion(-) create mode 100644 cmake/CodeCoverage.cmake diff --git a/CMakeLists.txt b/CMakeLists.txt index 6ef24bba..fe6582fa 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -116,6 +116,15 @@ if(LUAJIT_ENABLE_WARNINGS) ) endif() +set(LUAJIT_ENABLE_COVERAGE_DEFAULT OFF) +option(LUAJIT_ENABLE_COVERAGE + "Enable integration with gcovr, a code coverage program" + ${LUAJIT_ENABLE_COVERAGE_DEFAULT}) +if (LUAJIT_ENABLE_COVERAGE) + AppendFlags(CMAKE_C_FLAGS --coverage) + include(CodeCoverage) +endif(LUAJIT_ENABLE_COVERAGE) + # Auxiliary flags for main targets (libraries, binaries). AppendFlags(TARGET_C_FLAGS -D_FILE_OFFSET_BITS=64 diff --git a/cmake/CodeCoverage.cmake b/cmake/CodeCoverage.cmake new file mode 100644 index 00000000..2be7d129 --- /dev/null +++ b/cmake/CodeCoverage.cmake @@ -0,0 +1,45 @@ +find_program(GCOVR gcovr) +find_program(GCOV gcov) + +set(COVERAGE_DIR "${PROJECT_BINARY_DIR}/coverage") +set(COVERAGE_HTML_REPORT "${COVERAGE_DIR}/luajit.html") +set(COVERAGE_XML_REPORT "${COVERAGE_DIR}/luajit.xml") + +if(NOT GCOVR OR NOT GCOV) + add_custom_target(${PROJECT_NAME}-coverage + COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --red "LuaJIT-coverage is a dummy target" + ) + message(WARNING "Either `gcovr' or `gcov` not found, \ +so ${PROJECT_NAME}-coverage target is dummy") + return() +endif() + +file(MAKE_DIRECTORY ${COVERAGE_DIR}) +add_custom_target(${PROJECT_NAME}-coverage) +add_custom_command(TARGET ${PROJECT_NAME}-coverage + COMMENT "Building coverage report" + COMMAND + ${GCOVR} + # See https://gcovr.com/en/stable/guide/configuration.html + --root ${PROJECT_SOURCE_DIR} + --object-directory ${PROJECT_BINARY_DIR} + --filter ${PROJECT_SOURCE_DIR}/src + # Exclude DynASM files, that contain a low-level VM code for CPUs. + --exclude ".*\.dasc" + # Exclude buildvm source code, it's the project's infrastructure. + --exclude ".*/host/" + --print-summary + --output ${COVERAGE_HTML_REPORT} + --cobertura ${COVERAGE_XML_REPORT} + --html + --html-title "Tarantool LuaJIT Code Coverage Report" + --html-details + --sort-percentage + --branches + --decisions + -j ${CMAKE_BUILD_PARALLEL_LEVEL} + WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} +) + +message(STATUS "Code coverage HTML report: ${COVERAGE_HTML_REPORT}") +message(STATUS "Code coverage XML report: ${COVERAGE_XML_REPORT}") diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt index 47296a22..e23d6d45 100644 --- a/test/CMakeLists.txt +++ b/test/CMakeLists.txt @@ -76,4 +76,11 @@ if(LUAJIT_USE_TEST) ${PROJECT_NAME}-test ${PROJECT_NAME}-luacheck ) + + if (LUAJIT_ENABLE_COVERAGE) + add_custom_target(coverage DEPENDS + ${PROJECT_NAME}-test + ${PROJECT_NAME}-coverage + ) + endif (LUAJIT_ENABLE_COVERAGE) endif() diff --git a/test/tarantool-c-tests/CMakeLists.txt b/test/tarantool-c-tests/CMakeLists.txt index 17255345..d74e99fc 100644 --- a/test/tarantool-c-tests/CMakeLists.txt +++ b/test/tarantool-c-tests/CMakeLists.txt @@ -45,7 +45,11 @@ foreach(test_source ${tests}) OUTPUT_NAME "${exe}${C_TEST_SUFFIX}" RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}" ) - target_link_libraries(${exe} libtest ${LUAJIT_LIBRARY}) + set(libtest-libs libtest ${LUAJIT_LIBRARY}) + if (LUAJIT_ENABLE_COVERAGE) + set(libtest-libs ${libtest-libs} --coverage) + endif (LUAJIT_ENABLE_COVERAGE) + target_link_libraries(${exe} ${libtest-libs}) LIST(APPEND TESTS_COMPILED ${exe}) endforeach() -- 2.34.1
next prev parent reply other threads:[~2023-08-01 18:48 UTC|newest] Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top 2023-08-01 18:46 [Tarantool-patches] [PATCH 0/2 v2] Add " Sergey Bronnikov via Tarantool-patches 2023-08-01 18:46 ` Sergey Bronnikov via Tarantool-patches [this message] 2023-08-02 8:06 ` [Tarantool-patches] [PATCH 1/2 v2] cmake: add " Maxim Kokryashkin via Tarantool-patches 2023-08-02 8:18 ` Sergey Bronnikov via Tarantool-patches 2023-08-06 11:35 ` Sergey Kaplun via Tarantool-patches 2023-08-07 13:39 ` Sergey Bronnikov via Tarantool-patches 2023-08-15 8:41 ` Maxim Kokryashkin via Tarantool-patches 2023-08-01 18:46 ` [Tarantool-patches] [PATCH 2/2 v2] ci: support coveralls Sergey Bronnikov via Tarantool-patches 2023-08-02 8:18 ` Maxim Kokryashkin via Tarantool-patches 2023-08-02 8:20 ` Sergey Bronnikov via Tarantool-patches 2023-08-06 11:41 ` Sergey Kaplun via Tarantool-patches 2023-08-07 11:32 ` Sergey Bronnikov via Tarantool-patches 2023-08-21 11:05 ` [Tarantool-patches] [PATCH 0/2 v2] Add code coverage support Igor Munkin via Tarantool-patches
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=bce119d7dd029f179e4edc6e5afbbde8f4d097dc.1690915289.git.sergeyb@tarantool.org \ --to=tarantool-patches@dev.tarantool.org \ --cc=estetus@gmail.com \ --cc=max.kokryashkin@gmail.com \ --cc=skaplun@tarantool.org \ --subject='Re: [Tarantool-patches] [PATCH 1/2 v2] cmake: add code coverage support' \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox