Add reauth to frontier_silicon config flow (#90443)

* Add reauth to frontier_silicon config flow

* Update patch target

* Apply suggestions from code review

Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>

* Add reauth_successful to strings.json

* Don't manually set "title_placeholders"

Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>

---------

Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>
This commit is contained in:
Thijs W 2023-03-30 08:49:46 +02:00 committed by GitHub
parent 40cb0eeb68
commit 053ed3cfdc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 101 additions and 1 deletions

View file

@ -1,6 +1,7 @@
"""Config flow for Frontier Silicon Media Player integration."""
from __future__ import annotations
from collections.abc import Mapping
import logging
from typing import Any
from urllib.parse import urlparse
@ -53,6 +54,7 @@ class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
_name: str
_webfsapi_url: str
_reauth_entry: config_entries.ConfigEntry | None = None # Only used in reauth flows
async def async_step_import(self, import_info: dict[str, Any]) -> FlowResult:
"""Handle the import of legacy configuration.yaml entries."""
@ -192,6 +194,16 @@ class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
step_id="confirm", description_placeholders={"name": self._name}
)
async def async_step_reauth(self, config: Mapping[str, Any]) -> FlowResult:
"""Perform reauth upon an API authentication error."""
self._webfsapi_url = config[CONF_WEBFSAPI_URL]
self._reauth_entry = self.hass.config_entries.async_get_entry(
self.context["entry_id"]
)
return await self.async_step_device_config()
async def async_step_device_config(
self, user_input: dict[str, Any] | None = None
) -> FlowResult:
@ -220,6 +232,14 @@ class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
_LOGGER.exception(exception)
errors["base"] = "unknown"
else:
if self._reauth_entry:
self.hass.config_entries.async_update_entry(
self._reauth_entry,
data={CONF_PIN: user_input[CONF_PIN]},
)
await self.hass.config_entries.async_reload(self._reauth_entry.entry_id)
return self.async_abort(reason="reauth_successful")
unique_id = await afsapi.get_radio_id()
await self.async_set_unique_id(unique_id, raise_on_progress=False)
self._abort_if_unique_id_configured()

View file

@ -24,7 +24,8 @@
"unknown": "[%key:common::config_flow::error::unknown%]"
},
"abort": {
"already_configured": "[%key:common::config_flow::abort::already_configured_device%]"
"already_configured": "[%key:common::config_flow::abort::already_configured_device%]",
"reauth_successful": "[%key:common::config_flow::abort::reauth_successful%]"
}
},
"issues": {

View file

@ -415,3 +415,82 @@ async def test_ssdp_nondefault_pin(hass: HomeAssistant) -> None:
assert result["type"] == FlowResultType.ABORT
assert result["reason"] == "invalid_auth"
async def test_reauth_flow(hass: HomeAssistant, config_entry: MockConfigEntry) -> None:
"""Test reauth flow."""
config_entry.add_to_hass(hass)
assert config_entry.data[CONF_PIN] == "1234"
result = await hass.config_entries.flow.async_init(
DOMAIN,
context={
"source": config_entries.SOURCE_REAUTH,
"unique_id": config_entry.unique_id,
"entry_id": config_entry.entry_id,
},
data=config_entry.data,
)
assert result["type"] == FlowResultType.FORM
assert result["step_id"] == "device_config"
result2 = await hass.config_entries.flow.async_configure(
result["flow_id"],
user_input={CONF_PIN: "4242"},
)
assert result2["type"] == FlowResultType.ABORT
assert result2["reason"] == "reauth_successful"
assert config_entry.data[CONF_PIN] == "4242"
@pytest.mark.parametrize(
("exception", "reason"),
[
(ConnectionError, "cannot_connect"),
(InvalidPinException, "invalid_auth"),
(ValueError, "unknown"),
],
)
async def test_reauth_flow_friendly_name_error(
hass: HomeAssistant,
exception: Exception,
reason: str,
config_entry: MockConfigEntry,
) -> None:
"""Test reauth flow with failures."""
config_entry.add_to_hass(hass)
assert config_entry.data[CONF_PIN] == "1234"
result = await hass.config_entries.flow.async_init(
DOMAIN,
context={
"source": config_entries.SOURCE_REAUTH,
"unique_id": config_entry.unique_id,
"entry_id": config_entry.entry_id,
},
data=config_entry.data,
)
assert result["type"] == FlowResultType.FORM
assert result["step_id"] == "device_config"
with patch(
"homeassistant.components.frontier_silicon.config_flow.AFSAPI.get_friendly_name",
side_effect=exception,
):
result2 = await hass.config_entries.flow.async_configure(
result["flow_id"],
{CONF_PIN: "4321"},
)
await hass.async_block_till_done()
assert result2["type"] == FlowResultType.FORM
assert result2["step_id"] == "device_config"
assert result2["errors"] == {"base": reason}
result3 = await hass.config_entries.flow.async_configure(
result["flow_id"],
user_input={CONF_PIN: "4242"},
)
assert result3["type"] == FlowResultType.ABORT
assert result3["reason"] == "reauth_successful"
assert config_entry.data[CONF_PIN] == "4242"