Merge lp:~michael.nelson/charm-helpers/no-hyphens-in-ansible-yaml-keys into lp:charm-helpers

[Michael Nelson]

No hyphens in ansible yaml keys.

No hyphens in ansible yaml keys.

As InformatiQ pointed out yesterday, ansible requires that keys don't have hyphens. YAML alows hyphens in key names, so this doesn't affect the saltstack helpers (where you pull the variables in explicitly in your template with private_address = grains["private-address"], but ansible brings the yaml variables into the templates directly, and jinja2 does not allow {{ private-address }} for obvious reasons.

[1] http://www.ansibleworks.com/docs/playbooks_variables.html#what-makes-a-valid-variable-name

[James Page (james-page)]

review: Approve

=== modified file 'charmhelpers/contrib/ansible/__init__.py'
--- charmhelpers/contrib/ansible/__init__.py	2013-11-19 16:20:38 +0000
+++ charmhelpers/contrib/ansible/__init__.py	2013-11-20 10:06:29 +0000
@@ -98,7 +98,8 @@
     tags = tags or []
     tags = ",".join(tags)
     charmhelpers.contrib.templating.contexts.juju_state_to_yaml(
-        ansible_vars_path, namespace_separator='__')
+        ansible_vars_path, namespace_separator='__',
+        allow_hyphens_in_keys=False)
     call = [
         'ansible-playbook',
         '-c',

=== modified file 'charmhelpers/contrib/templating/contexts.py'
--- charmhelpers/contrib/templating/contexts.py	2013-11-07 14:38:35 +0000
+++ charmhelpers/contrib/templating/contexts.py	2013-11-20 10:06:29 +0000
@@ -12,7 +12,8 @@
 charm_dir = os.environ.get('CHARM_DIR', '')
 
 
-def juju_state_to_yaml(yaml_path, namespace_separator=':'):
+def juju_state_to_yaml(yaml_path, namespace_separator=':',
+                       allow_hyphens_in_keys=True):
     """Update the juju config and state in a yaml file.
 
     This includes any current relation-get data, and the charm
@@ -23,6 +24,11 @@
     context to templates, but it may be useful generally to
     create and update an on-disk cache of all the config, including
     previous relation data.
+
+    By default, hyphens are allowed in keys as this is supported
+    by yaml, but for tools like ansible, hyphens are not valid [1].
+
+    [1] http://www.ansibleworks.com/docs/playbooks_variables.html#what-makes-a-valid-variable-name
     """
     config = charmhelpers.core.hookenv.config()
 
@@ -59,6 +65,9 @@
     else:
         existing_vars = {}
 
+    if not allow_hyphens_in_keys:
+        config = dict(
+            (key.replace('-', '_'), val) for key, val in config.items())
     existing_vars.update(config)
     with open(yaml_path, "w+") as fp:
         fp.write(yaml.dump(existing_vars))

=== modified file 'tests/contrib/ansible/test_ansible.py'
--- tests/contrib/ansible/test_ansible.py	2013-11-19 17:03:40 +0000
+++ tests/contrib/ansible/test_ansible.py	2013-11-20 10:06:29 +0000
@@ -111,11 +111,12 @@
         self.mock_config.return_value = charmhelpers.core.hookenv.Serializable({
             'group_code_owner': 'webops_deploy',
             'user_code_runner': 'ubunet',
+            'private-address': '10.10.10.10',
         })
         self.mock_relation_type.return_value = 'wsgi-file'
         self.mock_relation_get.return_value = {
             'relation_key1': 'relation_value1',
-            'relation_key2': 'relation_value2',
+            'relation-key2': 'relation_value2',
         }
 
         charmhelpers.contrib.ansible.apply_playbook(
@@ -127,6 +128,7 @@
             self.assertEqual({
                 "group_code_owner": "webops_deploy",
                 "user_code_runner": "ubunet",
+                "private_address": "10.10.10.10",
                 "charm_dir": "",
                 "local_unit": {},
                 "wsgi_file__relation_key1": "relation_value1",

=== modified file 'tests/contrib/templating/test_contexts.py'
--- tests/contrib/templating/test_contexts.py	2013-11-19 17:03:40 +0000
+++ tests/contrib/templating/test_contexts.py	2013-11-20 10:06:29 +0000
@@ -165,3 +165,54 @@
                 "local_unit": "click-index/3",
                 "solr:hostname": "example.com",
             }, result)
+
+    def test_keys_with_hyphens(self):
+        self.mock_config.return_value = {
+            'group_code_owner': 'webops_deploy',
+            'user_code_runner': 'ubunet',
+            'private-address': '10.1.1.10',
+        }
+        self.mock_local_unit.return_value = "click-index/3"
+        self.mock_relation_get.return_value = None
+
+        charmhelpers.contrib.templating.contexts.juju_state_to_yaml(
+            self.context_path)
+
+        with open(self.context_path, 'r') as context_file:
+            result = yaml.load(context_file.read())
+            self.assertEqual({
+                "charm_dir": "/tmp/charm_dir",
+                "group_code_owner": "webops_deploy",
+                "user_code_runner": "ubunet",
+                "local_unit": "click-index/3",
+                "private-address": "10.1.1.10",
+            }, result)
+
+    def test_keys_with_hypens_not_allowed_in_keys(self):
+        self.mock_config.return_value = {
+            'group_code_owner': 'webops_deploy',
+            'user_code_runner': 'ubunet',
+            'private-address': '10.1.1.10',
+        }
+        self.mock_local_unit.return_value = "click-index/3"
+        self.mock_relation_type.return_value = 'wsgi-file'
+        self.mock_relation_get.return_value = {
+            'relation-key1': 'relation_value1',
+            'relation-key2': 'relation_value2',
+        }
+
+        charmhelpers.contrib.templating.contexts.juju_state_to_yaml(
+            self.context_path, allow_hyphens_in_keys=False,
+            namespace_separator='__')
+
+        with open(self.context_path, 'r') as context_file:
+            result = yaml.load(context_file.read())
+            self.assertEqual({
+                "charm_dir": "/tmp/charm_dir",
+                "group_code_owner": "webops_deploy",
+                "user_code_runner": "ubunet",
+                "local_unit": "click-index/3",
+                "private_address": "10.1.1.10",
+                "wsgi_file__relation_key1": "relation_value1",
+                "wsgi_file__relation_key2": "relation_value2",
+            }, result)