Merge ~jocave/checkbox-support:snapd-install-improvements into checkbox-support:master

[Jonathan Cave]

Some improvements to the snapd class used by the snappy tests in particular. First commit adds a call to abort the change if the timeout is reached. Second commit just provides information about the tasks in progress to help diagnose problems like slow installs.

[Jonathan Cave (jocave)]

Modified second commit to make verbose output to be off by default

[Sylvain Pineau (sylvain-pineau)]

LGTM

review: Approve

[Devices Certification Bot (ce-certification-qa)]

The merge was fine but running tests failed.

[xenial] [13:45:56] starting container
[bionic] [13:45:56] starting container
Device project added to xenial-testing
Device project added to bionic-testing
[xenial] [13:46:06] provisioning container
[bionic] [13:46:11] provisioning container
[xenial] [13:46:37] Unable to provision requirements in container!
[xenial] output: https://paste.ubuntu.com/p/4bCRvWpk5m/
[xenial] [13:46:39] Fixing file permissions in source directory
[xenial] Destroying failed container to reclaim resources
[bionic] [13:47:05] Unable to provision requirements in container!
[bionic] output: https://paste.ubuntu.com/p/JcgFcQj3R9/
[bionic] [13:47:07] Fixing file permissions in source directory
[bionic] Destroying failed container to reclaim resources

review: Needs Fixing

diff --git a/checkbox_support/snap_utils/snapd.py b/checkbox_support/snap_utils/snapd.py
index 84ff9f5..8cb5c7c 100644
--- a/checkbox_support/snap_utils/snapd.py
+++ b/checkbox_support/snap_utils/snapd.py
@@ -12,8 +12,9 @@ import requests_unixsocket
 
 class AsyncException(Exception):
 
-    def __init__(self, message):
+    def __init__(self, message, abort_message=''):
         self.message = message
+        self.abort_message = abort_message
 
 
 class Snapd():
@@ -27,10 +28,15 @@ class Snapd():
     _interfaces = '/v2/interfaces'
     _assertions = '/v2/assertions'
 
-    def __init__(self, task_timeout=30, poll_interval=1):
+    def __init__(self, task_timeout=30, poll_interval=1, verbose=False):
         self._session = requests_unixsocket.Session()
         self._task_timeout = task_timeout
         self._poll_interval = poll_interval
+        self._verbose = verbose
+
+    def _info(self, msg):
+        if self._verbose:
+            print('(info) {}'.format(msg), flush=True)
 
     def _get(self, path, params=None, decode=True):
         r = self._session.get(self._url + path, params=params)
@@ -60,9 +66,19 @@ class Snapd():
             if status == 'Done':
                 return True
             if time.time() > maxtime:
-                raise AsyncException(status)
+                abort_result = self._abort_change(change_id)
+                raise AsyncException(status, abort_result)
+            for task in self.tasks(change_id):
+                if task['status'] == 'Doing':
+                    self._info(task['summary'])
             time.sleep(self._poll_interval)
 
+    def _abort_change(self, change_id):
+        path = self._changes + '/' + change_id
+        data = {'action': 'abort'}
+        r = self._post(path, json.dumps(data))
+        return r['result']['status']
+
     def list(self, snap=None):
         path = self._snaps
         if snap is not None:
@@ -111,6 +127,11 @@ class Snapd():
         r = self._get(path)
         return r['result']['status']
 
+    def tasks(self, change_id):
+        path = self._changes + '/' + change_id
+        r = self._get(path)
+        return r['result']['tasks']
+
     def revert(self, snap, channel='stable', revision=None):
         path = self._snaps + '/' + snap
         data = {'action': 'revert', 'channel': channel}