Fix duplicated IP port usage in Govee Light Local (home-assistant#152087)

Author: abmantis

homeassistant/components/govee_light_local/__init__.py

@@ -26,16 +26,11 @@
 async def async_setup_entry(hass: HomeAssistant, entry: GoveeLocalConfigEntry) -> bool:
     """Set up Govee light local from a config entry."""
 
-    # Get source IPs for all enabled adapters
-    source_ips = await network.async_get_enabled_source_ips(hass)
+    source_ips = await async_get_source_ips(hass)
     _LOGGER.debug("Enabled source IPs: %s", source_ips)
 
     coordinator: GoveeLocalApiCoordinator = GoveeLocalApiCoordinator(
-        hass=hass,
-        config_entry=entry,
-        source_ips=[
-            source_ip for source_ip in source_ips if isinstance(source_ip, IPv4Address)
-        ],
+        hass=hass, config_entry=entry, source_ips=source_ips
     )
 
     async def await_cleanup():
@@ -76,3 +71,13 @@ async def await_cleanup():
 async def async_unload_entry(hass: HomeAssistant, entry: GoveeLocalConfigEntry) -> bool:
     """Unload a config entry."""
     return await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
+
+
+async def async_get_source_ips(
+    hass: HomeAssistant,
+) -> set[str]:
+    """Get the source ips for Govee local."""
+    source_ips = await network.async_get_enabled_source_ips(hass)
+    return {
+        str(source_ip) for source_ip in source_ips if isinstance(source_ip, IPv4Address)
+    }

homeassistant/components/govee_light_local/config_flow.py

@@ -4,15 +4,14 @@
 
 import asyncio
 from contextlib import suppress
-from ipaddress import IPv4Address
 import logging
 
 from govee_local_api import GoveeController
 
-from homeassistant.components import network
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers import config_entry_flow
 
+from . import async_get_source_ips
 from .const import (
     CONF_LISTENING_PORT_DEFAULT,
     CONF_MULTICAST_ADDRESS_DEFAULT,
@@ -24,11 +23,11 @@
 _LOGGER = logging.getLogger(__name__)
 
 
-async def _async_discover(hass: HomeAssistant, adapter_ip: IPv4Address) -> bool:
+async def _async_discover(hass: HomeAssistant, adapter_ip: str) -> bool:
     controller: GoveeController = GoveeController(
         loop=hass.loop,
         logger=_LOGGER,
-        listening_address=str(adapter_ip),
+        listening_address=adapter_ip,
         broadcast_address=CONF_MULTICAST_ADDRESS_DEFAULT,
         broadcast_port=CONF_TARGET_PORT_DEFAULT,
         listening_port=CONF_LISTENING_PORT_DEFAULT,
@@ -62,14 +61,8 @@ async def _async_discover(hass: HomeAssistant, adapter_ip: IPv4Address) -> bool:
 async def _async_has_devices(hass: HomeAssistant) -> bool:
     """Return if there are devices that can be discovered."""
 
-    # Get source IPs for all enabled adapters
-    source_ips = await network.async_get_enabled_source_ips(hass)
-    _LOGGER.debug("Enabled source IPs: %s", source_ips)
-
-    # Run discovery on every IPv4 address and gather results
-    results = await asyncio.gather(
-        *[_async_discover(hass, ip) for ip in source_ips if isinstance(ip, IPv4Address)]
-    )
+    source_ips = await async_get_source_ips(hass)
+    results = await asyncio.gather(*[_async_discover(hass, ip) for ip in source_ips])
 
     return any(results)
 

homeassistant/components/govee_light_local/coordinator.py

@@ -2,7 +2,6 @@
 
 import asyncio
 from collections.abc import Callable
-from ipaddress import IPv4Address
 import logging
 
 from govee_local_api import GoveeController, GoveeDevice
@@ -30,7 +29,7 @@ def __init__(
         self,
         hass: HomeAssistant,
         config_entry: GoveeLocalConfigEntry,
-        source_ips: list[IPv4Address],
+        source_ips: set[str],
     ) -> None:
         """Initialize my coordinator."""
         super().__init__(
@@ -45,7 +44,7 @@ def __init__(
             GoveeController(
                 loop=hass.loop,
                 logger=_LOGGER,
-                listening_address=str(source_ip),
+                listening_address=source_ip,
                 broadcast_address=CONF_MULTICAST_ADDRESS_DEFAULT,
                 broadcast_port=CONF_TARGET_PORT_DEFAULT,
                 listening_port=CONF_LISTENING_PORT_DEFAULT,

tests/components/govee_light_local/test_config_flow.py

@@ -1,6 +1,7 @@
 """Test Govee light local config flow."""
 
 from errno import EADDRINUSE
+from ipaddress import IPv4Address
 from unittest.mock import AsyncMock, patch
 
 from govee_local_api import GoveeDevice
@@ -61,17 +62,22 @@ async def test_creating_entry_has_with_devices(
 
     mock_govee_api.devices = _get_devices(mock_govee_api)
 
-    result = await hass.config_entries.flow.async_init(
-        DOMAIN, context={"source": config_entries.SOURCE_USER}
-    )
+    # Mock duplicated IPs to ensure that only one GoveeController is started
+    with patch(
+        "homeassistant.components.network.async_get_enabled_source_ips",
+        return_value=[IPv4Address("192.168.1.2"), IPv4Address("192.168.1.2")],
+    ):
+        result = await hass.config_entries.flow.async_init(
+            DOMAIN, context={"source": config_entries.SOURCE_USER}
+        )
 
-    # Confirmation form
-    assert result["type"] is FlowResultType.FORM
+        # Confirmation form
+        assert result["type"] is FlowResultType.FORM
 
-    result = await hass.config_entries.flow.async_configure(result["flow_id"], {})
-    assert result["type"] is FlowResultType.CREATE_ENTRY
+        result = await hass.config_entries.flow.async_configure(result["flow_id"], {})
+        assert result["type"] is FlowResultType.CREATE_ENTRY
 
-    await hass.async_block_till_done()
+        await hass.async_block_till_done()
 
     mock_govee_api.start.assert_awaited_once()
     mock_setup_entry.assert_awaited_once()