michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: twister: ztest: Add test application diagram

Browse source 
Add a diagram to illustrate a test application's project
components with relationships between Ztest and Twister
objects.

Signed-off-by: Dmitrii Golovanov <dmitrii.golovanov@intel.com>
This commit is contained in:
Dmitrii Golovanov 2024-06-23 16:14:05 +02:00 • committed by Anas Nashif
commit 5d763534d6
3 changed files with 32 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/develop/test/figures/twister_test_project.svg generated Normal file
View file

File diff suppressed because one or more lines are too long
Side by side

After

Width:  |  Height:  |  Size: 131 KiB

9
doc/develop/test/twister.rst
View file

@ -218,6 +218,15 @@ files in the application's project directory. This test application
configuration file may contain one or more entries in the tests section each
identifying a test scenario.
.. _twister_test_project_diagram:
.. figure:: figures/twister_test_project.svg
:alt: Twister and a Test applications' project.
:figclass: align-center
Twister and a Test applications' project.
Test application configurations are written using the YAML syntax and share the
same structure as samples.

32
doc/develop/test/ztest.rst
View file

@ -215,25 +215,31 @@ function can be written as follows:
Quick start - Integration testing
*********************************
A simple working base is located at :zephyr_file:`samples/subsys/testsuite/integration`. Just
copy the files to ``tests/`` and edit them for your needs. The test will then
be automatically built and run by the twister script. If you are testing
the **bar** component of **foo**, you should copy the sample folder to
``tests/foo/bar``. It can then be tested with:
A simple working base is located at :zephyr_file:`samples/subsys/testsuite/integration`.
To make a test application for the **bar** component of **foo**, you should copy the
sample folder to ``tests/foo/bar`` and edit files there adjusting for your test
application's purposes.
.. code-block:: console
./scripts/twister -s tests/foo/bar/test-identifier
In the example above ``tests/foo/bar`` signifies the path to the test and the
``test-identifier`` references a test scenario defined in the :file:`testcase.yaml` file.
To run all test scenarios defined in a test application, run:
To build and execute all applicable test scenarios defined in your test application
use the :ref:`Twister <twister_script>` tool, for example:
.. code-block:: console
./scripts/twister -T tests/foo/bar/
To select just one of the test scenarios, run Twister with ``--scenario`` command:
.. code-block:: console
./scripts/twister --scenario tests/foo/bar/your.test.scenario.name
In the command line above ``tests/foo/bar`` is the path to your test application and
``your.test.scenario.name`` references a test scenario defined in :file:`testcase.yaml`
file, which is like ``sample.testing.ztest`` in the boilerplate test suite sample.
See :ref:`Twister test project diagram <twister_test_project_diagram>` for more details
on how Twister deals with Ztest application.
The sample contains the following files:
CMakeLists.txt