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

[Pierre Equoy]

To test:

- build a snap out of it:
    snapcraft cleanbuild
- install in devmode:
    snap install qabro_0.7_amd64.snap --devmode
- launch on Launchpad Staging instance:
    APPORT_STAGING=1 qabro
- fill the proper info, and select "Firmware" as issue type (or at least, make sure there is a `hwe-firmware` tag)

→ this should create an issue with fwts logs attached

Tested on 18.04 desktop and UC16.

[Maciej Kisielewski (kissiel)]

I need some explanation why FWTS has to be built afresh when snapping.
Also one nitpick inline.

review: Needs Information

[Pierre Equoy (pieq)]

Thanks for the review, Maciek!

I added an answer to your reply below.

[Sylvain Pineau (sylvain-pineau)]

One possible way to avoid compiling fwts is to fetch the deb packages from their ppa using the deb plugin.

See how I initially included tpm2-tools 1.1 in plano classic:

https://git.launchpad.net/~plano-team/plano/+git/checkbox-plano-classic/tree/snap/snapcraft.yaml?id=95fc6f624ffa4ab2842a2c1f1ea0458e3ac26a59

Downside is that you'll be stuck with one hardcoded version of fwts.

[Pierre Equoy (pieq)]

I took into account Maciek's comment regarding

    _ = subprocess.call(...)

Otherwise, for now FWTS will be compiled when snapping qabro, unfortunately :S
(the reason is because qabro needs to support different archs, and the `source-type: deb` feature only works for single arch)

[Maciej Kisielewski (kissiel)]

LGTM, +1

review: Approve

diff --git a/bin/oembugreport b/bin/oembugreport
deleted file mode 100755
index 26bae6c..0000000
--- a/bin/oembugreport
+++ /dev/null
@@ -1,10 +0,0 @@
-#!/usr/bin/env python
-
-import os, sys
-import oembugreport
-
-if __name__ == '__main__':
-    if os.getenv('SUDO_USER'):
-        oembugreport.main()
-    else:
-        sys.exit("Please run this tool using sudo!")
diff --git a/qabro/__version__.py b/qabro/__version__.py
index 07c4cf5..f480065 100644
--- a/qabro/__version__.py
+++ b/qabro/__version__.py
@@ -1,5 +1,5 @@
 __title__ = 'qabro'
-__version__ = '0.6'
+__version__ = '0.7dev'
 __description__ = 'Report bug information with attachments in Launchpad'
 __author__ = 'Pierre Equoy'
 __author_email__ = '[e-mail]'
diff --git a/qabro/bug_assistant.py b/qabro/bug_assistant.py
index 127a69a..6cb741b 100644
--- a/qabro/bug_assistant.py
+++ b/qabro/bug_assistant.py
@@ -206,10 +206,12 @@ class AttachmentAssistant:
     def run_attachment_methods(self):
         """Runs the different attachment methods to add logs to the
         attachments dictionary."""
+        if self.options.get('include_checkbox_session'):
+            self.attach_last_checkbox_session()
+        if self.options.get('include_fwts_logs'):
+            self.attach_fwts_logs()
         self.attach_snaplist()
         self.attach_sosreport()
-        if 'include_checkbox_session' in self.options and self.options['include_checkbox_session']:
-            self.attach_last_checkbox_session()
 
     def attach_sosreport(self):
         home_dir = os.getenv('HOME')
@@ -281,6 +283,25 @@ class AttachmentAssistant:
         else:
             print('There does not seem to be any Checkbox session here...')
 
+    def attach_fwts_logs(self):
+        p = os.getenv("PATH")
+        lp = os.getenv("LD_LIBRARY_PATH")
+        logfile = os.path.expandvars("$HOME/fwts_results.log")
+        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) as f:
+                content = f.read()
+            self.attachments['fwts_results.log'] = content
+        else:
+            print("$PATH and/or $LD_LIBRARY_PATH missing. Cannot run FWTS!")
+
     @classmethod
     def get_standard_info(cls):
         """Gather standard information that should be present in all bugs."""
diff --git a/qabro/ui.py b/qabro/ui.py
index cdf2ec5..b87ace4 100644
--- a/qabro/ui.py
+++ b/qabro/ui.py
@@ -127,7 +127,8 @@ class ReportScreen:
 
     def report(self):
         tags = self._tags.base_widget.text
-        options = {'include_checkbox_session': 'checkbox' in tags}
+        options = {'include_checkbox_session': 'checkbox' in tags,
+                   'include_fwts_logs': 'hwe-firmware' in tags}
         return BugReport(title=self._title.base_widget.text,
                          description=self._description.base_widget.text,
                          project=self._project.base_widget.text,
diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml
index e75daf8..de2f615 100644
--- a/snap/snapcraft.yaml
+++ b/snap/snapcraft.yaml
@@ -1,5 +1,5 @@
 name: qabro
-version: '0.6'
+version: '0.7dev'
 summary: QA OEM bug reporting tool
 description: |
   Tool to generate a Launchpad bug report and attach useful logs (using
@@ -11,10 +11,17 @@ confinement: strict # use 'strict' once you have the right plugs and slots
 apps:
   qabro:
     command: qabro
+    environment:
+      LD_LIBRARY_PATH: $LD_LIBRARY_PATH:$SNAP/lib/fwts
 
   sosreport:
     command: sosreport
 
+  fwts:
+    command: bin/fwts
+    environment:
+      LD_LIBRARY_PATH: $LD_LIBRARY_PATH:$SNAP/lib/fwts
+
 parts:
   qabro:
     plugin: python
@@ -39,8 +46,27 @@ parts:
       - libc6
       - libdb5.3
 
+  fwts:
+    plugin: autotools
+    source: git://kernel.ubuntu.com/hwe/fwts
+    source-tag: V18.06.02
+    stage-packages:
+      - libfdt1
+    build-packages:
+      - gcc
+      - make
+      - autoconf
+      - automake
+      - libtool
+      - libjson-c-dev
+      - flex
+      - bison
+      - dh-autoreconf
+      - libglib2.0-dev
+      - libfdt-dev
+
   config:
-    source: config/
     plugin: dump
+    source: config/
     organize:
       '*.conf': etc/