Merge ~pieq/bugit/+git/qabro:fix-1816437-fwts-logs into bugit:master

[Pierre Equoy]

Handles LP issues #1807359 and #1816437. In a nutshell:

- don't run FWTS from qabro anymore
- only rely on FWTS logs generated by Checkbox (from the latest active session)
- remove FWTS binaries from qabro snap

See commit messages for more explanation.

Tested as follow:

0. In a 18.04.3 LXC container, install Checkbox from PPA, as well as checkbox-snappy from Snap store.
1. Build qabro snap from this branch (run `snapcraft` from within the git repo), copy the generated snap to the container and install it:
    (inside container) $ sudo snap install qabro_0.11dev_amd64.snap --devmode
2. Run checkbox-cli (Checkbox from PPA isntall), select 18.04 cert tests, and run tests from the Firmware category. This will create a Checkbox session in ~/.cache/plainbox/sessions/ that contains "fwts*.log" files.
3. Run qabro (while pointing at Staging Launchpad to avoid spamming the real Launchpad):
    $ APPORT_LAUNCHPAD_INSTANCE=staging qabro
4. Enter title, select "qabro" for project, then "Firmware" for category, and press Alt+Enter to submit the bug.
5. Check that qabro output contains the following:
    Uploading attachment fwts_desktop_diagnosis_results.log...
    Uploading attachment fwts_uefirtvariable.log...
6. Check that the generated LP issue contains the two above logs as attachments
7. Repeat steps 2~6 using checkbox-snappy.checkbox-cli instead of checkbox-cli to make sure things work fine with snap-based Checkbox sessions
8. Run checkbox-cli again, but this time only run tests that do not contain FWTS jobs (you can for instance run the 18.04 cert test plan and deselect everything before starting the test).
9. Repeat step 3~4, and check that qabro output contains the following:
    No FWTS logs found in Checkbox session!
This is expected since the last active Checkbox session found has not run FWTS-related jobs.

[Maciej Kisielewski (kissiel)]

Some improvement suggestions below.
Landable as is. +1

review: Approve

[Pierre Equoy (pieq)]

Thanks for the feedback Maciek!

I'll resubmit this, rebased. I added a few inline answers to your comments.

[Pierre Equoy (pieq)]

Oops, I realized $HOME and /home/$USER were here for a reason (see comment below).

[Pierre Equoy (pieq)]

Resubmitted with minor changes (PEP257, ...).

review: Needs Resubmitting

[Maciej Kisielewski (kissiel)]

+1

review: Approve

diff --git a/qabro/bug_assistant.py b/qabro/bug_assistant.py
index 12f6df4..d8248d5 100644
--- a/qabro/bug_assistant.py
+++ b/qabro/bug_assistant.py
@@ -1,4 +1,5 @@
 import getpass
+from glob import glob
 import os
 import re
 import subprocess
@@ -263,59 +264,69 @@ class AttachmentAssistant:
                               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
-        the attachments.
-        """
-        session_tgz = os.path.expandvars('$HOME/checkbox-session.tgz')
-        if os.path.exists(session_tgz):
-            os.remove(session_tgz)
-
+    def _get_last_checkbox_session_path(self):
+        """Return path of the most recent Checkbox session directory."""
+        rootpath = ''
+        latest_session_dir = ''
         # Determine if we use a classic install or a snap install
         classic_path = os.path.expandvars('/home/$USER/.cache/plainbox/sessions')
-        rootpath = ''
         if os.path.exists(classic_path):
             rootpath = classic_path
         else:
             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):
-                    rootpath = snap_path
-
-        # Get the most recent Checkbox session and add it to the attachments
+            snap_list = [e['title'] for e in ss.get_snaps() if 'checkbox-' in e['name']]
+            for snap_name in snap_list:
+                sp = ["/home/$USER/snap/{}/current/.cache/plainbox/sessions",
+                      "/root/snap/{}/current/.cache/plainbox/sessions"]
+                for p in sp:
+                    snap_path = os.path.expandvars(p.format(snap_name))
+                    if os.path.exists(snap_path):
+                        rootpath = snap_path
+        # Get path of the most recent Checkbox session
         if rootpath:
             sessions_dirs = [os.path.join(rootpath, f) for f in os.listdir(rootpath)
                              if os.path.isdir(os.path.join(rootpath, f))]
             if sessions_dirs:
                 latest_session_dir = max(sessions_dirs, key=lambda x: os.stat(x).st_mtime)
-                with tarfile.open(session_tgz, 'w:gz') as tar:
-                    tar.add(latest_session_dir)
-                with open(session_tgz, 'rb') as f:
-                    data = f.read()
-                self.attachments['checkbox-session.tgz'] = data
         else:
             print('There does not seem to be any Checkbox session here...')
+        return latest_session_dir
+
+    def attach_last_checkbox_session(self):
+        """Archive and attach the most recent Checkbox session available."""
+        latest_session_dir = self._get_last_checkbox_session_path()
+        if latest_session_dir:
+            session_tgz = os.path.expandvars('$HOME/checkbox-session.tgz')
+            if os.path.exists(session_tgz):
+                os.remove(session_tgz)
+            with tarfile.open(session_tgz, 'w:gz') as tar:
+                tar.add(latest_session_dir)
+            with open(session_tgz, 'rb') as f:
+                data = f.read()
+            self.attachments['checkbox-session.tgz'] = data
 
     def attach_fwts_logs(self):
+        """Check for FWTS-related log files in the most recent Checkbox session
+        and attach them.
+        """
         p = os.getenv("PATH")
         lp = os.getenv("LD_LIBRARY_PATH")
-        logfile = os.path.expandvars("$HOME/fwts_results.log")
+        latest_session_dir = self._get_last_checkbox_session_path()
         if p and lp:
-            print("Running FWTS...")
-            command = ["sudo", "env", "PATH={}".format(p),
-                       "LD_LIBRARY_PATH={}".format(lp), "fwts", "-q", "-r",
-                       logfile, "version", "cpufreq", "maxfreq", "msr", "mtrr",
-                       "nx", "virt", "aspm", "dmicheck", "apicedge", "klog",
-                       "oops", "esrt", "uefibootpath", "uefirtvariable",
-                       "uefirttime", "uefirtmisc", "--acpitests", "--log-level=high"]
-            subprocess.call(command)
-            with open(logfile, 'rb') as f:
-                content = f.read()
-            self.attachments['fwts_results.log'] = content
+            if latest_session_dir:
+                logpath = os.path.join(latest_session_dir, "CHECKBOX_DATA",
+                                       "fwts*.log")
+                logfiles = glob(logpath)
+                if logfiles:
+                    for log in logfiles:
+                        with open(log, 'rb') as f:
+                            content = f.read()
+                        self.attachments[os.path.basename(log)] = content
+                else:
+                    print("No FWTS logs found in Checkbox session!")
+            else:
+                print(("Cannot find Checkbox session where FWTS logs could be "
+                       "located!"))
         else:
             print("$PATH and/or $LD_LIBRARY_PATH missing. Cannot run FWTS!")
 
diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml
index 2c9982d..41a00ee 100644
--- a/snap/snapcraft.yaml
+++ b/snap/snapcraft.yaml
@@ -17,9 +17,6 @@ apps:
   sosreport:
     command: sosreport --no-report --batch --tmp-dir $SNAP_USER_COMMON -z gzip
 
-  fwts:
-    command: bin/fwts
-
   lspci:
     command: lspci
 
@@ -57,28 +54,6 @@ parts:
       # variable used by sosreport to call other commands.
       patch $SNAPCRAFT_PART_INSTALL/usr/share/sosreport/sos/policies/ubuntu.py $SNAPCRAFT_STAGE/patches/sosreport-env-path-snap.patch
 
-  fwts:
-    plugin: autotools
-    source: git://kernel.ubuntu.com/hwe/fwts
-    source-tag: V19.01.00
-    stage-packages:
-        - libfdt1
-        - libbsd0
-        - libpci3
-    build-packages:
-        - gcc
-        - make
-        - autoconf
-        - automake
-        - libtool
-        - libjson-c-dev
-        - flex
-        - bison
-        - dh-autoreconf
-        - libglib2.0-dev
-        - libfdt-dev
-        - libbsd-dev
-
   lspci:
     plugin: nil
     stage-packages: