f95de32cdd
The server wrote gigabytes to ~/.kicad-mcp/logs and ignored LOG_LEVEL. Three root causes, all fixed here (the logging carve-out of #182): - Python (kicad_interface.py): replace the unbounded FileHandler with a RotatingFileHandler (10 MB x 3 backups, env-tunable via KICAD_MCP_LOG_MAX_BYTES / KICAD_MCP_LOG_BACKUP_COUNT); read the level from KICAD_MCP_LOG_LEVEL or LOG_LEVEL (default INFO) instead of hardcoding DEBUG; mute the noisy skip / skip.sexp.* loggers to WARNING unless KICAD_MCP_DEBUG_SKIP is set. - TypeScript (config.ts): honor KICAD_MCP_LOG_LEVEL / LOG_LEVEL for the TS logger. - TypeScript (logger.ts): size-cap the per-day log files with the same env knobs. - Docs + a no-network test for the env helpers, skip muting, and that no unbounded handler targets kicad_interface.log. Verified: LOG_LEVEL is now applied, skip is muted, and the file rotates instead of growing forever. Full suite unchanged from baseline. The hierarchical-sheet rewrite from #182 is intentionally left out (stays as a separate PR pending the #169/#170 design discussion). Co-Authored-By: angelorodem <angelorodem@users.noreply.github.com> Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
114 lines
4.4 KiB
Python
114 lines
4.4 KiB
Python
"""
|
|
Regression tests for env-driven, bounded logging (issue #181).
|
|
|
|
Before this fix kicad_interface.py hardcoded the log level to DEBUG and used a
|
|
plain (unbounded) FileHandler, and the noisy kicad-skip loggers were never
|
|
muted — so ~/.kicad-mcp/logs grew to gigabytes and LOG_LEVEL was ignored.
|
|
|
|
These tests exercise the env-parsing helpers, the skip-logger muting, and that
|
|
no unbounded file handler is installed. No real KiCAD required.
|
|
"""
|
|
|
|
import logging
|
|
import sys
|
|
from logging.handlers import RotatingFileHandler
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
sys.path.insert(0, str(Path(__file__).parent.parent / "python"))
|
|
|
|
from kicad_interface import ( # noqa: E402
|
|
_env_flag_enabled,
|
|
_parse_log_level,
|
|
_parse_positive_int_env,
|
|
)
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestParseLogLevel:
|
|
def test_defaults_to_info_when_unset(self, monkeypatch):
|
|
monkeypatch.delenv("KICAD_MCP_LOG_LEVEL", raising=False)
|
|
monkeypatch.delenv("LOG_LEVEL", raising=False)
|
|
assert _parse_log_level() == logging.INFO
|
|
|
|
def test_reads_log_level_env(self, monkeypatch):
|
|
monkeypatch.delenv("KICAD_MCP_LOG_LEVEL", raising=False)
|
|
monkeypatch.setenv("LOG_LEVEL", "warning")
|
|
assert _parse_log_level() == logging.WARNING
|
|
|
|
def test_kicad_mcp_log_level_takes_precedence(self, monkeypatch):
|
|
monkeypatch.setenv("LOG_LEVEL", "debug")
|
|
monkeypatch.setenv("KICAD_MCP_LOG_LEVEL", "error")
|
|
assert _parse_log_level() == logging.ERROR
|
|
|
|
def test_case_insensitive_and_aliases(self, monkeypatch):
|
|
monkeypatch.delenv("KICAD_MCP_LOG_LEVEL", raising=False)
|
|
for raw, expected in [
|
|
("debug", logging.DEBUG),
|
|
("INFO", logging.INFO),
|
|
("Warn", logging.WARNING),
|
|
("FATAL", logging.CRITICAL),
|
|
]:
|
|
monkeypatch.setenv("LOG_LEVEL", raw)
|
|
assert _parse_log_level() == expected
|
|
|
|
def test_off_disables_logging(self, monkeypatch):
|
|
monkeypatch.delenv("KICAD_MCP_LOG_LEVEL", raising=False)
|
|
for raw in ("OFF", "none", "0", "false"):
|
|
monkeypatch.setenv("LOG_LEVEL", raw)
|
|
assert _parse_log_level() > logging.CRITICAL
|
|
|
|
def test_garbage_falls_back_to_info(self, monkeypatch):
|
|
monkeypatch.delenv("KICAD_MCP_LOG_LEVEL", raising=False)
|
|
monkeypatch.setenv("LOG_LEVEL", "verbose-ish")
|
|
assert _parse_log_level() == logging.INFO
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestEnvHelpers:
|
|
def test_positive_int_valid(self, monkeypatch):
|
|
monkeypatch.setenv("X_BYTES", "2048")
|
|
assert _parse_positive_int_env("X_BYTES", 10) == 2048
|
|
|
|
def test_positive_int_negative_and_garbage_use_default(self, monkeypatch):
|
|
monkeypatch.setenv("X_BYTES", "-5")
|
|
assert _parse_positive_int_env("X_BYTES", 10) == 10
|
|
monkeypatch.setenv("X_BYTES", "lots")
|
|
assert _parse_positive_int_env("X_BYTES", 10) == 10
|
|
|
|
def test_positive_int_unset_uses_default(self, monkeypatch):
|
|
monkeypatch.delenv("X_BYTES", raising=False)
|
|
assert _parse_positive_int_env("X_BYTES", 7) == 7
|
|
|
|
def test_flag_truthy_values(self, monkeypatch):
|
|
for raw in ("1", "true", "YES", "On"):
|
|
monkeypatch.setenv("X_FLAG", raw)
|
|
assert _env_flag_enabled("X_FLAG") is True
|
|
|
|
def test_flag_falsey_values(self, monkeypatch):
|
|
for raw in ("0", "false", "no", ""):
|
|
monkeypatch.setenv("X_FLAG", raw)
|
|
assert _env_flag_enabled("X_FLAG") is False
|
|
monkeypatch.delenv("X_FLAG", raising=False)
|
|
assert _env_flag_enabled("X_FLAG") is False
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestLoggingSideEffects:
|
|
def test_skip_loggers_muted_by_default(self):
|
|
# Importing kicad_interface (no KICAD_MCP_DEBUG_SKIP in the test env)
|
|
# must have set the noisy kicad-skip loggers to WARNING.
|
|
for name in ("skip", "skip.sexp", "skip.sexp.parser", "skip.sexp.sourcefile"):
|
|
assert logging.getLogger(name).level == logging.WARNING
|
|
|
|
def test_no_unbounded_handler_for_kicad_log(self):
|
|
# The regression was a plain logging.FileHandler on kicad_interface.log
|
|
# that grows forever. Any handler targeting that file must rotate.
|
|
# (Unrelated handlers, e.g. a NUL-device sink from the test harness,
|
|
# are ignored — they can't grow.)
|
|
for handler in logging.getLogger().handlers:
|
|
base = getattr(handler, "baseFilename", "")
|
|
if base and base.endswith("kicad_interface.log"):
|
|
assert isinstance(handler, RotatingFileHandler)
|