Merge lp:~verterok/charms/trusty/telegraf/fix-haproxy-format into lp:~ubuntuone-hackers/charms/trusty/telegraf/trunk

[Guillermo Gonzalez]

Fix config rendering: extra_options is now valid YAML (without force string values) and add unittests

- fix config rendering: extra_options is now valid YAML (without force string values)
- added unittests for these changes

[Wes Mason (wesmason)]

Seems legit
https://media.giphy.com/media/xxReQ3GBWVbUc/giphy.gif

review: Approve

=== added file '.bzrignore'
--- .bzrignore	1970-01-01 00:00:00 +0000
+++ .bzrignore	2016-04-01 14:32:37 +0000
@@ -0,0 +1,2 @@
+__pycache__
+.cache

=== modified file 'README.md'
--- README.md	2016-03-30 20:52:57 +0000
+++ README.md	2016-04-01 14:32:37 +0000
@@ -28,25 +28,24 @@
 
     inputs:
         cpu:
-            percpu: 'false'
-            fielddrop: '["time_*"]'
+            percpu: false
+            fielddrop: ["time_*"]
         disk:
-            mount_points: '["/"]'
-            ignore_fs: '["tmpfs", "devtmpfs"]'
+            mount_points: ["/"]
+            ignore_fs: ["tmpfs", "devtmpfs"]
         elasticsearch:
-            local: 'false' 
-            cluster_health: 'true'
+            local: false
+            cluster_health: true
         postgresql:
-            databases: '["foo", "bar"]'
+            databases: ["foo", "bar"]
             tagpass: 
-                db: '["template", "postgres"]'
+                db: ["template", "postgres"]
     outputs:
         influxdb:
-            precision: "ms" 
+            precision: ms
 
 This extra options will only be applied to plugins defined in templates/base_inputs.conf and any other plugins configured via relations.
 
-
 To use a different metrics storage, e.g: graphite. the plugin configuration needs to be set as a base64 string in outputs_config configuration.
 
 For exmaple, save the following config to a file: 

=== modified file 'config.yaml'
--- config.yaml	2016-03-30 17:57:57 +0000
+++ config.yaml	2016-04-01 14:32:37 +0000
@@ -86,23 +86,22 @@
     type: string 
     description: |
         YAML with extra options for out|inputs managed by relations or in the default config.
-        Values must be strings.
         example:
           inputs:
               cpu:
-                  percpu: 'false'
-                  fielddrop: '["time_*"]'
+                  percpu: false
+                  fielddrop: ["time_*"]
               disk:
-                  mount_points: '["/"]'
-                  ignore_fs: '["tmpfs", "devtmpfs"]'
+                  mount_points: ["/"]
+                  ignore_fs: ["tmpfs", "devtmpfs"]
               elasticsearch:
-                  local: 'false' 
-                  cluster_health: 'true'
+                  local: false 
+                  cluster_health: true
               postgresql:
-                  databases: '["foo", "bar"]'
+                  databases: ["foo", "bar"]
                   tagpass: 
-                      db: '["template", "postgres"]'
+                      db: ["template", "postgres"]
           outputs:
               influxdb:
-                  precision: "ms" 
+                  precision: ms
 

=== modified file 'hooks/actions.py'
--- hooks/actions.py	2016-04-01 14:32:37 +0000
+++ hooks/actions.py	2016-04-01 14:32:37 +0000
@@ -93,7 +93,6 @@
 
 def render_config(service_name):
     config = hookenv.config()
-    extra_options = get_extra_options()
     context = config.copy()
     inputs = base64.b64decode(config['inputs_config'])
     outputs = base64.b64decode(config['outputs_config'])
@@ -107,10 +106,7 @@
         context["inputs"] = inputs
     else:
         # use base inputs from charm templates
-        with open('templates/base_inputs.conf', 'r') as fd:
-            context["inputs"] = render_template(
-                fd.read(),
-                {'extra_options': extra_options['inputs']})
+        context["inputs"] = render_base_inputs()
     if outputs:
         context["outputs"] = outputs
     else:
@@ -131,6 +127,15 @@
     render(source='telegraf.conf.tmpl', target=CONFIG_FILE, context=context)
 
 
+def render_base_inputs():
+    extra_options = get_extra_options()
+    # use base inputs from charm templates
+    with open(os.path.join(hookenv.charm_dir(), 'templates/base_inputs.conf'), 'r') as fd:
+        return render_template(
+            fd.read(),
+            {'extra_options': extra_options['inputs']})
+
+
 def get_remote_unit_name():
     types = hookenv.relation_types()
     for rel_type in types:
@@ -144,7 +149,25 @@
     extra_options_raw = hookenv.config()['extra_options']
     extra_opts = yaml.load(extra_options_raw) or {}
     extra_options.update(extra_opts)
-    return extra_options
+    # jsonify value, required as the telegraf config format is similar to raw
+    # json
+    json_vals = {}
+    # kind level
+    for k, v in extra_options.items():
+        json_vals[k] = {}
+        # plugins level
+        for plugin, values in v.items():
+            json_vals[k][plugin] = {}
+            # inner plugin (aka key:value)
+            for key, val in values.items():
+                if key in ('tagpass', 'tagdrop'):
+                    # this is a tagpass/drop, we need to go deeper
+                    json_vals[k][plugin][key] = {}
+                    for tag, tagvalue in val.items():
+                        json_vals[k][plugin][key][tag] = json.dumps(tagvalue)
+                else:
+                    json_vals[k][plugin][key] = json.dumps(val)
+    return json_vals
 
 
 def render_extra_options(kind, name):

=== added directory 'hooks/tests'
=== added file 'hooks/tests/__init__.py'
--- hooks/tests/__init__.py	1970-01-01 00:00:00 +0000
+++ hooks/tests/__init__.py	2016-04-01 14:32:37 +0000
@@ -0,0 +1,6 @@
+import sys
+
+from pkg_resources import resource_filename
+
+# allow importing actions from the hooks directory
+sys.path.append(resource_filename(__name__, '../../hooks'))

=== added file 'hooks/tests/test_actions.py'
--- hooks/tests/test_actions.py	1970-01-01 00:00:00 +0000
+++ hooks/tests/test_actions.py	2016-04-01 14:32:37 +0000
@@ -0,0 +1,49 @@
+"""actions.py tests"""
+import os
+
+import pytest
+
+import actions
+
+
+def test_render_extra_options(monkeypatch):
+    extra_options = """
+    inputs:
+        test:
+            boolean: true
+            string: 10s
+            list: ["a", "b"]
+"""
+    config = {'extra_options': extra_options}
+    monkeypatch.setattr(actions.hookenv, 'config', lambda: config)
+    content = actions.render_extra_options('inputs', 'test')
+    expected = """  boolean = true\n  list = ["a", "b"]\n  string = "10s"\n"""
+    assert sorted(content.split()) == sorted(expected.split())
+
+
+def test_render_base_inputs(monkeypatch):
+    base_inputs_opts = """
+inputs:
+    cpu:
+        foo: 10s
+        percpu: false
+        fielddrop: ["time_*"]
+        tagpass:
+            cpu: ["cpu0"]
+"""
+    config = {'extra_options': base_inputs_opts}
+    monkeypatch.setattr(actions.hookenv, 'config', lambda: config)
+    charm_dir = os.path.join(os.path.dirname(actions.__file__), "../")
+    monkeypatch.setattr(actions.hookenv, 'charm_dir', lambda: charm_dir)
+    content = actions.render_base_inputs()
+    expected = """
+# Read metrics about cpu usage
+[[inputs.cpu]]
+  fielddrop = ["time_*"]
+  foo = "10s"
+  [inputs.cpu.tagpass]
+    cpu = ["cpu0"]
+  percpu = false
+"""
+    assert content[:len(expected)] == expected
+