Merge lp:~smoser/software-properties/trunk.lp1532855 into lp:software-properties

[Scott Moser]

This is not the world's cleanest change, and I'm not sure how error messages should be printed, but it does catch the error correctly.

[lp:~smoser/software-properties/trunk.lp1532855]

988. By Dimitri John Ledkov on 2017-03-01

When failing to retrieve a GPG key, raise an exception such that
e.g. add-apt-repository can fail when it did not manage to retrieve a
GPG key for the shortcut repository. LP: #1532855

[Dimitri John Ledkov (xnox)]

review: Approve (with prejudice)

[Iain Lane (laney)]

Please see https://code.launchpad.net/~laney/software-properties/test-fixes/+merge/318784 - I think this change broke the testsuite.

=== modified file 'softwareproperties/SoftwareProperties.py'
--- softwareproperties/SoftwareProperties.py	2016-03-16 09:17:42 +0000
+++ softwareproperties/SoftwareProperties.py	2017-02-23 16:44:58 +0000
@@ -666,7 +666,8 @@
 
   def check_and_add_key_for_whitelisted_channels(self, srcline):
     # This is maintained for any legacy callers
-    return self.check_and_add_key_for_whitelisted_shortcut(shortcut_handler(srcline))
+    worker, _queue = self.check_and_add_key_for_whitelisted_shortcut(shortcut_handler(srcline))
+    return worker
 
   def check_and_add_key_for_whitelisted_shortcut(self, shortcut):
     """
@@ -683,13 +684,31 @@
 
     cdata = (shortcut.add_key, {'keyserver': (self.options and
                                               self.options.keyserver)})
+    try:
+        import queue
+    except ImportError:
+        import Queue as queue
+
+    myqueue = queue.Queue()
+
     def addkey_func():
         func, kwargs = cdata
-        func(**kwargs)
+        ret = None
+        msg = None
+        try:
+            ret = func(**kwargs)
+            if ret:
+                msg = "Added key."
+            else:
+                msg = "Failed to add key."
+        except Exception as e:
+            ret = False
+            msg = str(e)
+        myqueue.put([ret, msg])
 
     worker = threading.Thread(target=addkey_func)
     worker.start()
-    return worker
+    return (worker, myqueue)
 
   def update_interface(self):
     " abstract interface to keep the UI alive "
@@ -734,7 +753,7 @@
     new_debsrc_entry = SourceEntry(debsrc_line, file)
     if new_deb_entry.invalid or new_debsrc_entry.invalid:
       return False
-    worker = self.check_and_add_key_for_whitelisted_shortcut(shortcut)
+    worker, rqueue = self.check_and_add_key_for_whitelisted_shortcut(shortcut)
     self.sourceslist.add(new_deb_entry.type,
                          new_deb_entry.uri,
                          new_deb_entry.dist,
@@ -753,6 +772,15 @@
     if worker:
         # wait for GPG key to be downloaded
         worker.join(30)
+        if worker.isAlive():
+            # thread timed out.
+            print("Error: retrieving gpg key timed out.")
+            return False
+        result, msg = rqueue.get()
+        if not result:
+            print(msg)
+            return result
+
     if self.options and self.options.update:
         import apt
         cache = apt.Cache()