kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Help: Revise and format add_test() command documentation 

Favor the add_test(NAME) signature and document the limitations of
the plain signature.
This commit is contained in:
Brad King 2014-02-20 08:58:13 -05:00
parent f8ccb6d038
commit 8afa5fe8ce
1 changed files with 41 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
Help/command/add_test.rst
View File

@ -1,69 +1,59 @@
add_test add_test
-------- --------
Add a test to the project with the specified arguments. Add a test to the project to be run by :manual:`ctest(1)`.
:: ::
add_test(testname Exename arg1 arg2 ... ) add_test(NAME <name> COMMAND <command> [<arg>...]
[CONFIGURATIONS <config>...]
[WORKING_DIRECTORY <dir>])
If the ENABLE_TESTING command has been run, this command adds a test Add a test called ``<name>``. The test name may not contain spaces,
target to the current directory. If ENABLE_TESTING has not been run, quotes, or other characters special in CMake syntax. The options are:
this command does nothing. The tests are run by the testing subsystem
by executing Exename with the specified arguments. Exename can be
either an executable built by this project or an arbitrary executable
on the system (like tclsh). The test will be run with the current
working directory set to the CMakeList.txt files corresponding
directory in the binary tree. Tests added using this signature do not
support generator expressions.
``COMMAND``
Specify the test command-line. If ``<command>`` specifies an
executable target (created by :command:`add_executable`) it will
automatically be replaced by the location of the executable created
at build time.
``CONFIGURATIONS``
Restrict execution of the test only to the named configurations.
:: ``WORKING_DIRECTORY``
Set the :prop_test:`WORKING_DIRECTORY` test 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.
add_test(NAME <name> [CONFIGURATIONS [Debug|Release|...]] The ``COMMAND`` and ``WORKING_DIRECTORY`` options may use "generator
[WORKING_DIRECTORY dir] expressions" with the syntax ``$<...>``. See the
COMMAND <command> [arg1 [arg2 ...]]) :manual:`cmake-generator-expressions(7)` manual for available expressions.
Add a test called <name>. The test name may not contain spaces, Example usage::
quotes, or other characters special in CMake syntax. If COMMAND
specifies an executable target (created by add_executable) it will
automatically be replaced by the location of the executable created at
build time. If a CONFIGURATIONS option is given then the test will be
executed only when testing under one of the named configurations. If
a WORKING_DIRECTORY option is given then the test will be executed in
the given directory.
Arguments after COMMAND may use "generator expressions" with the syntax
``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual for
available expressions.
Note that tgt is not added as a dependency of the target this
expression is evaluated on.
::
$<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies.
$<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise.
Boolean expressions:
::
$<AND:?[,?]...> = '1' if all '?' are '1', else '0'
$<OR:?[,?]...> = '0' if all '?' are '0', else '1'
$<NOT:?> = '0' if '?' is '1', else '1'
where '?' is always either '0' or '1'.
Example usage:
::
add_test(NAME mytest add_test(NAME mytest
COMMAND testDriver --config $<CONFIGURATION> COMMAND testDriver --config $<CONFIGURATION>
--exe $<TARGET_FILE:myexe>) --exe $<TARGET_FILE:myexe>)
This creates a test "mytest" whose command runs a testDriver tool This creates a test ``mytest`` whose command runs a ``testDriver`` tool
passing the configuration name and the full path to the executable passing the configuration name and the full path to the executable
file produced by target "myexe". file produced by target ``myexe``.
.. note::
CMake will generate tests only if the :command:`enable_testing`
command has been invoked. The :module:`CTest` module invokes the
command automatically when the ``BUILD_TESTING`` option is ``ON``.
---------------------------------------------------------------------
::
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.