Re: [bitbake-devel] [PATCH] doc: improve BitBake README testing instructions

Re: [bitbake-devel] [PATCH] doc: improve BitBake README testing instructions

[Antonin Godard]

Hi,

On Mon Aug 18, 2025 at 6:33 PM CEST, Mohamed Ayman via lists.openembedded.org wrote:
> Clarified the testing section by:
> - Adding context on setting PATH before running selftests
> - Documenting how to install pytest using pip
> - Providing an example command for running pytest on lib/bb/tests
>
> These additions make it easier for new contributors to run the
> testsuite and ensure consistent testing practices.
>
> Signed-off-by: Mohamed Ayman <mohamedaymanworkspace2@gmail.com>
> ---
>  bitbake/README | 7 +++++++
>  1 file changed, 7 insertions(+)
>
> diff --git a/bitbake/README b/bitbake/README
> index e9f4c858ee..938eec47ce 100644
> --- a/bitbake/README
> +++ b/bitbake/README
> @@ -54,10 +54,17 @@ The assumption is made that this testsuite is run from an initialized OpenEmbedd
>  environment (i.e. `source oe-init-build-env` is used). If this is not the case, run the
>  testsuite as follows:
>
> +# ensure local tools are on PATH and run the selftest script

This should probably be aligned to "export PATH=$(pwd)/bin:$PATH" below?

    # ensure local tools are on PATH and run the selftest script
    export PATH=$(pwd)/bin:$PATH
    bin/bitbake-selftest

>      export PATH=$(pwd)/bin:$PATH
>      bin/bitbake-selftest
>
>  The testsuite can alternatively be executed using pytest, e.g. obtained from PyPI (in this
>  case, the PATH is configured automatically):
>
> +# install pytest into a virtualenv or pipx (recommended)
> +python -m pip install --user pytest
> +
> +# run tests (example)
> +python -m pytest lib/bb/tests -q

Same comment as the one above.

Otherwise, how does this differ from simply running "pytest"?

I tried this and it gave:

   $ python -m pytest lib/bb/tests -q

   no tests ran in 0.10s

I'm not sure this does anything?

Instead running for example "python -m pytest lib/bb/tests/color.py" works, so
if the intent was to showcase how to run tests separately, I would rather
showcase an example like this.

Antonin

--
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com