Add reboot button to velux gateway device (home-assistant#155547)

Co-authored-by: Joost Lekkerkerker <[email protected]>

Author: wollew

homeassistant/components/velux/button.py

@@ -0,0 +1,52 @@
+"""Support for VELUX KLF 200 gateway button."""
+
+from __future__ import annotations
+
+from pyvlx import PyVLX, PyVLXException
+
+from homeassistant.components.button import ButtonDeviceClass, ButtonEntity
+from homeassistant.const import EntityCategory
+from homeassistant.core import HomeAssistant
+from homeassistant.exceptions import HomeAssistantError
+from homeassistant.helpers.device_registry import DeviceInfo
+from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
+
+from . import VeluxConfigEntry
+from .const import DOMAIN
+
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    config_entry: VeluxConfigEntry,
+    async_add_entities: AddConfigEntryEntitiesCallback,
+) -> None:
+    """Set up button entities for the Velux integration."""
+    async_add_entities(
+        [VeluxGatewayRebootButton(config_entry.entry_id, config_entry.runtime_data)]
+    )
+
+
+class VeluxGatewayRebootButton(ButtonEntity):
+    """Representation of the Velux Gateway reboot button."""
+
+    _attr_has_entity_name = True
+    _attr_device_class = ButtonDeviceClass.RESTART
+    _attr_entity_category = EntityCategory.CONFIG
+
+    def __init__(self, config_entry_id: str, pyvlx: PyVLX) -> None:
+        """Initialize the gateway reboot button."""
+        self.pyvlx = pyvlx
+        self._attr_unique_id = f"{config_entry_id}_reboot-gateway"
+        self._attr_device_info = DeviceInfo(
+            identifiers={(DOMAIN, f"gateway_{config_entry_id}")},
+        )
+
+    async def async_press(self) -> None:
+        """Handle the button press - reboot the gateway."""
+        try:
+            await self.pyvlx.reboot_gateway()
+        except PyVLXException as ex:
+            raise HomeAssistantError(
+                translation_domain=DOMAIN,
+                translation_key="reboot_failed",
+            ) from ex

homeassistant/components/velux/const.py

@@ -5,5 +5,11 @@
 from homeassistant.const import Platform
 
 DOMAIN = "velux"
-PLATFORMS = [Platform.BINARY_SENSOR, Platform.COVER, Platform.LIGHT, Platform.SCENE]
+PLATFORMS = [
+    Platform.BINARY_SENSOR,
+    Platform.BUTTON,
+    Platform.COVER,
+    Platform.LIGHT,
+    Platform.SCENE,
+]
 LOGGER = getLogger(__package__)

homeassistant/components/velux/strings.json

@@ -36,9 +36,14 @@
       }
     }
   },
+  "exceptions": {
+    "reboot_failed": {
+      "message": "Failed to reboot gateway. Try again in a few moments or power cycle the device manually"
+    }
+  },
   "services": {
     "reboot_gateway": {
-      "description": "Reboots the KLF200 Gateway.",
+      "description": "Reboots the KLF200 Gateway",
       "name": "Reboot gateway"
     }
   }

tests/components/velux/conftest.py

@@ -107,6 +107,7 @@ def mock_pyvlx(mock_window: MagicMock, mock_light: MagicMock) -> Generator[Magic
 def mock_config_entry() -> MockConfigEntry:
     """Return a mock config entry."""
     return MockConfigEntry(
+        entry_id="test_entry_id",
         domain=DOMAIN,
         data={
             CONF_HOST: "testhost",

tests/components/velux/snapshots/test_button.ambr

@@ -0,0 +1,50 @@
+# serializer version: 1
+# name: test_button_snapshot[button.klf_200_gateway_restart-entry]
+  EntityRegistryEntrySnapshot({
+    'aliases': set({
+    }),
+    'area_id': None,
+    'capabilities': None,
+    'config_entry_id': <ANY>,
+    'config_subentry_id': <ANY>,
+    'device_class': None,
+    'device_id': <ANY>,
+    'disabled_by': None,
+    'domain': 'button',
+    'entity_category': <EntityCategory.CONFIG: 'config'>,
+    'entity_id': 'button.klf_200_gateway_restart',
+    'has_entity_name': True,
+    'hidden_by': None,
+    'icon': None,
+    'id': <ANY>,
+    'labels': set({
+    }),
+    'name': None,
+    'options': dict({
+    }),
+    'original_device_class': <ButtonDeviceClass.RESTART: 'restart'>,
+    'original_icon': None,
+    'original_name': 'Restart',
+    'platform': 'velux',
+    'previous_unique_id': None,
+    'suggested_object_id': None,
+    'supported_features': 0,
+    'translation_key': None,
+    'unique_id': 'test_entry_id_reboot-gateway',
+    'unit_of_measurement': None,
+  })
+# ---
+# name: test_button_snapshot[button.klf_200_gateway_restart-state]
+  StateSnapshot({
+    'attributes': ReadOnlyDict({
+      'device_class': 'restart',
+      'friendly_name': 'KLF 200 Gateway Restart',
+    }),
+    'context': <ANY>,
+    'entity_id': 'button.klf_200_gateway_restart',
+    'last_changed': <ANY>,
+    'last_reported': <ANY>,
+    'last_updated': <ANY>,
+    'state': 'unknown',
+  })
+# ---

tests/components/velux/test_button.py

@@ -0,0 +1,100 @@
+"""Test Velux button entities."""
+
+from unittest.mock import AsyncMock, MagicMock
+
+import pytest
+from pyvlx import PyVLXException
+from syrupy.assertion import SnapshotAssertion
+
+from homeassistant.components.button import DOMAIN as BUTTON_DOMAIN, SERVICE_PRESS
+from homeassistant.components.velux import DOMAIN
+from homeassistant.const import ATTR_ENTITY_ID, Platform
+from homeassistant.core import HomeAssistant
+from homeassistant.exceptions import HomeAssistantError
+from homeassistant.helpers import device_registry as dr, entity_registry as er
+
+from tests.common import MockConfigEntry, snapshot_platform
+
+
+@pytest.fixture
+def platform() -> Platform:
+    """Fixture to specify platform to test."""
+    return Platform.BUTTON
+
+
+@pytest.mark.usefixtures("setup_integration")
+async def test_button_snapshot(
+    hass: HomeAssistant,
+    mock_config_entry: MockConfigEntry,
+    entity_registry: er.EntityRegistry,
+    device_registry: dr.DeviceRegistry,
+    snapshot: SnapshotAssertion,
+) -> None:
+    """Snapshot the button entity (registry + state)."""
+    await snapshot_platform(
+        hass,
+        entity_registry,
+        snapshot,
+        mock_config_entry.entry_id,
+    )
+
+    # Get the button entity setup and test device association
+    entity_entries = er.async_entries_for_config_entry(
+        entity_registry, mock_config_entry.entry_id
+    )
+    assert len(entity_entries) == 1
+    entry = entity_entries[0]
+
+    assert entry.device_id is not None
+    device_entry = device_registry.async_get(entry.device_id)
+    assert device_entry is not None
+    assert (DOMAIN, f"gateway_{mock_config_entry.entry_id}") in device_entry.identifiers
+    assert device_entry.via_device_id is None
+
+
+@pytest.mark.usefixtures("setup_integration")
+async def test_button_press_success(
+    hass: HomeAssistant,
+    mock_pyvlx: MagicMock,
+) -> None:
+    """Test successful button press."""
+
+    # Configure the mock method to be async and return a coroutine
+    mock_pyvlx.reboot_gateway.return_value = AsyncMock()()
+
+    # Press the button
+    await hass.services.async_call(
+        BUTTON_DOMAIN,
+        SERVICE_PRESS,
+        {ATTR_ENTITY_ID: "button.klf_200_gateway_restart"},
+        blocking=True,
+    )
+
+    # Verify the reboot method was called
+    mock_pyvlx.reboot_gateway.assert_called_once()
+
+
+@pytest.mark.usefixtures("setup_integration")
+async def test_button_press_failure(
+    hass: HomeAssistant,
+    mock_pyvlx: MagicMock,
+) -> None:
+    """Test button press failure handling."""
+
+    # Mock reboot failure
+    mock_pyvlx.reboot_gateway.side_effect = PyVLXException("Connection failed")
+
+    # Press the button and expect HomeAssistantError
+    with pytest.raises(
+        HomeAssistantError,
+        match="Failed to reboot gateway. Try again in a few moments or power cycle the device manually",
+    ):
+        await hass.services.async_call(
+            BUTTON_DOMAIN,
+            SERVICE_PRESS,
+            {ATTR_ENTITY_ID: "button.klf_200_gateway_restart"},
+            blocking=True,
+        )
+
+    # Verify the reboot method was called
+    mock_pyvlx.reboot_gateway.assert_called_once()