Merge lp:~sidnei/charmsupport/nrpe-notify-monitors into lp:~ubuntuone-pqm-team/charmsupport/trunk

[Sidnei da Silva]

Move notification of local-monitors to nrpe.write()

Move notification of local-monitors to nrpe.write()

[Anthony Lenton (elachuni)]

Neat!

review: Approve

=== modified file 'charmsupport/hookenv.py'
--- charmsupport/hookenv.py	2013-03-08 16:22:41 +0000
+++ charmsupport/hookenv.py	2013-03-13 15:44:27 +0000
@@ -104,6 +104,15 @@
     return Serializable(config_data)
 
 
+def relation_set(relation_id=None, **kwargs):
+    relation_cmd_line = ['relation-set']
+    if relation_id is not None:
+        relation_cmd_line.extend(('-r', relation_id))
+    for k, v in kwargs.items():
+        relation_cmd_line.append('{}={}'.format(k, v))
+    subprocess.check_call(relation_cmd_line)
+
+
 def relation_ids(reltype=None):
     "A list of relation_ids"
     reltype = reltype or relation_type()

=== modified file 'charmsupport/nrpe.py'
--- charmsupport/nrpe.py	2013-03-12 19:22:11 +0000
+++ charmsupport/nrpe.py	2013-03-13 15:44:27 +0000
@@ -10,11 +10,13 @@
 import os
 import re
 import shlex
-
-from hookenv import config, local_unit, log
-
-# This module adds compatibility with the nrpe_external_master
-# subordinate charm. To use it in your charm:
+import yaml
+
+from hookenv import config, local_unit, log, relation_ids, relation_set
+from host import service
+
+# This module adds compatibility with the nrpe-external-master and plain nrpe
+# subordinate charms. To use it in your charm:
 #
 # 1. Update metadata.yaml
 #
@@ -24,13 +26,22 @@
 #       interface: nrpe-external-master
 #       scope: container
 #
+#   and/or
+#
+#   provides:
+#     (...)
+#     local-monitors:
+#       interface: local-monitors
+#       scope: container
+
+#
 # 2. Add the following to config.yaml
 #
 #    nagios_context:
 #      default: "juju"
 #      type: string
 #      description: |
-#        Used by the nrpe-external-master subordinate charm.
+#        Used by the nrpe subordinate charms.
 #        A string that will be prepended to instance name to set the host name
 #        in nagios. So for instance the hostname would be something like:
 #            juju-myservice-0
@@ -60,10 +71,15 @@
 #    def config_changed():
 #        (...)
 #        update_nrpe_config()
+#
 #    def nrpe_external_master_relation_changed():
 #        update_nrpe_config()
 #
+#    def local_monitors_relation_changed():
+#        update_nrpe_config()
+#
 # 5. ln -s hooks.py nrpe-external-master-relation-changed
+#    ln -s hooks.py local-monitors-relation-changed
 
 
 class CheckException(Exception):
@@ -81,7 +97,7 @@
     host_name                       {nagios_hostname}
     service_description             {nagios_hostname}[{shortname}] """
                         """{description}
-    check_command                   check_nrpe!check_{shortname}
+    check_command                   check_nrpe!{command}
     servicegroups                   {nagios_servicegroup}
 }}
 """)
@@ -93,6 +109,7 @@
             raise CheckException("shortname must match {}".format(
                 Check.shortname_re))
         self.shortname = shortname
+        self.command = "check_{}".format(shortname)
         # Note: a set of invalid characters is defined by the
         # Nagios server config
         # The default is: illegal_object_name_chars=`~!$%^&*"|'<>?,()=
@@ -117,12 +134,12 @@
         return ''
 
     def write(self, nagios_context, hostname):
-        nrpe_check_file = '/etc/nagios/nrpe.d/check_{}.cfg'.format(
-            self.shortname)
+        nrpe_check_file = '/etc/nagios/nrpe.d/{}.cfg'.format(
+            self.command)
         with open(nrpe_check_file, 'w') as nrpe_check_config:
             nrpe_check_config.write("# check {}\n".format(self.shortname))
-            nrpe_check_config.write("command[check_{}]={}\n".format(
-                self.shortname, self.check_cmd))
+            nrpe_check_config.write("command[{}]={}\n".format(
+                self.command, self.check_cmd))
 
         if not os.path.exists(NRPE.nagios_exportdir):
             log('Not writing service config as {} is not accessible'.format(
@@ -132,7 +149,7 @@
 
     def write_service_config(self, nagios_context, hostname):
         for f in os.listdir(NRPE.nagios_exportdir):
-            if re.search('.*check_{}.cfg'.format(self.shortname), f):
+            if re.search('.*{}.cfg'.format(self.command), f):
                 os.remove(os.path.join(NRPE.nagios_exportdir, f))
 
         templ_vars = {
@@ -140,10 +157,11 @@
             'nagios_servicegroup': nagios_context,
             'description': self.description,
             'shortname': self.shortname,
+            'command': self.command,
             }
         nrpe_service_text = Check.service_template.format(**templ_vars)
-        nrpe_service_file = '{}/service__{}_check_{}.cfg'.format(
-            NRPE.nagios_exportdir, hostname, self.shortname)
+        nrpe_service_file = '{}/service__{}_{}.cfg'.format(
+            NRPE.nagios_exportdir, hostname, self.command)
         with open(nrpe_service_file, 'w') as nrpe_service_config:
             nrpe_service_config.write(str(nrpe_service_text))
 
@@ -179,8 +197,15 @@
             os.mkdir(NRPE.nagios_logdir)
             os.chown(NRPE.nagios_logdir, nagios_uid, nagios_gid)
 
+        nrpe_monitors = {}
+        monitors = {"monitors": {"remote": {"nrpe": nrpe_monitors}}}
         for nrpecheck in self.checks:
             nrpecheck.write(self.nagios_context, self.hostname)
-
-        if os.path.isfile('/etc/init.d/nagios-nrpe-server'):
-            subprocess.call(['service', 'nagios-nrpe-server', 'reload'])
+            nrpe_monitors[nrpecheck.shortname] = {
+                "command": nrpecheck.command,
+                }
+
+        service('nagios-nrpe-server', 'restart')
+
+        for rid in relation_ids("local-monitors"):
+            relation_set(relation_id=rid, monitors=yaml.dump(monitors))

=== modified file 'tests/test_nrpe.py'
--- tests/test_nrpe.py	2013-03-12 20:22:13 +0000
+++ tests/test_nrpe.py	2013-03-13 15:44:27 +0000
@@ -1,5 +1,7 @@
 import os
+import yaml
 import subprocess
+
 from testtools import TestCase
 from mock import patch, call
 
@@ -20,6 +22,8 @@
         'open': {'object': nrpe, 'create': True},
         'isfile': {'object': os.path},
         'call': {'object': subprocess},
+        'relation_ids': {'object': nrpe},
+        'relation_set': {'object': nrpe},
     }
 
     def setUp(self):
@@ -68,31 +72,29 @@
     def test_write_no_checker(self):
         self.patched['config'].return_value = {'nagios_context': 'test'}
         self.patched['exists'].return_value = True
-        self.patched['isfile'].return_value = False
         checker = nrpe.NRPE()
 
         self.assertEqual(None, checker.write())
 
-        self.check_call_counts(config=1, getpwnam=1, getgrnam=1, isfile=1,
-                               exists=1)
+        self.check_call_counts(config=1, getpwnam=1, getgrnam=1, exists=2)
 
     def test_write_restarts_service(self):
         self.patched['config'].return_value = {'nagios_context': 'test'}
         self.patched['exists'].return_value = True
-        self.patched['isfile'].return_value = True
         checker = nrpe.NRPE()
 
         self.assertEqual(None, checker.write())
 
-        expected = ['service', 'nagios-nrpe-server', 'reload']
+        expected = ['initctl', 'nagios-nrpe-server', 'restart']
         self.assertEqual(expected, self.patched['call'].call_args[0][0])
-        self.check_call_counts(config=1, getpwnam=1, getgrnam=1, isfile=1,
-                               exists=1, call=1)
+        self.check_call_counts(config=1, getpwnam=1, getgrnam=1,
+                               exists=2, call=1)
 
     def test_update_nrpe(self):
         self.patched['config'].return_value = {'nagios_context': 'a'}
         self.patched['exists'].return_value = True
-        self.patched['isfile'].return_value = False
+        self.patched['relation_ids'].return_value = ['local-monitors:1']
+
         checker = nrpe.NRPE()
         checker.add_check(shortname="myservice",
                           description="Check MyService",
@@ -128,8 +130,16 @@
         ]
         actual = [x[0][0] for x in outfile.write.call_args_list]
         self.assertEqual(expected, actual)
-        self.check_call_counts(config=1, getpwnam=1, getgrnam=1, isfile=1,
-                               exists=3, open=2, listdir=1)
+
+        nrpe_monitors = {'myservice':
+                         {'command': 'check_myservice'}}
+        monitors = yaml.dump(
+            {"monitors": {"remote": {"nrpe": nrpe_monitors}}})
+        self.patched['relation_set'].assert_called_once_with(
+            relation_id="local-monitors:1", monitors=monitors)
+        self.check_call_counts(config=1, getpwnam=1, getgrnam=1,
+                               exists=4, open=2, listdir=1,
+                               relation_ids=1, relation_set=1)
 
 
 class NRPECheckTestCase(NRPEBaseTestCase):