mirror of https://github.com/home-assistant/core
636 lines
18 KiB
Python
636 lines
18 KiB
Python
"""The tests for the Input number component."""
|
|
|
|
from typing import Any
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.input_number import (
|
|
ATTR_VALUE,
|
|
DOMAIN,
|
|
SERVICE_DECREMENT,
|
|
SERVICE_INCREMENT,
|
|
SERVICE_RELOAD,
|
|
SERVICE_SET_VALUE,
|
|
)
|
|
from homeassistant.const import (
|
|
ATTR_EDITABLE,
|
|
ATTR_ENTITY_ID,
|
|
ATTR_FRIENDLY_NAME,
|
|
ATTR_NAME,
|
|
)
|
|
from homeassistant.core import Context, CoreState, HomeAssistant, State
|
|
from homeassistant.exceptions import Unauthorized
|
|
from homeassistant.helpers import entity_registry as er
|
|
from homeassistant.setup import async_setup_component
|
|
|
|
from tests.common import MockUser, mock_restore_cache
|
|
from tests.typing import WebSocketGenerator
|
|
|
|
|
|
@pytest.fixture
|
|
def storage_setup(hass: HomeAssistant, hass_storage: dict[str, Any]):
|
|
"""Storage setup."""
|
|
|
|
async def _storage(items=None, config=None):
|
|
if items is None:
|
|
hass_storage[DOMAIN] = {
|
|
"key": DOMAIN,
|
|
"version": 1,
|
|
"data": {
|
|
"items": [
|
|
{
|
|
"id": "from_storage",
|
|
"initial": 10,
|
|
"name": "from storage",
|
|
"max": 100,
|
|
"min": 0,
|
|
"step": 1,
|
|
"mode": "slider",
|
|
}
|
|
]
|
|
},
|
|
}
|
|
else:
|
|
hass_storage[DOMAIN] = {
|
|
"key": DOMAIN,
|
|
"version": 1,
|
|
"data": {"items": items},
|
|
}
|
|
if config is None:
|
|
config = {DOMAIN: {}}
|
|
return await async_setup_component(hass, DOMAIN, config)
|
|
|
|
return _storage
|
|
|
|
|
|
async def set_value(hass: HomeAssistant, entity_id: str, value: str) -> None:
|
|
"""Set input_number to value.
|
|
|
|
This is a legacy helper method. Do not use it for new tests.
|
|
"""
|
|
await hass.services.async_call(
|
|
DOMAIN,
|
|
SERVICE_SET_VALUE,
|
|
{ATTR_ENTITY_ID: entity_id, ATTR_VALUE: value},
|
|
blocking=True,
|
|
)
|
|
|
|
|
|
async def increment(hass: HomeAssistant, entity_id: str) -> None:
|
|
"""Increment value of entity.
|
|
|
|
This is a legacy helper method. Do not use it for new tests.
|
|
"""
|
|
await hass.services.async_call(
|
|
DOMAIN, SERVICE_INCREMENT, {ATTR_ENTITY_ID: entity_id}, blocking=True
|
|
)
|
|
|
|
|
|
async def decrement(hass: HomeAssistant, entity_id: str) -> None:
|
|
"""Decrement value of entity.
|
|
|
|
This is a legacy helper method. Do not use it for new tests.
|
|
"""
|
|
await hass.services.async_call(
|
|
DOMAIN, SERVICE_DECREMENT, {ATTR_ENTITY_ID: entity_id}, blocking=True
|
|
)
|
|
|
|
|
|
async def test_config(hass: HomeAssistant) -> None:
|
|
"""Test config."""
|
|
invalid_configs = [
|
|
None,
|
|
{},
|
|
{"name with space": None},
|
|
{"test_1": {"min": 50, "max": 50}},
|
|
]
|
|
for cfg in invalid_configs:
|
|
assert not await async_setup_component(hass, DOMAIN, {DOMAIN: cfg})
|
|
|
|
|
|
async def test_set_value(hass: HomeAssistant, caplog: pytest.LogCaptureFixture) -> None:
|
|
"""Test set_value method."""
|
|
assert await async_setup_component(
|
|
hass, DOMAIN, {DOMAIN: {"test_1": {"initial": 50, "min": 0, "max": 100}}}
|
|
)
|
|
entity_id = "input_number.test_1"
|
|
|
|
state = hass.states.get(entity_id)
|
|
assert float(state.state) == 50
|
|
|
|
await set_value(hass, entity_id, "30.4")
|
|
|
|
state = hass.states.get(entity_id)
|
|
assert float(state.state) == 30.4
|
|
|
|
await set_value(hass, entity_id, "70")
|
|
|
|
state = hass.states.get(entity_id)
|
|
assert float(state.state) == 70
|
|
|
|
with pytest.raises(vol.Invalid) as excinfo:
|
|
await set_value(hass, entity_id, "110")
|
|
|
|
assert "Invalid value for input_number.test_1: 110.0 (range 0.0 - 100.0)" in str(
|
|
excinfo.value
|
|
)
|
|
|
|
state = hass.states.get(entity_id)
|
|
assert float(state.state) == 70
|
|
|
|
|
|
async def test_increment(hass: HomeAssistant) -> None:
|
|
"""Test increment method."""
|
|
assert await async_setup_component(
|
|
hass, DOMAIN, {DOMAIN: {"test_2": {"initial": 50, "min": 0, "max": 51}}}
|
|
)
|
|
entity_id = "input_number.test_2"
|
|
|
|
state = hass.states.get(entity_id)
|
|
assert float(state.state) == 50
|
|
|
|
await increment(hass, entity_id)
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get(entity_id)
|
|
assert float(state.state) == 51
|
|
|
|
await increment(hass, entity_id)
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get(entity_id)
|
|
assert float(state.state) == 51
|
|
|
|
|
|
async def test_rounding(hass: HomeAssistant) -> None:
|
|
"""Test increment introducing floating point error is rounded."""
|
|
assert await async_setup_component(
|
|
hass,
|
|
DOMAIN,
|
|
{DOMAIN: {"test_2": {"initial": 2.4, "min": 0, "max": 51, "step": 1.2}}},
|
|
)
|
|
entity_id = "input_number.test_2"
|
|
assert 2.4 + 1.2 != 3.6
|
|
|
|
state = hass.states.get(entity_id)
|
|
assert float(state.state) == 2.4
|
|
|
|
await increment(hass, entity_id)
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get(entity_id)
|
|
assert float(state.state) == 3.6
|
|
|
|
|
|
async def test_decrement(hass: HomeAssistant) -> None:
|
|
"""Test decrement method."""
|
|
assert await async_setup_component(
|
|
hass, DOMAIN, {DOMAIN: {"test_3": {"initial": 50, "min": 49, "max": 100}}}
|
|
)
|
|
entity_id = "input_number.test_3"
|
|
|
|
state = hass.states.get(entity_id)
|
|
assert float(state.state) == 50
|
|
|
|
await decrement(hass, entity_id)
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get(entity_id)
|
|
assert float(state.state) == 49
|
|
|
|
await decrement(hass, entity_id)
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get(entity_id)
|
|
assert float(state.state) == 49
|
|
|
|
|
|
async def test_mode(hass: HomeAssistant) -> None:
|
|
"""Test mode settings."""
|
|
assert await async_setup_component(
|
|
hass,
|
|
DOMAIN,
|
|
{
|
|
DOMAIN: {
|
|
"test_default_slider": {"min": 0, "max": 100},
|
|
"test_explicit_box": {"min": 0, "max": 100, "mode": "box"},
|
|
"test_explicit_slider": {"min": 0, "max": 100, "mode": "slider"},
|
|
}
|
|
},
|
|
)
|
|
|
|
state = hass.states.get("input_number.test_default_slider")
|
|
assert state
|
|
assert state.attributes["mode"] == "slider"
|
|
|
|
state = hass.states.get("input_number.test_explicit_box")
|
|
assert state
|
|
assert state.attributes["mode"] == "box"
|
|
|
|
state = hass.states.get("input_number.test_explicit_slider")
|
|
assert state
|
|
assert state.attributes["mode"] == "slider"
|
|
|
|
|
|
async def test_restore_state(hass: HomeAssistant) -> None:
|
|
"""Ensure states are restored on startup."""
|
|
mock_restore_cache(
|
|
hass, (State("input_number.b1", "70"), State("input_number.b2", "200"))
|
|
)
|
|
|
|
hass.set_state(CoreState.starting)
|
|
|
|
await async_setup_component(
|
|
hass,
|
|
DOMAIN,
|
|
{DOMAIN: {"b1": {"min": 0, "max": 100}, "b2": {"min": 10, "max": 100}}},
|
|
)
|
|
|
|
state = hass.states.get("input_number.b1")
|
|
assert state
|
|
assert float(state.state) == 70
|
|
|
|
state = hass.states.get("input_number.b2")
|
|
assert state
|
|
assert float(state.state) == 10
|
|
|
|
|
|
async def test_restore_invalid_state(hass: HomeAssistant) -> None:
|
|
"""Ensure an invalid restore state is handled."""
|
|
mock_restore_cache(
|
|
hass, (State("input_number.b1", "="), State("input_number.b2", "200"))
|
|
)
|
|
|
|
hass.set_state(CoreState.starting)
|
|
|
|
await async_setup_component(
|
|
hass,
|
|
DOMAIN,
|
|
{DOMAIN: {"b1": {"min": 2, "max": 100}, "b2": {"min": 10, "max": 100}}},
|
|
)
|
|
|
|
state = hass.states.get("input_number.b1")
|
|
assert state
|
|
assert float(state.state) == 2
|
|
|
|
state = hass.states.get("input_number.b2")
|
|
assert state
|
|
assert float(state.state) == 10
|
|
|
|
|
|
async def test_initial_state_overrules_restore_state(hass: HomeAssistant) -> None:
|
|
"""Ensure states are restored on startup."""
|
|
mock_restore_cache(
|
|
hass, (State("input_number.b1", "70"), State("input_number.b2", "200"))
|
|
)
|
|
|
|
hass.set_state(CoreState.starting)
|
|
|
|
await async_setup_component(
|
|
hass,
|
|
DOMAIN,
|
|
{
|
|
DOMAIN: {
|
|
"b1": {"initial": 50, "min": 0, "max": 100},
|
|
"b2": {"initial": 60, "min": 0, "max": 100},
|
|
}
|
|
},
|
|
)
|
|
|
|
state = hass.states.get("input_number.b1")
|
|
assert state
|
|
assert float(state.state) == 50
|
|
|
|
state = hass.states.get("input_number.b2")
|
|
assert state
|
|
assert float(state.state) == 60
|
|
|
|
|
|
async def test_no_initial_state_and_no_restore_state(hass: HomeAssistant) -> None:
|
|
"""Ensure that entity is create without initial and restore feature."""
|
|
hass.set_state(CoreState.starting)
|
|
|
|
await async_setup_component(hass, DOMAIN, {DOMAIN: {"b1": {"min": 0, "max": 100}}})
|
|
|
|
state = hass.states.get("input_number.b1")
|
|
assert state
|
|
assert float(state.state) == 0
|
|
|
|
|
|
async def test_input_number_context(
|
|
hass: HomeAssistant, hass_admin_user: MockUser
|
|
) -> None:
|
|
"""Test that input_number context works."""
|
|
assert await async_setup_component(
|
|
hass, "input_number", {"input_number": {"b1": {"min": 0, "max": 100}}}
|
|
)
|
|
|
|
state = hass.states.get("input_number.b1")
|
|
assert state is not None
|
|
|
|
await hass.services.async_call(
|
|
"input_number",
|
|
"increment",
|
|
{"entity_id": state.entity_id},
|
|
True,
|
|
Context(user_id=hass_admin_user.id),
|
|
)
|
|
|
|
state2 = hass.states.get("input_number.b1")
|
|
assert state2 is not None
|
|
assert state.state != state2.state
|
|
assert state2.context.user_id == hass_admin_user.id
|
|
|
|
|
|
async def test_reload(
|
|
hass: HomeAssistant,
|
|
entity_registry: er.EntityRegistry,
|
|
hass_admin_user: MockUser,
|
|
hass_read_only_user: MockUser,
|
|
) -> None:
|
|
"""Test reload service."""
|
|
count_start = len(hass.states.async_entity_ids())
|
|
|
|
assert await async_setup_component(
|
|
hass,
|
|
DOMAIN,
|
|
{
|
|
DOMAIN: {
|
|
"test_1": {"initial": 50, "min": 0, "max": 51},
|
|
"test_3": {"initial": 10, "min": 0, "max": 15},
|
|
}
|
|
},
|
|
)
|
|
|
|
assert count_start + 2 == len(hass.states.async_entity_ids())
|
|
|
|
state_1 = hass.states.get("input_number.test_1")
|
|
state_2 = hass.states.get("input_number.test_2")
|
|
state_3 = hass.states.get("input_number.test_3")
|
|
|
|
assert state_1 is not None
|
|
assert state_2 is None
|
|
assert state_3 is not None
|
|
assert float(state_1.state) == 50
|
|
assert float(state_3.state) == 10
|
|
assert entity_registry.async_get_entity_id(DOMAIN, DOMAIN, "test_1") is not None
|
|
assert entity_registry.async_get_entity_id(DOMAIN, DOMAIN, "test_2") is None
|
|
assert entity_registry.async_get_entity_id(DOMAIN, DOMAIN, "test_3") is not None
|
|
|
|
with patch(
|
|
"homeassistant.config.load_yaml_config_file",
|
|
autospec=True,
|
|
return_value={
|
|
DOMAIN: {
|
|
"test_1": {"initial": 40, "min": 0, "max": 51},
|
|
"test_2": {"initial": 20, "min": 10, "max": 30},
|
|
}
|
|
},
|
|
):
|
|
with pytest.raises(Unauthorized):
|
|
await hass.services.async_call(
|
|
DOMAIN,
|
|
SERVICE_RELOAD,
|
|
blocking=True,
|
|
context=Context(user_id=hass_read_only_user.id),
|
|
)
|
|
await hass.services.async_call(
|
|
DOMAIN,
|
|
SERVICE_RELOAD,
|
|
blocking=True,
|
|
context=Context(user_id=hass_admin_user.id),
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
assert count_start + 2 == len(hass.states.async_entity_ids())
|
|
|
|
state_1 = hass.states.get("input_number.test_1")
|
|
state_2 = hass.states.get("input_number.test_2")
|
|
state_3 = hass.states.get("input_number.test_3")
|
|
|
|
assert state_1 is not None
|
|
assert state_2 is not None
|
|
assert state_3 is None
|
|
assert float(state_1.state) == 50
|
|
assert float(state_2.state) == 20
|
|
assert entity_registry.async_get_entity_id(DOMAIN, DOMAIN, "test_1") is not None
|
|
assert entity_registry.async_get_entity_id(DOMAIN, DOMAIN, "test_2") is not None
|
|
assert entity_registry.async_get_entity_id(DOMAIN, DOMAIN, "test_3") is None
|
|
|
|
|
|
async def test_load_from_storage(hass: HomeAssistant, storage_setup) -> None:
|
|
"""Test set up from storage."""
|
|
assert await storage_setup()
|
|
state = hass.states.get(f"{DOMAIN}.from_storage")
|
|
assert float(state.state) == 0 # initial is not supported when loading from storage
|
|
assert state.attributes.get(ATTR_FRIENDLY_NAME) == "from storage"
|
|
assert state.attributes.get(ATTR_EDITABLE)
|
|
|
|
|
|
async def test_editable_state_attribute(hass: HomeAssistant, storage_setup) -> None:
|
|
"""Test editable attribute."""
|
|
assert await storage_setup(
|
|
config={
|
|
DOMAIN: {
|
|
"from_yaml": {
|
|
"min": 1,
|
|
"max": 10,
|
|
"initial": 5,
|
|
"step": 1,
|
|
"mode": "slider",
|
|
}
|
|
}
|
|
}
|
|
)
|
|
|
|
state = hass.states.get(f"{DOMAIN}.from_storage")
|
|
assert float(state.state) == 0
|
|
assert state.attributes.get(ATTR_FRIENDLY_NAME) == "from storage"
|
|
assert state.attributes.get(ATTR_EDITABLE)
|
|
|
|
state = hass.states.get(f"{DOMAIN}.from_yaml")
|
|
assert float(state.state) == 5
|
|
assert not state.attributes.get(ATTR_EDITABLE)
|
|
|
|
|
|
async def test_ws_list(
|
|
hass: HomeAssistant, hass_ws_client: WebSocketGenerator, storage_setup
|
|
) -> None:
|
|
"""Test listing via WS."""
|
|
assert await storage_setup(
|
|
config={
|
|
DOMAIN: {
|
|
"from_yaml": {
|
|
"min": 1,
|
|
"max": 10,
|
|
"initial": 5,
|
|
"step": 1,
|
|
"mode": "slider",
|
|
}
|
|
}
|
|
}
|
|
)
|
|
|
|
client = await hass_ws_client(hass)
|
|
|
|
await client.send_json({"id": 6, "type": f"{DOMAIN}/list"})
|
|
resp = await client.receive_json()
|
|
assert resp["success"]
|
|
|
|
storage_ent = "from_storage"
|
|
yaml_ent = "from_yaml"
|
|
result = {item["id"]: item for item in resp["result"]}
|
|
|
|
assert len(result) == 1
|
|
assert storage_ent in result
|
|
assert yaml_ent not in result
|
|
assert result[storage_ent][ATTR_NAME] == "from storage"
|
|
|
|
|
|
async def test_ws_delete(
|
|
hass: HomeAssistant,
|
|
entity_registry: er.EntityRegistry,
|
|
hass_ws_client: WebSocketGenerator,
|
|
storage_setup,
|
|
) -> None:
|
|
"""Test WS delete cleans up entity registry."""
|
|
assert await storage_setup()
|
|
|
|
input_id = "from_storage"
|
|
input_entity_id = f"{DOMAIN}.{input_id}"
|
|
|
|
state = hass.states.get(input_entity_id)
|
|
assert state is not None
|
|
assert entity_registry.async_get_entity_id(DOMAIN, DOMAIN, input_id) is not None
|
|
|
|
client = await hass_ws_client(hass)
|
|
|
|
await client.send_json(
|
|
{"id": 6, "type": f"{DOMAIN}/delete", f"{DOMAIN}_id": f"{input_id}"}
|
|
)
|
|
resp = await client.receive_json()
|
|
assert resp["success"]
|
|
|
|
state = hass.states.get(input_entity_id)
|
|
assert state is None
|
|
assert entity_registry.async_get_entity_id(DOMAIN, DOMAIN, input_id) is None
|
|
|
|
|
|
async def test_update_min_max(
|
|
hass: HomeAssistant,
|
|
entity_registry: er.EntityRegistry,
|
|
hass_ws_client: WebSocketGenerator,
|
|
storage_setup,
|
|
) -> None:
|
|
"""Test updating min/max updates the state."""
|
|
|
|
settings = {
|
|
"name": "from storage",
|
|
"max": 100,
|
|
"min": 0,
|
|
"step": 1,
|
|
"mode": "slider",
|
|
}
|
|
items = [{"id": "from_storage"} | settings]
|
|
assert await storage_setup(items)
|
|
|
|
input_id = "from_storage"
|
|
input_entity_id = f"{DOMAIN}.{input_id}"
|
|
|
|
state = hass.states.get(input_entity_id)
|
|
assert state is not None
|
|
assert state.state
|
|
assert entity_registry.async_get_entity_id(DOMAIN, DOMAIN, input_id) is not None
|
|
|
|
client = await hass_ws_client(hass)
|
|
|
|
updated_settings = settings | {"min": 9}
|
|
await client.send_json(
|
|
{
|
|
"id": 6,
|
|
"type": f"{DOMAIN}/update",
|
|
f"{DOMAIN}_id": f"{input_id}",
|
|
**updated_settings,
|
|
}
|
|
)
|
|
resp = await client.receive_json()
|
|
assert resp["success"]
|
|
assert resp["result"] == {"id": "from_storage"} | updated_settings
|
|
|
|
state = hass.states.get(input_entity_id)
|
|
assert float(state.state) == 9
|
|
|
|
updated_settings = settings | {"max": 5}
|
|
await client.send_json(
|
|
{
|
|
"id": 7,
|
|
"type": f"{DOMAIN}/update",
|
|
f"{DOMAIN}_id": f"{input_id}",
|
|
**updated_settings,
|
|
}
|
|
)
|
|
resp = await client.receive_json()
|
|
assert resp["success"]
|
|
assert resp["result"] == {"id": "from_storage"} | updated_settings
|
|
|
|
state = hass.states.get(input_entity_id)
|
|
assert float(state.state) == 5
|
|
|
|
|
|
async def test_ws_create(
|
|
hass: HomeAssistant,
|
|
entity_registry: er.EntityRegistry,
|
|
hass_ws_client: WebSocketGenerator,
|
|
storage_setup,
|
|
) -> None:
|
|
"""Test create WS."""
|
|
assert await storage_setup(items=[])
|
|
|
|
input_id = "new_input"
|
|
input_entity_id = f"{DOMAIN}.{input_id}"
|
|
|
|
state = hass.states.get(input_entity_id)
|
|
assert state is None
|
|
assert entity_registry.async_get_entity_id(DOMAIN, DOMAIN, input_id) is None
|
|
|
|
client = await hass_ws_client(hass)
|
|
|
|
await client.send_json(
|
|
{
|
|
"id": 6,
|
|
"type": f"{DOMAIN}/create",
|
|
"name": "New Input",
|
|
"max": 20,
|
|
"min": 0,
|
|
"initial": 10,
|
|
"step": 1,
|
|
"mode": "slider",
|
|
}
|
|
)
|
|
resp = await client.receive_json()
|
|
assert resp["success"]
|
|
|
|
state = hass.states.get(input_entity_id)
|
|
assert float(state.state) == 10
|
|
|
|
|
|
async def test_setup_no_config(hass: HomeAssistant, hass_admin_user: MockUser) -> None:
|
|
"""Test component setup with no config."""
|
|
count_start = len(hass.states.async_entity_ids())
|
|
assert await async_setup_component(hass, DOMAIN, {})
|
|
|
|
with patch(
|
|
"homeassistant.config.load_yaml_config_file", autospec=True, return_value={}
|
|
):
|
|
await hass.services.async_call(
|
|
DOMAIN,
|
|
SERVICE_RELOAD,
|
|
blocking=True,
|
|
context=Context(user_id=hass_admin_user.id),
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
assert count_start == len(hass.states.async_entity_ids())
|