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

Validate tone is valid when processing siren.turn_on service call (#52953)

Browse source 
* Validate tone is valid when processing siren.turn_on service call

* Better message
This commit is contained in:
Raman Gupta 2021-07-13 04:42:35 -04:00 • committed by GitHub
parent ac39607ae9
commit 30def802fc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
homeassistant/components/siren/__init__.py
View file

@ -51,14 +51,24 @@ class SirenTurnOnServiceParameters(TypedDict, total=False):
volume_level: float volume_level: float
def filter_turn_on_params( def process_turn_on_params(
siren: SirenEntity, params: SirenTurnOnServiceParameters siren: SirenEntity, params: SirenTurnOnServiceParameters
) -> SirenTurnOnServiceParameters: ) -> SirenTurnOnServiceParameters:
"""Filter out params not supported by the siren.""" """
Process turn_on service params.
Filters out unsupported params and validates the rest.
"""
supported_features = siren.supported_features or 0 supported_features = siren.supported_features or 0
if not supported_features & SUPPORT_TONES: if not supported_features & SUPPORT_TONES:
params.pop(ATTR_TONE, None) params.pop(ATTR_TONE, None)
elif ATTR_TONE in params and (
not siren.available_tones
or (tone := params[ATTR_TONE]) not in siren.available_tones
):
raise ValueError(f"Tone {tone} is not a valid tone for this device")
if not supported_features & SUPPORT_DURATION: if not supported_features & SUPPORT_DURATION:
params.pop(ATTR_DURATION, None) params.pop(ATTR_DURATION, None)
if not supported_features & SUPPORT_VOLUME_SET: if not supported_features & SUPPORT_VOLUME_SET:
@ -84,7 +94,7 @@ async def async_setup(hass: HomeAssistantType, config: ConfigType) -> bool:
if k in (ATTR_TONE, ATTR_DURATION, ATTR_VOLUME_LEVEL) if k in (ATTR_TONE, ATTR_DURATION, ATTR_VOLUME_LEVEL)
} }
await siren.async_turn_on( await siren.async_turn_on(
**filter_turn_on_params(siren, cast(SirenTurnOnServiceParameters, data)) **process_turn_on_params(siren, cast(SirenTurnOnServiceParameters, data))
) )
component.async_register_entity_service( component.async_register_entity_service(

10
tests/components/demo/test_siren.py
View file

@ -5,6 +5,7 @@ import pytest
from homeassistant.components.siren.const import ( from homeassistant.components.siren.const import (
ATTR_AVAILABLE_TONES, ATTR_AVAILABLE_TONES,
ATTR_TONE,
ATTR_VOLUME_LEVEL, ATTR_VOLUME_LEVEL,
DOMAIN, DOMAIN,
) )
@ -56,6 +57,15 @@ async def test_turn_on(hass):
state = hass.states.get(ENTITY_SIREN) state = hass.states.get(ENTITY_SIREN)
assert state.state == STATE_ON assert state.state == STATE_ON
# Test that an invalid tone will raise a ValueError
with pytest.raises(ValueError):
await hass.services.async_call(
DOMAIN,
SERVICE_TURN_ON,
{ATTR_ENTITY_ID: ENTITY_SIREN_WITH_ALL_FEATURES, ATTR_TONE: "invalid_tone"},
blocking=True,
)
async def test_turn_off(hass): async def test_turn_off(hass):
"""Test turn off device.""" """Test turn off device."""