vdk-structlog: add test for syslog

Signed-off-by: Dilyan Marinov <mdilyan@vmware.com>

Author: Dilyan Marinov

projects/vdk-plugins/vdk-structlog/src/vdk/plugin/structlog/structlog_plugin.py

@@ -311,11 +311,17 @@ def run_job(self, context: JobContext) -> Optional[ExecutionResult]:
     def run_step(self, context: JobContext, step: Step) -> Optional[StepResult]:
         root_logger = logging.getLogger()
         handler = root_logger.handlers[0]
-
+        metadata_filter = None
         # make sure the metadata filter executes last
         # so that step_name and step_type are filtered if necessary
-        metadata_filter = [f for f in handler.filters if f.name == "metadata_filter"][0]
-        handler.removeFilter(metadata_filter)
+        metadata_filter_result = [
+            f for f in handler.filters if f.name == "metadata_filter"
+        ]
+        if metadata_filter_result:
+            metadata_filter = metadata_filter_result[0]
+
+        if metadata_filter:
+            handler.removeFilter(metadata_filter)
 
         step_name_adder = AttributeAdder("vdk_step_name", step.name)
         step_type_adder = AttributeAdder("vdk_step_type", step.type)
@@ -324,7 +330,8 @@ def run_step(self, context: JobContext, step: Step) -> Optional[StepResult]:
 
         # make sure the metadata filter executes last
         # so that step_name and step_type are filtered if necessary
-        handler.addFilter(metadata_filter)
+        if metadata_filter:
+            handler.addFilter(metadata_filter)
         out: HookCallResult
         out = yield
         handler.removeFilter(step_name_adder)

projects/vdk-plugins/vdk-structlog/src/vdk/plugin/structlog/syslog_config.py

@@ -1,6 +1,5 @@
 # Copyright 2021-2024 VMware, Inc.
 # SPDX-License-Identifier: Apache-2.0
-
 import logging.handlers
 
 from vdk.plugin.structlog.constants import SYSLOG_PROTOCOLS
@@ -36,7 +35,7 @@ def configure_syslog_handler(
     syslog_socktype = SYSLOG_PROTOCOLS[syslog_protocol.upper()]
     syslog_handler = logging.handlers.SysLogHandler(
         address=(syslog_host, syslog_port),
-        facility=logging.handlers.SysLogHandler.LOG_USER,
+        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
         socktype=syslog_socktype,
     )
 

projects/vdk-plugins/vdk-structlog/tests/test_structlog.py

@@ -3,6 +3,8 @@
 import logging
 import os
 import re
+import socket
+import threading
 from unittest import mock
 
 import pytest
@@ -108,6 +110,52 @@ def test_structlog(log_format):
         )
 
 
+def test_structlog_syslog():
+    with mock.patch.dict(
+        os.environ,
+        {
+            "VDK_STRUCTLOG_METADATA": f"timestamp,level,file_name,line_number,vdk_job_name,{BOUND_TEST_KEY},{EXTRA_TEST_KEY}",
+            "VDK_STRUCTLOG_FORMAT": "console",
+            "LOG_LEVEL_MODULE": "test_structlog=WARNING",
+            "VDK_SYSLOG_HOST": "127.0.0.1",
+            "VDK_SYSLOG_PORT": "8888",
+            "VDK_SYSLOG_PROTOCOL": "UDP",
+            "VDK_SYSLOG_ENABLED": "True",
+        },
+    ):
+        syslog_out = []
+
+        def start_syslog_server(host, port):
+            server_socket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+            server_socket.bind((host, port))
+            print(f"Syslog server listening on {host}:{port}")
+
+            while True:
+                data, addr = server_socket.recvfrom(1024)
+                syslog_out.append(f"{data.decode('utf-8')}")
+
+        server = threading.Thread(
+            target=start_syslog_server, args=("127.0.0.1", 8888), daemon=True
+        )
+        server.start()
+
+        _run_job_and_get_logs()
+
+        assert len(syslog_out)
+
+        # assert log entries are formatted using the hardcoded formatter
+        for log in syslog_out:
+            assert re.search("\\[id:.*\\]", log)
+
+        # syslog_out[0] comes from vdk-core for some reason when the whole suite is run
+        assert re.search("run_python_step", syslog_out[1])
+        assert re.search("run", syslog_out[2])
+        assert re.search("run", syslog_out[3])
+        assert re.search("run", syslog_out[4])
+        assert re.search("run_python_step", syslog_out[5])
+        assert re.search("create_and_run_d", syslog_out[6])
+
+
 @pytest.mark.parametrize("log_format", ["console", "ltsv", "json"])
 def test_stock_fields_removal(log_format):
     stock_field_reps = STOCK_FIELD_REPRESENTATIONS[log_format]

projects/vdk-plugins/vdk-structlog/tests/test_syslog_config.py

@@ -1,6 +1,5 @@
 # Copyright 2021-2024 VMware, Inc.
 # SPDX-License-Identifier: Apache-2.0
-
 import logging.handlers
 import socket
 from unittest.mock import MagicMock
@@ -83,20 +82,3 @@ def test_configure_syslog_handler_invalid_protocol(mock_job_context):
         configure_syslog_handler(
             True, "localhost", 514, "invalid_protocol", "test_job", "12345"
         )
-
-
-@patch("logging.handlers.SysLogHandler")
-def test_syslog_handler_configuration(mock_syslog_handler, mock_job_context):
-    configure_syslog_handler(
-        True,
-        "localhost",
-        514,
-        "UDP",
-        mock_job_context.name,
-        mock_job_context.core_context.state.get(),
-    )
-    mock_syslog_handler.assert_called_with(
-        address=("localhost", 514),
-        facility=logging.handlers.SysLogHandler.LOG_USER,
-        socktype=socket.SOCK_DGRAM,
-    )