Add discovery support to steamist (#63707)

tests/components/steamist/test_init.py

@@ -2,18 +2,41 @@
 from __future__ import annotations
 
 import asyncio
-from unittest.mock import patch
+from unittest.mock import AsyncMock, MagicMock, patch
+
+from discovery30303 import AIODiscovery30303
+import pytest
 
 from homeassistant.components import steamist
 from homeassistant.components.steamist.const import DOMAIN
 from homeassistant.config_entries import ConfigEntryState
-from homeassistant.const import CONF_HOST
+from homeassistant.const import CONF_HOST, CONF_NAME
 from homeassistant.core import HomeAssistant
 from homeassistant.setup import async_setup_component
+from homeassistant.util.dt import utcnow
 
-from . import MOCK_ASYNC_GET_STATUS_ACTIVE, _async_setup_entry_with_status
+from . import (
+    DEFAULT_ENTRY_DATA,
+    DEVICE_30303,
+    DEVICE_IP_ADDRESS,
+    DEVICE_NAME,
+    FORMATTED_MAC_ADDRESS,
+    MOCK_ASYNC_GET_STATUS_ACTIVE,
+    _async_setup_entry_with_status,
+    _patch_status,
+)
 
-from tests.common import MockConfigEntry
+from tests.common import MockConfigEntry, async_fire_time_changed
+
+
+@pytest.fixture
+def mock_single_broadcast_address():
+    """Mock network's async_async_get_ipv4_broadcast_addresses."""
+    with patch(
+        "homeassistant.components.network.async_get_ipv4_broadcast_addresses",
+        return_value={"10.255.255.255"},
+    ):
+        yield
 
 
 async def test_config_entry_reload(hass: HomeAssistant) -> None:
@@ -40,3 +63,63 @@ async def test_config_entry_retry_later(hass: HomeAssistant) -> None:
         await async_setup_component(hass, steamist.DOMAIN, {steamist.DOMAIN: {}})
         await hass.async_block_till_done()
     assert config_entry.state == ConfigEntryState.SETUP_RETRY
+
+
+async def test_config_entry_fills_unique_id_with_directed_discovery(
+    hass: HomeAssistant,
+) -> None:
+    """Test that the unique id is added if its missing via directed (not broadcast) discovery."""
+    config_entry = MockConfigEntry(
+        domain=DOMAIN, data={CONF_HOST: DEVICE_IP_ADDRESS}, unique_id=None
+    )
+    config_entry.add_to_hass(hass)
+    last_address = None
+
+    async def _async_scan(*args, address=None, **kwargs):
+        # Only return discovery results when doing directed discovery
+        nonlocal last_address
+        last_address = address
+
+    @property
+    def found_devices(self):
+        nonlocal last_address
+        return [DEVICE_30303] if last_address == DEVICE_IP_ADDRESS else []
+
+    mock_aio_discovery = MagicMock(auto_spec=AIODiscovery30303)
+    mock_aio_discovery.async_scan = _async_scan
+    type(mock_aio_discovery).found_devices = found_devices
+
+    with _patch_status(MOCK_ASYNC_GET_STATUS_ACTIVE), patch(
+        "homeassistant.components.steamist.discovery.AIODiscovery30303",
+        return_value=mock_aio_discovery,
+    ):
+        await async_setup_component(hass, steamist.DOMAIN, {steamist.DOMAIN: {}})
+        await hass.async_block_till_done()
+        assert config_entry.state == ConfigEntryState.LOADED
+
+    assert config_entry.unique_id == FORMATTED_MAC_ADDRESS
+    assert config_entry.data[CONF_NAME] == DEVICE_NAME
+    assert config_entry.title == DEVICE_NAME
+
+
+@pytest.mark.usefixtures("mock_single_broadcast_address")
+async def test_discovery_happens_at_interval(hass: HomeAssistant) -> None:
+    """Test that discovery happens at interval."""
+    config_entry = MockConfigEntry(
+        domain=DOMAIN, data=DEFAULT_ENTRY_DATA, unique_id=FORMATTED_MAC_ADDRESS
+    )
+    config_entry.add_to_hass(hass)
+    mock_aio_discovery = MagicMock(auto_spec=AIODiscovery30303)
+    mock_aio_discovery.async_scan = AsyncMock()
+    with patch(
+        "homeassistant.components.steamist.discovery.AIODiscovery30303",
+        return_value=mock_aio_discovery,
+    ), _patch_status(MOCK_ASYNC_GET_STATUS_ACTIVE):
+        await async_setup_component(hass, steamist.DOMAIN, {steamist.DOMAIN: {}})
+        await hass.async_block_till_done()
+
+        assert len(mock_aio_discovery.async_scan.mock_calls) == 2
+
+        async_fire_time_changed(hass, utcnow() + steamist.DISCOVERY_INTERVAL)
+        await hass.async_block_till_done()
+        assert len(mock_aio_discovery.async_scan.mock_calls) == 3