Merge lp:~gnuoy/charm-helpers/service-framework-loader into lp:charm-helpers

[Liam Young]

=== modified file 'charmhelpers/contrib/openstack/utils.py'
--- charmhelpers/contrib/openstack/utils.py	2015-10-14 21:29:40 +0000
+++ charmhelpers/contrib/openstack/utils.py	2015-11-03 12:21:04 +0000
@@ -26,6 +26,7 @@
 
 import six
 import traceback
+import uuid
 import yaml
 
 from charmhelpers.contrib.network import ip
@@ -41,6 +42,7 @@
     log as juju_log,
     charm_dir,
     INFO,
+    related_units,
     relation_ids,
     relation_set,
     status_set,
@@ -978,3 +980,19 @@
             action_set({'outcome': 'no upgrade available.'})
 
     return ret
+
+
+def remote_restart(rel_name, remote_service=None):
+    trigger = {
+        'restart-trigger': str(uuid.uuid4()),
+    }
+    if remote_service:
+        trigger['remote-service'] = remote_service
+    for rid in relation_ids(rel_name):
+        # This subordinate can be related to two seperate services using
+        # different subordinate relations so only issue the restart if
+        # the principle is conencted down the relation we think it is
+        if related_units(relid=rid):
+            relation_set(relation_id=rid,
+                         relation_settings=trigger,
+                         )

=== modified file 'charmhelpers/core/services/helpers.py'
--- charmhelpers/core/services/helpers.py	2015-08-17 11:03:07 +0000
+++ charmhelpers/core/services/helpers.py	2015-11-03 12:21:04 +0000
@@ -249,16 +249,18 @@
     :param int perms: The permissions of the rendered file
     :param partial on_change_action: functools partial to be executed when
                                      rendered file changes
+    :param jinja2 loader template_loader: A jinja2 template loader
     """
     def __init__(self, source, target,
                  owner='root', group='root', perms=0o444,
-                 on_change_action=None):
+                 on_change_action=None, template_loader=None):
         self.source = source
         self.target = target
         self.owner = owner
         self.group = group
         self.perms = perms
         self.on_change_action = on_change_action
+        self.template_loader = template_loader
 
     def __call__(self, manager, service_name, event_name):
         pre_checksum = ''
@@ -269,7 +271,8 @@
         for ctx in service.get('required_data', []):
             context.update(ctx)
         templating.render(self.source, self.target, context,
-                          self.owner, self.group, self.perms)
+                          self.owner, self.group, self.perms,
+                          template_loader=self.template_loader)
         if self.on_change_action:
             if pre_checksum == host.file_hash(self.target):
                 hookenv.log(

=== modified file 'charmhelpers/core/templating.py'
--- charmhelpers/core/templating.py	2015-07-28 12:52:17 +0000
+++ charmhelpers/core/templating.py	2015-11-03 12:21:04 +0000
@@ -21,7 +21,7 @@
 
 
 def render(source, target, context, owner='root', group='root',
-           perms=0o444, templates_dir=None, encoding='UTF-8'):
+           perms=0o444, templates_dir=None, encoding='UTF-8', template_loader=None):
     """
     Render a template.
 
@@ -52,12 +52,15 @@
         apt_install('python-jinja2', fatal=True)
         from jinja2 import FileSystemLoader, Environment, exceptions
 
-    if templates_dir is None:
-        templates_dir = os.path.join(hookenv.charm_dir(), 'templates')
-    loader = Environment(loader=FileSystemLoader(templates_dir))
+    if template_loader:
+        template_env = Environment(loader=template_loader)
+    else:
+        if templates_dir is None:
+            templates_dir = os.path.join(hookenv.charm_dir(), 'templates')
+        template_env = Environment(loader=FileSystemLoader(templates_dir))
     try:
         source = source
-        template = loader.get_template(source)
+        template = template_env.get_template(source)
     except exceptions.TemplateNotFound as e:
         hookenv.log('Could not load template %s from %s.' %
                     (source, templates_dir),

=== modified file 'tests/contrib/openstack/test_os_utils.py'
--- tests/contrib/openstack/test_os_utils.py	2015-09-25 14:23:31 +0000
+++ tests/contrib/openstack/test_os_utils.py	2015-11-03 12:21:04 +0000
@@ -95,3 +95,18 @@
                                              database='testdb',
                                              username='testdbuser',
                                              hostname=hosts)
+
+    @mock.patch('uuid.uuid4')
+    @mock.patch('charmhelpers.contrib.openstack.utils.related_units')
+    @mock.patch('charmhelpers.contrib.openstack.utils.relation_set')
+    @mock.patch('charmhelpers.contrib.openstack.utils.relation_ids')
+    def test_remote_restart(self, mock_relation_ids, mock_relation_set,
+                            mock_related_units, mock_uuid4):
+        mock_relation_ids.return_value = ['neutron-plugin-api-subordinate:8']
+        mock_related_units.return_value = ['neutron-api/0']
+        mock_uuid4.return_value = 'uuid4'
+        utils.remote_restart('neutron-plugin-api-subordinate')
+        mock_relation_set.assert_called_with(
+            relation_id='neutron-plugin-api-subordinate:8',
+            relation_settings={'restart-trigger': 'uuid4'}
+        )

=== modified file 'tests/core/test_services.py'
--- tests/core/test_services.py	2015-08-17 11:03:07 +0000
+++ tests/core/test_services.py	2015-11-03 12:21:04 +0000
@@ -739,7 +739,7 @@
         callback(manager, 'test', 'event')
         mtemplating.render.assert_called_once_with(
             'foo.yml', 'bar.yml', {'foo': 'bar'},
-            'root', 'root', 0o444)
+            'root', 'root', 0o444, template_loader=None)
 
     @mock.patch.object(services.helpers, 'templating')
     def test_template_explicit(self, mtemplating):
@@ -754,7 +754,23 @@
         callback(manager, 'test', 'event')
         mtemplating.render.assert_called_once_with(
             'foo.yml', 'bar.yml', {'foo': 'bar'},
-            'user', 'group', 0o555)
+            'user', 'group', 0o555, template_loader=None)
+
+    @mock.patch.object(services.helpers, 'templating')
+    def test_template_loader(self, mtemplating):
+        manager = mock.Mock(**{'get_service.return_value': {
+            'required_data': [{'foo': 'bar'}]}})
+        callback = services.template(
+            source='foo.yml', target='bar.yml',
+            owner='user', group='group', perms=0o555,
+            template_loader='myloader'
+        )
+        assert isinstance(callback, services.ManagerCallback)
+        assert not mtemplating.render.called
+        callback(manager, 'test', 'event')
+        mtemplating.render.assert_called_once_with(
+            'foo.yml', 'bar.yml', {'foo': 'bar'},
+            'user', 'group', 0o555, template_loader='myloader')
 
     @mock.patch.object(os.path, 'isfile')
     @mock.patch.object(host, 'file_hash')
@@ -777,7 +793,7 @@
         callback(manager, 'test', 'event')
         mtemplating.render.assert_called_once_with(
             'foo.yml', 'bar.yml', {'foo': 'bar'},
-            'user', 'group', 0o555)
+            'user', 'group', 0o555, template_loader=None)
         mrestart.assert_called_with('mysuperservice')
 
     @mock.patch.object(hookenv, 'log')
@@ -801,7 +817,7 @@
         callback(manager, 'test', 'event')
         mtemplating.render.assert_called_once_with(
             'foo.yml', 'bar.yml', {'foo': 'bar'},
-            'user', 'group', 0o555)
+            'user', 'group', 0o555, template_loader=None)
         self.assertEqual(mrestart.call_args_list, [])
 
 

=== modified file 'tests/core/test_templating.py'
--- tests/core/test_templating.py	2015-07-28 12:52:17 +0000
+++ tests/core/test_templating.py	2015-11-03 12:21:04 +0000
@@ -58,6 +58,29 @@
             # expose your secrets (!).
             self.assertEqual(mkdir.call_count, 0)
 
+    @mock.patch.object(templating.host.os, 'fchown')
+    @mock.patch.object(templating.host, 'mkdir')
+    @mock.patch.object(templating.host, 'log')
+    def test_render_loader(self, log, mkdir, fchown):
+        with tempfile.NamedTemporaryFile() as fn1:
+            context = {
+                'nats': {
+                    'port': '1234',
+                    'host': 'example.com',
+                },
+                'router': {
+                    'domain': 'api.foo.com'
+                },
+                'nginx_port': 80,
+            }
+            template_loader = jinja2.ChoiceLoader([jinja2.FileSystemLoader(TEMPLATES_DIR)])
+            templating.render('fake_cc.yml', fn1.name,
+                              context, template_loader=template_loader)
+            contents = open(fn1.name).read()
+            self.assertRegexpMatches(contents, 'port: 1234')
+            self.assertRegexpMatches(contents, 'host: example.com')
+            self.assertRegexpMatches(contents, 'domain: api.foo.com')
+
     @mock.patch.object(templating.os.path, 'exists')
     @mock.patch.object(templating.host.os, 'fchown')
     @mock.patch.object(templating.host, 'mkdir')