summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-04-11 08:52:46 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-04-13 12:03:52 +0100
commitf3dccea14aa4790f33098859df5ec1ce6cac8428 (patch)
tree6e33b81b50e1e5c24800eb0cf0063cd33bcb04b5 /documentation/dev-manual
parente63348fb8cc827d0472981e80e9884ceaafc9ffd (diff)
downloadpoky-f3dccea14aa4790f33098859df5ec1ce6cac8428.tar.gz
ref-manual, dev-manual: Edits to running tests on hardware
Fixes [YOCTO #5554] Applied edits to the section in the dev-manual on running tests on hardware. Edited the TEST_TARGET and TEST_IMAGE variables. (From yocto-docs rev: a26ba11c739aabab4009a944d9b622e2814c7fca) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml80
1 files changed, 56 insertions, 24 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 63aba00abb..fa6e9cd9b8 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -5660,7 +5660,7 @@
5660 </para> 5660 </para>
5661 5661
5662 <section id='qemu-image-enabling-tests'> 5662 <section id='qemu-image-enabling-tests'>
5663 <title>QEMU</title> 5663 <title>Enabling Runtime Tests on QEMU</title>
5664 5664
5665 <para> 5665 <para>
5666 In order to run tests, you need to do the following: 5666 In order to run tests, you need to do the following:
@@ -5750,7 +5750,43 @@
5750 </section> 5750 </section>
5751 5751
5752 <section id='hardware-image-enabling-tests'> 5752 <section id='hardware-image-enabling-tests'>
5753 <title>Hardware</title> 5753 <title>Enabling Runtime Tests on Hardware</title>
5754
5755 <para>
5756 The OpenEmbedded build system can run tests on real
5757 hardware, and for certain devices it can also deploy
5758 the image to be tested onto the device beforehand.
5759 </para>
5760
5761 <para>
5762 For automated deployment, a "master image" is installed
5763 onto the hardware once as part of setup.
5764 Then, each time tests are to be run, the following
5765 occurs:
5766 <orderedlist>
5767 <listitem><para>The master image is booted into and
5768 used to write the image to be tested to
5769 a second partition.
5770 </para></listitem>
5771 <listitem><para>The device is then rebooted using an
5772 external script that you need to provide.
5773 </para></listitem>
5774 <listitem><para>The device boots into the image to be
5775 tested.
5776 </para></listitem>
5777 </orderedlist>
5778 </para>
5779
5780 <para>
5781 When running tests (independent of whether the image
5782 has been deployed automatically or not), the device is
5783 expected to be connected to a network on a
5784 pre-determined IP address.
5785 You can either use static IP addresses written into
5786 the image, or set the image to use DHCP and have your
5787 DHCP server on the test network assign a known IP address
5788 based on the MAC address of the device.
5789 </para>
5754 5790
5755 <para> 5791 <para>
5756 In order to run tests on hardware, you need to set 5792 In order to run tests on hardware, you need to set
@@ -5762,13 +5798,17 @@
5762 <itemizedlist> 5798 <itemizedlist>
5763 <listitem><para><emphasis>"SimpleRemoteTarget":</emphasis> 5799 <listitem><para><emphasis>"SimpleRemoteTarget":</emphasis>
5764 Choose "SimpleRemoteTarget" if you are going to 5800 Choose "SimpleRemoteTarget" if you are going to
5765 run tests on a target system that is already up and 5801 run tests on a target system that is already
5766 running either on the network or as an image in 5802 running the image to be tested and is available
5767 QEMU. 5803 on the network.
5804 You can use "SimpleRemoteTarget" in conjunction
5805 with either real hardware or an image running
5806 within a separately started QEMU or any
5807 other virtual machine manager.
5768 </para></listitem> 5808 </para></listitem>
5769 <listitem><para><emphasis>"GummiBootTarget":</emphasis> 5809 <listitem><para><emphasis>"GummiBootTarget":</emphasis>
5770 Choose "GummiBootTarget" if your hardware is 5810 Choose "GummiBootTarget" if your hardware is
5771 a running EFI machine with 5811 an EFI-based machine with
5772 <filename>gummiboot</filename> as bootloader and 5812 <filename>gummiboot</filename> as bootloader and
5773 <filename>core-image-testmaster</filename> 5813 <filename>core-image-testmaster</filename>
5774 (or something similar) is installed. 5814 (or something similar) is installed.
@@ -5781,8 +5821,8 @@
5781 5821
5782 <para> 5822 <para>
5783 If you set <filename>TEST_TARGET</filename> to 5823 If you set <filename>TEST_TARGET</filename> to
5784 "GummiBootTarget", you also need to 5824 "GummiBootTarget", you also need to perform a one-time
5785 setup your master image by doing the following: 5825 setup of your master image by doing the following:
5786 <orderedlist> 5826 <orderedlist>
5787 <listitem><para><emphasis>Set <filename>EFI_PROVIDER</filename>:</emphasis> 5827 <listitem><para><emphasis>Set <filename>EFI_PROVIDER</filename>:</emphasis>
5788 Be sure that <filename>EFI_PROVIDER</filename> 5828 Be sure that <filename>EFI_PROVIDER</filename>
@@ -5797,6 +5837,8 @@
5797 </para></listitem> 5837 </para></listitem>
5798 <listitem><para><emphasis>Install image:</emphasis> 5838 <listitem><para><emphasis>Install image:</emphasis>
5799 Install the image on the target system. 5839 Install the image on the target system.
5840 &lt;Need some clarification here from Stefan,
5841 partition layout, etc.&gt;
5800 </para></listitem> 5842 </para></listitem>
5801 </orderedlist> 5843 </orderedlist>
5802 </para> 5844 </para>
@@ -5853,14 +5895,17 @@
5853 <note> 5895 <note>
5854 You need to customize 5896 You need to customize
5855 <filename>TEST_POWERCONTROL_CMD</filename> 5897 <filename>TEST_POWERCONTROL_CMD</filename>
5856 and <filename>_ARGS</filename> for your own 5898 and
5857 setup. 5899 <filename>TEST_POWERCONTROL_EXTRA_ARGS</filename>
5900 for your own setup.
5858 The one requirement is that it accepts 5901 The one requirement is that it accepts
5859 "on", "off", and "cycle" as the last argument. 5902 "on", "off", and "cycle" as the last argument.
5860 </note> 5903 </note>
5861 </para></listitem> 5904 </para></listitem>
5862 <listitem><para> 5905 <listitem><para>
5863 When no command is defined, it uses classic reboot. 5906 When no command is defined, it connects to the
5907 device over SSH and uses the classic reboot command
5908 to reboot the device.
5864 Classic reboot is fine as long as the machine 5909 Classic reboot is fine as long as the machine
5865 actually reboots (i.e. the SSH test has not 5910 actually reboots (i.e. the SSH test has not
5866 failed). 5911 failed).
@@ -5890,18 +5935,6 @@
5890 <literallayout class='monospaced'> 5935 <literallayout class='monospaced'>
5891 TEST_IMAGE = "1" 5936 TEST_IMAGE = "1"
5892 </literallayout> 5937 </literallayout>
5893 Next, also in the <filename>local.conf</filename>, set the
5894 <filename>TEST_TARGET</filename> variable to
5895 "simpleremote" if you want to run tests on real hardware or
5896 set it to "qemu" if you want to run tests using QEMU.
5897 file:
5898 <literallayout class='monospaced'>
5899 TEST_TARGET = "simpleremote"
5900 </literallayout>
5901 or
5902 <literallayout class='monospaced'>
5903 TEST_TARGET = "qemu"
5904 </literallayout>
5905 Next, build your image. 5938 Next, build your image.
5906 If the image successfully builds, the tests will be 5939 If the image successfully builds, the tests will be
5907 run: 5940 run:
@@ -6013,7 +6046,6 @@
6013 Exporting tests is required if you want to be able to hand 6046 Exporting tests is required if you want to be able to hand
6014 the test execution off to a scheduler. 6047 the test execution off to a scheduler.
6015 You can only export tests that are defined in 6048 You can only export tests that are defined in
6016 Tests exported are the ones defined in
6017 <ulink url='&YOCTO_DOCS_REF_URL;#var-TEST_SUITES'><filename>TEST_SUITES</filename></ulink>. 6049 <ulink url='&YOCTO_DOCS_REF_URL;#var-TEST_SUITES'><filename>TEST_SUITES</filename></ulink>.
6018 </para> 6050 </para>
6019 6051