ctest_test()

ctest_test

Perform the CTest Test Step as a Dashboard Client.

ctest_test([BUILD <build-dir>] [APPEND]
           [START <start-number>]
           [END <end-number>]
           [STRIDE <stride-number>]
           [EXCLUDE <exclude-regex>]
           [INCLUDE <include-regex>]
           [EXCLUDE_LABEL <label-exclude-regex>]
           [INCLUDE_LABEL <label-include-regex>]
           [PARALLEL_LEVEL <level>]
           [TEST_LOAD <threshold>]
           [SCHEDULE_RANDOM <ON|OFF>]
           [STOP_TIME <time-of-day>]
           [RETURN_VALUE <result-var>]
           [QUIET]
           )

Run tests in the project build tree and store results in Test.xml for submission with the ctest_submit() command.

The options are:

BUILD

Specify the top-level build directory. If not given, the CTEST_BINARY_DIRECTORY variable is used.

APPEND

Mark results for append to those previously submitted to a dashboard server since the last ctest_start() call. Append semantics are defined by the dashboard server in use.

START

Specify the beginning of a range of test numbers.

END

Specify the end of a range of test numbers.

STRIDE

Specify the stride by which to step across a range of test numbers.

EXCLUDE

Specify a regular expression matching test names to exclude.

INCLUDE

Specify a regular expression matching test names to include. Tests not matching this expression are excluded.

EXCLUDE_LABEL

Specify a regular expression matching test labels to exclude.

INCLUDE_LABEL

Specify a regular expression matching test labels to include. Tests not matching this expression are excluded.

PARALLEL_LEVEL

Specify a positive number representing the number of tests to be run in parallel.

TEST_LOAD

While running tests in parallel, try not to start tests when they may cause the CPU load to pass above a given threshold. If not specified the CTEST_TEST_LOAD variable will be checked, and then the --test-load command-line argument to ctest(1). See also the TestLoad setting in the CTest Test Step.

SCHEDULE_RANDOM

Launch tests in a random order. This may be useful for detecting implicit test dependencies.

STOP_TIME

Specify a time of day at which the tests should all stop running.

RETURN_VALUE

Store in the <result-var> variable 0 if all tests passed. Store non-zero if anything went wrong.

QUIET

Suppress any CTest-specific non-error messages that would have otherwise been printed to the console. Output from the underlying test command is not affected. Summary info detailing the percentage of passing tests is also unaffected by the QUIET option.

See also the CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE and CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE variables.