S allius/issue288 (#289)

* remove apostrophes from fmt strings

- thanks to @onkelenno for the suggestion

* improve the logger initializing

- don't overwrite the logging.ini settings if the
env variable LOG_LVL isn't well defined
- Thanks to @onkelenno for the idea to improve

* set default argument for LOG_LVL to INFO in docker files

* adapt unit test

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+- Respect logging.ini file, if LOG_ENV isn't set well [#288](https://github.com/s-allius/tsun-gen3-proxy/issues/288)
+- Remove trailing apostrophe in the log output [#288](https://github.com/s-allius/tsun-gen3-proxy/issues/288)
 - Update AddOn base docker image to version 17.1.3 and python3 to 3.12.9-r0
 - add initial DCU support
 - update AddOn base docker image to version 17.1.2

app/Dockerfile

@@ -30,7 +30,7 @@ ARG SERVICE_NAME
 ARG VERSION
 ARG UID
 ARG GID
-ARG LOG_LVL
+ARG LOG_LVL=INFO
 ARG environment
 
 ENV SERVICE_NAME=$SERVICE_NAME

app/src/logging.ini

@@ -67,10 +67,10 @@ formatter=file_formatter
 args=(handlers.log_path + 'trace.log', when:='midnight', backupCount:=handlers.log_backups)
 
 [formatter_console_formatter]
-format=%(asctime)s %(levelname)5s | %(name)4s | %(message)s'
-datefmt='%Y-%m-%d %H:%M:%S
+format=%(asctime)s %(levelname)5s | %(name)4s | %(message)s
+datefmt=%Y-%m-%d %H:%M:%S
 
 [formatter_file_formatter]
-format=%(asctime)s %(levelname)5s | %(name)4s | %(message)s'
-datefmt='%Y-%m-%d %H:%M:%S
+format=%(asctime)s %(levelname)5s | %(name)4s | %(message)s
+datefmt=%Y-%m-%d %H:%M:%S
 

app/src/server.py

@@ -117,19 +117,19 @@ async def handle_shutdown(loop, web_task):
     loop.stop()
 
 
-def get_log_level() -> int:
+def get_log_level() -> int | None:
     '''checks if LOG_LVL is set in the environment and returns the
     corresponding logging.LOG_LEVEL'''
-    log_level = os.getenv('LOG_LVL', 'INFO')
+    switch = {
+        'DEBUG': logging.DEBUG,
+        'WARN': logging.WARNING,
+        'INFO': logging.INFO,
+        'ERROR': logging.ERROR,
+    }
+    log_level = os.getenv('LOG_LVL', None)
     logging.info(f"LOG_LVL    : {log_level}")
 
-    if log_level == 'DEBUG':
-        log_level = logging.DEBUG
-    elif log_level == 'WARN':
-        log_level = logging.WARNING
-    else:
-        log_level = logging.INFO
-    return log_level
+    return switch.get(log_level, None)
 
 
 def main():   # pragma: no cover
@@ -172,15 +172,15 @@ def main():   # pragma: no cover
         logging.info(f"log_backups: {args.log_backups} days")
     log_level = get_log_level()
     logging.info('******')
-
-    # set lowest-severity for 'root', 'msg', 'conn' and 'data' logger
-    logging.getLogger().setLevel(log_level)
-    logging.getLogger('msg').setLevel(log_level)
-    logging.getLogger('conn').setLevel(log_level)
-    logging.getLogger('data').setLevel(log_level)
-    logging.getLogger('tracer').setLevel(log_level)
-    logging.getLogger('asyncio').setLevel(log_level)
-    # logging.getLogger('mqtt').setLevel(log_level)
+    if log_level:
+        # set lowest-severity for 'root', 'msg', 'conn' and 'data' logger
+        logging.getLogger().setLevel(log_level)
+        logging.getLogger('msg').setLevel(log_level)
+        logging.getLogger('conn').setLevel(log_level)
+        logging.getLogger('data').setLevel(log_level)
+        logging.getLogger('tracer').setLevel(log_level)
+        logging.getLogger('asyncio').setLevel(log_level)
+        # logging.getLogger('mqtt').setLevel(log_level)
 
     loop = asyncio.new_event_loop()
     asyncio.set_event_loop(loop)

app/tests/test_server.py

@@ -7,18 +7,26 @@ from server import get_log_level
 
 def test_get_log_level():
 
-    with patch.dict(os.environ, {'LOG_LVL': ''}):
+    with patch.dict(os.environ, {}):
         log_lvl = get_log_level()
-        assert log_lvl == logging.INFO
+        assert log_lvl == None
 
     with patch.dict(os.environ, {'LOG_LVL': 'DEBUG'}):
         log_lvl = get_log_level()
         assert log_lvl == logging.DEBUG
 
+    with patch.dict(os.environ, {'LOG_LVL': 'INFO'}):
+        log_lvl = get_log_level()
+        assert log_lvl == logging.INFO
+
     with patch.dict(os.environ, {'LOG_LVL': 'WARN'}):
         log_lvl = get_log_level()
         assert log_lvl == logging.WARNING
 
+    with patch.dict(os.environ, {'LOG_LVL': 'ERROR'}):
+        log_lvl = get_log_level()
+        assert log_lvl == logging.ERROR
+
     with patch.dict(os.environ, {'LOG_LVL': 'UNKNOWN'}):
         log_lvl = get_log_level()
-        assert log_lvl == logging.INFO
+        assert log_lvl == None

ha_addons/ha_addon/Dockerfile

@@ -47,6 +47,8 @@ FROM base AS runtime
 
 ARG SERVICE_NAME
 ARG VERSION
+ARG LOG_LVL=INFO
+ENV LOG_LVL=$LOG_LVL
 ENV SERVICE_NAME=${SERVICE_NAME}