Skip to content

Commit

Permalink
docs: twister: Add section about quarantine feature
Browse files Browse the repository at this point in the history
Add section about quarantine feature

Signed-off-by: Maciej Perkowski <[email protected]>
  • Loading branch information
PerMac authored and nashif committed Apr 12, 2021
1 parent 9c6dfce commit 22a82bc
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions doc/guides/test/twister.rst
Original file line number Diff line number Diff line change
Expand Up @@ -634,3 +634,40 @@ using an external J-Link probe. The "probe_id" keyword overrides the
product: DAPLink CMSIS-DAP
runner: jlink
serial: null

Quarantine
++++++++++

Twister allows using user-defined yaml files defining the list of tests to be put
under quarantine. Such tests will be skipped and marked accordingly in the output
reports. This feature is especially useful when running larger test suits, where
a failure of one test can affect the execution of other tests (e.g. putting the
physical board in a corrupted state).

To use the quarantine feature one has to add the argument
``--quarantine-list <PATH_TO_QUARANTINE_YAML>`` to a twister call.
The current status of tests on the quarantine list can also be verified by adding
``--quarantine-verify`` to the above argument. This will make twister skip all tests
which are not on the given list.

A quarantine yaml has to be a sequence of dictionaries. Each dictionary has to have
"scenarios" and "platforms" entries listing combinations of scenarios and platforms
to put under quarantine. In addition, an optional entry "comment" can be used, where
some more details can be given (e.g. link to a reported issue). These comments will also
be added to the output reports.

An example of entries in a quarantine yaml::

- scenarios:
- sample.basic.helloworld
platforms:
- all
comment: "Link to the issue: https:/zephyrproject-rtos/zephyr/pull/33287"

- scenarios:
- kernel.common
- kernel.common.misra
- kernel.common.nano64
platforms:
- qemu_cortex_m3
- native_posix

0 comments on commit 22a82bc

Please sign in to comment.