From e44538f4e4d17c5fcdebc973e45e0b1b56e58803 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 23 Sep 2013 09:19:53 -0700 Subject: 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 Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-classes.xml | 16 ++++---- documentation/ref-manual/ref-variables.xml | 61 +++++++++++++++++------------- 2 files changed, 44 insertions(+), 33 deletions(-) (limited to 'documentation/ref-manual') 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 @@ You can use this class to enable running a series of automated tests - for QEMU images. - The class handles loading the tests and starting the QEMU image. + for images. + The class handles loading the tests and starting the image. + + The current release of Yocto Project supports these tests + for QEMU images only. + @@ -950,15 +954,13 @@ The tests are commands that run on the target system over ssh. they are written in Python and make use of the - unittest modulebuild software. + unittest module. For information on how to enable, run, and create new tests, see the - "Running and Writing Tests for a QEMU Image" - section and the - Image Tests - Wiki page. + "Performing Automated Runtime Testing" + section. 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" TEST_IMAGE - Automatically runs the series of automated tests for QEMU - images when a QEMU image is successfully built. - These tests are commands that run on the target system over - ssh and are written in Python. + Automatically runs the series of automated tests for + images when an image is successfully built. + + The current release of Yocto Project supports these tests + for QEMU images only. + + These tests are written in Python making use of the + unittest module, and the majority of + them run commands on the target system over + ssh. You can set this variable to "1" in your local.conf file in the Build Directory to have the OpenEmbedded build system automatically run - these tests after a QEMU image successfully builds: + these tests after an image successfully builds: TEST_IMAGE = "1" For more information on enabling, running, and writing these tests, see the - "Running and Writing Tests for a QEMU Image" + "Performing Automated Runtime Testing" section in the Yocto Project Development Manual and the "testimage.bbclass" section. @@ -5245,24 +5251,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" TEST_QEMUBOOT_TIMEOUT - The time in seconds allowed for a QEMU image to boot before - tests begin to run against the image using the following - command: - - bitbake <qemu_image> -c testimage - - - - + The time in seconds allowed for an image to boot before + automated runtime tests begin to run against an + image. The default timeout period to allow the boot process to reach the login prompt is 500 seconds. - You can edit this default value in the + You can specify a different value in the local.conf file. - For more information on testing QEMU images, see the - "Running and Writing Tests for a QEMU Image" + For more information on testing images, see the + "Performing Automated Runtime Testing" section in the Yocto Project Development Manual. @@ -5272,15 +5272,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" An ordered list of tests (modules) to run against - a QEMU image using the following command: - - bitbake <qemu_image> -c testimage - + an image when performing automated runtime testing. - The Yocto Project provides a core set of tests that can - be used against QEMU images. + The OpenEmbedded build system provides a core set of tests + that can be used against images. + + The current release of Yocto Project supports these + tests for QEMU images only. + Tests include ping, ssh, df among others. @@ -5289,6 +5290,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" TEST_SUITES_append = " mytest" + Alternatively, you can provide the "auto" option to + have all applicable tests run against the image. + + TEST_SUITES_append = " auto" + + Using this option causes the build system to automatically + run tests that are applicable to the image. + Tests that are not applicable are skipped. @@ -5307,8 +5316,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" - For more information on testing QEMU images, see the - "Running and Writing Tests for a QEMU Image" + For more information on testing images, see the + "Performing Automated Runtime Testing" section in the Yocto Project Development Manual. -- cgit v1.2.3-54-g00ecf