Debian Codegraph @

cmake/tribits/ctest_driver/TribitsAddDashboardTarget.cmake

raw
1 # @HEADER
2 # *****************************************************************************
3 # TriBITS: Tribal Build, Integrate, and Test System
4 #
5 # Copyright 2013-2016 NTESS and the TriBITS contributors.
6 # SPDX-License-Identifier: BSD-3-Clause
7 # *****************************************************************************
8 # @HEADER
9
10
11 ################################################################################
12 #
13 # This file gets included in the main TriBITS framework. It is put here to
14 # reduce the size of the tribits/core/ directory.
15 #
16 ################################################################################
17
18 include("${CMAKE_CURRENT_LIST_DIR}/../core/utils/TribitsGitRepoVersionInfo.cmake")
19
20 #
21 # Macro that drives a experimental 'dashboard' target
22 #
23
24 macro(tribits_add_dashboard_target)
25
26 if (NOT (WIN32 AND NOT CYGWIN))
27
28 if ("${${PROJECT_NAME}_CTEST_DO_ALL_AT_ONCE_DEFAULT}" STREQUAL "")
29 set(${PROJECT_NAME}_CTEST_DO_ALL_AT_ONCE_DEFAULT FALSE)
30 endif()
31 advanced_set(${PROJECT_NAME}_CTEST_DO_ALL_AT_ONCE
32 ${${PROJECT_NAME}_CTEST_DO_ALL_AT_ONCE_DEFAULT}
33 CACHE BOOL
34 "If set to TRUE, use all-at-once mode for configure, build, test, and submit. Otherwise, use package-by-package mode.")
35
36 advanced_set(${PROJECT_NAME}_DASHBOARD_CTEST_ARGS "-V" CACHE STRING
37 "Extra arguments to pass to CTest when calling 'ctest -S' to run the 'dashboard' make target." )
38
39 advanced_set(CTEST_BUILD_FLAGS "" CACHE STRING
40 "Sets CTEST_BUILD_FLAGS on the env before invoking 'ctest -S'." )
41
42 advanced_set(CTEST_PARALLEL_LEVEL "" CACHE STRING
43 "Sets CTEST_PARALLEL_LEVEL on the env before invoking 'ctest -S'." )
44
45 # H.1) Enable all packages that are enabled and have tests enabled
46
47 set(${PROJECT_NAME}_ENABLED_PACKAGES_LIST)
48 set(${PROJECT_NAME}_ENABLED_PACKAGES_CMAKE_ARG_LIST)
49 foreach(TRIBITS_PACKAGE ${${PROJECT_NAME}_ENABLED_INTERNAL_PACKAGES})
50 if (${PROJECT_NAME}_ENABLE_${TRIBITS_PACKAGE} AND ${TRIBITS_PACKAGE}_ENABLE_TESTS)
51 if (${PROJECT_NAME}_ENABLED_PACKAGES_LIST)
52 set(${PROJECT_NAME}_ENABLED_PACKAGES_LIST
53 "${${PROJECT_NAME}_ENABLED_PACKAGES_LIST}\;${TRIBITS_PACKAGE}")
54 else()
55 set(${PROJECT_NAME}_ENABLED_PACKAGES_LIST "${TRIBITS_PACKAGE}")
56 endif()
57 set(${PROJECT_NAME}_ENABLED_PACKAGES_CMAKE_ARG_LIST
58 ${${PROJECT_NAME}_ENABLED_PACKAGES_CMAKE_ARG_LIST} -D${PROJECT_NAME}_ENABLE_${TRIBITS_PACKAGE}=ON)
59 endif()
60 endforeach()
61 #print_var(${PROJECT_NAME}_ENABLED_PACKAGES_LIST)
62
63 set(EXPR_CMND_ARGS)
64
65 # Hard override options used by basic build and tests
66 append_set(EXPR_CMND_ARGS "TRIBITS_PROJECT_ROOT=${${PROJECT_NAME}_SOURCE_DIR}")
67 append_set(EXPR_CMND_ARGS "${PROJECT_NAME}_TRIBITS_DIR=${${PROJECT_NAME}_TRIBITS_DIR}")
68 append_set(EXPR_CMND_ARGS "${PROJECT_NAME}_WARNINGS_AS_ERRORS_FLAGS='${${PROJECT_NAME}_WARNINGS_AS_ERRORS_FLAGS}'")
69 append_set(EXPR_CMND_ARGS "${PROJECT_NAME}_ENABLE_SECONDARY_TESTED_CODE=${${PROJECT_NAME}_ENABLE_SECONDARY_TESTED_CODE}")
70
71 # Determine if base repo is a git repo (by seeing if SHA1 can be extracted)
72 tribits_git_repo_sha1("${PROJECT_SOURCE_DIR}" projectGitRepoSha1
73 FAILURE_MESSAGE_OUT projectGitRepoSha1FailureMsg)
74 if (projectGitRepoSha1 STREQUAL "")
75 append_set(EXPR_CMND_ARGS "CTEST_DO_UPDATES=OFF")
76 endif()
77
78 # Conditionally override options used only for the 'dashboard' target.
79 # These options have no use in a a basic build/test so we don't want to
80 # interfere with options users might set on the env.
81 if (NOT "${${PROJECT_NAME}_CTEST_DO_ALL_AT_ONCE}" STREQUAL "")
82 append_set(EXPR_CMND_ARGS "${PROJECT_NAME}_CTEST_DO_ALL_AT_ONCE=${${PROJECT_NAME}_CTEST_DO_ALL_AT_ONCE}")
83 endif()
84 if (NOT "${CTEST_BUILD_NAME}" STREQUAL "")
85 append_set(EXPR_CMND_ARGS "CTEST_BUILD_NAME=${CTEST_BUILD_NAME}")
86 endif()
87 if (NOT "${${PROJECT_NAME}_ENABLE_COVERAGE_TESTING}" STREQUAL "")
88 append_set(EXPR_CMND_ARGS "CTEST_DO_COVERAGE_TESTING=${${PROJECT_NAME}_ENABLE_COVERAGE_TESTING}")
89 endif()
90 if (NOT "${CTEST_BUILD_FLAGS}" STREQUAL "")
91 append_set(EXPR_CMND_ARGS "CTEST_BUILD_FLAGS=${CTEST_BUILD_FLAGS}")
92 endif()
93 if (NOT "${CTEST_PARALLEL_LEVEL}" STREQUAL "")
94 append_set(EXPR_CMND_ARGS "CTEST_PARALLEL_LEVEL=${CTEST_PARALLEL_LEVEL}")
95 endif()
96 if (NOT "${CTEST_DO_SUBMIT}" STREQUAL "")
97 append_set(EXPR_CMND_ARGS "CTEST_DO_SUBMIT=${CTEST_DO_SUBMIT}")
98 endif()
99 if (NOT "${CTEST_DROP_METHOD}" STREQUAL "")
100 append_set(EXPR_CMND_ARGS "CTEST_DROP_METHOD=${CTEST_DROP_METHOD}")
101 endif()
102 if (NOT $"{CTEST_DROP_SITE}" STREQUAL "")
103 append_set(EXPR_CMND_ARGS "CTEST_DROP_SITE=${CTEST_DROP_SITE}")
104 endif()
105 if (NOT "${CTEST_DROP_LOCATION}" STREQUAL "")
106 append_set(EXPR_CMND_ARGS "CTEST_DROP_LOCATION=${CTEST_DROP_LOCATION}")
107 endif()
108 if (NOT "${CTEST_DROP_SITE_COVERAGE}" STREQUAL "")
109 append_set(EXPR_CMND_ARGS "CTEST_DROP_SITE_COVERAGE=${CTEST_DROP_SITE_COVERAGE}")
110 endif()
111 if (NOT "${CTEST_DROP_LOCATION_COVERAGE}" STREQUAL "")
112 append_set(EXPR_CMND_ARGS "CTEST_DROP_LOCATION_COVERAGE=${CTEST_DROP_LOCATION_COVERAGE}")
113 endif()
114 if (NOT "${TRIBITS_2ND_CTEST_DROP_LOCATION}" STREQUAL "")
115 append_set(EXPR_CMND_ARGS "TRIBITS_2ND_CTEST_DROP_LOCATION=${TRIBITS_2ND_CTEST_DROP_LOCATION}")
116 endif()
117 if (NOT "${TRIBITS_2ND_CTEST_DROP_SITE}" STREQUAL "")
118 append_set(EXPR_CMND_ARGS "TRIBITS_2ND_CTEST_DROP_SITE=${TRIBITS_2ND_CTEST_DROP_SITE}")
119 endif()
120
121 #print_var(${PROJECT_NAME}_EXTRA_REPOSITORIES)
122 append_set(EXPR_CMND_ARGS
123 ${PROJECT_NAME}_EXTRAREPOS_FILE=${${PROJECT_NAME}_EXTRAREPOS_FILE})
124 append_set(EXPR_CMND_ARGS
125 ${PROJECT_NAME}_ENABLE_KNOWN_EXTERNAL_REPOS_TYPE=${${PROJECT_NAME}_ENABLE_KNOWN_EXTERNAL_REPOS_TYPE})
126 append_set(EXPR_CMND_ARGS
127 ${PROJECT_NAME}_IGNORE_MISSING_EXTRA_REPOSITORIES=${${PROJECT_NAME}_IGNORE_MISSING_EXTRA_REPOSITORIES})
128 join(${PROJECT_NAME}_EXTRA_REPOSITORIES_JOINED "," FALSE
129 ${${PROJECT_NAME}_EXTRA_REPOSITORIES})
130 append_set(EXPR_CMND_ARGS
131 ${PROJECT_NAME}_EXTRA_REPOSITORIES=${${PROJECT_NAME}_EXTRA_REPOSITORIES_JOINED})
132
133 #print_var(EXPR_CMND_ARGS)
134
135 # H.2) Add the custom target to enable all the packages with tests enabled
136
137 if (${PROJECT_NAME}_CTEST_DO_ALL_AT_ONCE)
138
139 set(RUNNING_EXP_DASHBOARD_MSG_HEADER
140 "Running all-at-once experimental dashboard"
141 )
142
143 set(DASHBOARD_TARGET_PRE_CTEST_DRIVER_CMNDS)
144
145 set(DASHBOARD_TARGET_CTEST_DRIVER_CMND_NUM)
146
147 set(DASHBOARD_TARGET_POST_CTEST_DRIVER_CMNDS)
148
149 else()
150
151 set(RUNNING_EXP_DASHBOARD_MSG_HEADER
152 "Running package-by-package experimental dashboard"
153 )
154
155 set(DASHBOARD_TARGET_PRE_CTEST_DRIVER_CMNDS
156 COMMAND echo
157 COMMAND echo "***"
158 COMMAND echo "*** A) Clean out the list of packages"
159 COMMAND echo "***"
160 COMMAND echo
161 COMMAND echo Running: ${CMAKE_COMMAND} -D${PROJECT_NAME}_UNENABLE_ENABLED_PACKAGES:BOOL=TRUE
162 -D${PROJECT_NAME}_ALLOW_NO_PACKAGES:BOOL=ON -D${PROJECT_NAME}_ENABLE_ALL_PACKAGES:BOOL=OFF ${PROJECT_SOURCE_DIR}
163 COMMAND echo
164 COMMAND ${CMAKE_COMMAND} -D${PROJECT_NAME}_UNENABLE_ENABLED_PACKAGES:BOOL=TRUE
165 -D${PROJECT_NAME}_ALLOW_NO_PACKAGES:BOOL=ON -D${PROJECT_NAME}_ENABLE_ALL_PACKAGES:BOOL=OFF ${PROJECT_SOURCE_DIR}
166 # NOTE: Above, if ${PROJECT_NAME}_ENABLE_ALL_PACKAGES was set in CMakeCache.txt, then setting
167 # -D${PROJECT_NAME}_ENABLE_ALL_PACKAGES:BOOL=OFF will turn it off in the cache. Note that it will
168 # never be turned on again which means that the list of packages will be set explicitly below.
169 )
170
171 set(DASHBOARD_TARGET_CTEST_DRIVER_CMND_NUM "B) ")
172
173 set(DASHBOARD_TARGET_POST_CTEST_DRIVER_CMNDS
174 COMMAND echo
175 COMMAND echo "***"
176 COMMAND echo "*** C) Clean out the list of packages again to clean the cache file"
177 COMMAND echo "***"
178 COMMAND echo
179 COMMAND echo Running: ${CMAKE_COMMAND} -D${PROJECT_NAME}_UNENABLE_ENABLED_PACKAGES:BOOL=TRUE
180 -D${PROJECT_NAME}_ALLOW_NO_PACKAGES:BOOL=ON -D${PROJECT_NAME}_ENABLE_ALL_PACKAGES:BOOL=OFF ${PROJECT_SOURCE_DIR}
181 COMMAND echo
182 COMMAND ${CMAKE_COMMAND} -D${PROJECT_NAME}_UNENABLE_ENABLED_PACKAGES:BOOL=TRUE
183 -D${PROJECT_NAME}_ALLOW_NO_PACKAGES:BOOL=ON -D${PROJECT_NAME}_ENABLE_ALL_PACKAGES:BOOL=OFF ${PROJECT_SOURCE_DIR}
184
185 COMMAND echo
186 COMMAND echo "***"
187 COMMAND echo "*** D) Reconfigure with the original package list"
188 COMMAND echo "***"
189 COMMAND echo
190 COMMAND echo Running: ${CMAKE_COMMAND} ${${PROJECT_NAME}_ENABLED_PACKAGES_CMAKE_ARG_LIST}
191 -D${PROJECT_NAME}_ALLOW_NO_PACKAGES:BOOL=ON ${PROJECT_SOURCE_DIR}
192 COMMAND echo
193 COMMAND ${CMAKE_COMMAND} ${${PROJECT_NAME}_ENABLED_PACKAGES_CMAKE_ARG_LIST}
194 -D${PROJECT_NAME}_ALLOW_NO_PACKAGES:BOOL=ON ${PROJECT_SOURCE_DIR}
195
196 COMMAND echo
197 COMMAND echo "See the results at http://${CTEST_DROP_SITE}${CTEST_DROP_LOCATION}&display=project\#Experimental"
198 COMMAND echo
199 )
200
201 endif()
202
203 add_custom_target( dashboard
204
205 USES_TERMINAL # Allow real-time STDOUT with ninja target
206
207 VERBATIM # Recommended
208
209 # WARNING: The echoed command and the actual commands are duplicated! You have to reproduce them!
210
211 COMMAND echo
212 COMMAND echo "**************************************************"
213 COMMAND echo "*** ${RUNNING_EXP_DASHBOARD_MSG_HEADER} ***"
214 COMMAND echo "**************************************************"
215 COMMAND echo
216 COMMAND echo ${PROJECT_NAME}_ENABLED_PACKAGES_LIST=${${PROJECT_NAME}_ENABLED_PACKAGES_LIST}
217 COMMAND echo
218
219 ${DASHBOARD_TARGET_PRE_CTEST_DRIVER_CMNDS}
220
221 COMMAND echo
222 COMMAND echo "***"
223 COMMAND echo "*** ${DASHBOARD_TARGET_CTEST_DRIVER_CMND_NUM}Run the dashboard command setting the list of packages"
224 COMMAND echo "***"
225 COMMAND echo
226 COMMAND echo Running: env ${EXPR_CMND_ARGS}
227 ${PROJECT_NAME}_PACKAGES=${${PROJECT_NAME}_ENABLED_PACKAGES_LIST}
228 PROJECT_SOURCE_DIR=${PROJECT_SOURCE_DIR}
229 ${CMAKE_CTEST_COMMAND} ${${PROJECT_NAME}_DASHBOARD_CTEST_ARGS} -S
230 ${${PROJECT_NAME}_TRIBITS_DIR}/ctest_driver/experimental_build_test.cmake
231 COMMAND echo
232 COMMAND env ${EXPR_CMND_ARGS}
233 ${PROJECT_NAME}_PACKAGES=${${PROJECT_NAME}_ENABLED_PACKAGES_LIST}
234 PROJECT_SOURCE_DIR=${PROJECT_SOURCE_DIR}
235 ${CMAKE_CTEST_COMMAND} ${${PROJECT_NAME}_DASHBOARD_CTEST_ARGS} -S
236 ${${PROJECT_NAME}_TRIBITS_DIR}/ctest_driver/experimental_build_test.cmake || echo
237 # 2009/07/05: rabartl: Above, I added the ending '|| echo' to always make
238 # the command pass so that 'make' will not stop and avoid this last command
239 # to set back the enabled packages.
240
241 ${DASHBOARD_TARGET_POST_CTEST_DRIVER_CMNDS}
242
243 )
244
245 endif()
246
247 endmacro()