diff options
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 80 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 27 |
2 files changed, 69 insertions, 38 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 | <Need some clarification here from Stefan, | ||
5841 | partition layout, etc.> | ||
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 | ||
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 164ea1c817..fbf0a43dee 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -7620,10 +7620,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
7620 | <para> | 7620 | <para> |
7621 | Automatically runs the series of automated tests for | 7621 | Automatically runs the series of automated tests for |
7622 | images when an image is successfully built. | 7622 | images when an image is successfully built. |
7623 | <note> | 7623 | </para> |
7624 | Currently, there is only support for running these tests | 7624 | |
7625 | under QEMU. | 7625 | <para> |
7626 | </note> | ||
7627 | These tests are written in Python making use of the | 7626 | These tests are written in Python making use of the |
7628 | <filename>unittest</filename> module, and the majority of | 7627 | <filename>unittest</filename> module, and the majority of |
7629 | them run commands on the target system over | 7628 | them run commands on the target system over |
@@ -7722,24 +7721,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
7722 | You can provide the following arguments with | 7721 | You can provide the following arguments with |
7723 | <filename>TEST_TARGET</filename>: | 7722 | <filename>TEST_TARGET</filename>: |
7724 | <itemizedlist> | 7723 | <itemizedlist> |
7725 | <listitem><para><emphasis>"qemu":</emphasis> | 7724 | <listitem><para><emphasis>"qemu" and "QemuTarget":</emphasis> |
7726 | Boots a QEMU image and runs the tests. | 7725 | Boots a QEMU image and runs the tests. |
7727 | See the | 7726 | See the |
7728 | "<ulink url='&YOCTO_DOCS_DEV_URL;#qemu-image-enabling-tests'>QEMU</ulink>" | 7727 | "<ulink url='&YOCTO_DOCS_DEV_URL;#qemu-image-enabling-tests'>Enabling Runtime Tests on QEMU</ulink>" |
7729 | section in the Yocto Project Development Manual for | 7728 | section in the Yocto Project Development Manual for |
7730 | more information. | 7729 | more information. |
7731 | </para></listitem> | 7730 | </para></listitem> |
7732 | <listitem><para><emphasis>"QemuTarget":</emphasis> | 7731 | <listitem><para><emphasis>"simpleremote" and "SimpleRemoteTarget":</emphasis> |
7733 | Identical to "qemu". | ||
7734 | </para></listitem> | ||
7735 | <listitem><para><emphasis>"simpleremote":</emphasis> | ||
7736 | Runs the tests on target hardware that is already | 7732 | Runs the tests on target hardware that is already |
7737 | up and running. | 7733 | up and running. |
7738 | The hardware can be on the network or it can be | 7734 | The hardware can be on the network or it can be |
7739 | a device running an image on QEMU. | 7735 | a device running an image on QEMU. |
7740 | You must also set | 7736 | You must also set |
7741 | <link linkend='var-TEST_TARGET_IP'><filename>TEST_TARGET_IP</filename></link> | 7737 | <link linkend='var-TEST_TARGET_IP'><filename>TEST_TARGET_IP</filename></link> |
7742 | when you use "simpleremote". | 7738 | when you use "simpleremote" or "SimpleRemoteTarget". |
7743 | <note> | 7739 | <note> |
7744 | This argument is defined in | 7740 | This argument is defined in |
7745 | <filename>meta/lib/oeqa/targetcontrol.py</filename>. | 7741 | <filename>meta/lib/oeqa/targetcontrol.py</filename>. |
@@ -7747,9 +7743,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
7747 | reasons. | 7743 | reasons. |
7748 | </note> | 7744 | </note> |
7749 | </para></listitem> | 7745 | </para></listitem> |
7750 | <listitem><para><emphasis>"SimpleRemoteTarget":</emphasis> | ||
7751 | Identical to "simpleremote". | ||
7752 | </para></listitem> | ||
7753 | <listitem><para><emphasis>"GummibootTarget":</emphasis> | 7746 | <listitem><para><emphasis>"GummibootTarget":</emphasis> |
7754 | Automatically deploys and runs tests on an | 7747 | Automatically deploys and runs tests on an |
7755 | EFI-enabled machine that has a master image | 7748 | EFI-enabled machine that has a master image |
@@ -7761,6 +7754,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
7761 | </para></listitem> | 7754 | </para></listitem> |
7762 | </itemizedlist> | 7755 | </itemizedlist> |
7763 | </para> | 7756 | </para> |
7757 | |||
7758 | <para> | ||
7759 | For information on running tests on hardware, see the | ||
7760 | "<ulink url='&YOCTO_DOCS_DEV_URL;#hardware-image-enabling-tests'>Enabling Runtime Tests on Hardware</ulink>" | ||
7761 | section in the Yocto Project Development Manual. | ||
7762 | </para> | ||
7764 | </glossdef> | 7763 | </glossdef> |
7765 | </glossentry> | 7764 | </glossentry> |
7766 | 7765 | ||