From 72da1fc6cf12d0c344bd718c18b4e099e0ab1d8a Mon Sep 17 00:00:00 2001
From: Liam Young <liam.young@canonical.com>
Date: Mon, 7 Sep 2015 09:23:57 +0100
Subject: [PATCH] Charm helper sync

---
 charm-helpers-hooks.yaml                      |  2 +-
 .../contrib/storage/linux/ceph.py             | 62 +++++++++++++++++--
 2 files changed, 57 insertions(+), 7 deletions(-)

diff --git a/charm-helpers-hooks.yaml b/charm-helpers-hooks.yaml
index d4035311..eeee6f8c 100644
--- a/charm-helpers-hooks.yaml
+++ b/charm-helpers-hooks.yaml
@@ -1,4 +1,4 @@
-branch: lp:~gnuoy/charm-helpers/cepg-broker
+branch: lp:charm-helpers
 destination: hooks/charmhelpers
 include:
     - core
diff --git a/hooks/charmhelpers/contrib/storage/linux/ceph.py b/hooks/charmhelpers/contrib/storage/linux/ceph.py
index 0caaabe3..c5aa2dde 100644
--- a/hooks/charmhelpers/contrib/storage/linux/ceph.py
+++ b/hooks/charmhelpers/contrib/storage/linux/ceph.py
@@ -414,21 +414,26 @@ class CephBrokerRq(object):
 
     The API is versioned and defaults to version 1.
     """
-    def __init__(self, api_version=1, ops=None, request_id=None):
+    def __init__(self, api_version=1, request_id=None):
         self.api_version = api_version
         if request_id:
             self.request_id = request_id
         else:
             self.request_id = str(uuid.uuid1())
-        if ops:
-            self.ops = ops
-        else:
-            self.ops = []
+        self.ops = []
 
     def add_op_create_pool(self, name, replica_count=3):
         self.ops.append({'op': 'create-pool', 'name': name,
                          'replicas': replica_count})
 
+    def set_ops(self, ops):
+        """Set request ops to provided value.
+
+        Useful for injecting ops that come from a previous request
+        to allow comparisons to ensure validity.
+        """
+        self.ops = ops
+
     @property
     def request(self):
         return json.dumps({'api-version': self.api_version, 'ops': self.ops,
@@ -482,6 +487,51 @@ class CephBrokerRsp(object):
         return self.rsp.get('stderr')
 
 
+# Ceph Broker Conversation:
+# If a charm needs an action to be taken by ceph it can create a CephBrokerRq
+# and send that request to ceph via the ceph relation. The CephBrokerRq has a
+# unique id so that the client can identity which CephBrokerRsp is associated
+# with the request. Ceph will also respond to each client unit individually
+# creating a response key per client unit eg glance/0 will get a CephBrokerRsp
+# via key broker-rsp-glance-0
+#
+# To use this the charm can just do something like:
+#
+# from charmhelpers.contrib.storage.linux.ceph import (
+#     send_request_if_needed,
+#     is_request_complete,
+#     CephBrokerRq,
+# )
+#
+# @hooks.hook('ceph-relation-changed')
+# def ceph_changed():
+#     rq = CephBrokerRq()
+#     rq.add_op_create_pool(name='poolname', replica_count=3)
+#
+#     if is_request_complete(rq):
+#         <Request complete actions>
+#     else:
+#         send_request_if_needed(get_ceph_request())
+#
+# CephBrokerRq and CephBrokerRsp are serialized into JSON. Below is an example
+# of glance having sent a request to ceph which ceph has successfully processed
+#  'ceph:8': {
+#      'ceph/0': {
+#          'auth': 'cephx',
+#          'broker-rsp-glance-0': '{"request-id": "0bc7dc54", "exit-code": 0}',
+#          'broker_rsp': '{"request-id": "0da543b8", "exit-code": 0}',
+#          'ceph-public-address': '10.5.44.103',
+#          'key': 'AQCLDttVuHXINhAAvI144CB09dYchhHyTUY9BQ==',
+#          'private-address': '10.5.44.103',
+#      },
+#      'glance/0': {
+#          'broker_req': ('{"api-version": 1, "request-id": "0bc7dc54", '
+#                         '"ops": [{"replicas": 3, "name": "glance", '
+#                         '"op": "create-pool"}]}'),
+#          'private-address': '10.5.44.109',
+#      },
+#  }
+
 def get_previous_request(rid):
     """Return the last ceph broker request sent on a given relation
 
@@ -493,8 +543,8 @@ def get_previous_request(rid):
     if broker_req:
         request_data = json.loads(broker_req)
         request = CephBrokerRq(api_version=request_data['api-version'],
-                               ops=request_data['ops'],
                                request_id=request_data['request-id'])
+        request.set_ops(request_data['ops'])
     return request