1
=== modified file 'charmhelpers/contrib/cloudfoundry/contexts.py'
2
--- charmhelpers/contrib/cloudfoundry/contexts.py	2014-05-26 18:49:24 +0000
3
+++ charmhelpers/contrib/cloudfoundry/contexts.py	2014-06-06 19:43:53 +0000
4
@@ -33,7 +33,7 @@
5
33
33
6
34
class NatsRelation(RelationContext):
34
class NatsRelation(RelationContext):
7
35
    interface = 'nats'
35
    interface = 'nats'
9
36
    required_keys = ['nats_port', 'nats_address', 'nats_user', 'nats_password']
36
    required_keys = ['address', 'port', 'user', 'password']
10
37
37
11
38
38
12
39
class MysqlRelation(RelationContext):
39
class MysqlRelation(RelationContext):
13
@@ -44,9 +44,10 @@
14
44
    def get_data(self):
44
    def get_data(self):
15
45
        RelationContext.get_data(self)
45
        RelationContext.get_data(self)
16
46
        if self.is_ready():
46
        if self.is_ready():
20
47
            if 'port' not in self['db']:
47
            for unit in self['db']:
21
48
                self['db']['port'] = '3306'
48
                if 'port' not in unit:
22
49
            self['db']['dsn'] = self.dsn_template.format(**self['db'])
49
                    unit['port'] = '3306'
23
50
                unit['dsn'] = self.dsn_template.format(**unit)
24
50
51
25
51
52
26
52
class RouterRelation(RelationContext):
53
class RouterRelation(RelationContext):
27
@@ -56,9 +57,19 @@
28
56
57
29
57
class LogRouterRelation(RelationContext):
58
class LogRouterRelation(RelationContext):
30
58
    interface = 'logrouter'
59
    interface = 'logrouter'
32
59
    required_keys = ['shared-secret', 'logrouter-address']
60
    required_keys = ['shared_secret', 'address', 'incoming_port', 'outgoing_port']
33
60
61
34
61
62
35
62
class LoggregatorRelation(RelationContext):
63
class LoggregatorRelation(RelationContext):
36
63
    interface = 'loggregator'
64
    interface = 'loggregator'
38
64
    required_keys = ['shared_secret', 'loggregator_address']
65
    required_keys = ['shared_secret', 'address', 'incoming_port', 'outgoing_port']
39
66
40
67
41
68
class EtcdRelation(RelationContext):
42
69
    interface = 'etcd'
43
70
    required_keys = ['hostname', 'port']
44
71
45
72
46
73
class CloudControllerRelation(RelationContext):
47
74
    interface = 'cc'
48
75
    required_keys = ['hostname', 'port', 'user', 'password']
49
65
76
50
=== modified file 'charmhelpers/core/services.py'
51
--- charmhelpers/core/services.py	2014-05-29 17:23:48 +0000
52
+++ charmhelpers/core/services.py	2014-06-06 19:43:53 +0000
53
@@ -11,6 +11,14 @@
54
11
        """
11
        """
55
12
        Register a list of services, given their definitions.
12
        Register a list of services, given their definitions.
56
13
13
57
14
        Traditional charm authoring is focused on implementing hooks.  That is,
58
15
        the charm author is thinking in terms of "What hook am I handling; what
59
16
        does this hook need to do?"  However, in most cases, the real question
60
17
        should be "Do I have the information I need to configure and start this
61
18
        piece of software and, if so, what are the steps for doing so."  The
62
19
        ServiceManager framework tries to bring the focus to the data and the
63
20
        setup tasks, in the most declarative way possible.
64
21
65
14
        Service definitions are dicts in the following formats (all keys except
22
        Service definitions are dicts in the following formats (all keys except
66
15
        'service' are optional):
23
        'service' are optional):
67
16
24
68
@@ -67,28 +75,28 @@
69
67
        a mongodb relation and which runs a custom `db_migrate` function prior to
75
        a mongodb relation and which runs a custom `db_migrate` function prior to
70
68
        restarting the service, and a Runit serivce called spadesd.
76
        restarting the service, and a Runit serivce called spadesd.
71
69
77
94
70
            >>> manager = services.ServiceManager([
78
            manager = services.ServiceManager([
95
71
            ...     {
79
                {
96
72
            ...         'service': 'bingod',
80
                    'service': 'bingod',
97
73
            ...         'ports': [80, 443],
81
                    'ports': [80, 443],
98
74
            ...         'required_data': [MongoRelation(), config()],
82
                    'required_data': [MongoRelation(), config(), {'my': 'data'}],
99
75
            ...         'data_ready': [
83
                    'data_ready': [
100
76
            ...             services.template(source='bingod.conf'),
84
                        services.template(source='bingod.conf'),
101
77
            ...             services.template(source='bingod.ini',
85
                        services.template(source='bingod.ini',
102
78
            ...                               target='/etc/bingod.ini',
86
                                          target='/etc/bingod.ini',
103
79
            ...                               owner='bingo', perms=0400),
87
                                          owner='bingo', perms=0400),
104
80
            ...         ],
88
                    ],
105
81
            ...     },
89
                },
106
82
            ...     {
90
                {
107
83
            ...         'service': 'spadesd',
91
                    'service': 'spadesd',
108
84
            ...         'data_ready': services.template(source='spadesd_run.j2',
92
                    'data_ready': services.template(source='spadesd_run.j2',
109
85
            ...                                         target='/etc/sv/spadesd/run',
93
                                                    target='/etc/sv/spadesd/run',
110
86
            ...                                         perms=0555),
94
                                                    perms=0555),
111
87
            ...         'start': runit_start,
95
                    'start': runit_start,
112
88
            ...         'stop': runit_stop,
96
                    'stop': runit_stop,
113
89
            ...     },
97
                },
114
90
            ... ])
98
            ])
115
91
            ... manager.manage()
99
            manager.manage()
116
92
        """
100
        """
117
93
        self.services = {}
101
        self.services = {}
118
94
        for service in services or []:
102
        for service in services or []:
119
@@ -222,46 +230,57 @@
120
222
230
121
223
    __nonzero__ = __bool__
231
    __nonzero__ = __bool__
122
224
232
123
233
    def __repr__(self):
124
234
        return super(RelationContext, self).__repr__()
125
235
126
225
    def is_ready(self):
236
    def is_ready(self):
127
226
        """
237
        """
131
227
        Returns True if all of the required_keys are available.
238
        Returns True if all of the `required_keys` are available from any units.
132
228
        """
239
        """
133
229
        return set(self.get(self.interface, {}).keys()).issuperset(set(self.required_keys))
240
        return len(self.get(self.interface, [])) > 0
134
241
135
242
    def _is_ready(self, unit_data):
136
243
        """
137
244
        Helper method that tests a set of relation data and returns True if
138
245
        all of the `required_keys` are present.
139
246
        """
140
247
        return set(unit_data.keys()).issuperset(set(self.required_keys))
141
230
248
142
231
    def get_data(self):
249
    def get_data(self):
143
232
        """
250
        """
163
233
        Retrieve the relation data and store it under `self[self.interface]`.
251
        Retrieve the relation data for each unit involved in a realtion and,
164
234
252
        if complete, store it in a list under `self[self.interface]`.
165
235
        If there are more than one units related on the desired interface,
253
166
236
        then each unit will have its data stored under `self[self.interface][unit_id]`
254
        The units are sorted lexographically first by the service ID, then by
167
237
        and one of the units with complete information will chosen at random
255
        the unit ID.  Thus, if an interface has two other services, 'db:1'
168
238
        to fill the values at `self[self.interface]`.
256
        and 'db:2', with 'db:1' having two units, 'wordpress/0' and 'wordpress/1',
169
239
257
        and 'db:2' having one unit, 'mediawiki/0', all of which have a complete
170
240
258
        set of data, the relation data for the units will be stored in the
171
241
        For example:
259
        order: 'wordpress/0', 'wordpress/1', 'mediawiki/0'.
172
242
260
173
243
            {
261
        If you only care about a single unit on the relation, you can just
174
244
                'foo': 'bar',
262
        access it as `{{ interface[0]['key'] }}`.  However, if you can at all
175
245
                'unit/0': {
263
        support multiple units on a relation, you should iterate over the list,
176
246
                    'foo': 'bar',
264
        like:
177
247
                },
265
178
248
                'unit/1': {
266
            {% for unit in interface -%}
179
249
                    'foo': 'baz',
267
                {{ unit['key'] }}{% if not loop.last %},{% endif %}
180
250
                },
268
            {%- endfor %}
181
251
            }
269
182
270
        Note that since all sets of relation data from all related services and
183
271
        units are in a single list, if you need to know which service or unit a
184
272
        set of data came from, you'll need to extend this class to preserve
185
273
        that information.
186
252
        """
274
        """
187
253
        if not hookenv.relation_ids(self.interface):
275
        if not hookenv.relation_ids(self.interface):
188
254
            return
276
            return
189
255
277
194
256
        ns = self.setdefault(self.interface, {})
278
        ns = self.setdefault(self.interface, [])
195
257
        required = set(self.required_keys)
279
        for rid in sorted(hookenv.relation_ids(self.interface)):
196
258
        for rid in hookenv.relation_ids(self.interface):
280
            for unit in sorted(hookenv.related_units(rid)):
193
259
            for unit in hookenv.related_units(rid):
197
260
                reldata = hookenv.relation_get(rid=rid, unit=unit)
281
                reldata = hookenv.relation_get(rid=rid, unit=unit)
202
261
                unit_ns = ns.setdefault(unit, {})
282
                if self._is_ready(reldata):
203
262
                unit_ns.update(reldata)
283
                    ns.append(reldata)
200
263
                if set(reldata.keys()).issuperset(required):
201
264
                    ns.update(reldata)
204
265
284
205
266
285
206
267
class ManagerCallback(object):
286
class ManagerCallback(object):
207
@@ -316,6 +335,6 @@
208
316
335
209
317
336
210
318
# Convenience aliases
337
# Convenience aliases
212
319
template = TemplateCallback
338
render_template = template = TemplateCallback
213
320
open_ports = PortManagerCallback()
339
open_ports = PortManagerCallback()
214
321
close_ports = PortManagerCallback()
340
close_ports = PortManagerCallback()
215
322
341
216
=== modified file 'tests/contrib/cloudfoundry/test_render_context.py'
217
--- tests/contrib/cloudfoundry/test_render_context.py	2014-05-26 18:49:24 +0000
218
+++ tests/contrib/cloudfoundry/test_render_context.py	2014-06-06 19:43:53 +0000
219
@@ -18,23 +18,22 @@
220
18
    @mock.patch('charmhelpers.core.hookenv.relation_get')
18
    @mock.patch('charmhelpers.core.hookenv.relation_get')
221
19
    def test_nats_relation_populated(self, mrel, mid, mrelated):
19
    def test_nats_relation_populated(self, mrel, mid, mrelated):
222
20
        mid.return_value = ['nats']
20
        mid.return_value = ['nats']
225
21
        mrel.return_value = {'nats_port': 1234, 'nats_address': 'host',
21
        mrel.return_value = {'port': 1234, 'address': 'host',
226
22
                             'nats_user': 'user', 'nats_password': 'password'}
22
                             'user': 'user', 'password': 'password'}
227
23
        mrelated.return_value = ['router/0']
23
        mrelated.return_value = ['router/0']
228
24
        n = contexts.NatsRelation()
24
        n = contexts.NatsRelation()
233
25
        expected = {'nats': {'nats_port': 1234, 'nats_address': 'host',
25
        expected = {'nats': [{'port': 1234, 'address': 'host',
234
26
                             'nats_user': 'user', 'nats_password': 'password',
26
                              'user': 'user', 'password': 'password'}]}
231
27
                             'router/0': {'nats_port': 1234, 'nats_address': 'host',
232
28
                                          'nats_user': 'user', 'nats_password': 'password'}}}
235
29
        self.assertTrue(bool(n))
27
        self.assertTrue(bool(n))
236
30
        self.assertEqual(n, expected)
28
        self.assertEqual(n, expected)
237
29
        self.assertEqual(n['nats'][0]['port'], 1234)
238
31
30
239
32
    @mock.patch('charmhelpers.core.hookenv.related_units')
31
    @mock.patch('charmhelpers.core.hookenv.related_units')
240
33
    @mock.patch('charmhelpers.core.hookenv.relation_ids')
32
    @mock.patch('charmhelpers.core.hookenv.relation_ids')
241
34
    @mock.patch('charmhelpers.core.hookenv.relation_get')
33
    @mock.patch('charmhelpers.core.hookenv.relation_get')
242
35
    def test_nats_relation_partial(self, mrel, mid, mrelated):
34
    def test_nats_relation_partial(self, mrel, mid, mrelated):
243
36
        mid.return_value = ['nats']
35
        mid.return_value = ['nats']
245
37
        mrel.return_value = {'nats_address': 'host'}
36
        mrel.return_value = {'address': 'host'}
246
38
        mrelated.return_value = ['router/0']
37
        mrelated.return_value = ['router/0']
247
39
        n = contexts.NatsRelation()
38
        n = contexts.NatsRelation()
248
40
        self.assertEqual(n, {})
39
        self.assertEqual(n, {})
249
@@ -56,10 +55,10 @@
250
56
        mrel.return_value = {'domain': 'example.com'}
55
        mrel.return_value = {'domain': 'example.com'}
251
57
        mrelated.return_value = ['router/0']
56
        mrelated.return_value = ['router/0']
252
58
        n = contexts.RouterRelation()
57
        n = contexts.RouterRelation()
255
59
        expected = {'router': {'domain': 'example.com',
58
        expected = {'router': [{'domain': 'example.com'}]}
254
60
                               'router/0': {'domain': 'example.com'}}}
256
61
        self.assertTrue(bool(n))
59
        self.assertTrue(bool(n))
257
62
        self.assertEqual(n, expected)
60
        self.assertEqual(n, expected)
258
61
        self.assertEqual(n['router'][0]['domain'], 'example.com')
259
63
62
260
64
63
261
65
class TestStoredContext(unittest.TestCase):
64
class TestStoredContext(unittest.TestCase):
262
66
65
263
=== modified file 'tests/core/test_services.py'
264
--- tests/core/test_services.py	2014-05-29 17:23:48 +0000
265
+++ tests/core/test_services.py	2014-06-06 19:43:53 +0000
266
@@ -310,7 +310,7 @@
267
310
        mhookenv.related_units.return_value = []
310
        mhookenv.related_units.return_value = []
268
311
        self.context.get_data()
311
        self.context.get_data()
269
312
        self.assertFalse(self.context.is_ready())
312
        self.assertFalse(self.context.is_ready())
271
313
        self.assertEqual(self.context, {'http': {}})
313
        self.assertEqual(self.context, {'http': []})
272
314
314
273
315
    @mock.patch.object(services, 'hookenv')
315
    @mock.patch.object(services, 'hookenv')
274
316
    def test_incomplete(self, mhookenv):
316
    def test_incomplete(self, mhookenv):
275
@@ -319,8 +319,8 @@
276
319
        mhookenv.relation_get.side_effect = [{}, {'foo': '1'}]
319
        mhookenv.relation_get.side_effect = [{}, {'foo': '1'}]
277
320
        self.assertFalse(bool(self.context))
320
        self.assertFalse(bool(self.context))
278
321
        self.assertEqual(mhookenv.relation_get.call_args_list, [
321
        self.assertEqual(mhookenv.relation_get.call_args_list, [
279
322
            mock.call(rid='apache', unit='apache/0'),
280
322
            mock.call(rid='nginx', unit='nginx/0'),
323
            mock.call(rid='nginx', unit='nginx/0'),
281
323
            mock.call(rid='apache', unit='apache/0'),
282
324
        ])
324
        ])
283
325
325
284
326
    @mock.patch.object(services, 'hookenv')
326
    @mock.patch.object(services, 'hookenv')
285
@@ -329,23 +329,17 @@
286
329
        mhookenv.related_units.side_effect = lambda i: [i+'/0']
329
        mhookenv.related_units.side_effect = lambda i: [i+'/0']
287
330
        mhookenv.relation_get.side_effect = [{'foo': '1'}, {'foo': '2', 'bar': '3'}, {}]
330
        mhookenv.relation_get.side_effect = [{'foo': '1'}, {'foo': '2', 'bar': '3'}, {}]
288
331
        self.context.get_data()
331
        self.context.get_data()
296
332
        self.assertEqual(self.context, {'http': {
332
        self.assertTrue(self.context.is_ready())
297
333
            'foo': '2',
333
        self.assertEqual(self.context, {'http': [
298
334
            'bar': '3',
334
            {
292
335
            'nginx/0': {
293
336
                'foo': '1',
294
337
            },
295
338
            'apache/0': {
299
339
                'foo': '2',
335
                'foo': '2',
300
340
                'bar': '3',
336
                'bar': '3',
301
341
            },
337
            },
305
342
            'tomcat/0': {
338
        ]})
303
343
            },
304
344
        }})
306
345
        mhookenv.relation_ids.assert_called_with('http')
339
        mhookenv.relation_ids.assert_called_with('http')
307
346
        self.assertEqual(mhookenv.relation_get.call_args_list, [
340
        self.assertEqual(mhookenv.relation_get.call_args_list, [
308
341
            mock.call(rid='apache', unit='apache/0'),
309
347
            mock.call(rid='nginx', unit='nginx/0'),
342
            mock.call(rid='nginx', unit='nginx/0'),
310
348
            mock.call(rid='apache', unit='apache/0'),
311
349
            mock.call(rid='tomcat', unit='tomcat/0'),
343
            mock.call(rid='tomcat', unit='tomcat/0'),
312
350
        ])
344
        ])
313
351
345
Status:	Merged
Merged at revision:	183
Proposed branch:	lp:~johnsca/charm-helpers/multi-unit
Merge into:	lp:~cf-charmers/charm-helpers/cloud-foundry
Diff against target:	312 lines (+104/-81) 4 files modified charmhelpers/contrib/cloudfoundry/contexts.py (+17/-6) charmhelpers/core/services.py (+72/-53) tests/contrib/cloudfoundry/test_render_context.py (+8/-9) tests/core/test_services.py (+7/-13)
To merge this branch:	bzr merge lp:~johnsca/charm-helpers/multi-unit
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Cloud Foundry Charmers		2014-06-02	Pending
Review via email: mp+221801@code.launchpad.net