Merge ~sylvain-pineau/plainbox-provider-resource:snapd_resources into plainbox-provider-resource:master

[Sylvain Pineau]

Addition of the snapd resources jobs for desktop test plans and submissions.

The dependency on python3-requests-unixsocket [1] is ensured thanks to a dummy package for Trusty in the dev/stable ppas.

[1] http://packages.ubuntu.com/xenial/python3-requests-unixsocket

[Maciej Kisielewski (kissiel)]

> The dependency on python3-requests-unixsocket [1] is ensured thanks to a dummy package for Trusty in the dev/stable ppas.

I spooled up a fresh VM and installed everything from the dev ppa.
python3-requests-unixsocket didn't get installed.

After I installed it manually all jobs worked perfectly.

How this dependency is ensured? What am I doing wrong?

review: Needs Information

[Sylvain Pineau (sylvain-pineau)]

weird, I expected the packaging meta-data unit to do the right job for packaging.

[Sylvain Pineau (sylvain-pineau)]

I built the deb package for this provider locally and I can confirm the new dep is well written in the control file:

Package: plainbox-provider-resource-generic
Version: 0.31.0-1
Architecture: amd64
Maintainer: Checkbox Developers <email address hidden>
Installed-Size: 131
Depends: python3 (>= 3.2), python3-checkbox-support (>= 0.22), dmidecode, dpkg (>= 1.13), lsb-release, network-manager, udev, usbutils, python3-requests-unixsocket, libc6 (>= 2.4), libnl-3-200 (>= 3.2.7), libnl-genl-3-200 (>= 3.2.7)
Suggests: x11-server-utils, gconf2, xinput
Section: utils
Priority: optional
Homepage: http://launchpad.net/plainbox-provider-resource
Description: CheckBox generic resource jobs provider
 This package provides the generic resource jobs. It is used together
 alongside with PlainBox.
 .
 Jobs are smallest units of testing that can be performed by PlainBox.
 All jobs have an unique name. There are many types of jobs, some are fully
 automated others are fully manual.
 .
 Resources are collections of key-value data sets that are generated by
 special resource jobs. They are extensively used to indicate hardware or
 software dependencies. For example a bluetooth test may indicate it
 requires bluetooth hardware and appropriate software packages installed.

Once new builds will be available in the dev ppa, you'll see python3-requests-unixsocket installed.

review: Approve

diff --git a/bin/snapd_resource b/bin/snapd_resource
new file mode 100755
index 0000000..da0cac9
--- /dev/null
+++ b/bin/snapd_resource
@@ -0,0 +1,176 @@
+#!/usr/bin/env python3
+# Copyright 2017 Canonical Ltd.
+# All rights reserved.
+#
+# Written by:
+#    Authors: Jonathan Cave <[e-mail]>
+
+import io
+import logging
+import sys
+
+from guacamole import Command
+import requests
+import requests_unixsocket
+
+
+SNAPD_BASE_URL = 'http+unix://%2Frun%2Fsnapd.socket'
+
+
+class SnapdQuery(Command):
+
+    def __init__(self):
+        self._session = requests_unixsocket.Session()
+
+    def get(self, path):
+        r = self._session.get(SNAPD_BASE_URL + path)
+        if r.status_code != requests.codes.ok:
+            logging.error("Got error {} attempting to access {}".format(
+                          r.status_code, path))
+            sys.exit(1)
+        return r
+
+
+class AssertionQuery(SnapdQuery):
+
+    prefix = '/v2/assertions/'
+
+    def convert(self, assertion):
+        """ Super naive Assertion parser
+
+        No attempt to handle assertions with a body. Discards signatures based
+        on lack of colon characters.
+        """
+        data = self.get(self.prefix + assertion)
+        count = int(data.headers['X-Ubuntu-Assertions-Count'])
+        if count > 0:
+            for line in io.StringIO(data.text):
+                if line.strip() == "":
+                    print()
+                if ':' in line:
+                    print(line.strip())
+        return count
+
+
+class ModelAssertion(AssertionQuery):
+
+    def invoked(self, ctx):
+        count = self.convert('model')
+        if count == 0:
+            # Print a dummy assertion - not nice but really trick to use
+            # plainbox resources without some defualt value
+            print('type: model')
+            print('authority-id: None')
+            print('model: None')
+            print()
+
+
+class SerialAssertion(AssertionQuery):
+
+    def invoked(self, ctx):
+        count = self.convert('serial')
+        if count == 0:
+            # Print a dummy assertion - not nice but really trick to use
+            # plainbox resources without some defualt value
+            print('type: serial')
+            print('authority-id: None')
+            print('serial: None')
+            print()
+
+
+class Assertions(Command):
+
+    sub_commands = (
+        ('model', ModelAssertion),
+        ('serial', SerialAssertion),
+    )
+
+
+class Snaps(SnapdQuery):
+
+    prefix = '/v2/snaps'
+
+    def invoked(self, ctx):
+        data = self.get(self.prefix).json()
+
+        for snap in data['result']:
+            def print_field(key):
+                val = snap[key]
+                if val != "":
+                    print("{}: {}".format(key, val))
+            #  Whitelist of information that is of interest
+            keys = ['name', 'type', 'channel', 'version', 'revision',
+                    'developer', 'install-date', 'confinement', 'devmode']
+            for f in keys:
+                print_field(f)
+            print()
+
+
+class InterfacesQuery(SnapdQuery):
+
+    prefix = '/v2/interfaces'
+
+
+class Endpoints(InterfacesQuery):
+
+    def invoked(self, ctx):
+        data = self.get(self.prefix).json()
+
+        for plug in data['result']['plugs']:
+            def print_field(key):
+                val = plug[key]
+                if val != '':
+                    print('{}: {}'.format(key, val))
+            keys = ['snap', 'interface']
+            for f in keys:
+                print_field(f)
+            print('type: plug')
+            print('name: {}'.format(plug['plug']))
+            print()
+
+        for slot in data['result']['slots']:
+            def print_field(key):
+                val = slot[key]
+                if val != '':
+                    print('{}: {}'.format(key, val))
+            keys = ['snap', 'interface']
+            for f in keys:
+                print_field(f)
+            print('type: slot')
+            print('name: {}'.format(slot['slot']))
+            print()
+
+
+class Connections(InterfacesQuery):
+
+    def invoked(self, ctx):
+        data = self.get(self.prefix).json()
+
+        if data['result']['plugs'] is not None:
+            for plug in data['result']['plugs']:
+                if 'connections' in plug:
+                    for con in plug['connections']:
+                        print('slot: {}:{}'.format(con['snap'], con['slot']))
+                        print('plug: {}:{}'.format(plug['snap'], plug['plug']))
+                        print()
+
+
+class Interfaces(Command):
+
+    sub_commands = (
+        ('endpoints', Endpoints),
+        ('connections', Connections),
+    )
+
+
+class SnapdResource(Command):
+
+    sub_commands = (
+        ('assertions', Assertions),
+        ('snaps', Snaps),
+        ('interfaces', Interfaces),
+    )
+
+
+if __name__ == '__main__':
+    SnapdResource().main()
diff --git a/jobs/resource.pxu b/jobs/resource.pxu
index befc0dd..a7207d7 100644
--- a/jobs/resource.pxu
+++ b/jobs/resource.pxu
@@ -61,6 +61,11 @@ unit: packaging meta-data
 os-id: debian
 Depends: usbutils
 
+# This is for snapd_resource
+unit: packaging meta-data
+os-id: debian
+Depends: python3-requests-unixsocket
+
 id: cpuinfo
 estimated_duration: 0.37
 plugin: resource
@@ -332,3 +337,48 @@ _description: Generate an entry for each MIR integration tests
 command:
  for test in `mir_integration_tests --gtest_list_tests | sed -n '/\.$/s/\.$//p'`; do echo "category: integration"; echo "name: $test"; echo ""; done
  for test in `mir_acceptance_tests --gtest_list_tests | sed -n '/\.$/s/\.$//p'`; do echo "category: acceptance"; echo "name: $test"; echo ""; done
+
+id: snap
+estimated_duration: 1.1
+plugin: resource
+command:
+    unset PYTHONUSERBASE
+    snapd_resource snaps
+_description: Generates a list of snap packages
+_summary: Collect information about installed snap packages
+
+id: interface
+estimated_duration: 1.1
+plugin: resource
+command:
+    unset PYTHONUSERBASE
+    snapd_resource interfaces endpoints
+_description: Generates a list of interface declarations on the device
+_summary: Collect information about interfaces
+
+id: connections
+estimated_duration: 1.1
+plugin: resource
+command:
+    unset PYTHONUSERBASE
+    snapd_resource interfaces connections
+_description: Generates a list of plug and slot connections on the device
+_summary: Collect information about connections
+
+id: model_assertion
+_summary: Collect model assertions on the device
+_description:
+ Queries the snapd REST API for model assertions present on the device.
+plugin: resource
+estimated_duration: 2.0
+command:
+  snapd_resource assertions model
+
+id: serial_assertion
+_summary: Collect serial assertions on the device
+_description:
+ Queries the snapd REST API for serial assertions present on the device.
+plugin: resource
+estimated_duration: 2.0
+command:
+  snapd_resource assertions serial