Merge ~alexmurray/ubuntu-security-tools:umt-qrt-vm-creation into ubuntu-security-tools:master

[Alex Murray]

Add support to `umt qrt` to offer to automatically create a VM if none already exists.

[Seth Arnold (seth-arnold)]

Cool :D I've got a comment on the lxd create(), but it's minor.

Thanks

[Alex Murray (alexmurray)]

Thanks for the review Seth - I made a chance on master last week https://git.launchpad.net/ubuntu-security-tools/commit/?id=95441826c758b1df62bcfcdaf73354003de62520 that should address your concern.

[Seth Arnold (seth-arnold)]

On Mon, Sep 20, 2021 at 05:09:39AM -0000, Alex Murray wrote:
> Thanks for the review Seth - I made a chance on master last week
> https://git.launchpad.net/ubuntu-security-tools/commit/?id=95441826c758b1df62bcfcdaf73354003de62520
> that should address your concern.

Oh, that looks a lot nicer. Thanks :)

diff --git a/build-tools/umt b/build-tools/umt
index 40b5250..50a0c19 100755
--- a/build-tools/umt
+++ b/build-tools/umt
@@ -2079,20 +2079,34 @@ def cmd_search():
                 pkg_list[release][0], pkg_list[release][1], pkg_list[release][2]))
 
 class QRTBackend:
-    class NotImplementedError(Exception):
-        def __init__(self, msg="🚧 Please implement me 🚧", *args, **kwargs):
-            super().__init__(msg, *args, **kwargs)
-
-    def __init__(self, name, vm, user=os.getenv("USER"), debug=False, dry_run=False, no_snapshot=False):
+    def __init__(self, name, vm, release, user=os.getenv("USER"), debug=False, dry_run=False, no_snapshot=False):
         self.name = name
         self.vm = vm
+        self.release = release
         self.user = user
         self.debug = debug
         self.dry_run = dry_run
         self.no_snapshot = no_snapshot
-
-    def _runcmd(self, cmd, okrc=[0]):
-        return runcmd(cmd, debug=self.debug, dry_run=self.dry_run, okrc=okrc)
+    def _runcmd(self, cmd, stdout=subprocess.PIPE, okrc=[0]):
+        return runcmd(cmd, stdout=stdout, debug=self.debug, dry_run=self.dry_run, okrc=okrc)
+    def exists(self):
+        '''Check whether the VM exists in the backend.'''
+        raise NotImplementedError()
+    def create(self):
+        '''Create a new VM in the backend.'''
+        assert(not self.exists())
+        raise NotImplementedError()
+    def ensure(self):
+        '''Ensure the VM exists in the backend.'''
+        if not self.exists():
+            print("%s does not exist in %s backend, do you want to try and automatically create it (y/N)? " % (self.vm, self.name), end=' ', flush=True)
+            answer = sys.stdin.readline().strip().lower()
+            if answer == 'y':
+                self.create()
+                if not self.dry_run:
+                    assert(self.exists())
+            else:
+                raise RuntimeError("User choose not to proceed.")
     def start(self):
         raise NotImplementedError()
     def stop(self, force=False):
@@ -2148,10 +2162,31 @@ class UVTQRTBackend(QRTBackend):
             err("Unable to find uvt - please define QRT as the path to ubuntu-qa-tools repo")
         return uvt
 
-    def __init__(self, vm, user=os.getenv("USER"), debug=False, dry_run=False, no_snapshot=False):
-        super().__init__("uvt", vm, user, debug, dry_run, no_snapshot)
+    def __init__(self, vm, release, user=os.getenv("USER"), debug=False, dry_run=False, no_snapshot=False):
+        super().__init__("uvt", vm, release, user, debug, dry_run, no_snapshot)
         self.uvt = self.find_uvt_binary()
 
+    def exists(self):
+        found = False
+        cmd = [self.uvt, "list"]
+        rc, report = self._runcmd(cmd)
+        # look for an exact match so we don't accidentally match on common
+        # prefixes
+        for line in report.splitlines():
+            # if VM is running will be suffixed with an asterisk
+            if line == self.vm or line == self.vm + "*":
+                found = True
+        return found
+
+    def create(self):
+        cmd = [self.uvt, "new", "--name", self.vm, "-f", self.release, "amd64"]
+        # let stdout go to terminal
+        rc, report = self._runcmd(cmd, stdout=None)
+        if rc != 0:
+            raise RuntimeError("Failed to create new UVT VM %s: %s" %
+                               (self.vm, report))
+        assert(self.exists())
+
     def start(self):
         # run headless since we don't use the GUI and wait for ssh
         # availability
@@ -2205,12 +2240,29 @@ class UVTQRTBackend(QRTBackend):
 
 
 class LXDQRTBackend(QRTBackend):
-    def __init__(self, vm, user="ubuntu", debug=False, dry_run=False, no_snapshot=False):
-        super().__init__("lxd", vm, user, debug, dry_run, no_snapshot)
+    def __init__(self, vm, release, user="ubuntu", debug=False, dry_run=False, no_snapshot=False):
+        super().__init__("lxd", vm, release, user, debug, dry_run, no_snapshot)
 
     def running(self):
-        (_, result) = self._runcmd(["lxc", "info", self.vm])
-        return "RUNNING" in result
+        (rc, result) = self._runcmd(["lxc", "info", self.vm], okrc=None)
+        return rc == 0 and "RUNNING" in result
+
+    def exists(self):
+        cmd = ["lxc", "info", self.vm]
+        rc, _ = self._runcmd(cmd, okrc=None)
+        return rc == 0
+
+    def create(self):
+        cmd = ["lxc", "launch", "--vm", "images:ubuntu/%s" % self.release, self.vm]
+        # let stdout go to terminal
+        rc, report = self._runcmd(cmd, stdout=None)
+        if rc != 0:
+            raise RuntimeError("Failed to create new LXD VM %s: %s" %
+                               (self.vm, report))
+        # wait a bit since seems to take a while until the lxd-agent is
+        # running and there doesn't appear to be a way to detect this...
+        time.sleep(15)
+        assert(self.exists())
 
     def start(self):
         if self.running():
@@ -2445,9 +2497,10 @@ def run_qrt_tests(opt, args, details):
     else:
         vm = opt.vm_prefix + "-" + details["release"] + "-" + opt.arch
 
-    backend = qrt_backends[opt.backend](vm, user=user, debug=opt.debug, no_snapshot=opt.no_snapshot)
+    backend = qrt_backends[opt.backend](vm, details["release"], user=user,
+                                        debug=opt.debug, no_snapshot=opt.no_snapshot)
 
-    print("Running QRT test " + qrt_test + " for " + details["package"] + " as " + user + (" via sudo" if opt.sudo else "") + " with " + backend.name)
+    print("Running QRT test " + qrt_test + " for " + details["package"] + " in release " + details["release"] + " as " + user + (" via sudo" if opt.sudo else "") + " with " + backend.name)
 
     # catch any exception which occurred during execution
     try:
@@ -2467,6 +2520,8 @@ def run_qrt_tests(opt, args, details):
             if not opt.dry_run:
                 copy_to_repo(opt, details, quiet=not opt.debug, source_dest=source_dest, binary_dest=binary_dest)
 
+        backend.ensure()
+
         if not opt.no_update:
             # ensure vm is stopped first - unless no_snapshot we can stop
             # it by force