Use collection helpers for input_datetime component (#30815)
* Refactor input_datetime. Keep the state as datetime, but format accordingly to has_time and has_date. * Use config dict for input_datetime. * Add tests. * Lint Co-authored-by: Paulus Schoutsen <paulus@home-assistant.io>
This commit is contained in:
parent
d1da653e62
commit
d9d5e06baf
2 changed files with 377 additions and 65 deletions
|
@ -9,18 +9,64 @@ import voluptuous as vol
|
|||
from homeassistant.components.input_datetime import (
|
||||
ATTR_DATE,
|
||||
ATTR_DATETIME,
|
||||
ATTR_EDITABLE,
|
||||
ATTR_TIME,
|
||||
CONF_HAS_DATE,
|
||||
CONF_HAS_TIME,
|
||||
CONF_ID,
|
||||
CONF_INITIAL,
|
||||
CONF_NAME,
|
||||
DEFAULT_TIME,
|
||||
DOMAIN,
|
||||
SERVICE_RELOAD,
|
||||
SERVICE_SET_DATETIME,
|
||||
)
|
||||
from homeassistant.const import ATTR_ENTITY_ID
|
||||
from homeassistant.const import ATTR_ENTITY_ID, ATTR_FRIENDLY_NAME, ATTR_NAME
|
||||
from homeassistant.core import Context, CoreState, State
|
||||
from homeassistant.exceptions import Unauthorized
|
||||
from homeassistant.helpers import entity_registry
|
||||
from homeassistant.setup import async_setup_component
|
||||
|
||||
from tests.common import mock_restore_cache
|
||||
|
||||
INITIAL_DATE = "2020-01-10"
|
||||
INITIAL_TIME = "23:45:56"
|
||||
INITIAL_DATETIME = f"{INITIAL_DATE} {INITIAL_TIME}"
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def storage_setup(hass, hass_storage):
|
||||
"""Storage setup."""
|
||||
|
||||
async def _storage(items=None, config=None):
|
||||
if items is None:
|
||||
hass_storage[DOMAIN] = {
|
||||
"key": DOMAIN,
|
||||
"version": 1,
|
||||
"data": {
|
||||
"items": [
|
||||
{
|
||||
CONF_ID: "from_storage",
|
||||
CONF_NAME: "datetime from storage",
|
||||
CONF_INITIAL: INITIAL_DATETIME,
|
||||
CONF_HAS_DATE: True,
|
||||
CONF_HAS_TIME: True,
|
||||
}
|
||||
]
|
||||
},
|
||||
}
|
||||
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 async_set_date_and_time(hass, entity_id, dt_value):
|
||||
"""Set date and / or time of input_datetime."""
|
||||
|
@ -318,11 +364,7 @@ async def test_reload(hass, hass_admin_user, hass_read_only_user):
|
|||
assert await async_setup_component(
|
||||
hass,
|
||||
DOMAIN,
|
||||
{
|
||||
DOMAIN: {
|
||||
"dt1": {"has_time": False, "has_date": True, "initial": "2019-1-1"},
|
||||
}
|
||||
},
|
||||
{DOMAIN: {"dt1": {"has_time": False, "has_date": True, "initial": "2019-1-1"}}},
|
||||
)
|
||||
|
||||
assert count_start + 1 == len(hass.states.async_entity_ids())
|
||||
|
@ -365,8 +407,169 @@ async def test_reload(hass, hass_admin_user, hass_read_only_user):
|
|||
state_1 = hass.states.get("input_datetime.dt1")
|
||||
state_2 = hass.states.get("input_datetime.dt2")
|
||||
|
||||
dt_obj = datetime.datetime(2019, 1, 1, 23, 32)
|
||||
assert state_1 is not None
|
||||
assert state_2 is not None
|
||||
assert str(dt_obj.time()) == state_1.state
|
||||
assert str(DEFAULT_TIME) == state_1.state
|
||||
assert str(datetime.datetime(1970, 1, 1, 0, 0)) == state_2.state
|
||||
|
||||
|
||||
async def test_load_from_storage(hass, storage_setup):
|
||||
"""Test set up from storage."""
|
||||
assert await storage_setup()
|
||||
state = hass.states.get(f"{DOMAIN}.datetime_from_storage")
|
||||
assert state.state == INITIAL_DATETIME
|
||||
assert state.attributes.get(ATTR_EDITABLE)
|
||||
|
||||
|
||||
async def test_editable_state_attribute(hass, storage_setup):
|
||||
"""Test editable attribute."""
|
||||
assert await storage_setup(
|
||||
config={
|
||||
DOMAIN: {
|
||||
"from_yaml": {
|
||||
CONF_HAS_DATE: True,
|
||||
CONF_HAS_TIME: True,
|
||||
CONF_NAME: "yaml datetime",
|
||||
CONF_INITIAL: "2001-01-02 12:34:56",
|
||||
}
|
||||
}
|
||||
}
|
||||
)
|
||||
|
||||
state = hass.states.get(f"{DOMAIN}.datetime_from_storage")
|
||||
assert state.state == INITIAL_DATETIME
|
||||
assert state.attributes.get(ATTR_EDITABLE)
|
||||
|
||||
state = hass.states.get(f"{DOMAIN}.from_yaml")
|
||||
assert state.state == "2001-01-02 12:34:56"
|
||||
assert not state.attributes[ATTR_EDITABLE]
|
||||
|
||||
|
||||
async def test_ws_list(hass, hass_ws_client, storage_setup):
|
||||
"""Test listing via WS."""
|
||||
assert await storage_setup(config={DOMAIN: {"from_yaml": {CONF_HAS_DATE: True}}})
|
||||
|
||||
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] == "datetime from storage"
|
||||
|
||||
|
||||
async def test_ws_delete(hass, hass_ws_client, storage_setup):
|
||||
"""Test WS delete cleans up entity registry."""
|
||||
assert await storage_setup()
|
||||
|
||||
input_id = "from_storage"
|
||||
input_entity_id = f"{DOMAIN}.datetime_from_storage"
|
||||
ent_reg = await entity_registry.async_get_registry(hass)
|
||||
|
||||
state = hass.states.get(input_entity_id)
|
||||
assert state is not None
|
||||
assert ent_reg.async_get_entity_id(DOMAIN, DOMAIN, input_id) == input_entity_id
|
||||
|
||||
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 ent_reg.async_get_entity_id(DOMAIN, DOMAIN, input_id) is None
|
||||
|
||||
|
||||
async def test_update(hass, hass_ws_client, storage_setup):
|
||||
"""Test updating min/max updates the state."""
|
||||
|
||||
assert await storage_setup()
|
||||
|
||||
input_id = "from_storage"
|
||||
input_entity_id = f"{DOMAIN}.datetime_from_storage"
|
||||
ent_reg = await entity_registry.async_get_registry(hass)
|
||||
|
||||
state = hass.states.get(input_entity_id)
|
||||
assert state.attributes[ATTR_FRIENDLY_NAME] == "datetime from storage"
|
||||
assert state.state == INITIAL_DATETIME
|
||||
assert ent_reg.async_get_entity_id(DOMAIN, DOMAIN, input_id) == input_entity_id
|
||||
|
||||
client = await hass_ws_client(hass)
|
||||
|
||||
await client.send_json(
|
||||
{
|
||||
"id": 6,
|
||||
"type": f"{DOMAIN}/update",
|
||||
f"{DOMAIN}_id": f"{input_id}",
|
||||
ATTR_NAME: "even newer name",
|
||||
CONF_HAS_DATE: False,
|
||||
}
|
||||
)
|
||||
resp = await client.receive_json()
|
||||
assert resp["success"]
|
||||
|
||||
state = hass.states.get(input_entity_id)
|
||||
assert state.state == INITIAL_TIME
|
||||
assert state.attributes[ATTR_FRIENDLY_NAME] == "even newer name"
|
||||
|
||||
|
||||
async def test_ws_create(hass, hass_ws_client, storage_setup):
|
||||
"""Test create WS."""
|
||||
assert await storage_setup(items=[])
|
||||
|
||||
input_id = "new_datetime"
|
||||
input_entity_id = f"{DOMAIN}.{input_id}"
|
||||
ent_reg = await entity_registry.async_get_registry(hass)
|
||||
|
||||
state = hass.states.get(input_entity_id)
|
||||
assert state is None
|
||||
assert ent_reg.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",
|
||||
CONF_NAME: "New DateTime",
|
||||
CONF_INITIAL: "1991-01-02 01:02:03",
|
||||
CONF_HAS_DATE: True,
|
||||
CONF_HAS_TIME: True,
|
||||
}
|
||||
)
|
||||
resp = await client.receive_json()
|
||||
assert resp["success"]
|
||||
|
||||
state = hass.states.get(input_entity_id)
|
||||
assert state.state == "1991-01-02 01:02:03"
|
||||
assert state.attributes[ATTR_FRIENDLY_NAME] == "New DateTime"
|
||||
assert state.attributes[ATTR_EDITABLE]
|
||||
|
||||
|
||||
async def test_setup_no_config(hass, hass_admin_user):
|
||||
"""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())
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue