mirror of
https://github.com/home-assistant/core.git
synced 2025-07-22 20:57:21 +00:00
Move integration setup to coordinator _async_setup
in Bring (#135711)
This commit is contained in:
parent
2f5545e7b8
commit
958b1e7759
@ -4,20 +4,13 @@ from __future__ import annotations
|
|||||||
|
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
from bring_api import (
|
from bring_api import Bring
|
||||||
Bring,
|
|
||||||
BringAuthException,
|
|
||||||
BringParseException,
|
|
||||||
BringRequestException,
|
|
||||||
)
|
|
||||||
|
|
||||||
from homeassistant.config_entries import ConfigEntry
|
from homeassistant.config_entries import ConfigEntry
|
||||||
from homeassistant.const import CONF_EMAIL, CONF_PASSWORD, Platform
|
from homeassistant.const import CONF_EMAIL, CONF_PASSWORD, Platform
|
||||||
from homeassistant.core import HomeAssistant
|
from homeassistant.core import HomeAssistant
|
||||||
from homeassistant.exceptions import ConfigEntryAuthFailed, ConfigEntryNotReady
|
|
||||||
from homeassistant.helpers.aiohttp_client import async_get_clientsession
|
from homeassistant.helpers.aiohttp_client import async_get_clientsession
|
||||||
|
|
||||||
from .const import DOMAIN
|
|
||||||
from .coordinator import BringDataUpdateCoordinator
|
from .coordinator import BringDataUpdateCoordinator
|
||||||
|
|
||||||
PLATFORMS: list[Platform] = [Platform.SENSOR, Platform.TODO]
|
PLATFORMS: list[Platform] = [Platform.SENSOR, Platform.TODO]
|
||||||
@ -30,30 +23,8 @@ type BringConfigEntry = ConfigEntry[BringDataUpdateCoordinator]
|
|||||||
async def async_setup_entry(hass: HomeAssistant, entry: BringConfigEntry) -> bool:
|
async def async_setup_entry(hass: HomeAssistant, entry: BringConfigEntry) -> bool:
|
||||||
"""Set up Bring! from a config entry."""
|
"""Set up Bring! from a config entry."""
|
||||||
|
|
||||||
email = entry.data[CONF_EMAIL]
|
|
||||||
password = entry.data[CONF_PASSWORD]
|
|
||||||
|
|
||||||
session = async_get_clientsession(hass)
|
session = async_get_clientsession(hass)
|
||||||
bring = Bring(session, email, password)
|
bring = Bring(session, entry.data[CONF_EMAIL], entry.data[CONF_PASSWORD])
|
||||||
|
|
||||||
try:
|
|
||||||
await bring.login()
|
|
||||||
except BringRequestException as e:
|
|
||||||
raise ConfigEntryNotReady(
|
|
||||||
translation_domain=DOMAIN,
|
|
||||||
translation_key="setup_request_exception",
|
|
||||||
) from e
|
|
||||||
except BringParseException as e:
|
|
||||||
raise ConfigEntryNotReady(
|
|
||||||
translation_domain=DOMAIN,
|
|
||||||
translation_key="setup_parse_exception",
|
|
||||||
) from e
|
|
||||||
except BringAuthException as e:
|
|
||||||
raise ConfigEntryAuthFailed(
|
|
||||||
translation_domain=DOMAIN,
|
|
||||||
translation_key="setup_authentication_exception",
|
|
||||||
translation_placeholders={CONF_EMAIL: email},
|
|
||||||
) from e
|
|
||||||
|
|
||||||
coordinator = BringDataUpdateCoordinator(hass, bring)
|
coordinator = BringDataUpdateCoordinator(hass, bring)
|
||||||
await coordinator.async_config_entry_first_refresh()
|
await coordinator.async_config_entry_first_refresh()
|
||||||
|
@ -16,7 +16,7 @@ from bring_api.types import BringItemsResponse, BringList, BringUserSettingsResp
|
|||||||
from homeassistant.config_entries import ConfigEntry
|
from homeassistant.config_entries import ConfigEntry
|
||||||
from homeassistant.const import CONF_EMAIL
|
from homeassistant.const import CONF_EMAIL
|
||||||
from homeassistant.core import HomeAssistant
|
from homeassistant.core import HomeAssistant
|
||||||
from homeassistant.exceptions import ConfigEntryAuthFailed
|
from homeassistant.exceptions import ConfigEntryAuthFailed, ConfigEntryNotReady
|
||||||
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
|
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
|
||||||
|
|
||||||
from .const import DOMAIN
|
from .const import DOMAIN
|
||||||
@ -51,7 +51,7 @@ class BringDataUpdateCoordinator(DataUpdateCoordinator[dict[str, BringData]]):
|
|||||||
raise UpdateFailed("Unable to connect and retrieve data from bring") from e
|
raise UpdateFailed("Unable to connect and retrieve data from bring") from e
|
||||||
except BringParseException as e:
|
except BringParseException as e:
|
||||||
raise UpdateFailed("Unable to parse response from bring") from e
|
raise UpdateFailed("Unable to parse response from bring") from e
|
||||||
except BringAuthException as e:
|
except BringAuthException:
|
||||||
# try to recover by refreshing access token, otherwise
|
# try to recover by refreshing access token, otherwise
|
||||||
# initiate reauth flow
|
# initiate reauth flow
|
||||||
try:
|
try:
|
||||||
@ -64,9 +64,7 @@ class BringDataUpdateCoordinator(DataUpdateCoordinator[dict[str, BringData]]):
|
|||||||
translation_key="setup_authentication_exception",
|
translation_key="setup_authentication_exception",
|
||||||
translation_placeholders={CONF_EMAIL: self.bring.mail},
|
translation_placeholders={CONF_EMAIL: self.bring.mail},
|
||||||
) from exc
|
) from exc
|
||||||
raise UpdateFailed(
|
return self.data
|
||||||
"Authentication failed but re-authentication was successful, trying again later"
|
|
||||||
) from e
|
|
||||||
|
|
||||||
list_dict: dict[str, BringData] = {}
|
list_dict: dict[str, BringData] = {}
|
||||||
for lst in lists_response["lists"]:
|
for lst in lists_response["lists"]:
|
||||||
@ -88,13 +86,22 @@ class BringDataUpdateCoordinator(DataUpdateCoordinator[dict[str, BringData]]):
|
|||||||
async def _async_setup(self) -> None:
|
async def _async_setup(self) -> None:
|
||||||
"""Set up coordinator."""
|
"""Set up coordinator."""
|
||||||
|
|
||||||
await self.async_refresh_user_settings()
|
|
||||||
|
|
||||||
async def async_refresh_user_settings(self) -> None:
|
|
||||||
"""Refresh user settings."""
|
|
||||||
try:
|
try:
|
||||||
|
await self.bring.login()
|
||||||
self.user_settings = await self.bring.get_all_user_settings()
|
self.user_settings = await self.bring.get_all_user_settings()
|
||||||
except (BringAuthException, BringRequestException, BringParseException) as e:
|
except BringRequestException as e:
|
||||||
raise UpdateFailed(
|
raise ConfigEntryNotReady(
|
||||||
"Unable to connect and retrieve user settings from bring"
|
translation_domain=DOMAIN,
|
||||||
|
translation_key="setup_request_exception",
|
||||||
|
) from e
|
||||||
|
except BringParseException as e:
|
||||||
|
raise ConfigEntryNotReady(
|
||||||
|
translation_domain=DOMAIN,
|
||||||
|
translation_key="setup_parse_exception",
|
||||||
|
) from e
|
||||||
|
except BringAuthException as e:
|
||||||
|
raise ConfigEntryAuthFailed(
|
||||||
|
translation_domain=DOMAIN,
|
||||||
|
translation_key="setup_authentication_exception",
|
||||||
|
translation_placeholders={CONF_EMAIL: self.bring.mail},
|
||||||
) from e
|
) from e
|
||||||
|
@ -8,7 +8,7 @@ import uuid
|
|||||||
from bring_api.types import BringAuthResponse
|
from bring_api.types import BringAuthResponse
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from homeassistant.components.bring import DOMAIN
|
from homeassistant.components.bring.const import DOMAIN
|
||||||
from homeassistant.const import CONF_EMAIL, CONF_PASSWORD
|
from homeassistant.const import CONF_EMAIL, CONF_PASSWORD
|
||||||
|
|
||||||
from tests.common import MockConfigEntry, load_json_object_fixture
|
from tests.common import MockConfigEntry, load_json_object_fixture
|
||||||
@ -43,6 +43,7 @@ def mock_bring_client() -> Generator[AsyncMock]:
|
|||||||
):
|
):
|
||||||
client = mock_client.return_value
|
client = mock_client.return_value
|
||||||
client.uuid = UUID
|
client.uuid = UUID
|
||||||
|
client.mail = EMAIL
|
||||||
client.login.return_value = cast(BringAuthResponse, {"name": "Bring"})
|
client.login.return_value = cast(BringAuthResponse, {"name": "Bring"})
|
||||||
client.load_lists.return_value = load_json_object_fixture("lists.json", DOMAIN)
|
client.load_lists.return_value = load_json_object_fixture("lists.json", DOMAIN)
|
||||||
client.get_list.return_value = load_json_object_fixture("items.json", DOMAIN)
|
client.get_list.return_value = load_json_object_fixture("items.json", DOMAIN)
|
||||||
|
@ -3,15 +3,11 @@
|
|||||||
from datetime import timedelta
|
from datetime import timedelta
|
||||||
from unittest.mock import AsyncMock
|
from unittest.mock import AsyncMock
|
||||||
|
|
||||||
|
from bring_api import BringAuthException, BringParseException, BringRequestException
|
||||||
from freezegun.api import FrozenDateTimeFactory
|
from freezegun.api import FrozenDateTimeFactory
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from homeassistant.components.bring import (
|
from homeassistant.components.bring import async_setup_entry
|
||||||
BringAuthException,
|
|
||||||
BringParseException,
|
|
||||||
BringRequestException,
|
|
||||||
async_setup_entry,
|
|
||||||
)
|
|
||||||
from homeassistant.components.bring.const import DOMAIN
|
from homeassistant.components.bring.const import DOMAIN
|
||||||
from homeassistant.config_entries import ConfigEntryDisabler, ConfigEntryState
|
from homeassistant.config_entries import ConfigEntryDisabler, ConfigEntryState
|
||||||
from homeassistant.core import HomeAssistant
|
from homeassistant.core import HomeAssistant
|
||||||
@ -120,13 +116,20 @@ async def test_config_entry_not_ready(
|
|||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
"exception", [None, BringAuthException, BringRequestException, BringParseException]
|
("exception", "state"),
|
||||||
|
[
|
||||||
|
(None, ConfigEntryState.LOADED),
|
||||||
|
(BringAuthException, ConfigEntryState.SETUP_ERROR),
|
||||||
|
(BringRequestException, ConfigEntryState.SETUP_RETRY),
|
||||||
|
(BringParseException, ConfigEntryState.SETUP_RETRY),
|
||||||
|
],
|
||||||
)
|
)
|
||||||
async def test_config_entry_not_ready_auth_error(
|
async def test_config_entry_not_ready_auth_error(
|
||||||
hass: HomeAssistant,
|
hass: HomeAssistant,
|
||||||
bring_config_entry: MockConfigEntry,
|
bring_config_entry: MockConfigEntry,
|
||||||
mock_bring_client: AsyncMock,
|
mock_bring_client: AsyncMock,
|
||||||
exception: Exception | None,
|
exception: Exception | None,
|
||||||
|
state: ConfigEntryState,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Test config entry not ready from authentication error."""
|
"""Test config entry not ready from authentication error."""
|
||||||
|
|
||||||
@ -137,7 +140,7 @@ async def test_config_entry_not_ready_auth_error(
|
|||||||
await hass.config_entries.async_setup(bring_config_entry.entry_id)
|
await hass.config_entries.async_setup(bring_config_entry.entry_id)
|
||||||
await hass.async_block_till_done()
|
await hass.async_block_till_done()
|
||||||
|
|
||||||
assert bring_config_entry.state is ConfigEntryState.SETUP_RETRY
|
assert bring_config_entry.state is state
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.usefixtures("mock_bring_client")
|
@pytest.mark.usefixtures("mock_bring_client")
|
||||||
|
@ -5,7 +5,7 @@ from typing import cast
|
|||||||
from bring_api import BringUserSettingsResponse
|
from bring_api import BringUserSettingsResponse
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from homeassistant.components.bring import DOMAIN
|
from homeassistant.components.bring.const import DOMAIN
|
||||||
from homeassistant.components.bring.coordinator import BringData
|
from homeassistant.components.bring.coordinator import BringData
|
||||||
from homeassistant.components.bring.util import list_language, sum_attributes
|
from homeassistant.components.bring.util import list_language, sum_attributes
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user