Merge lp:~gnuoy/charm-helpers/nrpe-service-functions into lp:charm-helpers

[Liam Young]

Add functions to simplify setup of nrpe service checks

[James Page (james-page)]

review: Approve

=== modified file 'charmhelpers/contrib/charmsupport/nrpe.py'
--- charmhelpers/contrib/charmsupport/nrpe.py	2014-11-26 14:09:26 +0000
+++ charmhelpers/contrib/charmsupport/nrpe.py	2015-01-12 10:12:45 +0000
@@ -18,6 +18,7 @@
     log,
     relation_ids,
     relation_set,
+    relations_of_type,
 )
 
 from charmhelpers.core.host import service
@@ -233,3 +234,64 @@
 
         for rid in relation_ids("local-monitors"):
             relation_set(relation_id=rid, monitors=yaml.dump(monitors))
+
+
+def get_nagios_hostcontext(relation_name='nrpe-external-master'):
+    """
+    Query relation with nrpe subordinate, return the nagios_host_context
+
+    :param str relation_name: Name of relation nrpe sub joined to
+    """
+    for rel in relations_of_type(relation_name):
+        if 'nagios_hostname' in rel:
+            return rel['nagios_host_context']
+
+
+def get_nagios_unit_name(relation_name='nrpe-external-master'):
+    """
+    Return the nagios unit name prepended with host_context if needed
+
+    :param str relation_name: Name of relation nrpe sub joined to
+    """
+    host_context = get_nagios_hostcontext(relation_name)
+    if host_context:
+        unit = "%s:%s" % (host_context, local_unit())
+    else:
+        unit = local_unit()
+    return unit
+
+
+def add_init_service_checks(nrpe, services, unit_name):
+    """
+    Add checks for each service in list
+
+    :param NRPE nrpe: NRPE object to add check to
+    :param list services: List of services to check
+    :param str unit_name: Unit name to use in check description
+    """
+    for svc in services:
+        upstart_init = '/etc/init/%s.conf' % svc
+        sysv_init = '/etc/init.d/%s' % svc
+        if os.path.exists(upstart_init):
+            nrpe.add_check(
+                shortname=svc,
+                description='process check {%s}' % unit_name,
+                check_cmd='check_upstart_job %s' % svc
+            )
+        elif os.path.exists(sysv_init):
+            cronpath = '/etc/cron.d/nagios-service-check-%s' % svc
+            cron_file = ('*/5 * * * * root '
+                         '/usr/local/lib/nagios/plugins/check_exit_status.pl '
+                         '-s /etc/init.d/%s status > '
+                         '/var/lib/nagios/service-check-%s.txt\n' % (svc,
+                                                                     svc)
+                         )
+            f = open(cronpath, 'w')
+            f.write(cron_file)
+            f.close()
+            nrpe.add_check(
+                shortname=svc,
+                description='process check {%s}' % unit_name,
+                check_cmd='check_status_file.py -f '
+                          '/var/lib/nagios/service-check-%s.txt' % svc,
+            )

=== modified file 'tests/contrib/charmsupport/test_nrpe.py'
--- tests/contrib/charmsupport/test_nrpe.py	2014-11-26 14:18:27 +0000
+++ tests/contrib/charmsupport/test_nrpe.py	2015-01-12 10:12:45 +0000
@@ -24,6 +24,7 @@
         'call': {'object': subprocess},
         'relation_ids': {'object': nrpe},
         'relation_set': {'object': nrpe},
+        'relations_of_type': {'object': nrpe},
     }
 
     def setUp(self):
@@ -241,3 +242,54 @@
 
         self.check_call_counts(exists=1, call=1)
         self.assertEqual(command, self.patched['call'].call_args[0][0])
+
+
+class NRPEMiscTestCase(NRPEBaseTestCase):
+    def test_get_nagios_hostcontext(self):
+        rel_info = {
+            'nagios_hostname': 'bob-openstack-dashboard-0',
+            'private-address': '10.5.3.103',
+            '__unit__': u'dashboard-nrpe/1',
+            '__relid__': u'nrpe-external-master:2',
+            'nagios_host_context': u'bob',
+        }
+        self.patched['relations_of_type'].return_value = [rel_info]
+        self.assertEqual(nrpe.get_nagios_hostcontext(), 'bob')
+
+    def test_get_nagios_unit_name(self):
+        rel_info = {
+            'nagios_hostname': 'bob-openstack-dashboard-0',
+            'private-address': '10.5.3.103',
+            '__unit__': u'dashboard-nrpe/1',
+            '__relid__': u'nrpe-external-master:2',
+            'nagios_host_context': u'bob',
+        }
+        self.patched['relations_of_type'].return_value = [rel_info]
+        self.assertEqual(nrpe.get_nagios_unit_name(), 'bob:testunit')
+
+    def test_get_nagios_unit_name_no_hc(self):
+        self.patched['relations_of_type'].return_value = []
+        self.assertEqual(nrpe.get_nagios_unit_name(), 'testunit')
+
+    def test_add_init_service_checks(self):
+        def _exists(init_file):
+            files = ['/etc/init/apache2.conf',
+                     '/usr/lib/nagios/plugins/check_upstart_job',
+                     '/etc/init.d/haproxy',
+                     '/usr/lib/nagios/plugins/check_status_file.py',
+                     ]
+            return init_file in files
+
+        self.patched['exists'].side_effect = _exists
+        bill = nrpe.NRPE()
+        services = ['apache2', 'haproxy']
+        nrpe.add_init_service_checks(bill, services, 'testunit')
+        expect_cmds = {
+            'apache2': '/usr/lib/nagios/plugins/check_upstart_job apache2',
+            'haproxy': '/usr/lib/nagios/plugins/check_status_file.py -f '
+                       '/var/lib/nagios/service-check-haproxy.txt',
+        }
+        self.assertEqual(bill.checks[0].shortname, 'apache2')
+        self.assertEqual(bill.checks[0].check_cmd, expect_cmds['apache2'])
+        self.assertEqual(bill.checks[1].shortname, 'haproxy')
+        self.assertEqual(bill.checks[1].check_cmd, expect_cmds['haproxy'])