Add zwave_js.event automation trigger (#62828)
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This commit is contained in:
Raman Gupta
GitHub
parent
ddedaf6f70
commit
6e5ae3e2e4
5 changed files with 672 additions and 2 deletions
|
|
@ -264,6 +264,440 @@ async def test_zwave_js_value_updated(hass, client, lock_schlage_be469, integrat
|
|||
await hass.services.async_call(automation.DOMAIN, SERVICE_RELOAD, blocking=True)
|
||||
|
||||
|
||||
async def test_zwave_js_event(hass, client, lock_schlage_be469, integration):
|
||||
"""Test for zwave_js.event automation trigger."""
|
||||
trigger_type = f"{DOMAIN}.event"
|
||||
node: Node = lock_schlage_be469
|
||||
dev_reg = async_get_dev_reg(hass)
|
||||
device = async_entries_for_config_entry(dev_reg, integration.entry_id)[0]
|
||||
|
||||
node_no_event_data_filter = async_capture_events(hass, "node_no_event_data_filter")
|
||||
node_event_data_filter = async_capture_events(hass, "node_event_data_filter")
|
||||
controller_no_event_data_filter = async_capture_events(
|
||||
hass, "controller_no_event_data_filter"
|
||||
)
|
||||
controller_event_data_filter = async_capture_events(
|
||||
hass, "controller_event_data_filter"
|
||||
)
|
||||
driver_no_event_data_filter = async_capture_events(
|
||||
hass, "driver_no_event_data_filter"
|
||||
)
|
||||
driver_event_data_filter = async_capture_events(hass, "driver_event_data_filter")
|
||||
node_event_data_no_partial_dict_match_filter = async_capture_events(
|
||||
hass, "node_event_data_no_partial_dict_match_filter"
|
||||
)
|
||||
node_event_data_partial_dict_match_filter = async_capture_events(
|
||||
hass, "node_event_data_partial_dict_match_filter"
|
||||
)
|
||||
|
||||
def clear_events():
|
||||
"""Clear all events in the event list."""
|
||||
node_no_event_data_filter.clear()
|
||||
node_event_data_filter.clear()
|
||||
controller_no_event_data_filter.clear()
|
||||
controller_event_data_filter.clear()
|
||||
driver_no_event_data_filter.clear()
|
||||
driver_event_data_filter.clear()
|
||||
node_event_data_no_partial_dict_match_filter.clear()
|
||||
node_event_data_partial_dict_match_filter.clear()
|
||||
|
||||
assert await async_setup_component(
|
||||
hass,
|
||||
automation.DOMAIN,
|
||||
{
|
||||
automation.DOMAIN: [
|
||||
# node filter: no event data
|
||||
{
|
||||
"trigger": {
|
||||
"platform": trigger_type,
|
||||
"entity_id": SCHLAGE_BE469_LOCK_ENTITY,
|
||||
"event_source": "node",
|
||||
"event": "interview stage completed",
|
||||
},
|
||||
"action": {
|
||||
"event": "node_no_event_data_filter",
|
||||
},
|
||||
},
|
||||
# node filter: event data
|
||||
{
|
||||
"trigger": {
|
||||
"platform": trigger_type,
|
||||
"device_id": device.id,
|
||||
"event_source": "node",
|
||||
"event": "interview stage completed",
|
||||
"event_data": {"stageName": "ProtocolInfo"},
|
||||
},
|
||||
"action": {
|
||||
"event": "node_event_data_filter",
|
||||
},
|
||||
},
|
||||
# controller filter: no event data
|
||||
{
|
||||
"trigger": {
|
||||
"platform": trigger_type,
|
||||
"config_entry_id": integration.entry_id,
|
||||
"event_source": "controller",
|
||||
"event": "inclusion started",
|
||||
},
|
||||
"action": {
|
||||
"event": "controller_no_event_data_filter",
|
||||
},
|
||||
},
|
||||
# controller filter: event data
|
||||
{
|
||||
"trigger": {
|
||||
"platform": trigger_type,
|
||||
"config_entry_id": integration.entry_id,
|
||||
"event_source": "controller",
|
||||
"event": "inclusion started",
|
||||
"event_data": {"secure": True},
|
||||
},
|
||||
"action": {
|
||||
"event": "controller_event_data_filter",
|
||||
},
|
||||
},
|
||||
# driver filter: no event data
|
||||
{
|
||||
"trigger": {
|
||||
"platform": trigger_type,
|
||||
"config_entry_id": integration.entry_id,
|
||||
"event_source": "driver",
|
||||
"event": "logging",
|
||||
},
|
||||
"action": {
|
||||
"event": "driver_no_event_data_filter",
|
||||
},
|
||||
},
|
||||
# driver filter: event data
|
||||
{
|
||||
"trigger": {
|
||||
"platform": trigger_type,
|
||||
"config_entry_id": integration.entry_id,
|
||||
"event_source": "driver",
|
||||
"event": "logging",
|
||||
"event_data": {"message": "test"},
|
||||
},
|
||||
"action": {
|
||||
"event": "driver_event_data_filter",
|
||||
},
|
||||
},
|
||||
# node filter: event data, no partial dict match
|
||||
{
|
||||
"trigger": {
|
||||
"platform": trigger_type,
|
||||
"entity_id": SCHLAGE_BE469_LOCK_ENTITY,
|
||||
"event_source": "node",
|
||||
"event": "value updated",
|
||||
"event_data": {"args": {"commandClassName": "Door Lock"}},
|
||||
},
|
||||
"action": {
|
||||
"event": "node_event_data_no_partial_dict_match_filter",
|
||||
},
|
||||
},
|
||||
# node filter: event data, partial dict match
|
||||
{
|
||||
"trigger": {
|
||||
"platform": trigger_type,
|
||||
"entity_id": SCHLAGE_BE469_LOCK_ENTITY,
|
||||
"event_source": "node",
|
||||
"event": "value updated",
|
||||
"event_data": {"args": {"commandClassName": "Door Lock"}},
|
||||
"partial_dict_match": True,
|
||||
},
|
||||
"action": {
|
||||
"event": "node_event_data_partial_dict_match_filter",
|
||||
},
|
||||
},
|
||||
]
|
||||
},
|
||||
)
|
||||
|
||||
# Test that `node no event data filter` is triggered and `node event data filter` is not
|
||||
event = Event(
|
||||
type="interview stage completed",
|
||||
data={
|
||||
"source": "node",
|
||||
"event": "interview stage completed",
|
||||
"stageName": "NodeInfo",
|
||||
"nodeId": node.node_id,
|
||||
},
|
||||
)
|
||||
node.receive_event(event)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
assert len(node_no_event_data_filter) == 1
|
||||
assert len(node_event_data_filter) == 0
|
||||
assert len(controller_no_event_data_filter) == 0
|
||||
assert len(controller_event_data_filter) == 0
|
||||
assert len(driver_no_event_data_filter) == 0
|
||||
assert len(driver_event_data_filter) == 0
|
||||
assert len(node_event_data_no_partial_dict_match_filter) == 0
|
||||
assert len(node_event_data_partial_dict_match_filter) == 0
|
||||
|
||||
clear_events()
|
||||
|
||||
# Test that `node no event data filter` and `node event data filter` are triggered
|
||||
event = Event(
|
||||
type="interview stage completed",
|
||||
data={
|
||||
"source": "node",
|
||||
"event": "interview stage completed",
|
||||
"stageName": "ProtocolInfo",
|
||||
"nodeId": node.node_id,
|
||||
},
|
||||
)
|
||||
node.receive_event(event)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
assert len(node_no_event_data_filter) == 1
|
||||
assert len(node_event_data_filter) == 1
|
||||
assert len(controller_no_event_data_filter) == 0
|
||||
assert len(controller_event_data_filter) == 0
|
||||
assert len(driver_no_event_data_filter) == 0
|
||||
assert len(driver_event_data_filter) == 0
|
||||
assert len(node_event_data_no_partial_dict_match_filter) == 0
|
||||
assert len(node_event_data_partial_dict_match_filter) == 0
|
||||
|
||||
clear_events()
|
||||
|
||||
# Test that `controller no event data filter` is triggered and `controller event data filter` is not
|
||||
event = Event(
|
||||
type="inclusion started",
|
||||
data={
|
||||
"source": "controller",
|
||||
"event": "inclusion started",
|
||||
"secure": False,
|
||||
},
|
||||
)
|
||||
client.driver.controller.receive_event(event)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
assert len(node_no_event_data_filter) == 0
|
||||
assert len(node_event_data_filter) == 0
|
||||
assert len(controller_no_event_data_filter) == 1
|
||||
assert len(controller_event_data_filter) == 0
|
||||
assert len(driver_no_event_data_filter) == 0
|
||||
assert len(driver_event_data_filter) == 0
|
||||
assert len(node_event_data_no_partial_dict_match_filter) == 0
|
||||
assert len(node_event_data_partial_dict_match_filter) == 0
|
||||
|
||||
clear_events()
|
||||
|
||||
# Test that both `controller no event data filter` and `controller event data filter` are triggered
|
||||
event = Event(
|
||||
type="inclusion started",
|
||||
data={
|
||||
"source": "controller",
|
||||
"event": "inclusion started",
|
||||
"secure": True,
|
||||
},
|
||||
)
|
||||
client.driver.controller.receive_event(event)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
assert len(node_no_event_data_filter) == 0
|
||||
assert len(node_event_data_filter) == 0
|
||||
assert len(controller_no_event_data_filter) == 1
|
||||
assert len(controller_event_data_filter) == 1
|
||||
assert len(driver_no_event_data_filter) == 0
|
||||
assert len(driver_event_data_filter) == 0
|
||||
assert len(node_event_data_no_partial_dict_match_filter) == 0
|
||||
assert len(node_event_data_partial_dict_match_filter) == 0
|
||||
|
||||
clear_events()
|
||||
|
||||
# Test that `driver no event data filter` is triggered and `driver event data filter` is not
|
||||
event = Event(
|
||||
type="logging",
|
||||
data={
|
||||
"source": "driver",
|
||||
"event": "logging",
|
||||
"message": "no test",
|
||||
"formattedMessage": "test",
|
||||
"direction": ">",
|
||||
"level": "debug",
|
||||
"primaryTags": "tag",
|
||||
"secondaryTags": "tag2",
|
||||
"secondaryTagPadding": 0,
|
||||
"multiline": False,
|
||||
"timestamp": "time",
|
||||
"label": "label",
|
||||
},
|
||||
)
|
||||
client.driver.receive_event(event)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
assert len(node_no_event_data_filter) == 0
|
||||
assert len(node_event_data_filter) == 0
|
||||
assert len(controller_no_event_data_filter) == 0
|
||||
assert len(controller_event_data_filter) == 0
|
||||
assert len(driver_no_event_data_filter) == 1
|
||||
assert len(driver_event_data_filter) == 0
|
||||
assert len(node_event_data_no_partial_dict_match_filter) == 0
|
||||
assert len(node_event_data_partial_dict_match_filter) == 0
|
||||
|
||||
clear_events()
|
||||
|
||||
# Test that both `driver no event data filter` and `driver event data filter` are triggered
|
||||
event = Event(
|
||||
type="logging",
|
||||
data={
|
||||
"source": "driver",
|
||||
"event": "logging",
|
||||
"message": "test",
|
||||
"formattedMessage": "test",
|
||||
"direction": ">",
|
||||
"level": "debug",
|
||||
"primaryTags": "tag",
|
||||
"secondaryTags": "tag2",
|
||||
"secondaryTagPadding": 0,
|
||||
"multiline": False,
|
||||
"timestamp": "time",
|
||||
"label": "label",
|
||||
},
|
||||
)
|
||||
client.driver.receive_event(event)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
assert len(node_no_event_data_filter) == 0
|
||||
assert len(node_event_data_filter) == 0
|
||||
assert len(controller_no_event_data_filter) == 0
|
||||
assert len(controller_event_data_filter) == 0
|
||||
assert len(driver_no_event_data_filter) == 1
|
||||
assert len(driver_event_data_filter) == 1
|
||||
assert len(node_event_data_no_partial_dict_match_filter) == 0
|
||||
assert len(node_event_data_partial_dict_match_filter) == 0
|
||||
|
||||
clear_events()
|
||||
|
||||
# Test that only `node with event data and partial match dict filter` is triggered
|
||||
event = Event(
|
||||
type="value updated",
|
||||
data={
|
||||
"source": "node",
|
||||
"event": "value updated",
|
||||
"nodeId": node.node_id,
|
||||
"args": {
|
||||
"commandClassName": "Door Lock",
|
||||
"commandClass": 49,
|
||||
"endpoint": 0,
|
||||
"property": "latchStatus",
|
||||
"newValue": "closed",
|
||||
"prevValue": "open",
|
||||
"propertyName": "latchStatus",
|
||||
},
|
||||
},
|
||||
)
|
||||
node.receive_event(event)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
assert len(node_no_event_data_filter) == 0
|
||||
assert len(node_event_data_filter) == 0
|
||||
assert len(controller_no_event_data_filter) == 0
|
||||
assert len(controller_event_data_filter) == 0
|
||||
assert len(driver_no_event_data_filter) == 0
|
||||
assert len(driver_event_data_filter) == 0
|
||||
assert len(node_event_data_no_partial_dict_match_filter) == 0
|
||||
assert len(node_event_data_partial_dict_match_filter) == 1
|
||||
|
||||
clear_events()
|
||||
|
||||
# Test that `node with event data and partial match dict filter` is not triggered
|
||||
# when partial dict doesn't match
|
||||
event = Event(
|
||||
type="value updated",
|
||||
data={
|
||||
"source": "node",
|
||||
"event": "value updated",
|
||||
"nodeId": node.node_id,
|
||||
"args": {
|
||||
"commandClassName": "fake command class name",
|
||||
"commandClass": 49,
|
||||
"endpoint": 0,
|
||||
"property": "latchStatus",
|
||||
"newValue": "closed",
|
||||
"prevValue": "open",
|
||||
"propertyName": "latchStatus",
|
||||
},
|
||||
},
|
||||
)
|
||||
node.receive_event(event)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
assert len(node_no_event_data_filter) == 0
|
||||
assert len(node_event_data_filter) == 0
|
||||
assert len(controller_no_event_data_filter) == 0
|
||||
assert len(controller_event_data_filter) == 0
|
||||
assert len(driver_no_event_data_filter) == 0
|
||||
assert len(driver_event_data_filter) == 0
|
||||
assert len(node_event_data_no_partial_dict_match_filter) == 0
|
||||
assert len(node_event_data_partial_dict_match_filter) == 0
|
||||
|
||||
clear_events()
|
||||
|
||||
with patch("homeassistant.config.load_yaml", return_value={}):
|
||||
await hass.services.async_call(automation.DOMAIN, SERVICE_RELOAD, blocking=True)
|
||||
|
||||
|
||||
async def test_zwave_js_event_invalid_config_entry_id(
|
||||
hass, client, integration, caplog
|
||||
):
|
||||
"""Test zwave_js.event automation trigger fails when config entry ID is invalid."""
|
||||
trigger_type = f"{DOMAIN}.event"
|
||||
|
||||
assert await async_setup_component(
|
||||
hass,
|
||||
automation.DOMAIN,
|
||||
{
|
||||
automation.DOMAIN: [
|
||||
{
|
||||
"trigger": {
|
||||
"platform": trigger_type,
|
||||
"config_entry_id": "not_real_entry_id",
|
||||
"event_source": "controller",
|
||||
"event": "inclusion started",
|
||||
},
|
||||
"action": {
|
||||
"event": "node_no_event_data_filter",
|
||||
},
|
||||
}
|
||||
]
|
||||
},
|
||||
)
|
||||
|
||||
assert "Config entry 'not_real_entry_id' not found" in caplog.text
|
||||
caplog.clear()
|
||||
|
||||
|
||||
async def test_zwave_js_event_unloaded_config_entry(hass, client, integration, caplog):
|
||||
"""Test zwave_js.event automation trigger fails when config entry is unloaded."""
|
||||
trigger_type = f"{DOMAIN}.event"
|
||||
|
||||
await hass.config_entries.async_unload(integration.entry_id)
|
||||
|
||||
assert await async_setup_component(
|
||||
hass,
|
||||
automation.DOMAIN,
|
||||
{
|
||||
automation.DOMAIN: [
|
||||
{
|
||||
"trigger": {
|
||||
"platform": trigger_type,
|
||||
"config_entry_id": integration.entry_id,
|
||||
"event_source": "controller",
|
||||
"event": "inclusion started",
|
||||
},
|
||||
"action": {
|
||||
"event": "node_no_event_data_filter",
|
||||
},
|
||||
}
|
||||
]
|
||||
},
|
||||
)
|
||||
|
||||
assert f"Config entry '{integration.entry_id}' not loaded" in caplog.text
|
||||
|
||||
|
||||
async def test_async_validate_trigger_config(hass):
|
||||
"""Test async_validate_trigger_config."""
|
||||
mock_platform = AsyncMock()
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue