add log tests

Author: GabrielSalla

.coveragerc

@@ -3,8 +3,6 @@ omit =
     src/_monitors/*
     src/_monitors_load/*
     src/tmp/*
-    src/main.py
-    src/utils/log.py
 exclude_lines =
     pragma: no cover
     if TYPE_CHECKING:

configs.yaml

@@ -18,9 +18,9 @@ logging:
     timestamp: created
     level: levelname
     file_path: pathname
-    logger_name: name
     function_name: funcName
     line_number: lineno
+    logger_name: name
     message: message
 
 # Application database pool settings

src/main.py

@@ -1,3 +1,5 @@
+# pragma: no cover
+
 import asyncio
 import logging
 import sys

tests/utils/test_log.py

@@ -0,0 +1,103 @@
+import json
+import logging
+import re
+
+import pytest
+
+import utils.log as log
+from configs import FriendlyLogConfig, JsonLogConfig, configs
+
+TIMESTAMP_PATTERN = r"\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d*"
+
+
+@pytest.fixture(scope="module", autouse=True)
+def reset_logging_config():
+    """Reset logging configuration after the log tests"""
+    yield
+    log.setup()
+
+
+@pytest.fixture(scope="module", autouse=True)
+def force_logging_setup(monkeypatch, reset_logging_config):
+    """Force the logging setup to reconfigure the logging configuration"""
+    logging_basicConfig = logging.basicConfig
+    monkeypatch.setattr(
+        logging,
+        "basicConfig",
+        lambda *args, **kwargs: logging_basicConfig(*args, force=True, **kwargs),
+    )
+
+
+def set_friendly_formatter(monkeypatch, log_format: str) -> None:
+    """Set the friendly formatter for the logging configuration"""
+    monkeypatch.setattr(configs, "logging", FriendlyLogConfig(mode="friendly", format=log_format))
+    log.setup()
+
+
+def set_json_formatter(monkeypatch, fields: dict[str, str]) -> None:
+    """Set the JSON formatter for the logging configuration"""
+    monkeypatch.setattr(configs, "logging", JsonLogConfig(mode="json", fields=fields))
+    log.setup()
+
+
+@pytest.mark.parametrize(
+    "log_format",
+    [
+        "%(asctime)s %(levelname)s: %(message)s",
+        "%(asctime)s %(levelname)s %(message)s",
+        "%(levelname)s %(message)s",
+    ],
+)
+@pytest.mark.parametrize("level", ["info", "warning", "error"])
+def test_friendly_formatter(caplog, monkeypatch, log_format, level):
+    """'friendly' formatter should format the log message in a friendly way using the provided log
+    format"""
+    set_friendly_formatter(monkeypatch, log_format)
+
+    logger = logging.getLogger("test_friendly_formatter")
+    message = f"message for '{level}' level"
+    getattr(logger, level)(message)
+
+    expected_levelname = level.upper()
+    log_format = log_format.format(asctime=TIMESTAMP_PATTERN)
+
+    match = re.match(
+        log_format.format(levelname=expected_levelname, message=message),
+        caplog.records[0].message,
+    )
+    assert match is not None
+
+
+@pytest.mark.parametrize(
+    "fields",
+    [
+        {"message": "message"},
+        {"some_message": "message"},
+        {"message": "message", "level": "level"},
+        {"some_message": "message", "log_level": "level"},
+        {"message": "message", "level": "level", "time": "asctime"},
+        {"some_message": "message", "log_level": "level", "timestamp": "asctime"},
+
+    ],
+)
+@pytest.mark.parametrize("level", ["info", "warning", "error"])
+def test_json_formatter(caplog, monkeypatch, fields, level):
+    """'json' formatter should format the log message as a JSON object using the provided fields"""
+    set_json_formatter(monkeypatch, fields)
+
+    logger = logging.getLogger("test_json_formatter")
+    message = f"message for '{level}' level"
+    getattr(logger, level)(message)
+
+    log_info = json.loads(caplog.records[0].message)
+
+    for key, value in log_info.items():
+        if key in ("message", "some_message"):
+            assert value == message
+        elif key in ("level", "log_level"):
+            assert value == level.upper()
+        elif key in ("time", "timestamp"):
+            match = re.match(TIMESTAMP_PATTERN, value)
+            assert match is not None
+        else:
+            assert False, "Unexpected field in log"