Fix Hue homekit discovery (#37694)

Co-authored-by: Franck Nijhof <git@frenck.dev>

tests/components/hue/test_init.py

@@ -1,11 +1,23 @@
 """Test Hue setup process."""
 from unittest.mock import Mock
 
+import pytest
+
+from homeassistant import config_entries
 from homeassistant.components import hue
 from homeassistant.setup import async_setup_component
 
 from tests.async_mock import AsyncMock, patch
-from tests.common import MockConfigEntry, mock_coro
+from tests.common import MockConfigEntry
+
+
+@pytest.fixture
+def mock_bridge_setup():
+    """Mock bridge setup."""
+    with patch.object(hue, "HueBridge") as mock_bridge:
+        mock_bridge.return_value.async_setup = AsyncMock(return_value=True)
+        mock_bridge.return_value.api.config = Mock(bridgeid="mock-id")
+        yield mock_bridge.return_value
 
 
 async def test_setup_with_no_config(hass):
@@ -23,7 +35,7 @@ async def test_setup_defined_hosts_known_auth(hass):
     """Test we don't initiate a config entry if config bridge is known."""
     MockConfigEntry(domain="hue", data={"host": "0.0.0.0"}).add_to_hass(hass)
 
-    with patch.object(hue, "async_setup_entry", return_value=mock_coro(True)):
+    with patch.object(hue, "async_setup_entry", return_value=True):
         assert (
             await async_setup_component(
                 hass,
@@ -143,43 +155,71 @@ async def test_config_passed_to_config_entry(hass):
     }
 
 
-async def test_unload_entry(hass):
+async def test_unload_entry(hass, mock_bridge_setup):
     """Test being able to unload an entry."""
     entry = MockConfigEntry(domain=hue.DOMAIN, data={"host": "0.0.0.0"})
     entry.add_to_hass(hass)
 
-    with patch.object(hue, "HueBridge") as mock_bridge, patch(
-        "homeassistant.helpers.device_registry.async_get_registry",
-        return_value=mock_coro(Mock()),
-    ):
-        mock_bridge.return_value.async_setup = AsyncMock(return_value=True)
-        mock_bridge.return_value.api.config = Mock(bridgeid="aabbccddeeff")
-        assert await async_setup_component(hass, hue.DOMAIN, {}) is True
+    assert await async_setup_component(hass, hue.DOMAIN, {}) is True
+    assert len(mock_bridge_setup.mock_calls) == 1
 
-    assert len(mock_bridge.return_value.mock_calls) == 1
-
-    mock_bridge.return_value.async_reset = AsyncMock(return_value=True)
+    mock_bridge_setup.async_reset = AsyncMock(return_value=True)
     assert await hue.async_unload_entry(hass, entry)
-    assert len(mock_bridge.return_value.async_reset.mock_calls) == 1
+    assert len(mock_bridge_setup.async_reset.mock_calls) == 1
     assert hass.data[hue.DOMAIN] == {}
 
 
-async def test_setting_unique_id(hass):
+async def test_setting_unique_id(hass, mock_bridge_setup):
     """Test we set unique ID if not set yet."""
     entry = MockConfigEntry(domain=hue.DOMAIN, data={"host": "0.0.0.0"})
     entry.add_to_hass(hass)
-
-    with patch.object(hue, "HueBridge") as mock_bridge, patch(
-        "homeassistant.helpers.device_registry.async_get_registry",
-        return_value=mock_coro(Mock()),
-    ):
-        mock_bridge.return_value.async_setup = AsyncMock(return_value=True)
-        mock_bridge.return_value.api.config = Mock(bridgeid="mock-id")
-        assert await async_setup_component(hass, hue.DOMAIN, {}) is True
-
+    assert await async_setup_component(hass, hue.DOMAIN, {}) is True
     assert entry.unique_id == "mock-id"
 
 
+async def test_fixing_unique_id_no_other(hass, mock_bridge_setup):
+    """Test we set unique ID if not set yet."""
+    entry = MockConfigEntry(
+        domain=hue.DOMAIN, data={"host": "0.0.0.0"}, unique_id="invalid-id"
+    )
+    entry.add_to_hass(hass)
+    assert await async_setup_component(hass, hue.DOMAIN, {}) is True
+    assert entry.unique_id == "mock-id"
+
+
+async def test_fixing_unique_id_other_ignored(hass, mock_bridge_setup):
+    """Test we set unique ID if not set yet."""
+    MockConfigEntry(
+        domain=hue.DOMAIN,
+        data={"host": "0.0.0.0"},
+        unique_id="mock-id",
+        source=config_entries.SOURCE_IGNORE,
+    ).add_to_hass(hass)
+    entry = MockConfigEntry(
+        domain=hue.DOMAIN, data={"host": "0.0.0.0"}, unique_id="invalid-id",
+    )
+    entry.add_to_hass(hass)
+    assert await async_setup_component(hass, hue.DOMAIN, {}) is True
+    await hass.async_block_till_done()
+    assert entry.unique_id == "mock-id"
+    assert hass.config_entries.async_entries() == [entry]
+
+
+async def test_fixing_unique_id_other_correct(hass, mock_bridge_setup):
+    """Test we remove config entry if another one has correct ID."""
+    correct_entry = MockConfigEntry(
+        domain=hue.DOMAIN, data={"host": "0.0.0.0"}, unique_id="mock-id",
+    )
+    correct_entry.add_to_hass(hass)
+    entry = MockConfigEntry(
+        domain=hue.DOMAIN, data={"host": "0.0.0.0"}, unique_id="invalid-id",
+    )
+    entry.add_to_hass(hass)
+    assert await async_setup_component(hass, hue.DOMAIN, {}) is True
+    await hass.async_block_till_done()
+    assert hass.config_entries.async_entries() == [correct_entry]
+
+
 async def test_security_vuln_check(hass):
     """Test that we report security vulnerabilities."""
     assert await async_setup_component(hass, "persistent_notification", {})