Refactor Velux integration to use runtime_data (#155207)

Author: wollew

homeassistant/components/velux/__init__.py

@@ -8,19 +8,38 @@
 
 from .const import DOMAIN, LOGGER, PLATFORMS
 
+type VeluxConfigEntry = ConfigEntry[PyVLX]
+
 
 async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     """Set up the velux component."""
-    module = VeluxModule(hass, entry.data)
-    try:
-        module.setup()
-        await module.async_start()
+    host = entry.data[CONF_HOST]
+    password = entry.data[CONF_PASSWORD]
+    pyvlx = PyVLX(host=host, password=password)
 
+    LOGGER.debug("Velux interface started")
+    try:
+        await pyvlx.load_scenes()
+        await pyvlx.load_nodes()
     except PyVLXException as ex:
         LOGGER.exception("Can't connect to velux interface: %s", ex)
         return False
 
-    hass.data.setdefault(DOMAIN, {})[entry.entry_id] = module
+    entry.runtime_data = pyvlx
+
+    async def on_hass_stop(event):
+        """Close connection when hass stops."""
+        LOGGER.debug("Velux interface terminated")
+        await pyvlx.disconnect()
+
+    async def async_reboot_gateway(service_call: ServiceCall) -> None:
+        await pyvlx.reboot_gateway()
+
+    entry.async_on_unload(
+        hass.bus.async_listen_once(EVENT_HOMEASSISTANT_STOP, on_hass_stop)
+    )
+
+    hass.services.async_register(DOMAIN, "reboot_gateway", async_reboot_gateway)
 
     await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
 
@@ -30,39 +49,3 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
 async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     """Unload a config entry."""
     return await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
-
-
-class VeluxModule:
-    """Abstraction for velux component."""
-
-    def __init__(self, hass, domain_config):
-        """Initialize for velux component."""
-        self.pyvlx = None
-        self._hass = hass
-        self._domain_config = domain_config
-
-    def setup(self):
-        """Velux component setup."""
-
-        async def on_hass_stop(event):
-            """Close connection when hass stops."""
-            LOGGER.debug("Velux interface terminated")
-            await self.pyvlx.disconnect()
-
-        async def async_reboot_gateway(service_call: ServiceCall) -> None:
-            await self.pyvlx.reboot_gateway()
-
-        self._hass.bus.async_listen_once(EVENT_HOMEASSISTANT_STOP, on_hass_stop)
-        host = self._domain_config.get(CONF_HOST)
-        password = self._domain_config.get(CONF_PASSWORD)
-        self.pyvlx = PyVLX(host=host, password=password)
-
-        self._hass.services.async_register(
-            DOMAIN, "reboot_gateway", async_reboot_gateway
-        )
-
-    async def async_start(self):
-        """Start velux component."""
-        LOGGER.debug("Velux interface started")
-        await self.pyvlx.load_scenes()
-        await self.pyvlx.load_nodes()

homeassistant/components/velux/binary_sensor.py

@@ -11,11 +11,11 @@
     BinarySensorDeviceClass,
     BinarySensorEntity,
 )
-from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
-from .const import DOMAIN, LOGGER
+from . import VeluxConfigEntry
+from .const import LOGGER
 from .entity import VeluxEntity
 
 PARALLEL_UPDATES = 1
@@ -24,15 +24,15 @@
 
 async def async_setup_entry(
     hass: HomeAssistant,
-    config: ConfigEntry,
+    config: VeluxConfigEntry,
     async_add_entities: AddConfigEntryEntitiesCallback,
 ) -> None:
     """Set up rain sensor(s) for Velux platform."""
-    module = hass.data[DOMAIN][config.entry_id]
+    pyvlx = config.runtime_data
 
     async_add_entities(
         VeluxRainSensor(node, config.entry_id)
-        for node in module.pyvlx.nodes
+        for node in pyvlx.nodes
         if isinstance(node, Window) and node.rain_sensor
     )
 

homeassistant/components/velux/cover.py

@@ -21,26 +21,25 @@
     CoverEntity,
     CoverEntityFeature,
 )
-from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
-from .const import DOMAIN
+from . import VeluxConfigEntry
 from .entity import VeluxEntity
 
 PARALLEL_UPDATES = 1
 
 
 async def async_setup_entry(
     hass: HomeAssistant,
-    config: ConfigEntry,
+    config: VeluxConfigEntry,
     async_add_entities: AddConfigEntryEntitiesCallback,
 ) -> None:
     """Set up cover(s) for Velux platform."""
-    module = hass.data[DOMAIN][config.entry_id]
+    pyvlx = config.runtime_data
     async_add_entities(
         VeluxCover(node, config.entry_id)
-        for node in module.pyvlx.nodes
+        for node in pyvlx.nodes
         if isinstance(node, OpeningDevice)
     )
 

homeassistant/components/velux/light.py

@@ -7,27 +7,25 @@
 from pyvlx import Intensity, LighteningDevice
 
 from homeassistant.components.light import ATTR_BRIGHTNESS, ColorMode, LightEntity
-from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
-from .const import DOMAIN
+from . import VeluxConfigEntry
 from .entity import VeluxEntity
 
 PARALLEL_UPDATES = 1
 
 
 async def async_setup_entry(
     hass: HomeAssistant,
-    config: ConfigEntry,
+    config: VeluxConfigEntry,
     async_add_entities: AddConfigEntryEntitiesCallback,
 ) -> None:
     """Set up light(s) for Velux platform."""
-    module = hass.data[DOMAIN][config.entry_id]
-
+    pyvlx = config.runtime_data
     async_add_entities(
         VeluxLight(node, config.entry_id)
-        for node in module.pyvlx.nodes
+        for node in pyvlx.nodes
         if isinstance(node, LighteningDevice)
     )
 

homeassistant/components/velux/scene.py

@@ -5,24 +5,23 @@
 from typing import Any
 
 from homeassistant.components.scene import Scene
-from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
-from .const import DOMAIN
+from . import VeluxConfigEntry
 
 PARALLEL_UPDATES = 1
 
 
 async def async_setup_entry(
     hass: HomeAssistant,
-    config: ConfigEntry,
+    config: VeluxConfigEntry,
     async_add_entities: AddConfigEntryEntitiesCallback,
 ) -> None:
     """Set up the scenes for Velux platform."""
-    module = hass.data[DOMAIN][config.entry_id]
+    pyvlx = config.runtime_data
 
-    entities = [VeluxScene(scene) for scene in module.pyvlx.scenes]
+    entities = [VeluxScene(scene) for scene in pyvlx.scenes]
     async_add_entities(entities)
 
 

tests/components/velux/conftest.py

@@ -79,28 +79,16 @@ def mock_window() -> AsyncMock:
 
 
 @pytest.fixture
-def mock_pyvlx(mock_window: MagicMock) -> MagicMock:
-    """Create the library mock."""
+def mock_pyvlx(mock_window: MagicMock) -> Generator[MagicMock]:
+    """Create the library mock and patch PyVLX."""
     pyvlx = MagicMock()
     pyvlx.nodes = [mock_window]
     pyvlx.load_scenes = AsyncMock()
     pyvlx.load_nodes = AsyncMock()
     pyvlx.disconnect = AsyncMock()
-    return pyvlx
 
-
-@pytest.fixture
-def mock_module(mock_pyvlx: MagicMock) -> Generator[AsyncMock]:
-    """Create the Velux module mock."""
-    with (
-        patch(
-            "homeassistant.components.velux.VeluxModule",
-            autospec=True,
-        ) as mock_velux,
-    ):
-        module = mock_velux.return_value
-        module.pyvlx = mock_pyvlx
-        yield module
+    with patch("homeassistant.components.velux.PyVLX", return_value=pyvlx):
+        yield pyvlx
 
 
 @pytest.fixture

tests/components/velux/test_binary_sensor.py

@@ -16,7 +16,7 @@
 
 
 @pytest.mark.usefixtures("entity_registry_enabled_by_default")
-@pytest.mark.usefixtures("mock_module")
+@pytest.mark.usefixtures("mock_pyvlx")
 async def test_rain_sensor_state(
     hass: HomeAssistant,
     mock_window: MagicMock,
@@ -62,7 +62,7 @@ async def test_rain_sensor_state(
 
 
 @pytest.mark.usefixtures("entity_registry_enabled_by_default")
-@pytest.mark.usefixtures("mock_module")
+@pytest.mark.usefixtures("mock_pyvlx")
 async def test_rain_sensor_device_association(
     hass: HomeAssistant,
     mock_window: MagicMock,

tests/components/velux/test_cover.py

@@ -13,7 +13,7 @@
 from tests.common import MockConfigEntry
 
 
-@pytest.mark.usefixtures("mock_module")
+@pytest.mark.usefixtures("mock_pyvlx")
 async def test_cover_closed(
     hass: HomeAssistant,
     mock_window: AsyncMock,