Add reconfiguration flow to senz (home-assistant#156539)

Author: astrandb

homeassistant/components/senz/config_flow.py

@@ -6,7 +6,11 @@
 
 import jwt
 
-from homeassistant.config_entries import SOURCE_REAUTH, ConfigFlowResult
+from homeassistant.config_entries import (
+    SOURCE_REAUTH,
+    SOURCE_RECONFIGURE,
+    ConfigFlowResult,
+)
 from homeassistant.helpers import config_entry_oauth2_flow
 
 from .const import DOMAIN
@@ -47,6 +51,12 @@ async def async_step_reauth_confirm(
 
         return await self.async_step_user()
 
+    async def async_step_reconfigure(
+        self, user_input: Mapping[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """User initiated reconfiguration."""
+        return await self.async_step_user()
+
     async def async_oauth_create_entry(self, data: dict) -> ConfigFlowResult:
         """Create or update the config entry."""
 
@@ -62,5 +72,11 @@ async def async_oauth_create_entry(self, data: dict) -> ConfigFlowResult:
                 self._get_reauth_entry(), data=data
             )
 
+        if self.source == SOURCE_RECONFIGURE:
+            self._abort_if_unique_id_mismatch(reason="account_mismatch")
+            return self.async_update_reload_and_abort(
+                self._get_reconfigure_entry(), data=data
+            )
+
         self._abort_if_unique_id_configured()
         return await super().async_oauth_create_entry(data)

homeassistant/components/senz/strings.json

@@ -11,7 +11,8 @@
       "oauth_failed": "[%key:common::config_flow::abort::oauth2_failed%]",
       "oauth_timeout": "[%key:common::config_flow::abort::oauth2_timeout%]",
       "oauth_unauthorized": "[%key:common::config_flow::abort::oauth2_unauthorized%]",
-      "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%]"
     },
     "create_entry": {
       "default": "[%key:common::config_flow::create_entry::authenticated%]"

tests/components/senz/conftest.py

@@ -114,12 +114,18 @@ async def setup_credentials(hass: HomeAssistant) -> None:
 
 
 @pytest.fixture
-async def access_token(hass: HomeAssistant) -> str:
+def unique_id() -> str:
+    """Return a unique ID."""
+    return ENTRY_UNIQUE_ID
+
+
+@pytest.fixture
+async def access_token(hass: HomeAssistant, unique_id: str) -> str:
     """Return a valid access token."""
     return config_entry_oauth2_flow._encode_jwt(
         hass,
         {
-            "sub": ENTRY_UNIQUE_ID,
+            "sub": unique_id,
             "aud": [],
             "scp": [
                 "rest_api",

tests/components/senz/test_config_flow.py

@@ -16,7 +16,7 @@
 from homeassistant.helpers import config_entry_oauth2_flow
 from homeassistant.setup import async_setup_component
 
-from .const import CLIENT_ID, CLIENT_SECRET
+from .const import CLIENT_ID, CLIENT_SECRET, ENTRY_UNIQUE_ID
 
 from tests.common import MockConfigEntry
 from tests.test_util.aiohttp import AiohttpClientMocker
@@ -202,3 +202,80 @@ async def test_reauth_flow(
     assert result.get("reason") == "reauth_successful"
 
     assert len(hass.config_entries.async_entries(DOMAIN)) == 1
+
+
+@pytest.mark.usefixtures("current_request_with_host")
+@pytest.mark.parametrize(
+    ("unique_id", "expected_result"),
+    [
+        (ENTRY_UNIQUE_ID, "reconfigure_successful"),
+        ("different_unique_id", "account_mismatch"),
+    ],
+)
+async def test_reconfiguration_flow(
+    hass: HomeAssistant,
+    hass_client_no_auth: ClientSessionGenerator,
+    aioclient_mock: AiohttpClientMocker,
+    mock_config_entry: MockConfigEntry,
+    access_token: str,
+    unique_id: str,
+    expected_result: str,
+    expires_at: float,
+) -> None:
+    """Test reconfigure step with correct params."""
+
+    CURRENT_TOKEN = {
+        "auth_implementation": DOMAIN,
+        "token": {
+            "access_token": access_token,
+            "expires_in": 86399,
+            "refresh_token": "3012bc9f-7a65-4240-b817-9154ffdcc30f",
+            "token_type": "Bearer",
+            "expires_at": expires_at,
+        },
+    }
+    assert hass.config_entries.async_update_entry(
+        mock_config_entry,
+        data=CURRENT_TOKEN,
+    )
+    assert len(hass.config_entries.async_entries(DOMAIN)) == 1
+
+    result = await mock_config_entry.start_reconfigure_flow(hass)
+
+    assert result["step_id"] == "auth"
+
+    state = config_entry_oauth2_flow._encode_jwt(
+        hass,
+        {
+            "flow_id": result["flow_id"],
+            "redirect_uri": REDIRECT_URL,
+        },
+    )
+    assert result["url"] == (
+        f"{AUTHORIZATION_ENDPOINT}?response_type=code&client_id={CLIENT_ID}"
+        f"&redirect_uri={REDIRECT_URL}"
+        f"&state={state}&scope=restapi+offline_access"
+    )
+
+    client = await hass_client_no_auth()
+    resp = await client.get(f"{REDIRECT_PATH}?code=abcd&state={state}")
+    assert resp.status == 200
+    assert resp.headers["content-type"] == "text/html; charset=utf-8"
+
+    aioclient_mock.post(
+        TOKEN_ENDPOINT,
+        json={
+            "refresh_token": "updated-refresh-token",
+            "access_token": access_token,
+            "type": "Bearer",
+            "expires_in": "60",
+        },
+    )
+
+    result = await hass.config_entries.flow.async_configure(result["flow_id"])
+    await hass.async_block_till_done()
+
+    assert result.get("type") is FlowResultType.ABORT
+    assert result.get("reason") == expected_result
+
+    assert len(hass.config_entries.async_entries(DOMAIN)) == 1