summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-09-23 09:19:53 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-10-01 22:52:51 +0100
commite44538f4e4d17c5fcdebc973e45e0b1b56e58803 (patch)
tree6fa92058f47c87a4f722ba981bcbf2f42f53e0f4 /documentation/ref-manual
parent56c4de93b94c60a827d378488cbe13a0bb59c2e2 (diff)
downloadpoky-e44538f4e4d17c5fcdebc973e45e0b1b56e58803.tar.gz
ref-manual, dev-manual: Applied review comments for test section
The section and variables for performing automated runtime tests on images was reviewed by Paul Eggleton. The suggested changes were made. (From yocto-docs rev: c2f84ea3c162892e4da3df30fb833f88bab3d3cc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-classes.xml16
-rw-r--r--documentation/ref-manual/ref-variables.xml61
2 files changed, 44 insertions, 33 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 5870d0f44a..b1a8e64ce0 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -940,8 +940,12 @@
940 940
941 <para> 941 <para>
942 You can use this class to enable running a series of automated tests 942 You can use this class to enable running a series of automated tests
943 for QEMU images. 943 for images.
944 The class handles loading the tests and starting the QEMU image. 944 The class handles loading the tests and starting the image.
945 <note>
946 The current release of Yocto Project supports these tests
947 for QEMU images only.
948 </note>
945 </para> 949 </para>
946 950
947 <para> 951 <para>
@@ -950,15 +954,13 @@
950 The tests are commands that run on the target system over 954 The tests are commands that run on the target system over
951 <filename>ssh</filename>. 955 <filename>ssh</filename>.
952 they are written in Python and make use of the 956 they are written in Python and make use of the
953 <filename>unittest modulebuild</filename> software. 957 <filename>unittest</filename> module.
954 </para> 958 </para>
955 959
956 <para> 960 <para>
957 For information on how to enable, run, and create new tests, see the 961 For information on how to enable, run, and create new tests, see the
958 "<ulink url='running-and-writing-tests-for-a-qemu-image'>Running and Writing Tests for a QEMU Image</ulink>" 962 "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
959 section and the 963 section.
960 <ulink url='https://wiki.yoctoproject.org/wiki/Image_tests'>Image Tests</ulink>
961 Wiki page.
962 </para> 964 </para>
963</section> 965</section>
964 966
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 662a230650..d71378d271 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -5220,21 +5220,27 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5220 <glossentry id='var-TEST_IMAGE'><glossterm>TEST_IMAGE</glossterm> 5220 <glossentry id='var-TEST_IMAGE'><glossterm>TEST_IMAGE</glossterm>
5221 <glossdef> 5221 <glossdef>
5222 <para> 5222 <para>
5223 Automatically runs the series of automated tests for QEMU 5223 Automatically runs the series of automated tests for
5224 images when a QEMU image is successfully built. 5224 images when an image is successfully built.
5225 These tests are commands that run on the target system over 5225 <note>
5226 <filename>ssh</filename> and are written in Python. 5226 The current release of Yocto Project supports these tests
5227 for QEMU images only.
5228 </note>
5229 These tests are written in Python making use of the
5230 <filename>unittest</filename> module, and the majority of
5231 them run commands on the target system over
5232 <filename>ssh</filename>.
5227 You can set this variable to "1" in your 5233 You can set this variable to "1" in your
5228 <filename>local.conf</filename> file in the 5234 <filename>local.conf</filename> file in the
5229 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> 5235 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
5230 to have the OpenEmbedded build system automatically run 5236 to have the OpenEmbedded build system automatically run
5231 these tests after a QEMU image successfully builds: 5237 these tests after an image successfully builds:
5232 <literallayout class='monospaced'> 5238 <literallayout class='monospaced'>
5233 TEST_IMAGE = "1" 5239 TEST_IMAGE = "1"
5234 </literallayout> 5240 </literallayout>
5235 For more information on enabling, running, and writing 5241 For more information on enabling, running, and writing
5236 these tests, see the 5242 these tests, see the
5237 "<ulink url='&YOCTO_DOCS_DEV_URL;#running-and-writing-tests-for-a-qemu-image'>Running and Writing Tests for a QEMU Image</ulink>" 5243 "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
5238 section in the Yocto Project Development Manual and the 5244 section in the Yocto Project Development Manual and the
5239 "<link linkend='ref-classes-testimage'><filename>testimage.bbclass</filename></link>" 5245 "<link linkend='ref-classes-testimage'><filename>testimage.bbclass</filename></link>"
5240 section. 5246 section.
@@ -5245,24 +5251,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5245 <glossentry id='var-TEST_QEMUBOOT_TIMEOUT'><glossterm>TEST_QEMUBOOT_TIMEOUT</glossterm> 5251 <glossentry id='var-TEST_QEMUBOOT_TIMEOUT'><glossterm>TEST_QEMUBOOT_TIMEOUT</glossterm>
5246 <glossdef> 5252 <glossdef>
5247 <para> 5253 <para>
5248 The time in seconds allowed for a QEMU image to boot before 5254 The time in seconds allowed for an image to boot before
5249 tests begin to run against the image using the following 5255 automated runtime tests begin to run against an
5250 command: 5256 image.
5251 <literallayout class='monospaced'>
5252 bitbake &lt;qemu_image&gt; -c testimage
5253 </literallayout>
5254 </para>
5255
5256 <para>
5257 The default timeout period to allow the boot process to 5257 The default timeout period to allow the boot process to
5258 reach the login prompt is 500 seconds. 5258 reach the login prompt is 500 seconds.
5259 You can edit this default value in the 5259 You can specify a different value in the
5260 <filename>local.conf</filename> file. 5260 <filename>local.conf</filename> file.
5261 </para> 5261 </para>
5262 5262
5263 <para> 5263 <para>
5264 For more information on testing QEMU images, see the 5264 For more information on testing images, see the
5265 "<ulink url='running-and-writing-tests-for-a-qemu-image'>Running and Writing Tests for a QEMU Image</ulink>" 5265 "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
5266 section in the Yocto Project Development Manual. 5266 section in the Yocto Project Development Manual.
5267 </para> 5267 </para>
5268 </glossdef> 5268 </glossdef>
@@ -5272,15 +5272,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5272 <glossdef> 5272 <glossdef>
5273 <para> 5273 <para>
5274 An ordered list of tests (modules) to run against 5274 An ordered list of tests (modules) to run against
5275 a QEMU image using the following command: 5275 an image when performing automated runtime testing.
5276 <literallayout class='monospaced'>
5277 bitbake &lt;qemu_image&gt; -c testimage
5278 </literallayout>
5279 </para> 5276 </para>
5280 5277
5281 <para> 5278 <para>
5282 The Yocto Project provides a core set of tests that can 5279 The OpenEmbedded build system provides a core set of tests
5283 be used against QEMU images. 5280 that can be used against images.
5281 <note>
5282 The current release of Yocto Project supports these
5283 tests for QEMU images only.
5284 </note>
5284 Tests include <filename>ping</filename>, 5285 Tests include <filename>ping</filename>,
5285 <filename>ssh</filename>, <filename>df</filename> among 5286 <filename>ssh</filename>, <filename>df</filename> among
5286 others. 5287 others.
@@ -5289,6 +5290,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5289 <literallayout class='monospaced'> 5290 <literallayout class='monospaced'>
5290 TEST_SUITES_append = " mytest" 5291 TEST_SUITES_append = " mytest"
5291 </literallayout> 5292 </literallayout>
5293 Alternatively, you can provide the "auto" option to
5294 have all applicable tests run against the image.
5295 <literallayout class='monospaced'>
5296 TEST_SUITES_append = " auto"
5297 </literallayout>
5298 Using this option causes the build system to automatically
5299 run tests that are applicable to the image.
5300 Tests that are not applicable are skipped.
5292 </para> 5301 </para>
5293 5302
5294 <para> 5303 <para>
@@ -5307,8 +5316,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5307 </para> 5316 </para>
5308 5317
5309 <para> 5318 <para>
5310 For more information on testing QEMU images, see the 5319 For more information on testing images, see the
5311 "<ulink url='running-and-writing-tests-for-a-qemu-image'>Running and Writing Tests for a QEMU Image</ulink>" 5320 "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
5312 section in the Yocto Project Development Manual. 5321 section in the Yocto Project Development Manual.
5313 </para> 5322 </para>
5314 </glossdef> 5323 </glossdef>