jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-23 21:27:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Teach cover device trigger about entity registry ids (#94971)

Browse Source
This commit is contained in:
Erik Montnemery 2023-06-21 14:50:40 +02:00 committed by GitHub
parent f3defff429
commit 49c7d2ff89
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 154 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
homeassistant/components/cover/device_trigger.py
View File

@ -43,7 +43,7 @@ STATE_TRIGGER_TYPES = {"opened", "closed", "opening", "closing"}
POSITION_TRIGGER_SCHEMA = vol.All( POSITION_TRIGGER_SCHEMA = vol.All(
DEVICE_TRIGGER_BASE_SCHEMA.extend( DEVICE_TRIGGER_BASE_SCHEMA.extend(
{ {
vol.Required(CONF_ENTITY_ID): cv.entity_id, vol.Required(CONF_ENTITY_ID): cv.entity_id_or_uuid,
vol.Required(CONF_TYPE): vol.In(POSITION_TRIGGER_TYPES), vol.Required(CONF_TYPE): vol.In(POSITION_TRIGGER_TYPES),
vol.Optional(CONF_ABOVE): vol.All( vol.Optional(CONF_ABOVE): vol.All(
vol.Coerce(int), vol.Range(min=0, max=100) vol.Coerce(int), vol.Range(min=0, max=100)
@ -58,7 +58,7 @@ POSITION_TRIGGER_SCHEMA = vol.All(
STATE_TRIGGER_SCHEMA = DEVICE_TRIGGER_BASE_SCHEMA.extend( STATE_TRIGGER_SCHEMA = DEVICE_TRIGGER_BASE_SCHEMA.extend(
{ {
vol.Required(CONF_ENTITY_ID): cv.entity_id, vol.Required(CONF_ENTITY_ID): cv.entity_id_or_uuid,
vol.Required(CONF_TYPE): vol.In(STATE_TRIGGER_TYPES), vol.Required(CONF_TYPE): vol.In(STATE_TRIGGER_TYPES),
vol.Optional(CONF_FOR): cv.positive_time_period_dict, vol.Optional(CONF_FOR): cv.positive_time_period_dict,
} }
@ -87,7 +87,7 @@ async def async_get_triggers(
CONF_PLATFORM: "device", CONF_PLATFORM: "device",
CONF_DEVICE_ID: device_id, CONF_DEVICE_ID: device_id,
CONF_DOMAIN: DOMAIN, CONF_DOMAIN: DOMAIN,
CONF_ENTITY_ID: entry.entity_id, CONF_ENTITY_ID: entry.id,
} }
if supports_open_close: if supports_open_close:

194
tests/components/cover/test_device_trigger.py
View File

@ -88,7 +88,7 @@ async def test_get_triggers(
config_entry_id=config_entry.entry_id, config_entry_id=config_entry.entry_id,
connections={(dr.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")}, connections={(dr.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
) )
entity_registry.async_get_or_create( entity_entry = entity_registry.async_get_or_create(
DOMAIN, DOMAIN,
"test", "test",
"5678", "5678",
@ -97,7 +97,7 @@ async def test_get_triggers(
) )
if set_state: if set_state:
hass.states.async_set( hass.states.async_set(
f"{DOMAIN}.test_5678", entity_entry.entity_id,
"attributes", "attributes",
{"supported_features": features_state}, {"supported_features": features_state},
) )
@ -110,7 +110,7 @@ async def test_get_triggers(
"domain": DOMAIN, "domain": DOMAIN,
"type": trigger, "type": trigger,
"device_id": device_entry.id, "device_id": device_entry.id,
"entity_id": f"{DOMAIN}.test_5678", "entity_id": entity_entry.id,
"metadata": {"secondary": False}, "metadata": {"secondary": False},
} }
for trigger in expected_trigger_types for trigger in expected_trigger_types
@ -144,7 +144,7 @@ async def test_get_triggers_hidden_auxiliary(
config_entry_id=config_entry.entry_id, config_entry_id=config_entry.entry_id,
connections={(dr.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")}, connections={(dr.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
) )
entity_registry.async_get_or_create( entity_entry = entity_registry.async_get_or_create(
DOMAIN, DOMAIN,
"test", "test",
"5678", "5678",
@ -159,7 +159,7 @@ async def test_get_triggers_hidden_auxiliary(
"domain": DOMAIN, "domain": DOMAIN,
"type": trigger, "type": trigger,
"device_id": device_entry.id, "device_id": device_entry.id,
"entity_id": f"{DOMAIN}.test_5678", "entity_id": entity_entry.id,
"metadata": {"secondary": True}, "metadata": {"secondary": True},
} }
for trigger in ["opened", "closed", "opening", "closing"] for trigger in ["opened", "closed", "opening", "closing"]
@ -208,6 +208,45 @@ async def test_get_trigger_capabilities(
} }
async def test_get_trigger_capabilities_legacy(
hass: HomeAssistant,
device_registry: dr.DeviceRegistry,
entity_registry: er.EntityRegistry,
enable_custom_integrations: None,
) -> None:
"""Test we get the expected capabilities from a cover trigger."""
platform = getattr(hass.components, f"test.{DOMAIN}")
platform.init()
ent = platform.ENTITIES[0]
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {CONF_PLATFORM: "test"}})
await hass.async_block_till_done()
config_entry = MockConfigEntry(domain="test", data={})
config_entry.add_to_hass(hass)
device_entry = device_registry.async_get_or_create(
config_entry_id=config_entry.entry_id,
connections={(dr.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
)
entity_registry.async_get_or_create(
DOMAIN, "test", ent.unique_id, device_id=device_entry.id
)
triggers = await async_get_device_automations(
hass, DeviceAutomationType.TRIGGER, device_entry.id
)
assert len(triggers) == 4
for trigger in triggers:
trigger["entity_id"] = entity_registry.async_get(trigger["entity_id"]).entity_id
capabilities = await async_get_device_automation_capabilities(
hass, DeviceAutomationType.TRIGGER, trigger
)
assert capabilities == {
"extra_fields": [
{"name": "for", "optional": True, "type": "positive_time_period_dict"}
]
}
async def test_get_trigger_capabilities_set_pos( async def test_get_trigger_capabilities_set_pos(
hass: HomeAssistant, hass: HomeAssistant,
device_registry: dr.DeviceRegistry, device_registry: dr.DeviceRegistry,
@ -338,9 +377,13 @@ async def test_get_trigger_capabilities_set_tilt_pos(
} }
async def test_if_fires_on_state_change(hass: HomeAssistant, calls) -> None: async def test_if_fires_on_state_change(
hass: HomeAssistant, entity_registry: er.EntityRegistry, calls
) -> None:
"""Test for state triggers firing.""" """Test for state triggers firing."""
hass.states.async_set("cover.entity", STATE_CLOSED) entry = entity_registry.async_get_or_create(DOMAIN, "test", "5678")
hass.states.async_set(entry.entity_id, STATE_CLOSED)
assert await async_setup_component( assert await async_setup_component(
hass, hass,
@ -352,7 +395,7 @@ async def test_if_fires_on_state_change(hass: HomeAssistant, calls) -> None:
"platform": "device", "platform": "device",
"domain": DOMAIN, "domain": DOMAIN,
"device_id": "", "device_id": "",
"entity_id": "cover.entity", "entity_id": entry.id,
"type": "opened", "type": "opened",
}, },
"action": { "action": {
@ -374,7 +417,7 @@ async def test_if_fires_on_state_change(hass: HomeAssistant, calls) -> None:
"platform": "device", "platform": "device",
"domain": DOMAIN, "domain": DOMAIN,
"device_id": "", "device_id": "",
"entity_id": "cover.entity", "entity_id": entry.id,
"type": "closed", "type": "closed",
}, },
"action": { "action": {
@ -396,7 +439,7 @@ async def test_if_fires_on_state_change(hass: HomeAssistant, calls) -> None:
"platform": "device", "platform": "device",
"domain": DOMAIN, "domain": DOMAIN,
"device_id": "", "device_id": "",
"entity_id": "cover.entity", "entity_id": entry.id,
"type": "opening", "type": "opening",
}, },
"action": { "action": {
@ -418,7 +461,7 @@ async def test_if_fires_on_state_change(hass: HomeAssistant, calls) -> None:
"platform": "device", "platform": "device",
"domain": DOMAIN, "domain": DOMAIN,
"device_id": "", "device_id": "",
"entity_id": "cover.entity", "entity_id": entry.id,
"type": "closing", "type": "closing",
}, },
"action": { "action": {
@ -440,42 +483,49 @@ async def test_if_fires_on_state_change(hass: HomeAssistant, calls) -> None:
) )
# Fake that the entity is opened. # Fake that the entity is opened.
hass.states.async_set("cover.entity", STATE_OPEN) hass.states.async_set(entry.entity_id, STATE_OPEN)
await hass.async_block_till_done() await hass.async_block_till_done()
assert len(calls) == 1 assert len(calls) == 1
assert calls[0].data[ assert (
"some" calls[0].data["some"]
] == "opened - device - {} - closed - open - None".format("cover.entity") == f"opened - device - {entry.entity_id} - closed - open - None"
)
# Fake that the entity is closed. # Fake that the entity is closed.
hass.states.async_set("cover.entity", STATE_CLOSED) hass.states.async_set(entry.entity_id, STATE_CLOSED)
await hass.async_block_till_done() await hass.async_block_till_done()
assert len(calls) == 2 assert len(calls) == 2
assert calls[1].data[ assert (
"some" calls[1].data["some"]
] == "closed - device - {} - open - closed - None".format("cover.entity") == f"closed - device - {entry.entity_id} - open - closed - None"
)
# Fake that the entity is opening. # Fake that the entity is opening.
hass.states.async_set("cover.entity", STATE_OPENING) hass.states.async_set(entry.entity_id, STATE_OPENING)
await hass.async_block_till_done() await hass.async_block_till_done()
assert len(calls) == 3 assert len(calls) == 3
assert calls[2].data[ assert (
"some" calls[2].data["some"]
] == "opening - device - {} - closed - opening - None".format("cover.entity") == f"opening - device - {entry.entity_id} - closed - opening - None"
)
# Fake that the entity is closing. # Fake that the entity is closing.
hass.states.async_set("cover.entity", STATE_CLOSING) hass.states.async_set(entry.entity_id, STATE_CLOSING)
await hass.async_block_till_done() await hass.async_block_till_done()
assert len(calls) == 4 assert len(calls) == 4
assert calls[3].data[ assert (
"some" calls[3].data["some"]
] == "closing - device - {} - opening - closing - None".format("cover.entity") == f"closing - device - {entry.entity_id} - opening - closing - None"
)
async def test_if_fires_on_state_change_with_for(hass: HomeAssistant, calls) -> None: async def test_if_fires_on_state_change_legacy(
"""Test for triggers firing with delay.""" hass: HomeAssistant, entity_registry: er.EntityRegistry, calls
entity_id = "cover.entity" ) -> None:
hass.states.async_set(entity_id, STATE_CLOSED) """Test for state triggers firing."""
entry = entity_registry.async_get_or_create(DOMAIN, "test", "5678")
hass.states.async_set(entry.entity_id, STATE_CLOSED)
assert await async_setup_component( assert await async_setup_component(
hass, hass,
@ -487,7 +537,56 @@ async def test_if_fires_on_state_change_with_for(hass: HomeAssistant, calls) ->
"platform": "device", "platform": "device",
"domain": DOMAIN, "domain": DOMAIN,
"device_id": "", "device_id": "",
"entity_id": entity_id, "entity_id": entry.entity_id,
"type": "opened",
},
"action": {
"service": "test.automation",
"data_template": {
"some": (
"opened "
"- {{ trigger.platform }} "
"- {{ trigger.entity_id }} "
"- {{ trigger.from_state.state }} "
"- {{ trigger.to_state.state }} "
"- {{ trigger.for }}"
)
},
},
},
]
},
)
# Fake that the entity is opened.
hass.states.async_set(entry.entity_id, STATE_OPEN)
await hass.async_block_till_done()
assert len(calls) == 1
assert (
calls[0].data["some"]
== f"opened - device - {entry.entity_id} - closed - open - None"
)
async def test_if_fires_on_state_change_with_for(
hass: HomeAssistant, entity_registry: er.EntityRegistry, calls
) -> None:
"""Test for triggers firing with delay."""
entry = entity_registry.async_get_or_create(DOMAIN, "test", "5678")
hass.states.async_set(entry.entity_id, STATE_CLOSED)
assert await async_setup_component(
hass,
automation.DOMAIN,
{
automation.DOMAIN: [
{
"trigger": {
"platform": "device",
"domain": DOMAIN,
"device_id": "",
"entity_id": entry.id,
"type": "opened", "type": "opened",
"for": {"seconds": 5}, "for": {"seconds": 5},
}, },
@ -511,10 +610,9 @@ async def test_if_fires_on_state_change_with_for(hass: HomeAssistant, calls) ->
}, },
) )
await hass.async_block_till_done() await hass.async_block_till_done()
assert hass.states.get(entity_id).state == STATE_CLOSED
assert len(calls) == 0 assert len(calls) == 0
hass.states.async_set(entity_id, STATE_OPEN) hass.states.async_set(entry.entity_id, STATE_OPEN)
await hass.async_block_till_done() await hass.async_block_till_done()
assert len(calls) == 0 assert len(calls) == 0
async_fire_time_changed(hass, dt_util.utcnow() + timedelta(seconds=10)) async_fire_time_changed(hass, dt_util.utcnow() + timedelta(seconds=10))
@ -523,12 +621,15 @@ async def test_if_fires_on_state_change_with_for(hass: HomeAssistant, calls) ->
await hass.async_block_till_done() await hass.async_block_till_done()
assert ( assert (
calls[0].data["some"] calls[0].data["some"]
== f"turn_off device - {entity_id} - closed - open - 0:00:05" == f"turn_off device - {entry.entity_id} - closed - open - 0:00:05"
) )
async def test_if_fires_on_position( async def test_if_fires_on_position(
hass: HomeAssistant, calls, enable_custom_integrations: None hass: HomeAssistant,
entity_registry: er.EntityRegistry,
calls,
enable_custom_integrations: None,
) -> None: ) -> None:
"""Test for position triggers.""" """Test for position triggers."""
platform = getattr(hass.components, f"test.{DOMAIN}") platform = getattr(hass.components, f"test.{DOMAIN}")
@ -537,6 +638,8 @@ async def test_if_fires_on_position(
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {CONF_PLATFORM: "test"}}) assert await async_setup_component(hass, DOMAIN, {DOMAIN: {CONF_PLATFORM: "test"}})
await hass.async_block_till_done() await hass.async_block_till_done()
entry = entity_registry.async_get(ent.entity_id)
assert await async_setup_component( assert await async_setup_component(
hass, hass,
automation.DOMAIN, automation.DOMAIN,
@ -548,7 +651,7 @@ async def test_if_fires_on_position(
"platform": "device", "platform": "device",
"domain": DOMAIN, "domain": DOMAIN,
"device_id": "", "device_id": "",
"entity_id": ent.entity_id, "entity_id": entry.id,
"type": "position", "type": "position",
"above": 45, "above": 45,
} }
@ -573,7 +676,7 @@ async def test_if_fires_on_position(
"platform": "device", "platform": "device",
"domain": DOMAIN, "domain": DOMAIN,
"device_id": "", "device_id": "",
"entity_id": ent.entity_id, "entity_id": entry.id,
"type": "position", "type": "position",
"below": 90, "below": 90,
} }
@ -598,7 +701,7 @@ async def test_if_fires_on_position(
"platform": "device", "platform": "device",
"domain": DOMAIN, "domain": DOMAIN,
"device_id": "", "device_id": "",
"entity_id": ent.entity_id, "entity_id": entry.id,
"type": "position", "type": "position",
"above": 45, "above": 45,
"below": 90, "below": 90,
@ -669,7 +772,10 @@ async def test_if_fires_on_position(
async def test_if_fires_on_tilt_position( async def test_if_fires_on_tilt_position(
hass: HomeAssistant, calls, enable_custom_integrations: None hass: HomeAssistant,
entity_registry: er.EntityRegistry,
calls,
enable_custom_integrations: None,
) -> None: ) -> None:
"""Test for tilt position triggers.""" """Test for tilt position triggers."""
platform = getattr(hass.components, f"test.{DOMAIN}") platform = getattr(hass.components, f"test.{DOMAIN}")
@ -678,6 +784,8 @@ async def test_if_fires_on_tilt_position(
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {CONF_PLATFORM: "test"}}) assert await async_setup_component(hass, DOMAIN, {DOMAIN: {CONF_PLATFORM: "test"}})
await hass.async_block_till_done() await hass.async_block_till_done()
entry = entity_registry.async_get(ent.entity_id)
assert await async_setup_component( assert await async_setup_component(
hass, hass,
automation.DOMAIN, automation.DOMAIN,
@ -689,7 +797,7 @@ async def test_if_fires_on_tilt_position(
"platform": "device", "platform": "device",
"domain": DOMAIN, "domain": DOMAIN,
"device_id": "", "device_id": "",
"entity_id": ent.entity_id, "entity_id": entry.id,
"type": "tilt_position", "type": "tilt_position",
"above": 45, "above": 45,
} }
@ -714,7 +822,7 @@ async def test_if_fires_on_tilt_position(
"platform": "device", "platform": "device",
"domain": DOMAIN, "domain": DOMAIN,
"device_id": "", "device_id": "",
"entity_id": ent.entity_id, "entity_id": entry.id,
"type": "tilt_position", "type": "tilt_position",
"below": 90, "below": 90,
} }
@ -739,7 +847,7 @@ async def test_if_fires_on_tilt_position(
"platform": "device", "platform": "device",
"domain": DOMAIN, "domain": DOMAIN,
"device_id": "", "device_id": "",
"entity_id": ent.entity_id, "entity_id": entry.id,
"type": "tilt_position", "type": "tilt_position",
"above": 45, "above": 45,
"below": 90, "below": 90,