dev-manual: WIP for YOCTO #5554.

(From yocto-docs rev: 00ecee108d87b5c1044e7b6df702e59f0332035f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2014-03-27 07:16:04 -06:00 committed by Richard Purdie
parent f1e9e335ee
commit df02dd8c65
1 changed files with 111 additions and 60 deletions

View File

@ -5588,20 +5588,28 @@
<para>
The OpenEmbedded build system makes available a series of automated
tests for images to verify runtime functionality.
<note>
Currently, there is only support for running these tests
under QEMU.
</note>
These tests are written in Python making use of the
You can run these tests on either QEMU or actual target hardware.
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 SSH.
This section describes how you set up the environment to use these
tests, run available tests, and write and add your own tests.
</para>
<section id="qemu-image-enabling-tests">
<section id='enabling-tests'>
<title>Enabling Tests</title>
<para>
Depending on whether you are planning on running tests using
QEMU or on running them on the hardware, you have to take
different steps to enable the tests.
See the following subsections for information on how to
enable both types of tests.
</para>
<section id='qemu-image-enabling-tests'>
<title>QEMU</title>
<para>
In order to run tests, you need to do the following:
<itemizedlist>
@ -5661,6 +5669,37 @@
</note>
</section>
<section id='hardware-image-enabling-tests'>
<title>Hardware</title>
<para>
This section needs the information specific to enabling
tests to run on actual hardware.
Here are some developer notes:
<itemizedlist>
<listitem><para>
Paul says this "If you have deployed the image yourself,
you can manually boot it, you know the IP address
it will show up under, and SSH is installed with no
password, then you can now run tests on any real
machine."
</para></listitem>
<listitem><para>
<filename>TEST_TARGET</filename> variable needs to equal
"simpleremote"
</para></listitem>
<listitem><para>
Here are some notes from the patch - "The remote machine
must be up with network and ssh and you need to set
<filename>TEST_TARGET_IP</filename> with the IP address
of the remote machine (it can still be a qemu instance that
was manually started)
</para></listitem>
</itemizedlist>
</para>
</section>
</section>
<section id="qemu-image-running-tests">
<title>Running Tests</title>
@ -5677,6 +5716,18 @@
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>:
<literallayout class='monospaced'>
TEST_IMAGE = "1"
</literallayout>
Next, also in the <filename>local.conf</filename>, set the
<filename>TEST_TARGET</filename> variable to
"simpleremote" if you want to run tests on real hardware or
set it to "qemu" if you want to run tests using QEMU.
file:
<literallayout class='monospaced'>
TEST_TARGET = "simpleremote"
</literallayout>
or
<literallayout class='monospaced'>
TEST_TARGET = "qemu"
</literallayout>
Next, build your image.
If the image successfully builds, the tests will be