ha-supervisor/tests/api/test_discovery.py

138 lines
4.5 KiB
Python

"""Test discovery API."""
import logging
from unittest.mock import ANY, AsyncMock, MagicMock, patch
from aiohttp.test_utils import TestClient
import pytest
from supervisor.addons.addon import Addon
from supervisor.const import AddonState
from supervisor.coresys import CoreSys
from supervisor.discovery import Message
from tests.common import load_json_fixture
from tests.const import TEST_ADDON_SLUG
@pytest.mark.parametrize("api_client", ["local_ssh"], indirect=True)
async def test_api_discovery_forbidden(
api_client: TestClient, caplog: pytest.LogCaptureFixture, install_addon_ssh
):
"""Test addon sending discovery message for an unregistered service."""
caplog.clear()
with caplog.at_level(logging.ERROR):
resp = await api_client.post(
"/discovery", json={"service": "mqtt", "config": {}}
)
assert resp.status == 403
result = await resp.json()
assert result["result"] == "error"
assert (
result["message"]
== "Add-ons must list services they provide via discovery in their config!"
)
assert "Please report this to the maintainer of the add-on" in caplog.text
@pytest.mark.parametrize(
"skip_state", [AddonState.ERROR, AddonState.STOPPED, AddonState.STARTUP]
)
async def test_api_list_discovery(
api_client: TestClient,
coresys: CoreSys,
install_addon_ssh: Addon,
skip_state: AddonState,
):
"""Test listing discovery messages only returns ones for healthy services."""
with patch(
"supervisor.utils.common.read_json_or_yaml_file",
return_value=load_json_fixture("discovery.json"),
), patch("supervisor.utils.common.Path.is_file", return_value=True):
coresys.discovery.read_data()
await coresys.discovery.load()
assert coresys.discovery.list_messages == [
Message(addon="core_mosquitto", service="mqtt", config=ANY, uuid=ANY),
Message(addon="local_ssh", service="adguard", config=ANY, uuid=ANY),
]
install_addon_ssh.state = AddonState.STARTED
resp = await api_client.get("/discovery")
assert resp.status == 200
result = await resp.json()
assert result["data"]["discovery"] == [
{
"addon": "local_ssh",
"service": "adguard",
"config": ANY,
"uuid": ANY,
}
]
install_addon_ssh.state = skip_state
resp = await api_client.get("/discovery")
assert resp.status == 200
result = await resp.json()
assert result["data"]["discovery"] == []
@pytest.mark.parametrize("api_client", [TEST_ADDON_SLUG], indirect=True)
async def test_api_send_del_discovery(
api_client: TestClient, coresys: CoreSys, install_addon_ssh: Addon
):
"""Test adding and removing discovery."""
install_addon_ssh.data["discovery"] = ["test"]
coresys.homeassistant.api.ensure_access_token = AsyncMock()
coresys.websession.post = MagicMock()
resp = await api_client.post("/discovery", json={"service": "test", "config": {}})
assert resp.status == 200
result = await resp.json()
uuid = result["data"]["uuid"]
coresys.websession.post.assert_called_once()
assert (
coresys.websession.post.call_args.args[0]
== f"http://172.30.32.1:8123/api/hassio_push/discovery/{uuid}"
)
assert coresys.websession.post.call_args.kwargs["json"] == {
"addon": TEST_ADDON_SLUG,
"service": "test",
"uuid": uuid,
}
message = coresys.discovery.get(uuid)
assert message.addon == TEST_ADDON_SLUG
assert message.service == "test"
assert message.config == {}
coresys.websession.delete = MagicMock()
resp = await api_client.delete(f"/discovery/{uuid}")
assert resp.status == 200
coresys.websession.delete.assert_called_once()
assert (
coresys.websession.delete.call_args.args[0]
== f"http://172.30.32.1:8123/api/hassio_push/discovery/{uuid}"
)
assert coresys.websession.delete.call_args.kwargs["json"] == {
"addon": TEST_ADDON_SLUG,
"service": "test",
"uuid": uuid,
}
assert coresys.discovery.get(uuid) is None
@pytest.mark.parametrize("api_client", [TEST_ADDON_SLUG], indirect=True)
async def test_api_invalid_discovery(api_client: TestClient, install_addon_ssh: Addon):
"""Test invalid discovery messages."""
install_addon_ssh.data["discovery"] = ["test"]
resp = await api_client.post("/discovery", json={"service": "test"})
assert resp.status == 400
resp = await api_client.post("/discovery", json={"service": "test", "config": None})
assert resp.status == 400