From 7e822e13de6b85e156d3508f076f580e63dda01e Mon Sep 17 00:00:00 2001 From: Antonin Godard Date: Tue, 25 Mar 2025 10:20:45 +0100 Subject: [PATCH] ref-manual/classes.rst: document the ptest-python-pytest class and variables 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 Signed-off-by: Richard Purdie --- documentation/ref-manual/classes.rst | 15 +++++++++++++++ documentation/ref-manual/variables.rst | 10 ++++++++++ 2 files changed, 25 insertions(+) diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 6797927fe8..8b930fe3d2 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -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 `__ 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`` diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 41bda5d0d6..8e0833bff4 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -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 `__ 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