feat: add parameter validations to decorator. add a unit test

Author: lpm0073

secure_logger/decorators.py

@@ -6,6 +6,7 @@
 
 # our stuff
 from secure_logger.conf import settings
+from secure_logger.exceptions import SecureLoggerConfigurationError
 from secure_logger.masked_dict import masked_dict2str
 
 
@@ -17,6 +18,14 @@ def secure_logger(
 ):
     """Top level decorator, for defining input parameters."""
 
+    logging_levels = list(settings.logging_levels)
+    if log_level not in logging_levels:
+        raise SecureLoggerConfigurationError(f"Invalid logging level: {log_level}. Valid values are: {logging_levels}")
+    if indent < 0:
+        raise SecureLoggerConfigurationError(f"Invalid indentation value: {indent}. Valid values are: 0 or greater.")
+    if message == "":
+        raise SecureLoggerConfigurationError(f"Invalid redaction message: {message}. Must be a non-empty string.")
+
     def decorate(func):
         """
         Decorate a Python a class, a class method, or a function.

secure_logger/tests/tests.py

@@ -10,6 +10,7 @@
 
 from secure_logger.conf import settings
 from secure_logger.decorators import secure_logger
+from secure_logger.exceptions import SecureLoggerConfigurationError
 from secure_logger.masked_dict import masked_dict, masked_dict2str
 
 
@@ -166,6 +167,26 @@ def test_class_method_with_custom_params(self):
 
         self.assertEqual(cm.output[0][0:100], expected_output[0:100])
 
+    def test_method_with_illegal_decorator_input(self):
+        """Test class method with illegal decorator input."""
+
+        def create_mock_class():
+            """Create a mock class with illegal decorator input."""
+
+            class MockClass:
+                """Mock class with illegal decorator input."""
+
+                @secure_logger(indent=-1)
+                def decorator_with_invalid_params(self):
+                    """Test class input parameter as objects."""
+
+            return MockClass()
+
+        self.assertRaises(
+            SecureLoggerConfigurationError,
+            create_mock_class,
+        )
+
 
 class TestClassDecorator(unittest.TestCase):
     """Test class logging."""