mirror of
https://github.com/python-kasa/python-kasa.git
synced 2026-11-22 05:53:33 +00:00
Keep tests from changing logger levels and fixture data for later tests (#1844)
Some checks failed
CI / Perform Lint Checks (3.15) (push) Has been cancelled
CodeQL Checks / Analyze (python) (push) Has been cancelled
CI / Python 3.11 on macos-latest (push) Has been cancelled
CI / Python 3.12 on macos-latest (push) Has been cancelled
CI / Python 3.13 on macos-latest (push) Has been cancelled
CI / Python 3.14 on macos-latest (push) Has been cancelled
CI / Python 3.15 on macos-latest (push) Has been cancelled
CI / Python 3.11 on ubuntu-latest (push) Has been cancelled
CI / Python 3.12 on ubuntu-latest (push) Has been cancelled
CI / Python 3.13 on ubuntu-latest (push) Has been cancelled
CI / Python 3.14 on ubuntu-latest (push) Has been cancelled
CI / Python 3.15 on ubuntu-latest (push) Has been cancelled
CI / Python 3.11 on windows-latest (push) Has been cancelled
CI / Python 3.12 on windows-latest (push) Has been cancelled
CI / Python 3.13 on windows-latest (push) Has been cancelled
CI / Python 3.14 on windows-latest (push) Has been cancelled
CI / Python 3.15 on windows-latest (push) Has been cancelled
Stale / stale (push) Has been cancelled
Some checks failed
CI / Perform Lint Checks (3.15) (push) Has been cancelled
CodeQL Checks / Analyze (python) (push) Has been cancelled
CI / Python 3.11 on macos-latest (push) Has been cancelled
CI / Python 3.12 on macos-latest (push) Has been cancelled
CI / Python 3.13 on macos-latest (push) Has been cancelled
CI / Python 3.14 on macos-latest (push) Has been cancelled
CI / Python 3.15 on macos-latest (push) Has been cancelled
CI / Python 3.11 on ubuntu-latest (push) Has been cancelled
CI / Python 3.12 on ubuntu-latest (push) Has been cancelled
CI / Python 3.13 on ubuntu-latest (push) Has been cancelled
CI / Python 3.14 on ubuntu-latest (push) Has been cancelled
CI / Python 3.15 on ubuntu-latest (push) Has been cancelled
CI / Python 3.11 on windows-latest (push) Has been cancelled
CI / Python 3.12 on windows-latest (push) Has been cancelled
CI / Python 3.13 on windows-latest (push) Has been cancelled
CI / Python 3.14 on windows-latest (push) Has been cancelled
CI / Python 3.15 on windows-latest (push) Has been cancelled
Stale / stale (push) Has been cancelled
Some tests leave the `kasa` logger at a different level or rename devices in shared fixture data. Later log assertions and device dump comparisons then pass or fail depending on the test order. This PR restores logger levels through `caplog` and renames devices on copies, so the affected tests pass independently of their order. In details: - Use `caplog.set_level` for tests that change the `kasa` logger, and remove an unused logger override. - Add an autouse fixture that restores any changed logger levels and fails the test with a pointer to `caplog.set_level`. - Rename README devices on deep copies of the fixture data. - Cover KLAP handshake debug logging explicitly, instead of relying on an earlier test leaving DEBUG enabled. Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -2,6 +2,7 @@ from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
import functools
|
||||
import logging
|
||||
import os
|
||||
import sys
|
||||
import warnings
|
||||
@@ -69,6 +70,39 @@ async def _close_transport_and_http_sessions(monkeypatch):
|
||||
await session.close()
|
||||
|
||||
|
||||
def _logger_levels() -> dict[str, int]:
|
||||
levels = {"root": logging.getLogger().level}
|
||||
for name, logger in list(logging.Logger.manager.loggerDict.items()):
|
||||
if isinstance(logger, logging.Logger):
|
||||
levels[name] = logger.level
|
||||
return levels
|
||||
|
||||
|
||||
@pytest.fixture(autouse=True)
|
||||
def _logger_levels_unchanged(request: pytest.FixtureRequest):
|
||||
"""Fail a test that leaves a logger's level changed.
|
||||
|
||||
A level set directly stays for the later tests on the same worker, so
|
||||
they pass or fail depending on the order. Use caplog.set_level, which
|
||||
pytest restores after the test.
|
||||
"""
|
||||
before = _logger_levels()
|
||||
yield
|
||||
changed = {
|
||||
name: level
|
||||
for name, level in _logger_levels().items()
|
||||
if level != before.get(name, logging.NOTSET)
|
||||
}
|
||||
for name in changed:
|
||||
logging.getLogger(name).setLevel(before.get(name, logging.NOTSET))
|
||||
if changed:
|
||||
levels = {name: logging.getLevelName(level) for name, level in changed.items()}
|
||||
pytest.fail(
|
||||
f"{request.node.nodeid} left logger levels changed: {levels}. "
|
||||
"Use caplog.set_level, which restores them."
|
||||
)
|
||||
|
||||
|
||||
def load_fixture(foldername: str, filename: str) -> str:
|
||||
"""Load a fixture."""
|
||||
path = Path(Path(__file__).parent / "fixtures" / foldername / filename)
|
||||
|
||||
Reference in New Issue
Block a user