mirror of
https://github.com/home-assistant/supervisor.git
synced 2025-11-20 16:27:02 +00:00
0837e05cb2
* Strip ANSI escape color sequences from /latest log responses Strip ANSI sequences of CSI commands [1] used for log coloring from /latest log endpoints. These endpoint were primarily designed for log downloads and colors are mostly not wanted in those. Add optional argument for stripping the colors from the logs and enable it for the /latest endpoints. [1] https://en.wikipedia.org/wiki/ANSI_escape_code#CSIsection * Refactor advanced logs' tests to use fixture factory Introduce `advanced_logs_tester` fixture to simplify testing of advanced logs in the API tests, declaring all the needed fixture in a single place. # Please enter the commit message for your changes. Lines starting
134 lines
4.1 KiB
Python
134 lines
4.1 KiB
Python
"""Fixtures for API tests."""
|
|
|
|
from collections.abc import Awaitable, Callable
|
|
from unittest.mock import ANY, AsyncMock, MagicMock
|
|
|
|
from aiohttp.test_utils import TestClient
|
|
import pytest
|
|
|
|
from supervisor.coresys import CoreSys
|
|
from supervisor.host.const import LogFormat, LogFormatter
|
|
|
|
DEFAULT_LOG_RANGE = "entries=:-99:100"
|
|
DEFAULT_LOG_RANGE_FOLLOW = "entries=:-99:18446744073709551615"
|
|
|
|
|
|
async def _common_test_api_advanced_logs(
|
|
path_prefix: str,
|
|
syslog_identifier: str,
|
|
api_client: TestClient,
|
|
journald_logs: MagicMock,
|
|
coresys: CoreSys,
|
|
os_available: None,
|
|
journal_logs_reader: MagicMock,
|
|
):
|
|
"""Template for tests of endpoints using advanced logs."""
|
|
resp = await api_client.get(f"{path_prefix}/logs")
|
|
assert resp.status == 200
|
|
assert resp.content_type == "text/plain"
|
|
|
|
journald_logs.assert_called_once_with(
|
|
params={"SYSLOG_IDENTIFIER": syslog_identifier},
|
|
range_header=DEFAULT_LOG_RANGE,
|
|
accept=LogFormat.JOURNAL,
|
|
)
|
|
|
|
journald_logs.reset_mock()
|
|
|
|
resp = await api_client.get(f"{path_prefix}/logs/follow")
|
|
assert resp.status == 200
|
|
assert resp.content_type == "text/plain"
|
|
|
|
journald_logs.assert_called_once_with(
|
|
params={"SYSLOG_IDENTIFIER": syslog_identifier, "follow": ""},
|
|
range_header=DEFAULT_LOG_RANGE_FOLLOW,
|
|
accept=LogFormat.JOURNAL,
|
|
)
|
|
journal_logs_reader.assert_called_with(ANY, LogFormatter.PLAIN, False)
|
|
|
|
journald_logs.reset_mock()
|
|
journal_logs_reader.reset_mock()
|
|
|
|
mock_response = MagicMock()
|
|
mock_response.text = AsyncMock(
|
|
return_value='{"CONTAINER_LOG_EPOCH": "12345"}\n{"CONTAINER_LOG_EPOCH": "12345"}\n'
|
|
)
|
|
journald_logs.return_value.__aenter__.return_value = mock_response
|
|
|
|
resp = await api_client.get(f"{path_prefix}/logs/latest")
|
|
assert resp.status == 200
|
|
|
|
assert journald_logs.call_count == 2
|
|
|
|
# Check the first call for getting epoch
|
|
epoch_call = journald_logs.call_args_list[0]
|
|
assert epoch_call[1]["params"] == {"CONTAINER_NAME": syslog_identifier}
|
|
assert epoch_call[1]["range_header"] == "entries=:-1:2"
|
|
|
|
# Check the second call for getting logs with the epoch
|
|
logs_call = journald_logs.call_args_list[1]
|
|
assert logs_call[1]["params"]["SYSLOG_IDENTIFIER"] == syslog_identifier
|
|
assert logs_call[1]["params"]["CONTAINER_LOG_EPOCH"] == "12345"
|
|
assert logs_call[1]["range_header"] == "entries=:0:18446744073709551615"
|
|
journal_logs_reader.assert_called_with(ANY, LogFormatter.PLAIN, True)
|
|
|
|
journald_logs.reset_mock()
|
|
journal_logs_reader.reset_mock()
|
|
|
|
resp = await api_client.get(f"{path_prefix}/logs/boots/0")
|
|
assert resp.status == 200
|
|
assert resp.content_type == "text/plain"
|
|
|
|
journald_logs.assert_called_once_with(
|
|
params={"SYSLOG_IDENTIFIER": syslog_identifier, "_BOOT_ID": "ccc"},
|
|
range_header=DEFAULT_LOG_RANGE,
|
|
accept=LogFormat.JOURNAL,
|
|
)
|
|
|
|
journald_logs.reset_mock()
|
|
|
|
resp = await api_client.get(f"{path_prefix}/logs/boots/0/follow")
|
|
assert resp.status == 200
|
|
assert resp.content_type == "text/plain"
|
|
|
|
journald_logs.assert_called_once_with(
|
|
params={
|
|
"SYSLOG_IDENTIFIER": syslog_identifier,
|
|
"_BOOT_ID": "ccc",
|
|
"follow": "",
|
|
},
|
|
range_header=DEFAULT_LOG_RANGE_FOLLOW,
|
|
accept=LogFormat.JOURNAL,
|
|
)
|
|
|
|
|
|
@pytest.fixture
|
|
async def advanced_logs_tester(
|
|
api_client: TestClient,
|
|
journald_logs: MagicMock,
|
|
coresys: CoreSys,
|
|
os_available,
|
|
journal_logs_reader: MagicMock,
|
|
) -> Callable[[str, str], Awaitable[None]]:
|
|
"""Fixture that returns a function to test advanced logs endpoints.
|
|
|
|
This allows tests to avoid explicitly passing all the required fixtures.
|
|
|
|
Usage:
|
|
async def test_my_logs(advanced_logs_tester):
|
|
await advanced_logs_tester("/path/prefix", "syslog_identifier")
|
|
"""
|
|
|
|
async def test_logs(path_prefix: str, syslog_identifier: str):
|
|
await _common_test_api_advanced_logs(
|
|
path_prefix,
|
|
syslog_identifier,
|
|
api_client,
|
|
journald_logs,
|
|
coresys,
|
|
os_available,
|
|
journal_logs_reader,
|
|
)
|
|
|
|
return test_logs
|