Improve error handling in Niko Home Control config flow (home-assistant#154565)

Co-authored-by: Joostlek <[email protected]>

Author: VandeurenGlenn

homeassistant/components/niko_home_control/config_flow.py

@@ -28,9 +28,13 @@ async def test_connection(host: str) -> str | None:
     controller = NHCController(host, 8000)
     try:
         await controller.connect()
-    except Exception:
-        _LOGGER.exception("Unexpected exception")
+    except TimeoutError:
+        return "timeout_connect"
+    except OSError:
         return "cannot_connect"
+    except Exception:
+        _LOGGER.exception("Unexpected exception during connection")
+        return "unknown"
     return None
 
 

homeassistant/components/niko_home_control/strings.json

@@ -5,7 +5,9 @@
       "reconfigure_successful": "[%key:common::config_flow::abort::reconfigure_successful%]"
     },
     "error": {
-      "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]"
+      "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
+      "timeout_connect": "[%key:common::config_flow::error::timeout_connect%]",
+      "unknown": "[%key:common::config_flow::error::unknown%]"
     },
     "step": {
       "reconfigure": {

tests/components/niko_home_control/test_config_flow.py

@@ -1,6 +1,8 @@
 """Test niko_home_control config flow."""
 
-from unittest.mock import AsyncMock, patch
+from unittest.mock import AsyncMock
+
+import pytest
 
 from homeassistant.components.niko_home_control.const import DOMAIN
 from homeassistant.config_entries import SOURCE_USER
@@ -36,34 +38,45 @@ async def test_full_flow(
     assert len(mock_setup_entry.mock_calls) == 1
 
 
-async def test_cannot_connect(hass: HomeAssistant) -> None:
-    """Test the cannot connect error."""
+@pytest.mark.parametrize(
+    ("exception", "error"),
+    [
+        (TimeoutError, "timeout_connect"),
+        (OSError, "cannot_connect"),
+        (Exception, "unknown"),
+    ],
+)
+async def test_flow_errors(
+    hass: HomeAssistant,
+    mock_niko_home_control_connection: AsyncMock,
+    mock_setup_entry: AsyncMock,
+    exception: Exception,
+    error: str,
+) -> None:
+    """Test the timeout error."""
 
     result = await hass.config_entries.flow.async_init(
         DOMAIN, context={"source": SOURCE_USER}
     )
     assert result["type"] is FlowResultType.FORM
     assert result["errors"] == {}
 
-    with patch(
-        "homeassistant.components.niko_home_control.config_flow.NHCController.connect",
-        side_effect=Exception,
-    ):
-        result = await hass.config_entries.flow.async_configure(
-            result["flow_id"],
-            {CONF_HOST: "192.168.0.123"},
-        )
+    mock_niko_home_control_connection.connect.side_effect = exception
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
+        {CONF_HOST: "192.168.0.123"},
+    )
 
     assert result["type"] is FlowResultType.FORM
-    assert result["errors"] == {"base": "cannot_connect"}
+    assert result["errors"] == {"base": error}
 
-    with patch(
-        "homeassistant.components.niko_home_control.config_flow.NHCController.connect",
-    ):
-        result = await hass.config_entries.flow.async_configure(
-            result["flow_id"],
-            {CONF_HOST: "192.168.0.123"},
-        )
+    mock_niko_home_control_connection.connect.side_effect = None
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
+        {CONF_HOST: "192.168.0.123"},
+    )
 
     assert result["type"] is FlowResultType.CREATE_ENTRY
 
@@ -119,6 +132,7 @@ async def test_reconfigure(
     hass: HomeAssistant,
     mock_niko_home_control_connection: AsyncMock,
     mock_config_entry: MockConfigEntry,
+    mock_setup_entry: AsyncMock,
 ) -> None:
     """Test the reconfigure flow."""
     mock_config_entry.add_to_hass(hass)
@@ -136,28 +150,39 @@ async def test_reconfigure(
     assert result["reason"] == "reconfigure_successful"
 
 
-async def test_reconfigure_cannot_connect(
+@pytest.mark.parametrize(
+    ("exception", "error"),
+    [
+        (TimeoutError, "timeout_connect"),
+        (OSError, "cannot_connect"),
+        (Exception, "unknown"),
+    ],
+)
+async def test_reconfigure_errors(
     hass: HomeAssistant,
     mock_niko_home_control_connection: AsyncMock,
     mock_config_entry: MockConfigEntry,
+    mock_setup_entry: AsyncMock,
+    exception: Exception,
+    error: str,
 ) -> None:
     """Test reconfiguration with connection error."""
     mock_config_entry.add_to_hass(hass)
 
-    mock_niko_home_control_connection.connect.side_effect = Exception("cannot_connect")
-
     result = await mock_config_entry.start_reconfigure_flow(hass)
 
     assert result["type"] is FlowResultType.FORM
     assert result["errors"] == {}
 
+    mock_niko_home_control_connection.connect.side_effect = exception
+
     result = await hass.config_entries.flow.async_configure(
         result["flow_id"],
         {CONF_HOST: "192.168.0.122"},
     )
 
     assert result["type"] is FlowResultType.FORM
-    assert result["errors"] == {"base": "cannot_connect"}
+    assert result["errors"] == {"base": error}
 
     mock_niko_home_control_connection.connect.side_effect = None