[OE-core] [RFC PATCH 4/4] lib/oeqa: add a test target controller for EFI targets

Otavio Salvador otavio at ossystems.com.br
Thu Mar 20 21:08:49 UTC 2014


On Thu, Mar 20, 2014 at 1:29 PM, Stefan Stanacar
<stefanx.stanacar at intel.com> wrote:
> The purpose of this module is to deploy a test image on a EFI-enabled hardware
> and run our runtime tests.
> A bit of background:
>  - testimage.bbclass uses the concept of TEST_TARGET which is a class name
> that is responsible for target deploying. A layer can provide
> it's own TEST_TARGET. Right now has OE-core has a QemuTarget and a SimpleRemoteTarget
> (ssh into an already up and running machine and run tests), the default one being qemu.
>  - basically testimage does something like:
>       - target.deploy()
>       - target.start()
>       - runTests()
>       - target.stop()
>
> This module assumes a running EFI (and gummiboot as bootloader) machine with
> core-image-testmaster installed (or similar).
> In order to use this Master Image mechanism there are some hard requirements:
>  - it only works for EFI-enabled hardware with EFI_PROVIDER = "gummiboot"
>  - your hardware under test has to be in DHCP-enabled network that gives it the same IP for each reboot
>
> One time setup (master image):
>  - build core-image-testmaster with EFI_PROVIDER = "gummiboot"
>  - TEMP: for now you'll need SRCREV_meta_pn-linux-yocto = "${AUTOREV}"
>     in local.conf so that some kernel configs required by gummiboot get enabled
>  - install the image on the target
>
> Test image setup:
>  - build your test image, e.g core-image-sato as you usually do, but with these in local.conf:
>     IMAGE_FSTYPES += "tar.gz"
>    (similar to above you need SRCREV_meta_pn-linux-yocto = "${AUTOREV}")
>  - Now run the tests:
>     INHERIT += "testimage"
>     TEST_TARGET = "GenericEfi"
>     TEST_TARGET_IP = "192.168.2.3"
>     bitbake core-image-sato -c testimage
>
> Other notes:
>  - TEST_POWERCONTROL_CMD (togheter with TEST_POWERCONTROL_EXTRA_ARGS) can be a command that runs on the host and does power cycling.
>    The test code passes one argument to that command: off, on or cycle (off then on). In my case I use something like
>    TEST_POWERCONTROL_CMD="/home/stefans/powercontrol.exp test 192.168.2.1 nuc1" in local.conf.
>    Basically my expect script does: 'ssh test at 192.168.2.1 and runs a python script there that controls power for a label called nuc1'.
>  - if no command is defined it would use classic reboot. This is fine as long as the machine
>    actually reboots (as in the ssh test hasn't failed), but it's useful for "simple-setup-with-one-board-on-the-desk" scenario, where
>    some manual interaction is okay from time to time.
>
> [YOCTO #5614]
>
> Signed-off-by: Stefan Stanacar <stefanx.stanacar at intel.com>

Nice.

> ---
>  meta/lib/oeqa/controllers/masterimage.py | 124 +++++++++++++++++++++++++++++++
>  meta/lib/oeqa/runtime/ssh.py             |   2 +
>  2 files changed, 126 insertions(+)
>  create mode 100644 meta/lib/oeqa/controllers/masterimage.py
>
> diff --git a/meta/lib/oeqa/controllers/masterimage.py b/meta/lib/oeqa/controllers/masterimage.py
> new file mode 100644
> index 0000000..028208b
> --- /dev/null
> +++ b/meta/lib/oeqa/controllers/masterimage.py
> @@ -0,0 +1,124 @@
> +import os
> +import bb
> +import traceback
> +import time
> +
> +import oeqa.targetcontrol
> +import oeqa.utils.sshcontrol as sshcontrol
> +import oeqa.utils.commands as commands
> +
> +class GenericEfi(oeqa.targetcontrol.SimpleRemoteTarget):
> +
> +    def __init__(self, d):
> +        # let our base class do the ip thing
> +        super(GenericEfi, self).__init__(d)
> +
> +        # test rootfs + kernel
> +        self.rootfs = os.path.join(d.getVar("DEPLOY_DIR_IMAGE", True), d.getVar("IMAGE_LINK_NAME", True) + '.tar.gz')
> +        self.kernel = os.path.join(d.getVar("DEPLOY_DIR_IMAGE", True), d.getVar("KERNEL_IMAGETYPE"))
> +        if not os.path.isfile(self.rootfs):
> +            # we could've checked that IMAGE_FSTYPES contains tar.gz but the config for running testimage might not be
> +            # the same as the config with which the image was build, ie
> +            # you bitbake core-image-sato with IMAGE_FSTYPES += "tar.gz"
> +            # and your autobuilder overwrites the config, adds the test bits and runs bitbake core-image-sato -c testimage
> +            bb.fatal("No rootfs found. Did you build the image ?\nIf yes, did you build it with IMAGE_FSTYPES += \"tar.gz\" ? \
> +                      \nExpected path: %s" % self.rootfs)

Couldn't testimage class add it?

> +        if not os.path.isfile(self.kernel):
> +            bb.fatal("No kernel found. Expected path: %s" % self.kernel)
> +
> +        # if the user knows what he's doing, then by all means...
> +        # test-rootfs.tar.gz and test-kernel are hardcoded names in other places
> +        # they really have to be used like that in commands though
> +        cmds = d.getVar("TEST_DEPLOY_CMDS", True)
> +        if cmds:
> +            self.deploy_cmds = cmds.split("\n")

Good.

> +        else:
> +            self.deploy_cmds = [
> +                'mount -L boot /boot',
> +                'mkdir -p /mnt/testrootfs',
> +                'mount -L testrootfs /mnt/testrootfs',
> +                'modprobe efivarfs',
> +                'mount -t efivarfs efivarfs /sys/firmware/efi/efivars',
> +                'cp ~/test-kernel /boot',
> +                'rm -rf /mnt/testrootfs/*',
> +                'tar xzvf ~/test-rootfs.tar.gz -C /mnt/testrootfs',

How target see those files? NFS?

> +                r'printf "\x07\x00\x00\x00\x74\x00\x65\x00\x73\x00\x74\x00\x00\x00" > /sys/firmware/efi/efivars/LoaderEntryOneShot-4a67b082-0a4c-41cf-b6c7-440b29bb8c4f'

Can you elaborate this? Seems too 'black magic' for me.

> +                ]
> +
> +        # master ssh connection
> +        self.master = None
> +
> +        # this is the name of the command that controls the power for a board
> +        # e.g: TEST_POWERCONTROL_CMD = "/home/user/myscripts/powercontrol.py ${MACHINE} what-ever-other-args-the-script-wants"
> +        # the command should take as the last argument "off" and "on" and "cycle" (off, on)
> +        self.powercontrol_cmd = d.getVar("TEST_POWERCONTROL_CMD", True) or None
> +        self.powercontrol_args = d.getVar("TEST_POWERCONTROL_EXTRA_ARGS") or ""
> +        self.origenv = os.environ
> +        if self.powercontrol_cmd:
> +            if self.powercontrol_args:
> +                self.powercontrol_cmd = "%s %s" % (self.powercontrol_cmd, self.powercontrol_args)
> +            # the external script for controlling power might use ssh
> +            # ssh + keys means we need the original user env
> +            bborigenv = d.getVar("BB_ORIGENV", False) or {}
> +            for key in bborigenv:
> +                val = bborigenv.getVar(key, True)
> +                if val is not None:
> +                    self.origenv[key] = str(val)
> +            self.power_ctl("on")
> +
> +    def power_ctl(self, msg):
> +        if self.powercontrol_cmd:
> +            cmd = "%s %s" % (self.powercontrol_cmd, msg)
> +            commands.runCmd(cmd, preexec_fn=os.setsid, env=self.origenv)
> +
> +    def power_cycle(self, conn):
> +        if self.powercontrol_cmd:
> +            # be nice, don't just cut power
> +            conn.run("shutdown -h now")
> +            time.sleep(10)
> +            self.power_ctl("cycle")
> +        else:
> +            status, output = conn.run("reboot")
> +            if status != 0:
> +                bb.error("Failed rebooting target and no power control command defined. You need to manually reset the device.\n%s" % output)
> +
> +    def deploy(self):
> +        bb.plain("%s - deploying image on target" % self.pn)
> +        # base class just sets the ssh log file for us
> +        super(GenericEfi, self).deploy()
> +        self.master = sshcontrol.SSHControl(ip=self.ip, logfile=self.sshlog, timeout=600, port=self.port)
> +        try:
> +            self._deploy()
> +        except Exception as e:
> +            bb.fatal("Failed deploying test image: %s" % e)
> +
> +    def _deploy(self):
> +        # make sure we are in the right image
> +        status, output = self.master.run("cat /etc/masterimage")
> +        if status != 0:
> +            raise Exception("No ssh connectivity or target isn't running a master image.\n%s" % output)
> +
> +        # make sure these aren't mounted
> +        self.master.run("umount /boot; umount /mnt/testrootfs; umount /sys/firmware/efi/efivars;")
> +
> +        # from now on, every deploy cmd should return 0
> +        self.master.ignore_status = False
> +        self.master.copy_to(self.rootfs, "~/test-rootfs.tar.gz")
> +        self.master.copy_to(self.kernel, "~/test-kernel")
> +        for cmd in self.deploy_cmds:
> +            self.master.run(cmd)
> +
> +
> +    def start(self, params=None):
> +        bb.plain("%s - boot test image on target" % self.pn)
> +        self.power_cycle(self.master)
> +        # assuming the reboot worked, we need to wait a bit
> +        # there are better ways than a timeout but this should work for my purpose for now
> +        time.sleep(120)
> +        # we are live, set the ssh object for the target/test image
> +        self.connection = sshcontrol.SSHControl(self.ip, logfile=self.sshlog, port=self.port)
> +        bb.plain("%s - start running tests" % self.pn)
> +
> +    def stop(self):
> +        bb.plain("%s - reboot/powercycle target" % self.pn)
> +        self.power_cycle(self.connection)
> diff --git a/meta/lib/oeqa/runtime/ssh.py b/meta/lib/oeqa/runtime/ssh.py
> index 8c96020..e648660 100644
> --- a/meta/lib/oeqa/runtime/ssh.py
> +++ b/meta/lib/oeqa/runtime/ssh.py
> @@ -14,3 +14,5 @@ class SshTest(oeRuntimeTest):
>      def test_ssh(self):
>          (status, output) = self.target.run('uname -a')
>          self.assertEqual(status, 0, msg="SSH Test failed: %s" % output)
> +        (status, output) = self.target.run('cat /etc/masterimage')
> +        self.assertEqual(status, 1, msg="This isn't the right image  - /etc/masterimage shouldn't be here %s" % output)
> --
> 1.8.5.3
>
> --
> _______________________________________________
> Openembedded-core mailing list
> Openembedded-core at lists.openembedded.org
> http://lists.openembedded.org/mailman/listinfo/openembedded-core



-- 
Otavio Salvador                             O.S. Systems
http://www.ossystems.com.br        http://code.ossystems.com.br
Mobile: +55 (53) 9981-7854            Mobile: +1 (347) 903-9750



More information about the Openembedded-core mailing list