evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add reconfigure flow to Sensibo (#129280)

Browse source
This commit is contained in:
G Johansson 2024-10-28 12:29:06 +01:00 • committed by GitHub
parent 1b7fcce42d
commit a0f73bd30f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 228 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

72
homeassistant/components/sensibo/config_flow.py
View file

@ -10,6 +10,7 @@ import voluptuous as vol
from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
from homeassistant.const import CONF_API_KEY
from homeassistant.core import HomeAssistant
from homeassistant.helpers.selector import TextSelector
from .const import DEFAULT_NAME, DOMAIN
@ -22,6 +23,25 @@ DATA_SCHEMA = vol.Schema(
)
async def validate_api(
hass: HomeAssistant, api_key: str
) -> tuple[str | None, dict[str, str]]:
"""Validate the API key."""
errors: dict[str, str] = {}
username: str | None = None
try:
username = await async_validate_api(hass, api_key)
except AuthenticationError:
errors["base"] = "invalid_auth"
except ConnectionError:
errors["base"] = "cannot_connect"
except NoDevicesError:
errors["base"] = "no_devices"
except NoUsernameError:
errors["base"] = "no_username"
return (username, errors)
class SensiboConfigFlow(ConfigFlow, domain=DOMAIN):
"""Handle a config flow for Sensibo integration."""
@ -41,17 +61,8 @@ class SensiboConfigFlow(ConfigFlow, domain=DOMAIN):
if user_input:
api_key = user_input[CONF_API_KEY]
try:
username = await async_validate_api(self.hass, api_key)
except AuthenticationError:
errors["base"] = "invalid_auth"
except ConnectionError:
errors["base"] = "cannot_connect"
except NoDevicesError:
errors["base"] = "no_devices"
except NoUsernameError:
errors["base"] = "no_username"
else:
username, errors = await validate_api(self.hass, api_key)
if username:
reauth_entry = self._get_reauth_entry()
if username == reauth_entry.unique_id:
return self.async_update_reload_and_abort(
@ -68,6 +79,32 @@ class SensiboConfigFlow(ConfigFlow, domain=DOMAIN):
errors=errors,
)
async def async_step_reconfigure(
self, user_input: dict[str, Any] | None = None
) -> ConfigFlowResult:
"""Reconfigure Sensibo."""
errors: dict[str, str] = {}
if user_input:
api_key = user_input[CONF_API_KEY]
username, errors = await validate_api(self.hass, api_key)
if username:
reconfigure_entry = self._get_reconfigure_entry()
if username == reconfigure_entry.unique_id:
return self.async_update_reload_and_abort(
reconfigure_entry,
data_updates={
CONF_API_KEY: api_key,
},
)
errors["base"] = "incorrect_api_key"
return self.async_show_form(
step_id="reconfigure",
data_schema=DATA_SCHEMA,
errors=errors,
)
async def async_step_user(
self, user_input: dict[str, Any] | None = None
) -> ConfigFlowResult:
@ -77,17 +114,8 @@ class SensiboConfigFlow(ConfigFlow, domain=DOMAIN):
if user_input:
api_key = user_input[CONF_API_KEY]
try:
username = await async_validate_api(self.hass, api_key)
except AuthenticationError:
errors["base"] = "invalid_auth"
except ConnectionError:
errors["base"] = "cannot_connect"
except NoDevicesError:
errors["base"] = "no_devices"
except NoUsernameError:
errors["base"] = "no_username"
else:
username, errors = await validate_api(self.hass, api_key)
if username:
await self.async_set_unique_id(username)
self._abort_if_unique_id_configured()

11
homeassistant/components/sensibo/strings.json
View file

@ -2,7 +2,8 @@
"config": {
"abort": {
"already_configured": "[%key:common::config_flow::abort::already_configured_account%]",
"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%]",
@ -27,6 +28,14 @@
"data_description": {
"api_key": "[%key:component::sensibo::config::step::user::data_description::api_key%]"
}
},
"reconfigure": {
"data": {
"api_key": "[%key:common::config_flow::data::api_key%]"
},
"data_description": {
"api_key": "[%key:component::sensibo::config::step::user::data_description::api_key%]"
}
}
}
},

168
tests/components/sensibo/test_config_flow.py
View file

@ -348,3 +348,171 @@ async def test_flow_reauth_no_username_or_device(
assert result2["step_id"] == "reauth_confirm"
assert result2["type"] is FlowResultType.FORM
assert result2["errors"] == {"base": p_error}
async def test_reconfigure_flow(hass: HomeAssistant) -> None:
"""Test a reconfigure flow."""
entry = MockConfigEntry(
version=2,
domain=DOMAIN,
unique_id="username",
data={"api_key": "1234567890"},
)
entry.add_to_hass(hass)
result = await entry.start_reconfigure_flow(hass)
assert result["step_id"] == "reconfigure"
assert result["type"] is FlowResultType.FORM
assert result["errors"] == {}
with (
patch(
"homeassistant.components.sensibo.util.SensiboClient.async_get_devices",
return_value={"result": [{"id": "xyzxyz"}, {"id": "abcabc"}]},
),
patch(
"homeassistant.components.sensibo.util.SensiboClient.async_get_me",
return_value={"result": {"username": "username"}},
) as mock_sensibo,
patch(
"homeassistant.components.sensibo.async_setup_entry",
return_value=True,
) as mock_setup_entry,
):
result2 = await hass.config_entries.flow.async_configure(
result["flow_id"],
{CONF_API_KEY: "1234567891"},
)
await hass.async_block_till_done()
assert result2["type"] is FlowResultType.ABORT
assert result2["reason"] == "reconfigure_successful"
assert entry.data == {"api_key": "1234567891"}
assert len(mock_sensibo.mock_calls) == 1
assert len(mock_setup_entry.mock_calls) == 1
@pytest.mark.parametrize(
("sideeffect", "p_error"),
[
(aiohttp.ClientConnectionError, "cannot_connect"),
(TimeoutError, "cannot_connect"),
(AuthenticationError, "invalid_auth"),
(SensiboError, "cannot_connect"),
],
)
async def test_reconfigure_flow_error(
hass: HomeAssistant, sideeffect: Exception, p_error: str
) -> None:
"""Test a reconfigure flow with error."""
entry = MockConfigEntry(
version=2,
domain=DOMAIN,
unique_id="username",
data={"api_key": "1234567890"},
)
entry.add_to_hass(hass)
result = await entry.start_reconfigure_flow(hass)
with patch(
"homeassistant.components.sensibo.util.SensiboClient.async_get_devices",
side_effect=sideeffect,
):
result2 = await hass.config_entries.flow.async_configure(
result["flow_id"],
{CONF_API_KEY: "1234567890"},
)
await hass.async_block_till_done()
assert result2["step_id"] == "reconfigure"
assert result2["type"] is FlowResultType.FORM
assert result2["errors"] == {"base": p_error}
with (
patch(
"homeassistant.components.sensibo.util.SensiboClient.async_get_devices",
return_value={"result": [{"id": "xyzxyz"}, {"id": "abcabc"}]},
),
patch(
"homeassistant.components.sensibo.util.SensiboClient.async_get_me",
return_value={"result": {"username": "username"}},
),
patch(
"homeassistant.components.sensibo.async_setup_entry",
return_value=True,
),
):
result2 = await hass.config_entries.flow.async_configure(
result["flow_id"],
{CONF_API_KEY: "1234567891"},
)
await hass.async_block_till_done()
assert result2["type"] is FlowResultType.ABORT
assert result2["reason"] == "reconfigure_successful"
assert entry.data == {"api_key": "1234567891"}
@pytest.mark.parametrize(
("get_devices", "get_me", "p_error"),
[
(
{"result": [{"id": "xyzxyz"}, {"id": "abcabc"}]},
{"result": {}},
"no_username",
),
(
{"result": []},
{"result": {"username": "username"}},
"no_devices",
),
(
{"result": [{"id": "xyzxyz"}, {"id": "abcabc"}]},
{"result": {"username": "username2"}},
"incorrect_api_key",
),
],
)
async def test_flow_reconfigure_no_username_or_device(
hass: HomeAssistant,
get_devices: dict[str, Any],
get_me: dict[str, Any],
p_error: str,
) -> None:
"""Test config flow get no username from api."""
entry = MockConfigEntry(
version=2,
domain=DOMAIN,
unique_id="username",
data={"api_key": "1234567890"},
)
entry.add_to_hass(hass)
result = await entry.start_reconfigure_flow(hass)
assert result["type"] is FlowResultType.FORM
assert result["step_id"] == "reconfigure"
with (
patch(
"homeassistant.components.sensibo.util.SensiboClient.async_get_devices",
return_value=get_devices,
),
patch(
"homeassistant.components.sensibo.util.SensiboClient.async_get_me",
return_value=get_me,
),
):
result2 = await hass.config_entries.flow.async_configure(
result["flow_id"],
user_input={
CONF_API_KEY: "1234567890",
},
)
await hass.async_block_till_done()
assert result2["step_id"] == "reconfigure"
assert result2["type"] is FlowResultType.FORM
assert result2["errors"] == {"base": p_error}