Fix flapping system log test (#75111)
This commit is contained in:
J. Nick Koston
GitHub
parent
a720b2989a
commit
08ff1b8986
5 changed files with 135 additions and 121 deletions
|
|
@ -1,10 +1,11 @@
|
|||
"""Test system log component."""
|
||||
import asyncio
|
||||
import logging
|
||||
import queue
|
||||
from unittest.mock import MagicMock, patch
|
||||
from __future__ import annotations
|
||||
|
||||
import pytest
|
||||
import asyncio
|
||||
from collections.abc import Awaitable
|
||||
import logging
|
||||
from typing import Any
|
||||
from unittest.mock import MagicMock, patch
|
||||
|
||||
from homeassistant.bootstrap import async_setup_component
|
||||
from homeassistant.components import system_log
|
||||
|
|
@ -16,28 +17,6 @@ _LOGGER = logging.getLogger("test_logger")
|
|||
BASIC_CONFIG = {"system_log": {"max_entries": 2}}
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def simple_queue():
|
||||
"""Fixture that get the queue."""
|
||||
simple_queue_fixed = queue.SimpleQueue()
|
||||
with patch(
|
||||
"homeassistant.components.system_log.queue.SimpleQueue",
|
||||
return_value=simple_queue_fixed,
|
||||
):
|
||||
yield simple_queue_fixed
|
||||
|
||||
|
||||
async def _async_block_until_queue_empty(hass, sq):
|
||||
# Unfortunately we are stuck with polling
|
||||
await hass.async_block_till_done()
|
||||
while not sq.empty():
|
||||
await asyncio.sleep(0.01)
|
||||
hass.data[system_log.DOMAIN].acquire()
|
||||
hass.data[system_log.DOMAIN].release()
|
||||
await hass.async_block_till_done()
|
||||
await hass.async_block_till_done()
|
||||
|
||||
|
||||
async def get_error_log(hass_ws_client):
|
||||
"""Fetch all entries from system_log via the API."""
|
||||
client = await hass_ws_client()
|
||||
|
|
@ -81,66 +60,97 @@ def assert_log(log, exception, message, level):
|
|||
assert "timestamp" in log
|
||||
|
||||
|
||||
class WatchLogErrorHandler(system_log.LogErrorHandler):
|
||||
"""WatchLogErrorHandler that watches for a message."""
|
||||
|
||||
instances: list[WatchLogErrorHandler] = []
|
||||
|
||||
def __init__(self, *args: Any, **kwargs: Any) -> None:
|
||||
"""Initialize HASSQueueListener."""
|
||||
super().__init__(*args, **kwargs)
|
||||
self.watch_message: str | None = None
|
||||
self.watch_event: asyncio.Event | None = asyncio.Event()
|
||||
WatchLogErrorHandler.instances.append(self)
|
||||
|
||||
def add_watcher(self, match: str) -> Awaitable:
|
||||
"""Add a watcher."""
|
||||
self.watch_event = asyncio.Event()
|
||||
self.watch_message = match
|
||||
return self.watch_event.wait()
|
||||
|
||||
def handle(self, record: logging.LogRecord) -> None:
|
||||
"""Handle a logging record."""
|
||||
super().handle(record)
|
||||
if record.message in self.watch_message:
|
||||
self.watch_event.set()
|
||||
|
||||
|
||||
def get_frame(name):
|
||||
"""Get log stack frame."""
|
||||
return (name, 5, None, None)
|
||||
|
||||
|
||||
async def test_normal_logs(hass, simple_queue, hass_ws_client):
|
||||
async def async_setup_system_log(hass, config) -> WatchLogErrorHandler:
|
||||
"""Set up the system_log component."""
|
||||
WatchLogErrorHandler.instances = []
|
||||
with patch(
|
||||
"homeassistant.components.system_log.LogErrorHandler", WatchLogErrorHandler
|
||||
):
|
||||
await async_setup_component(hass, system_log.DOMAIN, config)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
assert len(WatchLogErrorHandler.instances) == 1
|
||||
return WatchLogErrorHandler.instances.pop()
|
||||
|
||||
|
||||
async def test_normal_logs(hass, hass_ws_client):
|
||||
"""Test that debug and info are not logged."""
|
||||
await async_setup_component(hass, system_log.DOMAIN, BASIC_CONFIG)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
_LOGGER.debug("debug")
|
||||
_LOGGER.info("info")
|
||||
await _async_block_until_queue_empty(hass, simple_queue)
|
||||
|
||||
# Assert done by get_error_log
|
||||
logs = await get_error_log(hass_ws_client)
|
||||
assert len([msg for msg in logs if msg["level"] in ("DEBUG", "INFO")]) == 0
|
||||
|
||||
|
||||
async def test_exception(hass, simple_queue, hass_ws_client):
|
||||
async def test_exception(hass, hass_ws_client):
|
||||
"""Test that exceptions are logged and retrieved correctly."""
|
||||
await async_setup_component(hass, system_log.DOMAIN, BASIC_CONFIG)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
_generate_and_log_exception("exception message", "log message")
|
||||
await _async_block_until_queue_empty(hass, simple_queue)
|
||||
log = find_log(await get_error_log(hass_ws_client), "ERROR")
|
||||
assert log is not None
|
||||
assert_log(log, "exception message", "log message", "ERROR")
|
||||
|
||||
|
||||
async def test_warning(hass, simple_queue, hass_ws_client):
|
||||
async def test_warning(hass, hass_ws_client):
|
||||
"""Test that warning are logged and retrieved correctly."""
|
||||
await async_setup_component(hass, system_log.DOMAIN, BASIC_CONFIG)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
_LOGGER.warning("warning message")
|
||||
await _async_block_until_queue_empty(hass, simple_queue)
|
||||
|
||||
log = find_log(await get_error_log(hass_ws_client), "WARNING")
|
||||
assert_log(log, "", "warning message", "WARNING")
|
||||
|
||||
|
||||
async def test_error(hass, simple_queue, hass_ws_client):
|
||||
async def test_error(hass, hass_ws_client):
|
||||
"""Test that errors are logged and retrieved correctly."""
|
||||
await async_setup_component(hass, system_log.DOMAIN, BASIC_CONFIG)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
_LOGGER.error("error message")
|
||||
await _async_block_until_queue_empty(hass, simple_queue)
|
||||
|
||||
log = find_log(await get_error_log(hass_ws_client), "ERROR")
|
||||
assert_log(log, "", "error message", "ERROR")
|
||||
|
||||
|
||||
async def test_config_not_fire_event(hass, simple_queue):
|
||||
async def test_config_not_fire_event(hass):
|
||||
"""Test that errors are not posted as events with default config."""
|
||||
await async_setup_component(hass, system_log.DOMAIN, BASIC_CONFIG)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
events = []
|
||||
|
||||
@callback
|
||||
|
|
@ -150,50 +160,49 @@ async def test_config_not_fire_event(hass, simple_queue):
|
|||
|
||||
hass.bus.async_listen(system_log.EVENT_SYSTEM_LOG, event_listener)
|
||||
|
||||
_LOGGER.error("error message")
|
||||
await _async_block_until_queue_empty(hass, simple_queue)
|
||||
await hass.async_block_till_done()
|
||||
await hass.async_block_till_done()
|
||||
|
||||
assert len(events) == 0
|
||||
|
||||
|
||||
async def test_error_posted_as_event(hass, simple_queue):
|
||||
async def test_error_posted_as_event(hass):
|
||||
"""Test that error are posted as events."""
|
||||
await async_setup_component(
|
||||
hass, system_log.DOMAIN, {"system_log": {"max_entries": 2, "fire_event": True}}
|
||||
watcher = await async_setup_system_log(
|
||||
hass, {"system_log": {"max_entries": 2, "fire_event": True}}
|
||||
)
|
||||
await hass.async_block_till_done()
|
||||
wait_empty = watcher.add_watcher("error message")
|
||||
|
||||
events = async_capture_events(hass, system_log.EVENT_SYSTEM_LOG)
|
||||
|
||||
_LOGGER.error("error message")
|
||||
await _async_block_until_queue_empty(hass, simple_queue)
|
||||
await wait_empty
|
||||
await hass.async_block_till_done()
|
||||
await hass.async_block_till_done()
|
||||
|
||||
assert len(events) == 1
|
||||
assert_log(events[0].data, "", "error message", "ERROR")
|
||||
|
||||
|
||||
async def test_critical(hass, simple_queue, hass_ws_client):
|
||||
async def test_critical(hass, hass_ws_client):
|
||||
"""Test that critical are logged and retrieved correctly."""
|
||||
await async_setup_component(hass, system_log.DOMAIN, BASIC_CONFIG)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
_LOGGER.critical("critical message")
|
||||
await _async_block_until_queue_empty(hass, simple_queue)
|
||||
|
||||
log = find_log(await get_error_log(hass_ws_client), "CRITICAL")
|
||||
assert_log(log, "", "critical message", "CRITICAL")
|
||||
|
||||
|
||||
async def test_remove_older_logs(hass, simple_queue, hass_ws_client):
|
||||
async def test_remove_older_logs(hass, hass_ws_client):
|
||||
"""Test that older logs are rotated out."""
|
||||
await async_setup_component(hass, system_log.DOMAIN, BASIC_CONFIG)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
_LOGGER.error("error message 1")
|
||||
_LOGGER.error("error message 2")
|
||||
_LOGGER.error("error message 3")
|
||||
await _async_block_until_queue_empty(hass, simple_queue)
|
||||
|
||||
await hass.async_block_till_done()
|
||||
log = await get_error_log(hass_ws_client)
|
||||
assert_log(log[0], "", "error message 3", "ERROR")
|
||||
assert_log(log[1], "", "error message 2", "ERROR")
|
||||
|
|
@ -204,16 +213,14 @@ def log_msg(nr=2):
|
|||
_LOGGER.error("error message %s", nr)
|
||||
|
||||
|
||||
async def test_dedupe_logs(hass, simple_queue, hass_ws_client):
|
||||
async def test_dedupe_logs(hass, hass_ws_client):
|
||||
"""Test that duplicate log entries are dedupe."""
|
||||
await async_setup_component(hass, system_log.DOMAIN, {})
|
||||
await async_setup_component(hass, system_log.DOMAIN, BASIC_CONFIG)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
_LOGGER.error("error message 1")
|
||||
log_msg()
|
||||
log_msg("2-2")
|
||||
_LOGGER.error("error message 3")
|
||||
await _async_block_until_queue_empty(hass, simple_queue)
|
||||
|
||||
log = await get_error_log(hass_ws_client)
|
||||
assert_log(log[0], "", "error message 3", "ERROR")
|
||||
|
|
@ -221,8 +228,6 @@ async def test_dedupe_logs(hass, simple_queue, hass_ws_client):
|
|||
assert_log(log[1], "", ["error message 2", "error message 2-2"], "ERROR")
|
||||
|
||||
log_msg()
|
||||
await _async_block_until_queue_empty(hass, simple_queue)
|
||||
|
||||
log = await get_error_log(hass_ws_client)
|
||||
assert_log(log[0], "", ["error message 2", "error message 2-2"], "ERROR")
|
||||
assert log[0]["timestamp"] > log[0]["first_occurred"]
|
||||
|
|
@ -231,7 +236,6 @@ async def test_dedupe_logs(hass, simple_queue, hass_ws_client):
|
|||
log_msg("2-4")
|
||||
log_msg("2-5")
|
||||
log_msg("2-6")
|
||||
await _async_block_until_queue_empty(hass, simple_queue)
|
||||
|
||||
log = await get_error_log(hass_ws_client)
|
||||
assert_log(
|
||||
|
|
@ -248,17 +252,14 @@ async def test_dedupe_logs(hass, simple_queue, hass_ws_client):
|
|||
)
|
||||
|
||||
|
||||
async def test_clear_logs(hass, simple_queue, hass_ws_client):
|
||||
async def test_clear_logs(hass, hass_ws_client):
|
||||
"""Test that the log can be cleared via a service call."""
|
||||
await async_setup_component(hass, system_log.DOMAIN, BASIC_CONFIG)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
_LOGGER.error("error message")
|
||||
await _async_block_until_queue_empty(hass, simple_queue)
|
||||
|
||||
await hass.services.async_call(system_log.DOMAIN, system_log.SERVICE_CLEAR, {})
|
||||
await _async_block_until_queue_empty(hass, simple_queue)
|
||||
|
||||
await hass.async_block_till_done()
|
||||
# Assert done by get_error_log
|
||||
await get_error_log(hass_ws_client)
|
||||
|
||||
|
|
@ -309,19 +310,17 @@ async def test_write_choose_level(hass):
|
|||
assert logger.method_calls[0] == ("debug", ("test_message",))
|
||||
|
||||
|
||||
async def test_unknown_path(hass, simple_queue, hass_ws_client):
|
||||
async def test_unknown_path(hass, hass_ws_client):
|
||||
"""Test error logged from unknown path."""
|
||||
await async_setup_component(hass, system_log.DOMAIN, BASIC_CONFIG)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
_LOGGER.findCaller = MagicMock(return_value=("unknown_path", 0, None, None))
|
||||
_LOGGER.error("error message")
|
||||
await _async_block_until_queue_empty(hass, simple_queue)
|
||||
log = (await get_error_log(hass_ws_client))[0]
|
||||
assert log["source"] == ["unknown_path", 0]
|
||||
|
||||
|
||||
async def async_log_error_from_test_path(hass, path, sq):
|
||||
async def async_log_error_from_test_path(hass, path, watcher):
|
||||
"""Log error while mocking the path."""
|
||||
call_path = "internal_path.py"
|
||||
with patch.object(
|
||||
|
|
@ -337,34 +336,34 @@ async def async_log_error_from_test_path(hass, path, sq):
|
|||
]
|
||||
),
|
||||
):
|
||||
wait_empty = watcher.add_watcher("error message")
|
||||
_LOGGER.error("error message")
|
||||
await _async_block_until_queue_empty(hass, sq)
|
||||
await wait_empty
|
||||
|
||||
|
||||
async def test_homeassistant_path(hass, simple_queue, hass_ws_client):
|
||||
async def test_homeassistant_path(hass, hass_ws_client):
|
||||
"""Test error logged from Home Assistant path."""
|
||||
await async_setup_component(hass, system_log.DOMAIN, BASIC_CONFIG)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
with patch(
|
||||
"homeassistant.components.system_log.HOMEASSISTANT_PATH",
|
||||
new=["venv_path/homeassistant"],
|
||||
):
|
||||
watcher = await async_setup_system_log(hass, BASIC_CONFIG)
|
||||
await async_log_error_from_test_path(
|
||||
hass, "venv_path/homeassistant/component/component.py", simple_queue
|
||||
hass, "venv_path/homeassistant/component/component.py", watcher
|
||||
)
|
||||
log = (await get_error_log(hass_ws_client))[0]
|
||||
assert log["source"] == ["component/component.py", 5]
|
||||
|
||||
|
||||
async def test_config_path(hass, simple_queue, hass_ws_client):
|
||||
async def test_config_path(hass, hass_ws_client):
|
||||
"""Test error logged from config path."""
|
||||
await async_setup_component(hass, system_log.DOMAIN, BASIC_CONFIG)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
with patch.object(hass.config, "config_dir", new="config"):
|
||||
watcher = await async_setup_system_log(hass, BASIC_CONFIG)
|
||||
|
||||
await async_log_error_from_test_path(
|
||||
hass, "config/custom_component/test.py", simple_queue
|
||||
hass, "config/custom_component/test.py", watcher
|
||||
)
|
||||
log = (await get_error_log(hass_ws_client))[0]
|
||||
assert log["source"] == ["custom_component/test.py", 5]
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue