evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Don't allow partial update of timer settings (#78378)

Browse source
This commit is contained in:
Erik Montnemery 2022-09-13 20:58:12 +02:00 • committed by GitHub
parent 925a4b0286
commit 4898a41dcf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

17
homeassistant/components/timer/__init__.py
View file

@ -61,18 +61,12 @@ SERVICE_FINISH = "finish"
STORAGE_KEY = DOMAIN STORAGE_KEY = DOMAIN
STORAGE_VERSION = 1 STORAGE_VERSION = 1
CREATE_FIELDS = { STORAGE_FIELDS = {
vol.Required(CONF_NAME): cv.string, vol.Required(CONF_NAME): cv.string,
vol.Optional(CONF_ICON): cv.icon, vol.Optional(CONF_ICON): cv.icon,
vol.Optional(CONF_DURATION, default=DEFAULT_DURATION): cv.time_period, vol.Optional(CONF_DURATION, default=DEFAULT_DURATION): cv.time_period,
vol.Optional(CONF_RESTORE, default=DEFAULT_RESTORE): cv.boolean, vol.Optional(CONF_RESTORE, default=DEFAULT_RESTORE): cv.boolean,
} }
UPDATE_FIELDS = {
vol.Optional(CONF_NAME): cv.string,
vol.Optional(CONF_ICON): cv.icon,
vol.Optional(CONF_DURATION): cv.time_period,
vol.Optional(CONF_RESTORE): cv.boolean,
}
def _format_timedelta(delta: timedelta): def _format_timedelta(delta: timedelta):
@ -137,7 +131,7 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
await storage_collection.async_load() await storage_collection.async_load()
collection.StorageCollectionWebsocket( collection.StorageCollectionWebsocket(
storage_collection, DOMAIN, DOMAIN, CREATE_FIELDS, UPDATE_FIELDS storage_collection, DOMAIN, DOMAIN, STORAGE_FIELDS, STORAGE_FIELDS
).async_setup(hass) ).async_setup(hass)
async def reload_service_handler(service_call: ServiceCall) -> None: async def reload_service_handler(service_call: ServiceCall) -> None:
@ -171,12 +165,11 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
class TimerStorageCollection(collection.StorageCollection): class TimerStorageCollection(collection.StorageCollection):
"""Timer storage based collection.""" """Timer storage based collection."""
CREATE_SCHEMA = vol.Schema(CREATE_FIELDS) CREATE_UPDATE_SCHEMA = vol.Schema(STORAGE_FIELDS)
UPDATE_SCHEMA = vol.Schema(UPDATE_FIELDS)
async def _process_create_data(self, data: dict) -> dict: async def _process_create_data(self, data: dict) -> dict:
"""Validate the config is valid.""" """Validate the config is valid."""
data = self.CREATE_SCHEMA(data) data = self.CREATE_UPDATE_SCHEMA(data)
# make duration JSON serializeable # make duration JSON serializeable
data[CONF_DURATION] = _format_timedelta(data[CONF_DURATION]) data[CONF_DURATION] = _format_timedelta(data[CONF_DURATION])
return data return data
@ -188,7 +181,7 @@ class TimerStorageCollection(collection.StorageCollection):
async def _update_data(self, data: dict, update_data: dict) -> dict: async def _update_data(self, data: dict, update_data: dict) -> dict:
"""Return a new updated data object.""" """Return a new updated data object."""
data = {**data, **self.UPDATE_SCHEMA(update_data)} data = {CONF_ID: data[CONF_ID]} | self.CREATE_UPDATE_SCHEMA(update_data)
# make duration JSON serializeable # make duration JSON serializeable
if CONF_DURATION in update_data: if CONF_DURATION in update_data:
data[CONF_DURATION] = _format_timedelta(data[CONF_DURATION]) data[CONF_DURATION] = _format_timedelta(data[CONF_DURATION])

14
tests/components/timer/test_init.py
View file

@ -585,17 +585,27 @@ async def test_update(hass, hass_ws_client, storage_setup):
client = await hass_ws_client(hass) client = await hass_ws_client(hass)
updated_settings = {
CONF_NAME: "timer from storage",
CONF_DURATION: 33,
CONF_RESTORE: True,
}
await client.send_json( await client.send_json(
{ {
"id": 6, "id": 6,
"type": f"{DOMAIN}/update", "type": f"{DOMAIN}/update",
f"{DOMAIN}_id": f"{timer_id}", f"{DOMAIN}_id": f"{timer_id}",
CONF_DURATION: 33, **updated_settings,
CONF_RESTORE: True,
} }
) )
resp = await client.receive_json() resp = await client.receive_json()
assert resp["success"] assert resp["success"]
assert resp["result"] == {
"id": "from_storage",
CONF_DURATION: "0:00:33",
CONF_NAME: "timer from storage",
CONF_RESTORE: True,
}
state = hass.states.get(timer_entity_id) state = hass.states.get(timer_entity_id)
assert state.attributes[ATTR_DURATION] == _format_timedelta(cv.time_period(33)) assert state.attributes[ATTR_DURATION] == _format_timedelta(cv.time_period(33))