Handle authorization error in glances config flow (#100866)

* Handle authroization error in glances config flow

* Remove validate_input method and expections

* update tests
This commit is contained in:
Rami Mosleh 2023-09-26 15:51:04 +03:00 committed by GitHub
parent 91bc65be9c
commit 31e9ca0099
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 38 additions and 26 deletions

View File

@ -3,10 +3,13 @@ from __future__ import annotations
from typing import Any from typing import Any
from glances_api.exceptions import GlancesApiError from glances_api.exceptions import (
GlancesApiAuthorizationError,
GlancesApiConnectionError,
)
import voluptuous as vol import voluptuous as vol
from homeassistant import config_entries, exceptions from homeassistant import config_entries
from homeassistant.const import ( from homeassistant.const import (
CONF_HOST, CONF_HOST,
CONF_PASSWORD, CONF_PASSWORD,
@ -15,7 +18,6 @@ from homeassistant.const import (
CONF_USERNAME, CONF_USERNAME,
CONF_VERIFY_SSL, CONF_VERIFY_SSL,
) )
from homeassistant.core import HomeAssistant
from homeassistant.data_entry_flow import FlowResult from homeassistant.data_entry_flow import FlowResult
from . import get_api from . import get_api
@ -41,15 +43,6 @@ DATA_SCHEMA = vol.Schema(
) )
async def validate_input(hass: HomeAssistant, data: dict[str, Any]) -> None:
"""Validate the user input allows us to connect."""
api = get_api(hass, data)
try:
await api.get_ha_sensor_data()
except GlancesApiError as err:
raise CannotConnect from err
class GlancesFlowHandler(config_entries.ConfigFlow, domain=DOMAIN): class GlancesFlowHandler(config_entries.ConfigFlow, domain=DOMAIN):
"""Handle a Glances config flow.""" """Handle a Glances config flow."""
@ -64,19 +57,19 @@ class GlancesFlowHandler(config_entries.ConfigFlow, domain=DOMAIN):
self._async_abort_entries_match( self._async_abort_entries_match(
{CONF_HOST: user_input[CONF_HOST], CONF_PORT: user_input[CONF_PORT]} {CONF_HOST: user_input[CONF_HOST], CONF_PORT: user_input[CONF_PORT]}
) )
api = get_api(self.hass, user_input)
try: try:
await validate_input(self.hass, user_input) await api.get_ha_sensor_data()
except GlancesApiAuthorizationError:
errors["base"] = "invalid_auth"
except GlancesApiConnectionError:
errors["base"] = "cannot_connect"
if not errors:
return self.async_create_entry( return self.async_create_entry(
title=f"{user_input[CONF_HOST]}:{user_input[CONF_PORT]}", title=f"{user_input[CONF_HOST]}:{user_input[CONF_PORT]}",
data=user_input, data=user_input,
) )
except CannotConnect:
errors["base"] = "cannot_connect"
return self.async_show_form( return self.async_show_form(
step_id="user", data_schema=DATA_SCHEMA, errors=errors step_id="user", data_schema=DATA_SCHEMA, errors=errors
) )
class CannotConnect(exceptions.HomeAssistantError):
"""Error to indicate we cannot connect."""

View File

@ -14,7 +14,8 @@
} }
}, },
"error": { "error": {
"cannot_connect": "[%key:common::config_flow::error::cannot_connect%]" "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
"invalid_auth": "[%key:common::config_flow::error::invalid_auth%]"
}, },
"abort": { "abort": {
"already_configured": "[%key:common::config_flow::abort::already_configured_device%]" "already_configured": "[%key:common::config_flow::abort::already_configured_device%]"

View File

@ -1,7 +1,10 @@
"""Tests for Glances config flow.""" """Tests for Glances config flow."""
from unittest.mock import MagicMock from unittest.mock import MagicMock
from glances_api.exceptions import GlancesApiConnectionError from glances_api.exceptions import (
GlancesApiAuthorizationError,
GlancesApiConnectionError,
)
import pytest import pytest
from homeassistant import config_entries from homeassistant import config_entries
@ -9,7 +12,7 @@ from homeassistant.components import glances
from homeassistant.core import HomeAssistant from homeassistant.core import HomeAssistant
from homeassistant.data_entry_flow import FlowResultType from homeassistant.data_entry_flow import FlowResultType
from . import MOCK_USER_INPUT from . import HA_SENSOR_DATA, MOCK_USER_INPUT
from tests.common import MockConfigEntry, patch from tests.common import MockConfigEntry, patch
@ -39,10 +42,19 @@ async def test_form(hass: HomeAssistant) -> None:
assert result["data"] == MOCK_USER_INPUT assert result["data"] == MOCK_USER_INPUT
async def test_form_cannot_connect(hass: HomeAssistant, mock_api: MagicMock) -> None: @pytest.mark.parametrize(
"""Test to return error if we cannot connect.""" ("error", "message"),
[
(GlancesApiAuthorizationError, "invalid_auth"),
(GlancesApiConnectionError, "cannot_connect"),
],
)
async def test_form_fails(
hass: HomeAssistant, error: Exception, message: str, mock_api: MagicMock
) -> None:
"""Test flow fails when api exception is raised."""
mock_api.return_value.get_ha_sensor_data.side_effect = GlancesApiConnectionError mock_api.return_value.get_ha_sensor_data.side_effect = [error, HA_SENSOR_DATA]
result = await hass.config_entries.flow.async_init( result = await hass.config_entries.flow.async_init(
glances.DOMAIN, context={"source": config_entries.SOURCE_USER} glances.DOMAIN, context={"source": config_entries.SOURCE_USER}
) )
@ -51,7 +63,13 @@ async def test_form_cannot_connect(hass: HomeAssistant, mock_api: MagicMock) ->
) )
assert result["type"] == FlowResultType.FORM assert result["type"] == FlowResultType.FORM
assert result["errors"] == {"base": "cannot_connect"} assert result["errors"] == {"base": message}
result = await hass.config_entries.flow.async_configure(
result["flow_id"], user_input=MOCK_USER_INPUT
)
assert result["type"] == FlowResultType.CREATE_ENTRY
async def test_form_already_configured(hass: HomeAssistant) -> None: async def test_form_already_configured(hass: HomeAssistant) -> None: