Merge lp:~gandelman-a/charm-helpers/ensure_ceph_keyring into lp:charm-helpers

[Adam Gandelman]

Adds contrib.storage.linux.ceph:ensure_ceph_keyring().

[James Page (james-page)]

review: Approve

=== modified file 'charmhelpers/contrib/storage/linux/ceph.py'
--- charmhelpers/contrib/storage/linux/ceph.py	2013-08-23 14:07:52 +0000
+++ charmhelpers/contrib/storage/linux/ceph.py	2013-09-23 18:53:21 +0000
@@ -334,3 +334,25 @@
             log('ceph: Starting service {} after migrating data.'
                 .format(svc))
             service_start(svc)
+
+
+def ensure_ceph_keyring(service, user=None, group=None):
+    '''
+    Ensures a ceph keyring is created for a named service
+    and optionally ensures user and group ownership.
+
+    Returns False if no ceph key is available in relation state.
+    '''
+    key = None
+    for rid in relation_ids('ceph'):
+        for unit in related_units(rid):
+            key = relation_get('key', rid=rid, unit=unit)
+            if key:
+                break
+    if not key:
+        return False
+    create_keyring(service=service, key=key)
+    keyring = _keyring_path(service)
+    if user and group:
+        check_call(['chown', '%s.%s' % (user, group), keyring])
+    return True

=== modified file 'tests/contrib/storage/test_linux_ceph.py'
--- tests/contrib/storage/test_linux_ceph.py	2013-09-23 10:50:53 +0000
+++ tests/contrib/storage/test_linux_ceph.py	2013-09-23 18:53:21 +0000
@@ -408,8 +408,8 @@
         self.assertEquals(device, e.filename)
         self.assertEquals(os.errno.ENOENT, e.errno)
         self.assertEquals(os.strerror(os.errno.ENOENT), e.strerror)
-        self.log.assert_called_with('ceph: gave up waiting on block device %s' % device,
-                                    level='ERROR')
+        self.log.assert_called_with(
+            'ceph: gave up waiting on block device %s' % device, level='ERROR')
 
     @nose.plugins.attrib.attr('slow')
     def test_make_filesystem_timeout(self):
@@ -425,8 +425,8 @@
         after = time.time()
         duration = after - before
         self.assertTrue(timeout - duration < 0.1)
-        self.log.assert_called_with('ceph: gave up waiting on block device %s' % device,
-                                    level='ERROR')
+        self.log.assert_called_with(
+            'ceph: gave up waiting on block device %s' % device, level='ERROR')
 
     @nose.plugins.attrib.attr('slow')
     def test_device_is_formatted_if_it_appears(self):
@@ -460,3 +460,43 @@
             'ceph: Formatting block device %s as '
             'filesystem %s.' % (device, fstype), level='INFO'
         )
+
+    @patch.object(ceph_utils, 'relation_ids')
+    @patch.object(ceph_utils, 'related_units')
+    @patch.object(ceph_utils, 'relation_get')
+    def test_ensure_ceph_keyring_no_relation_no_data(self, rget, runits, rids):
+        rids.return_value = []
+        self.assertEquals(False, ceph_utils.ensure_ceph_keyring(service='foo'))
+        rids.return_value = ['ceph:0']
+        runits.return_value = ['ceph/0']
+        rget.return_value = ''
+        self.assertEquals(False, ceph_utils.ensure_ceph_keyring(service='foo'))
+
+    @patch.object(ceph_utils, '_keyring_path')
+    @patch.object(ceph_utils, 'create_keyring')
+    @patch.object(ceph_utils, 'relation_ids')
+    @patch.object(ceph_utils, 'related_units')
+    @patch.object(ceph_utils, 'relation_get')
+    def test_ensure_ceph_keyring_with_data(self, rget, runits,
+                                           rids, create, _path):
+        rids.return_value = ['ceph:0']
+        runits.return_value = ['ceph/0']
+        rget.return_value = 'fookey'
+        self.assertEquals(True,
+                          ceph_utils.ensure_ceph_keyring(service='foo'))
+        create.assert_called_with(service='foo', key='fookey')
+        _path.assert_called_with('foo')
+        self.assertFalse(self.check_call.called)
+
+        _path.return_value = '/etc/ceph/client.foo.keyring'
+        self.assertEquals(
+            True,
+            ceph_utils.ensure_ceph_keyring(
+                service='foo', user='adam', group='users'))
+        create.assert_called_with(service='foo', key='fookey')
+        _path.assert_called_with('foo')
+        self.check_call.assert_called_with([
+            'chown',
+            'adam.users',
+            '/etc/ceph/client.foo.keyring'
+        ])