Add reconfigure flow to Satel Integra (#164938)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: Tommatheussen

homeassistant/components/satel_integra/config_flow.py

@@ -44,11 +44,9 @@
     {
         vol.Required(CONF_HOST): str,
         vol.Required(CONF_PORT, default=DEFAULT_PORT): cv.port,
-        vol.Optional(CONF_CODE): cv.string,
     }
 )
 
-
 CODE_SCHEMA = vol.Schema(
     {
         vol.Optional(CONF_CODE): cv.string,
@@ -86,6 +84,11 @@
 class SatelConfigFlow(ConfigFlow, domain=DOMAIN):
     """Handle a Satel Integra config flow."""
 
+    def __init__(self) -> None:
+        """Initialize the config flow."""
+        super().__init__()
+        self.connection_data: dict[str, Any] = {}
+
     VERSION = 2
     MINOR_VERSION = 1
 
@@ -119,24 +122,71 @@ async def async_step_user(
         if user_input is not None:
             self._async_abort_entries_match({CONF_HOST: user_input[CONF_HOST]})
 
-            valid = await self.test_connection(
-                user_input[CONF_HOST], user_input[CONF_PORT]
+            if await self.test_connection(user_input[CONF_HOST], user_input[CONF_PORT]):
+                self.connection_data = {
+                    CONF_HOST: user_input[CONF_HOST],
+                    CONF_PORT: user_input[CONF_PORT],
+                }
+                return await self.async_step_code()
+
+            errors["base"] = "cannot_connect"
+
+        return self.async_show_form(
+            step_id="user",
+            data_schema=CONNECTION_SCHEMA,
+            errors=errors,
+        )
+
+    async def async_step_code(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """Handle code configuration."""
+        if user_input is not None:
+            return self.async_create_entry(
+                title=self.connection_data[CONF_HOST],
+                data=self.connection_data,
+                options={CONF_CODE: user_input.get(CONF_CODE)},
             )
 
-            if valid:
-                return self.async_create_entry(
-                    title=user_input[CONF_HOST],
-                    data={
+        return self.async_show_form(
+            step_id="code",
+            data_schema=CODE_SCHEMA,
+        )
+
+    async def async_step_reconfigure(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """Handle reconfiguration."""
+        errors: dict[str, str] = {}
+        reconfigure_entry = self._get_reconfigure_entry()
+
+        if user_input is not None:
+            self._async_abort_entries_match({CONF_HOST: user_input[CONF_HOST]})
+
+            if await self.test_connection(user_input[CONF_HOST], user_input[CONF_PORT]):
+                return self.async_update_reload_and_abort(
+                    reconfigure_entry,
+                    data_updates={
                         CONF_HOST: user_input[CONF_HOST],
                         CONF_PORT: user_input[CONF_PORT],
                     },
-                    options={CONF_CODE: user_input.get(CONF_CODE)},
+                    title=user_input[CONF_HOST],
+                    reload_even_if_entry_is_unchanged=False,
                 )
 
             errors["base"] = "cannot_connect"
 
+        suggested_values: dict[str, Any] = {
+            **reconfigure_entry.data,
+            **(user_input or {}),
+        }
+
         return self.async_show_form(
-            step_id="user", data_schema=CONNECTION_SCHEMA, errors=errors
+            step_id="reconfigure",
+            data_schema=self.add_suggested_values_to_schema(
+                CONNECTION_SCHEMA, suggested_values
+            ),
+            errors=errors,
         )
 
     async def test_connection(self, host: str, port: int) -> bool:

homeassistant/components/satel_integra/strings.json

@@ -5,20 +5,37 @@
   },
   "config": {
     "abort": {
-      "already_configured": "[%key:common::config_flow::abort::already_configured_device%]"
+      "already_configured": "[%key:common::config_flow::abort::already_configured_device%]",
+      "reconfigure_successful": "[%key:common::config_flow::abort::reconfigure_successful%]"
     },
     "error": {
       "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]"
     },
     "step": {
+      "code": {
+        "data": {
+          "code": "[%key:component::satel_integra::common::code%]"
+        },
+        "data_description": {
+          "code": "[%key:component::satel_integra::common::code_input_description%]"
+        }
+      },
+      "reconfigure": {
+        "data": {
+          "host": "[%key:common::config_flow::data::host%]",
+          "port": "[%key:common::config_flow::data::port%]"
+        },
+        "data_description": {
+          "host": "[%key:component::satel_integra::config::step::user::data_description::host%]",
+          "port": "[%key:component::satel_integra::config::step::user::data_description::port%]"
+        }
+      },
       "user": {
         "data": {
-          "code": "[%key:component::satel_integra::common::code%]",
           "host": "[%key:common::config_flow::data::host%]",
           "port": "[%key:common::config_flow::data::port%]"
         },
         "data_description": {
-          "code": "[%key:component::satel_integra::common::code_input_description%]",
           "host": "The IP address of the alarm panel",
           "port": "The port of the alarm panel"
         }

tests/components/satel_integra/test_config_flow.py

@@ -35,15 +35,17 @@
 
 
 @pytest.mark.parametrize(
-    ("user_input", "entry_data", "entry_options"),
+    ("user_input_connection", "user_input_code", "entry_data", "entry_options"),
     [
         (
-            {**MOCK_CONFIG_DATA, **MOCK_CONFIG_OPTIONS},
+            MOCK_CONFIG_DATA,
+            MOCK_CONFIG_OPTIONS,
             MOCK_CONFIG_DATA,
             MOCK_CONFIG_OPTIONS,
         ),
         (
             {CONF_HOST: MOCK_CONFIG_DATA[CONF_HOST]},
+            {},
             {CONF_HOST: MOCK_CONFIG_DATA[CONF_HOST], CONF_PORT: DEFAULT_PORT},
             {CONF_CODE: None},
         ),
@@ -53,7 +55,8 @@ async def test_setup_flow(
     hass: HomeAssistant,
     mock_satel: AsyncMock,
     mock_setup_entry: AsyncMock,
-    user_input: dict[str, Any],
+    user_input_connection: dict[str, Any],
+    user_input_code: dict[str, Any],
     entry_data: dict[str, Any],
     entry_options: dict[str, Any],
 ) -> None:
@@ -68,7 +71,14 @@ async def test_setup_flow(
 
     result = await hass.config_entries.flow.async_configure(
         result["flow_id"],
-        user_input,
+        user_input_connection,
+    )
+    assert result["type"] is FlowResultType.FORM
+    assert result["step_id"] == "code"
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
+        user_input_code,
     )
     assert result["type"] is FlowResultType.CREATE_ENTRY
     assert result["title"] == MOCK_CONFIG_DATA[CONF_HOST]
@@ -105,6 +115,14 @@ async def test_setup_connection_failed(
         user_input,
     )
 
+    assert result["type"] is FlowResultType.FORM
+    assert result["step_id"] == "code"
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
+        {},
+    )
+
     assert result["type"] is FlowResultType.CREATE_ENTRY
     assert len(mock_setup_entry.mock_calls) == 1
 
@@ -311,6 +329,80 @@ async def test_cannot_create_same_subentry(
     assert len(mock_setup_entry.mock_calls) == 0
 
 
+async def test_reconfigure_flow_success(
+    hass: HomeAssistant,
+    mock_satel: AsyncMock,
+    mock_setup_entry: AsyncMock,
+    mock_config_entry: MockConfigEntry,
+) -> None:
+    """Test that reconfigure updates host/port."""
+    mock_config_entry.add_to_hass(hass)
+
+    result = await mock_config_entry.start_reconfigure_flow(hass)
+
+    assert result["type"] is FlowResultType.FORM
+    assert result["step_id"] == "reconfigure"
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
+        {
+            CONF_HOST: "10.0.0.2",
+            CONF_PORT: 4321,
+        },
+    )
+
+    assert result["type"] is FlowResultType.ABORT
+    assert result["reason"] == "reconfigure_successful"
+
+    assert mock_config_entry.data == {
+        CONF_HOST: "10.0.0.2",
+        CONF_PORT: 4321,
+    }
+
+    await hass.async_block_till_done()
+    assert mock_setup_entry.call_count == 1
+
+
+async def test_reconfigure_connection_failed(
+    hass: HomeAssistant,
+    mock_satel: AsyncMock,
+    mock_config_entry: MockConfigEntry,
+) -> None:
+    """Failure path for the reconfigure flow."""
+    mock_satel.connect.return_value = False
+
+    mock_config_entry.add_to_hass(hass)
+
+    result = await mock_config_entry.start_reconfigure_flow(hass)
+
+    assert result["type"] is FlowResultType.FORM
+    assert result["step_id"] == "reconfigure"
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
+        {CONF_HOST: "1.2.3.4", CONF_PORT: 1234},
+    )
+
+    assert result["type"] is FlowResultType.FORM
+    assert result["step_id"] == "reconfigure"
+    assert result["errors"] == {"base": "cannot_connect"}
+
+    mock_satel.connect.return_value = True
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
+        {CONF_HOST: "1.2.3.4", CONF_PORT: 1234},
+    )
+
+    assert result["type"] is FlowResultType.ABORT
+    assert result["reason"] == "reconfigure_successful"
+
+    assert mock_config_entry.data == {
+        CONF_HOST: "1.2.3.4",
+        CONF_PORT: 1234,
+    }
+
+
 async def test_same_host_config_disallowed(
     hass: HomeAssistant, mock_config_entry: MockConfigEntry
 ) -> None: