Fix Freebox Home alarm & improve platform tests (home-assistant#103475)

* Fix Freebox Home alarm

* Add trigger feature test & fix

* FreeboxCallSensor: Add test for missing coverage of new call

* Use generator

Co-authored-by: Martin Hjelmare <[email protected]>

* Add test for arm_home feature (questions about the check)

* Stay focus on alam tests

* can_arm_home ==> if _command_arm_home

* Use one liner for supported_features

* Add idle state

* Fix rebase

---------

Co-authored-by: Martin Hjelmare <[email protected]>

Author: Quentame

homeassistant/components/freebox/alarm_control_panel.py

@@ -1,5 +1,4 @@
 """Support for Freebox alarms."""
-import logging
 from typing import Any
 
 from homeassistant.components.alarm_control_panel import (
@@ -9,7 +8,7 @@
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import (
     STATE_ALARM_ARMED_AWAY,
-    STATE_ALARM_ARMED_NIGHT,
+    STATE_ALARM_ARMED_HOME,
     STATE_ALARM_ARMING,
     STATE_ALARM_DISARMED,
     STATE_ALARM_TRIGGERED,
@@ -25,16 +24,14 @@
     "alarm1_arming": STATE_ALARM_ARMING,
     "alarm2_arming": STATE_ALARM_ARMING,
     "alarm1_armed": STATE_ALARM_ARMED_AWAY,
-    "alarm2_armed": STATE_ALARM_ARMED_NIGHT,
+    "alarm2_armed": STATE_ALARM_ARMED_HOME,
     "alarm1_alert_timer": STATE_ALARM_TRIGGERED,
     "alarm2_alert_timer": STATE_ALARM_TRIGGERED,
     "alert": STATE_ALARM_TRIGGERED,
+    "idle": STATE_ALARM_DISARMED,
 }
 
 
-_LOGGER = logging.getLogger(__name__)
-
-
 async def async_setup_entry(
     hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
 ) -> None:
@@ -76,63 +73,33 @@ def __init__(
         self._command_state = self.get_command_id(
             node["type"]["endpoints"], "signal", "state"
         )
-        self._set_features(self._router.home_devices[self._id])
+
+        self._attr_supported_features = (
+            AlarmControlPanelEntityFeature.ARM_AWAY
+            | (AlarmControlPanelEntityFeature.ARM_HOME if self._command_arm_home else 0)
+            | AlarmControlPanelEntityFeature.TRIGGER
+        )
 
     async def async_alarm_disarm(self, code: str | None = None) -> None:
         """Send disarm command."""
-        if await self.set_home_endpoint_value(self._command_disarm):
-            self._set_state(STATE_ALARM_DISARMED)
+        await self.set_home_endpoint_value(self._command_disarm)
 
     async def async_alarm_arm_away(self, code: str | None = None) -> None:
         """Send arm away command."""
-        if await self.set_home_endpoint_value(self._command_arm_away):
-            self._set_state(STATE_ALARM_ARMING)
+        await self.set_home_endpoint_value(self._command_arm_away)
 
     async def async_alarm_arm_home(self, code: str | None = None) -> None:
         """Send arm home command."""
-        if await self.set_home_endpoint_value(self._command_arm_home):
-            self._set_state(STATE_ALARM_ARMING)
+        await self.set_home_endpoint_value(self._command_arm_home)
 
     async def async_alarm_trigger(self, code: str | None = None) -> None:
         """Send alarm trigger command."""
-        if await self.set_home_endpoint_value(self._command_trigger):
-            self._set_state(STATE_ALARM_TRIGGERED)
+        await self.set_home_endpoint_value(self._command_trigger)
 
-    async def async_update_signal(self):
-        """Update signal."""
-        state = await self.get_home_endpoint_value(self._command_state)
+    async def async_update(self) -> None:
+        """Update state."""
+        state: str | None = await self.get_home_endpoint_value(self._command_state)
         if state:
-            self._set_state(state)
-
-    def _set_features(self, node: dict[str, Any]) -> None:
-        """Add alarm features."""
-        # Search if the arm home feature is present => has an "alarm2" endpoint
-        can_arm_home = False
-        for nodeid, local_node in self._router.home_devices.items():
-            if nodeid == local_node["id"]:
-                alarm2 = next(
-                    filter(
-                        lambda x: (x["name"] == "alarm2" and x["ep_type"] == "signal"),
-                        local_node["show_endpoints"],
-                    ),
-                    None,
-                )
-                if alarm2:
-                    can_arm_home = alarm2["value"]
-                    break
-
-        if can_arm_home:
-            self._attr_supported_features = (
-                AlarmControlPanelEntityFeature.ARM_AWAY
-                | AlarmControlPanelEntityFeature.ARM_HOME
-            )
-
+            self._attr_state = FREEBOX_TO_STATUS.get(state)
         else:
-            self._attr_supported_features = AlarmControlPanelEntityFeature.ARM_AWAY
-
-    def _set_state(self, state: str) -> None:
-        """Update state."""
-        self._attr_state = FREEBOX_TO_STATUS.get(state)
-        if not self._attr_state:
-            self._attr_state = STATE_ALARM_DISARMED
-        self.async_write_ha_state()
+            self._attr_state = None

homeassistant/components/freebox/home_base.py

@@ -131,13 +131,14 @@ def remove_signal_update(self, dispacher: Any):
     def get_value(self, ep_type: str, name: str):
         """Get the value."""
         node = next(
-            filter(
-                lambda x: (x["name"] == name and x["ep_type"] == ep_type),
-                self._node["show_endpoints"],
+            (
+                endpoint
+                for endpoint in self._node["show_endpoints"]
+                if endpoint["name"] == name and endpoint["ep_type"] == ep_type
             ),
             None,
         )
-        if not node:
+        if node is None:
             _LOGGER.warning(
                 "The Freebox Home device has no node value for: %s/%s", ep_type, name
             )

tests/components/freebox/conftest.py

@@ -12,13 +12,14 @@
     DATA_CALL_GET_CALLS_LOG,
     DATA_CONNECTION_GET_STATUS,
     DATA_HOME_GET_NODES,
-    DATA_HOME_PIR_GET_VALUES,
+    DATA_HOME_PIR_GET_VALUE,
+    DATA_HOME_SET_VALUE,
     DATA_LAN_GET_HOSTS_LIST,
     DATA_LAN_GET_HOSTS_LIST_MODE_BRIDGE,
     DATA_STORAGE_GET_DISKS,
     DATA_STORAGE_GET_RAIDS,
     DATA_SYSTEM_GET_CONFIG,
-    WIFI_GET_GLOBAL_CONFIG,
+    DATA_WIFI_GET_GLOBAL_CONFIG,
 )
 
 from tests.common import MockConfigEntry
@@ -84,11 +85,16 @@ def mock_router(mock_device_registry_devices):
             return_value=DATA_CONNECTION_GET_STATUS
         )
         # switch
-        instance.wifi.get_global_config = AsyncMock(return_value=WIFI_GET_GLOBAL_CONFIG)
+        instance.wifi.get_global_config = AsyncMock(
+            return_value=DATA_WIFI_GET_GLOBAL_CONFIG
+        )
         # home devices
         instance.home.get_home_nodes = AsyncMock(return_value=DATA_HOME_GET_NODES)
         instance.home.get_home_endpoint_value = AsyncMock(
-            return_value=DATA_HOME_PIR_GET_VALUES
+            return_value=DATA_HOME_PIR_GET_VALUE
+        )
+        instance.home.set_home_endpoint_value = AsyncMock(
+            return_value=DATA_HOME_SET_VALUE
         )
         instance.close = AsyncMock()
         yield service_mock

tests/components/freebox/const.py

@@ -21,7 +21,9 @@
 DATA_STORAGE_GET_RAIDS = load_json_array_fixture("freebox/storage_get_raids.json")
 
 # switch
-WIFI_GET_GLOBAL_CONFIG = load_json_object_fixture("freebox/wifi_get_global_config.json")
+DATA_WIFI_GET_GLOBAL_CONFIG = load_json_object_fixture(
+    "freebox/wifi_get_global_config.json"
+)
 
 # device_tracker
 DATA_LAN_GET_HOSTS_LIST = load_json_array_fixture("freebox/lan_get_hosts_list.json")
@@ -35,10 +37,14 @@
 
 # Home
 # PIR node id 26, endpoint id 6
-DATA_HOME_PIR_GET_VALUES = load_json_object_fixture("freebox/home_pir_get_values.json")
+DATA_HOME_PIR_GET_VALUE = load_json_object_fixture("freebox/home_pir_get_value.json")
 
 # Home
 # ALARM node id 7, endpoint id 11
-DATA_HOME_ALARM_GET_VALUES = load_json_object_fixture(
-    "freebox/home_alarm_get_values.json"
+DATA_HOME_ALARM_GET_VALUE = load_json_object_fixture(
+    "freebox/home_alarm_get_value.json"
 )
+
+# Home
+# Set a node value with success
+DATA_HOME_SET_VALUE = load_json_object_fixture("freebox/home_set_value.json")

tests/components/freebox/fixtures/home_alarm_get_values.json renamed to tests/components/freebox/fixtures/home_alarm_get_value.json

@@ -1,5 +1,5 @@
 {
   "refresh": 2000,
-  "value": "alarm2_armed",
+  "value": "alarm1_armed",
   "value_type": "string"
 }

tests/components/freebox/fixtures/home_pir_get_values.json renamed to tests/components/freebox/fixtures/home_pir_get_value.json

@@ -0,0 +1,3 @@
+{
+  "success": true
+}