2034 lines
60 KiB
Python
2034 lines
60 KiB
Python
"""Tests for WebSocket API commands."""
|
|
from copy import deepcopy
|
|
import datetime
|
|
from unittest.mock import ANY, patch
|
|
|
|
from async_timeout import timeout
|
|
import pytest
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.websocket_api import const
|
|
from homeassistant.components.websocket_api.auth import (
|
|
TYPE_AUTH,
|
|
TYPE_AUTH_OK,
|
|
TYPE_AUTH_REQUIRED,
|
|
)
|
|
from homeassistant.components.websocket_api.const import FEATURE_COALESCE_MESSAGES, URL
|
|
from homeassistant.const import SIGNAL_BOOTSTRAP_INTEGRATIONS
|
|
from homeassistant.core import Context, HomeAssistant, State, callback
|
|
from homeassistant.exceptions import HomeAssistantError
|
|
from homeassistant.helpers import entity
|
|
from homeassistant.helpers.dispatcher import async_dispatcher_send
|
|
from homeassistant.helpers.json import json_loads
|
|
from homeassistant.loader import async_get_integration
|
|
from homeassistant.setup import DATA_SETUP_TIME, async_setup_component
|
|
|
|
from tests.common import (
|
|
MockEntity,
|
|
MockEntityPlatform,
|
|
MockModule,
|
|
async_mock_service,
|
|
mock_integration,
|
|
)
|
|
|
|
STATE_KEY_SHORT_NAMES = {
|
|
"entity_id": "e",
|
|
"state": "s",
|
|
"last_changed": "lc",
|
|
"last_updated": "lu",
|
|
"context": "c",
|
|
"attributes": "a",
|
|
}
|
|
STATE_KEY_LONG_NAMES = {v: k for k, v in STATE_KEY_SHORT_NAMES.items()}
|
|
|
|
|
|
def _apply_entities_changes(state_dict: dict, change_dict: dict) -> None:
|
|
"""Apply a diff set to a dict.
|
|
|
|
Port of the client side merging
|
|
"""
|
|
additions = change_dict.get("+", {})
|
|
if "lc" in additions:
|
|
additions["lu"] = additions["lc"]
|
|
if attributes := additions.pop("a", None):
|
|
state_dict["attributes"].update(attributes)
|
|
if context := additions.pop("c", None):
|
|
if isinstance(context, str):
|
|
state_dict["context"]["id"] = context
|
|
else:
|
|
state_dict["context"].update(context)
|
|
for k, v in additions.items():
|
|
state_dict[STATE_KEY_LONG_NAMES[k]] = v
|
|
for key, items in change_dict.get("-", {}).items():
|
|
for item in items:
|
|
del state_dict[STATE_KEY_LONG_NAMES[key]][item]
|
|
|
|
|
|
async def test_fire_event(hass, websocket_client):
|
|
"""Test fire event command."""
|
|
runs = []
|
|
|
|
async def event_handler(event):
|
|
runs.append(event)
|
|
|
|
hass.bus.async_listen_once("event_type_test", event_handler)
|
|
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 5,
|
|
"type": "fire_event",
|
|
"event_type": "event_type_test",
|
|
"event_data": {"hello": "world"},
|
|
}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
assert len(runs) == 1
|
|
|
|
assert runs[0].event_type == "event_type_test"
|
|
assert runs[0].data == {"hello": "world"}
|
|
|
|
|
|
async def test_fire_event_without_data(hass, websocket_client):
|
|
"""Test fire event command."""
|
|
runs = []
|
|
|
|
async def event_handler(event):
|
|
runs.append(event)
|
|
|
|
hass.bus.async_listen_once("event_type_test", event_handler)
|
|
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 5,
|
|
"type": "fire_event",
|
|
"event_type": "event_type_test",
|
|
}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
assert len(runs) == 1
|
|
|
|
assert runs[0].event_type == "event_type_test"
|
|
assert runs[0].data == {}
|
|
|
|
|
|
async def test_call_service(hass, websocket_client):
|
|
"""Test call service command."""
|
|
calls = async_mock_service(hass, "domain_test", "test_service")
|
|
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 5,
|
|
"type": "call_service",
|
|
"domain": "domain_test",
|
|
"service": "test_service",
|
|
"service_data": {"hello": "world"},
|
|
}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
assert len(calls) == 1
|
|
call = calls[0]
|
|
|
|
assert call.domain == "domain_test"
|
|
assert call.service == "test_service"
|
|
assert call.data == {"hello": "world"}
|
|
assert call.context.as_dict() == msg["result"]["context"]
|
|
|
|
|
|
@pytest.mark.parametrize("command", ("call_service", "call_service_action"))
|
|
async def test_call_service_blocking(hass, websocket_client, command):
|
|
"""Test call service commands block, except for homeassistant restart / stop."""
|
|
with patch(
|
|
"homeassistant.core.ServiceRegistry.async_call", autospec=True
|
|
) as mock_call:
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 5,
|
|
"type": "call_service",
|
|
"domain": "domain_test",
|
|
"service": "test_service",
|
|
"service_data": {"hello": "world"},
|
|
},
|
|
)
|
|
msg = await websocket_client.receive_json()
|
|
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
mock_call.assert_called_once_with(
|
|
ANY,
|
|
"domain_test",
|
|
"test_service",
|
|
{"hello": "world"},
|
|
blocking=True,
|
|
context=ANY,
|
|
target=ANY,
|
|
)
|
|
|
|
with patch(
|
|
"homeassistant.core.ServiceRegistry.async_call", autospec=True
|
|
) as mock_call:
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 6,
|
|
"type": "call_service",
|
|
"domain": "homeassistant",
|
|
"service": "test_service",
|
|
},
|
|
)
|
|
msg = await websocket_client.receive_json()
|
|
|
|
assert msg["id"] == 6
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
mock_call.assert_called_once_with(
|
|
ANY,
|
|
"homeassistant",
|
|
"test_service",
|
|
ANY,
|
|
blocking=True,
|
|
context=ANY,
|
|
target=ANY,
|
|
)
|
|
|
|
with patch(
|
|
"homeassistant.core.ServiceRegistry.async_call", autospec=True
|
|
) as mock_call:
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 7,
|
|
"type": "call_service",
|
|
"domain": "homeassistant",
|
|
"service": "restart",
|
|
},
|
|
)
|
|
msg = await websocket_client.receive_json()
|
|
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
mock_call.assert_called_once_with(
|
|
ANY, "homeassistant", "restart", ANY, blocking=True, context=ANY, target=ANY
|
|
)
|
|
|
|
|
|
async def test_call_service_target(hass, websocket_client):
|
|
"""Test call service command with target."""
|
|
calls = async_mock_service(hass, "domain_test", "test_service")
|
|
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 5,
|
|
"type": "call_service",
|
|
"domain": "domain_test",
|
|
"service": "test_service",
|
|
"service_data": {"hello": "world"},
|
|
"target": {
|
|
"entity_id": ["entity.one", "entity.two"],
|
|
"device_id": "deviceid",
|
|
},
|
|
}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
assert len(calls) == 1
|
|
call = calls[0]
|
|
|
|
assert call.domain == "domain_test"
|
|
assert call.service == "test_service"
|
|
assert call.data == {
|
|
"hello": "world",
|
|
"entity_id": ["entity.one", "entity.two"],
|
|
"device_id": ["deviceid"],
|
|
}
|
|
assert call.context.as_dict() == msg["result"]["context"]
|
|
|
|
|
|
async def test_call_service_target_template(hass, websocket_client):
|
|
"""Test call service command with target does not allow template."""
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 5,
|
|
"type": "call_service",
|
|
"domain": "domain_test",
|
|
"service": "test_service",
|
|
"service_data": {"hello": "world"},
|
|
"target": {
|
|
"entity_id": "{{ 1 }}",
|
|
},
|
|
}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert not msg["success"]
|
|
assert msg["error"]["code"] == const.ERR_INVALID_FORMAT
|
|
|
|
|
|
async def test_call_service_not_found(hass, websocket_client):
|
|
"""Test call service command."""
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 5,
|
|
"type": "call_service",
|
|
"domain": "domain_test",
|
|
"service": "test_service",
|
|
"service_data": {"hello": "world"},
|
|
}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert not msg["success"]
|
|
assert msg["error"]["code"] == const.ERR_NOT_FOUND
|
|
|
|
|
|
async def test_call_service_child_not_found(hass, websocket_client):
|
|
"""Test not reporting not found errors if it's not the called service."""
|
|
|
|
async def serv_handler(call):
|
|
await hass.services.async_call("non", "existing")
|
|
|
|
hass.services.async_register("domain_test", "test_service", serv_handler)
|
|
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 5,
|
|
"type": "call_service",
|
|
"domain": "domain_test",
|
|
"service": "test_service",
|
|
"service_data": {"hello": "world"},
|
|
}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert not msg["success"]
|
|
assert msg["error"]["code"] == const.ERR_HOME_ASSISTANT_ERROR
|
|
|
|
|
|
async def test_call_service_schema_validation_error(
|
|
hass: HomeAssistant, websocket_client
|
|
):
|
|
"""Test call service command with invalid service data."""
|
|
|
|
calls = []
|
|
service_schema = vol.Schema(
|
|
{
|
|
vol.Required("message"): str,
|
|
}
|
|
)
|
|
|
|
@callback
|
|
def service_call(call):
|
|
calls.append(call)
|
|
|
|
hass.services.async_register(
|
|
"domain_test",
|
|
"test_service",
|
|
service_call,
|
|
schema=service_schema,
|
|
)
|
|
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 5,
|
|
"type": "call_service",
|
|
"domain": "domain_test",
|
|
"service": "test_service",
|
|
"service_data": {},
|
|
}
|
|
)
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert not msg["success"]
|
|
assert msg["error"]["code"] == const.ERR_INVALID_FORMAT
|
|
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 6,
|
|
"type": "call_service",
|
|
"domain": "domain_test",
|
|
"service": "test_service",
|
|
"service_data": {"extra_key": "not allowed"},
|
|
}
|
|
)
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 6
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert not msg["success"]
|
|
assert msg["error"]["code"] == const.ERR_INVALID_FORMAT
|
|
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 7,
|
|
"type": "call_service",
|
|
"domain": "domain_test",
|
|
"service": "test_service",
|
|
"service_data": {"message": []},
|
|
}
|
|
)
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert not msg["success"]
|
|
assert msg["error"]["code"] == const.ERR_INVALID_FORMAT
|
|
|
|
assert len(calls) == 0
|
|
|
|
|
|
async def test_call_service_error(hass, websocket_client):
|
|
"""Test call service command with error."""
|
|
|
|
@callback
|
|
def ha_error_call(_):
|
|
raise HomeAssistantError("error_message")
|
|
|
|
hass.services.async_register("domain_test", "ha_error", ha_error_call)
|
|
|
|
async def unknown_error_call(_):
|
|
raise ValueError("value_error")
|
|
|
|
hass.services.async_register("domain_test", "unknown_error", unknown_error_call)
|
|
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 5,
|
|
"type": "call_service",
|
|
"domain": "domain_test",
|
|
"service": "ha_error",
|
|
}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"] is False
|
|
assert msg["error"]["code"] == "home_assistant_error"
|
|
assert msg["error"]["message"] == "error_message"
|
|
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 6,
|
|
"type": "call_service",
|
|
"domain": "domain_test",
|
|
"service": "unknown_error",
|
|
}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 6
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"] is False
|
|
assert msg["error"]["code"] == "unknown_error"
|
|
assert msg["error"]["message"] == "value_error"
|
|
|
|
|
|
async def test_subscribe_unsubscribe_events(hass, websocket_client):
|
|
"""Test subscribe/unsubscribe events command."""
|
|
init_count = sum(hass.bus.async_listeners().values())
|
|
|
|
await websocket_client.send_json(
|
|
{"id": 5, "type": "subscribe_events", "event_type": "test_event"}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
# Verify we have a new listener
|
|
assert sum(hass.bus.async_listeners().values()) == init_count + 1
|
|
|
|
hass.bus.async_fire("ignore_event")
|
|
hass.bus.async_fire("test_event", {"hello": "world"})
|
|
hass.bus.async_fire("ignore_event")
|
|
|
|
async with timeout(3):
|
|
msg = await websocket_client.receive_json()
|
|
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == "event"
|
|
event = msg["event"]
|
|
|
|
assert event["event_type"] == "test_event"
|
|
assert event["data"] == {"hello": "world"}
|
|
assert event["origin"] == "LOCAL"
|
|
|
|
await websocket_client.send_json(
|
|
{"id": 6, "type": "unsubscribe_events", "subscription": 5}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 6
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
# Check our listener got unsubscribed
|
|
assert sum(hass.bus.async_listeners().values()) == init_count
|
|
|
|
|
|
async def test_get_states(hass, websocket_client):
|
|
"""Test get_states command."""
|
|
hass.states.async_set("greeting.hello", "world")
|
|
hass.states.async_set("greeting.bye", "universe")
|
|
|
|
await websocket_client.send_json({"id": 5, "type": "get_states"})
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
states = []
|
|
for state in hass.states.async_all():
|
|
states.append(state.as_dict())
|
|
|
|
assert msg["result"] == states
|
|
|
|
|
|
async def test_get_services(hass, websocket_client):
|
|
"""Test get_services command."""
|
|
await websocket_client.send_json({"id": 5, "type": "get_services"})
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
assert msg["result"] == hass.services.async_services()
|
|
|
|
|
|
async def test_get_config(hass, websocket_client):
|
|
"""Test get_config command."""
|
|
await websocket_client.send_json({"id": 5, "type": "get_config"})
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
if "components" in msg["result"]:
|
|
msg["result"]["components"] = set(msg["result"]["components"])
|
|
if "whitelist_external_dirs" in msg["result"]:
|
|
msg["result"]["whitelist_external_dirs"] = set(
|
|
msg["result"]["whitelist_external_dirs"]
|
|
)
|
|
if "allowlist_external_dirs" in msg["result"]:
|
|
msg["result"]["allowlist_external_dirs"] = set(
|
|
msg["result"]["allowlist_external_dirs"]
|
|
)
|
|
if "allowlist_external_urls" in msg["result"]:
|
|
msg["result"]["allowlist_external_urls"] = set(
|
|
msg["result"]["allowlist_external_urls"]
|
|
)
|
|
|
|
assert msg["result"] == hass.config.as_dict()
|
|
|
|
|
|
async def test_ping(websocket_client):
|
|
"""Test get_panels command."""
|
|
await websocket_client.send_json({"id": 5, "type": "ping"})
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == "pong"
|
|
|
|
|
|
async def test_call_service_context_with_user(
|
|
hass, hass_client_no_auth, hass_access_token
|
|
):
|
|
"""Test that the user is set in the service call context."""
|
|
assert await async_setup_component(hass, "websocket_api", {})
|
|
|
|
calls = async_mock_service(hass, "domain_test", "test_service")
|
|
client = await hass_client_no_auth()
|
|
|
|
async with client.ws_connect(URL) as ws:
|
|
auth_msg = await ws.receive_json()
|
|
assert auth_msg["type"] == TYPE_AUTH_REQUIRED
|
|
|
|
await ws.send_json({"type": TYPE_AUTH, "access_token": hass_access_token})
|
|
|
|
auth_msg = await ws.receive_json()
|
|
assert auth_msg["type"] == TYPE_AUTH_OK
|
|
|
|
await ws.send_json(
|
|
{
|
|
"id": 5,
|
|
"type": "call_service",
|
|
"domain": "domain_test",
|
|
"service": "test_service",
|
|
"service_data": {"hello": "world"},
|
|
}
|
|
)
|
|
|
|
msg = await ws.receive_json()
|
|
assert msg["success"]
|
|
|
|
refresh_token = await hass.auth.async_validate_access_token(hass_access_token)
|
|
|
|
assert len(calls) == 1
|
|
call = calls[0]
|
|
assert call.domain == "domain_test"
|
|
assert call.service == "test_service"
|
|
assert call.data == {"hello": "world"}
|
|
assert call.context.user_id == refresh_token.user.id
|
|
|
|
|
|
async def test_subscribe_requires_admin(websocket_client, hass_admin_user):
|
|
"""Test subscribing events without being admin."""
|
|
hass_admin_user.groups = []
|
|
await websocket_client.send_json(
|
|
{"id": 5, "type": "subscribe_events", "event_type": "test_event"}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert not msg["success"]
|
|
assert msg["error"]["code"] == const.ERR_UNAUTHORIZED
|
|
|
|
|
|
async def test_states_filters_visible(hass, hass_admin_user, websocket_client):
|
|
"""Test we only get entities that we're allowed to see."""
|
|
hass_admin_user.mock_policy({"entities": {"entity_ids": {"test.entity": True}}})
|
|
hass.states.async_set("test.entity", "hello")
|
|
hass.states.async_set("test.not_visible_entity", "invisible")
|
|
await websocket_client.send_json({"id": 5, "type": "get_states"})
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
assert len(msg["result"]) == 1
|
|
assert msg["result"][0]["entity_id"] == "test.entity"
|
|
|
|
|
|
async def test_get_states_not_allows_nan(hass, websocket_client):
|
|
"""Test get_states command converts NaN to None."""
|
|
hass.states.async_set("greeting.hello", "world")
|
|
hass.states.async_set("greeting.bad", "data", {"hello": float("NaN")})
|
|
hass.states.async_set("greeting.bye", "universe")
|
|
|
|
await websocket_client.send_json({"id": 5, "type": "get_states"})
|
|
bad = dict(hass.states.get("greeting.bad").as_dict())
|
|
bad["attributes"] = dict(bad["attributes"])
|
|
bad["attributes"]["hello"] = None
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
assert msg["result"] == [
|
|
hass.states.get("greeting.hello").as_dict(),
|
|
bad,
|
|
hass.states.get("greeting.bye").as_dict(),
|
|
]
|
|
|
|
|
|
async def test_subscribe_unsubscribe_events_whitelist(
|
|
hass, websocket_client, hass_admin_user
|
|
):
|
|
"""Test subscribe/unsubscribe events on whitelist."""
|
|
hass_admin_user.groups = []
|
|
|
|
await websocket_client.send_json(
|
|
{"id": 5, "type": "subscribe_events", "event_type": "not-in-whitelist"}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert not msg["success"]
|
|
assert msg["error"]["code"] == "unauthorized"
|
|
|
|
await websocket_client.send_json(
|
|
{"id": 6, "type": "subscribe_events", "event_type": "themes_updated"}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 6
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
hass.bus.async_fire("themes_updated")
|
|
|
|
async with timeout(3):
|
|
msg = await websocket_client.receive_json()
|
|
|
|
assert msg["id"] == 6
|
|
assert msg["type"] == "event"
|
|
event = msg["event"]
|
|
assert event["event_type"] == "themes_updated"
|
|
assert event["origin"] == "LOCAL"
|
|
|
|
|
|
async def test_subscribe_unsubscribe_events_state_changed(
|
|
hass, websocket_client, hass_admin_user
|
|
):
|
|
"""Test subscribe/unsubscribe state_changed events."""
|
|
hass_admin_user.groups = []
|
|
hass_admin_user.mock_policy({"entities": {"entity_ids": {"light.permitted": True}}})
|
|
|
|
await websocket_client.send_json(
|
|
{"id": 7, "type": "subscribe_events", "event_type": "state_changed"}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
hass.states.async_set("light.not_permitted", "on")
|
|
hass.states.async_set("light.permitted", "on")
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert msg["event"]["event_type"] == "state_changed"
|
|
assert msg["event"]["data"]["entity_id"] == "light.permitted"
|
|
|
|
|
|
async def test_subscribe_entities_with_unserializable_state(
|
|
hass, websocket_client, hass_admin_user
|
|
):
|
|
"""Test subscribe entities with an unserializeable state."""
|
|
|
|
class CannotSerializeMe:
|
|
"""Cannot serialize this."""
|
|
|
|
def __init__(self):
|
|
"""Init cannot serialize this."""
|
|
|
|
hass.states.async_set("light.permitted", "off", {"color": "red"})
|
|
hass.states.async_set(
|
|
"light.cannot_serialize",
|
|
"off",
|
|
{"color": "red", "cannot_serialize": CannotSerializeMe()},
|
|
)
|
|
original_state = hass.states.get("light.cannot_serialize")
|
|
assert isinstance(original_state, State)
|
|
state_dict = {
|
|
"attributes": dict(original_state.attributes),
|
|
"context": dict(original_state.context.as_dict()),
|
|
"entity_id": original_state.entity_id,
|
|
"last_changed": original_state.last_changed.isoformat(),
|
|
"last_updated": original_state.last_updated.isoformat(),
|
|
"state": original_state.state,
|
|
}
|
|
hass_admin_user.groups = []
|
|
hass_admin_user.mock_policy(
|
|
{
|
|
"entities": {
|
|
"entity_ids": {"light.permitted": True, "light.cannot_serialize": True}
|
|
}
|
|
}
|
|
)
|
|
|
|
await websocket_client.send_json({"id": 7, "type": "subscribe_entities"})
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert msg["event"] == {
|
|
"a": {
|
|
"light.permitted": {
|
|
"a": {"color": "red"},
|
|
"c": ANY,
|
|
"lc": ANY,
|
|
"s": "off",
|
|
}
|
|
}
|
|
}
|
|
hass.states.async_set("light.permitted", "on", {"effect": "help"})
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert msg["event"] == {
|
|
"c": {
|
|
"light.permitted": {
|
|
"+": {
|
|
"a": {"effect": "help"},
|
|
"c": ANY,
|
|
"lc": ANY,
|
|
"s": "on",
|
|
},
|
|
"-": {"a": ["color"]},
|
|
}
|
|
}
|
|
}
|
|
hass.states.async_set("light.cannot_serialize", "on", {"effect": "help"})
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
# Order does not matter
|
|
msg["event"]["c"]["light.cannot_serialize"]["-"]["a"] = set(
|
|
msg["event"]["c"]["light.cannot_serialize"]["-"]["a"]
|
|
)
|
|
assert msg["event"] == {
|
|
"c": {
|
|
"light.cannot_serialize": {
|
|
"+": {"a": {"effect": "help"}, "c": ANY, "lc": ANY, "s": "on"},
|
|
"-": {"a": {"color", "cannot_serialize"}},
|
|
}
|
|
}
|
|
}
|
|
change_set = msg["event"]["c"]["light.cannot_serialize"]
|
|
_apply_entities_changes(state_dict, change_set)
|
|
assert state_dict == {
|
|
"attributes": {"effect": "help"},
|
|
"context": {
|
|
"id": ANY,
|
|
"parent_id": None,
|
|
"user_id": None,
|
|
},
|
|
"entity_id": "light.cannot_serialize",
|
|
"last_changed": ANY,
|
|
"last_updated": ANY,
|
|
"state": "on",
|
|
}
|
|
hass.states.async_set(
|
|
"light.cannot_serialize",
|
|
"off",
|
|
{"color": "red", "cannot_serialize": CannotSerializeMe()},
|
|
)
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "result"
|
|
assert msg["error"] == {
|
|
"code": "unknown_error",
|
|
"message": "Invalid JSON in response",
|
|
}
|
|
|
|
|
|
async def test_subscribe_unsubscribe_entities(hass, websocket_client, hass_admin_user):
|
|
"""Test subscribe/unsubscribe entities."""
|
|
|
|
hass.states.async_set("light.permitted", "off", {"color": "red"})
|
|
original_state = hass.states.get("light.permitted")
|
|
assert isinstance(original_state, State)
|
|
state_dict = {
|
|
"attributes": dict(original_state.attributes),
|
|
"context": dict(original_state.context.as_dict()),
|
|
"entity_id": original_state.entity_id,
|
|
"last_changed": original_state.last_changed.isoformat(),
|
|
"last_updated": original_state.last_updated.isoformat(),
|
|
"state": original_state.state,
|
|
}
|
|
hass_admin_user.groups = []
|
|
hass_admin_user.mock_policy({"entities": {"entity_ids": {"light.permitted": True}}})
|
|
|
|
await websocket_client.send_json({"id": 7, "type": "subscribe_entities"})
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert isinstance(msg["event"]["a"]["light.permitted"]["c"], str)
|
|
assert msg["event"] == {
|
|
"a": {
|
|
"light.permitted": {
|
|
"a": {"color": "red"},
|
|
"c": ANY,
|
|
"lc": ANY,
|
|
"s": "off",
|
|
}
|
|
}
|
|
}
|
|
hass.states.async_set("light.not_permitted", "on")
|
|
hass.states.async_set("light.permitted", "on", {"color": "blue"})
|
|
hass.states.async_set("light.permitted", "on", {"effect": "help"})
|
|
hass.states.async_set(
|
|
"light.permitted", "on", {"effect": "help", "color": ["blue", "green"]}
|
|
)
|
|
hass.states.async_remove("light.permitted")
|
|
hass.states.async_set("light.permitted", "on", {"effect": "help", "color": "blue"})
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert msg["event"] == {
|
|
"c": {
|
|
"light.permitted": {
|
|
"+": {
|
|
"a": {"color": "blue"},
|
|
"c": ANY,
|
|
"lc": ANY,
|
|
"s": "on",
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
change_set = msg["event"]["c"]["light.permitted"]
|
|
additions = deepcopy(change_set["+"])
|
|
_apply_entities_changes(state_dict, change_set)
|
|
assert state_dict == {
|
|
"attributes": {"color": "blue"},
|
|
"context": {
|
|
"id": additions["c"],
|
|
"parent_id": None,
|
|
"user_id": None,
|
|
},
|
|
"entity_id": "light.permitted",
|
|
"last_changed": additions["lc"],
|
|
"last_updated": additions["lc"],
|
|
"state": "on",
|
|
}
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert msg["event"] == {
|
|
"c": {
|
|
"light.permitted": {
|
|
"+": {
|
|
"a": {"effect": "help"},
|
|
"c": ANY,
|
|
"lu": ANY,
|
|
},
|
|
"-": {"a": ["color"]},
|
|
}
|
|
}
|
|
}
|
|
|
|
change_set = msg["event"]["c"]["light.permitted"]
|
|
additions = deepcopy(change_set["+"])
|
|
_apply_entities_changes(state_dict, change_set)
|
|
|
|
assert state_dict == {
|
|
"attributes": {"effect": "help"},
|
|
"context": {
|
|
"id": additions["c"],
|
|
"parent_id": None,
|
|
"user_id": None,
|
|
},
|
|
"entity_id": "light.permitted",
|
|
"last_changed": ANY,
|
|
"last_updated": additions["lu"],
|
|
"state": "on",
|
|
}
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert msg["event"] == {
|
|
"c": {
|
|
"light.permitted": {
|
|
"+": {
|
|
"a": {"color": ["blue", "green"]},
|
|
"c": ANY,
|
|
"lu": ANY,
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
change_set = msg["event"]["c"]["light.permitted"]
|
|
additions = deepcopy(change_set["+"])
|
|
_apply_entities_changes(state_dict, change_set)
|
|
|
|
assert state_dict == {
|
|
"attributes": {"effect": "help", "color": ["blue", "green"]},
|
|
"context": {
|
|
"id": additions["c"],
|
|
"parent_id": None,
|
|
"user_id": None,
|
|
},
|
|
"entity_id": "light.permitted",
|
|
"last_changed": ANY,
|
|
"last_updated": additions["lu"],
|
|
"state": "on",
|
|
}
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert msg["event"] == {"r": ["light.permitted"]}
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert msg["event"] == {
|
|
"a": {
|
|
"light.permitted": {
|
|
"a": {"color": "blue", "effect": "help"},
|
|
"c": ANY,
|
|
"lc": ANY,
|
|
"s": "on",
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
async def test_subscribe_unsubscribe_entities_specific_entities(
|
|
hass, websocket_client, hass_admin_user
|
|
):
|
|
"""Test subscribe/unsubscribe entities with a list of entity ids."""
|
|
|
|
hass.states.async_set("light.permitted", "off", {"color": "red"})
|
|
hass.states.async_set("light.not_intrested", "off", {"color": "blue"})
|
|
original_state = hass.states.get("light.permitted")
|
|
assert isinstance(original_state, State)
|
|
hass_admin_user.groups = []
|
|
hass_admin_user.mock_policy(
|
|
{
|
|
"entities": {
|
|
"entity_ids": {"light.permitted": True, "light.not_intrested": True}
|
|
}
|
|
}
|
|
)
|
|
|
|
await websocket_client.send_json(
|
|
{"id": 7, "type": "subscribe_entities", "entity_ids": ["light.permitted"]}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert isinstance(msg["event"]["a"]["light.permitted"]["c"], str)
|
|
assert msg["event"] == {
|
|
"a": {
|
|
"light.permitted": {
|
|
"a": {"color": "red"},
|
|
"c": ANY,
|
|
"lc": ANY,
|
|
"s": "off",
|
|
}
|
|
}
|
|
}
|
|
hass.states.async_set("light.not_intrested", "on", {"effect": "help"})
|
|
hass.states.async_set("light.not_permitted", "on")
|
|
hass.states.async_set("light.permitted", "on", {"color": "blue"})
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert msg["event"] == {
|
|
"c": {
|
|
"light.permitted": {
|
|
"+": {
|
|
"a": {"color": "blue"},
|
|
"c": ANY,
|
|
"lc": ANY,
|
|
"s": "on",
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
async def test_render_template_renders_template(hass, websocket_client):
|
|
"""Test simple template is rendered and updated."""
|
|
hass.states.async_set("light.test", "on")
|
|
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 5,
|
|
"type": "render_template",
|
|
"template": "State is: {{ states('light.test') }}",
|
|
}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == "event"
|
|
event = msg["event"]
|
|
assert event == {
|
|
"result": "State is: on",
|
|
"listeners": {
|
|
"all": False,
|
|
"domains": [],
|
|
"entities": ["light.test"],
|
|
"time": False,
|
|
},
|
|
}
|
|
|
|
hass.states.async_set("light.test", "off")
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == "event"
|
|
event = msg["event"]
|
|
assert event == {
|
|
"result": "State is: off",
|
|
"listeners": {
|
|
"all": False,
|
|
"domains": [],
|
|
"entities": ["light.test"],
|
|
"time": False,
|
|
},
|
|
}
|
|
|
|
|
|
async def test_render_template_with_timeout_and_variables(hass, websocket_client):
|
|
"""Test a template with a timeout and variables renders without error."""
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 5,
|
|
"type": "render_template",
|
|
"timeout": 10,
|
|
"variables": {"test": {"value": "hello"}},
|
|
"template": "{{ test.value }}",
|
|
}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == "event"
|
|
event = msg["event"]
|
|
assert event == {
|
|
"result": "hello",
|
|
"listeners": {
|
|
"all": False,
|
|
"domains": [],
|
|
"entities": [],
|
|
"time": False,
|
|
},
|
|
}
|
|
|
|
|
|
async def test_render_template_manual_entity_ids_no_longer_needed(
|
|
hass, websocket_client
|
|
):
|
|
"""Test that updates to specified entity ids cause a template rerender."""
|
|
hass.states.async_set("light.test", "on")
|
|
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 5,
|
|
"type": "render_template",
|
|
"template": "State is: {{ states('light.test') }}",
|
|
}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == "event"
|
|
event = msg["event"]
|
|
assert event == {
|
|
"result": "State is: on",
|
|
"listeners": {
|
|
"all": False,
|
|
"domains": [],
|
|
"entities": ["light.test"],
|
|
"time": False,
|
|
},
|
|
}
|
|
|
|
hass.states.async_set("light.test", "off")
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == "event"
|
|
event = msg["event"]
|
|
assert event == {
|
|
"result": "State is: off",
|
|
"listeners": {
|
|
"all": False,
|
|
"domains": [],
|
|
"entities": ["light.test"],
|
|
"time": False,
|
|
},
|
|
}
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"template",
|
|
[
|
|
"{{ my_unknown_func() + 1 }}",
|
|
"{{ my_unknown_var }}",
|
|
"{{ my_unknown_var + 1 }}",
|
|
"{{ now() | unknown_filter }}",
|
|
],
|
|
)
|
|
async def test_render_template_with_error(hass, websocket_client, caplog, template):
|
|
"""Test a template with an error."""
|
|
await websocket_client.send_json(
|
|
{"id": 5, "type": "render_template", "template": template, "strict": True}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert not msg["success"]
|
|
assert msg["error"]["code"] == const.ERR_TEMPLATE_ERROR
|
|
|
|
assert "Template variable error" not in caplog.text
|
|
assert "TemplateError" not in caplog.text
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"template",
|
|
[
|
|
"{{ my_unknown_func() + 1 }}",
|
|
"{{ my_unknown_var }}",
|
|
"{{ my_unknown_var + 1 }}",
|
|
"{{ now() | unknown_filter }}",
|
|
],
|
|
)
|
|
async def test_render_template_with_timeout_and_error(
|
|
hass, websocket_client, caplog, template
|
|
):
|
|
"""Test a template with an error with a timeout."""
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 5,
|
|
"type": "render_template",
|
|
"template": template,
|
|
"timeout": 5,
|
|
"strict": True,
|
|
}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert not msg["success"]
|
|
assert msg["error"]["code"] == const.ERR_TEMPLATE_ERROR
|
|
|
|
assert "Template variable error" not in caplog.text
|
|
assert "TemplateError" not in caplog.text
|
|
|
|
|
|
async def test_render_template_error_in_template_code(hass, websocket_client, caplog):
|
|
"""Test a template that will throw in template.py."""
|
|
await websocket_client.send_json(
|
|
{"id": 5, "type": "render_template", "template": "{{ now() | random }}"}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert not msg["success"]
|
|
assert msg["error"]["code"] == const.ERR_TEMPLATE_ERROR
|
|
|
|
assert "TemplateError" not in caplog.text
|
|
|
|
|
|
async def test_render_template_with_delayed_error(hass, websocket_client, caplog):
|
|
"""Test a template with an error that only happens after a state change."""
|
|
hass.states.async_set("sensor.test", "on")
|
|
await hass.async_block_till_done()
|
|
|
|
template_str = """
|
|
{% if states.sensor.test.state %}
|
|
on
|
|
{% else %}
|
|
{{ explode + 1 }}
|
|
{% endif %}
|
|
"""
|
|
|
|
await websocket_client.send_json(
|
|
{"id": 5, "type": "render_template", "template": template_str}
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
msg = await websocket_client.receive_json()
|
|
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
hass.states.async_remove("sensor.test")
|
|
await hass.async_block_till_done()
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == "event"
|
|
event = msg["event"]
|
|
assert event == {
|
|
"result": "on",
|
|
"listeners": {
|
|
"all": False,
|
|
"domains": [],
|
|
"entities": ["sensor.test"],
|
|
"time": False,
|
|
},
|
|
}
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert not msg["success"]
|
|
assert msg["error"]["code"] == const.ERR_TEMPLATE_ERROR
|
|
|
|
assert "TemplateError" not in caplog.text
|
|
|
|
|
|
async def test_render_template_with_timeout(hass, websocket_client, caplog):
|
|
"""Test a template that will timeout."""
|
|
|
|
slow_template_str = """
|
|
{% for var in range(1000) -%}
|
|
{% for var in range(1000) -%}
|
|
{{ var }}
|
|
{%- endfor %}
|
|
{%- endfor %}
|
|
"""
|
|
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 5,
|
|
"type": "render_template",
|
|
"timeout": 0.000001,
|
|
"template": slow_template_str,
|
|
}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert not msg["success"]
|
|
assert msg["error"]["code"] == const.ERR_TEMPLATE_ERROR
|
|
|
|
assert "TemplateError" not in caplog.text
|
|
|
|
|
|
async def test_render_template_returns_with_match_all(hass, websocket_client):
|
|
"""Test that a template that would match with all entities still return success."""
|
|
await websocket_client.send_json(
|
|
{"id": 5, "type": "render_template", "template": "State is: {{ 42 }}"}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
|
|
async def test_manifest_list(hass, websocket_client):
|
|
"""Test loading manifests."""
|
|
http = await async_get_integration(hass, "http")
|
|
websocket_api = await async_get_integration(hass, "websocket_api")
|
|
|
|
await websocket_client.send_json({"id": 5, "type": "manifest/list"})
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
assert sorted(msg["result"], key=lambda manifest: manifest["domain"]) == [
|
|
http.manifest,
|
|
websocket_api.manifest,
|
|
]
|
|
|
|
|
|
async def test_manifest_list_specific_integrations(hass, websocket_client):
|
|
"""Test loading manifests for specific integrations."""
|
|
websocket_api = await async_get_integration(hass, "websocket_api")
|
|
|
|
await websocket_client.send_json(
|
|
{"id": 5, "type": "manifest/list", "integrations": ["hue", "websocket_api"]}
|
|
)
|
|
hue = await async_get_integration(hass, "hue")
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
assert sorted(msg["result"], key=lambda manifest: manifest["domain"]) == [
|
|
hue.manifest,
|
|
websocket_api.manifest,
|
|
]
|
|
|
|
|
|
async def test_manifest_get(hass, websocket_client):
|
|
"""Test getting a manifest."""
|
|
hue = await async_get_integration(hass, "hue")
|
|
|
|
await websocket_client.send_json(
|
|
{"id": 6, "type": "manifest/get", "integration": "hue"}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 6
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
assert msg["result"] == hue.manifest
|
|
|
|
# Non existing
|
|
await websocket_client.send_json(
|
|
{"id": 7, "type": "manifest/get", "integration": "non_existing"}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert not msg["success"]
|
|
assert msg["error"]["code"] == "not_found"
|
|
|
|
|
|
async def test_entity_source_admin(hass, websocket_client, hass_admin_user):
|
|
"""Check that we fetch sources correctly."""
|
|
platform = MockEntityPlatform(hass)
|
|
|
|
await platform.async_add_entities(
|
|
[MockEntity(name="Entity 1"), MockEntity(name="Entity 2")]
|
|
)
|
|
|
|
# Fetch all
|
|
await websocket_client.send_json({"id": 6, "type": "entity/source"})
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 6
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
assert msg["result"] == {
|
|
"test_domain.entity_1": {
|
|
"custom_component": False,
|
|
"domain": "test_platform",
|
|
"source": entity.SOURCE_PLATFORM_CONFIG,
|
|
},
|
|
"test_domain.entity_2": {
|
|
"custom_component": False,
|
|
"domain": "test_platform",
|
|
"source": entity.SOURCE_PLATFORM_CONFIG,
|
|
},
|
|
}
|
|
|
|
# Fetch one
|
|
await websocket_client.send_json(
|
|
{"id": 7, "type": "entity/source", "entity_id": ["test_domain.entity_2"]}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
assert msg["result"] == {
|
|
"test_domain.entity_2": {
|
|
"custom_component": False,
|
|
"domain": "test_platform",
|
|
"source": entity.SOURCE_PLATFORM_CONFIG,
|
|
},
|
|
}
|
|
|
|
# Fetch two
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 8,
|
|
"type": "entity/source",
|
|
"entity_id": ["test_domain.entity_2", "test_domain.entity_1"],
|
|
}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 8
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
assert msg["result"] == {
|
|
"test_domain.entity_1": {
|
|
"custom_component": False,
|
|
"domain": "test_platform",
|
|
"source": entity.SOURCE_PLATFORM_CONFIG,
|
|
},
|
|
"test_domain.entity_2": {
|
|
"custom_component": False,
|
|
"domain": "test_platform",
|
|
"source": entity.SOURCE_PLATFORM_CONFIG,
|
|
},
|
|
}
|
|
|
|
# Fetch non existing
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 9,
|
|
"type": "entity/source",
|
|
"entity_id": ["test_domain.entity_2", "test_domain.non_existing"],
|
|
}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 9
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert not msg["success"]
|
|
assert msg["error"]["code"] == const.ERR_NOT_FOUND
|
|
|
|
# Mock policy
|
|
hass_admin_user.groups = []
|
|
hass_admin_user.mock_policy(
|
|
{"entities": {"entity_ids": {"test_domain.entity_2": True}}}
|
|
)
|
|
|
|
# Fetch all
|
|
await websocket_client.send_json({"id": 10, "type": "entity/source"})
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 10
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
assert msg["result"] == {
|
|
"test_domain.entity_2": {
|
|
"custom_component": False,
|
|
"domain": "test_platform",
|
|
"source": entity.SOURCE_PLATFORM_CONFIG,
|
|
},
|
|
}
|
|
|
|
# Fetch unauthorized
|
|
await websocket_client.send_json(
|
|
{"id": 11, "type": "entity/source", "entity_id": ["test_domain.entity_1"]}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 11
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert not msg["success"]
|
|
assert msg["error"]["code"] == const.ERR_UNAUTHORIZED
|
|
|
|
|
|
async def test_subscribe_trigger(hass, websocket_client):
|
|
"""Test subscribing to a trigger."""
|
|
init_count = sum(hass.bus.async_listeners().values())
|
|
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 5,
|
|
"type": "subscribe_trigger",
|
|
"trigger": {"platform": "event", "event_type": "test_event"},
|
|
"variables": {"hello": "world"},
|
|
}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
# Verify we have a new listener
|
|
assert sum(hass.bus.async_listeners().values()) == init_count + 1
|
|
|
|
context = Context()
|
|
|
|
hass.bus.async_fire("ignore_event")
|
|
hass.bus.async_fire("test_event", {"hello": "world"}, context=context)
|
|
hass.bus.async_fire("ignore_event")
|
|
|
|
async with timeout(3):
|
|
msg = await websocket_client.receive_json()
|
|
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == "event"
|
|
assert msg["event"]["context"]["id"] == context.id
|
|
assert msg["event"]["variables"]["trigger"]["platform"] == "event"
|
|
|
|
event = msg["event"]["variables"]["trigger"]["event"]
|
|
|
|
assert event["event_type"] == "test_event"
|
|
assert event["data"] == {"hello": "world"}
|
|
assert event["origin"] == "LOCAL"
|
|
|
|
await websocket_client.send_json(
|
|
{"id": 6, "type": "unsubscribe_events", "subscription": 5}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 6
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
# Check our listener got unsubscribed
|
|
assert sum(hass.bus.async_listeners().values()) == init_count
|
|
|
|
|
|
async def test_test_condition(hass, websocket_client):
|
|
"""Test testing a condition."""
|
|
hass.states.async_set("hello.world", "paulus")
|
|
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 5,
|
|
"type": "test_condition",
|
|
"condition": {
|
|
"condition": "state",
|
|
"entity_id": "hello.world",
|
|
"state": "paulus",
|
|
},
|
|
"variables": {"hello": "world"},
|
|
}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 5
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
assert msg["result"]["result"] is True
|
|
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 6,
|
|
"type": "test_condition",
|
|
"condition": {
|
|
"condition": "template",
|
|
"value_template": "{{ is_state('hello.world', 'paulus') }}",
|
|
},
|
|
"variables": {"hello": "world"},
|
|
}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 6
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
assert msg["result"]["result"] is True
|
|
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 7,
|
|
"type": "test_condition",
|
|
"condition": {
|
|
"condition": "template",
|
|
"value_template": "{{ is_state('hello.world', 'frenck') }}",
|
|
},
|
|
"variables": {"hello": "world"},
|
|
}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
assert msg["result"]["result"] is False
|
|
|
|
|
|
async def test_execute_script(hass, websocket_client):
|
|
"""Test testing a condition."""
|
|
calls = async_mock_service(hass, "domain_test", "test_service")
|
|
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 5,
|
|
"type": "execute_script",
|
|
"sequence": [
|
|
{
|
|
"service": "domain_test.test_service",
|
|
"data": {"hello": "world"},
|
|
}
|
|
],
|
|
}
|
|
)
|
|
|
|
msg_no_var = await websocket_client.receive_json()
|
|
assert msg_no_var["id"] == 5
|
|
assert msg_no_var["type"] == const.TYPE_RESULT
|
|
assert msg_no_var["success"]
|
|
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 6,
|
|
"type": "execute_script",
|
|
"sequence": {
|
|
"service": "domain_test.test_service",
|
|
"data": {"hello": "{{ name }}"},
|
|
},
|
|
"variables": {"name": "From variable"},
|
|
}
|
|
)
|
|
|
|
msg_var = await websocket_client.receive_json()
|
|
assert msg_var["id"] == 6
|
|
assert msg_var["type"] == const.TYPE_RESULT
|
|
assert msg_var["success"]
|
|
|
|
await hass.async_block_till_done()
|
|
await hass.async_block_till_done()
|
|
|
|
assert len(calls) == 2
|
|
|
|
call = calls[0]
|
|
assert call.domain == "domain_test"
|
|
assert call.service == "test_service"
|
|
assert call.data == {"hello": "world"}
|
|
assert call.context.as_dict() == msg_no_var["result"]["context"]
|
|
|
|
call = calls[1]
|
|
assert call.domain == "domain_test"
|
|
assert call.service == "test_service"
|
|
assert call.data == {"hello": "From variable"}
|
|
assert call.context.as_dict() == msg_var["result"]["context"]
|
|
|
|
|
|
async def test_subscribe_unsubscribe_bootstrap_integrations(
|
|
hass, websocket_client, hass_admin_user
|
|
):
|
|
"""Test subscribe/unsubscribe bootstrap_integrations."""
|
|
await websocket_client.send_json(
|
|
{"id": 7, "type": "subscribe_bootstrap_integrations"}
|
|
)
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
message = {"august": 12.5, "isy994": 12.8}
|
|
|
|
async_dispatcher_send(hass, SIGNAL_BOOTSTRAP_INTEGRATIONS, message)
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert msg["event"] == message
|
|
|
|
|
|
async def test_integration_setup_info(hass, websocket_client, hass_admin_user):
|
|
"""Test subscribe/unsubscribe bootstrap_integrations."""
|
|
hass.data[DATA_SETUP_TIME] = {
|
|
"august": datetime.timedelta(seconds=12.5),
|
|
"isy994": datetime.timedelta(seconds=12.8),
|
|
}
|
|
await websocket_client.send_json({"id": 7, "type": "integration/setup_info"})
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
assert msg["result"] == [
|
|
{"domain": "august", "seconds": 12.5},
|
|
{"domain": "isy994", "seconds": 12.8},
|
|
]
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"key,config",
|
|
(
|
|
("trigger", {"platform": "event", "event_type": "hello"}),
|
|
(
|
|
"condition",
|
|
{"condition": "state", "entity_id": "hello.world", "state": "paulus"},
|
|
),
|
|
("action", {"service": "domain_test.test_service"}),
|
|
),
|
|
)
|
|
async def test_validate_config_works(websocket_client, key, config):
|
|
"""Test config validation."""
|
|
await websocket_client.send_json({"id": 7, "type": "validate_config", key: config})
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
assert msg["result"] == {key: {"valid": True, "error": None}}
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"key,config,error",
|
|
(
|
|
(
|
|
"trigger",
|
|
{"platform": "non_existing", "event_type": "hello"},
|
|
"Invalid platform 'non_existing' specified",
|
|
),
|
|
(
|
|
"condition",
|
|
{
|
|
"condition": "non_existing",
|
|
"entity_id": "hello.world",
|
|
"state": "paulus",
|
|
},
|
|
"Unexpected value for condition: 'non_existing'. Expected and, device, not, numeric_state, or, state, sun, template, time, trigger, zone",
|
|
),
|
|
(
|
|
"action",
|
|
{"non_existing": "domain_test.test_service"},
|
|
"Unable to determine action @ data[0]",
|
|
),
|
|
),
|
|
)
|
|
async def test_validate_config_invalid(websocket_client, key, config, error):
|
|
"""Test config validation."""
|
|
await websocket_client.send_json({"id": 7, "type": "validate_config", key: config})
|
|
|
|
msg = await websocket_client.receive_json()
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
assert msg["result"] == {key: {"valid": False, "error": error}}
|
|
|
|
|
|
async def test_supported_brands(hass, websocket_client):
|
|
"""Test supported brands."""
|
|
# Custom components without supported brands that override a built-in component with
|
|
# supported brand will still be listed in HAS_SUPPORTED_BRANDS and should be ignored.
|
|
mock_integration(
|
|
hass,
|
|
MockModule("override_without_brands"),
|
|
)
|
|
mock_integration(
|
|
hass,
|
|
MockModule("test", partial_manifest={"supported_brands": {"hello": "World"}}),
|
|
)
|
|
mock_integration(
|
|
hass,
|
|
MockModule(
|
|
"abcd", partial_manifest={"supported_brands": {"something": "Something"}}
|
|
),
|
|
)
|
|
|
|
with patch(
|
|
"homeassistant.generated.supported_brands.HAS_SUPPORTED_BRANDS",
|
|
("abcd", "test", "override_without_brands"),
|
|
):
|
|
await websocket_client.send_json({"id": 7, "type": "supported_brands"})
|
|
msg = await websocket_client.receive_json()
|
|
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
assert msg["result"] == {
|
|
"abcd": {
|
|
"something": "Something",
|
|
},
|
|
"test": {
|
|
"hello": "World",
|
|
},
|
|
}
|
|
|
|
|
|
async def test_message_coalescing(hass, websocket_client, hass_admin_user):
|
|
"""Test enabling message coalescing."""
|
|
await websocket_client.send_json(
|
|
{
|
|
"id": 1,
|
|
"type": "supported_features",
|
|
"features": {FEATURE_COALESCE_MESSAGES: 1},
|
|
}
|
|
)
|
|
hass.states.async_set("light.permitted", "on", {"color": "red"})
|
|
|
|
data = await websocket_client.receive_str()
|
|
msg = json_loads(data)
|
|
assert msg["id"] == 1
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
await websocket_client.send_json({"id": 7, "type": "subscribe_entities"})
|
|
|
|
data = await websocket_client.receive_str()
|
|
msgs = json_loads(data)
|
|
msg = msgs.pop(0)
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
msg = msgs.pop(0)
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert msg["event"] == {
|
|
"a": {
|
|
"light.permitted": {"a": {"color": "red"}, "c": ANY, "lc": ANY, "s": "on"}
|
|
}
|
|
}
|
|
|
|
hass.states.async_set("light.permitted", "on", {"color": "yellow"})
|
|
hass.states.async_set("light.permitted", "on", {"color": "green"})
|
|
hass.states.async_set("light.permitted", "on", {"color": "blue"})
|
|
|
|
data = await websocket_client.receive_str()
|
|
msgs = json_loads(data)
|
|
|
|
msg = msgs.pop(0)
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert msg["event"] == {
|
|
"c": {"light.permitted": {"+": {"a": {"color": "yellow"}, "c": ANY, "lu": ANY}}}
|
|
}
|
|
|
|
msg = msgs.pop(0)
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert msg["event"] == {
|
|
"c": {"light.permitted": {"+": {"a": {"color": "green"}, "c": ANY, "lu": ANY}}}
|
|
}
|
|
|
|
msg = msgs.pop(0)
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert msg["event"] == {
|
|
"c": {"light.permitted": {"+": {"a": {"color": "blue"}, "c": ANY, "lu": ANY}}}
|
|
}
|
|
|
|
hass.states.async_set("light.permitted", "on", {"color": "yellow"})
|
|
hass.states.async_set("light.permitted", "on", {"color": "green"})
|
|
hass.states.async_set("light.permitted", "on", {"color": "blue"})
|
|
await websocket_client.close()
|
|
await hass.async_block_till_done()
|
|
|
|
|
|
async def test_message_coalescing_not_supported_by_websocket_client(
|
|
hass, websocket_client, hass_admin_user
|
|
):
|
|
"""Test enabling message coalescing not supported by websocket client."""
|
|
await websocket_client.send_json({"id": 7, "type": "subscribe_entities"})
|
|
|
|
data = await websocket_client.receive_str()
|
|
msg = json_loads(data)
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
hass.states.async_set("light.permitted", "on", {"color": "red"})
|
|
hass.states.async_set("light.permitted", "on", {"color": "blue"})
|
|
|
|
data = await websocket_client.receive_str()
|
|
msg = json_loads(data)
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert msg["event"] == {"a": {}}
|
|
|
|
data = await websocket_client.receive_str()
|
|
msg = json_loads(data)
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert msg["event"] == {
|
|
"a": {
|
|
"light.permitted": {"a": {"color": "red"}, "c": ANY, "lc": ANY, "s": "on"}
|
|
}
|
|
}
|
|
|
|
data = await websocket_client.receive_str()
|
|
msg = json_loads(data)
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert msg["event"] == {
|
|
"c": {"light.permitted": {"+": {"a": {"color": "blue"}, "c": ANY, "lu": ANY}}}
|
|
}
|
|
await websocket_client.close()
|
|
await hass.async_block_till_done()
|
|
|
|
|
|
async def test_client_message_coalescing(hass, websocket_client, hass_admin_user):
|
|
"""Test client message coalescing."""
|
|
await websocket_client.send_json(
|
|
[
|
|
{
|
|
"id": 1,
|
|
"type": "supported_features",
|
|
"features": {FEATURE_COALESCE_MESSAGES: 1},
|
|
},
|
|
{"id": 7, "type": "subscribe_entities"},
|
|
]
|
|
)
|
|
hass.states.async_set("light.permitted", "on", {"color": "red"})
|
|
|
|
data = await websocket_client.receive_str()
|
|
msgs = json_loads(data)
|
|
|
|
msg = msgs.pop(0)
|
|
assert msg["id"] == 1
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
msg = msgs.pop(0)
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == const.TYPE_RESULT
|
|
assert msg["success"]
|
|
|
|
msg = msgs.pop(0)
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert msg["event"] == {
|
|
"a": {
|
|
"light.permitted": {"a": {"color": "red"}, "c": ANY, "lc": ANY, "s": "on"}
|
|
}
|
|
}
|
|
|
|
hass.states.async_set("light.permitted", "on", {"color": "yellow"})
|
|
hass.states.async_set("light.permitted", "on", {"color": "green"})
|
|
hass.states.async_set("light.permitted", "on", {"color": "blue"})
|
|
|
|
data = await websocket_client.receive_str()
|
|
msgs = json_loads(data)
|
|
|
|
msg = msgs.pop(0)
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert msg["event"] == {
|
|
"c": {"light.permitted": {"+": {"a": {"color": "yellow"}, "c": ANY, "lu": ANY}}}
|
|
}
|
|
|
|
msg = msgs.pop(0)
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert msg["event"] == {
|
|
"c": {"light.permitted": {"+": {"a": {"color": "green"}, "c": ANY, "lu": ANY}}}
|
|
}
|
|
|
|
msg = msgs.pop(0)
|
|
assert msg["id"] == 7
|
|
assert msg["type"] == "event"
|
|
assert msg["event"] == {
|
|
"c": {"light.permitted": {"+": {"a": {"color": "blue"}, "c": ANY, "lu": ANY}}}
|
|
}
|
|
|
|
hass.states.async_set("light.permitted", "on", {"color": "yellow"})
|
|
hass.states.async_set("light.permitted", "on", {"color": "green"})
|
|
hass.states.async_set("light.permitted", "on", {"color": "blue"})
|
|
await websocket_client.close()
|
|
await hass.async_block_till_done()
|
|
|
|
|
|
async def test_integration_descriptions(hass, hass_ws_client):
|
|
"""Test we can get integration descriptions."""
|
|
assert await async_setup_component(hass, "config", {})
|
|
ws_client = await hass_ws_client(hass)
|
|
|
|
await ws_client.send_json(
|
|
{
|
|
"id": 1,
|
|
"type": "integration/descriptions",
|
|
}
|
|
)
|
|
response = await ws_client.receive_json()
|
|
|
|
assert response["success"]
|
|
assert response["result"]
|