Merge ~pieq/bugit/+git/qabro:fix-1832181-additional-info into bugit:master

[Pierre Equoy]

Check related bug for more information.

Tested by building a snap and running it on:

- Desktop 18.04
- OEM Desktop 18.04
- Ubuntu Core 16

making sure:

- the manifest field is retrieved when using OEM images
- all the GPUs are shown when the device has more than one

Note: this branch includes the changes made in https://code.launchpad.net/~pieq/qabro/+git/qabro/+ref/move-to-base18

Unmerged commits

f212b3c... by Pierre Equoy on 2019-06-12

Use layout section directly

This snap is now using base18, so the passthrough section is not needed
anymore.

9c2e635... by Pierre Equoy on 2019-06-12

Check for PCI class '03' to get GPUs

LP: #1832181

d1e9dd6... by Pierre Equoy on 2019-06-12

Get OEM manifest from system instead of calling ubuntu-report

ubuntu-report gets its OEM manifest information from file
/var/lib/ubuntu_dist_channel. In a snap runtime, this file is available
in /var/lib/snapd/hostfs. This commit uses the same way to access the
OEM manifest as ubuntu-report without actually calling ubuntu-report :)

LP: #1832181

2f06c24... by Pierre Equoy on 2019-06-12

Add SKU to Additional information section

SKU cannot be determined automatically, but it helps QA engineers to
have an empty line already here to input it.

LP: #1832181

ff30707... by Pierre Equoy on 2019-06-12

Bump to v0.11dev

7bb591b... by Pierre Equoy on 2019-06-10

Move to base18

1c2369e... by Pierre Equoy on 2019-06-10

Use snapd socket to retrieve snap information

core18 does not have access to the `snap` command; therefore, it is not
possible to run commands like `snap list` like we used to do. Instead,
snapcraft team recommends to use the socket to snapd in order to
communicate with snap.

This commit does so by implementing a snapdsocket class that
communicates with the snapd socket.

The snap_list.org attachment method is revamped to use this new class,
as well as the check for qabro's devmode when running the app.

diff --git a/qabro/__init__.py b/qabro/__init__.py
index 815374c..9c72446 100644
--- a/qabro/__init__.py
+++ b/qabro/__init__.py
@@ -6,6 +6,7 @@ import sys
 
 from qabro.bug_assistant import BugAssistant, BugReport
 from qabro.ui import ReportScreen
+from qabro.utils import snapdsocket
 
 
 logger = logging.getLogger(__name__)
@@ -20,10 +21,10 @@ def main():
         sys.exit(("Cannot determine snap name. "
                   "Please install this tool using the snap command."))
 
-    output = subprocess.check_output(['snap', 'list', snap_name],
-                                     universal_newlines=True)
+    ss = snapdsocket()
+    qabro_snap_info = [e for e in ss.get_snaps() if e['name'] == 'qabro'][0]
 
-    if 'devmode' not in output:
+    if not qabro_snap_info['devmode']:
         sys.exit("This tool requires --devmode option to run properly.")
 
     logfile = os.path.join(os.getenv('SNAP_USER_COMMON', '/tmp'), 'qabro.log')
diff --git a/qabro/__version__.py b/qabro/__version__.py
index 992265c..29033e1 100644
--- a/qabro/__version__.py
+++ b/qabro/__version__.py
@@ -1,5 +1,5 @@
 __title__ = 'qabro'
-__version__ = '0.10.1'
+__version__ = '0.11dev'
 __description__ = 'Tool to generate a Launchpad bug report and attach useful logs (using sosreport and the like).'
 __author__ = 'Pierre Equoy'
 __author_email__ = '[e-mail]'
diff --git a/qabro/bug_assistant.py b/qabro/bug_assistant.py
index 209eb12..12f6df4 100644
--- a/qabro/bug_assistant.py
+++ b/qabro/bug_assistant.py
@@ -1,8 +1,6 @@
 import getpass
-import json
 import os
 import re
-import shutil
 import subprocess
 import sys
 import tarfile
@@ -11,6 +9,8 @@ from collections import Counter
 from launchpadlib.launchpad import Launchpad
 from launchpadlib.uris import LPNET_WEB_ROOT, STAGING_WEB_ROOT, QASTAGING_WEB_ROOT
 
+from qabro.utils import snapdsocket
+
 
 class BugReport:
     """Bug report.
@@ -247,8 +247,21 @@ class AttachmentAssistant:
             print("No $PATH defined. Cannot run sosreport!")
 
     def attach_snaplist(self):
-        output = subprocess.check_output(['snap', 'list'])
-        self.attachments['snap_list.log'] = output
+        print("Retrieving list of installed snaps...")
+        sckt = snapdsocket()
+        snaps = sckt.get_snaps()
+        fmt = "{:<32}{:<16}{:<16}{:<16}{:<16}{:<16}"
+        out = fmt.format("Name", "Version", "Revision",
+                         "Channel", "Devmode", "Confinement") + "\n"
+        for snap in snaps:
+            if snap["devmode"]:
+                devmode = "yes"
+            else:
+                devmode = "no"
+            out += fmt.format(snap["name"], snap["version"], snap["revision"],
+                              snap.get("tracking-channel", "-"), devmode,
+                              snap["confinement"]) + "\n"
+        self.attachments["snap_list.log"] = out.encode()
 
     def attach_last_checkbox_session(self):
         """Archive the most recent Plainbox session available and add it to
@@ -264,10 +277,10 @@ class AttachmentAssistant:
         if os.path.exists(classic_path):
             rootpath = classic_path
         else:
-            out = subprocess.check_output(["snap", "list"]).decode('utf-8')
-            snap_name_list = [e for e in out.split() if 'checkbox' in e]
-            if snap_name_list:
-                snap_name = snap_name_list[0]
+            ss = snapdsocket()
+            snap_list = [e for e in ss.get_snaps() if 'checkbox' in e['name']]
+            if snap_list:
+                snap_name = snap_list[0]["name"]
                 sp = "/home/$USER/snap/{}/current/plainbox/sessions"
                 snap_path = os.path.expandvars(sp.format(snap_name))
                 if os.path.exists(snap_path):
@@ -326,13 +339,16 @@ class AttachmentAssistant:
             standard_info['Image'] = subprocess.check_output(
                 ['tail', '-n', '1', buildstamp]).decode(sys.stdout.encoding).strip()
 
-        if shutil.which("ubuntu-report"):
-            print("Retrieving Manifest information...")
-            report = subprocess.check_output(["ubuntu-report", "show"])
-            reportjson = json.loads(report)
-            manifest = reportjson.get("OEM").get("DCD")
-            if manifest:
-                standard_info["Manifest"] = manifest
+        # This file hosts the OEM Manifest information we need
+        # See: https://forum.snapcraft.io/t/read-access-to-a-file-in-var-lib-on-the-host/11766
+        udc = '/var/lib/snapd/hostfs/var/lib/ubuntu_dist_channel'
+        manifest = ''
+        if os.path.isfile(udc):
+            with open(udc) as f:
+                dcd = f.read()
+            manifest = re.search("^([^\s#]+)$", dcd, re.MULTILINE)[0]
+        if manifest:
+            standard_info["Manifest"] = manifest
 
         p = os.getenv('PATH')
 
@@ -351,11 +367,12 @@ class AttachmentAssistant:
 
         standard_info['CPU'] = AttachmentAssistant.get_cpu_info()
 
-        lspci_output = (subprocess.check_output(['lspci'])
+        lspci_output = (subprocess.check_output(['lspci', '-nn'])
                         .decode(sys.stdout.encoding)
                         .splitlines())
+        # '03' is the PCI class for display controllers
         standard_info['GPU'] = '\n'.join([line for line in lspci_output
-                                          if 'VGA' in line])
+                                          if '[03' in line])
 
         standard_info["kernel-version"] = (subprocess.check_output(["uname", "-r"])
                                            .decode(sys.stdout.encoding)
diff --git a/qabro/ui.py b/qabro/ui.py
index 26f6bba..9303cc9 100644
--- a/qabro/ui.py
+++ b/qabro/ui.py
@@ -56,7 +56,7 @@ class ReportScreen:
         # Adding standard info (CPU, BIOS, GPU, etc.)  to the description
         std_info = AttachmentAssistant.get_standard_info()
         std_info_str = '\n'.join(['{}: {}'.format(elt, std_info[elt]) for elt in std_info])
-        self.default_description += "[Additional information]\n" + std_info_str
+        self.default_description += "[Additional information]\nSKU: \n" + std_info_str
 
         self._title = urwid.LineBox(urwid.Edit(), 'Bug Title')
         self._description = urwid.LineBox(urwid.Edit(edit_text=self.default_description,
diff --git a/qabro/utils.py b/qabro/utils.py
new file mode 100644
index 0000000..af790eb
--- /dev/null
+++ b/qabro/utils.py
@@ -0,0 +1,67 @@
+#!/usr/bin/env python3
+import socket, json, pprint
+
+class snapdsocket:
+    def __init__(self, sock=None):
+        if sock is None:
+            self.sock = socket.socket(socket.AF_UNIX)
+        else:
+            self.sock = sock
+        self.sock.settimeout(0.3)
+
+    def _connect(self):
+        self.sock.connect("/run/snapd.socket")
+
+    def _send(self, msg):
+        if type(msg) != "bytes":
+            msg = msg.encode()
+        self.sock.send(msg)
+
+    def _recv(self):
+        chunks = []
+        while True:
+            try:
+                chunk = self.sock.recv(2048)
+                chunks.append(chunk.decode())
+            except socket.timeout:
+                break
+        return ''.join(chunks)
+
+    def _close(self):
+        self.sock.close()
+
+    def _get_json_response(self, response):
+        begin = response.find('{')
+        end = response.rfind('}') + 1
+        return json.loads(response[begin:end])
+
+    def request(self, msg):
+        self.__init__()
+        self._connect()
+        self._send(msg)
+        raw_resp = self._recv()
+        self._close()
+        json_resp = self._get_json_response(raw_resp)
+        return json_resp
+
+    def get_interfaces(self):
+        req = "GET /v2/interfaces HTTP/1.1\r\nHost: localhost\r\n\r\n"
+        json_resp = self.request(req)
+        return json_resp['result']
+
+    def get_snaps(self):
+        req = "GET /v2/snaps HTTP/1.1\r\nHost: localhost\r\n\r\n"
+        json_resp = self.request(req)
+        return json_resp['result']
+
+    def get_snap_names(self):
+        req = "GET /v2/snaps HTTP/1.1\r\nHost: localhost\r\n\r\n"
+        json_resp = self.request(req)
+        snap_names = []
+        for s in json_resp["result"]:
+            snap_names.append(s["name"])
+        return snap_names
+
+if __name__ == "__main__":
+    sn = snapdsocket()
+    pprint.pprint(sn.get_snaps())
diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml
index 0a2ec6c..2c9982d 100644
--- a/snap/snapcraft.yaml
+++ b/snap/snapcraft.yaml
@@ -4,6 +4,7 @@ adopt-info: qabro
 
 grade: stable # must be 'stable' to release into candidate/stable channels
 confinement: strict # use 'strict' once you have the right plugs and slots
+base: core18
 
 apps:
   qabro:
@@ -112,12 +113,10 @@ parts:
       '*': patches/
     prime: [-*]
 
-# https://forum.snapcraft.io/t/snap-layouts/7207
-passthrough:
-  layout:
-    /etc/sos.conf:
-      bind-file: $SNAP/etc/sos.conf
-    /var/lib/usbutils/usb.ids:
-      bind-file: $SNAP/var/lib/usbutils/usb.ids
-    /usr/share/alsa:
-      bind: $SNAP/usr/share/alsa
+layout:
+  /etc/sos.conf:
+    bind-file: $SNAP/etc/sos.conf
+  /var/lib/usbutils/usb.ids:
+    bind-file: $SNAP/var/lib/usbutils/usb.ids
+  /usr/share/alsa:
+    bind: $SNAP/usr/share/alsa