Improve discovery of WMS WebControl pro by updating IP address (#128007)

homeassistant/components/wmspro/config_flow.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+import ipaddress
 import logging
 from typing import Any
 
@@ -38,7 +39,19 @@ class WebControlProConfigFlow(ConfigFlow, domain=DOMAIN):
         """Handle the DHCP discovery step."""
         unique_id = format_mac(discovery_info.macaddress)
         await self.async_set_unique_id(unique_id)
-        self._abort_if_unique_id_configured()
+
+        entry = self.hass.config_entries.async_entry_for_domain_unique_id(
+            DOMAIN, unique_id
+        )
+        if entry:
+            try:  # Check if current host is a valid IP address
+                ipaddress.ip_address(entry.data[CONF_HOST])
+            except ValueError:  # Do not touch name-based host
+                return self.async_abort(reason="already_configured")
+            else:  # Update existing host with new IP address
+                self._abort_if_unique_id_configured(
+                    updates={CONF_HOST: discovery_info.ip}
+                )
 
         for entry in self.hass.config_entries.async_entries(DOMAIN):
             if not entry.unique_id and entry.data[CONF_HOST] in (

tests/components/wmspro/test_config_flow.py

@@ -112,6 +112,96 @@ async def test_config_flow_from_dhcp_add_mac(
     assert hass.config_entries.async_entries(DOMAIN)[0].unique_id == "00:11:22:33:44:55"
 
 
+async def test_config_flow_from_dhcp_ip_update(
+    hass: HomeAssistant,
+    mock_setup_entry: AsyncMock,
+) -> None:
+    """Test we can use DHCP discovery to update IP in a config entry."""
+    info = DhcpServiceInfo(
+        ip="1.2.3.4", hostname="webcontrol", macaddress="00:11:22:33:44:55"
+    )
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": SOURCE_DHCP}, data=info
+    )
+    assert result["type"] is FlowResultType.FORM
+    assert result["errors"] == {}
+
+    with patch(
+        "wmspro.webcontrol.WebControlPro.ping",
+        return_value=True,
+    ):
+        result = await hass.config_entries.flow.async_configure(
+            result["flow_id"],
+            {
+                CONF_HOST: "1.2.3.4",
+            },
+        )
+
+    assert result["type"] is FlowResultType.CREATE_ENTRY
+    assert result["title"] == "1.2.3.4"
+    assert result["data"] == {
+        CONF_HOST: "1.2.3.4",
+    }
+    assert len(mock_setup_entry.mock_calls) == 1
+    assert hass.config_entries.async_entries(DOMAIN)[0].unique_id == "00:11:22:33:44:55"
+
+    info = DhcpServiceInfo(
+        ip="5.6.7.8", hostname="webcontrol", macaddress="00:11:22:33:44:55"
+    )
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": SOURCE_DHCP}, data=info
+    )
+    assert result["type"] is FlowResultType.ABORT
+    assert result["reason"] == "already_configured"
+    assert hass.config_entries.async_entries(DOMAIN)[0].unique_id == "00:11:22:33:44:55"
+    assert hass.config_entries.async_entries(DOMAIN)[0].data[CONF_HOST] == "5.6.7.8"
+
+
+async def test_config_flow_from_dhcp_no_update(
+    hass: HomeAssistant,
+    mock_setup_entry: AsyncMock,
+) -> None:
+    """Test we do not use DHCP discovery to overwrite hostname with IP in config entry."""
+    info = DhcpServiceInfo(
+        ip="1.2.3.4", hostname="webcontrol", macaddress="00:11:22:33:44:55"
+    )
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": SOURCE_DHCP}, data=info
+    )
+    assert result["type"] is FlowResultType.FORM
+    assert result["errors"] == {}
+
+    with patch(
+        "wmspro.webcontrol.WebControlPro.ping",
+        return_value=True,
+    ):
+        result = await hass.config_entries.flow.async_configure(
+            result["flow_id"],
+            {
+                CONF_HOST: "webcontrol",
+            },
+        )
+
+    assert result["type"] is FlowResultType.CREATE_ENTRY
+    assert result["title"] == "webcontrol"
+    assert result["data"] == {
+        CONF_HOST: "webcontrol",
+    }
+    assert len(mock_setup_entry.mock_calls) == 1
+    assert hass.config_entries.async_entries(DOMAIN)[0].unique_id == "00:11:22:33:44:55"
+
+    info = DhcpServiceInfo(
+        ip="5.6.7.8", hostname="webcontrol", macaddress="00:11:22:33:44:55"
+    )
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": SOURCE_DHCP}, data=info
+    )
+    assert result["type"] is FlowResultType.ABORT
+    assert result["reason"] == "already_configured"
+    assert hass.config_entries.async_entries(DOMAIN)[0].unique_id == "00:11:22:33:44:55"
+    assert hass.config_entries.async_entries(DOMAIN)[0].data[CONF_HOST] == "webcontrol"
+
+
 async def test_config_flow_ping_failed(
     hass: HomeAssistant, mock_setup_entry: AsyncMock
 ) -> None: