CTEST(1) CMake CTEST(1)
NAME
ctest - CTest Command-Line Reference
Contents
o ctest(1)
o Synopsis
o Description
o Options
o Label and Subproject Summary
o Build and Test Mode
o Dashboard Client
o Dashboard Client Steps
o Dashboard Client Modes
o Dashboard Client via CTest Command-Line
o Dashboard Client via CTest Script
o Dashboard Client Configuration
o CTest Start Step
o CTest Update Step
o CTest Configure Step
o CTest Build Step
o CTest Test Step
o CTest Coverage Step
o CTest MemCheck Step
o CTest Submit Step
o Show as JSON Object Model
o Resource Allocation
o Resource Specification File
o RESOURCE_GROUPS Property
o Environment Variables
o See Also
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 config-
urations in the same tree. This option can be used to specify
which one should be tested. Example configurations are Debug
and Release.
--progress
Enable 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 ver-
bosity 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 vari-
able CTEST_PROGRESS_OUTPUT.
-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 CTEST_OUT-
PUT_ON_FAILURE environment variable
--stop-on-failure
Stop running the tests when the first failure happens.
-F Enable failover.
This option allows CTest to resume a test set execution that was
previously interrupted. If no interruption occurred, the -F op-
tion 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_LEVEL environment variable.
This option can be used with the PROCESSORS test property.
See Label and Subproject Summary.
--resource-spec-file <file>
Run CTest with resource allocation enabled, using the resource
specification file specified in <file>.
When ctest is run as a Dashboard Client this sets the Resource-
SpecFile option of the CTest Test Step.
--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 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. Op-
tions such as --verbose, --extra-verbose, and --debug are ig-
nored if --quiet is 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 -R and -E
options.
<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 particu-
lar fixture, that fixtures setup and cleanup tests would nor-
mally be added to the test set automatically. This option pre-
vents adding setup or cleanup tests for fixtures matching the
<regex>. Note that all other fixture behavior is retained, in-
cluding test dependencies and skipping tests that have fixture
setup tests that fail.
-FS <regex>, --fixture-exclude-setup <regex>
Same as -FA except only matching setup tests are excluded.
-FC <regex>, --fixture-exclude-cleanup <re.
CTEST(1) CMake CTEST(1)
NAME
ctest - CTest Command-Line Reference
Contents
o ctest(1)
o Synopsis
o Description
o Options
o Label and Subproject Summary
o Build and Test Mode
o Dashboard Client
o Dashboard Client Steps
o Dashboard Client Modes
o Dashboard Client via CTest Command-Line
o Dashboard Client via CTest Script
o Dashboard Client Configuration
o CTest Start Step
o CTest Update Step
o CTest Configure Step
o CTest Build Step
o CTest Test Step
o CTest Coverage Step
o CTest MemCheck Step
o CTest Submit Step
o Show as JSON Object Model
o Resource Allocation
o Resource Specification File
o RESOURCE_GROUPS Property
o Environment Variables
o See Also
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 config-
urations in the same tree. This option can be used to specify
which one should be tested. Example configurations are Debug
and Release.
--progress
Enable 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 ver-
bosity 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 vari-
able CTEST_PROGRESS_OUTPUT.
-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 CTEST_OUT-
PUT_ON_FAILURE environment variable
--stop-on-failure
Stop running the tests when the first failure happens.
-F Enable failover.
This option allows CTest to resume a test set execution that was
previously interrupted. If no interruption occurred, the -F op-
tion 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_LEVEL environment variable.
This option can be used with the PROCESSORS test property.
See Label and Subproject Summary.
--resource-spec-file <file>
Run CTest with resource allocation enabled, using the resource
specification file specified in <file>.
When ctest is run as a Dashboard Client this sets the Resource-
SpecFile option of the CTest Test Step.
--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 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. Op-
tions such as --verbose, --extra-verbose, and --debug are ig-
nored if --quiet is 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 -R and -E
options.
<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 particu-
lar fixture, that fixtures setup and cleanup tests would nor-
mally be added to the test set automatically. This option pre-
vents adding setup or cleanup tests for fixtures matching the
<regex>. Note that all other fixture behavior is retained, in-
cluding test dependencies and skipping tests that have fixture
setup tests that fail.
-FS <regex>, --fixture-exclude-setup <regex>
Same as -FA except only matching setup tests are excluded.
-FC <regex>, --fixture-exclude-cleanup <re.
CTEST(1) CMake CTEST(1)
NAME
ctest - CTest Command-Line Reference
Contents
o ctest(1)
o Synopsis
o Description
o Options
o Label and Subproject Summary
o Build and Test Mode
o Dashboard Client
o Dashboard Client Steps
o Dashboard Client Modes
o Dashboard Client via CTest Command-Line
o Dashboard Client via CTest Script
o Dashboard Client Configuration
o CTest Start Step
o CTest Update Step
o CTest Configure Step
o CTest Build Step
o CTest Test Step
o CTest Coverage Step
o CTest MemCheck Step
o CTest Submit Step
o Show as JSON Object Model
o Resource Allocation
o Resource Specification File
o RESOURCE_GROUPS Property
o Environment Variables
o See Also
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 config-
urations in the same tree. This option can be used to specify
which one should be tested. Example configurations are Debug
and Release.
--progress
Enable 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 ver-
bosity 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 vari-
able CTEST_PROGRESS_OUTPUT.
-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 CTEST_OUT-
PUT_ON_FAILURE environment variable
--stop-on-failure
Stop running the tests when the first failure happens.
-F Enable failover.
This option allows CTest to resume a test set execution that was
previously interrupted. If no interruption occurred, the -F op-
tion 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_LEVEL environment variable.
This option can be used with the PROCESSORS test property.
See Label and Subproject Summary.
--resource-spec-file <file>
Run CTest with resource allocation enabled, using the resource
specification file specified in <file>.
When ctest is run as a Dashboard Client this sets the Resource-
SpecFile option of the CTest Test Step.
--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 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. Op-
tions such as --verbose, --extra-verbose, and --debug are ig-
nored if --quiet is 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 -R and -E
options.
<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 particu-
lar fixture, that fixtures setup and cleanup tests would nor-
mally be added to the test set automatically. This option pre-
vents adding setup or cleanup tests for fixtures matching the
<regex>. Note that all other fixture behavior is retained, in-
cluding test dependencies and skipping tests that have fixture
setup tests that fail.
-FS <regex>, --fixture-exclude-setup <regex>
Same as -FA except only matching setup tests are excluded.
-FC <regex>, --fixture-exclude-cleanup <re.
CTEST(1) CMake CTEST(1)
NAME
ctest - CTest Command-Line Reference
Contents
o ctest(1)
o Synopsis
o Description
o Options
o Label and Subproject Summary
o Build and Test Mode
o Dashboard Client
o Dashboard Client Steps
o Dashboard Client Modes
o Dashboard Client via CTest Command-Line
o Dashboard Client via CTest Script
o Dashboard Client Configuration
o CTest Start Step
o CTest Update Step
o CTest Configure Step
o CTest Build Step
o CTest Test Step
o CTest Coverage Step
o CTest MemCheck Step
o CTest Submit Step
o Show as JSON Object Model
o Resource Allocation
o Resource Specification File
o RESOURCE_GROUPS Property
o Environment Variables
o See Also
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 config-
urations in the same tree. This option can be used to specify
which one should be tested. Example configurations are Debug
and Release.
--progress
Enable 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 ver-
bosity 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 vari-
able CTEST_PROGRESS_OUTPUT.
-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 CTEST_OUT-
PUT_ON_FAILURE environment variable
--stop-on-failure
Stop running the tests when the first failure happens.
-F Enable failover.
This option allows CTest to resume a test set execution that was
previously interrupted. If no interruption occurred, the -F op-
tion 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_LEVEL environment variable.
This option can be used with the PROCESSORS test property.
See Label and Subproject Summary.
--resource-spec-file <file>
Run CTest with resource allocation enabled, using the resource
specification file specified in <file>.
When ctest is run as a Dashboard Client this sets the Resource-
SpecFile option of the CTest Test Step.
--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 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. Op-
tions such as --verbose, --extra-verbose, and --debug are ig-
nored if --quiet is 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 -R and -E
options.
<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 particu-
lar fixture, that fixtures setup and cleanup tests would nor-
mally be added to the test set automatically. This option pre-
vents adding setup or cleanup tests for fixtures matching the
<regex>. Note that all other fixture behavior is retained, in-
cluding test dependencies and skipping tests that have fixture
setup tests that fail.
-FS <regex>, --fixture-exclude-setup <regex>
Same as -FA except only matching setup tests are excluded.
-FC <regex>, --fixture-exclude-cleanup <re.
CTEST(1) CMake CTEST(1)
NAME
ctest - CTest Command-Line Reference
Contents
o ctest(1)
o Synopsis
o Description
o Options
o Label and Subproject Summary
o Build and Test Mode
o Dashboard Client
o Dashboard Client Steps
o Dashboard Client Modes
o Dashboard Client via CTest Command-Line
o Dashboard Client via CTest Script
o Dashboard Client Configuration
o CTest Start Step
o CTest Update Step
o CTest Configure Step
o CTest Build Step
o CTest Test Step
o CTest Coverage Step
o CTest MemCheck Step
o CTest Submit Step
o Show as JSON Object Model
o Resource Allocation
o Resource Specification File
o RESOURCE_GROUPS Property
o Environment Variables
o See Also
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 config-
urations in the same tree. This option can be used to specify
which one should be tested. Example configurations are Debug
and Release.
--progress
Enable 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 ver-
bosity 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 vari-
able CTEST_PROGRESS_OUTPUT.
-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 CTEST_OUT-
PUT_ON_FAILURE environment variable
--stop-on-failure
Stop running the tests when the first failure happens.
-F Enable failover.
This option allows CTest to resume a test set execution that was
previously interrupted. If no interruption occurred, the -F op-
tion 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_LEVEL environment variable.
This option can be used with the PROCESSORS test property.
See Label and Subproject Summary.
--resource-spec-file <file>
Run CTest with resource allocation enabled, using the resource
specification file specified in <file>.
When ctest is run as a Dashboard Client this sets the Resource-
SpecFile option of the CTest Test Step.
--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 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. Op-
tions such as --verbose, --extra-verbose, and --debug are ig-
nored if --quiet is 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 -R and -E
options.
<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 particu-
lar fixture, that fixtures setup and cleanup tests would nor-
mally be added to the test set automatically. This option pre-
vents adding setup or cleanup tests for fixtures matching the
<regex>. Note that all other fixture behavior is retained, in-
cluding test dependencies and skipping tests that have fixture
setup tests that fail.
-FS <regex>, --fixture-exclude-setup <regex>
Same as -FA except only matching setup tests are excluded.
-FC <regex>, --fixture-exclude-cleanup <re.
CTEST(1) CMake CTEST(1)
NAME
ctest - CTest Command-Line Reference
Contents
o ctest(1)
o Synopsis
o Description
o Options
o Label and Subproject Summary
o Build and Test Mode
o Dashboard Client
o Dashboard Client Steps
o Dashboard Client Modes
o Dashboard Client via CTest Command-Line
o Dashboard Client via CTest Script
o Dashboard Client Configuration
o CTest Start Step
o CTest Update Step
o CTest Configure Step
o CTest Build Step
o CTest Test Step
o CTest Coverage Step
o CTest MemCheck Step
o CTest Submit Step
o Show as JSON Object Model
o Resource Allocation
o Resource Specification File
o RESOURCE_GROUPS Property
o Environment Variables
o See Also
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 config-
urations in the same tree. This option can be used to specify
which one should be tested. Example configurations are Debug
and Release.
--progress
Enable 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 ver-
bosity 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 vari-
able CTEST_PROGRESS_OUTPUT.
-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 CTEST_OUT-
PUT_ON_FAILURE environment variable
--stop-on-failure
Stop running the tests when the first failure happens.
-F Enable failover.
This option allows CTest to resume a test set execution that was
previously interrupted. If no interruption occurred, the -F op-
tion 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_LEVEL environment variable.
This option can be used with the PROCESSORS test property.
See Label and Subproject Summary.
--resource-spec-file <file>
Run CTest with resource allocation enabled, using the resource
specification file specified in <file>.
When ctest is run as a Dashboard Client this sets the Resource-
SpecFile option of the CTest Test Step.
--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 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. Op-
tions such as --verbose, --extra-verbose, and --debug are ig-
nored if --quiet is 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 -R and -E
options.
<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 particu-
lar fixture, that fixtures setup and cleanup tests would nor-
mally be added to the test set automatically. This option pre-
vents adding setup or cleanup tests for fixtures matching the
<regex>. Note that all other fixture behavior is retained, in-
cluding test dependencies and skipping tests that have fixture
setup tests that fail.
-FS <regex>, --fixture-exclude-setup <regex>
Same as -FA except only matching setup tests are excluded.
-FC <regex>, --fixture-exclude-cleanup <re.
CTEST(1) CMake CTEST(1)
NAME
ctest - CTest Command-Line Reference
Contents
o ctest(1)
o Synopsis
o Description
o Options
o Label and Subproject Summary
o Build and Test Mode
o Dashboard Client
o Dashboard Client Steps
o Dashboard Client Modes
o Dashboard Client via CTest Command-Line
o Dashboard Client via CTest Script
o Dashboard Client Configuration
o CTest Start Step
o CTest Update Step
o CTest Configure Step
o CTest Build Step
o CTest Test Step
o CTest Coverage Step
o CTest MemCheck Step
o CTest Submit Step
o Show as JSON Object Model
o Resource Allocation
o Resource Specification File
o RESOURCE_GROUPS Property
o Environment Variables
o See Also
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 config-
urations in the same tree. This option can be used to specify
which one should be tested. Example configurations are Debug
and Release.
--progress
Enable 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 ver-
bosity 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 vari-
able CTEST_PROGRESS_OUTPUT.
-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 CTEST_OUT-
PUT_ON_FAILURE environment variable
--stop-on-failure
Stop running the tests when the first failure happens.
-F Enable failover.
This option allows CTest to resume a test set execution that was
previously interrupted. If no interruption occurred, the -F op-
tion 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_LEVEL environment variable.
This option can be used with the PROCESSORS test property.
See Label and Subproject Summary.
--resource-spec-file <file>
Run CTest with resource allocation enabled, using the resource
specification file specified in <file>.
When ctest is run as a Dashboard Client this sets the Resource-
SpecFile option of the CTest Test Step.
--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 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. Op-
tions such as --verbose, --extra-verbose, and --debug are ig-
nored if --quiet is 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 -R and -E
options.
<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 particu-
lar fixture, that fixtures setup and cleanup tests would nor-
mally be added to the test set automatically. This option pre-
vents adding setup or cleanup tests for fixtures matching the
<regex>. Note that all other fixture behavior is retained, in-
cluding test dependencies and skipping tests that have fixture
setup tests that fail.
-FS <regex>, --fixture-exclude-setup <regex>
Same as -FA except only matching setup tests are excluded.
-FC <regex>, --fixture-exclude-cleanup <re.
CTEST(1) CMake CTEST(1)
NAME
ctest - CTest Command-Line Reference
Contents
o ctest(1)
o Synopsis
o Description
o Options
o Label and Subproject Summary
o Build and Test Mode
o Dashboard Client
o Dashboard Client Steps
o Dashboard Client Modes
o Dashboard Client via CTest Command-Line
o Dashboard Client via CTest Script
o Dashboard Client Configuration
o CTest Start Step
o CTest Update Step
o CTest Configure Step
o CTest Build Step
o CTest Test Step
o CTest Coverage Step
o CTest MemCheck Step
o CTest Submit Step
o Show as JSON Object Model
o Resource Allocation
o Resource Specification File
o RESOURCE_GROUPS Property
o Environment Variables
o See Also
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 config-
urations in the same tree. This option can be used to specify
which one should be tested. Example configurations are Debug
and Release.
--progress
Enable 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 ver-
bosity 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 vari-
able CTEST_PROGRESS_OUTPUT.
-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 CTEST_OUT-
PUT_ON_FAILURE environment variable
--stop-on-failure
Stop running the tests when the first failure happens.
-F Enable failover.
This option allows CTest to resume a test set execution that was
previously interrupted. If no interruption occurred, the -F op-
tion 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_LEVEL environment variable.
This option can be used with the PROCESSORS test property.
See Label and Subproject Summary.
--resource-spec-file <file>
Run CTest with resource allocation enabled, using the resource
specification file specified in <file>.
When ctest is run as a Dashboard Client this sets the Resource-
SpecFile option of the CTest Test Step.
--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 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. Op-
tions such as --verbose, --extra-verbose, and --debug are ig-
nored if --quiet is 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 -R and -E
options.
<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 particu-
lar fixture, that fixtures setup and cleanup tests would nor-
mally be added to the test set automatically. This option pre-
vents adding setup or cleanup tests for fixtures matching the
<regex>. Note that all other fixture behavior is retained, in-
cluding test dependencies and skipping tests that have fixture
setup tests that fail.
-FS <regex>, --fixture-exclude-setup <regex>
Same as -FA except only matching setup tests are excluded.
-FC <regex>, --fixture-exclude-cleanup <re.
CTEST(1) CMake CTEST(1)
NAME
ctest - CTest Command-Line Reference
3.18.4 September 13, 2021 CTEST(1)
Czas wygenerowania: 0.00053 sek.
Created with the man page lookup class by Andrew Collington.
Based on a C man page viewer by Vadim Pavlov
Unicode soft-hyphen fix (as used by RedHat) by Dan Edwards
Some optimisations by Eli Argon
Caching idea and code contribution by James Richardson
Copyright © 2003-2025 Linux.pl
Hosted by Hosting Linux.pl