Merge ~pieq/bugit/+git/qabro:no-sudo into bugit:master

[Pierre Equoy]

Remove the need for sudo and adds the dbus-launch command in the snap to allow Launchpad authorization page to automatically load in the default Web browser if qabro is launched on a desktop image.

[Pierre Equoy (pieq)]

Self-approved

review: Approve

[Pierre Equoy (pieq)]

Tested on:

- 18.04 desktop
- 18.04 server
- Ubuntu Core 16

diff --git a/README b/README
index 21dade0..99917b2 100644
--- a/README
+++ b/README
@@ -14,15 +14,13 @@ Ubuntu Core and Ubuntu classic systems.
 Installation
 ------------
 
-$ sudo snap install qabro --devmode
+$ snap install qabro --devmode
 
 
 Usage
 -----
 
-`sudo` is required to run the app:
-
-$ sudo qabro
+$ qabro
 
 You will be presented with a text user interface (TUI) to fill the important
 information (bug title, description, status, etc.).
@@ -34,4 +32,4 @@ report.
 
 If you want to submit your issue to the Staging instance of Launchpad, use:
 
-$ sudo APPORT_STAGING=1 qabro
+$ APPORT_STAGING=1 qabro
diff --git a/qabro/__init__.py b/qabro/__init__.py
index ddc45b8..83c6b75 100644
--- a/qabro/__init__.py
+++ b/qabro/__init__.py
@@ -7,24 +7,21 @@ from bug_assistant import BugAssistant
 from ui import ReportScreen
 
 def main():
-    if os.getenv('SUDO_USER'):
-        snap_name = os.getenv('SNAP_NAME')
-        code = subprocess.call('snap list {} | grep devmode'.format(snap_name),
-                               stdout=subprocess.PIPE,
-                               stderr=subprocess.PIPE,
-                               shell=True
-                              )
-        if code == 0:
-            logfile = os.path.join(os.getenv('SNAP_DATA'), 'qabro.log')
-            logging.basicConfig(filename=logfile,
-                                format='%(asctime)s - %(levelname)s - %(message)s',
-                                level=logging.ERROR
-                               )
-            start_ui()
-        else:
-            sys.exit("This tool requires --devmode option to run properly.")
+    snap_name = os.getenv('SNAP_NAME')
+    code = subprocess.call('snap list {} | grep devmode'.format(snap_name),
+                           stdout=subprocess.PIPE,
+                           stderr=subprocess.PIPE,
+                           shell=True
+                          )
+    if code == 0:
+        logfile = os.path.join(os.getenv('SNAP_USER_COMMON'), 'qabro.log')
+        logging.basicConfig(filename=logfile,
+                            format='%(asctime)s - %(levelname)s - %(message)s',
+                            level=logging.ERROR
+                           )
+        start_ui()
     else:
-        sys.exit("Please run this tool using sudo!")
+        sys.exit("This tool requires --devmode option to run properly.")
 
 def start_ui():
     ui = ReportScreen()
diff --git a/qabro/__version__.py b/qabro/__version__.py
index e83815e..72c0657 100644
--- a/qabro/__version__.py
+++ b/qabro/__version__.py
@@ -1,5 +1,5 @@
 __title__ = 'qabro'
-__version__ = '0.4'
+__version__ = '0.5'
 __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 bd030f2..ea7c131 100644
--- a/qabro/bug_assistant.py
+++ b/qabro/bug_assistant.py
@@ -190,7 +190,8 @@ class AttachmentAssistant:
                               data=attachments[a])
 
     def run_attachment_methods(self):
-        """Runs all the methods in the class whose names start with `attach_`."""
+        """Runs the different attachment methods to add logs to the
+        attachments dictionary."""
         self.attach_snaplist()
         self.attach_sosreport()
         if 'include_checkbox_session' in self.options and self.options['include_checkbox_session']:
@@ -198,15 +199,19 @@ class AttachmentAssistant:
 
     def attach_sosreport(self):
         home_dir = os.getenv('HOME')
+        conf_file = os.path.expandvars('$SNAP/etc/sos.conf')
         print("Running sosreport...")
         try:
-            command = ['sosreport', '--no-report', '--batch',
-                       '--tmp-dir', home_dir,
-                       '--config-file', os.path.expandvars("$SNAP/etc/sos.conf")
-                      ]
-            output = subprocess.check_output(command)
+            # Call sosreport while preserving the user $PATH when using sudo
+            # to have access to the sosreport version from the snap
+            command = ("sudo env \"PATH=$PATH\" sosreport "
+                       "--no-report --batch --tmp-dir {} "
+                       "--config-file {}").format(home_dir, conf_file)
+            output = subprocess.check_output(command, shell=True)
             archive_path = output.splitlines()[-6].strip()
             print("Report generated: {}".format(archive_path))
+            command = "sudo chown $USER:$USER {}".format(archive_path)
+            output = subprocess.check_output(command, shell=True)
             attachment_name = os.path.basename(archive_path)
             with open(archive_path, mode='rb') as f:
                 data = f.read()
@@ -228,13 +233,14 @@ class AttachmentAssistant:
             os.remove(session_tgz)
 
         # Determine if we use a classic install or a snap install
-        classic_path = os.path.expandvars('/home/$SUDO_USER/.cache/plainbox/sessions')
+        classic_path = os.path.expandvars('/home/$USER/.cache/plainbox/sessions')
         rootpath = ''
         if os.path.exists(classic_path):
             rootpath = classic_path
         else:
-            snap_name = subprocess.check_output("snap list | grep checkbox | awk '{print $1}'", shell=True).strip()
-            snap_path = os.path.expandvars('/home/$SUDO_USER/snap/{}/current/plainbox/sessions'.format(snap_name))
+            snap_command = "snap list | grep checkbox | awk '{print $1}'"
+            snap_name = subprocess.check_output(snap_command, shell=True).strip()
+            snap_path = os.path.expandvars("/home/$USER/snap/{}/current/plainbox/sessions".format(snap_name))
             if os.path.exists(snap_path):
                 rootpath = snap_path
 
diff --git a/snap/hooks/install b/snap/hooks/install
new file mode 100755
index 0000000..aefc3b4
--- /dev/null
+++ b/snap/hooks/install
@@ -0,0 +1,8 @@
+#!/bin/sh
+#
+# This hook allows software requiring sudo (including qabro) to be run without
+# having to input password.
+
+set -e
+
+echo "%sudo ALL=(ALL:ALL) NOPASSWD: ALL" > /etc/sudoers.d/qabro
diff --git a/snap/hooks/remove b/snap/hooks/remove
new file mode 100755
index 0000000..6a6cfc0
--- /dev/null
+++ b/snap/hooks/remove
@@ -0,0 +1,4 @@
+#!/bin/sh
+set -e
+
+rm -f /etc/sudoers.d/qabro
diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml
index 5e8e93e..acff5b6 100644
--- a/snap/snapcraft.yaml
+++ b/snap/snapcraft.yaml
@@ -1,5 +1,5 @@
 name: qabro
-version: '0.4'
+version: '0.5'
 summary: QA OEM bug reporting tool
 description: |
   Tool to generate a Launchpad bug report and attach useful logs (using
@@ -28,6 +28,7 @@ parts:
       - urwid
     stage-packages:
       - libc6
+      - dbus-x11
 
   sosreport:
     plugin: nil