MIRRORS/poky
1
0
Fork 0
mirror of git://git.yoctoproject.org/poky.git synced 2025-07-05 05:04:44 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

test-manual/ptest: Add info about fail state of ptest-runner/ptests

Browse Source 
On the ML was pointed about no specific information about
ptest-runner/ptests so improve docs around.

https://lists.yoctoproject.org/g/yocto-patches/message/1622

[YOCTO #15832]

(From yocto-docs rev: 0d1fd79019883f366d796b58a01679297d7a5508)

Signed-off-by: Anibal Limon <anibal@limonsoftware.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Anibal Limon 2025-06-19 16:13:15 +00:00 committed by Richard Purdie
parent c1ffedae46
commit a904fe5a03
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
documentation/test-manual/ptest.rst
View File

@ -46,13 +46,19 @@ Running ptest
=============
The ``ptest-runner`` package installs a shell script that loops through
all installed ptest test suites and runs them in sequence. Consequently,
you might want to add this package to your image.
all installed ptest test suites and runs them in sequence.
During the execution ``ptest-runner`` keeps count of total and failed
``ptests``. At end the execution summary is written to the console.
If any of the ``run-ptest`` fails, ``ptest-runner`` returns '1'.
Consequently, you might want to add ``ptest-runner`` to your image.
Getting Your Package Ready
==========================
In order to enable a recipe to run installed ptests on target hardware,
In order to enable a recipe to run installed ``ptests`` on target hardware,
you need to prepare the recipes that build the packages you want to
test. Here is what you have to do for each recipe:
@ -77,8 +83,9 @@ test. Here is what you have to do for each recipe:
- *Create run-ptest:* This script starts your test. Locate the
script where you will refer to it using
:term:`SRC_URI`. Here is an
example that starts a test for ``dbus``::
:term:`SRC_URI`. Be sure ``run-ptest`` exits with 0 to mark it
as successfully executed otherwise will be marked as fail.
Here is an example that starts a test for ``dbus``::
#!/bin/sh
cd test