mirror of
https://github.com/home-assistant/core.git
synced 2025-07-25 22:27:07 +00:00
Delete Home Connect deprecated binary door sensor (#142490)
This commit is contained in:
J. Diego Rodríguez Royo
GitHub
parent
4813b5c882
commit
7ad13c8897
@ -5,37 +5,18 @@ from typing import cast
|
|||||||
|
|
||||||
from aiohomeconnect.model import EventKey, StatusKey
|
from aiohomeconnect.model import EventKey, StatusKey
|
||||||
|
|
||||||
from homeassistant.components.automation import automations_with_entity
|
|
||||||
from homeassistant.components.binary_sensor import (
|
from homeassistant.components.binary_sensor import (
|
||||||
BinarySensorDeviceClass,
|
BinarySensorDeviceClass,
|
||||||
BinarySensorEntity,
|
BinarySensorEntity,
|
||||||
BinarySensorEntityDescription,
|
BinarySensorEntityDescription,
|
||||||
)
|
)
|
||||||
from homeassistant.components.script import scripts_with_entity
|
|
||||||
from homeassistant.const import EntityCategory
|
from homeassistant.const import EntityCategory
|
||||||
from homeassistant.core import HomeAssistant
|
from homeassistant.core import HomeAssistant
|
||||||
from homeassistant.helpers import entity_registry as er
|
|
||||||
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
|
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
|
||||||
from homeassistant.helpers.issue_registry import (
|
|
||||||
IssueSeverity,
|
|
||||||
async_create_issue,
|
|
||||||
async_delete_issue,
|
|
||||||
)
|
|
||||||
|
|
||||||
from .common import setup_home_connect_entry
|
from .common import setup_home_connect_entry
|
||||||
from .const import (
|
from .const import REFRIGERATION_STATUS_DOOR_CLOSED, REFRIGERATION_STATUS_DOOR_OPEN
|
||||||
BSH_DOOR_STATE_CLOSED,
|
from .coordinator import HomeConnectApplianceData, HomeConnectConfigEntry
|
||||||
BSH_DOOR_STATE_LOCKED,
|
|
||||||
BSH_DOOR_STATE_OPEN,
|
|
||||||
DOMAIN,
|
|
||||||
REFRIGERATION_STATUS_DOOR_CLOSED,
|
|
||||||
REFRIGERATION_STATUS_DOOR_OPEN,
|
|
||||||
)
|
|
||||||
from .coordinator import (
|
|
||||||
HomeConnectApplianceData,
|
|
||||||
HomeConnectConfigEntry,
|
|
||||||
HomeConnectCoordinator,
|
|
||||||
)
|
|
||||||
from .entity import HomeConnectEntity
|
from .entity import HomeConnectEntity
|
||||||
|
|
||||||
PARALLEL_UPDATES = 0
|
PARALLEL_UPDATES = 0
|
||||||
@ -173,8 +154,6 @@ def _get_entities_for_appliance(
|
|||||||
for description in BINARY_SENSORS
|
for description in BINARY_SENSORS
|
||||||
if description.key in appliance.status
|
if description.key in appliance.status
|
||||||
)
|
)
|
||||||
if StatusKey.BSH_COMMON_DOOR_STATE in appliance.status:
|
|
||||||
entities.append(HomeConnectDoorBinarySensor(entry.runtime_data, appliance))
|
|
||||||
return entities
|
return entities
|
||||||
|
|
||||||
|
|
||||||
@ -220,83 +199,3 @@ class HomeConnectConnectivityBinarySensor(HomeConnectEntity, BinarySensorEntity)
|
|||||||
def available(self) -> bool:
|
def available(self) -> bool:
|
||||||
"""Return the availability."""
|
"""Return the availability."""
|
||||||
return self.coordinator.last_update_success
|
return self.coordinator.last_update_success
|
||||||
|
|
||||||
|
|
||||||
class HomeConnectDoorBinarySensor(HomeConnectBinarySensor):
|
|
||||||
"""Binary sensor for Home Connect Generic Door."""
|
|
||||||
|
|
||||||
_attr_has_entity_name = False
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self,
|
|
||||||
coordinator: HomeConnectCoordinator,
|
|
||||||
appliance: HomeConnectApplianceData,
|
|
||||||
) -> None:
|
|
||||||
"""Initialize the entity."""
|
|
||||||
super().__init__(
|
|
||||||
coordinator,
|
|
||||||
appliance,
|
|
||||||
HomeConnectBinarySensorEntityDescription(
|
|
||||||
key=StatusKey.BSH_COMMON_DOOR_STATE,
|
|
||||||
device_class=BinarySensorDeviceClass.DOOR,
|
|
||||||
boolean_map={
|
|
||||||
BSH_DOOR_STATE_CLOSED: False,
|
|
||||||
BSH_DOOR_STATE_LOCKED: False,
|
|
||||||
BSH_DOOR_STATE_OPEN: True,
|
|
||||||
},
|
|
||||||
entity_registry_enabled_default=False,
|
|
||||||
),
|
|
||||||
)
|
|
||||||
self._attr_unique_id = f"{appliance.info.ha_id}-Door"
|
|
||||||
self._attr_name = f"{appliance.info.name} Door"
|
|
||||||
|
|
||||||
async def async_added_to_hass(self) -> None:
|
|
||||||
"""Call when entity is added to hass."""
|
|
||||||
await super().async_added_to_hass()
|
|
||||||
automations = automations_with_entity(self.hass, self.entity_id)
|
|
||||||
scripts = scripts_with_entity(self.hass, self.entity_id)
|
|
||||||
items = automations + scripts
|
|
||||||
if not items:
|
|
||||||
return
|
|
||||||
|
|
||||||
entity_reg: er.EntityRegistry = er.async_get(self.hass)
|
|
||||||
entity_automations = [
|
|
||||||
automation_entity
|
|
||||||
for automation_id in automations
|
|
||||||
if (automation_entity := entity_reg.async_get(automation_id))
|
|
||||||
]
|
|
||||||
entity_scripts = [
|
|
||||||
script_entity
|
|
||||||
for script_id in scripts
|
|
||||||
if (script_entity := entity_reg.async_get(script_id))
|
|
||||||
]
|
|
||||||
|
|
||||||
items_list = [
|
|
||||||
f"- [{item.original_name}](/config/automation/edit/{item.unique_id})"
|
|
||||||
for item in entity_automations
|
|
||||||
] + [
|
|
||||||
f"- [{item.original_name}](/config/script/edit/{item.unique_id})"
|
|
||||||
for item in entity_scripts
|
|
||||||
]
|
|
||||||
|
|
||||||
async_create_issue(
|
|
||||||
self.hass,
|
|
||||||
DOMAIN,
|
|
||||||
f"deprecated_binary_common_door_sensor_{self.entity_id}",
|
|
||||||
breaks_in_ha_version="2025.5.0",
|
|
||||||
is_fixable=True,
|
|
||||||
is_persistent=True,
|
|
||||||
severity=IssueSeverity.WARNING,
|
|
||||||
translation_key="deprecated_binary_common_door_sensor",
|
|
||||||
translation_placeholders={
|
|
||||||
"entity": self.entity_id,
|
|
||||||
"items": "\n".join(items_list),
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
|
||||||
async def async_will_remove_from_hass(self) -> None:
|
|
||||||
"""Call when entity will be removed from hass."""
|
|
||||||
await super().async_will_remove_from_hass()
|
|
||||||
async_delete_issue(
|
|
||||||
self.hass, DOMAIN, f"deprecated_binary_common_door_sensor_{self.entity_id}"
|
|
||||||
)
|
|
||||||
|
|||||||
@ -1,7 +1,6 @@
|
|||||||
"""Tests for home_connect binary_sensor entities."""
|
"""Tests for home_connect binary_sensor entities."""
|
||||||
|
|
||||||
from collections.abc import Awaitable, Callable
|
from collections.abc import Awaitable, Callable
|
||||||
from http import HTTPStatus
|
|
||||||
from unittest.mock import AsyncMock, MagicMock
|
from unittest.mock import AsyncMock, MagicMock
|
||||||
|
|
||||||
from aiohomeconnect.model import (
|
from aiohomeconnect.model import (
|
||||||
@ -15,17 +14,11 @@ from aiohomeconnect.model import (
|
|||||||
from aiohomeconnect.model.error import HomeConnectApiError
|
from aiohomeconnect.model.error import HomeConnectApiError
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from homeassistant.components import automation, script
|
|
||||||
from homeassistant.components.automation import automations_with_entity
|
|
||||||
from homeassistant.components.home_connect.const import (
|
from homeassistant.components.home_connect.const import (
|
||||||
BSH_DOOR_STATE_CLOSED,
|
|
||||||
BSH_DOOR_STATE_LOCKED,
|
|
||||||
BSH_DOOR_STATE_OPEN,
|
|
||||||
DOMAIN,
|
DOMAIN,
|
||||||
REFRIGERATION_STATUS_DOOR_CLOSED,
|
REFRIGERATION_STATUS_DOOR_CLOSED,
|
||||||
REFRIGERATION_STATUS_DOOR_OPEN,
|
REFRIGERATION_STATUS_DOOR_OPEN,
|
||||||
)
|
)
|
||||||
from homeassistant.components.script import scripts_with_entity
|
|
||||||
from homeassistant.config_entries import ConfigEntryState
|
from homeassistant.config_entries import ConfigEntryState
|
||||||
from homeassistant.const import (
|
from homeassistant.const import (
|
||||||
STATE_OFF,
|
STATE_OFF,
|
||||||
@ -36,11 +29,8 @@ from homeassistant.const import (
|
|||||||
)
|
)
|
||||||
from homeassistant.core import HomeAssistant
|
from homeassistant.core import HomeAssistant
|
||||||
from homeassistant.helpers import device_registry as dr, entity_registry as er
|
from homeassistant.helpers import device_registry as dr, entity_registry as er
|
||||||
import homeassistant.helpers.issue_registry as ir
|
|
||||||
from homeassistant.setup import async_setup_component
|
|
||||||
|
|
||||||
from tests.common import MockConfigEntry
|
from tests.common import MockConfigEntry
|
||||||
from tests.typing import ClientSessionGenerator
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
@ -179,7 +169,6 @@ async def test_binary_sensors_entity_availability(
|
|||||||
) -> None:
|
) -> None:
|
||||||
"""Test if binary sensor entities availability are based on the appliance connection state."""
|
"""Test if binary sensor entities availability are based on the appliance connection state."""
|
||||||
entity_ids = [
|
entity_ids = [
|
||||||
"binary_sensor.washer_door",
|
|
||||||
"binary_sensor.washer_remote_control",
|
"binary_sensor.washer_remote_control",
|
||||||
]
|
]
|
||||||
assert config_entry.state == ConfigEntryState.NOT_LOADED
|
assert config_entry.state == ConfigEntryState.NOT_LOADED
|
||||||
@ -222,57 +211,6 @@ async def test_binary_sensors_entity_availability(
|
|||||||
assert state.state != STATE_UNAVAILABLE
|
assert state.state != STATE_UNAVAILABLE
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.usefixtures("entity_registry_enabled_by_default")
|
|
||||||
@pytest.mark.parametrize("appliance", ["Washer"], indirect=True)
|
|
||||||
@pytest.mark.parametrize(
|
|
||||||
("value", "expected"),
|
|
||||||
[
|
|
||||||
(BSH_DOOR_STATE_CLOSED, "off"),
|
|
||||||
(BSH_DOOR_STATE_LOCKED, "off"),
|
|
||||||
(BSH_DOOR_STATE_OPEN, "on"),
|
|
||||||
("", STATE_UNKNOWN),
|
|
||||||
],
|
|
||||||
)
|
|
||||||
async def test_binary_sensors_door_states(
|
|
||||||
appliance: HomeAppliance,
|
|
||||||
expected: str,
|
|
||||||
value: str,
|
|
||||||
hass: HomeAssistant,
|
|
||||||
config_entry: MockConfigEntry,
|
|
||||||
integration_setup: Callable[[MagicMock], Awaitable[bool]],
|
|
||||||
setup_credentials: None,
|
|
||||||
client: MagicMock,
|
|
||||||
) -> None:
|
|
||||||
"""Tests for Appliance door states."""
|
|
||||||
entity_id = "binary_sensor.washer_door"
|
|
||||||
assert config_entry.state == ConfigEntryState.NOT_LOADED
|
|
||||||
assert await integration_setup(client)
|
|
||||||
assert config_entry.state == ConfigEntryState.LOADED
|
|
||||||
|
|
||||||
await client.add_events(
|
|
||||||
[
|
|
||||||
EventMessage(
|
|
||||||
appliance.ha_id,
|
|
||||||
EventType.STATUS,
|
|
||||||
ArrayOfEvents(
|
|
||||||
[
|
|
||||||
Event(
|
|
||||||
key=EventKey.BSH_COMMON_STATUS_DOOR_STATE,
|
|
||||||
raw_key=EventKey.BSH_COMMON_STATUS_DOOR_STATE.value,
|
|
||||||
timestamp=0,
|
|
||||||
level="",
|
|
||||||
handling="",
|
|
||||||
value=value,
|
|
||||||
)
|
|
||||||
],
|
|
||||||
),
|
|
||||||
)
|
|
||||||
]
|
|
||||||
)
|
|
||||||
await hass.async_block_till_done()
|
|
||||||
assert hass.states.is_state(entity_id, expected)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
("entity_id", "event_key", "event_value_update", "expected", "appliance"),
|
("entity_id", "event_key", "event_value_update", "expected", "appliance"),
|
||||||
[
|
[
|
||||||
@ -403,141 +341,3 @@ async def test_connected_sensor_functionality(
|
|||||||
await hass.async_block_till_done()
|
await hass.async_block_till_done()
|
||||||
|
|
||||||
assert hass.states.is_state(entity_id, STATE_ON)
|
assert hass.states.is_state(entity_id, STATE_ON)
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.usefixtures("entity_registry_enabled_by_default")
|
|
||||||
async def test_create_door_binary_sensor_deprecation_issue(
|
|
||||||
hass: HomeAssistant,
|
|
||||||
config_entry: MockConfigEntry,
|
|
||||||
integration_setup: Callable[[MagicMock], Awaitable[bool]],
|
|
||||||
setup_credentials: None,
|
|
||||||
client: MagicMock,
|
|
||||||
issue_registry: ir.IssueRegistry,
|
|
||||||
) -> None:
|
|
||||||
"""Test that we create an issue when an automation or script is using a door binary sensor entity."""
|
|
||||||
entity_id = "binary_sensor.washer_door"
|
|
||||||
issue_id = f"deprecated_binary_common_door_sensor_{entity_id}"
|
|
||||||
|
|
||||||
assert await async_setup_component(
|
|
||||||
hass,
|
|
||||||
automation.DOMAIN,
|
|
||||||
{
|
|
||||||
automation.DOMAIN: {
|
|
||||||
"alias": "test",
|
|
||||||
"trigger": {"platform": "state", "entity_id": entity_id},
|
|
||||||
"action": {
|
|
||||||
"action": "automation.turn_on",
|
|
||||||
"target": {
|
|
||||||
"entity_id": "automation.test",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
},
|
|
||||||
)
|
|
||||||
assert await async_setup_component(
|
|
||||||
hass,
|
|
||||||
script.DOMAIN,
|
|
||||||
{
|
|
||||||
script.DOMAIN: {
|
|
||||||
"test": {
|
|
||||||
"sequence": [
|
|
||||||
{
|
|
||||||
"condition": "state",
|
|
||||||
"entity_id": entity_id,
|
|
||||||
"state": "on",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
|
||||||
assert config_entry.state == ConfigEntryState.NOT_LOADED
|
|
||||||
assert await integration_setup(client)
|
|
||||||
assert config_entry.state == ConfigEntryState.LOADED
|
|
||||||
|
|
||||||
assert automations_with_entity(hass, entity_id)[0] == "automation.test"
|
|
||||||
assert scripts_with_entity(hass, entity_id)[0] == "script.test"
|
|
||||||
|
|
||||||
assert len(issue_registry.issues) == 1
|
|
||||||
assert issue_registry.async_get_issue(DOMAIN, issue_id)
|
|
||||||
|
|
||||||
await hass.config_entries.async_unload(config_entry.entry_id)
|
|
||||||
await hass.async_block_till_done()
|
|
||||||
|
|
||||||
# Assert the issue is no longer present
|
|
||||||
assert not issue_registry.async_get_issue(DOMAIN, issue_id)
|
|
||||||
assert len(issue_registry.issues) == 0
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.usefixtures("entity_registry_enabled_by_default")
|
|
||||||
async def test_door_binary_sensor_deprecation_issue_fix(
|
|
||||||
hass: HomeAssistant,
|
|
||||||
config_entry: MockConfigEntry,
|
|
||||||
integration_setup: Callable[[MagicMock], Awaitable[bool]],
|
|
||||||
setup_credentials: None,
|
|
||||||
client: MagicMock,
|
|
||||||
issue_registry: ir.IssueRegistry,
|
|
||||||
hass_client: ClientSessionGenerator,
|
|
||||||
) -> None:
|
|
||||||
"""Test that we create an issue when an automation or script is using a door binary sensor entity."""
|
|
||||||
entity_id = "binary_sensor.washer_door"
|
|
||||||
issue_id = f"deprecated_binary_common_door_sensor_{entity_id}"
|
|
||||||
|
|
||||||
assert await async_setup_component(
|
|
||||||
hass,
|
|
||||||
automation.DOMAIN,
|
|
||||||
{
|
|
||||||
automation.DOMAIN: {
|
|
||||||
"alias": "test",
|
|
||||||
"trigger": {"platform": "state", "entity_id": entity_id},
|
|
||||||
"action": {
|
|
||||||
"action": "automation.turn_on",
|
|
||||||
"target": {
|
|
||||||
"entity_id": "automation.test",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
},
|
|
||||||
)
|
|
||||||
assert await async_setup_component(
|
|
||||||
hass,
|
|
||||||
script.DOMAIN,
|
|
||||||
{
|
|
||||||
script.DOMAIN: {
|
|
||||||
"test": {
|
|
||||||
"sequence": [
|
|
||||||
{
|
|
||||||
"condition": "state",
|
|
||||||
"entity_id": entity_id,
|
|
||||||
"state": "on",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
|
||||||
assert config_entry.state == ConfigEntryState.NOT_LOADED
|
|
||||||
assert await integration_setup(client)
|
|
||||||
assert config_entry.state == ConfigEntryState.LOADED
|
|
||||||
|
|
||||||
assert automations_with_entity(hass, entity_id)[0] == "automation.test"
|
|
||||||
assert scripts_with_entity(hass, entity_id)[0] == "script.test"
|
|
||||||
|
|
||||||
assert len(issue_registry.issues) == 1
|
|
||||||
issue = issue_registry.async_get_issue(DOMAIN, issue_id)
|
|
||||||
assert issue
|
|
||||||
|
|
||||||
_client = await hass_client()
|
|
||||||
resp = await _client.post(
|
|
||||||
"/api/repairs/issues/fix",
|
|
||||||
json={"handler": DOMAIN, "issue_id": issue.issue_id},
|
|
||||||
)
|
|
||||||
assert resp.status == HTTPStatus.OK
|
|
||||||
flow_id = (await resp.json())["flow_id"]
|
|
||||||
resp = await _client.post(f"/api/repairs/issues/fix/{flow_id}")
|
|
||||||
|
|
||||||
# Assert the issue is no longer present
|
|
||||||
assert not issue_registry.async_get_issue(DOMAIN, issue_id)
|
|
||||||
assert len(issue_registry.issues) == 0
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user