Merge lp:~hopem/charm-helpers/lp1694963 into lp:charm-helpers

[Edward Hope-Morley]

[Alex Kavanagh (ajkavanagh)]

I'm not sure I understand the rationale of using another store for this persistent data? why not just use the regular kv() store and just use the same 'namespace' that it already being proposed; it's unlikely to clash with anything else. Plus, the decorator will not be needed, and it simplifies the code.

review: Needs Fixing

[Billy Olsen (billy-olsen)]

This looks good to me.

review: Approve

[Alex Kavanagh (ajkavanagh)]

Sorry, probably already merged, but please take notice of these comments for the future.

=== modified file 'charmhelpers/contrib/storage/linux/ceph.py'
--- charmhelpers/contrib/storage/linux/ceph.py	2017-03-29 13:20:58 +0000
+++ charmhelpers/contrib/storage/linux/ceph.py	2017-06-09 15:20:01 +0000
@@ -63,6 +63,7 @@
 from charmhelpers.fetch import (
     apt_install,
 )
+from charmhelpers.core.unitdata import kv
 
 from charmhelpers.core.kernel import modprobe
 from charmhelpers.contrib.openstack.utils import config_flags_parser
@@ -1314,6 +1315,47 @@
             relation_set(relation_id=rid, broker_req=request.request)
 
 
+def is_broker_action_done(action, rid=None, unit=None):
+    """Check whether broker action has completed yet.
+
+    @param action: name of action to be performed
+    @returns True if action complete otherwise False
+    """
+    rdata = relation_get(rid, unit) or {}
+    broker_rsp = rdata.get(get_broker_rsp_key())
+    if not broker_rsp:
+        return False
+
+    rsp = CephBrokerRsp(broker_rsp)
+    unit_name = local_unit().partition('/')[2]
+    key = "unit_{}_ceph_broker_action.{}".format(unit_name, action)
+    kvstore = kv()
+    val = kvstore.get(key=key)
+    if val and val == rsp.request_id:
+        return True
+
+    return False
+
+
+def mark_broker_action_done(action, rid=None, unit=None):
+    """Mark action as having been completed.
+
+    @param action: name of action to be performed
+    @returns None
+    """
+    rdata = relation_get(rid, unit) or {}
+    broker_rsp = rdata.get(get_broker_rsp_key())
+    if not broker_rsp:
+        return
+
+    rsp = CephBrokerRsp(broker_rsp)
+    unit_name = local_unit().partition('/')[2]
+    key = "unit_{}_ceph_broker_action.{}".format(unit_name, action)
+    kvstore = kv()
+    kvstore.set(key=key, value=rsp.request_id)
+    kvstore.flush()
+
+
 class CephConfContext(object):
     """Ceph config (ceph.conf) context.
 

=== modified file 'tests/contrib/storage/test_linux_ceph.py'
--- tests/contrib/storage/test_linux_ceph.py	2017-03-29 13:20:58 +0000
+++ tests/contrib/storage/test_linux_ceph.py	2017-06-09 15:20:01 +0000
@@ -7,8 +7,11 @@
 from testtools import TestCase
 import json
 import copy
+import shutil
 
 import charmhelpers.contrib.storage.linux.ceph as ceph_utils
+
+from charmhelpers.core.unitdata import Storage
 from subprocess import CalledProcessError
 from tests.helpers import patch_open, FakeRelation
 import nose.plugins.attrib
@@ -1397,3 +1400,52 @@
         mock_config.return_value = ("{'osd': {'foo': 1},"
                                     "'unknown': {'blah': 1}}")
         self.assertEqual({'osd': {'foo': 1}}, ctxt)
+
+    @patch.object(ceph_utils, 'local_unit', lambda: "nova-compute/0")
+    def test_is_broker_action_done(self):
+        tmpdir = mkdtemp()
+        try:
+            db_path = '{}/kv.db'.format(tmpdir)
+            with patch('charmhelpers.core.unitdata._KV', Storage(db_path)):
+                rq_id = "3d03e9f6-4c36-11e7-89ba-fa163e7c7ec6"
+                broker_key = ceph_utils.get_broker_rsp_key()
+                self.relation_get.return_value = {broker_key:
+                                                  json.dumps({"request-id":
+                                                              rq_id,
+                                                              "exit-code": 0})}
+                action = 'restart_nova_compute'
+                ret = ceph_utils.is_broker_action_done(action, rid="ceph:1",
+                                                       unit="ceph/0")
+                self.relation_get.assert_has_calls([call('ceph:1', 'ceph/0')])
+                self.assertFalse(ret)
+
+                ceph_utils.mark_broker_action_done(action)
+                self.assertTrue(os.path.exists(tmpdir))
+                ret = ceph_utils.is_broker_action_done(action, rid="ceph:1",
+                                                       unit="ceph/0")
+                self.assertTrue(ret)
+        finally:
+            if os.path.exists(tmpdir):
+                shutil.rmtree(tmpdir)
+
+    @patch.object(ceph_utils, 'local_unit', lambda: "nova-compute/0")
+    def test_mark_broker_action_done(self):
+        tmpdir = mkdtemp()
+        try:
+            db_path = '{}/kv.db'.format(tmpdir)
+            with patch('charmhelpers.core.unitdata._KV', Storage(db_path)):
+                rq_id = "3d03e9f6-4c36-11e7-89ba-fa163e7c7ec6"
+                broker_key = ceph_utils.get_broker_rsp_key()
+                self.relation_get.return_value = {broker_key:
+                                                  json.dumps({"request-id":
+                                                              rq_id})}
+                action = 'restart_nova_compute'
+                ceph_utils.mark_broker_action_done(action, rid="ceph:1",
+                                                   unit="ceph/0")
+                key = 'unit_0_ceph_broker_action.{}'.format(action)
+                self.relation_get.assert_has_calls([call('ceph:1', 'ceph/0')])
+                kvstore = Storage(db_path)
+                self.assertEqual(kvstore.get(key=key), rq_id)
+        finally:
+            if os.path.exists(tmpdir):
+                shutil.rmtree(tmpdir)