Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do not unsubscribe mqtt integration discovery if entry is already configured #126907

Merged
merged 4 commits into from
Sep 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions homeassistant/components/mqtt/discovery.py
Original file line number Diff line number Diff line change
Expand Up @@ -393,8 +393,7 @@ async def async_integration_message_received(
if (
result
and result["type"] == FlowResultType.ABORT
and result["reason"]
in ("already_configured", "single_instance_allowed")
and result["reason"] == "single_instance_allowed"
):
integration_unsubscribe.pop(key)()

Expand Down
37 changes: 24 additions & 13 deletions tests/components/mqtt/test_discovery.py
Original file line number Diff line number Diff line change
Expand Up @@ -1444,8 +1444,19 @@ async def test_complex_discovery_topic_prefix(
@patch("homeassistant.components.mqtt.client.INITIAL_SUBSCRIBE_COOLDOWN", 0.0)
@patch("homeassistant.components.mqtt.client.SUBSCRIBE_COOLDOWN", 0.0)
@patch("homeassistant.components.mqtt.client.UNSUBSCRIBE_COOLDOWN", 0.0)
@pytest.mark.parametrize(
("reason", "unsubscribes"),
[
("single_instance_allowed", True),
("already_configured", False),
("some_abort_error", False),
],
)
async def test_mqtt_integration_discovery_subscribe_unsubscribe(
hass: HomeAssistant, mqtt_client_mock: MqttMockPahoClient
hass: HomeAssistant,
mqtt_client_mock: MqttMockPahoClient,
reason: str,
unsubscribes: bool,
) -> None:
"""Check MQTT integration discovery subscribe and unsubscribe."""

Expand All @@ -1454,7 +1465,7 @@ class TestFlow(config_entries.ConfigFlow):

async def async_step_mqtt(self, discovery_info: MqttServiceInfo) -> FlowResult:
"""Test mqtt step."""
return self.async_abort(reason="already_configured")
return self.async_abort(reason=reason)

mock_platform(hass, "comp.config_flow", None)

Expand All @@ -1465,13 +1476,6 @@ def wait_birth(msg: ReceiveMessage) -> None:
"""Handle birth message."""
birth.set()

wait_unsub = asyncio.Event()

@callback
def _mock_unsubscribe(topics: list[str]) -> tuple[int, int]:
wait_unsub.set()
return (0, 0)

entry = MockConfigEntry(domain=mqtt.DOMAIN, data=ENTRY_DEFAULT_BIRTH_MESSAGE)
entry.add_to_hass(hass)
with (
Expand All @@ -1480,7 +1484,6 @@ def _mock_unsubscribe(topics: list[str]) -> tuple[int, int]:
return_value={"comp": ["comp/discovery/#"]},
),
mock_config_flow("comp", TestFlow),
patch.object(mqtt_client_mock, "unsubscribe", side_effect=_mock_unsubscribe),
):
assert await hass.config_entries.async_setup(entry.entry_id)
await mqtt.async_subscribe(hass, "homeassistant/status", wait_birth)
Expand All @@ -1493,8 +1496,16 @@ def _mock_unsubscribe(topics: list[str]) -> tuple[int, int]:

await hass.async_block_till_done(wait_background_tasks=True)
async_fire_mqtt_message(hass, "comp/discovery/bla/config", "")
await wait_unsub.wait()
mqtt_client_mock.unsubscribe.assert_called_once_with(["comp/discovery/#"])
await hass.async_block_till_done()
await hass.async_block_till_done(wait_background_tasks=True)

assert (
unsubscribes
and call(["comp/discovery/#"]) in mqtt_client_mock.unsubscribe.mock_calls
or not unsubscribes
and call(["comp/discovery/#"])
not in mqtt_client_mock.unsubscribe.mock_calls
)
await hass.async_block_till_done(wait_background_tasks=True)


Expand All @@ -1513,7 +1524,7 @@ class TestFlow(config_entries.ConfigFlow):
async def async_step_mqtt(self, discovery_info: MqttServiceInfo) -> FlowResult:
"""Test mqtt step."""
await asyncio.sleep(0)
return self.async_abort(reason="already_configured")
return self.async_abort(reason="single_instance_allowed")

mock_platform(hass, "comp.config_flow", None)

Expand Down