Skip to content

Commit 22a82bc

Browse files
PerMacnashif
authored andcommitted
docs: twister: Add section about quarantine feature
Add section about quarantine feature Signed-off-by: Maciej Perkowski <[email protected]>
1 parent 9c6dfce commit 22a82bc

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

doc/guides/test/twister.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -634,3 +634,40 @@ using an external J-Link probe. The "probe_id" keyword overrides the
634634
product: DAPLink CMSIS-DAP
635635
runner: jlink
636636
serial: null
637+
638+
Quarantine
639+
++++++++++
640+
641+
Twister allows using user-defined yaml files defining the list of tests to be put
642+
under quarantine. Such tests will be skipped and marked accordingly in the output
643+
reports. This feature is especially useful when running larger test suits, where
644+
a failure of one test can affect the execution of other tests (e.g. putting the
645+
physical board in a corrupted state).
646+
647+
To use the quarantine feature one has to add the argument
648+
``--quarantine-list <PATH_TO_QUARANTINE_YAML>`` to a twister call.
649+
The current status of tests on the quarantine list can also be verified by adding
650+
``--quarantine-verify`` to the above argument. This will make twister skip all tests
651+
which are not on the given list.
652+
653+
A quarantine yaml has to be a sequence of dictionaries. Each dictionary has to have
654+
"scenarios" and "platforms" entries listing combinations of scenarios and platforms
655+
to put under quarantine. In addition, an optional entry "comment" can be used, where
656+
some more details can be given (e.g. link to a reported issue). These comments will also
657+
be added to the output reports.
658+
659+
An example of entries in a quarantine yaml::
660+
661+
- scenarios:
662+
- sample.basic.helloworld
663+
platforms:
664+
- all
665+
comment: "Link to the issue: https://github.com/zephyrproject-rtos/zephyr/pull/33287"
666+
667+
- scenarios:
668+
- kernel.common
669+
- kernel.common.misra
670+
- kernel.common.nano64
671+
platforms:
672+
- qemu_cortex_m3
673+
- native_posix

0 commit comments

Comments
 (0)