test: test general configuration and log output

Author: fleetingbytes

pyproject.toml

@@ -30,6 +30,7 @@ lint = [
 ]
 test = [
     "pytest>=8.4.2",
+    "watchdog>=6.0.0",
 ]
 
 [project.urls]

ruff.toml

@@ -0,0 +1,58 @@
+line-length = 108
+
+[format]
+line-ending = "lf"
+docstring-code-format = true
+
+[lint]
+preview = true
+select = [
+    "B",       # flake8-bugbear
+    "C901",    # mcabe
+    "E",       # pycodestyle errors
+    "ERA",     # eradicate (commented-out-code)
+    "F",       # pyflakes
+    "FLY",     # flynt
+    "G",       # flake8-logging-format
+    "I",       # isort
+    "ICN",     # flake8-import-conventions
+    "INT",     # flake8-gettext
+    "ISC",     # flake8-implicit-str-concat
+    "LOG",     # flake8-logging
+    "N",       # pep8-naming
+    "PERF",    # Perflint
+    "PL",      # pylint
+    "Q",       # quotes
+    "RUF",     # ruff-specific rules
+    "SIM",     # flake8-simplify
+    "TC",      # flake8-type-checking
+    "TID251",  # banned-api
+    "TID253",  # banned-module-level-imports
+    "UP",      # pyupgrade
+    "W",       # pycodestyle warnings
+]
+
+[lint.per-file-ignores]
+"src/**/cli/__init__.py" = [
+    "N813",  # camelcase-imported-as-lowercase
+]
+"tests/test_general.py" = [
+    "N813",  # camelcase-imported-as-lowercase
+]
+"tests/test_log.py" = [
+    "N813",  # camelcase-imported-as-lowercase
+]
+"src/readylog/__init__.py" = [
+    "PLR0913",  # too-many-arguments
+    "PLR0914",  # too-many-local-variables
+    "PLR0917",  # too-many-positional-arguments
+]
+
+extend-safe-fixes = [
+    "TC001",  # typing-only-first-party-import
+    "TC002",  # typing-only-third-party-import
+    "TC003",  # typing-only-standard-library-import
+]
+
+[lint.mccabe]
+max-complexity = 5

tests/__init__.py

@@ -0,0 +1,41 @@
+from pytest import FixtureRequest, fixture
+from watchdog.events import FileModifiedEvent, FileSystemEventHandler
+from watchdog.observers import Observer
+
+
+@fixture
+def tmp_log_file(tmp_path):
+    path = tmp_path / "log" / "debug.log"
+    path.parent.mkdir(parents=True, exist_ok=False)
+    return path
+
+
+@fixture
+def app_name():
+    return "test_app"
+
+
+@fixture
+def log_file_observer(tmp_log_file, request: FixtureRequest) -> Observer:
+    expected_number_of_log_lines = request.param
+
+    class LogFileChangeHandler(FileSystemEventHandler):
+        @staticmethod
+        def on_modified(event: FileModifiedEvent):
+            if event.src_path.endswith(tmp_log_file.name):
+                pass
+
+    observer = Observer()
+    handler = LogFileChangeHandler()
+    tmp_log_file.touch()
+    observer.schedule(handler, path=tmp_log_file, recursive=False)
+    observer.start()
+    yield observer
+
+    with open(tmp_log_file, encoding="utf-8") as f:
+        lines = f.readlines()
+    number_of_log_lines = len(lines)
+    assert number_of_log_lines == expected_number_of_log_lines
+
+    observer.stop()
+    observer.join()

tests/conftest.py

@@ -0,0 +1,6 @@
+from logging import getLevelNamesMapping
+
+IGNORED_LEVEL = "NOTSET"
+
+USABLE_LEVELS = {k: v for k, v in getLevelNamesMapping().items() if k != IGNORED_LEVEL}
+USABLE_LEVEL_NAMES = tuple(key for key in USABLE_LEVELS)

tests/constants.py

@@ -0,0 +1,33 @@
+from pytest import mark, param, raises
+
+from readylog import create_dict_config
+
+
+def test_config_creation(tmp_log_file, app_name):
+    _ = create_dict_config(tmp_log_file, app_name)
+
+
+@mark.parametrize(
+    "kwargs",
+    (
+        param({"console_log_level": "TRACE"}, id="console"),
+        param({"file_log_level": "TRACE"}, id="file"),
+        param({"console_log_level": "TRACE", "file_log_level": "IMPORTANT"}, id="console, file"),
+    ),
+)
+def test_config_creation_with_wrong_level(tmp_log_file, app_name, kwargs):
+    with raises(AssertionError):
+        _ = create_dict_config(tmp_log_file, app_name, **kwargs)
+
+
+@mark.parametrize(
+    "kwargs, expected",
+    (
+        param({"console_log_level": "DEBUG", "file_log_level": "INFO"}, "DEBUG", id="debug, info"),
+        param({"console_log_level": "INFO", "file_log_level": "DEBUG"}, "DEBUG", id="info, debug"),
+    ),
+)
+def test_logger_level(tmp_log_file, app_name, kwargs, expected):
+    d = create_dict_config(tmp_log_file, app_name, **kwargs)
+    actual = d["loggers"][app_name]["level"]
+    assert actual == expected

tests/test_general.py

@@ -0,0 +1,55 @@
+from logging import Logger
+from logging import getLogger as get_logger
+from logging.config import dictConfig as configure_logging
+from pathlib import Path
+
+from pytest import CaptureFixture, mark, param
+from watchdog.observers import Observer
+
+from readylog import create_dict_config
+from tests.constants import USABLE_LEVEL_NAMES, USABLE_LEVELS
+
+
+def produce_log_messages_on_all_levels(logger: Logger) -> None:
+    for level_name, level in USABLE_LEVELS.items():
+        message = f"this is a {level_name.lower()} message"
+        logger.log(level, message)
+
+
+def expected_number_of_log_lines(limit: int) -> int:
+    number_of_levels_at_or_above_limit = len(tuple(filter(lambda n: n >= limit, USABLE_LEVELS.values())))
+    return number_of_levels_at_or_above_limit
+
+
+@mark.parametrize("log_level", USABLE_LEVEL_NAMES, ids=str.lower)
+def test_console_log(tmp_log_file: Path, app_name: str, log_level, capsys: CaptureFixture):
+    config = create_dict_config(tmp_log_file, app_name, console_log_level=log_level)
+    configure_logging(config)
+    logger = get_logger(app_name)
+
+    produce_log_messages_on_all_levels(logger)
+
+    captured = capsys.readouterr()
+    lines = captured.err.strip().split("\n")
+    number_of_lines = len(lines)
+
+    limit = USABLE_LEVELS[log_level]
+    assert number_of_lines == expected_number_of_log_lines(limit)
+
+
+@mark.parametrize(
+    "log_file_observer, log_level_name",
+    (
+        *(
+            param(expected_number_of_log_lines(level), level_name, id=level_name.lower())
+            for level_name, level in USABLE_LEVELS.items()
+        ),
+    ),
+    indirect=["log_file_observer"],
+)
+def test_file_log(tmp_log_file: Path, app_name: str, log_file_observer: Observer, log_level_name):
+    config = create_dict_config(tmp_log_file, app_name, file_log_level=log_level_name)
+    configure_logging(config)
+    logger = get_logger(app_name)
+
+    produce_log_messages_on_all_levels(logger)