mirror of
https://github.com/home-assistant/supervisor.git
synced 2026-10-01 20:38:49 +01:00
Stefan AgnerandClaude Fable 5.1
108ac2f15d
Since 2020 Supervisor unconditionally installs and runs the multicast plugin on every installation. Users affected by its interference (mDNS duplicates, multicast storms) have no supported way to turn it off. This is phase 1 of the deprecation plan in architecture discussion #1457: an opt-in disable switch. The plugin config gains an `enabled` option (default true), persisted in multicast.json and exposed via `GET /multicast/info` and a new `POST /multicast/options` endpoint. Disabling stops and removes the container, removes the image and forgets the installed version. Enabling installs the current version and starts it, gated by the same job conditions as a plugin update. While disabled, load skips attach, install and start, the watchdog ignores container events, repair and auto-update are skipped, and start/restart/update raise MulticastDisabledError (HTTP 400). The update endpoint now rejects a disabled plugin before comparing versions, as the comparison raises on the None version left behind by a disable. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
117 lines
3.9 KiB
Python
117 lines
3.9 KiB
Python
"""Test multicast api."""
|
|
|
|
from unittest.mock import AsyncMock, PropertyMock, patch
|
|
|
|
from aiodocker.containers import DockerContainer
|
|
from aiohttp.test_utils import TestClient
|
|
from awesomeversion import AwesomeVersion
|
|
|
|
from supervisor.coresys import CoreSys
|
|
from supervisor.docker.manager import DockerAPI
|
|
from supervisor.host.const import LogFormatter
|
|
from supervisor.plugins.multicast import PluginMulticast
|
|
|
|
from tests.common import load_json_fixture
|
|
|
|
|
|
async def test_api_multicast_logs(advanced_logs_tester):
|
|
"""Test multicast logs."""
|
|
await advanced_logs_tester("/multicast", "hassio_multicast", LogFormatter.VERBOSE)
|
|
|
|
|
|
async def test_api_multicast_stats(
|
|
api_client_with_prefix: tuple[TestClient, str], container: DockerContainer
|
|
):
|
|
"""Test multicast stats."""
|
|
api_client, prefix = api_client_with_prefix
|
|
container.show.return_value["State"]["Status"] = "running"
|
|
container.show.return_value["State"]["Running"] = True
|
|
|
|
if prefix == "/v2":
|
|
stats_fixture = load_json_fixture("container_stats.json")
|
|
del stats_fixture["precpu_stats"]
|
|
with patch.object(
|
|
DockerAPI,
|
|
"_query_one_shot_stats",
|
|
AsyncMock(return_value=stats_fixture),
|
|
):
|
|
resp = await api_client.get(f"{prefix}/multicast/stats")
|
|
else:
|
|
container.stats = AsyncMock(
|
|
return_value=[load_json_fixture("container_stats.json")]
|
|
)
|
|
resp = await api_client.get(f"{prefix}/multicast/stats")
|
|
|
|
assert resp.status == 200
|
|
result = await resp.json()
|
|
if prefix == "/v2":
|
|
assert "cpu_percent" not in result["data"]
|
|
else:
|
|
assert result["data"]["cpu_percent"] == 90.0
|
|
assert result["data"]["memory_usage"] == 59700000
|
|
|
|
|
|
async def test_api_multicast_info(
|
|
api_client_with_prefix: tuple[TestClient, str], coresys: CoreSys
|
|
):
|
|
"""Test multicast info reports the enabled state."""
|
|
api_client, prefix = api_client_with_prefix
|
|
|
|
resp = await api_client.get(f"{prefix}/multicast/info")
|
|
assert resp.status == 200
|
|
result = await resp.json()
|
|
assert result["data"]["enabled"] is True
|
|
|
|
coresys.plugins.multicast._data["enabled"] = False # pylint: disable=protected-access
|
|
resp = await api_client.get(f"{prefix}/multicast/info")
|
|
result = await resp.json()
|
|
assert result["data"]["enabled"] is False
|
|
assert result["data"]["update_available"] is False
|
|
|
|
|
|
async def test_api_multicast_options(
|
|
api_client_with_prefix: tuple[TestClient, str], coresys: CoreSys
|
|
):
|
|
"""Test multicast options enable and disable the plugin."""
|
|
api_client, prefix = api_client_with_prefix
|
|
|
|
with (
|
|
patch.object(PluginMulticast, "disable") as disable,
|
|
patch.object(PluginMulticast, "enable") as enable,
|
|
):
|
|
resp = await api_client.post(
|
|
f"{prefix}/multicast/options", json={"enabled": False}
|
|
)
|
|
assert resp.status == 200
|
|
disable.assert_called_once()
|
|
enable.assert_not_called()
|
|
|
|
disable.reset_mock()
|
|
resp = await api_client.post(
|
|
f"{prefix}/multicast/options", json={"enabled": True}
|
|
)
|
|
assert resp.status == 200
|
|
enable.assert_called_once()
|
|
disable.assert_not_called()
|
|
|
|
|
|
async def test_api_multicast_disabled_actions(
|
|
api_client_with_prefix: tuple[TestClient, str], coresys: CoreSys
|
|
):
|
|
"""Test restart and update are rejected while the plugin is disabled."""
|
|
api_client, prefix = api_client_with_prefix
|
|
coresys.plugins.multicast._data["enabled"] = False # pylint: disable=protected-access
|
|
|
|
resp = await api_client.post(f"{prefix}/multicast/restart")
|
|
assert resp.status == 400
|
|
result = await resp.json()
|
|
assert result["message"] == "Multicast plugin is disabled"
|
|
|
|
with patch.object(
|
|
PluginMulticast,
|
|
"latest_version",
|
|
new=PropertyMock(return_value=AwesomeVersion("2024.01.0")),
|
|
):
|
|
resp = await api_client.post(f"{prefix}/multicast/update")
|
|
assert resp.status == 400
|