Message ID | 20240304205038.9060-1-simone.p.weiss@posteo.com |
---|---|
State | New |
Headers | show |
Series | contributor-guide: Add notes for tests | expand |
Hi! Le 04/03/2024 à 21:50, Simone Weiß a écrit : > From: Simone Weiß <simone.p.weiss@posteo.com> > > This adds some hints that and how chnages should be tested when contributing. > > Fixes [YOCTO #15412] > > Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com> > --- > .../contributor-guide/submit-changes.rst | 37 ++++++++++++++++++- > 1 file changed, 35 insertions(+), 2 deletions(-) > > diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst > index 61f3157d6..d2167a2f3 100644 > --- a/documentation/contributor-guide/submit-changes.rst > +++ b/documentation/contributor-guide/submit-changes.rst > @@ -221,6 +221,38 @@ to add the upgraded version. > <https://www.kernel.org/doc/html/latest/process/submitting-patches.html#using-reported-by-tested-by-reviewed-by-suggested-by-and-fixes>`__ > in the Linux kernel documentation. > > +Test your changes > +----------------- > + > +For each contributions you make, you should test your changes as well. > +For this the Yocto Project offers several types of tests. Those tests cover > +different areas and it depends on your changes which are feasible. For example run: > + > + - For changes that affect the build environment: > + > + - ``bitbake-selftest``: for changes within BitBake > + > + - ``oe-selftest``: to test combinations of BitBake runs > + > + - ``oe-build-perf-test``: to test the performance of common build scenarios > + > + - For changes in a recipe: > + > + - ``ptest``: of the package, if it exists > + > + - ``testimage``: build an image, boot it and run testcases on it > + > + - If applicable, ensure also the ``native`` and ``nativesdk`` variants builds > + > + - For changes relating to the SDK: > + > + - ``testsdk``: to build, install and run tests against a SDK > + > + - ``testsdk_ext``: to build, install and run tests against an extended SDK > + > +Note that this list just gives suggestions and is not exhaustive. More details can > +be found here: :ref:`test-manual/intro:Yocto Project Tests --- Types of Testing Overview`. > + > Creating Patches > ================ > > @@ -285,8 +317,9 @@ Validating Patches with Patchtest > ``patchtest`` is available in ``openembedded-core`` as a tool for making > sure that your patches are well-formatted and contain important info for > maintenance purposes, such as ``Signed-off-by`` and ``Upstream-Status`` > -tags. Currently, it only supports testing patches for > -``openembedded-core`` branches. To setup, perform the following:: > +tags. Note that no functional testing of the changes will be performed by ``patchtesti``. There is an extra 'i' : patchtesti -> patchtest > +Currently, it only supports testing patches for ``openembedded-core`` branches. > +To setup, perform the following:: > > pip install -r meta/lib/patchtest/requirements.txt > source oe-init-build-env > > > > -=-=-=-=-=-=-=-=-=-=-=- > Links: You receive all messages sent to this group. > View/Reply Online (#4928): https://lists.yoctoproject.org/g/docs/message/4928 > Mute This Topic: https://lists.yoctoproject.org/mt/104731180/4316185 > Group Owner: docs+owner@lists.yoctoproject.org > Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [yoann.congal@smile.fr] > -=-=-=-=-=-=-=-=-=-=-=- >
Hi Simone, Many thanks for the new patch! I have my own suggestions... On 3/4/24 at 21:50, Simone Weiß wrote: > From: Simone Weiß <simone.p.weiss@posteo.com> > > This adds some hints that and how chnages should be tested when contributing. s/chnages/changes/ > > Fixes [YOCTO #15412] > > Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com> > --- > .../contributor-guide/submit-changes.rst | 37 ++++++++++++++++++- > 1 file changed, 35 insertions(+), 2 deletions(-) > > diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst > index 61f3157d6..d2167a2f3 100644 > --- a/documentation/contributor-guide/submit-changes.rst > +++ b/documentation/contributor-guide/submit-changes.rst > @@ -221,6 +221,38 @@ to add the upgraded version. > <https://www.kernel.org/doc/html/latest/process/submitting-patches.html#using-reported-by-tested-by-reviewed-by-suggested-by-and-fixes>`__ > in the Linux kernel documentation. > > +Test your changes > +----------------- > + > +For each contributions you make, you should test your changes as well. > +For this the Yocto Project offers several types of tests. Those tests cover > +different areas and it depends on your changes which are feasible. For example run: > + > + - For changes that affect the build environment: > + > + - ``bitbake-selftest``: for changes within BitBake > + > + - ``oe-selftest``: to test combinations of BitBake runs > + > + - ``oe-build-perf-test``: to test the performance of common build scenarios > + > + - For changes in a recipe: > + > + - ``ptest``: of the package, if it exists "Run package specific tests, if they exist"? Thanks again Michael.
diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst index 61f3157d6..d2167a2f3 100644 --- a/documentation/contributor-guide/submit-changes.rst +++ b/documentation/contributor-guide/submit-changes.rst @@ -221,6 +221,38 @@ to add the upgraded version. <https://www.kernel.org/doc/html/latest/process/submitting-patches.html#using-reported-by-tested-by-reviewed-by-suggested-by-and-fixes>`__ in the Linux kernel documentation. +Test your changes +----------------- + +For each contributions you make, you should test your changes as well. +For this the Yocto Project offers several types of tests. Those tests cover +different areas and it depends on your changes which are feasible. For example run: + + - For changes that affect the build environment: + + - ``bitbake-selftest``: for changes within BitBake + + - ``oe-selftest``: to test combinations of BitBake runs + + - ``oe-build-perf-test``: to test the performance of common build scenarios + + - For changes in a recipe: + + - ``ptest``: of the package, if it exists + + - ``testimage``: build an image, boot it and run testcases on it + + - If applicable, ensure also the ``native`` and ``nativesdk`` variants builds + + - For changes relating to the SDK: + + - ``testsdk``: to build, install and run tests against a SDK + + - ``testsdk_ext``: to build, install and run tests against an extended SDK + +Note that this list just gives suggestions and is not exhaustive. More details can +be found here: :ref:`test-manual/intro:Yocto Project Tests --- Types of Testing Overview`. + Creating Patches ================ @@ -285,8 +317,9 @@ Validating Patches with Patchtest ``patchtest`` is available in ``openembedded-core`` as a tool for making sure that your patches are well-formatted and contain important info for maintenance purposes, such as ``Signed-off-by`` and ``Upstream-Status`` -tags. Currently, it only supports testing patches for -``openembedded-core`` branches. To setup, perform the following:: +tags. Note that no functional testing of the changes will be performed by ``patchtesti``. +Currently, it only supports testing patches for ``openembedded-core`` branches. +To setup, perform the following:: pip install -r meta/lib/patchtest/requirements.txt source oe-init-build-env