Help/manual/presets/execution-properties.rst

.. This file was generated by Utilities/Scripts/regenerate-presets.py
   from Help/manual/presets/schema.yaml. Do not edit.

.. _`CMakePresets.testPresets.execution.stopOnFailure`:

``stopOnFailure``
  An optional bool. If ``true``, equivalent to passing
  :ctest-option:`--stop-on-failure` on the command line.

.. _`CMakePresets.testPresets.execution.enableFailover`:

``enableFailover``
  An optional bool. If ``true``, equivalent to passing
  :ctest-option:`-F` on the command line.

.. _`CMakePresets.testPresets.execution.jobs`:

``jobs``
  An optional integer. Equivalent to passing
  :ctest-option:`--parallel` on the command line. If the value is
  ``0``, it is equivalent to unbounded parallelism.

  If set, this field takes precedence over the
  :envvar:`CTEST_PARALLEL_LEVEL` environment variable,
  including when that variable is instead set via this test
  preset's own :preset:`testPresets.environment` field.

  .. presets-versionchanged:: 11

    This field can also be a string, in which case it must be
    empty, and is equivalent to passing ``--parallel`` with
    ``<jobs>`` omitted.

  .. versionchanged:: 4.3

    This field does not accept negative integer values,
    regardless of the version in the presets file.

.. _`CMakePresets.testPresets.execution.resourceSpecFile`:

``resourceSpecFile``
  An optional string. Equivalent to passing
  :ctest-option:`--resource-spec-file` on the command line. This
  field supports `macro expansion`_.

.. _`CMakePresets.testPresets.execution.testLoad`:

``testLoad``
  An optional integer. Equivalent to passing
  :ctest-option:`--test-load` on the command line.

.. _`CMakePresets.testPresets.execution.showOnly`:

``showOnly``
  An optional string. Equivalent to passing
  :ctest-option:`--show-only` on the command line. The string
  must be one of the following values:

  * ``human``

  * ``json-v1``

  * ``json-v1-raw``

.. _`CMakePresets.testPresets.execution.repeat`:

``repeat``
  An optional object specifying how to repeat tests. Equivalent
  to passing :ctest-option:`--repeat` on the command line.
  The object must have the following fields:

  .. include:: presets/repeat-properties.rst

.. _`CMakePresets.testPresets.execution.interactiveDebugging`:

``interactiveDebugging``
  An optional bool. If ``true``, equivalent to passing
  :ctest-option:`--interactive-debug-mode 1` on the command line.
  If ``false``, equivalent to passing
  :ctest-option:`--interactive-debug-mode 0` on the command line.

.. _`CMakePresets.testPresets.execution.scheduleRandom`:

``scheduleRandom``
  An optional bool. If ``true``, equivalent to passing
  :ctest-option:`--schedule-random` on the command line.

.. _`CMakePresets.testPresets.execution.timeout`:

``timeout``
  An optional integer. Equivalent to passing
  :ctest-option:`--timeout` on the command line.

.. _`CMakePresets.testPresets.execution.noTestsAction`:

``noTestsAction``
  An optional string specifying the behavior if no tests are
  found. Must be one of the following values:

  ``default``
    Equivalent to not passing any value on the command line.

  ``error``
    Equivalent to passing :ctest-option:`--no-tests=error`
    on the command line.

  ``ignore``
    Equivalent to passing :ctest-option:`--no-tests=ignore`
    on the command line.

  If set, this field is overridden by the
  :envvar:`CTEST_NO_TESTS_ACTION` environment variable,
  including when that variable is instead set via this test
  preset's own :preset:`testPresets.environment` field.
  See :envvar:`CTEST_NO_TESTS_ACTION` for the full precedence
  order.

.. _`CMakePresets.testPresets.execution.testPassthroughArguments`:

``testPassthroughArguments``
  .. presets-versionadded:: 12

  An optional array of strings. Each element is forwarded as an
  argument to every test executable, equivalent to passing
  arguments after :option:`ctest --` on the command line.

  When both preset and command-line passthrough arguments are
  specified, preset arguments appear first, followed by
  command-line arguments.