text stringlengths 0 88 |
|---|
- If CTest is asked to run only a subset of tests (e.g. using regular |
expressions or the ``--rerun-failed`` option) and the setup test is not in |
the set of tests to run, it will automatically be added if any tests in the |
set require any fixture listed in ``FIXTURES_SETUP``. |
A setup test can have multiple fixtures listed in its ``FIXTURES_SETUP`` |
property. It will execute only once for the whole CTest run, not once for each |
fixture. A fixture can also have more than one setup test defined. If there are |
multiple setup tests for a fixture, projects can control their order with the |
usual :prop_test:`DEPENDS` test property if necessary. |
A setup test is allowed to require other fixtures, but not any fixture listed |
in its ``FIXTURES_SETUP`` property. For example: |
.. code-block:: cmake |
# Ok: dependent fixture is different to setup |
set_tests_properties(setupFoo PROPERTIES |
FIXTURES_SETUP Foo |
FIXTURES_REQUIRED Bar |
) |
# Error: cannot require same fixture as setup |
set_tests_properties(setupFoo PROPERTIES |
FIXTURES_SETUP Foo |
FIXTURES_REQUIRED Foo |
) |
If any of a fixture's setup tests fail, none of the tests listing that fixture |
in its :prop_test:`FIXTURES_REQUIRED` property will be run. Cleanup tests will, |
however, still be executed. |
See :prop_test:`FIXTURES_REQUIRED` for a more complete discussion of how to use |
test fixtures. |
LABELS |
------ |
Specify a list of text labels associated with a test. The labels are |
reported in both the :program:`ctest` output summary and in dashboard submissions. |
They can also be used to filter the set of tests to be executed (see the |
:option:`ctest -L` and :option:`ctest -LE` options). |
See :ref:`Additional Labels` for adding labels to a test dynamically during |
test execution. |
MEASUREMENT |
----------- |
Specify a ``CDASH`` measurement and value to be reported for a test. |
If set to a name then that name will be reported to ``CDASH`` as a named |
measurement with a value of ``1``. You may also specify a value by |
setting ``MEASUREMENT`` to ``measurement=value``. |
PASS_REGULAR_EXPRESSION |
----------------------- |
The output must match this regular expression for the test to pass. |
The process exit code is ignored. |
If set, the test output will be checked against the specified regular |
expressions and at least one of the regular expressions has to match, |
otherwise the test will fail. Example: |
.. code-block:: cmake |
set_tests_properties(mytest PROPERTIES |
PASS_REGULAR_EXPRESSION "TestPassed;All ok" |
) |
``PASS_REGULAR_EXPRESSION`` expects a list of regular expressions. |
See also the :prop_test:`FAIL_REGULAR_EXPRESSION` and |
:prop_test:`SKIP_REGULAR_EXPRESSION` test properties. |
PROCESSORS |
---------- |
Set to specify how many process slots this test requires. |
If not set, the default is ``1`` processor. |
Denotes the number of processors that this test will require. This is |
typically used for MPI tests, and should be used in conjunction with |
the :command:`ctest_test` ``PARALLEL_LEVEL`` option. |
This will also be used to display a weighted test timing result in label and |
subproject summaries in the command line output of :manual:`ctest(1)`. The wall |
clock time for the test run will be multiplied by this property to give a |
better idea of how much cpu resource CTest allocated for the test. |
See also the :prop_test:`PROCESSOR_AFFINITY` test property. |
PROCESSOR_AFFINITY |
------------------ |
.. versionadded:: 3.12 |
Set to a true value to ask CTest to launch the test process with CPU affinity |
for a fixed set of processors. If enabled and supported for the current |
platform, CTest will choose a set of processors to place in the CPU affinity |
mask when launching the test process. The number of processors in the set is |
determined by the :prop_test:`PROCESSORS` test property or the number of |
processors available to CTest, whichever is smaller. The set of processors |
chosen will be disjoint from the processors assigned to other concurrently |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.