Draft: No story: wf_monitor improvements

Why This Is a Draft

Note: this MR is a draft until both WS-2898 (writing tests for wf_monitor) and the code cleanliness tools have been set up, which might be when WS-3215 (Set up SonarQube for code analysis) is done and the analysis done using the SonarQube setup from WS-3215 is done.

Work Description

This involved:

• Making sure wf_monitor passed the default Pylint and SonarLint checks.
• Ensuring all methods and functions have accurate docstrings.

Note: the "us-ascii" encoding was found from running "file -i" on a condor log from Workspaces on dev and getting the charset value. The file I used was in /lustre/aoc/cluster/pipeline/dsoc-dev/workspaces/spool/tmpjsesjhoq, which is a calibration that was done on 12/27.

Also, in monitor.htc_log_process_end_of_event_line and monitor.dag_log_process_end_of_event_line, should_continue and should_break variables were used in and passed back to the callers to ensure the same loop behavior as before the code was modified.

apps/cli/utilities/wf_monitor/test/test_wf_monitor.py

@@ -19,15 +19,12 @@
    This module is kept so as not to break tests; mocks remain
    in case they may be useful Some Fine Day.
 """
-# pylint: disable=W1203
 
 import logging
 import sys
-from typing import Dict
 from unittest.mock import patch
 
 import pytest
-import wf_monitor.monitor
 from messaging.router import Router
 from wf_monitor.monitor import WorkflowMonitor
 
@@ -38,31 +35,28 @@ logger.setLevel(logging.INFO)
 logger.addHandler(logging.StreamHandler(sys.stdout))
 
 
-def mock_send_message(message: Dict[str, str], mock_router: Router):
+def mock_send_message(message: dict[str, str], mock_router: Router):
     """
-    Mocked version of wf_monitor.monitor.send_event without any AMQP connections being made
+    Mocked version of wf_monitor.monitor.send_event without any AMQP connections being made.
 
-    :param message: Workflow event being "sent"
-    :param mock_router: Mock router
+    :param message: The workflow event being "sent".
+    :param mock_router: A mock router.
     """
-    logger.info(f"Pretending to send message: {message} from mock router: {mock_router}")
+    logger.info("Pretending to send message: %s from mock router: %s", message, mock_router)
 
 
-wf_monitor.monitor.send_message = mock_send_message
-
-
-def mock_monitor_factory(path_to_log: str, timeout: int = 60) -> WorkflowMonitor:
+def mock_monitor_factory_htc_log(path_to_log: str, timeout: int = 60) -> WorkflowMonitor:
     """
     Factory function that creates a WorkflowMonitor object with external
-    dependencies mocked away
+    dependencies mocked away. Note: is_dag is set to False, so it will process logs as HTC logs.
 
-    :param path_to_log: Path to log file that will be monitored
-    :param timeout: Timeout in seconds
+    :param path_to_log: Path to log file that will be monitored.
+    :param timeout: Timeout in seconds. The default is 60.
 
     :return: Mocked WorkflowMonitor
     """
     with patch("wf_monitor.monitor.Router"):
-        return WorkflowMonitor(path_to_log, -1, timeout)
+        return WorkflowMonitor(path_to_log, -1, False, timeout)
 
 
 @pytest.mark.skip("This is here just to avoid breaking build")