Merge lp:~martin-hilton/charms/trusty/redis/000-nrpe-external-master into lp:~juju-gui/charms/trusty/redis/trunk

[Martin Hilton]

Add an nrpe-external-master relation

[Uros Jovanovic (uros-jovanovic)]

LGTM

I assume check_redis.sh has been tested ...

[Francesco Banconi (frankban)]

Looks good.

review: Approve

=== modified file 'config.yaml'
--- config.yaml	2015-07-20 11:52:19 +0000
+++ config.yaml	2017-11-07 11:14:30 +0000
@@ -89,3 +89,19 @@
       for memory-intensive tasks is increased, but there is more risk of memory
       overload. This option is ignored when the charm is deployed to a local
       environment.
+  nagios_context:
+    default: "juju"
+    type: string
+    description: |
+      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
+      If you're running multiple environments with the same services in them
+      this allows you to differentiate between them.
+  nagios_servicegroups:
+    default: ""
+    type: string
+    description: |
+      A comma-separated list of nagios servicegroups.
+      If left empty, the nagios_context will be used as the servicegroup

=== added directory 'files'
=== added file 'files/check_redis.sh'
--- files/check_redis.sh	1970-01-01 00:00:00 +0000
+++ files/check_redis.sh	2017-11-07 11:14:30 +0000
@@ -0,0 +1,7 @@
+#!/bin/sh
+
+# Check the redis server is running.
+if redis-cli -h $1 -p $2 ping; then
+	exit 0
+fi
+exit 2

=== added symlink 'hooks/nrpe-external-master-relation-changed'
=== target is u'generic-hook'
=== added symlink 'hooks/nrpe-external-master-relation-joined'
=== target is u'generic-hook'
=== modified file 'hooks/relations.py'
--- hooks/relations.py	2015-05-25 10:42:20 +0000
+++ hooks/relations.py	2017-11-07 11:14:30 +0000
@@ -40,3 +40,13 @@
     name = 'slave'
     interface = 'redis'
     required_keys = ['hostname', 'port']
+
+
+class NRPERelation(helpers.RelationContext):
+    """Relation data provider feeding NRPE service configuration."""
+
+    name = 'nrpe-external-master'
+    interface = 'nrpe-external-master'
+    required_keys = [
+        "nagios_hostname",
+        "nagios_host_context"]

=== modified file 'hooks/services.py'
--- hooks/services.py	2015-07-17 12:29:09 +0000
+++ hooks/services.py	2017-11-07 11:14:30 +0000
@@ -42,6 +42,8 @@
     master_relation = relations.MasterRelation()
     slave_relation = relations.SlaveRelation()
     slave_relation_ready = slave_relation.is_ready()
+    nrpe_relation = relations.NRPERelation()
+    nrpe_relation_ready = nrpe_relation.is_ready()
 
     # Set up the service manager.
     manager = base.ServiceManager([
@@ -100,6 +102,24 @@
 
             # Callables called when it is time to stop the service.
             'stop': [service_stop],
-        }
+        },
+        {
+            # The name of the nrpe "service".
+            'service': 'nrpe',
+
+            # Data (contexts) required to configure the service.
+            'required_data': [config, nrpe_relation_ready],
+
+            # Callables called when required data is ready.
+            'data_ready': [
+                serviceutils.install_redis_check(config),
+            ],
+
+            # Callables called when it is time to start the service.
+            'start': [],
+
+            # Callables called when it is time to stop the service.
+            'stop': [],
+        },
     ])
     manager.manage()

=== modified file 'hooks/serviceutils.py'
--- hooks/serviceutils.py	2015-07-17 12:49:32 +0000
+++ hooks/serviceutils.py	2017-11-07 11:14:30 +0000
@@ -7,7 +7,11 @@
 registering callables in the services framework manager.
 """
 
+import os
+import shutil
+
 from charmhelpers import fetch
+from charmhelpers.contrib.charmsupport import nrpe
 from charmhelpers.core import (
     hookenv,
     host,
@@ -157,3 +161,28 @@
         for relation_id in hookenv.relation_ids(name):
             hookutils.log('Updating data for relation {}.'.format(name))
             hookenv.relation_set(relation_id, relation.provide_data())
+
+
+_nagios_plugin_path = '/usr/local/lib/nagios/plugins'
+
+def install_redis_check(config):
+    """Write redis NRPE check."""
+    def callback(service_name):
+        path = _nagios_plugin_path
+        host.mkdir(path)
+        src = os.path.join(hookenv.charm_dir(), 'files', 'check_redis.sh')
+        check_file = os.path.join(path, 'check_redis.sh')
+        shutil.copy(src, check_file)
+        check = '{} {} {}'.format(
+            check_file,
+            hookenv.unit_private_ip(),
+            config["port"])
+
+        nrpe_ = nrpe.NRPE()
+        nrpe_.add_check(
+            shortname='redis',
+            description='Check Redis service',
+            check_cmd=check,
+        )
+        nrpe_.write()
+    return callback

=== modified file 'metadata.yaml'
--- metadata.yaml	2015-05-25 09:08:47 +0000
+++ metadata.yaml	2017-11-07 11:14:30 +0000
@@ -16,6 +16,9 @@
     interface: redis
   db:
     interface: redis
+  nrpe-external-master:
+    interface: nrpe-external-master
+    scope: container
 requires:
   slave:
     interface: redis

=== modified file 'unit_tests/test_relations.py'
--- unit_tests/test_relations.py	2015-05-25 15:34:53 +0000
+++ unit_tests/test_relations.py	2017-11-07 11:14:30 +0000
@@ -52,3 +52,19 @@
         }
         self.assertEqual(expected_data, data)
         mock_unit_get.assert_called_once_with('private-address')
+
+
+class TestNRPERelation(unittest.TestCase):
+
+    def setUp(self):
+        relation_ids_path = 'charmhelpers.core.hookenv.relation_ids'
+        with mock.patch(relation_ids_path, mock.MagicMock()):
+            self.relation = relations.NRPERelation()
+
+    def test_relation(self):
+        self.assertEqual(self.relation.name, 'nrpe-external-master')
+        self.assertEqual(self.relation.interface, 'nrpe-external-master')
+        self.assertEqual(
+            self.relation.required_keys,
+            ["nagios_hostname",
+             "nagios_host_context"])

=== modified file 'unit_tests/test_services.py'
--- unit_tests/test_services.py	2015-05-25 15:34:53 +0000
+++ unit_tests/test_services.py	2017-11-07 11:14:30 +0000
@@ -25,5 +25,6 @@
         self.assertEqual(1, mock_manager.call_count)
         definitions = mock_manager.call_args[0][0]
         service_names = [i['service'] for i in definitions]
-        self.assertEqual(['redis-master', 'redis-slave'], service_names)
+        self.assertEqual(['redis-master', 'redis-slave', 'nrpe'],
+                         service_names)
         mock_config.assert_called_once_with()

=== modified file 'unit_tests/test_serviceutils.py'
--- unit_tests/test_serviceutils.py	2015-07-17 12:53:23 +0000
+++ unit_tests/test_serviceutils.py	2017-11-07 11:14:30 +0000
@@ -3,7 +3,10 @@
 
 import contextlib
 from pkg_resources import resource_filename
+import os
+import shutil
 import sys
+import tempfile
 import unittest
 
 import mock
@@ -494,3 +497,38 @@
         callback('service')
         mock_log.assert_called_once_with('Setting up sysctl state.')
         mock_write_sysctl.assert_called_once_with(overcommit_memory=False)
+
+
+class TestInstallRedisCheck(unittest.TestCase):
+
+    def setUp(self):
+        self.charm_dir = tempfile.mkdtemp()
+        self.dest = tempfile.mkdtemp()
+        self.old_nagios_plugin_path = serviceutils._nagios_plugin_path
+        serviceutils._nagios_plugin_path = self.dest
+
+    def tearDown(self):
+        serviceutils._nagios_plugin_path = self.old_nagios_plugin_path
+        shutil.rmtree(self.dest)
+        shutil.rmtree(self.charm_dir)
+
+    @mock.patch('charmhelpers.contrib.charmsupport.nrpe.NRPE')
+    @mock.patch('charmhelpers.core.hookenv.charm_dir')
+    @mock.patch('charmhelpers.core.hookenv.unit_private_ip')
+    @mock.patch('charmhelpers.core.host.mkdir')
+    def test_install_redis_check(self, mock_mkdir, mock_unit_private_ip,
+                                 mock_charm_dir, mock_nrpe):
+        files_path = os.path.join(self.charm_dir, 'files')
+        os.makedirs(files_path)
+        with open(os.path.join(files_path, 'check_redis.sh'), 'w') as f:
+            f.write('TEST1234')
+        mock_charm_dir.return_value = self.charm_dir
+        mock_unit_private_ip.return_value = '127.0.0.1'
+        serviceutils.install_redis_check({"port": 1111})("")
+        with open(os.path.join(self.dest, 'check_redis.sh')) as f:
+            self.assertEqual(f.read(), 'TEST1234')
+        mock_nrpe().add_check.assert_called_with(
+            shortname='redis',
+            description='Check Redis service',
+            check_cmd='{}/check_redis.sh 127.0.0.1 1111'.format(self.dest))
+        mock_nrpe().write.assert_called_with()