test: adjust unit tests

Author: sgoral-splunk

solnlib/conf_manager.py

@@ -36,9 +36,11 @@
     InvalidHostnameError,
 )
 
-from solnlib.log import Logs
+from solnlib.utils import get_solnlib_logger
+
+logger = get_solnlib_logger(__name__)
+
 
-logger = Logs().get_logger(__name__)
 
 __all__ = [
     "ConfFile",
@@ -342,7 +344,7 @@ def delete(self, stanza_name: str):
         try:
             self._conf.delete(stanza_name)
         except KeyError:
-            logger.error(
+            logger().error(
                 "Delete stanza: %s error: %s.", stanza_name, traceback.format_exc()
             )
             raise ConfStanzaNotExistException(

solnlib/file_monitor.py

@@ -24,9 +24,11 @@
 import traceback
 from typing import Any, Callable, List
 
-from solnlib.log import Logs
+from solnlib.utils import get_solnlib_logger
+
+logger = get_solnlib_logger(__name__)
+
 
-logger = Logs().get_logger(__name__)
 
 
 __all__ = ["FileChangesChecker", "FileMonitor"]
@@ -53,7 +55,7 @@ def __init__(self, callback: Callable[[List[str]], Any], files: List):
                 logging.debug(
                     f"Getmtime for {k}, failed: {traceback.format_exc()}"
                 )  # deprecated
-                logger.debug(f"Getmtime for {k}, failed: {traceback.format_exc()}")
+                logger().debug(f"Getmtime for {k}, failed: {traceback.format_exc()}")
 
     def check_changes(self) -> bool:
         """Check files change.
@@ -64,7 +66,7 @@ def check_changes(self) -> bool:
         Returns:
             True if files changed else False
         """
-        logger.debug(f"Checking files={self._files}")
+        logger().debug(f"Checking files={self._files}")
         file_mtimes = self.file_mtimes
         changed_files = []
         for f, last_mtime in list(file_mtimes.items()):
@@ -73,7 +75,7 @@ def check_changes(self) -> bool:
                 if current_mtime != last_mtime:
                     file_mtimes[f] = current_mtime
                     changed_files.append(f)
-                    logger.info(f"Detect {f} has changed", f)
+                    logger().info(f"Detect {f} has changed", f)
             except OSError:
                 pass
         if changed_files:

solnlib/modular_input/checkpointer.py

@@ -30,9 +30,9 @@
 
 from solnlib import _utils, utils
 
-from solnlib.log import Logs
+from solnlib.utils import get_solnlib_logger
 
-logger = Logs().get_logger(__name__)
+logger = get_solnlib_logger(__name__)
 
 __all__ = ["CheckpointerException", "KVStoreCheckpointer", "FileCheckpointer"]
 
@@ -181,7 +181,7 @@ def get(self, key: str) -> Optional[Any]:
             record = self._collection_data.query_by_id(key)
         except binding.HTTPError as e:
             if e.status != 404:
-                logger.error(f"Get checkpoint failed: {traceback.format_exc()}.")
+                logger().error(f"Get checkpoint failed: {traceback.format_exc()}.")
                 raise
             return None
         return json.loads(record["state"])
@@ -202,7 +202,7 @@ def delete(self, key: str) -> None:
             self._collection_data.delete_by_id(key)
         except binding.HTTPError as e:
             if e.status != 404:
-                logger.error(f"Delete checkpoint failed: {traceback.format_exc()}.")
+                logger().error(f"Delete checkpoint failed: {traceback.format_exc()}.")
                 raise
 
 

solnlib/modular_input/modinput.py

@@ -20,9 +20,9 @@
 
 import solnlib.splunkenv as sp
 
-from solnlib.log import Logs
+from solnlib.utils import get_solnlib_logger
 
-logger = Logs().get_logger(__name__)
+logger = get_solnlib_logger(__name__)
 
 
 def _parse_modinput_configs(root, outer_block, inner_block):
@@ -65,7 +65,7 @@ def _parse_modinput_configs(root, outer_block, inner_block):
 
     confs = root.getElementsByTagName(outer_block)
     if not confs:
-        logger.error("Invalid config, missing %s section", outer_block)
+        logger().error("Invalid config, missing %s section", outer_block)
         raise Exception(f"Invalid config, missing {outer_block} section")
 
     configs = []
@@ -74,7 +74,7 @@ def _parse_modinput_configs(root, outer_block, inner_block):
         config = {}
         stanza_name = stanza.getAttribute("name")
         if not stanza_name:
-            logger.error("Invalid config, missing name")
+            logger().error("Invalid config, missing name")
             raise Exception("Invalid config, missing name")
 
         config["name"] = stanza_name
@@ -110,13 +110,13 @@ def parse_modinput_configs(config_str):
     for tag in meta_configs.keys():
         nodes = doc.getElementsByTagName(tag)
         if not nodes:
-            logger.error("Invalid config, missing %s section", tag)
+            logger().error("Invalid config, missing %s section", tag)
             raise Exception("Invalid config, missing %s section", tag)
 
         if nodes[0].firstChild and nodes[0].firstChild.nodeType == nodes[0].TEXT_NODE:
             meta_configs[tag] = nodes[0].firstChild.data
         else:
-            logger.error("Invalid config, expect text ndoe")
+            logger().error("Invalid config, expect text ndoe")
             raise Exception("Invalid config, expect text ndoe")
 
     if doc.nodeName == "input":
@@ -143,7 +143,7 @@ def get_modinput_configs_from_cli(modinput, modinput_stanza=None):
         cli, stdout=subprocess.PIPE, stderr=subprocess.PIPE
     ).communicate()
     if err:
-        logger.error("Failed to get modinput configs with error: %s", err)
+        logger().error("Failed to get modinput configs with error: %s", err)
         return None, None
     else:
         return parse_modinput_configs(out)
@@ -155,7 +155,7 @@ def get_modinput_config_str_from_stdin():
     try:
         return sys.stdin.read(5000)
     except Exception:
-        logger.error(traceback.format_exc())
+        logger().error(traceback.format_exc())
         raise
 
 

solnlib/modular_input/modular_input.py

@@ -34,9 +34,9 @@
 from ..orphan_process_monitor import OrphanProcessMonitor
 from . import checkpointer, event_writer
 
-from solnlib.log import Logs
+from solnlib.utils import get_solnlib_logger
 
-logger = Logs().get_logger(__name__)
+logger = get_solnlib_logger(__name__)
 
 __all__ = ["ModularInputException", "ModularInput"]
 
@@ -199,7 +199,7 @@ def _create_checkpointer(self):
                     port=self.server_port,
                 )
             except binding.HTTPError:
-                logger.error(
+                logger().error(
                     "Failed to init kvstore checkpointer: %s.", traceback.format_exc()
                 )
                 raise
@@ -237,7 +237,7 @@ def _create_event_writer(self):
                     global_settings_schema=self.hec_global_settings_schema,
                 )
             except binding.HTTPError:
-                logger.error(
+                logger().error(
                     "Failed to init HECEventWriter: %s.", traceback.format_exc()
                 )
                 raise
@@ -467,10 +467,10 @@ def execute(self):
                 else:
                     self.config_name = list(input_definition["inputs"].keys())[0]
                 self.do_run(input_definition["inputs"])
-                logger.info("Modular input: %s exit normally.", self.name)
+                logger().info("Modular input: %s exit normally.", self.name)
                 return 0
             except Exception:
-                logger.error(
+                logger().error(
                     "Modular input: %s exit with exception: %s.",
                     self.name,
                     traceback.format_exc(),
@@ -493,7 +493,7 @@ def execute(self):
                 self.do_validation(validation_definition["parameters"])
                 return 0
             except Exception as e:
-                logger.error(
+                logger().error(
                     "Modular input: %s validate arguments with exception: %s.",
                     self.name,
                     traceback.format_exc(),
@@ -504,7 +504,7 @@ def execute(self):
                 sys.stderr.flush()
                 return 1
         else:
-            logger.error(
+            logger().error(
                 'Modular input: %s run with invalid arguments: "%s".',
                 self.name,
                 " ".join(sys.argv[1:]),

solnlib/rest.py

@@ -23,9 +23,11 @@
 
 import logging
 
-from solnlib.log import Logs, log_exception
+from solnlib.log import log_exception
 
-logger = Logs().get_logger(__name__)
+from solnlib.utils import get_solnlib_logger
+
+logger = get_solnlib_logger(__name__)
 
 
 def splunkd_request(
@@ -69,7 +71,7 @@ def splunkd_request(
         except Exception as e:
             logging.error(msg_temp, splunkd_uri, "unknown", format_exc())  # deprecated
             log_exception(
-                logger,
+                logger(),
                 e,
                 exc_label="unknown",
                 msg_before=f"Failed to send rest request={splunkd_uri}, errcode=unknown",
@@ -80,7 +82,7 @@ def splunkd_request(
                     logging.debug(
                         msg_temp, splunkd_uri, resp.status_code, code_to_msg(resp)
                     )  # deprecated
-                    logger.debug(
+                    logger().debug(
                         msg_temp, splunkd_uri, resp.status_code, code_to_msg(resp)
                     )
             else:

solnlib/splunk_rest_client.py

@@ -34,9 +34,9 @@
 from .net_utils import validate_scheme_host_port
 from .splunkenv import get_splunkd_access_info
 
-from solnlib.log import Logs
+from solnlib.utils import get_solnlib_logger
 
-logger = Logs().get_logger(__name__)
+logger = get_solnlib_logger(__name__)
 
 __all__ = ["SplunkRestClient"]
 MAX_REQUEST_RETRIES = 5
@@ -174,7 +174,7 @@ def request(url, message, **kwargs):
                 **kwargs,
             )
         except Exception:
-            logger.error(
+            logger().error(
                 "Failed to issue http request=%s to url=%s, error=%s",
                 method,
                 url,

solnlib/timer_queue.py

@@ -27,7 +27,7 @@
 
 from solnlib.log import Logs
 
-logger = Logs().get_logger(__name__)
+
 
 
 __all__ = ["Timer", "TimerQueueStruct", "TimerQueue"]
@@ -193,7 +193,8 @@ def check_and_execute(self) -> float:
             try:
                 timer()
             except Exception:
-                logging.error(traceback.format_exc())  # deprecated
+                logging.error(traceback.format_exc())
+                logger = Logs().get_logger(__name__)# deprecated
                 logger.error(traceback.format_exc())
 
         self.reset_timers(expired_timers)
@@ -241,6 +242,7 @@ def start(self):
         self._started = True
 
         self._thr.start()
+        logger = Logs().get_logger(__name__)
         logger.info("TimerQueue started.")
 
     def stop(self):
@@ -294,7 +296,8 @@ def _check_and_execute(self):
                     # Note, please make timer callback effective/short
                     timer()
                 except Exception:
-                    logging.error(traceback.format_exc())  # deprecated
+                    logging.error(traceback.format_exc())
+                    logger = Logs().get_logger(__name__)# deprecated
                     logger.error(traceback.format_exc())
 
             self._reset_timers(expired_timers)

solnlib/utils.py

@@ -26,10 +26,8 @@
 from typing import Any, Callable, List, Tuple, Union
 from urllib import parse as urlparse
 
-
 from solnlib.log import Logs
 
-logger = Logs().get_logger(__name__)
 
 __all__ = [
     "handle_teardown_signals",
@@ -162,11 +160,6 @@ def wrapper(*args, **kwargs):
                         func.__name__,
                         traceback.format_exc(),
                     )  # deprecated
-                    logger.warning(
-                        "Run function: %s failed: %s.",
-                        func.__name__,
-                        traceback.format_exc(),
-                    )
                     if not exceptions or any(
                         isinstance(e, exception) for exception in exceptions
                     ):
@@ -229,3 +222,14 @@ def get_appname_from_path(absolute_path):
                 pass
             continue
     return "-"
+
+
+def get_solnlib_logger(name):
+    _logger = None
+
+    def logger():
+        nonlocal _logger
+        if _logger is None:
+            _logger = Logs().get_logger(name)
+        return _logger
+    return logger

tests/integration/conftest.py

@@ -1,33 +1,11 @@
 import os
 import sys
-import os.path as op
-from unittest.mock import MagicMock
 
 import pytest
 
 import context
 
 
-cur_dir = op.dirname(op.abspath(__file__))
-
-
-# Mock only once globally, before anything imports `log.py`
-mock_msp = MagicMock(return_value=op.sep.join([cur_dir, "data/mock_log"]))
-mock_bundle_paths = MagicMock()
-mock_bundle_paths.make_splunkhome_path = mock_msp
-
-sys.modules["splunk"] = MagicMock()
-sys.modules["splunk.clilib"] = MagicMock()
-sys.modules["splunk.clilib.bundle_paths"] = mock_bundle_paths
-
-
-@pytest.fixture(autouse=True)
-def patch_log_msp(monkeypatch):
-    """Ensure log.msp is patched in all tests after mocking sys.modules."""
-    from solnlib import log  # only import after sys.modules is patched
-    monkeypatch.setattr(log, "msp", mock_msp)
-
-
 @pytest.fixture(autouse=True, scope="session")
 def setup_env():
     # path manipulation get the 'splunk' library for the imports while running on GH Actions