Merge branch 'develop'

elabit · Dec 7, 2021 · 376ab05 · 376ab05
2 parents bcbf69e + 2186395
commit 376ab05
Show file tree

Hide file tree

Showing 6 changed files with 61 additions and 53 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.2.4 - 2021-12-07
+
+* Check: Check crashes when the suite never ran. In this case, no XML is present
+  and no data can be parsed. The corrected behaviour now is to skip the discovery
+  of suites but to let the "Robotmk" service report that suites are missing results. (#178)
+
 ## 1.2.3 - 2021-11-29
 
 ### Fixed

diff --git a/agents_plugins/robotmk.py b/agents_plugins/robotmk.py
@@ -49,7 +49,7 @@
 
 local_tz = datetime.utcnow().astimezone().tzinfo
 
-ROBOTMK_VERSION = 'v1.2.3'
+ROBOTMK_VERSION = 'v1.2.4'
 
 class RMKConfig():
     _PRESERVED_WORDS = [

diff --git a/bakery/v1/robotmk.py b/bakery/v1/robotmk.py
@@ -18,7 +18,7 @@
 # to the Free Software Foundation, Inc., 51 Franklin St,  Fifth Floor,
 # Boston, MA 02110-1301 USA.
 
-ROBOTMK_VERSION = 'v1.2.3'
+ROBOTMK_VERSION = 'v1.2.4'
 
 import cmk.utils.paths
 import os

diff --git a/bakery/v2/robotmk.py b/bakery/v2/robotmk.py
@@ -18,7 +18,7 @@
 # to the Free Software Foundation, Inc., 51 Franklin St,  Fifth Floor,
 # Boston, MA 02110-1301 USA.
 
-ROBOTMK_VERSION = 'v1.2.3'
+ROBOTMK_VERSION = 'v1.2.4'
 
 from typing import Iterable, TypedDict, List
 from pathlib import Path

diff --git a/checks/v1/robotmk b/checks/v1/robotmk
@@ -34,7 +34,7 @@ from collections import namedtuple
 iam = "robotmk"
 # DO NOT DELETE
 inventory_robotmk_rules = []
-ROBOTMK_VERSION = 'v1.2.3'
+ROBOTMK_VERSION = 'v1.2.4'
 DEFAULT_SVC_PREFIX = 'Robot Framework E2E $SUITEID$SPACE-$SPACE'
 HTML_LOG_DIR = "%s/%s" % (os.environ['OMD_ROOT'], 'local/share/addons/robotmk')
 
@@ -85,7 +85,7 @@ def parse_robot(info):
                     else:
                         d_decomp = d
                     json_suite[k] = d_decomp
-        try:
+        if 'xml' in json_suite:
             # TODO: his should not be done for HTML 
             # Leave the XML data binary here, because ElementTree has its own decoding
             # mechaism, see https://stackoverflow.com/a/12349894/14845044
@@ -94,19 +94,19 @@ def parse_robot(info):
             xml_str = re.sub(".*(<robot generator=.*)", r"\1", json_suite['xml'], flags=re.DOTALL)
             xml = ET.fromstring(xml_str)
             xml_root_suite = xml.find('./suite')
-        except Exception:
-            continue
+            setting = pattern_match(robot_discovery_settings,
+                                    xml_root_suite.attrib['name'], (0, ''))
+            discovery_setting = namedtuple(
+                'DiscoverySetting', 'level blacklist_pattern')._make(setting)
+            # now process the root suite
+            st_dict['suites'][idx]['parsed'] = parse_suite_xml(
+                xml_root_suite, discovery_setting)
+        else: 
+            pass
             # Seems to be a good idea not to raise an exception here.
             # The Robotmk service can report this error, too.
             #raise MKGeneralException("Fatal parsing error. Robotmk cannot " +\
             #    "find XML/HTML data. %s" % suite.get('error', ''))
-        setting = pattern_match(robot_discovery_settings,
-                                xml_root_suite.attrib['name'], (0, ''))
-        discovery_setting = namedtuple(
-            'DiscoverySetting', 'level blacklist_pattern')._make(setting)
-        # now process the root suite
-        st_dict['suites'][idx]['parsed'] = parse_suite_xml(
-            xml_root_suite, discovery_setting)
     return (st_dict, robot_discovery_settings)
 
 
@@ -281,20 +281,21 @@ def check_robot(item, checkgroup_parameters, parsed):
         # see Ref. 8nIZ5J
         fflines = []
         for root_suite in parsed_section['suites']:
-            if len(root_suite['parsed'].robotmk_messages) > 0: 
-                firstline_messages = []
-                fflines.append("Messages from suite '%s':" % root_suite['parsed'].name)
-                suite_rc = 0
-                for data in root_suite['parsed'].robotmk_messages:
-                    stateid = STATES_NO[data['nagios_state']]
-                    badge = STATE_BADGES[stateid]
-                    fflines.append(" %s %s %s" % (u"\u25cf", badge, data['msg']))
-                    rc = max(rc, stateid)
-                    suite_rc = max(suite_rc, stateid)
-                first_line.append("Suite '%s' has messages %s" % (
-                    root_suite['parsed'].name,
-                    STATE_BADGES[suite_rc],
-                    ))
+            if 'parsed' in root_suite:
+                if len(root_suite['parsed'].robotmk_messages) > 0: 
+                    firstline_messages = []
+                    fflines.append("Messages from suite '%s':" % root_suite['parsed'].name)
+                    suite_rc = 0
+                    for data in root_suite['parsed'].robotmk_messages:
+                        stateid = STATES_NO[data['nagios_state']]
+                        badge = STATE_BADGES[stateid]
+                        fflines.append(" %s %s %s" % (u"\u25cf", badge, data['msg']))
+                        rc = max(rc, stateid)
+                        suite_rc = max(suite_rc, stateid)
+                    first_line.append("Suite '%s' has messages %s" % (
+                        root_suite['parsed'].name,
+                        STATE_BADGES[suite_rc],
+                        ))
         out_lines.append('\n'.join(fflines))
 
 

diff --git a/checks/v2/robotmk.py b/checks/v2/robotmk.py
@@ -35,7 +35,7 @@
 from cmk.base.plugins.agent_based.agent_based_api.v1 import *
 from cmk.utils.exceptions import MKGeneralException
 
-ROBOTMK_VERSION = 'v1.2.3'
+ROBOTMK_VERSION = 'v1.2.4'
 DEFAULT_SVC_PREFIX = 'Robot Framework E2E $SUITEID$SPACE-$SPACE'
 HTML_LOG_DIR = "%s/%s" % (os.environ['OMD_ROOT'], 'local/share/addons/robotmk')
 
@@ -86,22 +86,22 @@ def parse_robotmk(params, string_table):
                     else:
                         d_decomp = d
                     json_suite[k] = d_decomp
-        try:
+        if 'xml' in json_suite:
             xml = ET.fromstring(json_suite['xml'])
             xml_root_suite = xml.find('./suite')
-        except Exception:
-            continue
+            setting = pattern_match(robot_discovery_settings,
+                                    xml_root_suite.attrib['name'], (0, ''))
+            discovery_setting = namedtuple(
+                'DiscoverySetting', 'level blacklist_pattern')._make(setting)
+            # now process the root suite
+            st_dict['suites'][idx]['parsed'] = parse_suite_xml(
+                xml_root_suite, discovery_setting)
+        else: 
+            pass
             # Seems to be a good idea not to raise an exception here.
             # The Robotmk service can report this error, too.
             #raise MKGeneralException("Fatal parsing error. Robotmk cannot " +\
             #    "find XML/HTML data. %s" % suite.get('error', ''))
-        setting = pattern_match(robot_discovery_settings,
-                                xml_root_suite.attrib['name'], (0, ''))
-        discovery_setting = namedtuple(
-            'DiscoverySetting', 'level blacklist_pattern')._make(setting)
-        # now process the root suite
-        st_dict['suites'][idx]['parsed'] = parse_suite_xml(
-            xml_root_suite, discovery_setting)
     return (st_dict, params.__dict__['_data'])
 
 
@@ -277,20 +277,21 @@ def check_robotmk(item, params, section):
         # see Ref. 8nIZ5J
         fflines = []
         for root_suite in parsed_section['suites']:
-            if len(root_suite['parsed'].robotmk_messages) > 0: 
-                firstline_messages = []
-                fflines.append("Messages from suite '%s':" % root_suite['parsed'].name)
-                suite_rc = 0
-                for data in root_suite['parsed'].robotmk_messages:
-                    stateid = STATES_NO[data['nagios_state']]
-                    badge = STATE_BADGES[stateid]
-                    fflines.append(" %s %s %s" % (u"\u25cf", badge, data['msg']))
-                    rc = max(rc, stateid)
-                    suite_rc = max(suite_rc, stateid)
-                first_line.append("Suite '%s' has messages %s" % (
-                    root_suite['parsed'].name,
-                    STATE_BADGES[suite_rc],
-                    ))
+            if 'parsed' in root_suite:
+                if len(root_suite['parsed'].robotmk_messages) > 0: 
+                    firstline_messages = []
+                    fflines.append("Messages from suite '%s':" % root_suite['parsed'].name)
+                    suite_rc = 0
+                    for data in root_suite['parsed'].robotmk_messages:
+                        stateid = STATES_NO[data['nagios_state']]
+                        badge = STATE_BADGES[stateid]
+                        fflines.append(" %s %s %s" % (u"\u25cf", badge, data['msg']))
+                        rc = max(rc, stateid)
+                        suite_rc = max(suite_rc, stateid)
+                    first_line.append("Suite '%s' has messages %s" % (
+                        root_suite['parsed'].name,
+                        STATE_BADGES[suite_rc],
+                        ))
         out_lines.append('\n'.join(fflines))