Skip to content

Commit 66339bc

Browse files
binary1248eXpl0it3r
binary1248
authored and
eXpl0it3r
committed
Added support for coverage reporting.
1 parent 0e41954 commit 66339bc

6 files changed

Lines changed: 180 additions & 9 deletions

File tree

‎.github/.codecov.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
codecov:
2+
require_ci_to_pass: yes
3+
4+
coverage:
5+
precision: 2
6+
round: down
7+
range: "70...100"
8+
status:
9+
project:
10+
default:
11+
target: auto
12+
threshold: 100%
13+
base: auto
14+
15+
parsers:
16+
gcov:
17+
branch_detection:
18+
conditional: yes
19+
loop: yes
20+
method: no
21+
macro: no
22+
23+
comment:
24+
layout: "reach,diff,flags,files,footer"
25+
behavior: default
26+
require_changes: no
27+
require_head: no
28+
require_base: no
29+
30+
github_checks:
31+
annotations: true

‎.github/workflows/ci.yml‎

Lines changed: 53 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,23 @@ jobs:
3535
- name: Checkout Code
3636
uses: actions/checkout@v2
3737

38-
- name: Install Linux Dependencies
38+
- name: Detect Linux Clang Version
3939
if: runner.os == 'Linux'
40-
run: sudo apt-get update && sudo apt-get install libxrandr-dev libxcursor-dev libudev-dev libopenal-dev libflac-dev libvorbis-dev libgl1-mesa-dev libegl1-mesa-dev
40+
run: clang++ --version | sed -n 's/.*version \([0-9]\+\)\..*/clang_version=\1/p' >> $GITHUB_ENV
4141

42+
- name: Install Linux Tools and Dependencies
43+
if: runner.os == 'Linux'
44+
run: sudo apt-get update && sudo apt-get install gcovr llvm-${{ env.clang_version }} libxrandr-dev libxcursor-dev libudev-dev libopenal-dev libflac-dev libvorbis-dev libgl1-mesa-dev libegl1-mesa-dev
45+
46+
- name: Install macOS Tools and Dependencies
47+
if: runner.os == 'macOS'
48+
run: brew install gcovr
49+
50+
- name: Install OpenCppCoverage and add to PATH
51+
if: runner.os == 'Windows'
52+
run: |
53+
choco install OpenCppCoverage -y
54+
echo "C:\Program Files\OpenCppCoverage" >> $env:GITHUB_PATH
4255
4356
- name: Install Android Components
4457
if: matrix.platform.name == 'Android'
@@ -48,11 +61,47 @@ jobs:
4861
wget -nv https://dl.google.com/android/repository/android-ndk-r18b-linux-x86_64.zip -P $GITHUB_WORKSPACE
4962
unzip -qq -d $GITHUB_WORKSPACE android-ndk-r18b-linux-x86_64.zip
5063
51-
5264
- name: Configure CMake
5365
shell: bash
54-
run: cmake -S $GITHUB_WORKSPACE -B $GITHUB_WORKSPACE/build -DCMAKE_INSTALL_PREFIX=$GITHUB_WORKSPACE/install -DSFML_BUILD_EXAMPLES=TRUE -DCMAKE_VERBOSE_MAKEFILE=ON -DSFML_BUILD_TEST_SUITE=TRUE ${{matrix.platform.flags}} ${{matrix.config.flags}}
66+
run: cmake -S $GITHUB_WORKSPACE -B $GITHUB_WORKSPACE/build -DCMAKE_INSTALL_PREFIX=$GITHUB_WORKSPACE/install -DSFML_BUILD_EXAMPLES=TRUE -DCMAKE_VERBOSE_MAKEFILE=ON -DSFML_BUILD_TEST_SUITE=TRUE -DSFML_ENABLE_COVERAGE=TRUE ${{matrix.platform.flags}} ${{matrix.config.flags}}
5567

5668
- name: Build
5769
shell: bash
5870
run: cmake --build $GITHUB_WORKSPACE/build --config Release --target install
71+
72+
- name: Generate OpenCppCoverage Coverage Report
73+
if: matrix.platform.name == 'Windows VS2019' || matrix.platform.name == 'Windows VS2022'
74+
shell: bash
75+
run: cmake --build $GITHUB_WORKSPACE/build --config Debug --target runtests
76+
77+
- name: Generate GCC Gcov Coverage Report
78+
if: matrix.platform.name == 'Linux GCC'
79+
shell: bash
80+
run: |
81+
cmake -S $GITHUB_WORKSPACE -B $GITHUB_WORKSPACE/build -DCMAKE_INSTALL_PREFIX=$GITHUB_WORKSPACE/install -DCMAKE_BUILD_TYPE=Debug -DSFML_BUILD_EXAMPLES=TRUE -DCMAKE_VERBOSE_MAKEFILE=ON -DSFML_BUILD_TEST_SUITE=TRUE -DSFML_ENABLE_COVERAGE=TRUE ${{matrix.platform.flags}} ${{matrix.config.flags}}
82+
cmake --build $GITHUB_WORKSPACE/build --target runtests
83+
gcovr -r $GITHUB_WORKSPACE -x $GITHUB_WORKSPACE/build/coverage.out -s -f 'src/SFML/.*' -f 'include/SFML/.*' $GITHUB_WORKSPACE
84+
85+
- name: Generate Clang Gcov Coverage Report
86+
if: matrix.platform.name == 'Linux Clang'
87+
shell: bash
88+
run: |
89+
cmake -S $GITHUB_WORKSPACE -B $GITHUB_WORKSPACE/build -DCMAKE_INSTALL_PREFIX=$GITHUB_WORKSPACE/install -DCMAKE_BUILD_TYPE=Debug -DSFML_BUILD_EXAMPLES=TRUE -DCMAKE_VERBOSE_MAKEFILE=ON -DSFML_BUILD_TEST_SUITE=TRUE -DSFML_ENABLE_COVERAGE=TRUE ${{matrix.platform.flags}} ${{matrix.config.flags}}
90+
cmake --build $GITHUB_WORKSPACE/build --target runtests
91+
gcovr --gcov-executable="llvm-cov-${{ env.clang_version }} gcov" -r $GITHUB_WORKSPACE -x $GITHUB_WORKSPACE/build/coverage.out -s -f 'src/SFML/.*' -f 'include/SFML/.*' $GITHUB_WORKSPACE
92+
93+
- name: Generate Apple Clang Gcov Coverage Report
94+
if: matrix.platform.name == 'MacOS XCode' && (matrix.config.name == 'Shared' || matrix.config.name == 'Static')
95+
shell: bash
96+
run: |
97+
cmake -S $GITHUB_WORKSPACE -B $GITHUB_WORKSPACE/build -DCMAKE_INSTALL_PREFIX=$GITHUB_WORKSPACE/install -DCMAKE_BUILD_TYPE=Debug -DSFML_BUILD_EXAMPLES=TRUE -DCMAKE_VERBOSE_MAKEFILE=ON -DSFML_BUILD_TEST_SUITE=TRUE -DSFML_ENABLE_COVERAGE=TRUE ${{matrix.platform.flags}} ${{matrix.config.flags}}
98+
cmake --build $GITHUB_WORKSPACE/build --target runtests
99+
gcovr -r $GITHUB_WORKSPACE -x $GITHUB_WORKSPACE/build/coverage.out -s -f 'src/SFML/.*' -f 'include/SFML/.*' $GITHUB_WORKSPACE
100+
101+
- name: Upload Coverage Report to Codecov
102+
if: matrix.platform.name == 'Windows VS2019' || matrix.platform.name == 'Windows VS2022' || matrix.platform.name == 'Linux GCC' || matrix.platform.name == 'Linux Clang' || (matrix.platform.name == 'MacOS XCode' && (matrix.config.name == 'Shared' || matrix.config.name == 'Static'))
103+
uses: codecov/codecov-action@v2
104+
with:
105+
directory: ./build
106+
files: ./build/coverage.out
107+
fail_ci_if_error: true

‎CMakeLists.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@ endif()
8282
# add an option for building the test suite
8383
sfml_set_option(SFML_BUILD_TEST_SUITE FALSE BOOL "TRUE to build the SFML test suite, FALSE to ignore it")
8484

85+
# add an option for enabling coverage reporting
86+
sfml_set_option(SFML_ENABLE_COVERAGE FALSE BOOL "TRUE to enable coverage reporting, FALSE to ignore it")
87+
8588
# macOS specific options
8689
if(SFML_OS_MACOSX)
8790
# add an option to build frameworks instead of dylibs (release only)

‎cmake/Macros.cmake‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,17 @@ macro(sfml_add_library module)
7373
# enable C++17 support
7474
target_compile_features(${target} PUBLIC cxx_std_17)
7575

76+
# Add required flags for GCC if coverage reporting is enabled
77+
if (SFML_ENABLE_COVERAGE AND (SFML_COMPILER_GCC OR SFML_COMPILER_CLANG))
78+
target_compile_options(${target} PUBLIC $<$<CONFIG:DEBUG>:-O0> $<$<CONFIG:DEBUG>:-g> $<$<CONFIG:DEBUG>:-fprofile-arcs> $<$<CONFIG:DEBUG>:-ftest-coverage>)
79+
80+
if (CMAKE_VERSION VERSION_GREATER_EQUAL 3.13)
81+
target_link_options(${target} PUBLIC $<$<CONFIG:DEBUG>:--coverage>)
82+
else()
83+
target_link_libraries(${target} PUBLIC $<$<CONFIG:DEBUG>:--coverage>)
84+
endif()
85+
endif()
86+
7687
set_file_warnings(${THIS_SOURCES})
7788

7889
# define the export symbol of the module
@@ -318,6 +329,20 @@ function(sfml_add_test target SOURCES DEPENDS)
318329
# link the target to its SFML dependencies
319330
target_link_libraries(${target} PRIVATE ${DEPENDS})
320331

332+
# If coverage is enabled for MSVC and we are linking statically, use /WHOLEARCHIVE
333+
# to make sure the linker doesn't discard unused code sections before coverage can be measured
334+
if (SFML_ENABLE_COVERAGE AND SFML_COMPILER_MSVC AND NOT BUILD_SHARED_LIBS)
335+
if (CMAKE_VERSION VERSION_GREATER_EQUAL 3.13)
336+
foreach (DEPENDENCY ${DEPENDS})
337+
target_link_options(${target} PRIVATE $<$<CONFIG:DEBUG>:/WHOLEARCHIVE:$<TARGET_LINKER_FILE:${DEPENDENCY}>>)
338+
endforeach()
339+
else()
340+
foreach (DEPENDENCY ${DEPENDS})
341+
target_link_libraries(${target} PRIVATE $<$<CONFIG:DEBUG>:/WHOLEARCHIVE:$<TARGET_LINKER_FILE:${DEPENDENCY}>>)
342+
endforeach()
343+
endif()
344+
endif()
345+
321346
# Add the test
322347
add_test(${target} ${target})
323348

‎test/Audio/Dummy.cpp‎

Whitespace-only changes.

‎test/CMakeLists.txt‎

Lines changed: 68 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,75 @@ if(SFML_BUILD_NETWORK)
5151
target_link_libraries(test-sfml-network PRIVATE sfml-test-main)
5252
endif()
5353

54+
if(SFML_BUILD_AUDIO)
55+
SET(AUDIO_SRC
56+
"${SRCROOT}/Audio/Dummy.cpp" # TODO: Remove when there are real tests
57+
)
58+
sfml_add_test(test-sfml-audio "${AUDIO_SRC}" SFML::Audio)
59+
target_link_libraries(test-sfml-audio PRIVATE sfml-test-main)
60+
endif()
61+
5462
# Automatically run the tests at the end of the build
5563
add_custom_target(runtests ALL
56-
DEPENDS test-sfml-system test-sfml-window test-sfml-graphics test-sfml-network
64+
DEPENDS test-sfml-system test-sfml-window test-sfml-graphics test-sfml-network test-sfml-audio
5765
)
5866

59-
add_custom_command(TARGET runtests
60-
COMMENT "Run tests"
61-
POST_BUILD COMMAND "${CMAKE_CTEST_COMMAND}" --output-on-failure -C $<CONFIG>
62-
)
67+
if(SFML_OS_WINDOWS AND NOT SFML_USE_SYSTEM_DEPS)
68+
# Copy the binaries of SFML dependencies
69+
list(APPEND BINARIES
70+
"openal32.dll"
71+
)
72+
73+
foreach (BINARY ${BINARIES})
74+
if(ARCH_32BITS)
75+
list(APPEND BINARY_PATHS "${PROJECT_SOURCE_DIR}/extlibs/bin/x86/${BINARY}")
76+
elseif(ARCH_64BITS)
77+
list(APPEND BINARY_PATHS "${PROJECT_SOURCE_DIR}/extlibs/bin/x64/${BINARY}")
78+
endif()
79+
endforeach()
80+
81+
add_custom_command(TARGET runtests
82+
COMMENT "Copy binaries"
83+
POST_BUILD COMMAND "${CMAKE_COMMAND}" -E copy ${BINARY_PATHS} "$<TARGET_FILE_DIR:test-sfml-system>"
84+
)
85+
endif()
86+
87+
if(SFML_ENABLE_COVERAGE AND SFML_COMPILER_MSVC)
88+
# Try to find and use OpenCppCoverage for coverage reporting when building with MSVC
89+
find_program(OpenCppCoverage_BINARY "OpenCppCoverage.exe")
90+
91+
if(OpenCppCoverage_BINARY)
92+
execute_process(COMMAND "${OpenCppCoverage_BINARY}" --help ERROR_VARIABLE OpenCppCoverage_HELP_OUTPUT OUTPUT_QUIET)
93+
94+
if(OpenCppCoverage_HELP_OUTPUT MATCHES "OpenCppCoverage Version: ([.0-9]+)")
95+
set(OpenCppCoverage_VERSION "${CMAKE_MATCH_1}")
96+
endif()
97+
endif()
98+
99+
include(FindPackageHandleStandardArgs)
100+
101+
find_package_handle_standard_args(OpenCppCoverage
102+
REQUIRED_VARS OpenCppCoverage_BINARY
103+
VERSION_VAR OpenCppCoverage_VERSION
104+
)
105+
endif()
106+
107+
if(SFML_ENABLE_COVERAGE AND OpenCppCoverage_FOUND)
108+
# Use OpenCppCoverage
109+
message(STATUS "Using OpenCppCoverage to generate coverage report")
110+
111+
string(REPLACE "/" "\\" COVERAGE_EXCLUDE "${CMAKE_CTEST_COMMAND}")
112+
string(REPLACE "/" "\\" COVERAGE_SRC "${PROJECT_SOURCE_DIR}/src")
113+
string(REPLACE "/" "\\" COVERAGE_INCLUDE "${PROJECT_SOURCE_DIR}/include")
114+
115+
add_custom_command(TARGET runtests
116+
COMMENT "Run tests"
117+
POST_BUILD COMMAND "${OpenCppCoverage_BINARY}" ARGS --quiet --export_type cobertura:"${CMAKE_BINARY_DIR}/coverage.out" --cover_children --excluded_modules "${COVERAGE_EXCLUDE}" --sources "${COVERAGE_SRC}" --sources "${COVERAGE_INCLUDE}" -- "${CMAKE_CTEST_COMMAND}" --output-on-failure -C $<CONFIG>
118+
)
119+
else()
120+
# Run tests without a coverage runner
121+
add_custom_command(TARGET runtests
122+
COMMENT "Run tests"
123+
POST_BUILD COMMAND "${CMAKE_CTEST_COMMAND}" --output-on-failure -C $<CONFIG>
124+
)
125+
endif()

0 commit comments

Comments
 (0)