mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-02-20 08:29:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

ref-manual/classes.rst: document the ptest-python-pytest class and variables

Browse Source 
Add documentation for the ptest-python-pytest class, and the
PTEST_PYTEST_DIR variable which can be overriden.

(From yocto-docs rev: 1abee62c2b9f32dfa42782893940f211db930b4c)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Antonin Godard
2025-03-25 10:20:45 +01:00
committed by Richard Purdie
parent 498666694f
commit 7e822e13de
2 changed files with 25 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
documentation/ref-manual/classes.rst
View File

@@ -2707,6 +2707,21 @@ For information on setting up and running ptests, see the
":ref:`test-manual/ptest:testing packages with ptest`"
section in the Yocto Project Development Tasks Manual.
.. _ref-classes-ptest-python-pytest:
``ptest-python-pytest``
=======================
The :ref:`ref-classes-ptest-python-pytest` class can be used in Python-based
recipes to automatically configure the :ref:`ref-classes-ptest` class for Python
packages leveraging the `pytest <https://docs.pytest.org>`__ unit test framework.
Within the recipe, the :term:`PTEST_PYTEST_DIR` variable can be overridden to
specify the path to the directory containing the tests (default value:
``tests``). Test contained in this directory are installed in :term:`D` by the
:ref:`ref-tasks-install_ptest_base` task, as well as a specific ``run-ptest``
script for this task.
.. _ref-classes-python3-dir:
``python3-dir``

10
documentation/ref-manual/variables.rst
View File

@@ -7110,6 +7110,16 @@ system and gives an overview of their function and contents.
at build time should be done by adding "ptest" to (or removing it
from) :term:`DISTRO_FEATURES`.
:term:`PTEST_PYTEST_DIR`
Within the :ref:`ref-classes-ptest-python-pytest` class, the
:term:`PTEST_PYTEST_DIR` variable represents the path within the source
tree of a Python package holding the unit tests to be tested with the
`pytest <https://docs.pytest.org>`__ framework. The default value for this
variable is ``tests``.
For more information, see
the :ref:`ref-classes-ptest-python-pytest` class documentation.
:term:`PV`
The version of the recipe. The version is normally extracted from the
recipe filename. For example, if the recipe is named