Extend tests (#9)

* Extent tests and add some comments

* Improve error messages

* Small refactor to improve testability

Author: martialblog

check_monit.py

@@ -1,26 +1,34 @@
 #!/usr/bin/env python3
 
-# MIT License
-#
-# Copyright (c) 2021 NETWAYS GmbH
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
+# monit.h Reference
+# typedef enum {
+#         Monitor_Not     = 0x0,
+#         Monitor_Yes     = 0x1,
+#         Monitor_Init    = 0x2,
+#         Monitor_Waiting = 0x4
+# } Monitor_State;
+
+# typedef enum {
+#         State_Succeeded  = 0x0,
+#         State_Failed     = 0x1,
+#         State_Changed    = 0x2,
+#         State_ChangedNot = 0x4,
+#         State_Init       = 0x8,
+#         State_None       = State_Init // Alias
+# } State_Type;
+
+# typedef enum {
+#         Service_Filesystem = 0,
+#         Service_Directory,
+#         Service_File,
+#         Service_Process,
+#         Service_Host,
+#         Service_System,
+#         Service_Fifo,
+#         Service_Program,
+#         Service_Net,
+#         Service_Last = Service_Net
+# } Service_Type;
 
 import sys
 import argparse
@@ -38,7 +46,6 @@
     3: 'UNKNOWN'
 }
 
-
 def commandline(args):
 
     parser = argparse.ArgumentParser(prog="check_monit.py")
@@ -57,7 +64,6 @@ def commandline(args):
 
 
 def print_output(status, count_ok, count_all, items):
-
     s = icinga_status[status]
 
     print(f"[{s}]: Monit Service Status {count_ok}/{count_all}")
@@ -69,16 +75,19 @@ def print_output(status, count_ok, count_all, items):
             print('  ' + item['output'])
 
 
-def service_output(service_type, element):
+def get_service_output(service_type, element):
+    # Service Type Filesystem
     if service_type == 0:
         block = float(element.findall('block/percent')[0].text)
         inode = float(element.findall('inode/percent')[0].text)
         return 'user={0}%;inodes={1}%'.format(block, inode)
 
+    # Service Type Process
     if service_type == 3:
-        # service type: PROCESS
         status = element.find('status').text
         return status
+
+    # Service Type Host
     if service_type == 5:
         output = []
 
@@ -98,66 +107,70 @@ def service_output(service_type, element):
 
         return ';'.join(output)
 
+    # Service Type Program
     if service_type == 7:
-        # status = float(element.findall('program/status')[0].text)
         return element.findall('program/output')[0].text
 
     return 'Service (type={0}) not implemented'.format(service_type)
 
+def get_service_states(services):
+    items = []
+    count_all = 0
+    count_ok = 0
+
+    for service in services:
+        # Get the monitor state for the service (0: Not, 1: Yes, 2: Init, 4: Waiting)
+        monitor = int(service.find('monitor').text)
+        # if the monitor is yes or initialize, check its status
+        if monitor in (1, 2):
+            status = int(service.find('status').text)
+            if status == 0:
+                count_ok += 1
+
+            count_all += 1
+
+            items.append({
+                "name": service.find('name').text,
+                "status": status,
+                "output": get_service_output(int(service.get('type')), service)
+            })
+
+    return items, count_all, count_ok
 
 def main(args):
     url = '{0}:{1}/_status?format=xml'.format(args.host, args.port)
 
     try:
         r = requests.get(url, auth=(args.user, args.password), timeout=5)
     except Exception as e: # pylint: disable=broad-except
-        print('[UNKNOWN]: Monit Socket error={0}'.format(str(e)))
+        print('[UNKNOWN]: Could not connect to Monit. error={0}'.format(str(e)))
         return 3
 
     status_code = r.status_code
 
     if status_code != 200:
-        print('[UNKNOWN]: Monit HTTP status={0}'.format(status_code))
+        print('[UNKNOWN]: No valid response from Monit HTTP Server. error={0}'.format(status_code))
         return 3
 
     try:
         tree = ElementTree.fromstring(r.content)
     except Exception as e: # pylint: disable=broad-except
-        print('[UNKNOWN]: Monit XML error={0}'.format(str(e)))
+        print('[UNKNOWN]: Unable to parse XML response from Monit HTTP Server. error={0}'.format(str(e)))
         return 3
 
-    items = []
     services = tree.findall('service')
+    items, count_all, count_ok = get_service_states(services)
 
-    count_all = 0
-    count_ok = 0
-
-    for service in services:
-        monitor = int(service.find('monitor').text)
-        if monitor in (1, 2):
-            status = int(service.find('status').text)
-            if status == 0:
-                count_ok += 1
-
-            count_all += 1
-
-            items.append({
-                "name": service.find('name').text,
-                "status": status,
-                "output": service_output(int(service.get('type')), service)
-            })
-
-    status = 0
-
+    exit_status = 0
     if count_ok < count_all:
-        status = 2
+        exit_status = 2
 
     if count_ok == 0:
-        status = 2
+        exit_status = 2
 
-    print_output(status, count_ok, count_all, items)
+    print_output(exit_status, count_ok, count_all, items)
 
-    return status
+    return exit_status
 
 
 if __package__ == '__main__' or __package__ is None: # pragma: no cover

test_check_monit.py

@@ -2,6 +2,7 @@
 
 import unittest
 import unittest.mock as mock
+import xml.etree.ElementTree as ET
 import sys
 
 sys.path.append('..')
@@ -10,6 +11,7 @@
 from check_monit import main
 from check_monit import commandline
 from check_monit import print_output
+from check_monit import get_service_output
 
 
 class MockRequest():
@@ -29,6 +31,19 @@ def test_commandline(self):
         self.assertEqual(actual.user, 'user')
         self.assertEqual(actual.password, 'password')
 
+    def test_service_output(self):
+        input_element = ET.Element('foobar')
+        actual = get_service_output(-1, input_element)
+        self.assertEqual(actual, 'Service (type=-1) not implemented')
+
+        input_element = ET.ElementTree(ET.fromstring("""<doc><status>unittest</status></doc>"""))
+        actual = get_service_output(3, input_element)
+        self.assertEqual(actual, 'unittest')
+
+        input_element = ET.ElementTree(ET.fromstring("""<doc><program><output>foobar</output></program></doc>"""))
+        actual = get_service_output(7, input_element)
+        self.assertEqual(actual, 'foobar')
+
 class UtilTesting(unittest.TestCase):
 
     @mock.patch('builtins.print')
@@ -54,7 +69,7 @@ def test_main_request_error(self, mock_get, mock_print):
 
         self.assertEqual(actual, 3)
 
-        calls = [mock.call('[UNKNOWN]: Monit Socket error=Boom!')]
+        calls = [mock.call('[UNKNOWN]: Could not connect to Monit. error=Boom!')]
 
         mock_print.assert_has_calls(calls)
 
@@ -69,7 +84,7 @@ def test_main_http_error(self, mock_get, mock_print):
 
         self.assertEqual(actual, 3)
 
-        calls = [mock.call('[UNKNOWN]: Monit HTTP status=400')]
+        calls = [mock.call('[UNKNOWN]: No valid response from Monit HTTP Server. error=400')]
 
         mock_print.assert_has_calls(calls)
 
@@ -84,7 +99,7 @@ def test_main_xml_error(self, mock_get, mock_print):
 
         self.assertEqual(actual, 3)
 
-        calls = [mock.call('[UNKNOWN]: Monit XML error=syntax error: line 1, column 0')]
+        calls = [mock.call('[UNKNOWN]: Unable to parse XML response from Monit HTTP Server. error=syntax error: line 1, column 0')]
 
         mock_print.assert_has_calls(calls)