mirror of
https://github.com/swaywm/sway.git
synced 2024-12-01 19:06:38 +00:00
Simplify code coverage implementation
This commit is contained in:
Drew DeVault
parent
074238e9f4
commit
8758a2bd04
|
|
@ -1,184 +0,0 @@
|
||||||
# Copyright (c) 2012 - 2015, Lars Bilke
|
|
||||||
# All rights reserved.
|
|
||||||
#
|
|
||||||
# Redistribution and use in source and binary forms, with or without modification,
|
|
||||||
# are permitted provided that the following conditions are met:
|
|
||||||
#
|
|
||||||
# 1. Redistributions of source code must retain the above copyright notice, this
|
|
||||||
# list of conditions and the following disclaimer.
|
|
||||||
#
|
|
||||||
# 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
||||||
# this list of conditions and the following disclaimer in the documentation
|
|
||||||
# and/or other materials provided with the distribution.
|
|
||||||
#
|
|
||||||
# 3. Neither the name of the copyright holder nor the names of its contributors
|
|
||||||
# may be used to endorse or promote products derived from this software without
|
|
||||||
# specific prior written permission.
|
|
||||||
#
|
|
||||||
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
||||||
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
||||||
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
||||||
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
|
|
||||||
# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
||||||
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
||||||
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
|
||||||
# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
||||||
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
||||||
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
||||||
#
|
|
||||||
#
|
|
||||||
#
|
|
||||||
# 2012-01-31, Lars Bilke
|
|
||||||
# - Enable Code Coverage
|
|
||||||
#
|
|
||||||
# 2013-09-17, Joakim Söderberg
|
|
||||||
# - Added support for Clang.
|
|
||||||
# - Some additional usage instructions.
|
|
||||||
#
|
|
||||||
# USAGE:
|
|
||||||
|
|
||||||
# 0. (Mac only) If you use Xcode 5.1 make sure to patch geninfo as described here:
|
|
||||||
# http://stackoverflow.com/a/22404544/80480
|
|
||||||
#
|
|
||||||
# 1. Copy this file into your cmake modules path.
|
|
||||||
#
|
|
||||||
# 2. Add the following line to your CMakeLists.txt:
|
|
||||||
# INCLUDE(CodeCoverage)
|
|
||||||
#
|
|
||||||
# 3. Set compiler flags to turn off optimization and enable coverage:
|
|
||||||
# SET(CMAKE_CXX_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage")
|
|
||||||
# SET(CMAKE_C_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage")
|
|
||||||
#
|
|
||||||
# 3. Use the function SETUP_TARGET_FOR_COVERAGE to create a custom make target
|
|
||||||
# which runs your test executable and produces a lcov code coverage report:
|
|
||||||
# Example:
|
|
||||||
# SETUP_TARGET_FOR_COVERAGE(
|
|
||||||
# my_coverage_target # Name for custom target.
|
|
||||||
# test_driver # Name of the test driver executable that runs the tests.
|
|
||||||
# # NOTE! This should always have a ZERO as exit code
|
|
||||||
# # otherwise the coverage generation will not complete.
|
|
||||||
# coverage # Name of output directory.
|
|
||||||
# )
|
|
||||||
#
|
|
||||||
# 4. Build a Debug build:
|
|
||||||
# cmake -DCMAKE_BUILD_TYPE=Debug ..
|
|
||||||
# make
|
|
||||||
# make my_coverage_target
|
|
||||||
#
|
|
||||||
#
|
|
||||||
|
|
||||||
# Check prereqs
|
|
||||||
FIND_PROGRAM( GCOV_PATH gcov )
|
|
||||||
FIND_PROGRAM( LCOV_PATH lcov )
|
|
||||||
FIND_PROGRAM( GENHTML_PATH genhtml )
|
|
||||||
FIND_PROGRAM( GCOVR_PATH gcovr PATHS ${CMAKE_SOURCE_DIR}/tests)
|
|
||||||
|
|
||||||
IF(NOT GCOV_PATH)
|
|
||||||
MESSAGE(FATAL_ERROR "gcov not found! Aborting...")
|
|
||||||
ENDIF() # NOT GCOV_PATH
|
|
||||||
|
|
||||||
SET(CMAKE_CXX_FLAGS_COVERAGE
|
|
||||||
"-g -O0 --coverage -fprofile-arcs -ftest-coverage"
|
|
||||||
CACHE STRING "Flags used by the C++ compiler during coverage builds."
|
|
||||||
FORCE )
|
|
||||||
SET(CMAKE_C_FLAGS_COVERAGE
|
|
||||||
"-g -O0 --coverage -fprofile-arcs -ftest-coverage"
|
|
||||||
CACHE STRING "Flags used by the C compiler during coverage builds."
|
|
||||||
FORCE )
|
|
||||||
SET(CMAKE_EXE_LINKER_FLAGS_COVERAGE
|
|
||||||
""
|
|
||||||
CACHE STRING "Flags used for linking binaries during coverage builds."
|
|
||||||
FORCE )
|
|
||||||
SET(CMAKE_SHARED_LINKER_FLAGS_COVERAGE
|
|
||||||
""
|
|
||||||
CACHE STRING "Flags used by the shared libraries linker during coverage builds."
|
|
||||||
FORCE )
|
|
||||||
MARK_AS_ADVANCED(
|
|
||||||
CMAKE_CXX_FLAGS_COVERAGE
|
|
||||||
CMAKE_C_FLAGS_COVERAGE
|
|
||||||
CMAKE_EXE_LINKER_FLAGS_COVERAGE
|
|
||||||
CMAKE_SHARED_LINKER_FLAGS_COVERAGE )
|
|
||||||
|
|
||||||
IF ( NOT (CMAKE_BUILD_TYPE STREQUAL "Debug" OR CMAKE_BUILD_TYPE STREQUAL "Coverage"))
|
|
||||||
MESSAGE( WARNING "Code coverage results with an optimized (non-Debug) build may be misleading" )
|
|
||||||
ENDIF() # NOT CMAKE_BUILD_TYPE STREQUAL "Debug"
|
|
||||||
|
|
||||||
|
|
||||||
# Param _targetname The name of new the custom make target
|
|
||||||
# Param _testrunner The name of the target which runs the tests.
|
|
||||||
# MUST return ZERO always, even on errors.
|
|
||||||
# If not, no coverage report will be created!
|
|
||||||
# Param _outputname lcov output is generated as _outputname.info
|
|
||||||
# HTML report is generated in _outputname/index.html
|
|
||||||
# Optional fourth parameter is passed as arguments to _testrunner
|
|
||||||
# Pass them in list form, e.g.: "-j;2" for -j 2
|
|
||||||
FUNCTION(SETUP_TARGET_FOR_COVERAGE _targetname _testrunner _outputname)
|
|
||||||
|
|
||||||
IF(NOT LCOV_PATH)
|
|
||||||
MESSAGE(FATAL_ERROR "lcov not found! Aborting...")
|
|
||||||
ENDIF() # NOT LCOV_PATH
|
|
||||||
|
|
||||||
IF(NOT GENHTML_PATH)
|
|
||||||
MESSAGE(FATAL_ERROR "genhtml not found! Aborting...")
|
|
||||||
ENDIF() # NOT GENHTML_PATH
|
|
||||||
|
|
||||||
# Setup target
|
|
||||||
ADD_CUSTOM_TARGET(${_targetname}
|
|
||||||
|
|
||||||
# Cleanup lcov
|
|
||||||
${LCOV_PATH} --directory . --zerocounters
|
|
||||||
|
|
||||||
# Run tests
|
|
||||||
COMMAND ${_testrunner} ${ARGV3}
|
|
||||||
|
|
||||||
# Capturing lcov counters and generating report
|
|
||||||
COMMAND ${LCOV_PATH} --directory . --capture --output-file ${_outputname}.info
|
|
||||||
COMMAND ${LCOV_PATH} --remove ${_outputname}.info 'tests/*' '/usr/*' --output-file ${_outputname}.info.cleaned
|
|
||||||
COMMAND ${GENHTML_PATH} -o ${_outputname} ${_outputname}.info.cleaned
|
|
||||||
COMMAND ${CMAKE_COMMAND} -E remove ${_outputname}.info ${_outputname}.info.cleaned
|
|
||||||
|
|
||||||
WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
|
|
||||||
COMMENT "Resetting code coverage counters to zero.\nProcessing code coverage counters and generating report."
|
|
||||||
)
|
|
||||||
|
|
||||||
# Show info where to find the report
|
|
||||||
ADD_CUSTOM_COMMAND(TARGET ${_targetname} POST_BUILD
|
|
||||||
COMMAND ;
|
|
||||||
COMMENT "Open ./${_outputname}/index.html in your browser to view the coverage report."
|
|
||||||
)
|
|
||||||
|
|
||||||
ENDFUNCTION() # SETUP_TARGET_FOR_COVERAGE
|
|
||||||
|
|
||||||
# Param _targetname The name of new the custom make target
|
|
||||||
# Param _testrunner The name of the target which runs the tests
|
|
||||||
# Param _outputname cobertura output is generated as _outputname.xml
|
|
||||||
# Optional fourth parameter is passed as arguments to _testrunner
|
|
||||||
# Pass them in list form, e.g.: "-j;2" for -j 2
|
|
||||||
FUNCTION(SETUP_TARGET_FOR_COVERAGE_COBERTURA _targetname _testrunner _outputname)
|
|
||||||
|
|
||||||
IF(NOT PYTHON_EXECUTABLE)
|
|
||||||
MESSAGE(FATAL_ERROR "Python not found! Aborting...")
|
|
||||||
ENDIF() # NOT PYTHON_EXECUTABLE
|
|
||||||
|
|
||||||
IF(NOT GCOVR_PATH)
|
|
||||||
MESSAGE(FATAL_ERROR "gcovr not found! Aborting...")
|
|
||||||
ENDIF() # NOT GCOVR_PATH
|
|
||||||
|
|
||||||
ADD_CUSTOM_TARGET(${_targetname}
|
|
||||||
|
|
||||||
# Run tests
|
|
||||||
${_testrunner} ${ARGV3}
|
|
||||||
|
|
||||||
# Running gcovr
|
|
||||||
COMMAND ${GCOVR_PATH} -x -r ${CMAKE_SOURCE_DIR} -e '${CMAKE_SOURCE_DIR}/tests/' -o ${_outputname}.xml
|
|
||||||
WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
|
|
||||||
COMMENT "Running gcovr to produce Cobertura code coverage report."
|
|
||||||
)
|
|
||||||
|
|
||||||
# Show info where to find the report
|
|
||||||
ADD_CUSTOM_COMMAND(TARGET ${_targetname} POST_BUILD
|
|
||||||
COMMAND ;
|
|
||||||
COMMENT "Cobertura code coverage report saved in ${_outputname}.xml."
|
|
||||||
)
|
|
||||||
|
|
||||||
ENDFUNCTION() # SETUP_TARGET_FOR_COVERAGE_COBERTURA
|
|
||||||
|
|
@ -1,5 +1,3 @@
|
||||||
find_package(A2X REQUIRED)
|
|
||||||
|
|
||||||
function(configure_test)
|
function(configure_test)
|
||||||
set(options)
|
set(options)
|
||||||
set(oneValueArgs NAME SUBPROJECT)
|
set(oneValueArgs NAME SUBPROJECT)
|
||||||
|
|
@ -25,7 +23,7 @@ function(configure_test)
|
||||||
list(APPEND CONFIGURE_TEST_WRAPPERS "malloc" "calloc" "realloc" "free")
|
list(APPEND CONFIGURE_TEST_WRAPPERS "malloc" "calloc" "realloc" "free")
|
||||||
|
|
||||||
if (enable-coverage)
|
if (enable-coverage)
|
||||||
add_compile_options(-g -O0 --coverage -fprofile-arcs -ftest-coverage)
|
add_definitions(-g -O0 --coverage -fprofile-arcs -ftest-coverage)
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
list(LENGTH CONFIGURE_TEST_WRAPPERS WRAPPED_COUNT)
|
list(LENGTH CONFIGURE_TEST_WRAPPERS WRAPPED_COUNT)
|
||||||
|
|
@ -51,10 +49,5 @@ function(configure_test)
|
||||||
|
|
||||||
if (enable-coverage)
|
if (enable-coverage)
|
||||||
target_link_libraries(${CONFIGURE_TEST_NAME}_test gcov)
|
target_link_libraries(${CONFIGURE_TEST_NAME}_test gcov)
|
||||||
setup_target_for_coverage(
|
|
||||||
${CONFIGURE_TEST_NAME}_cov
|
|
||||||
${CONFIGURE_TEST_NAME}_test
|
|
||||||
${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/coverage
|
|
||||||
)
|
|
||||||
endif()
|
endif()
|
||||||
endfunction()
|
endfunction()
|
||||||
|
|
|
||||||
|
|
@ -135,9 +135,6 @@ install(
|
||||||
|
|
||||||
if(enable-tests)
|
if(enable-tests)
|
||||||
if (CMOCKA_FOUND)
|
if (CMOCKA_FOUND)
|
||||||
if(enable-coverage)
|
|
||||||
include(CodeCoverage)
|
|
||||||
endif()
|
|
||||||
add_subdirectory(test)
|
add_subdirectory(test)
|
||||||
else()
|
else()
|
||||||
message(WARNING "Not buliding tests - cmocka is required.")
|
message(WARNING "Not buliding tests - cmocka is required.")
|
||||||
|
|
|
||||||
|
|
@ -4,4 +4,19 @@ add_subdirectory(common)
|
||||||
|
|
||||||
add_custom_target(check
|
add_custom_target(check
|
||||||
WORKING_DIRECTORY ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}
|
WORKING_DIRECTORY ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}
|
||||||
COMMAND ${CMAKE_SOURCE_DIR}/test/runner)
|
COMMAND ${CMAKE_SOURCE_DIR}/test/runner "${CMAKE_BINARY_DIR}")
|
||||||
|
|
||||||
|
if(enable-coverage)
|
||||||
|
find_program(GCOV_PATH gcov)
|
||||||
|
find_program(LCOV_PATH lcov)
|
||||||
|
find_program(GENHTML_PATH genhtml)
|
||||||
|
if(NOT GCOV_PATH)
|
||||||
|
MESSAGE(FATAL_ERROR "gcov not found! Aborting...")
|
||||||
|
endif()
|
||||||
|
if(NOT LCOV_PATH)
|
||||||
|
MESSAGE(FATAL_ERROR "gcov not found! Aborting...")
|
||||||
|
endif()
|
||||||
|
if(NOT GENHTML_PATH)
|
||||||
|
MESSAGE(FATAL_ERROR "gcov not found! Aborting...")
|
||||||
|
endif()
|
||||||
|
endif()
|
||||||
|
|
|
||||||
13
test/runner
13
test/runner
|
|
@ -8,4 +8,17 @@ do
|
||||||
ret+=$?
|
ret+=$?
|
||||||
done
|
done
|
||||||
|
|
||||||
|
if grep 'enable-coverage:BOOL=YES' "$1/CMakeCache.txt"
|
||||||
|
then
|
||||||
|
echo "Generating coverage reports"
|
||||||
|
rm -rf "$1/coverage"
|
||||||
|
mkdir "$1/coverage"
|
||||||
|
lcov --directory "$1" \
|
||||||
|
--capture \
|
||||||
|
--output-file "$1/coverage/lcov.info"
|
||||||
|
lcov --remove "$1/coverage/lcov.info" 'test/*' '/usr/*' \
|
||||||
|
--output-file "$1/coverage/lcov.info.clean"
|
||||||
|
genhtml -o "$1/coverage/" "$1/coverage/lcov.info.clean"
|
||||||
|
fi
|
||||||
|
|
||||||
exit $ret
|
exit $ret
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue