FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
keepassxc/cmake/CodeCoverage.cmake at develop · sourcecodes2/keepassxc · GitHub
sourcecodes2
/
keepassxc
Public
forked from
keepassxreboot/keepassxc
Notifications
You must be signed in to change notification settings
Fork
0
Star
0
Code
Pull requests
0
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
keepassxc
/
cmake
/
CodeCoverage.cmake
Copy path
More file actions
More file actions
Latest commit
History
History
History
303 lines (263 loc) · 11.6 KB
Breadcrumbs
keepassxc
/
cmake
/
CodeCoverage.cmake
Copy path
File metadata and controls
303 lines (263 loc) · 11.6 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
#
Copyright (c) 2012 - 2017, 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.
#
#
CHANGES:
#
#
2012-01-31, Lars Bilke
#
- Enable Code Coverage
#
#
2013-09-17, Joakim Söderberg
#
- Added support for Clang.
#
- Some additional usage instructions.
#
#
2016-02-03, Lars Bilke
#
- Refactored functions to use named parameters
#
#
2017-06-02, Lars Bilke
#
- Merged with modified version from github.com/ufz/ogs
#
#
#
USAGE:
#
#
1. Copy this file into your cmake modules path.
#
#
2. Add the following line to your CMakeLists.txt:
#
include(CodeCoverage)
#
#
3. Append necessary compiler flags:
#
APPEND_COVERAGE_COMPILER_FLAGS()
#
#
4. If you need to exclude additional directories from the report, specify them
#
using the COVERAGE_LCOV_EXCLUDES variable before calling SETUP_TARGET_FOR_COVERAGE_LCOV.
#
Example:
#
set(COVERAGE_LCOV_EXCLUDES 'dir1/*' 'dir2/*')
#
#
5. Use the functions described below to create a custom make target which
#
runs your test executable and produces a code coverage report.
#
#
6. Build a Debug build:
#
cmake -DCMAKE_BUILD_TYPE=Debug ..
#
make
#
make my_coverage_target
#
include
(
CMakeParseArguments
)
#
Check prereqs
find_program
(
GCOV_PATH
gcov
)
find_program
(
LCOV_PATH
NAMES
lcov
lcov.bat
lcov.exe
lcov.perl
)
find_program
(
GENHTML_PATH
NAMES
genhtml
genhtml.perl
genhtml.bat
)
find_program
(
GCOVR_PATH
gcovr
PATHS
${
CMAKE_SOURCE_DIR
}
/scripts/test
)
find_program
(
SIMPLE_PYTHON_EXECUTABLE
python
)
if
(
NOT
GCOV_PATH)
message
(
FATAL_ERROR
"gcov not found! Aborting..."
)
endif
()
#
NOT GCOV_PATH
if
(
"
${
CMAKE_CXX_COMPILER_ID
}
"
MATCHES
"(Apple)?[Cc]lang"
)
if
(
"
${
CMAKE_CXX_COMPILER_VERSION
}
"
VERSION_LESS
3)
message
(
FATAL_ERROR
"Clang version must be 3.0.0 or greater! Aborting..."
)
endif
()
elseif
(
NOT
CMAKE_COMPILER_IS_GNUCXX)
message
(
FATAL_ERROR
"Compiler is not GNU gcc! Aborting..."
)
endif
()
set
(COVERAGE_COMPILER_FLAGS
"-g -O0 --coverage -fprofile-arcs -ftest-coverage"
CACHE
INTERNAL
""
)
set
(CMAKE_CXX_FLAGS_COVERAGE
${COVERAGE_COMPILER_FLAGS}
CACHE
STRING
"Flags used by the C++ compiler during coverage builds."
FORCE
)
set
(CMAKE_C_FLAGS_COVERAGE
${COVERAGE_COMPILER_FLAGS}
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_LOWER
STREQUAL
"debug"
)
message
(
WARNING
"Code coverage results with an optimised (non-Debug) build may be misleading"
)
endif
()
#
NOT CMAKE_BUILD_TYPE STREQUAL "Debug"
if
(
CMAKE_C_COMPILER_ID
STREQUAL
"GNU"
)
link_libraries
(
gcov
)
else
()
set
(
CMAKE_EXE_LINKER_FLAGS
"
${
CMAKE_EXE_LINKER_FLAGS
}
--coverage"
)
endif
()
#
Defines a target for running and collection code coverage information
#
Builds dependencies, runs the given executable and outputs reports.
#
NOTE! The executable should always have a ZERO as exit code otherwise
#
the coverage generation will not complete.
#
#
SETUP_TARGET_FOR_COVERAGE_LCOV(
#
NAME testrunner_coverage # New target name
#
EXECUTABLE testrunner -j ${PROCESSOR_COUNT} # Executable in PROJECT_BINARY_DIR
#
DEPENDENCIES testrunner # Dependencies to build first
#
)
function
(
SETUP_TARGET_FOR_COVERAGE_LCOV
)
set
(options NONE)
set
(oneValueArgs NAME)
set
(multiValueArgs EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES)
cmake_parse_arguments
(
Coverage
"
${options}
"
"
${oneValueArgs}
"
"
${multiValueArgs}
"
${ARGN}
)
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
(
${Coverage_NAME}
#
Cleanup lcov
COMMAND
${LCOV_PATH}
--gcov-tool
${GCOV_PATH}
-directory
.
--zerocounters
#
Create baseline to make sure untouched files show up in the report
COMMAND
${LCOV_PATH}
--gcov-tool
${GCOV_PATH}
-c
-i
-d
.
-o
${Coverage_NAME}
.base
#
Run tests
COMMAND
${Coverage_EXECUTABLE}
#
Capturing lcov counters and generating report
COMMAND
${LCOV_PATH}
--gcov-tool
${GCOV_PATH}
--directory
.
--capture
--output-file
${Coverage_NAME}
.info
#
add baseline counters
COMMAND
${LCOV_PATH}
--gcov-tool
${GCOV_PATH}
-a
${Coverage_NAME}
.base
-a
${Coverage_NAME}
.info
--output-file
${Coverage_NAME}
.total
COMMAND
${LCOV_PATH}
--gcov-tool
${GCOV_PATH}
--remove
${Coverage_NAME}
.total
${COVERAGE_LCOV_EXCLUDES}
--output-file
${
PROJECT_BINARY_DIR
}
/${Coverage_NAME}.info.cleaned
COMMAND
${GENHTML_PATH}
-o
${Coverage_NAME}
${
PROJECT_BINARY_DIR
}
/${Coverage_NAME}.info.cleaned
COMMAND
${
CMAKE_COMMAND
}
-E
remove
${Coverage_NAME}
.base
${Coverage_NAME}
.total
${
PROJECT_BINARY_DIR
}
/${Coverage_NAME}.info.cleaned
WORKING_DIRECTORY
${
PROJECT_BINARY_DIR
}
DEPENDS
${Coverage_DEPENDENCIES}
COMMENT
"Resetting code coverage counters to zero.
\n
Processing code coverage counters and generating report."
)
#
Show where to find the lcov info report
add_custom_command
(
TARGET
${Coverage_NAME}
POST_BUILD
COMMAND
;
COMMENT
"Lcov code coverage info report saved in
${Coverage_NAME}
.info."
)
#
Show info where to find the report
add_custom_command
(
TARGET
${Coverage_NAME}
POST_BUILD
COMMAND
;
COMMENT
"Open ./
${Coverage_NAME}
/index.html in your browser to view the coverage report."
)
endfunction
()
#
SETUP_TARGET_FOR_COVERAGE_LCOV
#
Defines a target for running and collection code coverage information
#
Builds dependencies, runs the given executable and outputs reports.
#
NOTE! The executable should always have a ZERO as exit code otherwise
#
the coverage generation will not complete.
#
#
SETUP_TARGET_FOR_COVERAGE_GCOVR_XML(
#
NAME ctest_coverage # New target name
#
EXECUTABLE ctest -j ${PROCESSOR_COUNT} # Executable in PROJECT_BINARY_DIR
#
DEPENDENCIES executable_target # Dependencies to build first
#
)
function
(
SETUP_TARGET_FOR_COVERAGE_GCOVR_XML
)
set
(options NONE)
set
(oneValueArgs NAME)
set
(multiValueArgs EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES)
cmake_parse_arguments
(
Coverage
"
${options}
"
"
${oneValueArgs}
"
"
${multiValueArgs}
"
${ARGN}
)
if
(
NOT
SIMPLE_PYTHON_EXECUTABLE)
message
(
FATAL_ERROR
"python not found! Aborting..."
)
endif
()
#
NOT SIMPLE_PYTHON_EXECUTABLE
if
(
NOT
GCOVR_PATH)
message
(
FATAL_ERROR
"gcovr not found! Aborting..."
)
endif
()
#
NOT GCOVR_PATH
#
Combine excludes to several -e arguments
set
(GCOVR_EXCLUDES
""
)
foreach
(EXCLUDE
${COVERAGE_GCOVR_EXCLUDES}
)
list
(
APPEND
GCOVR_EXCLUDES
"-e"
)
list
(
APPEND
GCOVR_EXCLUDES
"
${EXCLUDE}
"
)
endforeach
()
add_custom_target
(
${Coverage_NAME}
#
Run tests
${Coverage_EXECUTABLE}
#
Running gcovr
COMMAND
${GCOVR_PATH}
--xml
-r
${
PROJECT_SOURCE_DIR
}
${GCOVR_EXCLUDES}
--object-directory=${PROJECT_BINARY_DIR}
-o
${Coverage_NAME}
.xml
WORKING_DIRECTORY
${
PROJECT_BINARY_DIR
}
DEPENDS
${Coverage_DEPENDENCIES}
COMMENT
"Running gcovr to produce Cobertura code coverage report."
)
#
Show info where to find the report
add_custom_command
(
TARGET
${Coverage_NAME}
POST_BUILD
COMMAND
;
COMMENT
"Cobertura code coverage report saved in
${Coverage_NAME}
.xml."
)
endfunction
()
#
SETUP_TARGET_FOR_COVERAGE_GCOVR_XML
#
Defines a target for running and collection code coverage information
#
Builds dependencies, runs the given executable and outputs reports.
#
NOTE! The executable should always have a ZERO as exit code otherwise
#
the coverage generation will not complete.
#
#
SETUP_TARGET_FOR_COVERAGE_GCOVR_HTML(
#
NAME ctest_coverage # New target name
#
EXECUTABLE ctest -j ${PROCESSOR_COUNT} # Executable in PROJECT_BINARY_DIR
#
DEPENDENCIES executable_target # Dependencies to build first
#
)
function
(
SETUP_TARGET_FOR_COVERAGE_GCOVR_HTML
)
set
(options NONE)
set
(oneValueArgs NAME)
set
(multiValueArgs EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES)
cmake_parse_arguments
(
Coverage
"
${options}
"
"
${oneValueArgs}
"
"
${multiValueArgs}
"
${ARGN}
)
if
(
NOT
SIMPLE_PYTHON_EXECUTABLE)
message
(
FATAL_ERROR
"python not found! Aborting..."
)
endif
()
#
NOT SIMPLE_PYTHON_EXECUTABLE
if
(
NOT
GCOVR_PATH)
message
(
FATAL_ERROR
"gcovr not found! Aborting..."
)
endif
()
#
NOT GCOVR_PATH
#
Combine excludes to several -e arguments
set
(GCOVR_EXCLUDES
""
)
foreach
(EXCLUDE
${COVERAGE_GCOVR_EXCLUDES}
)
list
(
APPEND
GCOVR_EXCLUDES
"-e"
)
list
(
APPEND
GCOVR_EXCLUDES
"
${EXCLUDE}
"
)
endforeach
()
add_custom_target
(
${Coverage_NAME}
#
Run tests
${Coverage_EXECUTABLE}
#
Create folder
COMMAND
${
CMAKE_COMMAND
}
-E
make_directory
${
PROJECT_BINARY_DIR
}
/${Coverage_NAME}
#
Running gcovr
COMMAND
${GCOVR_PATH}
--html
--html-details
-r
${
PROJECT_SOURCE_DIR
}
${GCOVR_EXCLUDES}
--object-directory=${PROJECT_BINARY_DIR}
-o
${Coverage_NAME}
/index.html
WORKING_DIRECTORY
${
PROJECT_BINARY_DIR
}
DEPENDS
${Coverage_DEPENDENCIES}
COMMENT
"Running gcovr to produce HTML code coverage report."
)
#
Show info where to find the report
add_custom_command
(
TARGET
${Coverage_NAME}
POST_BUILD
COMMAND
;
COMMENT
"Open ./
${Coverage_NAME}
/index.html in your browser to view the coverage report."
)
endfunction
()
#
SETUP_TARGET_FOR_COVERAGE_GCOVR_HTML
function
(
APPEND_COVERAGE_COMPILER_FLAGS
)
set
(
CMAKE_C_FLAGS
"
${
CMAKE_C_FLAGS
}
${COVERAGE_COMPILER_FLAGS}
"
PARENT_SCOPE
)
set
(
CMAKE_CXX_FLAGS
"
${
CMAKE_CXX_FLAGS
}
${COVERAGE_COMPILER_FLAGS}
"
PARENT_SCOPE
)
message
(
STATUS
"Appending code coverage compiler flags:
${COVERAGE_COMPILER_FLAGS}
"
)
endfunction
()
#
APPEND_COVERAGE_COMPILER_FLAGS
Back
|
FazBrowse Home
|
New Git URL