omdnotificationforwarder 2.8__tar.gz → 2.9__tar.gz

{omdnotificationforwarder-2.8 → omdnotificationforwarder-2.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: omdnotificationforwarder
-Version: 2.8
+Version: 2.9
 Summary: A framework for notification scripts for OMD
 Project-URL: Homepage, https://github.com/lausser/noteventificationforhandlerwarder
 Project-URL: Bug Tracker, https://github.com/lausser/noteventificationforhandlerwarder/issues
@@ -8,7 +8,7 @@ Author-email: Gerhard Lausser <lausser@yahoo.com>
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.6
+Requires-Python: >=3.6.1
 Requires-Dist: coshsh
 Requires-Dist: jinja2
 Provides-Extra: test

{omdnotificationforwarder-2.8 → omdnotificationforwarder-2.9}/bin/notificationforwarder

@@ -74,7 +74,7 @@ Example for an HTTP-based reporter:
                       help='Increase the log level to DEBUG',
                       default=False)
     parser.add_argument('--version', action='version',
-                      version=f'%(prog)s 2.8')
+                      version=f'%(prog)s 2.9')
 
     args = parser.parse_args()
     if not hasattr(args, 'formatter'):
@@ -90,5 +90,9 @@ Example for an HTTP-based reporter:
         logger.critical("there is no class for forwarder {} and formatter {}".format(args.forwarder, args.formatter))
         sys.exit(1)
     
-    forwarder.forward(args.eventopt)
+    formatter_instance = forwarder.new_formatter()
+    if hasattr(formatter_instance, 'split_events'):
+        forwarder.forward_multiple(args.eventopt)
+    else:
+        forwarder.forward(args.eventopt)
 

{omdnotificationforwarder-2.8 → omdnotificationforwarder-2.9}/pyproject.toml

@@ -21,13 +21,13 @@ packages = ["src/notificationforwarder"]
 
 [project]
 name = "omdnotificationforwarder"
-version = "2.8"
+version = "2.9"
 authors = [
   { name="Gerhard Lausser", email="lausser@yahoo.com" },
 ]
 description = "A framework for notification scripts for OMD"
 readme = "README.md"
-requires-python = ">=3.6"
+requires-python = ">=3.6.1"
 classifiers = [
     "Programming Language :: Python :: 3",
     "License :: OSI Approved :: MIT License",

{omdnotificationforwarder-2.8 → omdnotificationforwarder-2.9}/src/notificationforwarder/webhook/forwarder.py

@@ -36,7 +36,22 @@ class WebhookForwarder(NotificationForwarder):
         # self.headers = 
         try:
             request_params = {}
-            request_params["json"] = event.payload
+            mode = event.forwarderopts.get("mode", "json")
+            if mode == "json":
+                request_params["json"] = event.payload
+            elif mode == "form":
+                if isinstance(event.payload, dict):
+                    request_params["data"] = event.payload
+                else:
+                    request_params["data"] = {"data": event.payload}
+            elif mode == "raw":
+                if isinstance(event.payload, (dict, list)):
+                    request_params["data"] = json.dumps(event.payload)
+                else:
+                    request_params["data"] = str(event.payload)
+            else:
+                raise ValueError(f"Unsupported forwarder mode: {mode}")
+
             if self.username and self.password:
                 request_params["auth"] = requests.auth.HTTPBasicAuth(self.username, self.password)
             if self.headers:
@@ -45,6 +60,9 @@ class WebhookForwarder(NotificationForwarder):
                     request_params["headers"] = json.loads(self.headers)
                 else:
                     request_params["headers"] = self.headers
+            if "url" in event.forwarderopts:
+                logger.debug(f"formatter overwrites the url with {event.forwarderopts['url']}")
+                self.url = event.forwarderopts["url"]
             if "headers" in event.forwarderopts:
                 if isinstance(event.forwarderopts["headers"], str):
                     event.forwarderopts["headers"] = json.loads(event.forwarderopts["headers"])
@@ -53,12 +71,16 @@ class WebhookForwarder(NotificationForwarder):
                 request_params["headers"].update(event.forwarderopts["headers"])
             if self.insecure == "yes":
                 request_params["verify"] = False
+
             if "headers" not in request_params:
-                request_params["headers"] = {
-                    "Content-type": "application/json"
-                }
-            elif "Content-type" not in request_params["headers"]:
-                request_params["headers"]["Content-type"] = "application/json"
+                request_params["headers"] = {}
+            if "content-type" not in [k.lower() for k in request_params["headers"]]:
+                if mode == "json":
+                    request_params["headers"]["Content-Type"] = "application/json"
+                elif mode == "form":
+                    request_params["headers"]["Content-Type"] = "application/x-www-form-urlencoded"
+                elif mode == "raw":
+                    request_params["headers"]["Content-Type"] = "text/xml"
 
             response = requests.post(self.url, **request_params)
             if response.status_code in [requests.codes.ok, requests.codes.accepted, requests.codes.created]:
@@ -78,4 +100,3 @@ class WebhookForwarder(NotificationForwarder):
         except Exception as e:
             logger.critical("POST had an exception: {}".format(str(e)))
             return False
-

omdnotificationforwarder-2.9/tests/pythonpath/local/lib/python/notificationforwarder/datadup/formatter.py

@@ -0,0 +1,27 @@
+from notificationforwarder.baseclass import NotificationFormatter
+
+class DatadupFormatter(NotificationFormatter):
+    def format_event(self, event):
+        """
+        Formats a single event.
+        """
+        # This part is similar to datapost/formatter.py
+        event.payload = {
+            "source": event.eventopts["source"],
+            "action": event.eventopts["action"],
+            "site": event.eventopts["site"],
+            "split_id": event.eventopts["split_id"], # Add the split_id
+        }
+        event.summary = f"split event {event.eventopts['split_id']}"
+
+    def split_events(self, raw_event):
+        """
+        Splits one incoming raw_event into two.
+        """
+        event1 = raw_event.copy()
+        event1["split_id"] = 1
+
+        event2 = raw_event.copy()
+        event2["split_id"] = 2
+
+        return [event1, event2]

omdnotificationforwarder-2.9/tests/pythonpath/local/lib/python/notificationforwarder/datapost/formatter.py

@@ -0,0 +1,13 @@
+from notificationforwarder.baseclass import NotificationFormatter
+
+class DatapostFormatter(NotificationFormatter):
+    def format_event(self, event):
+        """
+        Creates a dictionary payload from eventopts.
+        """
+        event.payload = {
+            "source": event.eventopts["source"],
+            "action": event.eventopts["action"],
+            "site": event.eventopts["site"],
+        }
+        event.summary = "dict payload"

{omdnotificationforwarder-2.8 → omdnotificationforwarder-2.9}/tests/test_webhook.py

@@ -80,18 +80,42 @@ class RequestHandler(http.server.SimpleHTTPRequestHandler):
             return False
 
     def do_POST(self):
+        import urllib.parse
         headers = self.headers
         if not self.check_auth():
             return
         content_length = int(self.headers['Content-Length'])
         post_data = self.rfile.read(content_length)
-        with open('/tmp/received_payload.json', 'wb') as json_file:
-            json_file.write(post_data)
+        
+        content_type = self.headers.get('Content-Type', '')
+        
+        if 'application/json' in content_type:
+            with open('/tmp/received_payload.json', 'ab') as json_file:
+                json_file.write(post_data)
+                json_file.write(b'\n')
+        elif 'application/x-www-form-urlencoded' in content_type:
+            decoded_data = post_data.decode('utf-8')
+            parsed_data = urllib.parse.parse_qs(decoded_data)
+            # The user wants single values, not lists
+            # Weil urllib.parse.parse_qs liefert als value immer eine Liste.
+            # Kommt daher, daß man mehrmals den gleichen Key angeben kann
+            # abc=schmarrn&abc=kaas&xyz=glump wird zu
+            # abc: [schmarrn, kaas], xyz: [glump]
+            single_value_data = {k: v[0] for k, v in parsed_data.items()}
+            with open('/tmp/received_payload.json', 'a') as json_file:
+                json.dump(single_value_data, json_file)
+                json_file.write('\n')
+        else:
+            # Default to writing raw data
+            with open('/tmp/received_payload.json', 'ab') as json_file:
+                json_file.write(post_data)
+                json_file.write(b'\n')
+
         self.send_response(200)
         self.end_headers()
 
 def start_server():
-    server = http.server.HTTPServer(('localhost', 8080), RequestHandler)
+    server = http.server.HTTPServer(('localhost', 18888), RequestHandler)
     server_thread = threading.Thread(target=server.serve_forever)
     server_thread.daemon = True
     server_thread.start()
@@ -113,7 +137,7 @@ def server_fixture(request):
     return server
 
 def xtest_send_json_payload_to_server(server_fixture):
-    url = "http://localhost:8080"
+    url = "http://localhost:18888"
     data = {"key": "value", "another_key": "another_value"}
 
     response = requests.post(url, json=data)
@@ -127,7 +151,7 @@ def xtest_send_json_payload_to_server(server_fixture):
 def test_forward_webhook_format_rabbitmq(server_fixture):
     signature = hashlib.sha256(secrets.token_bytes(32)).hexdigest()
     forwarderopts = {
-        "url": "http://localhost:8080/api/v1",
+        "url": "http://localhost:18888/api/v1",
         "username": "i_bims",
         "password": "i_bims_1_i_bims",
     }   
@@ -152,7 +176,7 @@ def test_forward_webhook_format_rabbitmq(server_fixture):
 def test_forward_webhook_format_example(server_fixture):
     signature = hashlib.sha256(secrets.token_bytes(32)).hexdigest()
     forwarderopts = {
-        "url": "http://localhost:8080",
+        "url": "http://localhost:18888",
         "username": "i_bims",
         "password": "i_bims_1_i_bims",
     }   
@@ -174,7 +198,7 @@ def test_forward_webhook_format_example(server_fixture):
 
 def test_forward_webhook_format_vong(server_fixture):
     forwarderopts = {
-        "url": "http://localhost:8080",
+        "url": "http://localhost:18888",
         "username": "i_bims",
         "password": "i_bims_1_i_bims",
     }   
@@ -195,7 +219,7 @@ def test_forward_webhook_format_vong(server_fixture):
 
 def test_forward_webhook_format_bayern(server_fixture):
     forwarderopts = {
-        "url": "http://localhost:8080",
+        "url": "http://localhost:18888",
         "username": "i_bims",
         "password": "i_bims_1_i_bims",
     }   
@@ -208,7 +232,7 @@ def test_forward_webhook_format_bayern(server_fixture):
     webhook = notificationforwarder.baseclass.new("webhook", None, "bayern", True, True,  forwarderopts)
     webhook.forward(eventopts)
     log = open(get_logfile(webhook)).read()
-    assert "INFO - success: des glump {} is hi".format(eventopts["HOSTNAME"]) in log
+    assert "INFO - success: des glump "+eventopts["HOSTNAME"]+" is hi" in log
     with open("/tmp/received_payload.json") as f:
         payload = f.read()
     payload = json.loads(payload)
@@ -216,7 +240,7 @@ def test_forward_webhook_format_bayern(server_fixture):
 
 def test_forward_webhook_format_vong_bin_basic_auth(server_fixture):
     forwarderopts = {
-        "url": "http://localhost:8080",
+        "url": "http://localhost:18888",
         "username": "i_bims",
         "password": "i_bims_1_i_bims",
     }   
@@ -241,7 +265,7 @@ def test_forward_webhook_format_vong_bin_basic_auth(server_fixture):
 def test_forward_webhook_format_vong_bin_token_auth(server_fixture):
     # auth with token, token is in forwarderopts
     forwarderopts = {
-        "url": "http://localhost:8080",
+        "url": "http://localhost:18888",
         "headers": '{"Authorization": "Bearer i_bims_1_token"}',
     }   
     eventopts = {
@@ -266,7 +290,7 @@ def test_forward_webhook_format_vong_bin_token_auth(server_fixture):
 def test_forward_webhook_format_vong_bin_token_auth_by_formatter(server_fixture):
     # auth with token, token is created by the formatter
     forwarderopts = {
-        "url": "http://localhost:8080",
+        "url": "http://localhost:18888",
         "username": "i_bims",
         "password": "i_bims_1_i_bims",
     }   
@@ -291,3 +315,114 @@ def test_forward_webhook_format_vong_bin_token_auth_by_formatter(server_fixture)
     payload = json.loads(payload)
     assert payload["host_name"] == "vongsrv04"
 
+def test_submit_form_with_xml_payload(server_fixture):
+    forwarderopts = {
+        "url": "http://localhost:18888",
+        "mode": "form",
+        "username": "i_bims",
+        "password": "i_bims_1_i_bims",
+    }
+    eventopts = {
+        "source": "nagios",
+        "action": "EskaMatrix",
+        "site": "p100"
+    }
+
+    webhook = notificationforwarder.baseclass.new("webhook", None, "datapost", True, True,  forwarderopts)
+    webhook.forward(eventopts)
+
+    with open("/tmp/received_payload.json") as f:
+        payload = json.load(f)
+
+    assert payload['source'] == "nagios"
+    assert payload['action'] == "EskaMatrix"
+    assert payload['site'] == "p100"
+
+def test_forward_multiple_events(server_fixture):
+    forwarderopts = {
+        "url": "http://localhost:18888",
+        "mode": "form",
+        "username": "i_bims",
+        "password": "i_bims_1_i_bims",
+    }
+    eventopts = {
+        "source": "nagios",
+        "action": "EskaMatrix",
+        "site": "p100"
+    }
+
+    webhook = notificationforwarder.baseclass.new("webhook", None, "datadup", True, True,  forwarderopts)
+    webhook.forward_multiple(eventopts)
+
+    # Read the two payloads from the file
+    received_payloads = []
+    with open("/tmp/received_payload.json", "r") as f:
+        for line in f:
+            if line.strip(): # Avoid empty lines
+                received_payloads.append(json.loads(line))
+
+    assert len(received_payloads) == 2
+
+    # Check the first event
+    assert received_payloads[0]['source'] == "nagios"
+    assert received_payloads[0]['action'] == "EskaMatrix"
+    assert received_payloads[0]['site'] == "p100"
+    assert received_payloads[0]['split_id'] == '1'
+
+    # Check the second event
+    assert received_payloads[1]['source'] == "nagios"
+    assert received_payloads[1]['action'] == "EskaMatrix"
+    assert received_payloads[1]['site'] == "p100"
+    assert received_payloads[1]['split_id'] == '2'
+
+def test_forward_multiple_events_bin(server_fixture):
+    forwarderopts = {
+        "url": "http://localhost:18888",
+        "mode": "form",
+        "username": "i_bims",
+        "password": "i_bims_1_i_bims",
+    }
+    eventopts = {
+        "source": "nagios",
+        "action": "EskaMatrix",
+        "site": "p100"
+    }
+
+    omd_root = os.environ["OMD_ROOT"]
+    pythonpath = omd_root+"/../src:"+omd_root+"/pythonpath/local/lib/python"+":"+omd_root+"/pythonpath/lib/python"
+    cmd = omd_root+"/../bin/notificationforwarder"
+
+    # Construct forwarderoptsparams
+    forwarderoptsparams = []
+    for k, v in forwarderopts.items():
+        if isinstance(v, dict): # Handle dicts for headers
+            forwarderoptsparams.append(f"--forwarderopt {k}='{json.dumps(v)}'")
+        else:
+            forwarderoptsparams.append(f"--forwarderopt {k}='{v}'")
+    forwarderoptsparams = " ".join(forwarderoptsparams)
+
+    # Construct eventoptsparams
+    eventoptsparams = " ".join([f"--eventopt {k}='{v}'" for k, v in eventopts.items()])
+
+    subprocess.call(f"OMD_SITE=my_devel_site OMD_ROOT={omd_root} PYTHONPATH={pythonpath} {cmd} --forwarder webhook --formatter datadup {forwarderoptsparams} {eventoptsparams}", shell=True)
+
+    # Read the two payloads from the file
+    received_payloads = []
+    with open("/tmp/received_payload.json", "r") as f:
+        for line in f:
+            if line.strip(): # Avoid empty lines
+                received_payloads.append(json.loads(line))
+
+    assert len(received_payloads) == 2
+
+    # Check the first event
+    assert received_payloads[0]['source'] == "nagios"
+    assert received_payloads[0]['action'] == "EskaMatrix"
+    assert received_payloads[0]['site'] == "p100"
+    assert received_payloads[0]['split_id'] == '1'
+
+    # Check the second event
+    assert received_payloads[1]['source'] == "nagios"
+    assert received_payloads[1]['action'] == "EskaMatrix"
+    assert received_payloads[1]['site'] == "p100"
+    assert received_payloads[1]['split_id'] == '2'