diff options
Diffstat (limited to 'documentation/test-manual')
| -rw-r--r-- | documentation/test-manual/intro.rst | 139 | ||||
| -rw-r--r-- | documentation/test-manual/reproducible-builds.rst | 25 | ||||
| -rw-r--r-- | documentation/test-manual/test-process.rst | 44 | ||||
| -rw-r--r-- | documentation/test-manual/understand-autobuilder.rst | 68 | ||||
| -rw-r--r-- | documentation/test-manual/yocto-project-compatible.rst | 2 |
5 files changed, 134 insertions, 144 deletions
diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst index 6421dd53c9..c31fd11c7a 100644 --- a/documentation/test-manual/intro.rst +++ b/documentation/test-manual/intro.rst @@ -14,15 +14,13 @@ release works as intended. All the project's testing infrastructure and processes are publicly visible and available so that the community can see what testing is being performed, how it's being done and the current status of the tests and the project at any given time. It is intended -that Other organizations can leverage off the process and testing +that other organizations can leverage off the process and testing environment used by the Yocto Project to create their own automated, production test environment, building upon the foundations from the project core. -Currently, the Yocto Project Test Environment Manual has no projected -release date. This manual is a work-in-progress and is being initially -loaded with information from the README files and notes from key -engineers: +This manual is a work-in-progress and is being initially loaded with +information from the README files and notes from key engineers: - *yocto-autobuilder2:* This :yocto_git:`README.md </yocto-autobuilder2/tree/README.md>` @@ -39,7 +37,7 @@ engineers: As a result, it can be used by any Continuous Improvement (CI) system to run builds, support getting the correct code revisions, configure builds and layers, run builds, and collect results. The code is - independent of any CI system, which means the code can work `Buildbot <https://docs.buildbot.net/0.9.15.post1/>`__, + independent of any CI system, which means the code can work `Buildbot <https://docs.buildbot.net/current/>`__, Jenkins, or others. This repository has a branch per release of the project defining the tests to run on a per release basis. @@ -54,8 +52,8 @@ the Autobuilder tests if things work. The Autobuilder builds all test targets and runs all the tests. The Yocto Project uses now uses standard upstream -`Buildbot <https://docs.buildbot.net/0.9.15.post1/>`__ (version 9) to -drive its integration and testing. Buildbot Nine has a plug-in interface +Buildbot (`version 3.8 <https://docs.buildbot.net/3.8.0/>`__) to +drive its integration and testing. Buildbot has a plug-in interface that the Yocto Project customizes using code from the ``yocto-autobuilder2`` repository, adding its own console UI plugin. The resulting UI plug-in allows you to visualize builds in a way suited to @@ -74,8 +72,7 @@ simple JSON files. The project uses Buildbot for historical reasons but also because many of the project developers have knowledge of Python. It is possible to use the outer layers from another Continuous Integration - (CI) system such as - `Jenkins <https://en.wikipedia.org/wiki/Jenkins_(software)>`__ + (CI) system such as :wikipedia:`Jenkins <Jenkins_(software)>` instead of Buildbot. The following figure shows the Yocto Project Autobuilder stack with a @@ -94,19 +91,18 @@ the following types of tests: - *Build Testing:* Tests whether specific configurations build by varying :term:`MACHINE`, :term:`DISTRO`, other configuration - options, and the specific target images being built (or world). Used - to trigger builds of all the different test configurations on the + options, and the specific target images being built (or ``world``). This is + used to trigger builds of all the different test configurations on the Autobuilder. Builds usually cover many different targets for different architectures, machines, and distributions, as well as different configurations, such as different init systems. The Autobuilder tests literally hundreds of configurations and targets. - - *Sanity Checks During the Build Process:* Tests initiated through - the :ref:`insane <ref-classes-insane>` - class. These checks ensure the output of the builds are correct. - For example, does the ELF architecture in the generated binaries - match the target system? ARM binaries would not work in a MIPS - system! + - *Sanity Checks During the Build Process:* Tests initiated through the + :ref:`ref-classes-insane` class. These checks ensure the output of the + builds are correct. For example, does the ELF architecture in the + generated binaries match the target system? ARM binaries would not work + in a MIPS system! - *Build Performance Testing:* Tests whether or not commonly used steps during builds work efficiently and avoid regressions. Tests to time @@ -122,7 +118,8 @@ the following types of tests: $ bitbake image -c testsdkext - The tests utilize the :ref:`testsdkext <ref-classes-testsdk>` class and the ``do_testsdkext`` task. + The tests use the :ref:`ref-classes-testsdk` class and the + ``do_testsdkext`` task. - *Feature Testing:* Various scenario-based tests are run through the :ref:`OpenEmbedded Self test (oe-selftest) <ref-manual/release-process:Testing and Quality Assurance>`. We test oe-selftest on each of the main distributions @@ -132,8 +129,8 @@ the following types of tests: $ bitbake image -c testimage - The tests utilize the :ref:`testimage* <ref-classes-testimage*>` - classes and the :ref:`ref-tasks-testimage` task. + The tests use the :ref:`ref-classes-testimage` + class and the :ref:`ref-tasks-testimage` task. - *Layer Testing:* The Autobuilder has the possibility to test whether specific layers work with the test of the system. The layers tested @@ -143,7 +140,7 @@ the following types of tests: - *Package Testing:* A Package Test (ptest) runs tests against packages built by the OpenEmbedded build system on the target machine. See the :ref:`Testing Packages With - ptest <dev-manual/common-tasks:Testing Packages With ptest>` section + ptest <dev-manual/packages:Testing Packages With ptest>` section in the Yocto Project Development Tasks Manual and the ":yocto_wiki:`Ptest </Ptest>`" Wiki page for more information on Ptest. @@ -152,7 +149,7 @@ the following types of tests: $ bitbake image -c testsdk - The tests utilize the :ref:`testsdk <ref-classes-testsdk>` class and + The tests use the :ref:`ref-classes-testsdk` class and the ``do_testsdk`` task. - *Unit Testing:* Unit tests on various components of the system run @@ -191,38 +188,39 @@ Tests map into the codebase as follows: $ bitbake-selftest -v To skip tests that access the Internet, use the ``BB_SKIP_NETTESTS`` - variable when running "bitbake-selftest" as follows:: + variable when running ``bitbake-selftest`` as follows:: $ BB_SKIP_NETTESTS=yes bitbake-selftest Use this option when you wish to skip tests that access the network, which are mostly necessary to test the fetcher modules. To specify individual test modules to run, append the test module name to the - "bitbake-selftest" command. For example, to specify the tests for the - bb.data.module, run:: + ``bitbake-selftest`` command. For example, to specify the tests for + ``bb.tests.data.DataExpansions``, run:: - $ bitbake-selftest bb.test.data.module + $ bitbake-selftest bb.tests.data.DataExpansions You can also specify individual tests by defining the full name and module plus the class path of the test, for example:: - $ bitbake-selftest bb.tests.data.TestOverrides.test_one_override + $ bitbake-selftest bb.tests.data.DataExpansions.test_one_var - The tests are based on `Python - unittest <https://docs.python.org/3/library/unittest.html>`__. + The tests are based on + `Python unittest <https://docs.python.org/3/library/unittest.html>`__. - *oe-selftest:* - These tests use OE to test the workflows, which include testing specific features, behaviors of tasks, and API unit tests. - - The tests can take advantage of parallelism through the "-j" + - The tests can take advantage of parallelism through the ``-j`` option, which can specify a number of threads to spread the tests across. Note that all tests from a given class of tests will run in the same thread. To parallelize large numbers of tests you can split the class into multiple units. - - The tests are based on Python unittest. + - The tests are based on + `Python unittest <https://docs.python.org/3/library/unittest.html>`__. - The code for the tests resides in ``meta/lib/oeqa/selftest/cases/``. @@ -232,18 +230,18 @@ Tests map into the codebase as follows: $ oe-selftest -a - To run a specific test, use the following command form where - testname is the name of the specific test:: + ``testname`` is the name of the specific test:: $ oe-selftest -r <testname> - For example, the following command would run the tinfoil - getVar API test:: + For example, the following command would run the ``tinfoil`` + ``getVar`` API test:: $ oe-selftest -r tinfoil.TinfoilTests.test_getvar It is also possible to run a set of tests. For example the following command will run all of the - tinfoil tests:: + ``tinfoil`` tests:: $ oe-selftest -r tinfoil @@ -278,7 +276,7 @@ Tests map into the codebase as follows: - These tests build an extended SDK (eSDK), install that eSDK, and run tests against the eSDK. - - The code for these tests resides in ``meta/lib/oeqa/esdk``. + - The code for these tests resides in ``meta/lib/oeqa/sdkext/cases/``. - To run the tests, use the following command form:: @@ -305,13 +303,13 @@ Tests map into the codebase as follows: Git repository. Use the ``oe-build-perf-report`` command to generate text reports - and HTML reports with graphs of the performance data. For - examples, see - :yocto_dl:`/releases/yocto/yocto-2.7/testresults/buildperf-centos7/perf-centos7.yoctoproject.org_warrior_20190414204758_0e39202.html` + and HTML reports with graphs of the performance data. See + :yocto_dl:`html </releases/yocto/yocto-4.3/testresults/buildperf-debian11/perf-debian11_nanbield_20231019191258_15b576c410.html>` and - :yocto_dl:`/releases/yocto/yocto-2.7/testresults/buildperf-centos7/perf-centos7.yoctoproject.org_warrior_20190414204758_0e39202.txt`. + :yocto_dl:`txt </releases/yocto/yocto-4.3/testresults/buildperf-debian11/perf-debian11_nanbield_20231019191258_15b576c410.txt>` + examples. - - The tests are contained in ``lib/oeqa/buildperf/test_basic.py``. + - The tests are contained in ``meta/lib/oeqa/buildperf/test_basic.py``. Test Examples ============= @@ -319,16 +317,14 @@ Test Examples This section provides example tests for each of the tests listed in the :ref:`test-manual/intro:How Tests Map to Areas of Code` section. -For oeqa tests, testcases for each area reside in the main test -directory at ``meta/lib/oeqa/selftest/cases`` directory. +- ``oe-selftest`` testcases reside in the ``meta/lib/oeqa/selftest/cases`` directory. -For oe-selftest. bitbake testcases reside in the ``lib/bb/tests/`` -directory. +- ``bitbake-selftest`` testcases reside in the ``bitbake/lib/bb/tests/`` directory. ``bitbake-selftest`` -------------------- -A simple test example from ``lib/bb/tests/data.py`` is:: +A simple test example from ``bitbake/lib/bb/tests/data.py`` is:: class DataExpansions(unittest.TestCase): def setUp(self): @@ -341,21 +337,24 @@ A simple test example from ``lib/bb/tests/data.py`` is:: val = self.d.expand("${foo}") self.assertEqual(str(val), "value_of_foo") -In this example, a ``DataExpansions`` class of tests is created, -derived from standard Python unittest. The class has a common ``setUp`` -function which is shared by all the tests in the class. A simple test is -then added to test that when a variable is expanded, the correct value -is found. +In this example, a ``DataExpansions`` class of tests is created, derived from +standard `Python unittest <https://docs.python.org/3/library/unittest.html>`__. +The class has a common ``setUp`` function which is shared by all the tests in +the class. A simple test is then added to test that when a variable is +expanded, the correct value is found. -BitBake selftests are straightforward Python unittest. Refer to the -Python unittest documentation for additional information on writing -these tests at: https://docs.python.org/3/library/unittest.html. +BitBake selftests are straightforward +`Python unittest <https://docs.python.org/3/library/unittest.html>`__. +Refer to the `Python unittest documentation +<https://docs.python.org/3/library/unittest.html>`__ for additional information +on writing such tests. ``oe-selftest`` --------------- These tests are more complex due to the setup required behind the scenes -for full builds. Rather than directly using Python's unittest, the code +for full builds. Rather than directly using `Python unittest +<https://docs.python.org/3/library/unittest.html>`__, the code wraps most of the standard objects. The tests can be simple, such as testing a command from within the OE build environment using the following example:: @@ -392,14 +391,14 @@ so tests within a given test class should always run in the same build, while tests in different classes or modules may be split into different builds. There is no data store available for these tests since the tests launch the ``bitbake`` command and exist outside of its context. As a -result, common bitbake library functions (bb.\*) are also unavailable. +result, common BitBake library functions (``bb.\*``) are also unavailable. ``testimage`` ------------- These tests are run once an image is up and running, either on target hardware or under QEMU. As a result, they are assumed to be running in a -target image environment, as opposed to a host build environment. A +target image environment, as opposed to in a host build environment. A simple example from ``meta/lib/oeqa/runtime/cases/python.py`` contains the following:: @@ -414,19 +413,19 @@ the following:: In this example, the ``OERuntimeTestCase`` class wraps ``unittest.TestCase``. Within the test, ``self.target`` represents the -target system, where commands can be run on it using the ``run()`` +target system, where commands can be run using the ``run()`` method. -To ensure certain test or package dependencies are met, you can use the +To ensure certain tests or package dependencies are met, you can use the ``OETestDepends`` and ``OEHasPackage`` decorators. For example, the test -in this example would only make sense if python3-core is installed in +in this example would only make sense if ``python3-core`` is installed in the image. ``testsdk_ext`` --------------- These tests are run against built extensible SDKs (eSDKs). The tests can -assume that the eSDK environment has already been setup. An example from +assume that the eSDK environment has already been set up. An example from ``meta/lib/oeqa/sdk/cases/devtool.py`` contains the following:: class DevtoolTest(OESDKExtTestCase): @@ -473,9 +472,9 @@ following:: output = self._run(cmd) self.assertEqual(output, "Hello, world\n") -In this example, if nativesdk-python3-core has been installed into the SDK, the code runs -the python3 interpreter with a basic command to check it is working -correctly. The test would only run if Python3 is installed in the SDK. +In this example, if ``nativesdk-python3-core`` has been installed into the SDK, +the code runs the ``python3`` interpreter with a basic command to check it is +working correctly. The test would only run if Python3 is installed in the SDK. ``oe-build-perf-test`` ---------------------- @@ -513,15 +512,15 @@ workers, consider the following: **Running "cleanall" is not permitted.** -This can delete files from DL_DIR which would potentially break other -builds running in parallel. If this is required, DL_DIR must be set to +This can delete files from :term:`DL_DIR` which would potentially break other +builds running in parallel. If this is required, :term:`DL_DIR` must be set to an isolated directory. **Running "cleansstate" is not permitted.** -This can delete files from SSTATE_DIR which would potentially break -other builds running in parallel. If this is required, SSTATE_DIR must -be set to an isolated directory. Alternatively, you can use the "-f" +This can delete files from :term:`SSTATE_DIR` which would potentially break +other builds running in parallel. If this is required, :term:`SSTATE_DIR` must +be set to an isolated directory. Alternatively, you can use the ``-f`` option with the ``bitbake`` command to "taint" tasks by changing the sstate checksums to ensure sstate cache items will not be reused. diff --git a/documentation/test-manual/reproducible-builds.rst b/documentation/test-manual/reproducible-builds.rst index 5977366c9e..91f94a5c74 100644 --- a/documentation/test-manual/reproducible-builds.rst +++ b/documentation/test-manual/reproducible-builds.rst @@ -19,13 +19,13 @@ Why it matters ============== The project aligns with the `Reproducible Builds project -<https://reproducible-builds.org/>`_, which shares information about why +<https://reproducible-builds.org/>`__, which shares information about why reproducibility matters. The primary focus of the project is the ability to detect security issues being introduced. However, from a Yocto Project perspective, it is also hugely important that our builds are deterministic. When you build a given input set of metadata, we expect you to get consistent output. -This has always been a key focus but, :yocto_docs:`since release 3.1 ("dunfell") -</ref-manual/migration-3.1.html#reproducible-builds-now-enabled-by-default>`, +This has always been a key focus but, :ref:`since release 3.1 ("dunfell") +<migration-guides/migration-3.1:reproducible builds now enabled by default>`, it is now true down to the binary level including timestamps. For example, at some point in the future life of a product, you find that you @@ -68,17 +68,6 @@ things we do within the build system to ensure reproducibility include: - Filtering the tools available from the host's ``PATH`` to only a specific set of tools, set using the :term:`HOSTTOOLS` variable. -.. note:: - - Because of an open bug in GCC, using ``DISTRO_FEATURES:append = " lto"`` or - adding ``-flto`` (Link Time Optimization) to ``CFLAGS`` makes the resulting - binary non-reproducible, in that it depends on the full absolute build path - to ``recipe-sysroot-native``, so installing the Yocto Project in a different - directory results in a different binary. - - This issue is addressed by - :yocto_bugs:`bug 14481 - Programs built with -flto are not reproducible</show_bug.cgi?id=14481>`. - ========================================= Can we prove the project is reproducible? ========================================= @@ -103,10 +92,12 @@ run:: oe-selftest -r reproducible.ReproducibleTests.test_reproducible_builds This defaults to including a ``world`` build so, if other layers are added, it would -also run the tests for recipes in the additional layers. The first build will be -run using :ref:`Shared State <overview-manual/concepts:Shared State>` if +also run the tests for recipes in the additional layers. Different build targets +can be defined using the :term:`OEQA_REPRODUCIBLE_TEST_TARGET` variable in ``local.conf``. +The first build will be run using :ref:`Shared State <overview-manual/concepts:Shared State>` if available, the second build explicitly disables -:ref:`Shared State <overview-manual/concepts:Shared State>` and builds on the +:ref:`Shared State <overview-manual/concepts:Shared State>` except for recipes defined in +the :term:`OEQA_REPRODUCIBLE_TEST_SSTATE_TARGETS` variable, and builds on the specific host the build is running on. This means we can test reproducibility builds between different host distributions over time on the Autobuilder. diff --git a/documentation/test-manual/test-process.rst b/documentation/test-manual/test-process.rst index 4c3b32bfea..7bec5ba828 100644 --- a/documentation/test-manual/test-process.rst +++ b/documentation/test-manual/test-process.rst @@ -20,8 +20,8 @@ helps review and test patches and this is his testing tree). We have two broad categories of test builds, including "full" and "quick". On the Autobuilder, these can be seen as "a-quick" and "a-full", simply for ease of sorting in the UI. Use our Autobuilder -console view to see where me manage most test-related items, available -at: :yocto_ab:`/typhoon/#/console`. +:yocto_ab:`console view </typhoon/#/console>` to see where we manage most +test-related items. Builds are triggered manually when the test branches are ready. The builds are monitored by the SWAT team. For additional information, see @@ -34,24 +34,21 @@ which the result was required. The Autobuilder does build the ``master`` branch once daily for several reasons, in particular, to ensure the current ``master`` branch does -build, but also to keep ``yocto-testresults`` -(:yocto_git:`/yocto-testresults/`), -buildhistory -(:yocto_git:`/poky-buildhistory/`), and -our sstate up to date. On the weekend, there is a master-next build +build, but also to keep (:yocto_git:`yocto-testresults </yocto-testresults/>`), +(:yocto_git:`buildhistory </poky-buildhistory/>`), and +our sstate up to date. On the weekend, there is a ``master-next`` build instead to ensure the test results are updated for the less frequently run targets. -Performance builds (buildperf-\* targets in the console) are triggered +Performance builds (``buildperf-\*`` targets in the console) are triggered separately every six hours and automatically push their results to the -buildstats repository at: -:yocto_git:`/yocto-buildstats/`. +:yocto_git:`buildstats </yocto-buildstats/>` repository. -The 'quick' targets have been selected to be the ones which catch the -most failures or give the most valuable data. We run 'fast' ptests in +The "quick" targets have been selected to be the ones which catch the +most failures or give the most valuable data. We run "fast" ptests in this case for example but not the ones which take a long time. The quick -target doesn't include \*-lsb builds for all architectures, some world -builds and doesn't trigger performance tests or ltp testing. The full +target doesn't include ``\*-lsb`` builds for all architectures, some ``world`` +builds and doesn't trigger performance tests or ``ltp`` testing. The full build includes all these things and is slower but more comprehensive. Release Builds @@ -67,12 +64,12 @@ that in :ref:`test-manual/test-process:day to day development`, in that the a-full target of the Autobuilder is used but in addition the form is configured to generate and publish artifacts and the milestone number, version, release candidate number and other information is entered. The -box to "generate an email to QA"is also checked. +box to "generate an email to QA" is also checked. -When the build completes, an email is sent out using the send-qa-email -script in the ``yocto-autobuilder-helper`` repository to the list of -people configured for that release. Release builds are placed into a -directory in https://autobuilder.yocto.io/pub/releases on the +When the build completes, an email is sent out using the ``send-qa-email`` +script in the :yocto_git:`yocto-autobuilder-helper </yocto-autobuilder-helper>` +repository to the list of people configured for that release. Release builds +are placed into a directory in https://autobuilder.yocto.io/pub/releases on the Autobuilder which is included in the email. The process from here is more manual and control is effectively passed to release engineering. The next steps include: @@ -80,14 +77,15 @@ The next steps include: - QA teams respond to the email saying which tests they plan to run and when the results will be available. -- QA teams run their tests and share their results in the yocto- - testresults-contrib repository, along with a summary of their - findings. +- QA teams run their tests and share their results in the + :yocto_git:`yocto-testresults-contrib </yocto-testresults-contrib>` + repository, along with a summary of their findings. - Release engineering prepare the release as per their process. - Test results from the QA teams are included into the release in - separate directories and also uploaded to the yocto-testresults + separate directories and also uploaded to the + :yocto_git:`yocto-testresults </yocto-testresults>` repository alongside the other test results for the given revision. - The QA report in the final release is regenerated using resulttool to diff --git a/documentation/test-manual/understand-autobuilder.rst b/documentation/test-manual/understand-autobuilder.rst index b6809ce7bd..6b4fab4f0b 100644 --- a/documentation/test-manual/understand-autobuilder.rst +++ b/documentation/test-manual/understand-autobuilder.rst @@ -9,8 +9,8 @@ Execution Flow within the Autobuilder The "a-full" and "a-quick" targets are the usual entry points into the Autobuilder and it makes sense to follow the process through the system -starting there. This is best visualized from the Autobuilder Console -view (:yocto_ab:`/typhoon/#/console`). +starting there. This is best visualized from the :yocto_ab:`Autobuilder +Console view </typhoon/#/console>`. Each item along the top of that view represents some "target build" and these targets are all run in parallel. The 'full' build will trigger the @@ -18,9 +18,9 @@ majority of them, the "quick" build will trigger some subset of them. The Autobuilder effectively runs whichever configuration is defined for each of those targets on a separate buildbot worker. To understand the configuration, you need to look at the entry on ``config.json`` file -within the ``yocto-autobuilder-helper`` repository. The targets are -defined in the ‘overrides' section, a quick example could be qemux86-64 -which looks like:: +within the :yocto_git:`yocto-autobuilder-helper </yocto-autobuilder-helper>` +repository. The targets are defined in the ``overrides`` section, a quick +example could be ``qemux86-64`` which looks like:: "qemux86-64" : { "MACHINE" : "qemux86-64", @@ -32,8 +32,8 @@ which looks like:: } }, -And to expand that, you need the "arch-qemu" entry from -the "templates" section, which looks like:: +And to expand that, you need the ``arch-qemu`` entry from +the ``templates`` section, which looks like:: "arch-qemu" : { "BUILDINFO" : true, @@ -54,11 +54,11 @@ the "templates" section, which looks like:: } }, -Combining these two entries you can see that "qemux86-64" is a three step build where the -``bitbake BBTARGETS`` would be run, then ``bitbake SANITYTARGETS`` for each step; all for -``MACHINE="qemx86-64"`` but with differing SDKMACHINE settings. In step -1 an extra variable is added to the ``auto.conf`` file to enable wic -image generation. +Combining these two entries you can see that ``qemux86-64`` is a three step +build where ``bitbake BBTARGETS`` would be run, then ``bitbake SANITYTARGETS`` +for each step; all for ``MACHINE="qemux86-64"`` but with differing +:term:`SDKMACHINE` settings. In step 1, an extra variable is added to the +``auto.conf`` file to enable wic image generation. While not every detail of this is covered here, you can see how the template mechanism allows quite complex configurations to be built up @@ -88,9 +88,9 @@ roughly consist of: #. *Obtain yocto-autobuilder-helper* - This step clones the ``yocto-autobuilder-helper`` git repository. - This is necessary to prevent the requirement to maintain all the - release or project-specific code within Buildbot. The branch chosen + This step clones the :yocto_git:`yocto-autobuilder-helper </yocto-autobuilder-helper>` + git repository. This is necessary to avoid the requirement to maintain all + the release or project-specific code within Buildbot. The branch chosen matches the release being built so we can support older releases and still make changes in newer ones. @@ -163,16 +163,17 @@ Autobuilder Worker Janitor -------------------------- This is a process running on each Worker that performs two basic -operations, including background file deletion at IO idle (see :ref:`test-manual/understand-autobuilder:Autobuilder Target Execution Overview`: Run clobberdir) and -maintenance of a cache of cloned repositories to improve the speed +operations, including background file deletion at IO idle (see +"Run clobberdir" in :ref:`test-manual/understand-autobuilder:Autobuilder Target Execution Overview`) +and maintenance of a cache of cloned repositories to improve the speed the system can checkout repositories. Shared DL_DIR ------------- -The Workers are all connected over NFS which allows DL_DIR to be shared +The Workers are all connected over NFS which allows :term:`DL_DIR` to be shared between them. This reduces network accesses from the system and allows -the build to be sped up. Usage of the directory within the build system +the build to be sped up. The usage of the directory within the build system is designed to be able to be shared over NFS. Shared SSTATE_DIR @@ -180,8 +181,8 @@ Shared SSTATE_DIR The Workers are all connected over NFS which allows the ``sstate`` directory to be shared between them. This means once a Worker has built -an artifact, all the others can benefit from it. Usage of the directory -within the directory is designed for sharing over NFS. +an artifact, all the others can benefit from it. The usage of the directory +within the build system is designed for sharing over NFS. Resulttool ---------- @@ -192,7 +193,7 @@ in a given build and their status. Additional information, such as failure logs or the time taken to run the tests, may also be included. Resulttool is part of OpenEmbedded-Core and is used to manipulate these -json results files. It has the ability to merge files together, display +JSON results files. It has the ability to merge files together, display reports of the test results and compare different result files. For details, see :yocto_wiki:`/Resulttool`. @@ -204,9 +205,9 @@ The ``scripts/run-config`` execution is where most of the work within the Autobuilder happens. It runs through a number of steps; the first are general setup steps that are run once and include: -#. Set up any ``buildtools-tarball`` if configured. +#. Set up any :term:`buildtools` tarball if configured. -#. Call "buildhistory-init" if buildhistory is configured. +#. Call ``buildhistory-init`` if :ref:`ref-classes-buildhistory` is configured. For each step that is configured in ``config.json``, it will perform the following: @@ -242,7 +243,7 @@ of post-build steps, including: #. Call ``scripts/upload-error-reports`` to send any error reports generated to the remote server. -#. Cleanup the build directory using +#. Cleanup the :term:`Build Directory` using :ref:`test-manual/understand-autobuilder:clobberdir` if the build was successful, else rename it to "build-renamed" for potential future debugging. @@ -250,15 +251,16 @@ Deploying Yocto Autobuilder =========================== The most up to date information about how to setup and deploy your own -Autobuilder can be found in README.md in the ``yocto-autobuilder2`` -repository. +Autobuilder can be found in :yocto_git:`README.md </yocto-autobuilder2/tree/README.md>` +in the :yocto_git:`yocto-autobuilder2 </yocto-autobuilder2>` repository. -We hope that people can use the ``yocto-autobuilder2`` code directly but -it is inevitable that users will end up needing to heavily customise the -``yocto-autobuilder-helper`` repository, particularly the -``config.json`` file as they will want to define their own test matrix. +We hope that people can use the :yocto_git:`yocto-autobuilder2 </yocto-autobuilder2>` +code directly but it is inevitable that users will end up needing to heavily +customize the :yocto_git:`yocto-autobuilder-helper </yocto-autobuilder-helper>` +repository, particularly the ``config.json`` file as they will want to define +their own test matrix. -The Autobuilder supports wo customization options: +The Autobuilder supports two customization options: - variable substitution @@ -278,7 +280,7 @@ environment:: $ ABHELPER_JSON="config.json /some/location/local.json" One issue users often run into is validation of the ``config.json`` files. A -tip for minimizing issues from invalid json files is to use a Git +tip for minimizing issues from invalid JSON files is to use a Git ``pre-commit-hook.sh`` script to verify the JSON file before committing it. Create a symbolic link as follows:: diff --git a/documentation/test-manual/yocto-project-compatible.rst b/documentation/test-manual/yocto-project-compatible.rst index 96c12ac083..65d924fad9 100644 --- a/documentation/test-manual/yocto-project-compatible.rst +++ b/documentation/test-manual/yocto-project-compatible.rst @@ -27,7 +27,7 @@ In the second version of the program, a script was added to make validation easier and clearer, the script is called ``yocto-check-layer`` and is available in :term:`OpenEmbedded-Core (OE-Core)`. -See :ref:`dev-manual/common-tasks:making sure your layer is compatible with yocto project` +See :ref:`dev-manual/layers:making sure your layer is compatible with yocto project` for details. ======== |