Merge lp:~bloodearnest/charms/precise/apache2/vhost-template-vars into lp:charms/apache2

[Simon Davy]

Add vhost_template_vars, as per trusty branch

Add vhost_template_vars, as per trusty branch

[Review Queue (review-queue)]

This items has failed automated testing! Results available here http://reports.vapour.ws/charm-tests/charm-bundle-test-11066-results

review: Needs Fixing (automated testing)

[Review Queue (review-queue)]

This items has failed automated testing! Results available here http://reports.vapour.ws/charm-tests/charm-bundle-test-11076-results

review: Needs Fixing (automated testing)

[Adam Israel (aisrael)]

Hi Simon,

Thanks for your work on improving the apache2 charm. It appears that the test_create_vhost_template_config test has been duplicated, which is causing a lint error. The other automated test failures, relating to self-signed certificates, is a problem upstream and won't stand in the way of this merge, once the lint error is corrected.

review: Approve

[Adam Israel (aisrael)]

Sorry, I meant to mark as needs fixing.

review: Needs Fixing

[Marco Ceppi (marcoceppi)]

I've moved this to Work In Progress, when ready for another review please move to Needs Review

Unmerged revisions

62. By Simon Davy on 2015-02-27

add vhost_template_vars, merge from trusty

=== modified file 'README.md'
--- README.md	2014-11-20 00:32:58 +0000
+++ README.md	2015-02-27 15:07:15 +0000
@@ -67,6 +67,11 @@
 Virtual host templates can also be specified via relation.  See the
 vhost-config relation section below for more information.
 
+The vhost_template_vars config allows for further customisation of the vhost
+templates. For example, you can have a single template for a particular
+service, but use vhost_template_vars to customise it slightly for
+devel/staging/production environments.
+
 ### Using the reverseproxy relation
 
 The charm will create the service variable, with the `unit_name`,

=== modified file 'config.yaml'
--- config.yaml	2014-10-16 13:12:04 +0000
+++ config.yaml	2015-02-27 15:07:15 +0000
@@ -11,6 +11,10 @@
     type: string
     default: ''
     description: Apache vhost template (base64 encoded).
+  vhost_template_vars:
+    type: string
+    default: ''
+    description: Additional custom variables for the vhost templating, in python dict format
   enable_modules:
     type: string
     default: ''

=== modified file 'hooks/hooks.py'
--- hooks/hooks.py	2014-10-13 07:51:42 +0000
+++ hooks/hooks.py	2015-02-27 15:07:15 +0000
@@ -11,6 +11,7 @@
 import pwd
 import shutil
 import os.path
+import ast
 
 from charmhelpers.core.hookenv import (
     open_port,
@@ -528,6 +529,9 @@
     from jinja2 import Template
     template = Template(str(base64.b64decode(template_str)))
     template_data = dict(config_data.items() + relationship_data.items())
+    if config_data.get('vhost_template_vars'):
+        extra_vars = ast.literal_eval(config_data['vhost_template_vars'])
+        template_data.update(extra_vars)
     vhost_name = '%s_%s' % (config_data['servername'], protocol)
     vhost_file = site_filename(vhost_name)
     log("Writing file %s with config and relation data" % vhost_file)

=== modified file 'hooks/tests/test_create_vhost.py'
--- hooks/tests/test_create_vhost.py	2014-05-20 03:34:20 +0000
+++ hooks/tests/test_create_vhost.py	2015-02-27 15:07:15 +0000
@@ -104,3 +104,31 @@
         with open(filename, 'r') as f:
             contents = f.read()
         self.assertEqual(contents, template)
+
+    @patch('hooks.close_port')
+    @patch('hooks.site_filename')
+    @patch('hooks.open_port')
+    @patch('hooks.subprocess.call')
+    def test_create_vhost_template_config(
+            self, mock_call, mock_open_port, mock_site_filename,
+            mock_close_port):
+        """Template passed in as config setting."""
+        template = ("one\n"
+                    "two\n"
+                    "{{ extra }}")
+        expected = ("one\n"
+                    "two\n"
+                    "three")
+        config = {"servername": "unused",
+                  "vhost_template_vars": "{'extra': 'three'}",
+                  "vhost_template": base64.b64encode(template)}
+        file = tempfile.NamedTemporaryFile()
+        filename = file.name
+        mock_site_filename.return_value = filename
+        hooks.create_vhost(
+            "80",
+            config_key="vhost_template",
+            config_data=config)
+        with open(filename, 'r') as f:
+            contents = f.read()
+        self.assertEqual(contents, expected)