1
0
mirror of https://git.yoctoproject.org/poky synced 2026-06-01 00:59:48 +00:00

ref-manual, dev-manual: Removed TEST_IMAGE for TESTIMAGE_AUTO.

The TEST_IMAGE variable went away and was replaced with the
TESTIMAGE_AUTO variable.  Fixed all related/affected areas.

(From yocto-docs rev: 84e2c149fa823ab6e12be17b049c9bae1c1dd904)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2018-10-30 11:41:37 -07:00
committed by Richard Purdie
parent 9cedaa6740
commit 400d491e8d
4 changed files with 46 additions and 41 deletions
@@ -11798,16 +11798,15 @@
To run the tests automatically after the
OpenEmbedded build system successfully creates an image,
first set the
<ulink url='&YOCTO_DOCS_REF_URL;#var-TEST_IMAGE'><filename>TEST_IMAGE</filename></ulink>
<ulink url='&YOCTO_DOCS_REF_URL;#var-TESTIMAGE_AUTO'><filename>TESTIMAGE_AUTO</filename></ulink>
variable to "1" in your <filename>local.conf</filename>
file in the
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>:
<literallayout class='monospaced'>
TEST_IMAGE = "1"
TESTIMAGE_AUTO = "1"
</literallayout>
Next, build your image.
If the image successfully builds, the tests will be
run:
If the image successfully builds, the tests run:
<literallayout class='monospaced'>
bitbake core-image-sato
</literallayout></para></listitem>
+1 -1
View File
@@ -3519,7 +3519,7 @@ This check was removed for YP 2.3 release
</literallayout>
The <filename>testimage-auto</filename> class runs tests on an image
after the image is constructed (i.e.
<link linkend='var-TEST_IMAGE'><filename>TEST_IMAGE</filename></link>
<link linkend='var-TESTIMAGE_AUTO'><filename>TESTIMAGE_AUTO</filename></link>
must be set to "1").
</para>
+1 -1
View File
@@ -886,7 +886,7 @@
Boots an image and performs runtime tests within the image
immediately after it has been built.
This task is enabled when you set
<link linkend='var-TEST_IMAGE'><filename>TEST_IMAGE</filename></link>
<link linkend='var-TESTIMAGE_AUTO'><filename>TESTIMAGE_AUTO</filename></link>
equal to "1".
</para>
+41 -35
View File
@@ -15195,41 +15195,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
</glossdef>
</glossentry>
<glossentry id='var-TEST_IMAGE'><glossterm>TEST_IMAGE</glossterm>
<info>
TEST_IMAGE[doc] = "Enables test booting of virtual machine images under the QEMU emulator after any root filesystems are created and runs tests against those images."
</info>
<glossdef>
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
Automatically runs the series of automated tests for
images when an image is successfully built.
</para>
<para>
These tests are written in Python making use of the
<filename>unittest</filename> module, and the majority of
them run commands on the target system over
<filename>ssh</filename>.
You can set this variable to "1" in your
<filename>local.conf</filename> file in the
<link linkend='build-directory'>Build Directory</link>
to have the OpenEmbedded build system automatically run
these tests after an image successfully builds:
<literallayout class='monospaced'>
TEST_IMAGE = "1"
</literallayout>
For more information on enabling, running, and writing
these tests, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
section in the Yocto Project Development Tasks Manual and
the
"<link linkend='ref-classes-testimage*'><filename>testimage*.bbclass</filename></link>"
section.
</para>
</glossdef>
</glossentry>
<glossentry id='var-TEST_LOG_DIR'><glossterm>TEST_LOG_DIR</glossterm>
<info>
TEST_LOG_DIR[doc] = "Holds the SSH log and the boot log for QEMU machines. The TEST_LOG_DIR variable defaults to "${WORKDIR}/testimage"."
@@ -15530,6 +15495,47 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
</glossdef>
</glossentry>
<glossentry id='var-TESTIMAGE_AUTO'><glossterm>TESTIMAGE_AUTO</glossterm>
<info>
TESTIMAGE_AUTO[doc] = "Enables automatic testing of an image once it is built."
</info>
<glossdef>
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
Automatically runs the series of automated tests for
images when an image is successfully built.
Setting <filename>TESTIMAGE_AUTO</filename> to "1"
causes any image that successfully builds to automatically
boot under QEMU.
Using the variable also adds in dependencies so that any
SDK for which testing is requested is automatically built
first.
</para>
<para>
These tests are written in Python making use of the
<filename>unittest</filename> module, and the majority of
them run commands on the target system over
<filename>ssh</filename>.
You can set this variable to "1" in your
<filename>local.conf</filename> file in the
<link linkend='build-directory'>Build Directory</link>
to have the OpenEmbedded build system automatically run
these tests after an image successfully builds:
<literallayout class='monospaced'>
TESTIMAGE_AUTO = "1"
</literallayout>
For more information on enabling, running, and writing
these tests, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
section in the Yocto Project Development Tasks Manual and
the
"<link linkend='ref-classes-testimage*'><filename>testimage*.bbclass</filename></link>"
section.
</para>
</glossdef>
</glossentry>
<glossentry id='var-THISDIR'><glossterm>THISDIR</glossterm>
<info>
THISDIR[doc] = "The directory in which the file BitBake is currently parsing is located."