Sanitizes MWI_LOG_LEVEL environment variable before setting log level

Author: pranaverma92

matlab_proxy/util/mwi/logger.py

@@ -1,4 +1,4 @@
-# Copyright 2020-2023 The MathWorks, Inc.
+# Copyright 2020-2024 The MathWorks, Inc.
 """Functions to access & control the logging behavior of the app
 """
 
@@ -52,7 +52,17 @@ def __set_logging_configuration():
     # query for user specified environment variables
     log_level = os.getenv(
         mwi_env.get_env_name_logging_level(), __get_default_log_level()
-    )
+    ).upper()
+
+    valid = __is_valid_log_level(log_level)
+
+    if not valid:
+        default_log_level = __get_default_log_level()
+        logging.warn(
+            f"Unknown log level '{log_level}' set. Defaulting to log level '{default_log_level}'..."
+        )
+        log_level = default_log_level
+
     log_file = os.getenv(mwi_env.get_env_name_log_file(), None)
 
     ## Set logging object
@@ -110,3 +120,13 @@ def __get_default_log_level():
         String: The default logging level
     """
     return "INFO"
+
+
+def __is_valid_log_level(log_level):
+    """Helper to check if the log level is valid.
+
+    Returns:
+        Boolean: Whether log level  exists
+    """
+
+    return hasattr(logging, log_level)

tests/unit/util/mwi/test_logger.py

@@ -1,10 +1,10 @@
-# Copyright 2020-2022 The MathWorks, Inc.
+# Copyright 2020-2024 The MathWorks, Inc.
 """This file tests methods present in matlab_proxy/util/mwi_logger.py
 """
 
 import logging
 import os
-
+import pytest
 from matlab_proxy.util.mwi import logger as mwi_logger
 
 
@@ -22,7 +22,7 @@ def test_get_mw_logger_name():
 
 
 def test_get_with_no_environment_variables(monkeypatch):
-    """This test checks if the get method returns a logger with default settings"""
+    """This test checks if the get method returns a logger with default settings if no environment variable is set"""
     # Delete the environment variables if they do exist
     env_names_list = mwi_logger.get_environment_variable_names()
     monkeypatch.delenv(env_names_list[0], raising=False)
@@ -34,7 +34,7 @@ def test_get_with_no_environment_variables(monkeypatch):
 
 
 def test_get_with_environment_variables(monkeypatch, tmp_path):
-    """This test checks if the get method returns a logger with default settings"""
+    """This test checks if the get method returns a logger with the specified settings"""
     env_names_list = mwi_logger.get_environment_variable_names()
     monkeypatch.setenv(env_names_list[0], "CRITICAL")
     monkeypatch.setenv(env_names_list[1], str(tmp_path / "testing123.log"))
@@ -47,3 +47,37 @@ def test_get_with_environment_variables(monkeypatch, tmp_path):
     # Verify that environment variable setting the file is respected
     assert len(logger.handlers) == 1
     assert os.path.basename(logger.handlers[0].baseFilename) == "testing123.log"
+
+
+@pytest.mark.parametrize(
+    "log_level, expected_level",
+    [
+        ("DEBUG", logging.DEBUG),
+        ("INFO", logging.INFO),
+        ("WARNING", logging.WARNING),
+        ("debug", logging.DEBUG),
+        ("info", logging.INFO),
+        ("warning", logging.WARNING),
+    ],
+)
+def test_set_logging_configuration_known_logging_levels(
+    monkeypatch, log_level, expected_level
+):
+    """This test checks if the logger is set with correct level for known log levels"""
+    env_names_list = mwi_logger.get_environment_variable_names()
+    monkeypatch.setenv(env_names_list[0], log_level)
+    logger = mwi_logger.get(init=True)
+    assert (
+        logger.isEnabledFor(expected_level) == True
+    ), f"Error in initialising the logger with {log_level}"
+
+
+@pytest.mark.parametrize("log_level", ["ABC", "abc"])
+def test_set_logging_configuration_unknown_logging_levels(monkeypatch, log_level):
+    """This test checks if the logger is set with INFO level for unknown log levels"""
+    env_names_list = mwi_logger.get_environment_variable_names()
+    monkeypatch.setenv(env_names_list[0], log_level)
+    logger = mwi_logger.get(init=True)
+    assert (
+        logger.isEnabledFor(logging.INFO) == True
+    ), "Error in initialising the default logger"