Merge lp:~raharper/curtin/trunk.add-gpg-retry into lp:~curtin-dev/curtin/trunk

[Ryan Harper]

gpg: retry when recv'ing gpg keys fail

Retry gpg recv operations in case error is transient.
Add unittests to validate curtin.gpg including retry behavior

[Server Team CI bot (server-team-bot)]

PASSED: Continuous integration, rev:445
https://jenkins.ubuntu.com/server/job/curtin-ci/309/
Executed test runs:
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=metal-arm64/309
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=metal-ppc64el/309
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=metal-s390x/309
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=vm-amd64/309
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=vm-i386/309

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/curtin-ci/309/rebuild

review: Approve (continuous-integration)

[lp:~raharper/curtin/trunk.add-gpg-retry]

446. By Ryan Harper on 2017-02-02

Don't hardcode retries value in gpg module.

[Server Team CI bot (server-team-bot)]

PASSED: Continuous integration, rev:446
https://jenkins.ubuntu.com/server/job/curtin-ci/310/
Executed test runs:
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=metal-arm64/310
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=metal-ppc64el/310
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=metal-s390x/310
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=vm-amd64/310
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=vm-i386/310

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/curtin-ci/310/rebuild

review: Approve (continuous-integration)

[Scott Moser (smoser)]

Ryan, this looks good.
Some comments in line, possibly me just misunderstanding.

[Ryan Harper (raharper)]

On Thu, Feb 2, 2017 at 8:27 PM, Scott Moser <email address hidden> wrote:

> Ryan, this looks good.
> Some comments in line, possibly me just misunderstanding.
>
>
> Diff comments:
>
> >
> > === added file 'tests/unittests/test_gpg.py'
> > --- tests/unittests/test_gpg.py 1970-01-01 00:00:00 +0000
> > +++ tests/unittests/test_gpg.py 2017-02-02 22:52:32 +0000
> > @@ -0,0 +1,174 @@
> > +from unittest import TestCase
> > +from mock import call, patch
> > +import textwrap
> > +
> > +from curtin import gpg
> > +from curtin import util
> > +
> > +
> > +class TestCurtinGpg(TestCase):
> > +
> > + @patch('curtin.util.subp')
> > + def test_export_armour(self, mock_subp):
> > + key = 'DEADBEEF'
> > + expected_armour = textwrap.dedent("""
> > + -----BEGIN PGP PUBLIC KEY BLOCK-----
> > + Version: GnuPG v1
> > +
> > + deadbeef
> > + -----END PGP PUBLIC KEY BLOCK----
> > + """)
> > + mock_subp.side_effect = iter([(expected_armour, "")])
>
> what is the second side affect for ? the ""?
> I dont think subp should be called twice for this, is it ?
>

subp usually returns an (out, err) tuple; It's a habit in case we need to
do something with the error in the calling code.

>
> > +
> > + armour = gpg.export_armour(key)
> > + mock_subp.assert_called_with(["gpg", "--export", "--armour",
> key],
> > + capture=True)
> > + self.assertEqual(expected_armour, armour)
> > +
> > + @patch('curtin.util.subp')
> > + def test_export_armour_missingkey(self, mock_subp):
> > + key = 'DEADBEEF'
> > + mock_subp.side_effect = iter([util.ProcessExecutionError()])
> > +
> > + expected_armour = gpg.export_armour(key)
> > + mock_subp.assert_called_with(["gpg", "--export", "--armour",
> key],
> > + capture=True)
> > + self.assertEqual(None, expected_armour)
> > +
> > + @patch('curtin.util.subp')
> > + def test_recv_key(self, mock_subp):
> > + key = 'DEADBEEF'
> > + keyserver = 'keyserver.ubuntu.com'
> > + mock_subp.side_effect = iter([("", "")])
> > +
> > + gpg.recv_key(key, keyserver, )
>
> calling here is wierd with the following ,
>
> And again, why the 2 side_affects ? shouldn't subp just be called once?
>

It's a single side-effect with a tuple return.

the iter() is for python mock on trusty which doesn't convert the list of
side-effects into an
iterable directly.

>
> > + mock_subp.assert_called_with(["gpg", "--keyserver", keyserver,
> > + "--recv", key], capture=True,
> > + retries=None)
> > +
> > + @patch('time.sleep')
> > + @patch('curtin.util._subp')
> > + def test_recv_key_retry_raises(self, mock_under_subp, mock_sleep):
> > + key = 'DEADBEEF'
> > + keyserver = 'keyserver.ubuntu.com'
> > + retries = (1, 2, 5, 10)
> > + mock_under_subp.side_effect = iter([
> > + util.ProcessExecutionError(), # 1
> > + util.ProcessExecutionError(), # 2
> > + util.ProcessExecutionError(), # 3
> > + ...

[Scott Moser (smoser)]

> > what is the second side affect for ? the ""?
> > I dont think subp should be called twice for this, is it ?
> >
>
> subp usually returns an (out, err) tuple; It's a habit in case we need to
> do something with the error in the calling code.

Yeah, i figured i was missing something. You are correct. Sorry for the noise.

> > > + gpg.recv_key(key, keyserver, )
> >
> > calling here is wierd with the following ,
> >
> > And again, why the 2 side_affects ? shouldn't subp just be called once?
> >
>
> It's a single side-effect with a tuple return.
>
> the iter() is for python mock on trusty which doesn't convert the list of
> side-effects into an
> iterable directly.

the subp comment was noise as mentioned above.
But why:
 gpg.recv_key(key, keyserver, )
and not
 gpg.recv_key(key, keyserver)

Just looks wierd.

> > you dont' use key in this test.
> >
>
> ? it's passed to gpg.recv_key) and checked in the expected_calls.

Not my best review. sorry :) Again, you are correct.

[Scott Moser (smoser)]

go ahead and cleanup the repetitive arrays with the * operator, and then i'm good with this.
Thanks.

review: Approve

[lp:~raharper/curtin/trunk.add-gpg-retry]

447. By Ryan Harper on 2017-02-03

Unittest cleanup after review

- Use list expansion for repeated calls
- Remove extra comma when calling gpg.recv_key

[Server Team CI bot (server-team-bot)]

PASSED: Continuous integration, rev:447
https://jenkins.ubuntu.com/server/job/curtin-ci/311/
Executed test runs:
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=metal-arm64/311
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=metal-ppc64el/311
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=metal-s390x/311
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=vm-amd64/311
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=vm-i386/311

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/curtin-ci/311/rebuild

review: Approve (continuous-integration)

=== modified file 'curtin/commands/apt_config.py'
--- curtin/commands/apt_config.py	2016-12-01 07:12:04 +0000
+++ curtin/commands/apt_config.py	2017-02-03 16:06:45 +0000
@@ -362,7 +362,8 @@
         if 'keyserver' in ent:
             keyserver = ent['keyserver']
 
-        ent['key'] = gpg.getkeybyid(ent['keyid'], keyserver)
+        ent['key'] = gpg.getkeybyid(ent['keyid'], keyserver,
+                                    retries=(1, 2, 5, 10))
 
     if 'key' in ent:
         add_apt_key_raw(ent['key'], target)
 
=== modified file 'curtin/gpg.py'
--- curtin/gpg.py	2016-06-23 15:04:21 +0000
+++ curtin/gpg.py	2017-02-03 16:06:45 +0000
@@ -36,12 +36,12 @@
     return armour
 
 
-def recv_key(key, keyserver):
+def recv_key(key, keyserver, retries=None):
     """Receive gpg key from the specified keyserver"""
     LOG.debug('Receive gpg key "%s"', key)
     try:
         util.subp(["gpg", "--keyserver", keyserver, "--recv", key],
-                  capture=True)
+                  capture=True, retries=retries)
     except util.ProcessExecutionError as error:
         raise ValueError(('Failed to import key "%s" '
                           'from server "%s" - error %s') %
@@ -57,12 +57,12 @@
         LOG.warn('Failed delete key "%s": %s', key, error)
 
 
-def getkeybyid(keyid, keyserver='keyserver.ubuntu.com'):
+def getkeybyid(keyid, keyserver='keyserver.ubuntu.com', retries=None):
     """get gpg keyid from keyserver"""
     armour = export_armour(keyid)
     if not armour:
         try:
-            recv_key(keyid, keyserver=keyserver)
+            recv_key(keyid, keyserver=keyserver, retries=retries)
             armour = export_armour(keyid)
         except ValueError:
             LOG.exception('Failed to obtain gpg key %s', keyid)
 
=== modified file 'curtin/util.py'
--- curtin/util.py	2017-02-01 03:18:21 +0000
+++ curtin/util.py	2017-02-03 16:06:45 +0000
@@ -155,6 +155,9 @@
     retries = []
     if "retries" in kwargs:
         retries = kwargs.pop("retries")
+        if not retries:
+            # allow retries=None
+            retries = []
 
     if args:
         cmd = args[0]
 
=== modified file 'tests/unittests/test_apt_source.py'
--- tests/unittests/test_apt_source.py	2016-11-14 22:55:12 +0000
+++ tests/unittests/test_apt_source.py	2017-02-03 16:06:45 +0000
@@ -364,7 +364,8 @@
         keycfg = cfg[self.aptlistfile]
         mockgetkey.assert_called_with(keycfg['keyid'],
                                       keycfg.get('keyserver',
-                                                 'keyserver.ubuntu.com'))
+                                                 'keyserver.ubuntu.com'),
+                                      retries=(1, 2, 5, 10))
         mockkey.assert_called_with(expectedkey, TARGET)
 
         # filename should be ignored on key only
@@ -407,7 +408,8 @@
                 self._add_apt_sources(cfg, TARGET, template_params=params,
                                       aa_repo_match=self.matcher)
 
-        mockgetkey.assert_called_with('03683F77', 'test.random.com')
+        mockgetkey.assert_called_with('03683F77', 'test.random.com',
+                                      retries=(1, 2, 5, 10))
         mockadd.assert_called_with('fakekey', TARGET)
 
         # filename should be ignored on key only
 
=== added file 'tests/unittests/test_gpg.py'
--- tests/unittests/test_gpg.py	1970-01-01 00:00:00 +0000
+++ tests/unittests/test_gpg.py	2017-02-03 16:06:45 +0000
@@ -0,0 +1,159 @@
+from unittest import TestCase
+from mock import call, patch
+import textwrap
+
+from curtin import gpg
+from curtin import util
+
+
+class TestCurtinGpg(TestCase):
+
+    @patch('curtin.util.subp')
+    def test_export_armour(self, mock_subp):
+        key = 'DEADBEEF'
+        expected_armour = textwrap.dedent("""
+        -----BEGIN PGP PUBLIC KEY BLOCK-----
+        Version: GnuPG v1
+
+        deadbeef
+        -----END PGP PUBLIC KEY BLOCK----
+        """)
+        mock_subp.side_effect = iter([(expected_armour, "")])
+
+        armour = gpg.export_armour(key)
+        mock_subp.assert_called_with(["gpg", "--export", "--armour", key],
+                                     capture=True)
+        self.assertEqual(expected_armour, armour)
+
+    @patch('curtin.util.subp')
+    def test_export_armour_missingkey(self, mock_subp):
+        key = 'DEADBEEF'
+        mock_subp.side_effect = iter([util.ProcessExecutionError()])
+
+        expected_armour = gpg.export_armour(key)
+        mock_subp.assert_called_with(["gpg", "--export", "--armour", key],
+                                     capture=True)
+        self.assertEqual(None, expected_armour)
+
+    @patch('curtin.util.subp')
+    def test_recv_key(self, mock_subp):
+        key = 'DEADBEEF'
+        keyserver = 'keyserver.ubuntu.com'
+        mock_subp.side_effect = iter([("", "")])
+
+        gpg.recv_key(key, keyserver)
+        mock_subp.assert_called_with(["gpg", "--keyserver", keyserver,
+                                      "--recv", key], capture=True,
+                                     retries=None)
+
+    @patch('time.sleep')
+    @patch('curtin.util._subp')
+    def test_recv_key_retry_raises(self, mock_under_subp, mock_sleep):
+        key = 'DEADBEEF'
+        keyserver = 'keyserver.ubuntu.com'
+        retries = (1, 2, 5, 10)
+        nr_calls = 5
+        mock_under_subp.side_effect = iter([
+            util.ProcessExecutionError()] * nr_calls)
+
+        with self.assertRaises(ValueError):
+            gpg.recv_key(key, keyserver, retries=retries)
+
+        print("_subp calls: %s" % mock_under_subp.call_args_list)
+        print("sleep calls: %s" % mock_sleep.call_args_list)
+        expected_calls = nr_calls * [
+            call(["gpg", "--keyserver", keyserver, "--recv", key],
+                 capture=True)]
+        mock_under_subp.assert_has_calls(expected_calls)
+
+        expected_calls = [call(1), call(2), call(5), call(10)]
+        mock_sleep.assert_has_calls(expected_calls)
+
+    @patch('time.sleep')
+    @patch('curtin.util._subp')
+    def test_recv_key_retry_works(self, mock_under_subp, mock_sleep):
+        key = 'DEADBEEF'
+        keyserver = 'keyserver.ubuntu.com'
+        nr_calls = 2
+        mock_under_subp.side_effect = iter([
+            util.ProcessExecutionError(),  # 1
+            ("", ""),
+        ])
+
+        gpg.recv_key(key, keyserver, retries=[1])
+
+        print("_subp calls: %s" % mock_under_subp.call_args_list)
+        print("sleep calls: %s" % mock_sleep.call_args_list)
+        expected_calls = nr_calls * [
+            call(["gpg", "--keyserver", keyserver, "--recv", key],
+                 capture=True)]
+        mock_under_subp.assert_has_calls(expected_calls)
+        mock_sleep.assert_has_calls([call(1)])
+
+    @patch('curtin.util.subp')
+    def test_delete_key(self, mock_subp):
+        key = 'DEADBEEF'
+        mock_subp.side_effect = iter([("", "")])
+
+        gpg.delete_key(key)
+        mock_subp.assert_called_with(["gpg", "--batch", "--yes",
+                                      "--delete-keys", key], capture=True)
+
+    @patch('curtin.gpg.delete_key')
+    @patch('curtin.gpg.recv_key')
+    @patch('curtin.gpg.export_armour')
+    def test_getkeybyid(self, mock_export, mock_recv, mock_del):
+        key = 'DEADBEEF'
+        keyserver = 'my.keyserver.xyz.co.uk'
+
+        mock_export.side_effect = iter([
+            None,
+            "-----BEGIN PGP PUBLIC KEY BLOCK-----",
+        ])
+
+        gpg.getkeybyid(key, keyserver=keyserver)
+
+        mock_export.assert_has_calls([call(key), call(key)])
+        mock_recv.assert_has_calls([
+            call(key, keyserver=keyserver, retries=None)])
+        mock_del.assert_has_calls([call(key)])
+
+    @patch('curtin.gpg.delete_key')
+    @patch('curtin.gpg.recv_key')
+    @patch('curtin.gpg.export_armour')
+    def test_getkeybyid_exists(self, mock_export, mock_recv, mock_del):
+        key = 'DEADBEEF'
+
+        mock_export.side_effect = iter([
+            "-----BEGIN PGP PUBLIC KEY BLOCK-----",
+        ])
+
+        gpg.getkeybyid(key)
+
+        mock_export.assert_has_calls([call(key)])
+        self.assertEqual([], mock_recv.call_args_list)
+        self.assertEqual([], mock_del.call_args_list)
+
+    @patch('curtin.gpg.delete_key')
+    @patch('curtin.gpg.recv_key')
+    @patch('curtin.gpg.export_armour')
+    def test_getkeybyid_raises(self, mock_export, mock_recv, mock_del):
+        key = 'DEADBEEF'
+        keyserver = 'my.keyserver.xyz.co.uk'
+
+        mock_export.side_effect = iter([
+            None,
+            "-----BEGIN PGP PUBLIC KEY BLOCK-----",
+        ])
+        mock_recv.side_effect = iter([
+            ValueError("Failed to import key %s from server %s" %
+                       (key, keyserver)),
+        ])
+
+        with self.assertRaises(ValueError):
+            gpg.getkeybyid(key, keyserver=keyserver)
+
+        mock_export.assert_has_calls([call(key)])
+        mock_recv.assert_has_calls([
+            call(key, keyserver=keyserver, retries=None)])
+        mock_del.assert_has_calls([call(key)])