.. cmake-manual-description: CTest Command-Line Reference ctest(1) ******** Synopsis ======== .. parsed-literal:: ctest [] 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 , --build-config `` 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 "Debug" and "Release". ``-V,--verbose`` Enable verbose output from tests. Test output is normally suppressed and only summary information is displayed. This option will show all test output. ``-VV,--extra-verbose`` Enable more verbose output from tests. Test output is normally suppressed and only summary information is displayed. This option will show even more test output. ``--debug`` Displaying 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 environment variable ``CTEST_OUTPUT_ON_FAILURE``. ``-F`` Enable failover. This option allows ctest to resume a test set execution that was previously interrupted. If no interruption occurred, the -F option will have no effect. ``-j , --parallel `` 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 environment variable ``CTEST_PARALLEL_LEVEL``. ``--test-load `` 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 ``ctest`` is run as a `Dashboard Client`_ this sets the ``TestLoad`` option of the `CTest Test Step`_. ``-Q,--quiet`` Make ctest quiet. This option will suppress all the output. The output log file will still be generated if the --output-log is specified. Options such as --verbose, --extra-verbose, and --debug are ignored if --quiet is specified. ``-O , --output-log `` Output to log file This option tells ctest to write all its output to a log file. ``-N,--show-only`` 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 -R and -E options. ``-L , --label-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 , --tests-regex `` Run tests matching regular expression. This option tells ctest to run only the tests whose names match the given regular expression. ``-E , --exclude-regex `` Exclude tests matching regular expression. This option tells ctest to NOT run the tests whose names match the given regular expression. ``-LE , --label-exclude `` Exclude tests with labels matching regular expression. This option tells ctest to NOT run the tests whose labels match the given regular expression. ``-D , --dashboard `` Execute dashboard test This option tells ctest to act as a CDash client and perform a dashboard test. All tests are , where Mode can be Experimental, Nightly, and Continuous, and Test can be Start, Update, Configure, Build, Test, Coverage, and Submit. ``-D :=`` Define a variable for script mode Pass in variable values on the command line. Use in conjunction with -S to pass variable values to a dashboard script. Parsing -D arguments as variable values is only attempted if the value following -D does not match any of the known dashboard types. ``-M , --test-model `` Sets the model for a dashboard This option tells ctest to act as a CDash client where the TestModel can be Experimental, Nightly, and Continuous. Combining -M and -T is similar to -D ``-T , --test-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, test etc. Combining -M and -T is similar to -D ``--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. ``-S