move plugin groups to under groups key (#44)

vegu · vegu · commit 4de65602e90e · 2019-11-13T15:00:50.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,7 @@
 - fix #62 timeseriesdb plugins crash when `update` is given `None` as a value
 - fix #54 pytest > 3 for testing
 ### Changed
+- plugin groups can now be maintained under an explicit `groups` section in the plugin config (#44)
 - move from `facsimile` to `ctl` for package / release management
 - parse_interval now can handle multiunit strings such as 1m30s
 ### Deprecated
diff --git a/examples/distributed_dns/vaping/config.yml b/examples/distributed_dns/vaping/config.yml
@@ -5,17 +5,18 @@ probes:
     output:
       - zmq_vodka
 
-    public_dns:
-      hosts:
-        - host: 8.8.8.8
-          name: Google
-          color: red
-        - host: 4.2.2.1
-          name: Level(3)
-          color: blue
-        - host: 208.67.222.222
-          name: OpenDNS
-          color: orange
+    groups:
+      - name: public_dns
+        hosts:
+          - host: 8.8.8.8
+            name: Google
+            color: red
+          - host: 4.2.2.1
+            name: Level(3)
+            color: blue
+          - host: 208.67.222.222
+            name: OpenDNS
+            color: orange
 
 plugins:
   - name: std_fping
diff --git a/examples/distributed_shared_graph/vaping-1/config.yml b/examples/distributed_shared_graph/vaping-1/config.yml
@@ -4,9 +4,10 @@ probes:
     output:
       - zmq_vodka
 
-    public_dns:
-      hosts:
-        - host: 1.1.1.1
+    groups:
+      - name: public_dns
+        hosts:
+          - host: 1.1.1.1
 
 plugins:
   - name: std_fping
diff --git a/examples/distributed_shared_graph/vaping-2/config.yml b/examples/distributed_shared_graph/vaping-2/config.yml
@@ -4,9 +4,10 @@ probes:
     output:
       - zmq_vodka
 
-    public_dns:
-      hosts:
-        - host: 8.8.8.8
+    groups:
+      - name: public_dns
+        hosts:
+          - host: 8.8.8.8
 
 plugins:
   - name: std_fping
diff --git a/examples/graphite/config.yml b/examples/graphite/config.yml
@@ -4,17 +4,18 @@ probes:
     output:
       - graphite_avg
 
-    public_dns:
-      hosts:
-        - host: 8.8.8.8
-          name: Google
-          color: red
-        - host: 4.2.2.1
-          name: Level3
-          color: blue
-        - host: 208.67.222.222
-          name: OpenDNS
-          color: orange
+    groups:
+      - name: public_dns
+        hosts:
+          - host: 8.8.8.8
+            name: Google
+            color: red
+          - host: 4.2.2.1
+            name: Level3
+            color: blue
+          - host: 208.67.222.222
+            name: OpenDNS
+            color: orange
 
 plugins:
   - name: std_fping
diff --git a/examples/rrdtool/config.yaml b/examples/rrdtool/config.yaml
@@ -4,17 +4,18 @@ probes:
     output:
       - rrd_avg
 
-    public_dns:
-      hosts:
-        - host: 8.8.8.8
-          name: Google
-          color: red
-        - host: 4.2.2.1
-          name: Level(3)
-          color: blue
-        - host: 208.67.222.222
-          name: OpenDNS
-          color: orange
+    groups:
+      - name: public_dns
+        hosts:
+          - host: 8.8.8.8
+            name: Google
+            color: red
+          - host: 4.2.2.1
+            name: Level(3)
+            color: blue
+          - host: 208.67.222.222
+            name: OpenDNS
+            color: orange
 
 plugins:
   - name: std_fping
diff --git a/examples/standalone_dns/config.yml b/examples/standalone_dns/config.yml
@@ -5,17 +5,18 @@ probes:
     output:
       - vodka
 
-    public_dns:
-      hosts:
-        - host: 8.8.8.8
-          name: Google
-          color: red
-        - host: 4.2.2.1
-          name: Level(3)
-          color: blue
-        - host: 208.67.222.222
-          name: OpenDNS
-          color: orange
+    groups:
+      - name: public_dns
+        hosts:
+          - host: 8.8.8.8
+            name: Google
+            color: red
+          - host: 4.2.2.1
+            name: Level(3)
+            color: blue
+          - host: 208.67.222.222
+            name: OpenDNS
+            color: orange
 
 plugins:
   - name: std_fping
diff --git a/examples/whisper/config.yaml b/examples/whisper/config.yaml
@@ -4,17 +4,18 @@ probes:
     output:
       - whisper_avg
 
-    public_dns:
-      hosts:
-        - host: 8.8.8.8
-          name: Google
-          color: red
-        - host: 4.2.2.1
-          name: Level(3)
-          color: blue
-        - host: 208.67.222.222
-          name: OpenDNS
-          color: orange
+    groups:
+      - name: public_dns
+        hosts:
+          - host: 8.8.8.8
+            name: Google
+            color: red
+          - host: 4.2.2.1
+            name: Level(3)
+            color: blue
+          - host: 208.67.222.222
+            name: OpenDNS
+            color: orange
 
 plugins:
   - name: std_fping
diff --git a/tests/test_config.py b/tests/test_config.py
@@ -3,6 +3,7 @@
 
 import vaping
 from vaping.config import parse_interval
+from vaping import plugin
 
 
 def test_parse_interval():
@@ -31,3 +32,67 @@ def test_probe_plugin_name(config_dir):
     with pytest.raises(ValueError) as excinfo:
         vaping.daemon.Vaping(config_dir=config_dir)
     assert "probes may not share names with plugins" in str(excinfo.value)
+
+
+def test_plugin_legacy_groups():
+
+    """
+    test legacy plugin groups
+    TODO: remove with vaping 2.0
+    """
+
+    probe = plugin.get_probe({
+        "type" : "fping",
+        "name" : "probe_b",
+        "interval" : "3s",
+        "dns": {
+            "hosts": [{
+                "host" : "1.1.1.1",
+                "name" : "Cloudflare"
+            }]
+        }
+    }, {})
+
+    expected = {
+        "dns": {
+            "hosts": [{
+                "host" : "1.1.1.1",
+                "name": "Cloudflare"
+            }]
+        }
+    }
+
+    assert probe.groups == expected
+
+def test_plugin_groups():
+
+    """
+    test plugin groups as per #44 implementation
+    """
+
+    probe = plugin.get_probe({
+        "type" : "fping",
+        "name" : "probe_c",
+        "interval" : "3s",
+        "groups": [{
+            "name": "dns",
+            "hosts": [{
+                "host" : "1.1.1.1",
+                "name" : "Cloudflare"
+            }]
+        }]
+    }, {})
+
+
+    expected = {
+        "dns": {
+            "name": "dns",
+            "hosts": [{
+                "host" : "1.1.1.1",
+                "name": "Cloudflare"
+            }]
+        }
+    }
+
+    assert probe.groups == expected
+
diff --git a/tests/test_vodka.py b/tests/test_vodka.py
@@ -12,6 +12,9 @@ def test_init(this_dir):
 
 
 def test_probe_to_graphsrv():
+
+    # vodka setup with single group plugin
+
     probe = plugin.get_probe({
         "type" : "fping_mtr",
         "name" : "probe_a",
@@ -24,6 +27,10 @@ def test_probe_to_graphsrv():
 
     assert group["targets"] == {"1.1.1.1":{"host":"1.1.1.1"}}
 
+    # vodka setup with legacy plugin groups (before implementation
+    # of #44)
+    # TODO: remove with vaping 2.0
+
     probe = plugin.get_probe({
         "type" : "fping",
         "name" : "probe_b",
@@ -39,3 +46,23 @@ def test_probe_to_graphsrv():
     group = graphsrv.group.groups.get("probe_b").get("dns")
 
     assert group["targets"] == {"1.1.1.1":{"host":"1.1.1.1", "name":"Cloudflare"}}
+
+    # vodka setup with plugin group implementation as
+    # per #44
+
+    probe = plugin.get_probe({
+        "type" : "fping",
+        "name" : "probe_c",
+        "interval" : "3s",
+        "groups": [{
+            "name": "dns",
+            "hosts": [{
+                "host" : "1.1.1.1",
+                "name" : "Cloudflare"
+            }]
+        }]
+    }, {})
+    probe_to_graphsrv(probe)
+    group = graphsrv.group.groups.get("probe_c").get("dns")
+
+    assert group["targets"] == {"1.1.1.1":{"host":"1.1.1.1", "name":"Cloudflare"}}
diff --git a/vaping/plugins/__init__.py b/vaping/plugins/__init__.py
@@ -1,9 +1,10 @@
+import collections
+import os
 import abc
 import copy
 import datetime
 import logging
 import munge
-import os
 
 from future.utils import with_metaclass
 from vaping.config import parse_interval
@@ -28,6 +29,32 @@ class PluginBase(vaping.io.Thread):
     Calls `self.on_start()` and `self.on_stop()` before and after running in
     case any connections need to be created or cleaned up.
     """
+
+    @property
+    def groups(self):
+
+        """
+        `dict` - group configurations keyed by name
+        """
+
+        group_config = {}
+
+        # legacy way of threating any dict as a potential
+        # group config (pre #44 implementation)
+        # supported until vaping 2.0
+
+        for k,v in list(self.config.items()):
+            if isinstance(v, collections.Mapping):
+                group_config[k] = v
+
+        # explicit groups object (#44 implementation)
+
+        for _group_config in self.config.get("groups",[]):
+            group_config[_group_config["name"]] = _group_config
+
+        return group_config
+
+
     def init(self):
         """
         called after the plugin is initialized, plugin may define this for any
diff --git a/vaping/plugins/command.py b/vaping/plugins/command.py
@@ -37,10 +37,8 @@ def init(self):
         if 'command' not in self.config:
             raise ValueError('command is required')
 
-        for k, v in list(self.config.items()):
-            # dict means it's a group - FIXME explicit groups
-            if isinstance(v, collections.Mapping):
-                self.hosts = v['hosts']
+        for name, group_config in list(self.groups.items()):
+            self.hosts.extend(group_config.get("hosts",[]))
 
         self.command = self.config['command']
 
diff --git a/vaping/plugins/fping.py b/vaping/plugins/fping.py
@@ -160,10 +160,9 @@ class FPing(FPingBase):
 
     def init(self):
         self.hosts = []
-        for key, value in list(self.config.items()):
-            # dict means it's a group
-            if isinstance(value, collections.Mapping):
-                self.hosts.extend(value['hosts'])
+
+        for name, group_config in list(self.groups.items()):
+            self.hosts.extend(group_config.get("hosts",[]))
 
     def probe(self):
         msg = self.new_message()
diff --git a/vaping/plugins/vodka.py b/vaping/plugins/vodka.py
