Merge pull request #641 from plugwise/testing123

Try a different approach for runtime updating

Author: bouwew

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Versions from 0.40 and up
 
+## v0.50.1
+
+- Code improvements via #640 and #641
+
 ## v0.50.0
 
 - Delete removed Plugwise devices at runtime.

custom_components/plugwise/coordinator.py

@@ -23,6 +23,7 @@
 from homeassistant.helpers import device_registry as dr
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
 from homeassistant.helpers.debounce import Debouncer
+from homeassistant.helpers.device_registry import DeviceEntry, DeviceRegistry
 from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
 
 from .const import (
@@ -34,32 +35,21 @@
     LOGGER,
 )
 
-EMPTY_DATA = PlugwiseData(gateway={}, devices={})
-
 
 async def cleanup_device_and_entity_registry(
-    hass: HomeAssistant,
     data: PlugwiseData,
-    self_data: PlugwiseData,
+    device_reg: DeviceRegistry,
+    device_list: list[DeviceEntry],
     entry: ConfigEntry,
 ) -> None:
     """Remove deleted devices from device- and entity-registry."""
-    device_reg = dr.async_get(hass)
-    device_list = dr.async_entries_for_config_entry(
-        device_reg, entry.entry_id
-    )
-    if not (
-        self_data != EMPTY_DATA  # don't clean-up at init
-        and len(device_list) - len(data.devices.keys()) > 0
-    ):
+    if len(device_list) - len(data.devices.keys()) <= 0:
         return
 
     # via_device cannot be None, this will result in the deletion
     # of other Plugwise Gateways when present!
     via_device: str = ""
-    for device_entry in dr.async_entries_for_config_entry(
-        device_reg, entry.entry_id
-    ):
+    for device_entry in device_list:
         if not device_entry.identifiers:
             continue  # pragma: no cover
 
@@ -124,9 +114,9 @@ def __init__(
             websession=async_get_clientsession(hass, verify_ssl=False),
         )
         self._unavailable_logged = False
-        self.data = EMPTY_DATA
         self.hass = hass
-        self.new_devices: set[str] = set()
+        self.device_list: list[DeviceEntry] = []
+        self.new_devices: bool = False
         self.update_interval = update_interval
 
     async def _connect(self) -> None:
@@ -149,7 +139,7 @@ async def _async_update_data(self) -> PlugwiseData:
         try:
             if not self._connected:
                 await self._connect()
-            fresh_data = await self.api.async_update()
+            data = await self.api.async_update()
 
             if self._unavailable_logged:
                 self._unavailable_logged = False
@@ -172,10 +162,20 @@ async def _async_update_data(self) -> PlugwiseData:
                 self._unavailable_logged = True
                 raise UpdateFailed("Failed to connect") from err
 
-        await cleanup_device_and_entity_registry(self.hass, fresh_data, self.data, self.config_entry)
+        device_reg = dr.async_get(self.hass)
+        device_list = dr.async_entries_for_config_entry(
+            device_reg, self.config_entry.entry_id
+        )
+
+        await cleanup_device_and_entity_registry(
+            data,
+            device_reg,
+            device_list,
+            self.config_entry
+        )
 
-        self.new_devices = (fresh_data.devices.keys() - self.data.devices.keys())
+        self.new_devices = len(data.devices.keys()) - len(self.device_list) > 0
 
-        self.data = fresh_data
+        self.device_list = device_list
 
-        return self.data
+        return data

custom_components/plugwise/manifest.json

@@ -9,5 +9,5 @@
   "iot_class": "local_polling",
   "loggers": ["plugwise"],
   "requirements": ["plugwise==0.37.5"],
-  "version": "0.50.1a0"
+  "version": "0.50.1"
 }

tests/components/plugwise/test_init.py

@@ -211,6 +211,9 @@ async def test_update_device(
     entity_registry: er.EntityRegistry,
 ) -> None:
     """Test a clean-up of the device_registry."""
+    utcnow = dt_util.utcnow()
+    data = mock_smile_adam_2.async_update.return_value
+
     mock_config_entry.add_to_hass(hass)
     assert await async_setup_component(hass, DOMAIN, {})
     await hass.async_block_till_done()
@@ -224,13 +227,10 @@ async def test_update_device(
         == 6
     )
 
-    utcnow = dt_util.utcnow()
-    data = mock_smile_adam_2.async_update.return_value
     # Add a 2nd Tom/Floor
     data.devices.update(TOM)
     with patch(HA_PLUGWISE_SMILE_ASYNC_UPDATE, return_value=data):
         async_fire_time_changed(hass, utcnow + timedelta(minutes=1))
-        await hass.config_entries.async_reload(mock_config_entry.entry_id)
         await hass.async_block_till_done()
 
         assert (
@@ -246,21 +246,10 @@ async def test_update_device(
             item_list.extend(x[1] for x in device_entry.identifiers)
         assert "01234567890abcdefghijklmnopqrstu" in item_list
 
-
-async def test_remove_device(
-    hass: HomeAssistant,
-    mock_config_entry: MockConfigEntry,
-    mock_smile_adam_2: MagicMock,
-    device_registry: dr.DeviceRegistry,
-    entity_registry: er.EntityRegistry,
-) -> None:
-    """Test a clean-up of the device_registry."""
-    mock_config_entry.add_to_hass(hass)
-    data = mock_smile_adam_2.async_update.return_value
-    utcnow = dt_util.utcnow()
-    with patch(HA_PLUGWISE_SMILE_ASYNC_UPDATE) as mock_update:
-        mock_update.return_value = data
-        assert await async_setup_component(hass, DOMAIN, {})
+    # Remove the existing Tom/Floor
+    data.devices.pop("1772a4ea304041adb83f357b751341ff")
+    with patch(HA_PLUGWISE_SMILE_ASYNC_UPDATE, return_value=data):
+        async_fire_time_changed(hass, utcnow + timedelta(minutes=1))
         await hass.async_block_till_done()
 
         assert (
@@ -271,22 +260,6 @@ async def test_remove_device(
             len(dr.async_entries_for_config_entry(device_registry, mock_config_entry.entry_id))
             == 6
         )
-
-        # Remove the Tom/Floor
-        data.devices.pop("1772a4ea304041adb83f357b751341ff")
-        mock_update.return_value = data
-        LOGGER.debug("HOI removing TOM 1772a4ea304041adb83f357b751341ff")
-        async_fire_time_changed(hass, utcnow + timedelta(seconds=65))
-        await hass.async_block_till_done()
-
-        assert (
-            len(er.async_entries_for_config_entry(entity_registry, mock_config_entry.entry_id))
-            == 23
-        )
-        assert (
-            len(dr.async_entries_for_config_entry(device_registry, mock_config_entry.entry_id))
-            == 5
-        )
         item_list: list[str] = []
         for device_entry in list(device_registry.devices.values()):
             item_list.extend(x[1] for x in device_entry.identifiers)