Add device action support to the alarm_control_panel integration (#27616)
* Add device action support to the alarm_control_panel integration * Improve tests
This commit is contained in:
1 parent
6ffc520b1c
commit
43c85c0549
6 files changed
+623
No files matched your search
@@ -0,0 +1,274 @@
|
||||
"""The tests for Alarm control panel device actions."""
|
||||
import pytest
|
||||
|
||||
from homeassistant.components.alarm_control_panel import DOMAIN
|
||||
from homeassistant.const import (
|
||||
CONF_PLATFORM,
|
||||
STATE_ALARM_ARMED_AWAY,
|
||||
STATE_ALARM_ARMED_HOME,
|
||||
STATE_ALARM_ARMED_NIGHT,
|
||||
STATE_ALARM_DISARMED,
|
||||
STATE_ALARM_TRIGGERED,
|
||||
STATE_UNKNOWN,
|
||||
)
|
||||
from homeassistant.setup import async_setup_component
|
||||
import homeassistant.components.automation as automation
|
||||
from homeassistant.helpers import device_registry
|
||||
|
||||
from tests.common import (
|
||||
MockConfigEntry,
|
||||
assert_lists_same,
|
||||
mock_device_registry,
|
||||
mock_registry,
|
||||
async_get_device_automations,
|
||||
async_get_device_automation_capabilities,
|
||||
)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def device_reg(hass):
|
||||
"""Return an empty, loaded, registry."""
|
||||
return mock_device_registry(hass)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def entity_reg(hass):
|
||||
"""Return an empty, loaded, registry."""
|
||||
return mock_registry(hass)
|
||||
|
||||
|
||||
async def test_get_actions(hass, device_reg, entity_reg):
|
||||
"""Test we get the expected actions from a alarm_control_panel."""
|
||||
config_entry = MockConfigEntry(domain="test", data={})
|
||||
config_entry.add_to_hass(hass)
|
||||
device_entry = device_reg.async_get_or_create(
|
||||
config_entry_id=config_entry.entry_id,
|
||||
connections={(device_registry.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
|
||||
)
|
||||
entity_reg.async_get_or_create(DOMAIN, "test", "5678", device_id=device_entry.id)
|
||||
expected_actions = [
|
||||
{
|
||||
"domain": DOMAIN,
|
||||
"type": "arm_away",
|
||||
"device_id": device_entry.id,
|
||||
"entity_id": "alarm_control_panel.test_5678",
|
||||
},
|
||||
{
|
||||
"domain": DOMAIN,
|
||||
"type": "arm_home",
|
||||
"device_id": device_entry.id,
|
||||
"entity_id": "alarm_control_panel.test_5678",
|
||||
},
|
||||
{
|
||||
"domain": DOMAIN,
|
||||
"type": "arm_night",
|
||||
"device_id": device_entry.id,
|
||||
"entity_id": "alarm_control_panel.test_5678",
|
||||
},
|
||||
{
|
||||
"domain": DOMAIN,
|
||||
"type": "disarm",
|
||||
"device_id": device_entry.id,
|
||||
"entity_id": "alarm_control_panel.test_5678",
|
||||
},
|
||||
{
|
||||
"domain": DOMAIN,
|
||||
"type": "trigger",
|
||||
"device_id": device_entry.id,
|
||||
"entity_id": "alarm_control_panel.test_5678",
|
||||
},
|
||||
]
|
||||
actions = await async_get_device_automations(hass, "action", device_entry.id)
|
||||
assert_lists_same(actions, expected_actions)
|
||||
|
||||
|
||||
async def test_get_action_capabilities(hass, device_reg, entity_reg):
|
||||
"""Test we get the expected capabilities from a sensor trigger."""
|
||||
platform = getattr(hass.components, f"test.{DOMAIN}")
|
||||
platform.init()
|
||||
|
||||
config_entry = MockConfigEntry(domain="test", data={})
|
||||
config_entry.add_to_hass(hass)
|
||||
device_entry = device_reg.async_get_or_create(
|
||||
config_entry_id=config_entry.entry_id,
|
||||
connections={(device_registry.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
|
||||
)
|
||||
entity_reg.async_get_or_create(
|
||||
DOMAIN,
|
||||
"test",
|
||||
platform.ENTITIES["no_arm_code"].unique_id,
|
||||
device_id=device_entry.id,
|
||||
)
|
||||
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {CONF_PLATFORM: "test"}})
|
||||
|
||||
expected_capabilities = {
|
||||
"arm_away": {"extra_fields": []},
|
||||
"arm_home": {"extra_fields": []},
|
||||
"arm_night": {"extra_fields": []},
|
||||
"disarm": {
|
||||
"extra_fields": [{"name": "code", "optional": True, "type": "string"}]
|
||||
},
|
||||
"trigger": {"extra_fields": []},
|
||||
}
|
||||
actions = await async_get_device_automations(hass, "action", device_entry.id)
|
||||
assert len(actions) == 5
|
||||
for action in actions:
|
||||
capabilities = await async_get_device_automation_capabilities(
|
||||
hass, "action", action
|
||||
)
|
||||
assert capabilities == expected_capabilities[action["type"]]
|
||||
|
||||
|
||||
async def test_get_action_capabilities_arm_code(hass, device_reg, entity_reg):
|
||||
"""Test we get the expected capabilities from a sensor trigger."""
|
||||
platform = getattr(hass.components, f"test.{DOMAIN}")
|
||||
platform.init()
|
||||
|
||||
config_entry = MockConfigEntry(domain="test", data={})
|
||||
config_entry.add_to_hass(hass)
|
||||
device_entry = device_reg.async_get_or_create(
|
||||
config_entry_id=config_entry.entry_id,
|
||||
connections={(device_registry.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
|
||||
)
|
||||
entity_reg.async_get_or_create(
|
||||
DOMAIN,
|
||||
"test",
|
||||
platform.ENTITIES["arm_code"].unique_id,
|
||||
device_id=device_entry.id,
|
||||
)
|
||||
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {CONF_PLATFORM: "test"}})
|
||||
|
||||
expected_capabilities = {
|
||||
"arm_away": {
|
||||
"extra_fields": [{"name": "code", "optional": True, "type": "string"}]
|
||||
},
|
||||
"arm_home": {
|
||||
"extra_fields": [{"name": "code", "optional": True, "type": "string"}]
|
||||
},
|
||||
"arm_night": {
|
||||
"extra_fields": [{"name": "code", "optional": True, "type": "string"}]
|
||||
},
|
||||
"disarm": {
|
||||
"extra_fields": [{"name": "code", "optional": True, "type": "string"}]
|
||||
},
|
||||
"trigger": {"extra_fields": []},
|
||||
}
|
||||
actions = await async_get_device_automations(hass, "action", device_entry.id)
|
||||
assert len(actions) == 5
|
||||
for action in actions:
|
||||
capabilities = await async_get_device_automation_capabilities(
|
||||
hass, "action", action
|
||||
)
|
||||
assert capabilities == expected_capabilities[action["type"]]
|
||||
|
||||
|
||||
async def test_action(hass):
|
||||
"""Test for turn_on and turn_off actions."""
|
||||
platform = getattr(hass.components, f"test.{DOMAIN}")
|
||||
platform.init()
|
||||
|
||||
assert await async_setup_component(
|
||||
hass,
|
||||
automation.DOMAIN,
|
||||
{
|
||||
automation.DOMAIN: [
|
||||
{
|
||||
"trigger": {
|
||||
"platform": "event",
|
||||
"event_type": "test_event_arm_away",
|
||||
},
|
||||
"action": {
|
||||
"domain": DOMAIN,
|
||||
"device_id": "abcdefgh",
|
||||
"entity_id": "alarm_control_panel.alarm_no_arm_code",
|
||||
"type": "arm_away",
|
||||
},
|
||||
},
|
||||
{
|
||||
"trigger": {
|
||||
"platform": "event",
|
||||
"event_type": "test_event_arm_home",
|
||||
},
|
||||
"action": {
|
||||
"domain": DOMAIN,
|
||||
"device_id": "abcdefgh",
|
||||
"entity_id": "alarm_control_panel.alarm_no_arm_code",
|
||||
"type": "arm_home",
|
||||
},
|
||||
},
|
||||
{
|
||||
"trigger": {
|
||||
"platform": "event",
|
||||
"event_type": "test_event_arm_night",
|
||||
},
|
||||
"action": {
|
||||
"domain": DOMAIN,
|
||||
"device_id": "abcdefgh",
|
||||
"entity_id": "alarm_control_panel.alarm_no_arm_code",
|
||||
"type": "arm_night",
|
||||
},
|
||||
},
|
||||
{
|
||||
"trigger": {"platform": "event", "event_type": "test_event_disarm"},
|
||||
"action": {
|
||||
"domain": DOMAIN,
|
||||
"device_id": "abcdefgh",
|
||||
"entity_id": "alarm_control_panel.alarm_no_arm_code",
|
||||
"type": "disarm",
|
||||
"code": "1234",
|
||||
},
|
||||
},
|
||||
{
|
||||
"trigger": {
|
||||
"platform": "event",
|
||||
"event_type": "test_event_trigger",
|
||||
},
|
||||
"action": {
|
||||
"domain": DOMAIN,
|
||||
"device_id": "abcdefgh",
|
||||
"entity_id": "alarm_control_panel.alarm_no_arm_code",
|
||||
"type": "trigger",
|
||||
},
|
||||
},
|
||||
]
|
||||
},
|
||||
)
|
||||
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {CONF_PLATFORM: "test"}})
|
||||
assert (
|
||||
hass.states.get("alarm_control_panel.alarm_no_arm_code").state == STATE_UNKNOWN
|
||||
)
|
||||
|
||||
hass.bus.async_fire("test_event_arm_away")
|
||||
await hass.async_block_till_done()
|
||||
assert (
|
||||
hass.states.get("alarm_control_panel.alarm_no_arm_code").state
|
||||
== STATE_ALARM_ARMED_AWAY
|
||||
)
|
||||
|
||||
hass.bus.async_fire("test_event_arm_home")
|
||||
await hass.async_block_till_done()
|
||||
assert (
|
||||
hass.states.get("alarm_control_panel.alarm_no_arm_code").state
|
||||
== STATE_ALARM_ARMED_HOME
|
||||
)
|
||||
|
||||
hass.bus.async_fire("test_event_arm_night")
|
||||
await hass.async_block_till_done()
|
||||
assert (
|
||||
hass.states.get("alarm_control_panel.alarm_no_arm_code").state
|
||||
== STATE_ALARM_ARMED_NIGHT
|
||||
)
|
||||
|
||||
hass.bus.async_fire("test_event_disarm")
|
||||
await hass.async_block_till_done()
|
||||
assert (
|
||||
hass.states.get("alarm_control_panel.alarm_no_arm_code").state
|
||||
== STATE_ALARM_DISARMED
|
||||
)
|
||||
|
||||
hass.bus.async_fire("test_event_trigger")
|
||||
await hass.async_block_till_done()
|
||||
assert (
|
||||
hass.states.get("alarm_control_panel.alarm_no_arm_code").state
|
||||
== STATE_ALARM_TRIGGERED
|
||||
)
|
||||
@@ -170,6 +170,106 @@ async def test_websocket_get_triggers(hass, hass_ws_client, device_reg, entity_r
|
||||
assert _same_lists(triggers, expected_triggers)
|
||||
|
||||
|
||||
async def test_websocket_get_action_capabilities(
|
||||
hass, hass_ws_client, device_reg, entity_reg
|
||||
):
|
||||
"""Test we get the expected action capabilities for an alarm through websocket."""
|
||||
await async_setup_component(hass, "device_automation", {})
|
||||
config_entry = MockConfigEntry(domain="test", data={})
|
||||
config_entry.add_to_hass(hass)
|
||||
device_entry = device_reg.async_get_or_create(
|
||||
config_entry_id=config_entry.entry_id,
|
||||
connections={(device_registry.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
|
||||
)
|
||||
entity_reg.async_get_or_create(
|
||||
"alarm_control_panel", "test", "5678", device_id=device_entry.id
|
||||
)
|
||||
expected_capabilities = {
|
||||
"arm_away": {"extra_fields": []},
|
||||
"arm_home": {"extra_fields": []},
|
||||
"arm_night": {"extra_fields": []},
|
||||
"disarm": {
|
||||
"extra_fields": [{"name": "code", "optional": True, "type": "string"}]
|
||||
},
|
||||
"trigger": {"extra_fields": []},
|
||||
}
|
||||
|
||||
client = await hass_ws_client(hass)
|
||||
await client.send_json(
|
||||
{"id": 1, "type": "device_automation/action/list", "device_id": device_entry.id}
|
||||
)
|
||||
msg = await client.receive_json()
|
||||
|
||||
assert msg["id"] == 1
|
||||
assert msg["type"] == TYPE_RESULT
|
||||
assert msg["success"]
|
||||
actions = msg["result"]
|
||||
|
||||
id = 2
|
||||
assert len(actions) == 5
|
||||
for action in actions:
|
||||
await client.send_json(
|
||||
{
|
||||
"id": id,
|
||||
"type": "device_automation/action/capabilities",
|
||||
"action": action,
|
||||
}
|
||||
)
|
||||
msg = await client.receive_json()
|
||||
assert msg["id"] == id
|
||||
assert msg["type"] == TYPE_RESULT
|
||||
assert msg["success"]
|
||||
capabilities = msg["result"]
|
||||
assert capabilities == expected_capabilities[action["type"]]
|
||||
id = id + 1
|
||||
|
||||
|
||||
async def test_websocket_get_bad_action_capabilities(
|
||||
hass, hass_ws_client, device_reg, entity_reg
|
||||
):
|
||||
"""Test we get no action capabilities for a non existing domain."""
|
||||
await async_setup_component(hass, "device_automation", {})
|
||||
expected_capabilities = {}
|
||||
|
||||
client = await hass_ws_client(hass)
|
||||
await client.send_json(
|
||||
{
|
||||
"id": 1,
|
||||
"type": "device_automation/action/capabilities",
|
||||
"action": {"domain": "beer"},
|
||||
}
|
||||
)
|
||||
msg = await client.receive_json()
|
||||
assert msg["id"] == 1
|
||||
assert msg["type"] == TYPE_RESULT
|
||||
assert msg["success"]
|
||||
capabilities = msg["result"]
|
||||
assert capabilities == expected_capabilities
|
||||
|
||||
|
||||
async def test_websocket_get_no_action_capabilities(
|
||||
hass, hass_ws_client, device_reg, entity_reg
|
||||
):
|
||||
"""Test we get no action capabilities for a domain with no device action capabilities."""
|
||||
await async_setup_component(hass, "device_automation", {})
|
||||
expected_capabilities = {}
|
||||
|
||||
client = await hass_ws_client(hass)
|
||||
await client.send_json(
|
||||
{
|
||||
"id": 1,
|
||||
"type": "device_automation/action/capabilities",
|
||||
"action": {"domain": "deconz"},
|
||||
}
|
||||
)
|
||||
msg = await client.receive_json()
|
||||
assert msg["id"] == 1
|
||||
assert msg["type"] == TYPE_RESULT
|
||||
assert msg["success"]
|
||||
capabilities = msg["result"]
|
||||
assert capabilities == expected_capabilities
|
||||
|
||||
|
||||
async def test_websocket_get_condition_capabilities(
|
||||
hass, hass_ws_client, device_reg, entity_reg
|
||||
):
|
||||
@@ -204,6 +304,7 @@ async def test_websocket_get_condition_capabilities(
|
||||
conditions = msg["result"]
|
||||
|
||||
id = 2
|
||||
assert len(conditions) == 2
|
||||
for condition in conditions:
|
||||
await client.send_json(
|
||||
{
|
||||
@@ -301,6 +402,7 @@ async def test_websocket_get_trigger_capabilities(
|
||||
triggers = msg["result"]
|
||||
|
||||
id = 2
|
||||
assert len(triggers) == 2
|
||||
for trigger in triggers:
|
||||
await client.send_json(
|
||||
{
|
||||
|
||||
Reference in new issue
Block a user