summaryrefslogtreecommitdiffstats
path: root/documentation/test-manual
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/test-manual')
-rw-r--r--documentation/test-manual/ptest.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/documentation/test-manual/ptest.rst b/documentation/test-manual/ptest.rst
index dea1bad23b..4248b98bd4 100644
--- a/documentation/test-manual/ptest.rst
+++ b/documentation/test-manual/ptest.rst
@@ -70,6 +70,25 @@ test. Here is what you have to do for each recipe:
70 cd test 70 cd test
71 make -k runtest-TESTS 71 make -k runtest-TESTS
72 72
73- *Return an appropriate exit code*: The ``run-ptest`` script must return 0 on
74 success, 1 on failure. This is needed by ``ptest-runner`` to keep track of
75 the successful and failed tests.
76
77- *Make sure the test prints at least one test result*: The execution of the
78 ``run-ptest`` script must result in at least one test result output on the
79 console, with the following format::
80
81 result: testname
82
83 Where ``result`` can be one of ``PASS``, ``SKIP``, or ``FAIL``. ``testname``
84 can be any name.
85
86 There can be as many test results as desired.
87
88 This information is read by the :ref:`ref-classes-testimage` class and
89 :oe_git:`logparser </openembedded-core/tree/meta/lib/oeqa/utils/logparser.py>`
90 module.
91
73- *Ensure dependencies are met:* If the test adds build or runtime 92- *Ensure dependencies are met:* If the test adds build or runtime
74 dependencies that normally do not exist for the package (such as 93 dependencies that normally do not exist for the package (such as
75 requiring "make" to run the test suite), use the 94 requiring "make" to run the test suite), use the