|
| 1 | +"""Tests for runtime logging setup.""" |
| 2 | + |
| 3 | +import io |
| 4 | +import logging |
| 5 | +import re |
| 6 | + |
| 7 | +import pytest |
| 8 | + |
| 9 | +from typer_bot.utils import logger as logger_module |
| 10 | + |
| 11 | + |
| 12 | +@pytest.fixture(autouse=True) |
| 13 | +def restore_logging_state(): |
| 14 | + root_logger = logging.getLogger() |
| 15 | + root_handlers = list(root_logger.handlers) |
| 16 | + root_level = root_logger.level |
| 17 | + discord_level = logging.getLogger("discord").level |
| 18 | + discord_http_level = logging.getLogger("discord.http").level |
| 19 | + trace_id = logger_module.get_trace_id() |
| 20 | + log_context = logger_module.get_log_context() |
| 21 | + |
| 22 | + yield |
| 23 | + |
| 24 | + root_logger.handlers.clear() |
| 25 | + root_logger.handlers.extend(root_handlers) |
| 26 | + root_logger.setLevel(root_level) |
| 27 | + logging.getLogger("discord").setLevel(discord_level) |
| 28 | + logging.getLogger("discord.http").setLevel(discord_http_level) |
| 29 | + logger_module.set_trace_id(trace_id) |
| 30 | + logger_module.clear_log_context() |
| 31 | + logger_module.set_log_context(**log_context) |
| 32 | + |
| 33 | + |
| 34 | +def _configure_and_emit(monkeypatch, output: io.StringIO, logger_name: str = "test.logger") -> str: |
| 35 | + monkeypatch.setattr(logger_module.sys, "stdout", output) |
| 36 | + |
| 37 | + logger_module.setup_logging(logging.INFO) |
| 38 | + logging.getLogger(logger_name).info("readable message") |
| 39 | + |
| 40 | + return output.getvalue().splitlines()[-1] |
| 41 | + |
| 42 | + |
| 43 | +def test_setup_logging_emits_plain_logs(monkeypatch): |
| 44 | + output = io.StringIO() |
| 45 | + |
| 46 | + log_line = _configure_and_emit(monkeypatch, output, "test.plain") |
| 47 | + |
| 48 | + assert "\x1b[" not in log_line |
| 49 | + assert not log_line.startswith("{") |
| 50 | + assert re.match(r"^20\d{2}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\+00:00\s", log_line) |
| 51 | + assert "INFO" in log_line |
| 52 | + assert "test.plain" in log_line |
| 53 | + assert "readable message" in log_line |
| 54 | + |
| 55 | + |
| 56 | +def test_setup_logging_includes_context_and_extra_fields(monkeypatch): |
| 57 | + output = io.StringIO() |
| 58 | + monkeypatch.setattr(logger_module.sys, "stdout", output) |
| 59 | + |
| 60 | + logger_module.set_trace_id("req-1") |
| 61 | + logger_module.set_log_context(guild_id="guild-1") |
| 62 | + logger_module.setup_logging(logging.INFO) |
| 63 | + logging.getLogger("test.context").info( |
| 64 | + "context message", |
| 65 | + extra={ |
| 66 | + "event_type": "prediction.saved", |
| 67 | + "error_detail": "Fixture not found", |
| 68 | + "payload": {2: "second", "token": "secret-value", "safe": "visible"}, |
| 69 | + "token": "secret-value", |
| 70 | + }, |
| 71 | + ) |
| 72 | + |
| 73 | + log_line = output.getvalue().splitlines()[-1] |
| 74 | + assert "context message" in log_line |
| 75 | + assert "secret-value" not in log_line |
| 76 | + assert 'error_detail="Fixture not found"' in log_line |
| 77 | + assert "event_type=prediction.saved" in log_line |
| 78 | + assert "guild_id=guild-1" in log_line |
| 79 | + assert "payload={2:second,safe:visible,token:[REDACTED]}" in log_line |
| 80 | + assert "token=[REDACTED]" in log_line |
| 81 | + assert "trace_id=req-1" in log_line |
| 82 | + |
| 83 | + |
| 84 | +def test_setup_logging_uses_stdout(monkeypatch): |
| 85 | + output = io.StringIO() |
| 86 | + |
| 87 | + _configure_and_emit(monkeypatch, output) |
| 88 | + |
| 89 | + assert "readable message" in output.getvalue() |
| 90 | + |
| 91 | + |
| 92 | +def test_setup_logging_respects_level(monkeypatch): |
| 93 | + output = io.StringIO() |
| 94 | + monkeypatch.setattr(logger_module.sys, "stdout", output) |
| 95 | + |
| 96 | + logger_module.setup_logging(logging.WARNING) |
| 97 | + logging.getLogger("test.level").info("hidden message") |
| 98 | + logging.getLogger("test.level").warning("visible message") |
| 99 | + |
| 100 | + logged = output.getvalue() |
| 101 | + assert "hidden message" not in logged |
| 102 | + assert "WARNING" in logged |
| 103 | + assert "visible message" in logged |
| 104 | + |
| 105 | + |
| 106 | +def test_setup_logging_uses_log_level_env(monkeypatch): |
| 107 | + output = io.StringIO() |
| 108 | + monkeypatch.setattr(logger_module.sys, "stdout", output) |
| 109 | + monkeypatch.setenv("LOG_LEVEL", "WARNING") |
| 110 | + |
| 111 | + logger_module.setup_logging() |
| 112 | + logging.getLogger("test.env_level").info("hidden message") |
| 113 | + logging.getLogger("test.env_level").warning("visible message") |
| 114 | + |
| 115 | + logged = output.getvalue() |
| 116 | + assert "hidden message" not in logged |
| 117 | + assert "WARNING" in logged |
| 118 | + assert "visible message" in logged |
0 commit comments