Merge ~jocave/plainbox-provider-checkbox:uvtkvm-test-on-ubuntucore into plainbox-provider-checkbox:master

[Jonathan Cave]

Modifications to the virtualization/kvm_check_vm test that support use of the test-snapd-uvtool snap in the store hence allowing the test to run on Ubuntu Core.

Test steps required to run on Ubuntu Core:

 * sudo snap install test-snapd-uvtool --devmode (--edge currently)
 * sudo snap alias test-snapd-uvtool.uvt-kvm uvt-kvm
 * sudo snap alias test-snapd-uvtool.uvt-simplestreams-libvirt uvt-simplestreams-libvirt
 * sudo snap alias test-snapd-uvtool.virsh virsh

 .. install checkbox-snappy, run test

Tested on a R340.

[Jeff Lane  (bladernr)]

Hey,

While youre at it, could you add a packaging.pxu file to explicitly install uvtool and uvtool-libvirt?

There is no packaging metadata that i can find, and turns out that on focal, installing uvtool also installs uvtool-libvirt, but on bionic, you have to explicitly install both. So a quick fix would be to just add a packaging metadata definition to explicitly install both regardless of release.

That's just a side request that could be done here... otherwise, everything below makes sense to me.

review: Needs Information

[Jonathan Cave (jocave)]

Sylvain pointed out that packages are included as dependencies for plainbox-provider-certification-server: https://git.launchpad.net/plainbox-provider-certification-server/tree/units/packaging.pxu

So I don't think we can our would want to have packaging units in this provider.

[Jeff Lane  (bladernr)]

Gah... disregard, then. I didn't see them in PPC and didn't remember them at all being in PPCS. Thanks for pointing it out.

review: Approve

[Michael Reed (mreed8855)]

The code looks good to me and I ran the test and it passed. +1

review: Approve

[Sylvain Pineau (sylvain-pineau)]

Thanks for the tempdir fixes, LGTM

review: Approve

diff --git a/bin/virtualization.py b/bin/virtualization.py
index 3032f71..a3794de 100755
--- a/bin/virtualization.py
+++ b/bin/virtualization.py
@@ -564,7 +564,8 @@ class UVTKVMTest(object):
         self.release = get_codename_to_test()
         self.arch = check_output(['dpkg', '--print-architecture'],
                                  universal_newlines=True).strip()
-        self.name = tempfile.mktemp()[5:]
+        # max len(name) is 8 chars for use with test-snapd-uvtool snap
+        self.name = tempfile.mktemp()[-8:]
 
     def run_command(self, cmd):
         task = RunCommand(cmd)
@@ -584,11 +585,25 @@ class UVTKVMTest(object):
                 logging.debug(' Command returned no output')
             return True
 
+    def ssh_command(self, private_key_file, cmd):
+        task = RunCommand("uvt-kvm ip {}".format(self.name))
+        if task.returncode != 0:
+            logging.error('Command {} returnd a code of {}'.format(
+                task.cmd, task.returncode))
+            return False
+        vm_ip = task.stdout
+
+        ssh_cmd = ('ssh ubuntu@{} '
+                   '-o UserKnownHostsFile=/dev/null '
+                   '-o StrictHostKeyChecking=no '
+                   '-i {} {}').format(vm_ip, private_key_file, cmd)
+        return self.run_command(ssh_cmd)
+
     def get_image_or_source(self):
         """
         An image can be specifed in a filesytem path and used directly in
         uvt-create with the backing-image option or a url can be
-        specifed and used in uvt-simpletreams to generate an image.
+        specifed and used in uvt-simplestreams to generate an image.
         """
         url = urlparse(self.image)
 
@@ -633,49 +648,54 @@ class UVTKVMTest(object):
 
     def start(self):
         # Generate ssh key if needed
-        home_dir = os.environ['HOME']
-        ssh_key_file = "{}/.ssh/id_rsa".format(home_dir)
-
-        if not os.path.exists(ssh_key_file):
-            self.run_command("mkdir -p {}/.ssh".format(home_dir))
+        with tempfile.TemporaryDirectory(
+                dir=os.path.expandvars("$PLAINBOX_SESSION_SHARE")) as tmp_dir:
+            ssh_private_key_file = "{}/id_rsa".format(tmp_dir)
+            ssh_public_key_file = "{}/id_rsa.pub".format(tmp_dir)
+
+            if not os.path.exists(ssh_private_key_file):
+                cmd = ('ssh-keygen -f {} -t rsa -N \'\''.format(
+                    ssh_private_key_file))
+                if not self.run_command(cmd):
+                    return False
+
+            # Create vm
+            logging.debug("Creating VM")
+            cmd = ('uvt-kvm create --ssh-public-key-file {} {} arch={}'.format(
+                ssh_public_key_file, self.name, self.arch))
+
+            logging.debug("Checking for local image")
+            try:
+                self.image.find(".img") > 0
+            except AttributeError:
+                logging.debug("No user provided image found.")
+                logging.debug(
+                    "I will attempt to sync the image from ubuntu.com")
+            else:
+                cmd = cmd + " --backing-image-file {} ".format(self.image)
 
-            cmd = ('ssh-keygen -f {} -t rsa -N \'\''.format(ssh_key_file))
             if not self.run_command(cmd):
                 return False
 
-        # Create vm
-        logging.debug("Creating VM")
-        cmd = ('uvt-kvm create {} arch={}'.format(self.name, self.arch))
-
-        logging.debug("Checking for local image")
-        try:
-            self.image.find(".img") > 0
-        except AttributeError:
-            logging.debug("No user provided image found.")
-            logging.debug("I will attempt to sync the image from ubuntu.com")
-        else:
-            cmd = cmd + " --backing-image-file {} ".format(self.image)
-
-        if not self.run_command(cmd):
-            return False
-
-        logging.debug("Wait for VM to complete creation")
-        if not self.run_command('uvt-kvm wait {}'.format(self.name)):
-            return False
+            logging.debug("Wait for VM to complete creation")
+            cmd = 'uvt-kvm wait --ssh-private-key-file {} {}'.format(
+                ssh_private_key_file, self.name)
+            if not self.run_command(cmd):
+                return False
 
-        logging.debug("List newly created vm")
-        cmd = ("uvt-kvm list")
-        if not self.run_command(cmd):
-            return False
+            logging.debug("List newly created vm")
+            cmd = ("uvt-kvm list")
+            if not self.run_command(cmd):
+                return False
 
-        logging.debug("Verify VM was created with ssh")
-        if not self.run_command('uvt-kvm ssh {}'.format(self.name)):
-            return False
+            logging.debug("Verify VM was created with ssh")
+            if not self.ssh_command(ssh_private_key_file, ""):
+                return False
 
-        logging.debug("Verify VM was created with ssh and run a command")
-        if not self.run_command('uvt-kvm ssh {} \"lsb_release -a \"'
-                                .format(self.name)):
-            return False
+            logging.debug("Verify VM was created with ssh and run a command")
+            cmd = "lsb_release -a"
+            if not self.ssh_command(ssh_private_key_file, cmd):
+                return False
 
         return True
 
diff --git a/units/virtualization/jobs.pxu b/units/virtualization/jobs.pxu
index 2b6fd99..2b903c7 100644
--- a/units/virtualization/jobs.pxu
+++ b/units/virtualization/jobs.pxu
@@ -5,8 +5,10 @@ user: root
 environ: UVT_IMAGE_OR_SOURCE http_proxy https_proxy
 estimated_duration: 300.0
 requires:
- package.name == 'uvtool'
- package.name == 'uvtool-libvirt'
+ executable.name == 'uvt-kvm'
+ executable.name == 'uvt-simplestreams-libvirt'
+ executable.name == 'virsh'
+ executable.name == 'ssh-keygen'
  virtualization.kvm == 'supported'
 command: virtualization.py --debug uvt
 _description: