ctest(1)¶
Contents
Synopsis¶
ctest [<options>]
ctest --build-and-test <path-to-source> <path-to-build>
--build-generator <generator> [<options>...]
[--build-options <opts>...] [--test-command <command> [<args>...]]
ctest {-D <dashboard> | -M <model> -T <action> | -S <script> | -SP <script>}
[-- <dashboard-options>...]
Description¶
The ctest executable is the CMake test driver program.
CMake-generated build trees created for projects that use the
enable_testing() and add_test() commands have testing support.
This program will run the tests and report results.
Options¶
-C <cfg>, --build-config <cfg>Choose configuration to test.
Some CMake-generated build trees can have multiple build configurations in the same tree. This option can be used to specify which one should be tested. Example configurations are
DebugandRelease.--progressEnable short progress output from tests.
When the output of ctest is being sent directly to a terminal, the progress through the set of tests is reported by updating the same line rather than printing start and end messages for each test on new lines. This can significantly reduce the verbosity of the test output. Test completion messages are still output on their own line for failed tests and the final test summary will also still be logged.
This option can also be enabled by setting the environment variable
CTEST_PROGRESS_OUTPUT.-V,--verboseEnable verbose output from tests.
Test output is normally suppressed and only summary information is displayed. This option will show all test output.
-VV,--extra-verboseEnable more verbose output from tests.
Test output is normally suppressed and only summary information is displayed. This option will show even more test output.
--debugDisplaying more verbose internals of CTest.
This feature will result in a large number of output that is mostly useful for debugging dashboard problems.
--output-on-failure- Output anything outputted by the test program if the test should fail.
This option can also be enabled by setting the
CTEST_OUTPUT_ON_FAILUREenvironment variable -FEnable failover.
This option allows CTest to resume a test set execution that was previously interrupted. If no interruption occurred, the
-Foption will have no effect.-j <jobs>, --parallel <jobs>Run the tests in parallel using the given number of jobs.
This option tells CTest to run the tests in parallel using given number of jobs. This option can also be set by setting the
CTEST_PARALLEL_LEVELenvironment variable.This option can be used with the
PROCESSORStest property.--test-load <level>While running tests in parallel (e.g. with
-j), try not to start tests when they may cause the CPU load to pass above a given threshold.When
ctestis run as a Dashboard Client this sets theTestLoadoption of the CTest Test Step.-Q,--quietMake CTest quiet.
This option will suppress all the output. The output log file will still be generated if the
--output-logis specified. Options such as--verbose,--extra-verbose, and--debugare ignored if--quietis specified.-O <file>, --output-log <file>Output to log file.
This option tells CTest to write all its output to a
<file>log file.-N,--show-only[=<format>]Disable actual execution of tests.
This option tells CTest to list the tests that would be run but not actually run them. Useful in conjunction with the
-Rand-Eoptions.<format>can be one of the following values.human- Human-friendly output. This is not guaranteed to be stable. This is the default.
json-v1- Dump the test information in JSON format. See Show as JSON Object Model.
-L <regex>, --label-regex <regex>Run tests with labels matching regular expression.
This option tells CTest to run only the tests whose labels match the given regular expression.
-R <regex>, --tests-regex <regex>Run tests matching regular expression.
This option tells CTest to run only the tests whose names match the given regular expression.
-E <regex>, --exclude-regex <regex>Exclude tests matching regular expression.
This option tells CTest to NOT run the tests whose names match the given regular expression.
-LE <regex>, --label-exclude <regex>Exclude tests with labels matching regular expression.
This option tells CTest to NOT run the tests whose labels match the given regular expression.
-FA <regex>, --fixture-exclude-any <regex>Exclude fixtures matching
<regex>from automatically adding any tests to the test set.If a test in the set of tests to be executed requires a particular fixture, that fixture’s setup and cleanup tests would normally be added to the test set automatically. This option prevents adding setup or cleanup tests for fixtures matching the
<regex>. Note that all other fixture behavior is retained, including test dependencies and skipping tests that have fixture setup tests that fail.-FS <regex>, --fixture-exclude-setup <regex>- Same as
-FAexcept only matching setup tests are excluded. -FC <regex>, --fixture-exclude-cleanup <regex>- Same as
-FAexcept only matching cleanup tests are excluded. -D <dashboard>, --dashboard <dashboard>Execute dashboard test.
This option tells CTest to act as a CDash client and perform a dashboard test. All tests are
<Mode><Test>, where<Mode>can beExperimental,Nightly, andContinuous, and<Test>can beStart,Update,Configure,Build,Test,Coverage, andSubmit.See Dashboard Client.
-D <var>:<type>=<value>Define a variable for script mode.
Pass in variable values on the command line. Use in conjunction with
-Sto pass variable values to a dashboard script. Parsing-Darguments as variable values is only attempted if the value following-Ddoes not match any of the known dashboard types.-M <model>, --test-model <model>Sets the model for a dashboard.
This option tells CTest to act as a CDash client where the
<model>can beExperimental,Nightly, andContinuous. Combining-Mand-Tis similar to-D.See Dashboard Client.
-T <action>, --test-action <action>Sets the dashboard action to perform.
This option tells CTest to act as a CDash client and perform some action such as
start,build,testetc. See Dashboard Client Steps for the full list of actions. Combining-Mand-Tis similar to-D.See Dashboard Client.
-S <script>, --script <script>Execute a dashboard for a configuration.
This option tells CTest to load in a configuration script which sets a number of parameters such as the binary and source directories. Then CTest will do what is required to create and run a dashboard. This option basically sets up a dashboard and then runs
ctest -Dwith the appropriate options.See Dashboard Client.
-SP <script>, --script-new-process <script>Execute a dashboard for a configuration.
This option does the same operations as
-Sbut it will do them in a separate process. This is primarily useful in cases where the script may modify the environment and you do not want the modified environment to impact other-Sscripts.See Dashboard Client.
-I [Start,End,Stride,test#,test#|Test file], --tests-informationRun a specific number of tests by number.
This option causes CTest to run tests starting at number
Start, ending at numberEnd, and incrementing byStride. Any additional numbers afterStrideare considered individual test numbers.Start,End, orStridecan be empty. Optionally a file can be given that contains the same syntax as the command line.-U, --unionTake the Union of
-Iand-R.When both
-Rand-Iare specified by default the intersection of tests are run. By specifying-Uthe union of tests is run instead.--rerun-failedRun only the tests that failed previously.
This option tells CTest to perform only the tests that failed during its previous run. When this option is specified, CTest ignores all other options intended to modify the list of tests to run (
-L,-R,-E,-LE,-I, etc). In the event that CTest runs and no tests fail, subsequent calls to CTest with the--rerun-failedoption will run the set of tests that most recently failed (if any).--repeat-until-fail <n>Require each test to run
<n>times without failing in order to pass.This is useful in finding sporadic failures in test cases.
--max-width <width>Set the max width for a test name to output.
Set the maximum width for each test name to show in the output. This allows the user to widen the output to avoid clipping the test name which can be very annoying.
--interactive-debug-mode [0|1]Set the interactive mode to
0or1.This option causes CTest to run tests in either an interactive mode or a non-interactive mode. On Windows this means that in non-interactive mode, all system debug pop up windows are blocked. In dashboard mode (
Experimental,Nightly,Continuous), the default is non-interactive. When just running tests not for a dashboard the default is to allow popups and interactive debugging.--no-label-summaryDisable timing summary information for labels.
This option tells CTest not to print summary information for each label associated with the tests run. If there are no labels on the tests, nothing extra is printed.
--no-subproject-summaryDisable timing summary information for subprojects.
This option tells CTest not to print summary information for each subproject associated with the tests run. If there are no subprojects on the tests, nothing extra is printed.
--build-and-test
See Build and Test Mode.
--test-output-size-passed <size>- Limit the output for passed tests to
<size>bytes. --test-output-size-failed <size>- Limit the output for failed tests to
<size>bytes. --overwriteOverwrite CTest configuration option.
By default CTest uses configuration options from configuration file. This option will overwrite the configuration option.
--force-new-ctest-processRun child CTest instances as new processes.
By default CTest will run child CTest instances within the same process. If this behavior is not desired, this argument will enforce new processes for child CTest processes.
--schedule-randomUse a random order for scheduling tests.
This option will run the tests in a random order. It is commonly used to detect implicit dependencies in a test suite.
--submit-index- Legacy option for old Dart2 dashboard server feature. Do not use.
--timeout <seconds>Set the default test timeout.
This option effectively sets a timeout on all tests that do not already have a timeout set on them via the
TIMEOUTproperty.--stop-time <time>Set a time at which all tests should stop running.
Set a real time of day at which all tests should timeout. Example:
7:00:00 -0400. Any time format understood by the curl date parser is accepted. Local time is assumed if no timezone is specified.--print-labelsPrint all available test labels.
This option will not run any tests, it will simply print the list of all labels associated with the test set.
--help,-help,-usage,-h,-H,/?Print usage information and exit.
Usage describes the basic command line interface and its options.
--version,-version,/V [<f>]Show program name/version banner and exit.
If a file is specified, the version is written into it. The help is printed to a named <f>ile if given.
--help-full [<f>]Print all help manuals and exit.
All manuals are printed in a human-readable text format. The help is printed to a named <f>ile if given.
--help-manual <man> [<f>]Print one help manual and exit.
The specified manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.
--help-manual-list [<f>]List help manuals available and exit.
The list contains all manuals for which help may be obtained by using the
--help-manualoption followed by a manual name. The help is printed to a named <f>ile if given.--help-command <cmd> [<f>]Print help for one command and exit.
The
cmake-commands(7)manual entry for<cmd>is printed in a human-readable text format. The help is printed to a named <f>ile if given.--help-command-list [<f>]List commands with help available and exit.
The list contains all commands for which help may be obtained by using the
--help-commandoption followed by a command name. The help is printed to a named <f>ile if given.--help-commands [<f>]Print cmake-commands manual and exit.
The
cmake-commands(7)manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.--help-module <mod> [<f>]Print help for one module and exit.
The
cmake-modules(7)manual entry for<mod>is printed in a human-readable text format. The help is printed to a named <f>ile if given.--help-module-list [<f>]List modules with help available and exit.
The list contains all modules for which help may be obtained by using the
--help-moduleoption followed by a module name. The help is printed to a named <f>ile if given.--help-modules [<f>]Print cmake-modules manual and exit.
The
cmake-modules(7)manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.--help-policy <cmp> [<f>]Print help for one policy and exit.
The
cmake-policies(7)manual entry for<cmp>is printed in a human-readable text format. The help is printed to a named <f>ile if given.--help-policy-list [<f>]List policies with help available and exit.
The list contains all policies for which help may be obtained by using the
--help-policyoption followed by a policy name. The help is printed to a named <f>ile if given.--help-policies [<f>]Print cmake-policies manual and exit.
The
cmake-policies(7)manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.--help-property <prop> [<f>]Print help for one property and exit.
The
cmake-properties(7)manual entries for<prop>are printed in a human-readable text format. The help is printed to a named <f>ile if given.--help-property-list [<f>]List properties with help available and exit.
The list contains all properties for which help may be obtained by using the
--help-propertyoption followed by a property name. The help is printed to a named <f>ile if given.--help-properties [<f>]Print cmake-properties manual and exit.
The
cmake-properties(7)manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.--help-variable <var> [<f>]Print help for one variable and exit.
The
cmake-variables(7)manual entry for<var>is printed in a human-readable text format. The help is printed to a named <f>ile if given.--help-variable-list [<f>]List variables with help available and exit.
The list contains all variables for which help may be obtained by using the
--help-variableoption followed by a variable name. The help is printed to a named <f>ile if given.--help-variables [<f>]Print cmake-variables manual and exit.
The
cmake-variables(7)manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.
Label and Subproject Summary¶
CTest prints timing summary information for each LABEL and subproject
associated with the tests run. The label time summary will not include labels
that are mapped to subprojects.
When the PROCESSORS test property is set, CTest will display a
weighted test timing result in label and subproject summaries. The time is
reported with sec*proc instead of just sec.
The weighted time summary reported for each label or subproject j
is computed as:
Weighted Time Summary for Label/Subproject j =
sum(raw_test_time[j,i] * num_processors[j,i], i=1...num_tests[j])
for labels/subprojects j=1...total
where:
raw_test_time[j,i]: Wall-clock time for theitest for thejlabel or subprojectnum_processors[j,i]: Value of the CTestPROCESSORSproperty for theitest for thejlabel or subprojectnum_tests[j]: Number of tests associated with thejlabel or subprojecttotal: Total number of labels or subprojects that have at least one test run
Therefore, the weighted time summary for each label or subproject represents the amount of time that CTest gave to run the tests for each label or subproject and gives a good representation of the total expense of the tests for each label or subproject when compared to other labels or subprojects.
For example, if SubprojectA showed 100 sec*proc and SubprojectB showed
10 sec*proc, then CTest allocated approximately 10 times the CPU/core time
to run the tests for SubprojectA than for SubprojectB (e.g. so if effort
is going to be expended to reduce the cost of the test suite for the whole
project, then reducing the cost of the test suite for SubprojectA would
likely have a larger impact than effort to reduce the cost of the test suite
for SubprojectB).
Build and Test Mode¶
CTest provides a command-line signature to configure (i.e. run cmake on), build, and/or execute a test:
ctest --build-and-test <path-to-source> <path-to-build>
--build-generator <generator>
[<options>...]
[--build-options <opts>...]
[--test-command <command> [<args>...]]
The configure and test steps are optional. The arguments to this command line
are the source and binary directories. The --build-generator option must
be provided to use --build-and-test. If --test-command is specified
then that will be run after the build is complete. Other options that affect
this mode include:
--build-targetSpecify a specific target to build.
If left out the
alltarget is built.--build-nocmakeRun the build without running cmake first.
Skip the cmake step.
--build-run-dirSpecify directory to run programs from.
Directory where programs will be after it has been compiled.
--build-two-config- Run CMake twice.
--build-exe-dir- Specify the directory for the executable.
--build-generator- Specify the generator to use. See the
cmake-generators(7)manual. --build-generator-platform- Specify the generator-specific platform.
--build-generator-toolset- Specify the generator-specific toolset.
--build-project- Specify the name of the project to build.
--build-makeprogram- Override the make program chosen by CTest with a given one.
--build-noclean- Skip the make clean step.
--build-config-sample- A sample executable to use to determine the configuration that
should be used. e.g.
Debug,Releaseetc. --build-options- Additional options for configuring the build (i.e. for CMake, not for
the build tool). Note that if this is specified, the
--build-optionskeyword and its arguments must be the last option given on the command line, with the possible exception of--test-command. --test-command- The command to run as the test step with the
--build-and-testoption. All arguments following this keyword will be assumed to be part of the test command line, so it must be the last option given. --test-timeout- The time limit in seconds
Dashboard Client¶
CTest can operate as a client for the CDash software quality dashboard application. As a dashboard client, CTest performs a sequence of steps to configure, build, and test software, and then submits the results to a CDash server. The command-line signature used to submit to CDash is:
ctest (-D <dashboard> | -M <model> -T <action> | -S <script> | -SP <script>)
[-- <dashboard-options>...]
Options for Dashboard Client include:
--track <track>Specify the track to submit dashboard to
Submit dashboard to specified track instead of default one. By default, the dashboard is submitted to Nightly, Experimental, or Continuous track, but by specifying this option, the track can be arbitrary.
-A <file>, --add-notes <file>Add a notes file with submission.
This option tells CTest to include a notes file when submitting dashboard.
--tomorrow-tagNightlyorExperimentalstarts with next day tag.This is useful if the build will not finish in one day.
--extra-submit <file>[;<file>]Submit extra files to the dashboard.
This option will submit extra files to the dashboard.
--http1.0Submit using HTTP 1.0.
This option will force CTest to use HTTP 1.0 to submit files to the dashboard, instead of HTTP 1.1.
--no-compress-outputDo not compress test output when submitting.
This flag will turn off automatic compression of test output. Use this to maintain compatibility with an older version of CDash which doesn’t support compressed test output.
Dashboard Client Steps¶
CTest defines an ordered list of testing steps of which some or all may be run as a dashboard client:
Start- Start a new dashboard submission to be composed of results recorded by the following steps. See the CTest Start Step section below.
Update- Update the source tree from its version control repository. Record the old and new versions and the list of updated source files. See the CTest Update Step section below.
Configure- Configure the software by running a command in the build tree. Record the configuration output log. See the CTest Configure Step section below.
Build- Build the software by running a command in the build tree. Record the build output log and detect warnings and errors. See the CTest Build Step section below.
Test- Test the software by loading a
CTestTestfile.cmakefrom the build tree and executing the defined tests. Record the output and result of each test. See the CTest Test Step section below. Coverage- Compute coverage of the source code by running a coverage analysis tool and recording its output. See the CTest Coverage Step section below.
MemCheck- Run the software test suite through a memory check tool. Record the test output, results, and issues reported by the tool. See the CTest MemCheck Step section below.
Submit- Submit results recorded from other testing steps to the software quality dashboard server. See the CTest Submit Step section below.
Dashboard Client Modes¶
CTest defines three modes of operation as a dashboard client:
Nightly- This mode is intended to be invoked once per day, typically at night.
It enables the
Start,Update,Configure,Build,Test,Coverage, andSubmitsteps by default. Selected steps run even if theUpdatestep reports no changes to the source tree. Continuous- This mode is intended to be invoked repeatedly throughout the day.
It enables the
Start,Update,Configure,Build,Test,Coverage, andSubmitsteps by default, but exits after theUpdatestep if it reports no changes to the source tree. Experimental- This mode is intended to be invoked by a developer to test local changes.
It enables the
Start,Configure,Build,Test,Coverage, andSubmitsteps by default.
Dashboard Client via CTest Command-Line¶
CTest can perform testing on an already-generated build tree.
Run the ctest command with the current working directory set
to the build tree and use one of these signatures:
ctest -D <mode>[<step>]
ctest -M <mode> [ -T <step> ]...
The <mode> must be one of the above Dashboard Client Modes,
and each <step> must be one of the above Dashboard Client Steps.
CTest reads the Dashboard Client Configuration settings from
a file in the build tree called either CTestConfiguration.ini
or DartConfiguration.tcl (the names are historical). The format
of the file is:
# Lines starting in '#' are comments.
# Other non-blank lines are key-value pairs.
<setting>: <value>
where <setting> is the setting name and <value> is the
setting value.
In build trees generated by CMake, this configuration file is
generated by the CTest module if included by the project.
The module uses variables to obtain a value for each setting
as documented with the settings below.
Dashboard Client via CTest Script¶
CTest can perform testing driven by a cmake-language(7)
script that creates and maintains the source and build tree as
well as performing the testing steps. Run the ctest command
with the current working directory set outside of any build tree
and use one of these signatures:
ctest -S <script>
ctest -SP <script>
The <script> file must call CTest Commands commands
to run testing steps explicitly as documented below. The commands
obtain Dashboard Client Configuration settings from their
arguments or from variables set in the script.
Dashboard Client Configuration¶
The Dashboard Client Steps may be configured by named settings as documented in the following sections.
CTest Start Step¶
Start a new dashboard submission to be composed of results recorded by the following steps.
In a CTest Script, the ctest_start() command runs this step.
Arguments to the command may specify some of the step settings.
The command first runs the command-line specified by the
CTEST_CHECKOUT_COMMAND variable, if set, to initialize the source
directory.
Configuration settings include:
BuildDirectoryThe full path to the project build tree.
- CTest Script variable:
CTEST_BINARY_DIRECTORY CTestmodule variable:PROJECT_BINARY_DIR
- CTest Script variable:
SourceDirectoryThe full path to the project source tree.
- CTest Script variable:
CTEST_SOURCE_DIRECTORY CTestmodule variable:PROJECT_SOURCE_DIR
- CTest Script variable:
CTest Update Step¶
In a CTest Script, the ctest_update() command runs this step.
Arguments to the command may specify some of the step settings.
Configuration settings to specify the version control tool include:
BZRCommandbzrcommand-line tool to use if source tree is managed by Bazaar.- CTest Script variable:
CTEST_BZR_COMMAND CTestmodule variable: none
- CTest Script variable:
BZRUpdateOptionsCommand-line options to the
BZRCommandwhen updating the source.- CTest Script variable:
CTEST_BZR_UPDATE_OPTIONS CTestmodule variable: none
- CTest Script variable:
CVSCommandcvscommand-line tool to use if source tree is managed by CVS.- CTest Script variable:
CTEST_CVS_COMMAND CTestmodule variable:CVSCOMMAND
- CTest Script variable:
CVSUpdateOptionsCommand-line options to the
CVSCommandwhen updating the source.- CTest Script variable:
CTEST_CVS_UPDATE_OPTIONS CTestmodule variable:CVS_UPDATE_OPTIONS
- CTest Script variable:
GITCommandgitcommand-line tool to use if source tree is managed by Git.- CTest Script variable:
CTEST_GIT_COMMAND CTestmodule variable:GITCOMMAND
The source tree is updated by
git fetchfollowed bygit reset --hardto theFETCH_HEAD. The result is the same asgit pullexcept that any local modifications are overwritten. UseGITUpdateCustomto specify a different approach.- CTest Script variable:
GITInitSubmodulesIf set, CTest will update the repository’s submodules before updating.
- CTest Script variable:
CTEST_GIT_INIT_SUBMODULES CTestmodule variable:CTEST_GIT_INIT_SUBMODULES
- CTest Script variable:
GITUpdateCustomSpecify a custom command line (as a semicolon-separated list) to run in the source tree (Git work tree) to update it instead of running the
GITCommand.- CTest Script variable:
CTEST_GIT_UPDATE_CUSTOM CTestmodule variable:CTEST_GIT_UPDATE_CUSTOM
- CTest Script variable:
GITUpdateOptionsCommand-line options to the
GITCommandwhen updating the source.- CTest Script variable:
CTEST_GIT_UPDATE_OPTIONS CTestmodule variable:GIT_UPDATE_OPTIONS
- CTest Script variable:
HGCommandhgcommand-line tool to use if source tree is managed by Mercurial.- CTest Script variable:
CTEST_HG_COMMAND CTestmodule variable: none
- CTest Script variable:
HGUpdateOptionsCommand-line options to the
HGCommandwhen updating the source.- CTest Script variable:
CTEST_HG_UPDATE_OPTIONS CTestmodule variable: none
- CTest Script variable:
P4ClientValue of the
-coption to theP4Command.- CTest Script variable:
CTEST_P4_CLIENT CTestmodule variable:CTEST_P4_CLIENT
- CTest Script variable:
P4Commandp4command-line tool to use if source tree is managed by Perforce.- CTest Script variable:
CTEST_P4_COMMAND CTestmodule variable:P4COMMAND
- CTest Script variable:
P4OptionsCommand-line options to the
P4Commandfor all invocations.- CTest Script variable:
CTEST_P4_OPTIONS CTestmodule variable:CTEST_P4_OPTIONS
- CTest Script variable:
P4UpdateCustomSpecify a custom command line (as a semicolon-separated list) to run in the source tree (Perforce tree) to update it instead of running the
P4Command.- CTest Script variable: none
CTestmodule variable:CTEST_P4_UPDATE_CUSTOM
P4UpdateOptionsCommand-line options to the
P4Commandwhen updating the source.- CTest Script variable:
CTEST_P4_UPDATE_OPTIONS CTestmodule variable:CTEST_P4_UPDATE_OPTIONS
- CTest Script variable:
SVNCommandsvncommand-line tool to use if source tree is managed by Subversion.- CTest Script variable:
CTEST_SVN_COMMAND CTestmodule variable:SVNCOMMAND
- CTest Script variable:
SVNOptionsCommand-line options to the
SVNCommandfor all invocations.- CTest Script variable:
CTEST_SVN_OPTIONS CTestmodule variable:CTEST_SVN_OPTIONS
- CTest Script variable:
SVNUpdateOptionsCommand-line options to the
SVNCommandwhen updating the source.- CTest Script variable:
CTEST_SVN_UPDATE_OPTIONS CTestmodule variable:SVN_UPDATE_OPTIONS
- CTest Script variable:
UpdateCommandSpecify the version-control command-line tool to use without detecting the VCS that manages the source tree.
- CTest Script variable:
CTEST_UPDATE_COMMAND CTestmodule variable:<VCS>COMMANDwhenUPDATE_TYPEis<vcs>, elseUPDATE_COMMAND
- CTest Script variable:
UpdateOptionsCommand-line options to the
UpdateCommand.- CTest Script variable:
CTEST_UPDATE_OPTIONS CTestmodule variable:<VCS>_UPDATE_OPTIONSwhenUPDATE_TYPEis<vcs>, elseUPDATE_OPTIONS
- CTest Script variable:
UpdateTypeSpecify the version-control system that manages the source tree if it cannot be detected automatically. The value may be
bzr,cvs,git,hg,p4, orsvn.- CTest Script variable: none, detected from source tree
CTestmodule variable:UPDATE_TYPEif set, elseCTEST_UPDATE_TYPE
UpdateVersionOnlySpecify that you want the version control update command to only discover the current version that is checked out, and not to update to a different version.
- CTest Script variable:
CTEST_UPDATE_VERSION_ONLY
- CTest Script variable:
UpdateVersionOverrideSpecify the current version of your source tree.
When this variable is set to a non-empty string, CTest will report the value you specified rather than using the update command to discover the current version that is checked out. Use of this variable supersedes
UpdateVersionOnly. LikeUpdateVersionOnly, using this variable tells CTest not to update the source tree to a different version.- CTest Script variable:
CTEST_UPDATE_VERSION_OVERRIDE
- CTest Script variable:
Additional configuration settings include:
NightlyStartTimeIn the
Nightlydashboard mode, specify the “nightly start time”. With centralized version control systems (cvsandsvn), theUpdatestep checks out the version of the software as of this time so that multiple clients choose a common version to test. This is not well-defined in distributed version-control systems so the setting is ignored.- CTest Script variable:
CTEST_NIGHTLY_START_TIME CTestmodule variable:NIGHTLY_START_TIMEif set, elseCTEST_NIGHTLY_START_TIME
- CTest Script variable:
CTest Configure Step¶
In a CTest Script, the ctest_configure() command runs this step.
Arguments to the command may specify some of the step settings.
Configuration settings include:
ConfigureCommandCommand-line to launch the software configuration process. It will be executed in the location specified by the
BuildDirectorysetting.- CTest Script variable:
CTEST_CONFIGURE_COMMAND CTestmodule variable:CMAKE_COMMANDfollowed byPROJECT_SOURCE_DIR
- CTest Script variable:
LabelsForSubprojectsSpecify a semicolon-separated list of labels that will be treated as subprojects. This mapping will be passed on to CDash when configure, test or build results are submitted.
- CTest Script variable:
CTEST_LABELS_FOR_SUBPROJECTS CTestmodule variable:CTEST_LABELS_FOR_SUBPROJECTS
- CTest Script variable:
CTest Build Step¶
In a CTest Script, the ctest_build() command runs this step.
Arguments to the command may specify some of the step settings.
Configuration settings include:
DefaultCTestConfigurationTypeWhen the build system to be launched allows build-time selection of the configuration (e.g.
Debug,Release), this specifies the default configuration to be built when no-Coption is given to thectestcommand. The value will be substituted into the value ofMakeCommandto replace the literal string${CTEST_CONFIGURATION_TYPE}if it appears.- CTest Script variable:
CTEST_CONFIGURATION_TYPE CTestmodule variable:DEFAULT_CTEST_CONFIGURATION_TYPE, initialized by theCMAKE_CONFIG_TYPEenvironment variable
- CTest Script variable:
LabelsForSubprojectsSpecify a semicolon-separated list of labels that will be treated as subprojects. This mapping will be passed on to CDash when configure, test or build results are submitted.
- CTest Script variable:
CTEST_LABELS_FOR_SUBPROJECTS CTestmodule variable:CTEST_LABELS_FOR_SUBPROJECTS
- CTest Script variable:
MakeCommandCommand-line to launch the software build process. It will be executed in the location specified by the
BuildDirectorysetting.- CTest Script variable:
CTEST_BUILD_COMMAND CTestmodule variable:MAKECOMMAND, initialized by thebuild_command()command
- CTest Script variable:
UseLaunchersFor build trees generated by CMake using one of the Makefile Generators or the
Ninjagenerator, specify whether theCTEST_USE_LAUNCHERSfeature is enabled by theCTestUseLaunchersmodule (also included by theCTestmodule). When enabled, the generated build system wraps each invocation of the compiler, linker, or custom command line with a “launcher” that communicates with CTest via environment variables and files to report granular build warning and error information. Otherwise, CTest must “scrape” the build output log for diagnostics.- CTest Script variable:
CTEST_USE_LAUNCHERS CTestmodule variable:CTEST_USE_LAUNCHERS
- CTest Script variable:
CTest Test Step¶
In a CTest Script, the ctest_test() command runs this step.
Arguments to the command may specify some of the step settings.
Configuration settings include:
LabelsForSubprojectsSpecify a semicolon-separated list of labels that will be treated as subprojects. This mapping will be passed on to CDash when configure, test or build results are submitted.
- CTest Script variable:
CTEST_LABELS_FOR_SUBPROJECTS CTestmodule variable:CTEST_LABELS_FOR_SUBPROJECTS
- CTest Script variable:
TestLoadWhile running tests in parallel (e.g. with
-j), try not to start tests when they may cause the CPU load to pass above a given threshold.- CTest Script variable:
CTEST_TEST_LOAD CTestmodule variable:CTEST_TEST_LOAD
- CTest Script variable:
TimeOutThe default timeout for each test if not specified by the
TIMEOUTtest property.- CTest Script variable:
CTEST_TEST_TIMEOUT CTestmodule variable:DART_TESTING_TIMEOUT
- CTest Script variable:
CTest Coverage Step¶
In a CTest Script, the ctest_coverage() command runs this step.
Arguments to the command may specify some of the step settings.
Configuration settings include:
CoverageCommandCommand-line tool to perform software coverage analysis. It will be executed in the location specified by the
BuildDirectorysetting.- CTest Script variable:
CTEST_COVERAGE_COMMAND CTestmodule variable:COVERAGE_COMMAND
- CTest Script variable:
CoverageExtraFlagsSpecify command-line options to the
CoverageCommandtool.- CTest Script variable:
CTEST_COVERAGE_EXTRA_FLAGS CTestmodule variable:COVERAGE_EXTRA_FLAGS
These options are the first arguments passed to
CoverageCommand.- CTest Script variable:
CTest MemCheck Step¶
In a CTest Script, the ctest_memcheck() command runs this step.
Arguments to the command may specify some of the step settings.
Configuration settings include:
MemoryCheckCommandCommand-line tool to perform dynamic analysis. Test command lines will be launched through this tool.
- CTest Script variable:
CTEST_MEMORYCHECK_COMMAND CTestmodule variable:MEMORYCHECK_COMMAND
- CTest Script variable:
MemoryCheckCommandOptionsSpecify command-line options to the
MemoryCheckCommandtool. They will be placed prior to the test command line.- CTest Script variable:
CTEST_MEMORYCHECK_COMMAND_OPTIONS CTestmodule variable:MEMORYCHECK_COMMAND_OPTIONS
- CTest Script variable:
MemoryCheckTypeSpecify the type of memory checking to perform.
- CTest Script variable:
CTEST_MEMORYCHECK_TYPE CTestmodule variable:MEMORYCHECK_TYPE
- CTest Script variable:
MemoryCheckSanitizerOptionsSpecify options to sanitizers when running with a sanitize-enabled build.
- CTest Script variable:
CTEST_MEMORYCHECK_SANITIZER_OPTIONS CTestmodule variable:MEMORYCHECK_SANITIZER_OPTIONS
- CTest Script variable:
MemoryCheckSuppressionFileSpecify a file containing suppression rules for the
MemoryCheckCommandtool. It will be passed with options appropriate to the tool.- CTest Script variable:
CTEST_MEMORYCHECK_SUPPRESSIONS_FILE CTestmodule variable:MEMORYCHECK_SUPPRESSIONS_FILE
- CTest Script variable:
Additional configuration settings include:
BoundsCheckerCommandSpecify a
MemoryCheckCommandthat is known to be command-line compatible with Bounds Checker.- CTest Script variable: none
CTestmodule variable: none
PurifyCommandSpecify a
MemoryCheckCommandthat is known to be command-line compatible with Purify.- CTest Script variable: none
CTestmodule variable:PURIFYCOMMAND
ValgrindCommandSpecify a
MemoryCheckCommandthat is known to be command-line compatible with Valgrind.- CTest Script variable: none
CTestmodule variable:VALGRIND_COMMAND
ValgrindCommandOptionsSpecify command-line options to the
ValgrindCommandtool. They will be placed prior to the test command line.- CTest Script variable: none
CTestmodule variable:VALGRIND_COMMAND_OPTIONS
CTest Submit Step¶
In a CTest Script, the ctest_submit() command runs this step.
Arguments to the command may specify some of the step settings.
Configuration settings include:
BuildNameDescribe the dashboard client platform with a short string. (Operating system, compiler, etc.)
- CTest Script variable:
CTEST_BUILD_NAME CTestmodule variable:BUILDNAME
- CTest Script variable:
CDashVersionLegacy option. Not used.
- CTest Script variable: none, detected from server
CTestmodule variable:CTEST_CDASH_VERSION
CTestSubmitRetryCountSpecify a number of attempts to retry submission on network failure.
- CTest Script variable: none,
use the
ctest_submit()RETRY_COUNToption. CTestmodule variable:CTEST_SUBMIT_RETRY_COUNT
- CTest Script variable: none,
use the
CTestSubmitRetryDelaySpecify a delay before retrying submission on network failure.
- CTest Script variable: none,
use the
ctest_submit()RETRY_DELAYoption. CTestmodule variable:CTEST_SUBMIT_RETRY_DELAY
- CTest Script variable: none,
use the
CurlOptionsSpecify a semicolon-separated list of options to control the Curl library that CTest uses internally to connect to the server. Possible options are
CURLOPT_SSL_VERIFYPEER_OFFandCURLOPT_SSL_VERIFYHOST_OFF.- CTest Script variable:
CTEST_CURL_OPTIONS CTestmodule variable:CTEST_CURL_OPTIONS
- CTest Script variable:
DropLocationLegacy option. When
SubmitURLis not set, it is constructed fromDropMethod,DropSiteUser,DropSitePassword,DropSite, andDropLocation.- CTest Script variable:
CTEST_DROP_LOCATION CTestmodule variable:DROP_LOCATIONif set, elseCTEST_DROP_LOCATION
- CTest Script variable:
DropMethodLegacy option. When
SubmitURLis not set, it is constructed fromDropMethod,DropSiteUser,DropSitePassword,DropSite, andDropLocation.- CTest Script variable:
CTEST_DROP_METHOD CTestmodule variable:DROP_METHODif set, elseCTEST_DROP_METHOD
- CTest Script variable:
DropSiteLegacy option. When
SubmitURLis not set, it is constructed fromDropMethod,DropSiteUser,DropSitePassword,DropSite, andDropLocation.- CTest Script variable:
CTEST_DROP_SITE CTestmodule variable:DROP_SITEif set, elseCTEST_DROP_SITE
- CTest Script variable:
DropSitePasswordLegacy option. When
SubmitURLis not set, it is constructed fromDropMethod,DropSiteUser,DropSitePassword,DropSite, andDropLocation.- CTest Script variable:
CTEST_DROP_SITE_PASSWORD CTestmodule variable:DROP_SITE_PASSWORDif set, elseCTEST_DROP_SITE_PASWORD
- CTest Script variable:
DropSiteUserLegacy option. When
SubmitURLis not set, it is constructed fromDropMethod,DropSiteUser,DropSitePassword,DropSite, andDropLocation.- CTest Script variable:
CTEST_DROP_SITE_USER CTestmodule variable:DROP_SITE_USERif set, elseCTEST_DROP_SITE_USER
- CTest Script variable:
IsCDashLegacy option. Not used.
- CTest Script variable:
CTEST_DROP_SITE_CDASH CTestmodule variable:CTEST_DROP_SITE_CDASH
- CTest Script variable:
ScpCommandLegacy option. Not used.
- CTest Script variable:
CTEST_SCP_COMMAND CTestmodule variable:SCPCOMMAND
- CTest Script variable:
SiteDescribe the dashboard client host site with a short string. (Hostname, domain, etc.)
- CTest Script variable:
CTEST_SITE CTestmodule variable:SITE, initialized by thesite_name()command
- CTest Script variable:
SubmitURLThe
httporhttpsURL of the dashboard server to send the submission to.- CTest Script variable:
CTEST_SUBMIT_URL CTestmodule variable:SUBMIT_URLif set, elseCTEST_SUBMIT_URL
- CTest Script variable:
TriggerSiteLegacy option. Not used.
- CTest Script variable:
CTEST_TRIGGER_SITE CTestmodule variable:TRIGGER_SITEif set, elseCTEST_TRIGGER_SITE
- CTest Script variable:
Show as JSON Object Model¶
When the --show-only=json-v1 command line option is given, the test
information is output in JSON format. Version 1.0 of the JSON object
model is defined as follows:
kind- The string “ctestInfo”.
versionA JSON object specifying the version components. Its members are
major- A non-negative integer specifying the major version component.
minor- A non-negative integer specifying the minor version component.
backtraceGraphJSON object representing backtrace information with the following members:
commands- List of command names.
files- List of file names.
nodesList of node JSON objects with members:
command- Index into the
commandsmember of thebacktraceGraph. file- Index into the
filesmember of thebacktraceGraph. line- Line number in the file where the backtrace was added.
parent- Index into the
nodesmember of thebacktraceGraphrepresenting the parent in the graph.
testsA JSON array listing information about each test. Each entry is a JSON object with members:
name- Test name.
config- Configuration that the test can run on. Empty string means any config.
command- List where the first element is the test command and the remaining elements are the command arguments.
backtrace- Index into the
nodesmember of thebacktraceGraph. properties- Test properties. Can contain keys for each of the supported test properties.
See Also¶
The following resources are available to get help using CMake:
- Home Page
-
The primary starting point for learning about CMake.
- Online Documentation and Community Resources
https://cmake.org/documentation
Links to available documentation and community resources may be found on this web page.
- Mailing List
https://cmake.org/mailing-lists
For help and discussion about using CMake, a mailing list is provided at cmake@cmake.org. The list is member-post-only but one may sign up on the CMake web page. Please first read the full documentation at https://cmake.org before posting questions to the list.