"""The tests for Cover device conditions.""" import pytest from pytest_unordered import unordered import homeassistant.components.automation as automation from homeassistant.components.cover import DOMAIN, CoverEntityFeature from homeassistant.components.device_automation import DeviceAutomationType from homeassistant.const import ( CONF_PLATFORM, STATE_CLOSED, STATE_CLOSING, STATE_OPEN, STATE_OPENING, STATE_UNAVAILABLE, EntityCategory, ) from homeassistant.core import HomeAssistant from homeassistant.helpers import device_registry as dr, entity_registry as er from homeassistant.helpers.entity_registry import RegistryEntryHider from homeassistant.setup import async_setup_component from tests.common import ( MockConfigEntry, async_get_device_automation_capabilities, async_get_device_automations, async_mock_service, ) @pytest.fixture(autouse=True, name="stub_blueprint_populate") def stub_blueprint_populate_autouse(stub_blueprint_populate: None) -> None: """Stub copying the blueprints to the config folder.""" @pytest.fixture def calls(hass): """Track calls to a mock service.""" return async_mock_service(hass, "test", "automation") @pytest.mark.parametrize( ("set_state", "features_reg", "features_state", "expected_condition_types"), [ (False, 0, 0, []), ( False, CoverEntityFeature.CLOSE, 0, ["is_open", "is_closed", "is_opening", "is_closing"], ), ( False, CoverEntityFeature.OPEN, 0, ["is_open", "is_closed", "is_opening", "is_closing"], ), (False, CoverEntityFeature.SET_POSITION, 0, ["is_position"]), (False, CoverEntityFeature.SET_TILT_POSITION, 0, ["is_tilt_position"]), (True, 0, 0, []), ( True, 0, CoverEntityFeature.CLOSE, ["is_open", "is_closed", "is_opening", "is_closing"], ), ( True, 0, CoverEntityFeature.OPEN, ["is_open", "is_closed", "is_opening", "is_closing"], ), (True, 0, CoverEntityFeature.SET_POSITION, ["is_position"]), (True, 0, CoverEntityFeature.SET_TILT_POSITION, ["is_tilt_position"]), ], ) async def test_get_conditions( hass: HomeAssistant, device_registry: dr.DeviceRegistry, entity_registry: er.EntityRegistry, set_state, features_reg, features_state, expected_condition_types, ) -> None: """Test we get the expected conditions from a cover.""" 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_entry = entity_registry.async_get_or_create( DOMAIN, "test", "5678", device_id=device_entry.id, supported_features=features_reg, ) if set_state: hass.states.async_set( f"{DOMAIN}.test_5678", "attributes", {"supported_features": features_state} ) await hass.async_block_till_done() expected_conditions = [] expected_conditions += [ { "condition": "device", "domain": DOMAIN, "type": condition, "device_id": device_entry.id, "entity_id": entity_entry.id, "metadata": {"secondary": False}, } for condition in expected_condition_types ] conditions = await async_get_device_automations( hass, DeviceAutomationType.CONDITION, device_entry.id ) assert conditions == unordered(expected_conditions) @pytest.mark.parametrize( ("hidden_by", "entity_category"), [ (RegistryEntryHider.INTEGRATION, None), (RegistryEntryHider.USER, None), (None, EntityCategory.CONFIG), (None, EntityCategory.DIAGNOSTIC), ], ) async def test_get_conditions_hidden_auxiliary( hass: HomeAssistant, device_registry: dr.DeviceRegistry, entity_registry: er.EntityRegistry, hidden_by, entity_category, ) -> None: """Test we get the expected conditions from a hidden or auxiliary entity.""" 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_entry = entity_registry.async_get_or_create( DOMAIN, "test", "5678", device_id=device_entry.id, entity_category=entity_category, hidden_by=hidden_by, supported_features=CoverEntityFeature.CLOSE, ) expected_conditions = [ { "condition": "device", "domain": DOMAIN, "type": condition, "device_id": device_entry.id, "entity_id": entity_entry.id, "metadata": {"secondary": True}, } for condition in ["is_open", "is_closed", "is_opening", "is_closing"] ] conditions = await async_get_device_automations( hass, DeviceAutomationType.CONDITION, device_entry.id ) assert conditions == unordered(expected_conditions) async def test_get_condition_capabilities( hass: HomeAssistant, device_registry: dr.DeviceRegistry, entity_registry: er.EntityRegistry, enable_custom_integrations: None, ) -> None: """Test we get the expected capabilities from a cover condition.""" 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 ) conditions = await async_get_device_automations( hass, DeviceAutomationType.CONDITION, device_entry.id ) assert len(conditions) == 4 for condition in conditions: capabilities = await async_get_device_automation_capabilities( hass, DeviceAutomationType.CONDITION, condition ) assert capabilities == {"extra_fields": []} async def test_get_condition_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 condition.""" 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 ) conditions = await async_get_device_automations( hass, DeviceAutomationType.CONDITION, device_entry.id ) assert len(conditions) == 4 for condition in conditions: condition["entity_id"] = entity_registry.async_get( condition["entity_id"] ).entity_id capabilities = await async_get_device_automation_capabilities( hass, DeviceAutomationType.CONDITION, condition ) assert capabilities == {"extra_fields": []} async def test_get_condition_capabilities_set_pos( hass: HomeAssistant, device_registry: dr.DeviceRegistry, entity_registry: er.EntityRegistry, enable_custom_integrations: None, ) -> None: """Test we get the expected capabilities from a cover condition.""" platform = getattr(hass.components, f"test.{DOMAIN}") platform.init() ent = platform.ENTITIES[1] 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 ) expected_capabilities = { "extra_fields": [ { "name": "above", "optional": True, "type": "integer", "default": 0, "valueMax": 100, "valueMin": 0, }, { "name": "below", "optional": True, "type": "integer", "default": 100, "valueMax": 100, "valueMin": 0, }, ] } conditions = await async_get_device_automations( hass, DeviceAutomationType.CONDITION, device_entry.id ) assert len(conditions) == 5 for condition in conditions: capabilities = await async_get_device_automation_capabilities( hass, DeviceAutomationType.CONDITION, condition ) if condition["type"] == "is_position": assert capabilities == expected_capabilities else: assert capabilities == {"extra_fields": []} async def test_get_condition_capabilities_set_tilt_pos( hass: HomeAssistant, device_registry: dr.DeviceRegistry, entity_registry: er.EntityRegistry, enable_custom_integrations: None, ) -> None: """Test we get the expected capabilities from a cover condition.""" platform = getattr(hass.components, f"test.{DOMAIN}") platform.init() ent = platform.ENTITIES[3] 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 ) expected_capabilities = { "extra_fields": [ { "name": "above", "optional": True, "type": "integer", "default": 0, "valueMax": 100, "valueMin": 0, }, { "name": "below", "optional": True, "type": "integer", "default": 100, "valueMax": 100, "valueMin": 0, }, ] } conditions = await async_get_device_automations( hass, DeviceAutomationType.CONDITION, device_entry.id ) assert len(conditions) == 5 for condition in conditions: capabilities = await async_get_device_automation_capabilities( hass, DeviceAutomationType.CONDITION, condition ) if condition["type"] == "is_tilt_position": assert capabilities == expected_capabilities else: assert capabilities == {"extra_fields": []} async def test_if_state( hass: HomeAssistant, device_registry: dr.DeviceRegistry, entity_registry: er.EntityRegistry, calls, ) -> None: """Test for turn_on and turn_off conditions.""" 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")}, ) entry = entity_registry.async_get_or_create( DOMAIN, "test", "5678", device_id=device_entry.id ) hass.states.async_set(entry.entity_id, STATE_OPEN) assert await async_setup_component( hass, automation.DOMAIN, { automation.DOMAIN: [ { "trigger": {"platform": "event", "event_type": "test_event1"}, "condition": [ { "condition": "device", "domain": DOMAIN, "device_id": device_entry.id, "entity_id": entry.id, "type": "is_open", } ], "action": { "service": "test.automation", "data_template": { "some": ( "is_open " "- {{ trigger.platform }} " "- {{ trigger.event.event_type }}" ) }, }, }, { "trigger": {"platform": "event", "event_type": "test_event2"}, "condition": [ { "condition": "device", "domain": DOMAIN, "device_id": device_entry.id, "entity_id": entry.id, "type": "is_closed", } ], "action": { "service": "test.automation", "data_template": { "some": ( "is_closed " "- {{ trigger.platform }} " "- {{ trigger.event.event_type }}" ) }, }, }, { "trigger": {"platform": "event", "event_type": "test_event3"}, "condition": [ { "condition": "device", "domain": DOMAIN, "device_id": device_entry.id, "entity_id": entry.id, "type": "is_opening", } ], "action": { "service": "test.automation", "data_template": { "some": ( "is_opening " "- {{ trigger.platform }} " "- {{ trigger.event.event_type }}" ) }, }, }, { "trigger": {"platform": "event", "event_type": "test_event4"}, "condition": [ { "condition": "device", "domain": DOMAIN, "device_id": device_entry.id, "entity_id": entry.id, "type": "is_closing", } ], "action": { "service": "test.automation", "data_template": { "some": ( "is_closing " "- {{ trigger.platform }} " "- {{ trigger.event.event_type }}" ) }, }, }, ] }, ) hass.bus.async_fire("test_event1") hass.bus.async_fire("test_event2") await hass.async_block_till_done() assert len(calls) == 1 assert calls[0].data["some"] == "is_open - event - test_event1" hass.states.async_set(entry.entity_id, STATE_CLOSED) hass.bus.async_fire("test_event1") hass.bus.async_fire("test_event2") await hass.async_block_till_done() assert len(calls) == 2 assert calls[1].data["some"] == "is_closed - event - test_event2" hass.states.async_set(entry.entity_id, STATE_OPENING) hass.bus.async_fire("test_event1") hass.bus.async_fire("test_event3") await hass.async_block_till_done() assert len(calls) == 3 assert calls[2].data["some"] == "is_opening - event - test_event3" hass.states.async_set(entry.entity_id, STATE_CLOSING) hass.bus.async_fire("test_event1") hass.bus.async_fire("test_event4") await hass.async_block_till_done() assert len(calls) == 4 assert calls[3].data["some"] == "is_closing - event - test_event4" async def test_if_state_legacy( hass: HomeAssistant, device_registry: dr.DeviceRegistry, entity_registry: er.EntityRegistry, calls, ) -> None: """Test for turn_on and turn_off conditions.""" 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")}, ) entry = entity_registry.async_get_or_create( DOMAIN, "test", "5678", device_id=device_entry.id ) hass.states.async_set(entry.entity_id, STATE_OPEN) assert await async_setup_component( hass, automation.DOMAIN, { automation.DOMAIN: [ { "trigger": {"platform": "event", "event_type": "test_event1"}, "condition": [ { "condition": "device", "domain": DOMAIN, "device_id": device_entry.id, "entity_id": entry.entity_id, "type": "is_open", } ], "action": { "service": "test.automation", "data_template": { "some": ( "is_open " "- {{ trigger.platform }} " "- {{ trigger.event.event_type }}" ) }, }, }, ] }, ) hass.bus.async_fire("test_event1") hass.bus.async_fire("test_event2") await hass.async_block_till_done() assert len(calls) == 1 assert calls[0].data["some"] == "is_open - event - test_event1" async def test_if_position( hass: HomeAssistant, device_registry: dr.DeviceRegistry, entity_registry: er.EntityRegistry, calls, caplog: pytest.LogCaptureFixture, enable_custom_integrations: None, ) -> None: """Test for position conditions.""" platform = getattr(hass.components, f"test.{DOMAIN}") platform.init() ent = platform.ENTITIES[1] 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")}, ) entry = entity_registry.async_get(ent.entity_id) entity_registry.async_update_entity(entry.entity_id, device_id=device_entry.id) assert await async_setup_component( hass, automation.DOMAIN, { automation.DOMAIN: [ { "trigger": {"platform": "event", "event_type": "test_event1"}, "action": { "choose": { "conditions": { "condition": "device", "domain": DOMAIN, "device_id": device_entry.id, "entity_id": entry.id, "type": "is_position", "above": 45, }, "sequence": { "service": "test.automation", "data_template": { "some": ( "is_pos_gt_45 " "- {{ trigger.platform }} " "- {{ trigger.event.event_type }}" ) }, }, }, "default": { "service": "test.automation", "data_template": { "some": ( "is_pos_not_gt_45 " "- {{ trigger.platform }} " "- {{ trigger.event.event_type }}" ) }, }, }, }, { "trigger": {"platform": "event", "event_type": "test_event2"}, "condition": [ { "condition": "device", "domain": DOMAIN, "device_id": device_entry.id, "entity_id": entry.id, "type": "is_position", "below": 90, } ], "action": { "service": "test.automation", "data_template": { "some": ( "is_pos_lt_90 " "- {{ trigger.platform }} " "- {{ trigger.event.event_type }}" ) }, }, }, { "trigger": {"platform": "event", "event_type": "test_event3"}, "condition": [ { "condition": "device", "domain": DOMAIN, "device_id": device_entry.id, "entity_id": entry.id, "type": "is_position", "above": 45, "below": 90, } ], "action": { "service": "test.automation", "data_template": { "some": ( "is_pos_gt_45_lt_90 " "- {{ trigger.platform }} " "- {{ trigger.event.event_type }}" ) }, }, }, ] }, ) caplog.clear() hass.bus.async_fire("test_event1") await hass.async_block_till_done() hass.bus.async_fire("test_event2") await hass.async_block_till_done() hass.bus.async_fire("test_event3") await hass.async_block_till_done() assert len(calls) == 3 assert calls[0].data["some"] == "is_pos_gt_45 - event - test_event1" assert calls[1].data["some"] == "is_pos_lt_90 - event - test_event2" assert calls[2].data["some"] == "is_pos_gt_45_lt_90 - event - test_event3" hass.states.async_set( ent.entity_id, STATE_CLOSED, attributes={"current_position": 45} ) hass.bus.async_fire("test_event1") await hass.async_block_till_done() hass.bus.async_fire("test_event2") await hass.async_block_till_done() hass.bus.async_fire("test_event3") await hass.async_block_till_done() assert len(calls) == 5 assert calls[3].data["some"] == "is_pos_not_gt_45 - event - test_event1" assert calls[4].data["some"] == "is_pos_lt_90 - event - test_event2" hass.states.async_set( ent.entity_id, STATE_CLOSED, attributes={"current_position": 90} ) hass.bus.async_fire("test_event1") hass.bus.async_fire("test_event2") hass.bus.async_fire("test_event3") await hass.async_block_till_done() assert len(calls) == 6 assert calls[5].data["some"] == "is_pos_gt_45 - event - test_event1" hass.states.async_set(ent.entity_id, STATE_UNAVAILABLE, attributes={}) hass.bus.async_fire("test_event1") await hass.async_block_till_done() assert len(calls) == 7 assert calls[6].data["some"] == "is_pos_not_gt_45 - event - test_event1" for record in caplog.records: assert record.levelname in ("DEBUG", "INFO") async def test_if_tilt_position( hass: HomeAssistant, device_registry: dr.DeviceRegistry, entity_registry: er.EntityRegistry, calls, caplog: pytest.LogCaptureFixture, enable_custom_integrations: None, ) -> None: """Test for tilt position conditions.""" platform = getattr(hass.components, f"test.{DOMAIN}") platform.init() ent = platform.ENTITIES[3] 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")}, ) entry = entity_registry.async_get(ent.entity_id) entity_registry.async_update_entity(entry.entity_id, device_id=device_entry.id) assert await async_setup_component( hass, automation.DOMAIN, { automation.DOMAIN: [ { "trigger": {"platform": "event", "event_type": "test_event1"}, "action": { "choose": { "conditions": { "condition": "device", "domain": DOMAIN, "device_id": device_entry.id, "entity_id": entry.id, "type": "is_tilt_position", "above": 45, }, "sequence": { "service": "test.automation", "data_template": { "some": ( "is_pos_gt_45 " "- {{ trigger.platform }} " "- {{ trigger.event.event_type }}" ) }, }, }, "default": { "service": "test.automation", "data_template": { "some": ( "is_pos_not_gt_45 " "- {{ trigger.platform }} " "- {{ trigger.event.event_type }}" ) }, }, }, }, { "trigger": {"platform": "event", "event_type": "test_event2"}, "condition": [ { "condition": "device", "domain": DOMAIN, "device_id": device_entry.id, "entity_id": entry.id, "type": "is_tilt_position", "below": 90, } ], "action": { "service": "test.automation", "data_template": { "some": ( "is_pos_lt_90 " "- {{ trigger.platform }} " "- {{ trigger.event.event_type }}" ) }, }, }, { "trigger": {"platform": "event", "event_type": "test_event3"}, "condition": [ { "condition": "device", "domain": DOMAIN, "device_id": device_entry.id, "entity_id": entry.id, "type": "is_tilt_position", "above": 45, "below": 90, } ], "action": { "service": "test.automation", "data_template": { "some": ( "is_pos_gt_45_lt_90 " "- {{ trigger.platform }} " "- {{ trigger.event.event_type }}" ) }, }, }, ] }, ) caplog.clear() hass.bus.async_fire("test_event1") await hass.async_block_till_done() hass.bus.async_fire("test_event2") await hass.async_block_till_done() hass.bus.async_fire("test_event3") await hass.async_block_till_done() assert len(calls) == 3 assert calls[0].data["some"] == "is_pos_gt_45 - event - test_event1" assert calls[1].data["some"] == "is_pos_lt_90 - event - test_event2" assert calls[2].data["some"] == "is_pos_gt_45_lt_90 - event - test_event3" hass.states.async_set( ent.entity_id, STATE_CLOSED, attributes={"current_tilt_position": 45} ) hass.bus.async_fire("test_event1") await hass.async_block_till_done() hass.bus.async_fire("test_event2") await hass.async_block_till_done() hass.bus.async_fire("test_event3") await hass.async_block_till_done() assert len(calls) == 5 assert calls[3].data["some"] == "is_pos_not_gt_45 - event - test_event1" assert calls[4].data["some"] == "is_pos_lt_90 - event - test_event2" hass.states.async_set( ent.entity_id, STATE_CLOSED, attributes={"current_tilt_position": 90} ) hass.bus.async_fire("test_event1") await hass.async_block_till_done() hass.bus.async_fire("test_event2") await hass.async_block_till_done() hass.bus.async_fire("test_event3") await hass.async_block_till_done() assert len(calls) == 6 assert calls[5].data["some"] == "is_pos_gt_45 - event - test_event1" hass.states.async_set(ent.entity_id, STATE_UNAVAILABLE, attributes={}) hass.bus.async_fire("test_event1") await hass.async_block_till_done() assert len(calls) == 7 assert calls[6].data["some"] == "is_pos_not_gt_45 - event - test_event1" for record in caplog.records: assert record.levelname in ("DEBUG", "INFO")