Skip to content

Commit dab9a22

Browse files
committed
doc: twister: Added required_images key description.
Added short description of new keys added with shared app mechanism. Signed-off-by: Grzegorz Chwierut <[email protected]>
1 parent 9ddfa62 commit dab9a22

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

doc/develop/test/twister.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -793,6 +793,34 @@ filter: <expression>
793793
794794
Would match it.
795795

796+
required_images: <list of images>
797+
A list of test scenarios that are required to be built for this test to run.
798+
If the test does not have a ``CMakeLists.txt`` file or has set ``no_own_image``
799+
to True, then the first image from this list will be used as the test
800+
scenario image.
801+
All required test scenarios must be available from the tree (given with ``-T`` option).
802+
If a required test scenario is not available in tree or its build failed,
803+
the test will be skipped.
804+
If the required scenario is prefixed with a platform name, then it will be
805+
built for that platform only.
806+
The following is an example yaml with 2 required images.
807+
808+
.. code-block:: yaml
809+
810+
tests:
811+
shared.app.example:
812+
required_images:
813+
- test.example.first
814+
- native_sim:test.example.second
815+
no_own_image: True
816+
817+
Not supported with options: ``--subset`` or ``--runtime-artifact-cleanup``.
818+
819+
no_own_image: <True|False> (default False)
820+
If true, the test scenario will not be built. Instead, it
821+
will use the first test scenario from ``required_images`` list.
822+
Not supported on QEMU platforms.
823+
796824
required_snippets: <list of needed snippets>
797825
:ref:`Snippets <snippets>` are supported in twister for test scenarios that
798826
require them. As with normal applications, twister supports using the base

0 commit comments

Comments
 (0)