|
| 1 | +"""Tests for Worker.main() CLI logging options.""" |
| 2 | + |
| 3 | +from __future__ import annotations |
| 4 | + |
| 5 | +import logging |
| 6 | +from typing import TYPE_CHECKING |
| 7 | + |
| 8 | +import pytest |
| 9 | + |
| 10 | +from vgi.logging_config import ( |
| 11 | + _KNOWN_LOGGERS, |
| 12 | + LogFormat, |
| 13 | + LogLevel, |
| 14 | + configure_worker_logging, |
| 15 | +) |
| 16 | + |
| 17 | +if TYPE_CHECKING: |
| 18 | + from collections.abc import Iterator |
| 19 | + |
| 20 | +# All known logger names from the registry |
| 21 | +_ALL_LOGGER_NAMES = [name for name, _, _ in _KNOWN_LOGGERS] |
| 22 | + |
| 23 | + |
| 24 | +@pytest.fixture(autouse=False) |
| 25 | +def _reset_loggers() -> Iterator[None]: |
| 26 | + """Save and restore logger handlers and levels after each test.""" |
| 27 | + saved: dict[str, tuple[int, list[logging.Handler]]] = {} |
| 28 | + for name in _ALL_LOGGER_NAMES: |
| 29 | + logger = logging.getLogger(name) |
| 30 | + saved[name] = (logger.level, list(logger.handlers)) |
| 31 | + yield |
| 32 | + for name in _ALL_LOGGER_NAMES: |
| 33 | + logger = logging.getLogger(name) |
| 34 | + level, handlers = saved[name] |
| 35 | + logger.handlers[:] = handlers |
| 36 | + logger.setLevel(level) |
| 37 | + |
| 38 | + |
| 39 | +class TestConfigureWorkerLogging: |
| 40 | + """Tests for configure_worker_logging() options.""" |
| 41 | + |
| 42 | + def test_debug_flag(self, _reset_loggers: None) -> None: |
| 43 | + """``--debug`` sets vgi + vgi_rpc loggers to DEBUG.""" |
| 44 | + configure_worker_logging(debug=True) |
| 45 | + for name in ("vgi", "vgi_rpc"): |
| 46 | + logger = logging.getLogger(name) |
| 47 | + assert logger.level == logging.DEBUG |
| 48 | + assert len(logger.handlers) == 1 |
| 49 | + |
| 50 | + def test_log_level_option(self, _reset_loggers: None) -> None: |
| 51 | + """``--log-level WARNING`` sets correct level.""" |
| 52 | + configure_worker_logging(log_level=LogLevel.WARNING) |
| 53 | + for name in ("vgi", "vgi_rpc"): |
| 54 | + logger = logging.getLogger(name) |
| 55 | + assert logger.level == logging.WARNING |
| 56 | + |
| 57 | + def test_log_logger_targeting(self, _reset_loggers: None) -> None: |
| 58 | + """``--log-logger vgi.worker`` targets only that logger.""" |
| 59 | + configure_worker_logging(log_level=LogLevel.DEBUG, log_loggers=["vgi.worker"]) |
| 60 | + target = logging.getLogger("vgi.worker") |
| 61 | + assert target.level == logging.DEBUG |
| 62 | + assert len(target.handlers) == 1 |
| 63 | + # Root vgi logger should not have been modified |
| 64 | + root = logging.getLogger("vgi") |
| 65 | + assert root.handlers == [] or root.level != logging.DEBUG |
| 66 | + |
| 67 | + def test_log_format_json(self, _reset_loggers: None) -> None: |
| 68 | + """``--log-format json`` uses VgiJsonFormatter.""" |
| 69 | + from vgi_rpc.logging_utils import VgiJsonFormatter |
| 70 | + |
| 71 | + configure_worker_logging(debug=True, log_format=LogFormat.json) |
| 72 | + logger = logging.getLogger("vgi") |
| 73 | + assert any(isinstance(h.formatter, VgiJsonFormatter) for h in logger.handlers) |
| 74 | + |
| 75 | + def test_debug_overrides_log_level(self, _reset_loggers: None) -> None: |
| 76 | + """``--debug --log-level INFO`` resolves to DEBUG.""" |
| 77 | + configure_worker_logging(debug=True, log_level=LogLevel.INFO) |
| 78 | + logger = logging.getLogger("vgi") |
| 79 | + assert logger.level == logging.DEBUG |
| 80 | + |
| 81 | + def test_unknown_logger_warning(self, _reset_loggers: None, capsys: pytest.CaptureFixture[str]) -> None: |
| 82 | + """Unrecognized logger name warns on stderr.""" |
| 83 | + configure_worker_logging(log_level=LogLevel.DEBUG, log_loggers=["not.a.real.logger"]) |
| 84 | + captured = capsys.readouterr() |
| 85 | + assert "warning: unknown logger 'not.a.real.logger'" in captured.err |
| 86 | + |
| 87 | + def test_configure_idempotent(self, _reset_loggers: None) -> None: |
| 88 | + """Calling configure_worker_logging() twice doesn't duplicate handlers.""" |
| 89 | + configure_worker_logging(debug=True) |
| 90 | + configure_worker_logging(debug=True) |
| 91 | + logger = logging.getLogger("vgi") |
| 92 | + assert len(logger.handlers) == 1 |
| 93 | + |
| 94 | + def test_returns_effective_level(self, _reset_loggers: None) -> None: |
| 95 | + """Return value is the numeric log level.""" |
| 96 | + level = configure_worker_logging(log_level=LogLevel.WARNING) |
| 97 | + assert level == logging.WARNING |
| 98 | + |
| 99 | + level = configure_worker_logging(debug=True, log_level=LogLevel.WARNING) |
| 100 | + assert level == logging.DEBUG |
| 101 | + |
| 102 | + def test_text_format_has_timestamp(self, _reset_loggers: None) -> None: |
| 103 | + """Text format includes asctime in the formatter.""" |
| 104 | + configure_worker_logging(log_format=LogFormat.text) |
| 105 | + logger = logging.getLogger("vgi") |
| 106 | + assert len(logger.handlers) == 1 |
| 107 | + fmt = logger.handlers[0].formatter |
| 108 | + assert fmt is not None |
| 109 | + assert fmt._fmt is not None |
| 110 | + assert "asctime" in fmt._fmt |
0 commit comments