fix(esphome): polish unreachable reconfigure confirmation

Author: Komzpa

homeassistant/components/esphome/config_flow.py

@@ -2,6 +2,7 @@
 
 from collections import OrderedDict
 from collections.abc import Mapping
+from ipaddress import IPv6Address, ip_address
 import json
 import logging
 from typing import Any, cast
@@ -69,6 +70,17 @@
 DEFAULT_NAME = "ESPHome"
 
 
+def _format_host_for_display(host: str) -> str:
+    """Return host formatted for host:port display."""
+    try:
+        address = ip_address(host)
+    except ValueError:
+        return host
+    if isinstance(address, IPv6Address):
+        return f"[{host}]"
+    return host
+
+
 class EsphomeFlowHandler(ConfigFlow, domain=DOMAIN):
     """Handle a esphome config flow."""
 
@@ -272,14 +284,14 @@ async def _async_try_fetch_device_info(self) -> ConfigFlowResult:
             if (
                 self.source == SOURCE_RECONFIGURE
                 and response in ("connection_error", "resolve_error")
-                and self._async_reconfigure_host_changed()
+                and self._async_reconfigure_connection_changed()
             ):
                 return await self.async_step_reconfigure_confirm_unreachable()
             return await self._async_step_user_base(error=response)
         return await self._async_authenticate_or_add()
 
     @callback
-    def _async_reconfigure_host_changed(self) -> bool:
+    def _async_reconfigure_connection_changed(self) -> bool:
         """Return if the reconfigure flow has a new host or port."""
         assert self._host is not None
         assert self._port is not None
@@ -307,11 +319,9 @@ async def async_step_reconfigure_confirm_unreachable(
         return self.async_show_form(
             step_id="reconfigure_confirm_unreachable",
             description_placeholders={
-                "host": self._host,
-                "name": self._reconfig_entry.data.get(
-                    CONF_DEVICE_NAME, self._reconfig_entry.title
-                ),
-                "port": self._port,
+                "host": _format_host_for_display(self._host),
+                "name": self._async_get_human_readable_name(),
+                "port": str(self._port),
             },
         )
 

tests/components/esphome/test_config_flow.py

@@ -2391,12 +2391,24 @@ async def test_reconfig_success_with_new_ip_same_name(
 
 
 @pytest.mark.usefixtures("mock_zeroconf", "mock_setup_entry")
-async def test_reconfig_can_save_changed_unreachable_host(
-    hass: HomeAssistant, mock_client: APIClient
+@pytest.mark.parametrize(
+    ("host", "error", "placeholder_host"),
+    [
+        ("127.0.0.2", APIConnectionError, "127.0.0.2"),
+        ("2001:db8::2", ResolveAPIError, "[2001:db8::2]"),
+    ],
+)
+async def test_reconfig_can_save_changed_unreachable_connection(
+    hass: HomeAssistant,
+    mock_client: APIClient,
+    host: str,
+    error: type[Exception],
+    placeholder_host: str,
 ) -> None:
-    """Test reconfig can save a changed host when the device is unreachable."""
+    """Test reconfig can save changed connection details when unreachable."""
     entry = MockConfigEntry(
         domain=DOMAIN,
+        title="Kitchen Sensor",
         data={
             CONF_HOST: "127.0.0.1",
             CONF_PORT: 6053,
@@ -2410,17 +2422,17 @@ async def test_reconfig_can_save_changed_unreachable_host(
 
     result = await entry.start_reconfigure_flow(hass)
 
-    mock_client.device_info.side_effect = APIConnectionError
+    mock_client.device_info.side_effect = error
     result = await hass.config_entries.flow.async_configure(
-        result["flow_id"], user_input={CONF_HOST: "127.0.0.2", CONF_PORT: 6053}
+        result["flow_id"], user_input={CONF_HOST: host, CONF_PORT: 6053}
     )
 
     assert result["type"] is FlowResultType.FORM
     assert result["step_id"] == "reconfigure_confirm_unreachable"
     assert result["description_placeholders"] == {
-        "host": "127.0.0.2",
-        "name": "test",
-        "port": 6053,
+        "host": placeholder_host,
+        "name": "Kitchen Sensor",
+        "port": "6053",
     }
     assert entry.data[CONF_HOST] == "127.0.0.1"
 
@@ -2431,7 +2443,7 @@ async def test_reconfig_can_save_changed_unreachable_host(
     assert result["type"] is FlowResultType.ABORT
     assert result["reason"] == "reconfigure_successful"
     assert entry.data == {
-        CONF_HOST: "127.0.0.2",
+        CONF_HOST: host,
         CONF_PORT: 6053,
         CONF_PASSWORD: "",
         CONF_DEVICE_NAME: "test",