| 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 |
include("${CMAKE_CURRENT_LIST_DIR}/../test_support/TribitsAddTest.cmake") |
| 12 |
|
| 13 |
include(TribitsAddExecutable) |
| 14 |
include(TribitsDeprecatedHelpers) |
| 15 |
|
| 16 |
|
| 17 |
# |
| 18 |
# Helper Macros |
| 19 |
# |
| 20 |
|
| 21 |
|
| 22 |
macro(tribits_fwd_parse_arg VAR_TO_SET_OUT ARGNAME) |
| 23 |
if (PARSE_${ARGNAME}) |
| 24 |
set(${VAR_TO_SET_OUT} ${${VAR_TO_SET_OUT}} ${ARGNAME} ${PARSE_${ARGNAME}}) |
| 25 |
endif() |
| 26 |
endmacro() |
| 27 |
|
| 28 |
|
| 29 |
macro(tribits_fwd_parse_opt VAR_TO_SET_OUT OPTNAME) |
| 30 |
if (PARSE_${OPTNAME}) |
| 31 |
set(${VAR_TO_SET_OUT} ${${VAR_TO_SET_OUT}} ${OPTNAME}) |
| 32 |
endif() |
| 33 |
endmacro() |
| 34 |
|
| 35 |
|
| 36 |
macro(tribits_add_executable_wrapper) |
| 37 |
if (TRIBITS_ADD_EXECUTABLE_AND_TEST_TEST_MODE) |
| 38 |
set(TRIBITS_ADD_EXECUTABLE_CAPTURE_ARGS ${ARGN} CACHE INTERNAL "") |
| 39 |
else() |
| 40 |
tribits_add_executable(${ARGN}) |
| 41 |
endif() |
| 42 |
endmacro() |
| 43 |
|
| 44 |
|
| 45 |
macro(tribits_add_test_wrapper) |
| 46 |
if (TRIBITS_ADD_EXECUTABLE_AND_TEST_TEST_MODE) |
| 47 |
set(TRIBITS_ADD_TEST_CAPTURE_ARGS ${ARGN} CACHE INTERNAL "") |
| 48 |
else() |
| 49 |
tribits_add_test(${ARGN}) |
| 50 |
endif() |
| 51 |
endmacro() |
| 52 |
|
| 53 |
|
| 54 |
# @FUNCTION: tribits_add_executable_and_test() |
| 55 |
# |
| 56 |
# Add an executable and a test (or several tests) all in one shot (just calls |
| 57 |
# `tribits_add_executable()`_ followed by `tribits_add_test()`_). |
| 58 |
# |
| 59 |
# Usage:: |
| 60 |
# |
| 61 |
# tribits_add_executable_and_test( |
| 62 |
# <exeRootName> [NOEXEPREFIX] [NOEXESUFFIX] [ADD_DIR_TO_NAME] |
| 63 |
# SOURCES <src0> <src1> ... |
| 64 |
# [NAME <testName> | NAME_POSTFIX <testNamePostfix>] |
| 65 |
# [CATEGORIES <category0> <category1> ...] |
| 66 |
# [HOST <host0> <host1> ...] |
| 67 |
# [XHOST <xhost0> <xhost1> ...] |
| 68 |
# [XHOST_TEST <xhost0> <xhost1> ...] |
| 69 |
# [HOSTTYPE <hosttype0> <hosttype1> ...] |
| 70 |
# [XHOSTTYPE <xhosttype0> <xhosttype1> ...] |
| 71 |
# [XHOSTTYPE_TEST <xhosttype0> <xhosttype1> ...] |
| 72 |
# [EXCLUDE_IF_NOT_TRUE <varname0> <varname1> ...] |
| 73 |
# [DISABLED "<messageWhyDisabled>"] |
| 74 |
# [DIRECTORY <dir>] |
| 75 |
# [TESTONLYLIBS <lib0> <lib1> ...] |
| 76 |
# [IMPORTEDLIBS <lib0> <lib1> ...] |
| 77 |
# [COMM [serial] [mpi]] |
| 78 |
# [ARGS "<arg0> <arg1> ..." "<arg2> <arg3> ..." ...] |
| 79 |
# [NUM_MPI_PROCS <numProcs>] |
| 80 |
# [RUN_SERIAL] |
| 81 |
# [LINKER_LANGUAGE (C|CXX|Fortran)] |
| 82 |
# [STANDARD_PASS_OUTPUT |
| 83 |
# | PASS_REGULAR_EXPRESSION "<regex0>;<regex1>;..."] |
| 84 |
# [FAIL_REGULAR_EXPRESSION "<regex0>;<regex1>;..."] |
| 85 |
# [WILL_FAIL] |
| 86 |
# [ENVIRONMENT <var0>=<value0> <var1>=<value1> ...] |
| 87 |
# [INSTALLABLE] |
| 88 |
# [TIMEOUT <maxSeconds>] |
| 89 |
# [LIST_SEPARATOR <sep>] |
| 90 |
# [ADDED_EXE_TARGET_NAME_OUT <exeTargetName>] |
| 91 |
# [ADDED_TESTS_NAMES_OUT <testsNames>] |
| 92 |
# ) |
| 93 |
# |
| 94 |
# This function takes a fairly common set of arguments to |
| 95 |
# `tribits_add_executable()`_ and `tribits_add_test()`_ but not the full set |
| 96 |
# passed to ``tribits_add_test()``. See the documentation for |
| 97 |
# `tribits_add_executable()`_ and `tribits_add_test()`_ to see which arguments |
| 98 |
# are accepted by which functions. |
| 99 |
# |
| 100 |
# Arguments that are specific to this function and not directly passed on to |
| 101 |
# ``tribits_add_executable()`` or ``tribits_add_test()`` include: |
| 102 |
# |
| 103 |
# ``XHOST_TEST <xhost0> <xhost1> ...`` |
| 104 |
# |
| 105 |
# When specified, this disables just running the tests for the named hosts |
| 106 |
# ``<xhost0>``, ``<xhost0>`` etc. but still builds the executable for the |
| 107 |
# test. These are just passed in through the ``XHOST`` argument to |
| 108 |
# ``tribits_add_test()``. |
| 109 |
# |
| 110 |
# ``XHOSTTYPE_TEST <xhosttype0> <hosttype1> ...`` |
| 111 |
# |
| 112 |
# When specified, this disables just running the tests for the named host |
| 113 |
# types ``<hosttype0>``, ``<hosttype0>``, ..., but still builds the |
| 114 |
# executable for the test. These are just passed in through the |
| 115 |
# ``XHOSTTYPE`` argument to ``tribits_add_test()``. |
| 116 |
# |
| 117 |
# This is the function to use for simple test executables that you want to run |
| 118 |
# that either takes no arguments or just a simple set of arguments passed in |
| 119 |
# through ``ARGS``. For more flexibility, just use |
| 120 |
# ``tribits_add_executable()`` followed by ``tribits_add_test()``. |
| 121 |
# |
| 122 |
# Finally, the tests are only added if tests are enabled for the package |
| 123 |
# (i.e. `${PACKAGE_NAME}_ENABLE_TESTS`_ ``= ON``) and other criteria are met. |
| 124 |
# But the test executable will always be added if this function is called, |
| 125 |
# regardless of the value of ``${PACKAGE_NAME}_ENABLE_TESTS``. To avoid |
| 126 |
# adding the test (or example) executable when |
| 127 |
# ``${PACKAGE_NAME}_ENABLE_TESTS=OFF``, put this command in a subdir under |
| 128 |
# ``test/`` or ``example/`` and that subdir with |
| 129 |
# `tribits_add_test_directories()`_ or `tribits_add_example_directories()`_, |
| 130 |
# respectively. |
| 131 |
# |
| 132 |
function(tribits_add_executable_and_test EXE_NAME) |
| 133 |
|
| 134 |
# |
| 135 |
# A) Parse the input arguments |
| 136 |
# |
| 137 |
|
| 138 |
cmake_parse_arguments( |
| 139 |
#prefix |
| 140 |
PARSE |
| 141 |
#options |
| 142 |
"RUN_SERIAL;STANDARD_PASS_OUTPUT;WILL_FAIL;ADD_DIR_TO_NAME;INSTALLABLE;NOEXEPREFIX;NOEXESUFFIX" |
| 143 |
#one_value_keywords |
| 144 |
"DISABLED" |
| 145 |
#mulit_value_keywords |
| 146 |
"SOURCES;DEPLIBS;TESTONLYLIBS;IMPORTEDLIBS;NAME;NAME_POSTFIX;NUM_MPI_PROCS;DIRECTORY;KEYWORDS;COMM;ARGS;PASS_REGULAR_EXPRESSION;FAIL_REGULAR_EXPRESSION;ENVIRONMENT;TIMEOUT;LIST_SEPARATOR;CATEGORIES;HOST;XHOST;XHOST_TEST;HOSTTYPE;XHOSTTYPE;EXCLUDE_IF_NOT_TRUE;XHOSTTYPE_TEST;LINKER_LANGUAGE;TARGET_DEFINES;DEFINES;ADDED_EXE_TARGET_NAME_OUT;ADDED_TESTS_NAMES_OUT" |
| 147 |
${ARGN} |
| 148 |
) |
| 149 |
|
| 150 |
tribits_check_for_unparsed_arguments() |
| 151 |
|
| 152 |
if(${PROJECT_NAME}_VERBOSE_CONFIGURE) |
| 153 |
message("") |
| 154 |
message("TRIBITS_ADD_EXECUTABLE_AND_TEST: ${EXE_NAME} ${ARGN}") |
| 155 |
endif() |
| 156 |
|
| 157 |
if(PARSE_ADDED_EXE_TARGET_NAME_OUT) |
| 158 |
set(${PARSE_ADDED_EXE_TARGET_NAME_OUT} "" PARENT_SCOPE) |
| 159 |
endif() |
| 160 |
if(PARSE_ADDED_TESTS_NAMES_OUT) |
| 161 |
set(${PARSE_ADDED_TESTS_NAMES_OUT} "" PARENT_SCOPE) |
| 162 |
endif() |
| 163 |
|
| 164 |
# |
| 165 |
# B) Arguments common to both |
| 166 |
# |
| 167 |
|
| 168 |
set(COMMON_CALL_ARGS "") |
| 169 |
tribits_fwd_parse_arg(COMMON_CALL_ARGS COMM) |
| 170 |
tribits_fwd_parse_arg(COMMON_CALL_ARGS CATEGORIES) |
| 171 |
tribits_fwd_parse_arg(COMMON_CALL_ARGS HOST) |
| 172 |
tribits_fwd_parse_arg(COMMON_CALL_ARGS XHOST) |
| 173 |
tribits_fwd_parse_arg(COMMON_CALL_ARGS HOSTTYPE) |
| 174 |
tribits_fwd_parse_arg(COMMON_CALL_ARGS XHOSTTYPE) |
| 175 |
tribits_fwd_parse_arg(COMMON_CALL_ARGS EXCLUDE_IF_NOT_TRUE) |
| 176 |
tribits_fwd_parse_opt(COMMON_CALL_ARGS NOEXEPREFIX) |
| 177 |
tribits_fwd_parse_opt(COMMON_CALL_ARGS NOEXESUFFIX) |
| 178 |
|
| 179 |
# |
| 180 |
# C) tribits_add_executable(...) |
| 181 |
# |
| 182 |
|
| 183 |
if (PARSE_DEPLIBS) |
| 184 |
tribits_deprecated("DEPLIBS argument of tribits_add_executable_and_test() is deprecated.") |
| 185 |
endif() |
| 186 |
|
| 187 |
set(CALL_ARGS "") |
| 188 |
tribits_fwd_parse_arg(CALL_ARGS SOURCES) |
| 189 |
tribits_fwd_parse_arg(CALL_ARGS DEPLIBS) # Deprecated |
| 190 |
tribits_fwd_parse_arg(CALL_ARGS TESTONLYLIBS) |
| 191 |
tribits_fwd_parse_arg(CALL_ARGS IMPORTEDLIBS) |
| 192 |
tribits_fwd_parse_arg(CALL_ARGS DIRECTORY) |
| 193 |
tribits_fwd_parse_opt(CALL_ARGS ADD_DIR_TO_NAME) |
| 194 |
tribits_fwd_parse_arg(CALL_ARGS LINKER_LANGUAGE) |
| 195 |
tribits_fwd_parse_arg(CALL_ARGS TARGET_DEFINES) |
| 196 |
tribits_fwd_parse_arg(CALL_ARGS DEFINES) |
| 197 |
tribits_fwd_parse_opt(CALL_ARGS INSTALLABLE) |
| 198 |
if (PARSE_ADDED_EXE_TARGET_NAME_OUT) |
| 199 |
list(APPEND CALL_ARGS ADDED_EXE_TARGET_NAME_OUT ADDED_EXE_TARGET_NAME) |
| 200 |
endif() |
| 201 |
|
| 202 |
tribits_add_executable_wrapper(${EXE_NAME} ${COMMON_CALL_ARGS} ${CALL_ARGS}) |
| 203 |
|
| 204 |
if(PARSE_ADDED_EXE_TARGET_NAME_OUT) |
| 205 |
set( ${PARSE_ADDED_EXE_TARGET_NAME_OUT} "${ADDED_EXE_TARGET_NAME}" |
| 206 |
PARENT_SCOPE ) |
| 207 |
endif() |
| 208 |
|
| 209 |
# |
| 210 |
# D) tribits_add_test(...) |
| 211 |
# |
| 212 |
|
| 213 |
set(CALL_ARGS "") |
| 214 |
tribits_fwd_parse_arg(CALL_ARGS NAME) |
| 215 |
tribits_fwd_parse_arg(CALL_ARGS NAME_POSTFIX) |
| 216 |
tribits_fwd_parse_arg(CALL_ARGS DIRECTORY) |
| 217 |
tribits_fwd_parse_arg(CALL_ARGS KEYWORDS) |
| 218 |
tribits_fwd_parse_arg(CALL_ARGS NUM_MPI_PROCS) |
| 219 |
tribits_fwd_parse_arg(CALL_ARGS ARGS) |
| 220 |
tribits_fwd_parse_arg(CALL_ARGS PASS_REGULAR_EXPRESSION) |
| 221 |
tribits_fwd_parse_arg(CALL_ARGS FAIL_REGULAR_EXPRESSION) |
| 222 |
tribits_fwd_parse_arg(CALL_ARGS ENVIRONMENT) |
| 223 |
tribits_fwd_parse_arg(CALL_ARGS DISABLED) |
| 224 |
tribits_fwd_parse_opt(CALL_ARGS RUN_SERIAL) |
| 225 |
tribits_fwd_parse_opt(CALL_ARGS STANDARD_PASS_OUTPUT) |
| 226 |
tribits_fwd_parse_opt(CALL_ARGS WILL_FAIL) |
| 227 |
tribits_fwd_parse_arg(CALL_ARGS TIMEOUT) |
| 228 |
tribits_fwd_parse_arg(CALL_ARGS LIST_SEPARATOR) |
| 229 |
tribits_fwd_parse_opt(CALL_ARGS ADD_DIR_TO_NAME) |
| 230 |
tribits_fwd_parse_opt(CALL_ARGS ADDED_TESTS_NAMES_OUT) |
| 231 |
if (PARSE_XHOST_TEST) |
| 232 |
set(CALL_ARGS ${CALL_ARGS} XHOST ${PARSE_XHOST_TEST}) |
| 233 |
endif() |
| 234 |
if (PARSE_XHOSTTYPE_TEST) |
| 235 |
set(CALL_ARGS ${CALL_ARGS} XHOSTTYPE ${PARSE_XHOSTTYPE_TEST}) |
| 236 |
endif() |
| 237 |
if (PARSE_ADDED_TESTS_NAMES_OUT) |
| 238 |
list(APPEND CALL_ARGS ADDED_TESTS_NAMES_OUT ADDED_TESTS_NAMES) |
| 239 |
endif() |
| 240 |
|
| 241 |
tribits_add_test_wrapper(${EXE_NAME} ${COMMON_CALL_ARGS} ${CALL_ARGS}) |
| 242 |
|
| 243 |
if(PARSE_ADDED_TESTS_NAMES_OUT) |
| 244 |
set(${PARSE_ADDED_TESTS_NAMES_OUT} "${ADDED_TESTS_NAMES}" PARENT_SCOPE) |
| 245 |
endif() |
| 246 |
|
| 247 |
endfunction() |
| 248 |
|
| 249 |
# LocalWords: executables |