include timestamp into json output for zabbix; add test for zabbix

Author: smoors

lib/vsc/utils/nagios.py

@@ -277,18 +277,18 @@ def report_and_exit(self):
             unknown_exit("%s nagios gzipped JSON file unavailable (%s)" % (self.header, self.filename))
 
         (timestamp, ((nagios_exit_code, nagios_exit_string), nagios_message)) = nagios_cache.load('nagios')
+        self.print_report_and_exit(timestamp, nagios_exit_code, nagios_exit_string, nagios_message)
 
+
+    def print_report_and_exit(self, timestamp, nagios_exit_code, nagios_exit_string, nagios_message):
+        """Print the nagios report (if the data is not too old) and exit"""
         if self.threshold <= 0 or time.time() - timestamp < self.threshold:
             self.log.info("Nagios check cache file %s contents delivered: %s", self.filename, nagios_message)
-            self.print_report(nagios_exit_string, nagios_message)
+            print("%s %s" % (nagios_exit_string, nagios_message))
             sys.exit(nagios_exit_code)
         else:
             unknown_exit("%s gzipped JSON file too old (timestamp = %s)" % (self.header, time.ctime(timestamp)))
 
-    def print_report(self, nagios_exit_string, nagios_message):
-        """Print the nagios report"""
-        print("%s %s" % (nagios_exit_string, nagios_message))
-
     def cache(self, nagios_exit, nagios_message):
         """Store the result in the cache file with a timestamp.
 

lib/vsc/utils/zabbix.py

@@ -33,12 +33,14 @@
 from __future__ import print_function
 
 import json
-
+import sys
 
 from vsc.utils.nagios import SimpleNagios, NagiosReporter
 
 
 class SimpleZabbix(SimpleNagios):
+    """Class to allow easy interaction with Zabbix related code"""
+
     def __init__(self, **kwargs):
         """Initialise message and perfdata"""
         super(SimpleZabbix, self)._init(reporterclass=ZabbixReporter, **kwargs)
@@ -52,7 +54,9 @@ def __str__(self):
 class ZabbixReporter(NagiosReporter):
     """Reporting class for Zabbix reports"""
 
-    def print_report(self, nagios_exit_string, nagios_message):
-        """Print the nagios report"""
-        print(nagios_message)
+    def print_report_and_exit(self, timestamp, nagios_exit_code, nagios_exit_string, nagios_message):
+        """Print the zabbix report and exit"""
+        json.dump([timestamp, nagios_exit_string, json.loads(nagios_message)], sys.stdout)
+        self.log.info("Zabbix check cache file %s contents delivered: %s", self.filename, nagios_message)
+        sys.exit(nagios_exit_code)
 

test/zabbix.py

@@ -0,0 +1,93 @@
+#
+# Copyright 2012-2022 Ghent University
+#
+# This file is part of vsc-utils,
+# originally created by the HPC team of Ghent University (http://ugent.be/hpc/en),
+# with support of Ghent University (http://ugent.be/hpc),
+# the Flemish Supercomputer Centre (VSC) (https://www.vscentrum.be),
+# the Flemish Research Foundation (FWO) (http://www.fwo.be/en)
+# and the Department of Economy, Science and Innovation (EWI) (http://www.ewi-vlaanderen.be/en).
+#
+# https://github.com/hpcugent/vsc-utils
+#
+# vsc-utils is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Library General Public License as
+# published by the Free Software Foundation, either version 2 of
+# the License, or (at your option) any later version.
+#
+# vsc-utils is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Library General Public License for more details.
+#
+# You should have received a copy of the GNU Library General Public License
+# along with vsc-utils. If not, see <http://www.gnu.org/licenses/>.
+#
+"""
+Tests for the vsc.utils.zabbix module.
+
+@author: Andy Georges (Ghent University)
+@author: Samuel Moors (Vrije Universiteit Brussel)
+"""
+import json
+import os
+import tempfile
+import time
+import sys
+import random
+import string
+from pwd import getpwuid
+
+from vsc.install.testing import TestCase
+
+from vsc.utils.zabbix import ZabbixReporter, SimpleZabbix
+from vsc.utils.nagios import NAGIOS_EXIT_OK, NAGIOS_EXIT_WARNING, NAGIOS_EXIT_CRITICAL, NAGIOS_EXIT_UNKNOWN
+from vsc.utils.py2vs3 import StringIO
+
+
+class TestZabbix(TestCase):
+    """Test for the zabbix reporter class."""
+
+    def setUp(self):
+        user = getpwuid(os.getuid())
+        self.nagios_user = user.pw_name
+        super(TestZabbix, self).setUp()
+
+    def test_cache(self):
+        """Test the caching mechanism in the reporter."""
+        length = random.randint(1, 30)
+        exit_code = random.randint(0, 3)
+        threshold = random.randint(0, 10)
+
+        message = ''.join(random.choice(string.printable) for x in range(length))
+        message = message.rstrip()
+        message = json.dumps([message])
+
+        (handle, filename) = tempfile.mkstemp()
+        os.unlink(filename)
+        os.close(handle)
+        reporter = ZabbixReporter('test_cache', filename, threshold, self.nagios_user)
+
+        nagios_exit = [NAGIOS_EXIT_OK, NAGIOS_EXIT_WARNING, NAGIOS_EXIT_CRITICAL, NAGIOS_EXIT_UNKNOWN][exit_code]
+
+        reporter.cache(nagios_exit, message)
+
+        (handle, output_filename) = tempfile.mkstemp()
+        os.close(handle)
+
+        try:
+            old_stdout = sys.stdout
+            buffer = StringIO()
+            sys.stdout = buffer
+            reporter_test = ZabbixReporter('test_cache', filename, threshold, self.nagios_user)
+            reporter_test.report_and_exit()
+        except SystemExit as err:
+            line = buffer.getvalue().rstrip()
+            sys.stdout = old_stdout
+            buffer.close()
+            self.assertTrue(err.code == nagios_exit[0])
+            line = json.loads(line)
+            self.assertTrue(line[1] == nagios_exit[1])
+            self.assertTrue(line[2][0] == json.loads(message)[0])
+
+        os.unlink(filename)