add_testΒΆ
Add a test to the project to be run by ctest(1).
add_test(NAME <name> COMMAND <command> [<arg>...]
[CONFIGURATIONS <config>...]
[WORKING_DIRECTORY <dir>]
[COMMAND_EXPAND_LISTS])
Adds a test called <name>. The test name may contain arbitrary
characters, expressed as a Quoted Argument or Bracket Argument
if necessary. See policy CMP0110. The options are:
COMMANDSpecify the test command-line. If
<command>specifies an executable target (created byadd_executable()) it will automatically be replaced by the location of the executable created at build time.CONFIGURATIONSRestrict execution of the test only to the named configurations.
WORKING_DIRECTORYSet the
WORKING_DIRECTORYtest property to specify the working directory in which to execute the test. If not specified the test will be run with the current working directory set to the build directory corresponding to the current source directory.COMMAND_EXPAND_LISTSNew in version 3.16.
Lists in
COMMANDarguments will be expanded, including those created withgenerator expressions.
The given test command is expected to exit with code 0 to pass and
non-zero to fail, or vice-versa if the WILL_FAIL test
property is set. Any output written to stdout or stderr will be
captured by ctest(1) but does not affect the pass/fail status
unless the PASS_REGULAR_EXPRESSION,
FAIL_REGULAR_EXPRESSION or
SKIP_REGULAR_EXPRESSION test property is used.
New in version 3.16: Added SKIP_REGULAR_EXPRESSION property.
The COMMAND and WORKING_DIRECTORY options may use "generator
expressions" with the syntax $<...>. See the
cmake-generator-expressions(7) manual for available expressions.
Example usage:
add_test(NAME mytest
COMMAND testDriver --config $<CONFIG>
--exe $<TARGET_FILE:myexe>)
This creates a test mytest whose command runs a testDriver tool
passing the configuration name and the full path to the executable
file produced by target myexe.
Note
CMake will generate tests only if the enable_testing()
command has been invoked. The CTest module invokes the
command automatically unless the BUILD_TESTING option is turned
OFF.
add_test(<name> <command> [<arg>...])
Add a test called <name> with the given command-line. Unlike
the above NAME signature no transformation is performed on the
command-line to support target names or generator expressions.