feat: add get_log_level method

Author: artemrys

solnlib/conf_manager.py

@@ -456,7 +456,7 @@ def get_conf(self, name: str, refresh: bool = False) -> ConfFile:
         try:
             conf = self._confs[name]
         except KeyError:
-            raise ConfManagerException("Config file: %s does not exist." % name)
+            raise ConfManagerException(f"Config file: {name} does not exist.")
 
         return ConfFile(
             name,
@@ -498,3 +498,60 @@ def create_conf(self, name: str) -> ConfFile:
             self._realm,
             **self._context,
         )
+
+
+def get_log_level(
+    *,
+    logger: logging.Logger,
+    session_key: str,
+    app_name: str,
+    conf_name: str,
+    log_level_field: str = "loglevel",
+    default_log_level: str = "INFO",
+) -> str:
+    """This function returns the log level for the addon from configuration
+    file.
+
+    Arguments:
+        logger: Logger.
+        session_key: Splunk access token.
+        app_name: Add-on name.
+        conf_name: Configuration file name where logging stanza is.
+        log_level_field: Logging level field name under logging stanza.
+        default_log_level: Default log level to return in case of errors.
+
+    Returns:
+        Log level defined under `logging.log_level_field` field in `conf_name`
+        file. In case of any error, `default_log_level` will be returned.
+
+    Examples:
+        >>> from solnlib import conf_manager
+        >>> log_level = conf_manager.get_log_level(
+        >>>     logger,
+        >>>     "session_key",
+        >>>     "ADDON_NAME",
+        >>>     "splunk_ta_addon_settings",
+        >>> )
+    """
+    try:
+        cfm = ConfManager(
+            session_key,
+            app_name,
+            realm=f"__REST_CREDENTIAL__#{app_name}#configs/conf-{conf_name}",
+        )
+        conf = cfm.get_conf(conf_name)
+    except ConfManagerException:
+        logger.error(
+            f"Failed to fetch configuration file {conf_name}, "
+            f"taking {default_log_level} as log level."
+        )
+        return default_log_level
+    try:
+        logging_details = conf.get("logging")
+        return logging_details.get(log_level_field, default_log_level)
+    except ConfStanzaNotExistException:
+        logger.error(
+            f'"logging" stanza does not exist under {conf_name}, '
+            f"taking {default_log_level} as log level."
+        )
+        return default_log_level

tests/integration/data/solnlib_demo/default/splunk_ta_addon_settings.conf

@@ -0,0 +1,2 @@
+[logging]
+log_level = DEBUG

tests/integration/test_conf_manager.py

@@ -16,6 +16,7 @@
 
 import os.path as op
 import sys
+from unittest import mock
 
 import pytest
 
@@ -53,3 +54,32 @@ def test_conf_manager():
     with pytest.raises(conf_manager.ConfStanzaNotExistException):
         conf.delete("test_stanza")
     conf.reload()
+
+
+def test_get_log_level():
+    session_key = context.get_session_key()
+    expected_log_level = "DEBUG"
+
+    log_level = conf_manager.get_log_level(
+        logger=mock.MagicMock(),
+        session_key=session_key,
+        app_name="solnlib_demo",
+        conf_name="splunk_ta_addon_settings",
+        log_level_field="log_level",
+    )
+
+    assert expected_log_level == log_level
+
+
+def test_get_log_level_incorrect_log_level_field():
+    session_key = context.get_session_key()
+    expected_log_level = "INFO"
+
+    log_level = conf_manager.get_log_level(
+        logger=mock.MagicMock(),
+        session_key=session_key,
+        app_name="solnlib_demo",
+        conf_name="splunk_ta_addon_settings",
+    )
+
+    assert expected_log_level == log_level

tests/unit/test_conf_manager.py

@@ -15,6 +15,7 @@
 #
 
 import hashlib
+from unittest import mock
 
 import common
 import pytest
@@ -204,3 +205,19 @@ def mock_stanza_submit(self, stanza):
     with pytest.raises(conf_manager.ConfStanzaNotExistException):
         conf.delete("test_stanza")
     conf.reload()
+
+
+@mock.patch.object(conf_manager, "ConfManager")
+def test_get_log_level_when_error_getting_conf(mock_conf_manager_class):
+    mock_conf_manager = mock_conf_manager_class.return_value
+    mock_conf_manager.get_conf.side_effect = conf_manager.ConfManagerException
+    expected_log_level = "INFO"
+
+    log_level = conf_manager.get_log_level(
+        logger=mock.MagicMock(),
+        session_key="session_key",
+        app_name="app_name",
+        conf_name="conf_name",
+    )
+
+    assert expected_log_level == log_level