Add reconfigure flow to Overseerr (#136248)

homeassistant/components/overseerr/config_flow.py

@@ -12,7 +12,7 @@ import voluptuous as vol
 from yarl import URL
 
 from homeassistant.components.webhook import async_generate_id
-from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
+from homeassistant.config_entries import SOURCE_USER, ConfigFlow, ConfigFlowResult
 from homeassistant.const import (
     CONF_API_KEY,
     CONF_HOST,
@@ -67,14 +67,26 @@ class OverseerrConfigFlow(ConfigFlow, domain=DOMAIN):
                 if error:
                     errors["base"] = error
                 else:
-                    return self.async_create_entry(
-                        title="Overseerr",
+                    if self.source == SOURCE_USER:
+                        return self.async_create_entry(
+                            title="Overseerr",
+                            data={
+                                CONF_HOST: host,
+                                CONF_PORT: port,
+                                CONF_SSL: url.scheme == "https",
+                                CONF_API_KEY: user_input[CONF_API_KEY],
+                                CONF_WEBHOOK_ID: async_generate_id(),
+                            },
+                        )
+                    reconfigure_entry = self._get_reconfigure_entry()
+                    return self.async_update_reload_and_abort(
+                        reconfigure_entry,
                         data={
+                            **reconfigure_entry.data,
                             CONF_HOST: host,
                             CONF_PORT: port,
                             CONF_SSL: url.scheme == "https",
                             CONF_API_KEY: user_input[CONF_API_KEY],
-                            CONF_WEBHOOK_ID: async_generate_id(),
                         },
                     )
         return self.async_show_form(
@@ -116,3 +128,9 @@ class OverseerrConfigFlow(ConfigFlow, domain=DOMAIN):
             data_schema=vol.Schema({vol.Required(CONF_API_KEY): str}),
             errors=errors,
         )
+
+    async def async_step_reconfigure(
+        self, user_input: Mapping[str, Any]
+    ) -> ConfigFlowResult:
+        """Handle reconfiguration."""
+        return await self.async_step_user()

homeassistant/components/overseerr/quality_scale.yaml

@@ -67,7 +67,7 @@ rules:
   entity-translations: done
   exception-translations: done
   icon-translations: done
-  reconfiguration-flow: todo
+  reconfiguration-flow: done
   repair-issues:
     status: exempt
     comment: |

homeassistant/components/overseerr/strings.json

@@ -22,7 +22,8 @@
     },
     "abort": {
       "already_configured": "[%key:common::config_flow::abort::already_configured_service%]",
-      "reauth_successful": "[%key:common::config_flow::abort::reauth_successful%]"
+      "reauth_successful": "[%key:common::config_flow::abort::reauth_successful%]",
+      "reconfigure_successful": "[%key:common::config_flow::abort::reconfigure_successful%]"
     },
     "error": {
       "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",

tests/components/overseerr/test_config_flow.py

@@ -226,3 +226,77 @@ async def test_reauth_flow_errors(
     assert result["reason"] == "reauth_successful"
 
     assert mock_config_entry.data[CONF_API_KEY] == "new-test-key"
+
+
+async def test_reconfigure_flow(
+    hass: HomeAssistant,
+    mock_overseerr_client: AsyncMock,
+    mock_setup_entry: AsyncMock,
+    mock_config_entry: MockConfigEntry,
+) -> None:
+    """Test reconfigure flow."""
+    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"] == "user"
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
+        {CONF_URL: "http://overseerr2.test", CONF_API_KEY: "new-key"},
+    )
+
+    assert result["type"] is FlowResultType.ABORT
+    assert result["reason"] == "reconfigure_successful"
+    assert mock_config_entry.data == {
+        CONF_HOST: "overseerr2.test",
+        CONF_PORT: 80,
+        CONF_SSL: False,
+        CONF_API_KEY: "new-key",
+        CONF_WEBHOOK_ID: WEBHOOK_ID,
+    }
+
+
+@pytest.mark.parametrize(
+    ("exception", "error"),
+    [
+        (OverseerrAuthenticationError, "invalid_auth"),
+        (OverseerrConnectionError, "cannot_connect"),
+    ],
+)
+async def test_reconfigure_flow_errors(
+    hass: HomeAssistant,
+    mock_overseerr_client: AsyncMock,
+    mock_setup_entry: AsyncMock,
+    mock_config_entry: MockConfigEntry,
+    exception: Exception,
+    error: str,
+) -> None:
+    """Test reconfigure flow errors."""
+    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"] == "user"
+
+    mock_overseerr_client.get_request_count.side_effect = exception
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
+        {CONF_URL: "http://overseerr2.test", CONF_API_KEY: "new-key"},
+    )
+
+    assert result["type"] is FlowResultType.FORM
+    assert result["errors"] == {"base": error}
+
+    mock_overseerr_client.get_request_count.side_effect = None
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
+        {CONF_URL: "http://overseerr2.test", CONF_API_KEY: "new-key"},
+    )
+
+    assert result["type"] is FlowResultType.ABORT
+    assert result["reason"] == "reconfigure_successful"