Improves logger format handling and adds tests

Updates the logger to properly handle and sanitize the `LOG_FORMAT` environment variable.
It now trims whitespace and converts the format to uppercase, ensuring consistency.

Adds new tests to cover JSON and inline log formats, including a scenario with a messy environment configuration.

Author: paulcruse3

acai_aws/common/logger/common_logger.py

@@ -10,7 +10,8 @@ class CommonLogger:
 
     def __init__(self):
         self.__json = jsonpickle
-        self.__format = os.getenv('LOG_FORMAT', 'JSON')
+        env_format = os.getenv('LOG_FORMAT', 'JSON') or 'JSON'
+        self.__format = env_format.strip().upper()
         self.__log_level = os.getenv('LOG_LEVEL', 'INFO')
         self.__json.set_encoder_options('simplejson', use_decimal=True)
         self.__json.set_preferred_backend('simplejson')

tests/acai_aws/common/test_logger.py

@@ -1,4 +1,7 @@
+import io
+import json
 import os
+from contextlib import redirect_stdout
 from unittest import TestCase, mock
 
 from acai_aws.common import logger
@@ -54,6 +57,29 @@ def test_logger_logs_error_inline(self):
         except Exception as error:
             logger.log(level='ERROR', log=error)
 
+    @mock.patch.dict(os.environ, {'RUN_MODE': 'SEE-LOGS', 'LOG_STAGE_VARIABLE': 'STAGE', 'STAGE': 'local', 'LOG_FORMAT': ' inline '})
+    def test_logger_logs_error_inline_with_messy_env(self):
+        logger.log(level='INFO', log={'message': 'inline-format'})
+
+    @mock.patch.dict(os.environ, {'RUN_MODE': 'SEE-LOGS', 'LOG_STAGE_VARIABLE': 'STAGE', 'STAGE': 'local', 'LOG_FORMAT': 'JSON'})
+    def test_logger_json_output(self):
+        buffer = io.StringIO()
+        with redirect_stdout(buffer):
+            logger.log(level='WARN', log={'json': True})
+        log_output = buffer.getvalue().strip()
+        parsed = json.loads(log_output)
+        self.assertEqual('WARN', parsed['level'])
+        self.assertEqual({'json': True}, parsed['log'])
+
+    @mock.patch.dict(os.environ, {'RUN_MODE': 'SEE-LOGS', 'LOG_STAGE_VARIABLE': 'STAGE', 'STAGE': 'local', 'LOG_FORMAT': 'INLINE'})
+    def test_logger_inline_output(self):
+        buffer = io.StringIO()
+        with redirect_stdout(buffer):
+            logger.log(level='INFO', log={'inline': True})
+        log_output = buffer.getvalue().strip()
+        self.assertTrue(log_output.startswith('INFO|'))
+        self.assertIn("inline': True", log_output)
+
     @mock.patch.dict(os.environ, {'RUN_MODE': 'SEE-LOGS', 'LOG_STAGE_VARIABLE': 'STAGE', 'STAGE': 'local'})
     def test_logger_logs_error_as_object(self):
         try:
@@ -96,4 +122,3 @@ def test_logger_handles_bad_level(self):
     @mock.patch.dict(os.environ, {'RUN_MODE': 'SEE-LOGS', 'LOG_STAGE_VARIABLE': 'STAGE', 'STAGE': 'local', 'LOG_LEVEL': 'ERROR', 'LOG_FORMAT': 'BAD'})
     def test_logger_handles_bad_format(self):
         logger.log(level='INFO', log={'INFO': 'ignore'})
-