Add reauth flow to Namecheap DynamicDNS integration (home-assistant#161674)

Author: tr4nt0r

homeassistant/components/namecheapdns/config_flow.py

@@ -2,13 +2,14 @@
 
 from __future__ import annotations
 
+from collections.abc import Mapping
 import logging
 from typing import Any
 
 from aiohttp import ClientError
 import voluptuous as vol
 
-from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
+from homeassistant.config_entries import SOURCE_REAUTH, ConfigFlow, ConfigFlowResult
 from homeassistant.const import CONF_DOMAIN, CONF_HOST, CONF_NAME, CONF_PASSWORD
 from homeassistant.helpers import config_validation as cv
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
@@ -19,7 +20,7 @@
 )
 
 from .const import DOMAIN
-from .helpers import update_namecheapdns
+from .helpers import AuthFailed, update_namecheapdns
 from .issue import deprecate_yaml_issue
 
 _LOGGER = logging.getLogger(__name__)
@@ -100,13 +101,29 @@ async def async_step_import(self, import_info: dict[str, Any]) -> ConfigFlowResu
         deprecate_yaml_issue(self.hass, import_success=True)
         return result
 
+    async def async_step_reauth(
+        self, entry_data: Mapping[str, Any]
+    ) -> ConfigFlowResult:
+        """Perform reauth upon authentication error."""
+        return await self.async_step_reauth_confirm()
+
     async def async_step_reconfigure(
         self, user_input: dict[str, Any] | None = None
     ) -> ConfigFlowResult:
         """Handle reconfigure flow."""
+        return await self.async_step_reauth_confirm(user_input)
+
+    async def async_step_reauth_confirm(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """Confirm reauthentication dialog."""
         errors: dict[str, str] = {}
 
-        entry = self._get_reconfigure_entry()
+        entry = (
+            self._get_reauth_entry()
+            if self.source == SOURCE_REAUTH
+            else self._get_reconfigure_entry()
+        )
 
         if user_input is not None:
             session = async_get_clientsession(self.hass)
@@ -118,6 +135,8 @@ async def async_step_reconfigure(
                     user_input[CONF_PASSWORD],
                 ):
                     errors["base"] = "update_failed"
+            except AuthFailed:
+                errors["base"] = "invalid_auth"
             except ClientError:
                 _LOGGER.debug("Cannot connect", exc_info=True)
                 errors["base"] = "cannot_connect"
@@ -132,8 +151,12 @@ async def async_step_reconfigure(
                 )
 
         return self.async_show_form(
-            step_id="reconfigure",
+            step_id="reauth_confirm" if self.source == SOURCE_REAUTH else "reconfigure",
             data_schema=STEP_RECONFIGURE_DATA_SCHEMA,
             errors=errors,
-            description_placeholders={CONF_NAME: entry.title},
+            description_placeholders={
+                "account_panel": f"https://ap.www.namecheap.com/Domains/DomainControlPanel/{entry.data[CONF_DOMAIN]}/advancedns",
+                CONF_NAME: entry.title,
+                CONF_DOMAIN: entry.data[CONF_DOMAIN],
+            },
         )

homeassistant/components/namecheapdns/coordinator.py

@@ -8,11 +8,12 @@
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_DOMAIN, CONF_HOST, CONF_PASSWORD
 from homeassistant.core import HomeAssistant
+from homeassistant.exceptions import ConfigEntryAuthFailed
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
 from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
 
 from .const import DOMAIN
-from .helpers import update_namecheapdns
+from .helpers import AuthFailed, update_namecheapdns
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -53,6 +54,12 @@ async def _async_update_data(self) -> None:
                     translation_key="update_failed",
                     translation_placeholders={CONF_DOMAIN: f"{host}.{domain}"},
                 )
+        except AuthFailed as e:
+            raise ConfigEntryAuthFailed(
+                translation_domain=DOMAIN,
+                translation_key="authentication_failed",
+                translation_placeholders={CONF_DOMAIN: f"{host}.{domain}"},
+            ) from e
         except ClientError as e:
             raise UpdateFailed(
                 translation_domain=DOMAIN,

homeassistant/components/namecheapdns/helpers.py

@@ -4,21 +4,29 @@
 
 from aiohttp import ClientSession
 
+from homeassistant.exceptions import HomeAssistantError
+
 from .const import UPDATE_URL
 
 _LOGGER = logging.getLogger(__name__)
 
 
 async def update_namecheapdns(
     session: ClientSession, host: str, domain: str, password: str
-):
+) -> bool:
     """Update namecheap DNS entry."""
     params = {"host": host, "domain": domain, "password": password}
 
     resp = await session.get(UPDATE_URL, params=params)
     xml_string = await resp.text()
 
     if "<ErrCount>0</ErrCount>" not in xml_string:
+        if "<Err1>Passwords do not match</Err1>" in xml_string:
+            raise AuthFailed
         return False
 
     return True
+
+
+class AuthFailed(HomeAssistantError):
+    """Authentication error."""

homeassistant/components/namecheapdns/strings.json

@@ -2,21 +2,34 @@
   "config": {
     "abort": {
       "already_configured": "[%key:common::config_flow::abort::already_configured_service%]",
+      "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%]",
+      "invalid_auth": "[%key:common::config_flow::error::invalid_auth%]",
       "unknown": "[%key:common::config_flow::error::unknown%]",
       "update_failed": "Updating DNS failed"
     },
     "step": {
+      "reauth_confirm": {
+        "data": {
+          "password": "[%key:component::namecheapdns::config::step::user::data::password%]"
+        },
+        "data_description": {
+          "password": "[%key:component::namecheapdns::config::step::user::data_description::password%]"
+        },
+        "description": "[%key:component::namecheapdns::config::step::reconfigure::description%]",
+        "title": "Re-authenticate {name}"
+      },
       "reconfigure": {
         "data": {
           "password": "[%key:component::namecheapdns::config::step::user::data::password%]"
         },
         "data_description": {
           "password": "[%key:component::namecheapdns::config::step::user::data_description::password%]"
         },
+        "description": "You can find the Dynamic DNS password in your Namecheap account under [Domain List > {domain} > Manage > Advanced DNS > Dynamic DNS]({account_panel}).",
         "title": "Re-configure {name}"
       },
       "user": {
@@ -35,6 +48,9 @@
     }
   },
   "exceptions": {
+    "authentication_failed": {
+      "message": "Authentication for Namecheap DynamicDNS domain {domain} failed"
+    },
     "connection_error": {
       "message": "Updating Namecheap DynamicDNS domain {domain} failed due to a connection error"
     },

tests/components/namecheapdns/test_config_flow.py

@@ -5,8 +5,14 @@
 from aiohttp import ClientError
 import pytest
 
-from homeassistant.components.namecheapdns.const import DOMAIN
-from homeassistant.config_entries import SOURCE_IMPORT, SOURCE_USER
+from homeassistant.components.namecheapdns.const import DOMAIN, UPDATE_URL
+from homeassistant.components.namecheapdns.helpers import AuthFailed
+from homeassistant.config_entries import (
+    SOURCE_IMPORT,
+    SOURCE_REAUTH,
+    SOURCE_USER,
+    ConfigEntryState,
+)
 from homeassistant.const import CONF_PASSWORD
 from homeassistant.core import DOMAIN as HOMEASSISTANT_DOMAIN, HomeAssistant
 from homeassistant.data_entry_flow import FlowResultType
@@ -16,6 +22,7 @@
 from .conftest import TEST_USER_INPUT
 
 from tests.common import MockConfigEntry
+from tests.test_util.aiohttp import AiohttpClientMocker
 
 
 @pytest.mark.usefixtures("mock_namecheap")
@@ -173,6 +180,7 @@ async def test_reconfigure(
         (ValueError, "unknown"),
         (False, "update_failed"),
         (ClientError, "cannot_connect"),
+        (AuthFailed, "invalid_auth"),
     ],
 )
 async def test_reconfigure_errors(
@@ -208,3 +216,120 @@ async def test_reconfigure_errors(
     assert result["reason"] == "reconfigure_successful"
 
     assert config_entry.data[CONF_PASSWORD] == "new-password"
+
+
+@pytest.mark.usefixtures("mock_namecheap")
+async def test_reauth(
+    hass: HomeAssistant,
+    config_entry: MockConfigEntry,
+    aioclient_mock: AiohttpClientMocker,
+) -> None:
+    """Test reauth flow."""
+    aioclient_mock.get(
+        UPDATE_URL,
+        params=TEST_USER_INPUT,
+        text="<interface-response><ErrCount>0</ErrCount></interface-response>",
+    )
+    config_entry.add_to_hass(hass)
+    assert await hass.config_entries.async_setup(config_entry.entry_id)
+    await hass.async_block_till_done()
+
+    assert config_entry.state is ConfigEntryState.LOADED
+
+    result = await config_entry.start_reauth_flow(hass)
+
+    assert result["type"] is FlowResultType.FORM
+    assert result["step_id"] == "reauth_confirm"
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"], {CONF_PASSWORD: "new-password"}
+    )
+    await hass.async_block_till_done()
+
+    assert result["type"] is FlowResultType.ABORT
+    assert result["reason"] == "reauth_successful"
+    assert config_entry.data[CONF_PASSWORD] == "new-password"
+
+
+@pytest.mark.parametrize(
+    ("side_effect", "text_error"),
+    [
+        (ValueError, "unknown"),
+        (False, "update_failed"),
+        (ClientError, "cannot_connect"),
+        (AuthFailed, "invalid_auth"),
+    ],
+)
+async def test_reauth_errors(
+    hass: HomeAssistant,
+    config_entry: MockConfigEntry,
+    mock_namecheap: AsyncMock,
+    side_effect: Exception | bool,
+    text_error: str,
+    aioclient_mock: AiohttpClientMocker,
+) -> None:
+    """Test we handle errors."""
+    aioclient_mock.get(
+        UPDATE_URL,
+        params=TEST_USER_INPUT,
+        text="<interface-response><ErrCount>0</ErrCount></interface-response>",
+    )
+    config_entry.add_to_hass(hass)
+    assert await hass.config_entries.async_setup(config_entry.entry_id)
+    await hass.async_block_till_done()
+
+    assert config_entry.state is ConfigEntryState.LOADED
+
+    result = await config_entry.start_reauth_flow(hass)
+
+    assert result["type"] is FlowResultType.FORM
+    assert result["step_id"] == "reauth_confirm"
+
+    mock_namecheap.side_effect = [side_effect]
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"], {CONF_PASSWORD: "new-password"}
+    )
+
+    assert result["type"] is FlowResultType.FORM
+    assert result["errors"] == {"base": text_error}
+
+    mock_namecheap.side_effect = None
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"], {CONF_PASSWORD: "new-password"}
+    )
+
+    assert result["type"] is FlowResultType.ABORT
+    assert result["reason"] == "reauth_successful"
+
+    assert config_entry.data[CONF_PASSWORD] == "new-password"
+
+
+async def test_initiate_reauth_flow(
+    hass: HomeAssistant,
+    config_entry: MockConfigEntry,
+    aioclient_mock: AiohttpClientMocker,
+) -> None:
+    """Test authentication error initiates reauth flow."""
+
+    aioclient_mock.get(
+        UPDATE_URL,
+        params=TEST_USER_INPUT,
+        text="<interface-response><ErrCount>1</ErrCount><errors><Err1>Passwords do not match</Err1></errors></interface-response>",
+    )
+    config_entry.add_to_hass(hass)
+    await hass.config_entries.async_setup(config_entry.entry_id)
+    await hass.async_block_till_done()
+
+    assert config_entry.state is ConfigEntryState.SETUP_ERROR
+
+    flows = hass.config_entries.flow.async_progress()
+    assert len(flows) == 1
+
+    flow = flows[0]
+    assert flow.get("step_id") == "reauth_confirm"
+    assert flow.get("handler") == DOMAIN
+
+    assert "context" in flow
+    assert flow["context"].get("source") == SOURCE_REAUTH
+    assert flow["context"].get("entry_id") == config_entry.entry_id