Compare commits

..

1 Commits

Author SHA1 Message Date
Franck Nijhof 3ebf7e1417 Fix Growatt setup failure on API rate limit 2026-05-28 16:46:22 +00:00
48 changed files with 266 additions and 1109 deletions
-1
View File
@@ -6,7 +6,6 @@
"lg_netcast",
"lg_soundbar",
"lg_thinq",
"lg_tv_rs232",
"webostv"
]
}
+16 -41
View File
@@ -5,12 +5,8 @@ from typing import Any
import voluptuous as vol
from homeassistant.components import labs, websocket_api
from homeassistant.components.hassio import HassioNotReadyError
from homeassistant.config_entries import SOURCE_SYSTEM, ConfigEntry
from homeassistant.core import HomeAssistant, callback
from homeassistant.exceptions import ConfigEntryNotReady
from homeassistant.helpers import discovery_flow
from homeassistant.helpers.start import async_at_started
from homeassistant.const import EVENT_HOMEASSISTANT_STARTED
from homeassistant.core import Event, HomeAssistant, callback
from homeassistant.helpers.typing import ConfigType
from homeassistant.util.hass_dict import HassKey
@@ -53,7 +49,6 @@ CONFIG_SCHEMA = vol.Schema(
)
DATA_COMPONENT: HassKey[Analytics] = HassKey(DOMAIN)
_DATA_SNAPSHOTS_URL: HassKey[str | None] = HassKey(f"{DOMAIN}_snapshots_url")
LABS_SNAPSHOT_FEATURE = "snapshots"
@@ -62,39 +57,18 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
"""Set up the analytics integration."""
analytics_config = config.get(DOMAIN, {})
snapshots_url: str | None = None
if CONF_SNAPSHOTS_URL in analytics_config:
await labs.async_update_preview_feature(
hass, DOMAIN, LABS_SNAPSHOT_FEATURE, enabled=True
)
snapshots_url = analytics_config[CONF_SNAPSHOTS_URL]
else:
snapshots_url = None
hass.data[_DATA_SNAPSHOTS_URL] = snapshots_url
discovery_flow.async_create_flow(
hass, DOMAIN, context={"source": SOURCE_SYSTEM}, data={}
)
websocket_api.async_register_command(hass, websocket_analytics)
websocket_api.async_register_command(hass, websocket_analytics_preferences)
hass.http.register_view(AnalyticsDevicesView)
return True
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
"""Set up Analytics from a config entry."""
snapshots_url = hass.data[_DATA_SNAPSHOTS_URL]
analytics = Analytics(hass, snapshots_url)
try:
await analytics.load()
except HassioNotReadyError as err:
raise ConfigEntryNotReady(
translation_domain=DOMAIN,
translation_key="supervisor_not_ready",
) from err
# Load stored data
await analytics.load()
started = False
@@ -106,8 +80,8 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
if started:
await analytics.async_schedule()
async def start_schedule(hass: HomeAssistant) -> None:
"""Start the send schedule once Home Assistant has started."""
async def start_schedule(_event: Event) -> None:
"""Start the send schedule after the started event."""
nonlocal started
started = True
await analytics.async_schedule()
@@ -115,7 +89,12 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
labs.async_subscribe_preview_feature(
hass, DOMAIN, LABS_SNAPSHOT_FEATURE, _async_handle_labs_update
)
async_at_started(hass, start_schedule)
hass.bus.async_listen_once(EVENT_HOMEASSISTANT_STARTED, start_schedule)
websocket_api.async_register_command(hass, websocket_analytics)
websocket_api.async_register_command(hass, websocket_analytics_preferences)
hass.http.register_view(AnalyticsDevicesView)
hass.data[DATA_COMPONENT] = analytics
return True
@@ -130,9 +109,7 @@ def websocket_analytics(
msg: dict[str, Any],
) -> None:
"""Return analytics preferences."""
if (analytics := hass.data.get(DATA_COMPONENT)) is None:
connection.send_error(msg["id"], websocket_api.ERR_NOT_FOUND, "Not loaded")
return
analytics = hass.data[DATA_COMPONENT]
connection.send_result(
msg["id"],
{ATTR_PREFERENCES: analytics.preferences, ATTR_ONBOARDED: analytics.onboarded},
@@ -153,10 +130,8 @@ async def websocket_analytics_preferences(
msg: dict[str, Any],
) -> None:
"""Update analytics preferences."""
if (analytics := hass.data.get(DATA_COMPONENT)) is None:
connection.send_error(msg["id"], websocket_api.ERR_NOT_FOUND, "Not loaded")
return
preferences = msg[ATTR_PREFERENCES]
analytics = hass.data[DATA_COMPONENT]
await analytics.save_preferences(preferences)
await analytics.async_schedule()
@@ -299,8 +299,12 @@ class Analytics:
self._data = AnalyticsData.from_dict(stored)
if self.supervisor and not self.onboarded:
# This may raise HassioNotReadyError if Supervisor was unreachable.
# The caller is responsible for handling this and triggering a retry.
# This may raise HassioNotReadyError if Supervisor was unreachable
# during setup of the Supervisor integration. That will fail setup
# of this integration. However there is no better option at this time
# since we need to get the diagnostic setting from Supervisor to correctly
# setup this integration and we can't raise ConfigEntryNotReady to
# trigger a retry from async_setup.
supervisor_info = hassio.get_supervisor_info(self._hass)
# User have not configured analytics, get this setting from the supervisor
@@ -345,10 +349,10 @@ class Analytics:
await self._save()
if self.supervisor:
# Try to pull Supervisor information, but don't fail if some or all
# of it is unavailable due to setup failures in the hassio integration.
with contextlib.suppress(hassio.HassioNotReadyError):
supervisor_info = hassio.get_supervisor_info(hass)
# get_supervisor_info was called during setup so we can't get here
# if it raised. The others may raise HassioNotReadyError if only some
# data was successfully fetched from Supervisor
supervisor_info = hassio.get_supervisor_info(hass)
with contextlib.suppress(hassio.HassioNotReadyError):
operating_system_info = hassio.get_os_info(hass)
with contextlib.suppress(hassio.HassioNotReadyError):
@@ -1,19 +0,0 @@
"""Config flow for Analytics integration."""
from typing import Any
from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
from .const import DOMAIN
class AnalyticsConfigFlow(ConfigFlow, domain=DOMAIN):
"""Handle a config flow for Analytics."""
VERSION = 1
async def async_step_system(
self, user_input: dict[str, Any] | None = None
) -> ConfigFlowResult:
"""Handle the initial step."""
return self.async_create_entry(title="Analytics", data={})
@@ -14,6 +14,5 @@
"report_issue_url": "https://github.com/OHF-Device-Database/device-database/issues/new"
}
},
"quality_scale": "internal",
"single_config_entry": true
"quality_scale": "internal"
}
@@ -1,9 +1,4 @@
{
"exceptions": {
"supervisor_not_ready": {
"message": "Supervisor was not ready during setup, will retry"
}
},
"preview_features": {
"snapshots": {
"description": "We're creating the [Open Home Foundation Device Database](https://www.home-assistant.io/blog/2026/02/02/about-device-database/): a free, open source community-powered resource to help users find practical information about how smart home devices perform in real installations.\n\nYou can help us build it by opting in to share anonymized data about your devices. This data will only ever include device-specific details (like model or manufacturer) never personally identifying information (like the names you assign).\n\nFind out how we process your data (should you choose to contribute) in our [Data Use Statement](https://www.openhomefoundation.org/device-database-data-use-statement).",
@@ -92,7 +92,7 @@ class BroadlinkRadioFrequency(BroadlinkEntity, RadioFrequencyTransmitterEntity):
"""Representation of a Broadlink RF transmitter."""
_attr_has_entity_name = True
_attr_translation_key = "rf_transmitter"
_attr_name = None
def __init__(self, device: BroadlinkDevice) -> None:
"""Initialize the entity."""
@@ -54,11 +54,6 @@
"name": "IR emitter"
}
},
"radio_frequency": {
"rf_transmitter": {
"name": "RF transmitter"
}
},
"select": {
"day_of_week": {
"name": "Day of week",
+2 -12
View File
@@ -86,6 +86,7 @@ class DucoCoordinator(DataUpdateCoordinator[DucoData]):
"""Fetch node data from the Duco box."""
try:
nodes = await self.client.async_get_nodes()
lan_info = await self.client.async_get_lan_info()
except DucoConnectionError as err:
raise UpdateFailed(
translation_domain=DOMAIN,
@@ -99,18 +100,7 @@ class DucoCoordinator(DataUpdateCoordinator[DucoData]):
translation_placeholders={"error": repr(err)},
) from err
# LAN info only backs the diagnostic RSSI sensor, so failures on this
# supplemental endpoint, including connection failures, should not make
# the primary node entities unavailable.
rssi_wifi = self.data.rssi_wifi if self.data else None
try:
lan_info = await self.client.async_get_lan_info()
except DucoError as err:
_LOGGER.debug("Could not fetch Duco LAN info", exc_info=err)
else:
rssi_wifi = lan_info.rssi_wifi
return DucoData(
nodes={node.node_id: node for node in nodes},
rssi_wifi=rssi_wifi,
rssi_wifi=lan_info.rssi_wifi,
)
@@ -199,7 +199,6 @@ DEVICE_CLASS_TO_GOOGLE_TYPES = {
(media_player.DOMAIN, media_player.MediaPlayerDeviceClass.RECEIVER): TYPE_RECEIVER,
(media_player.DOMAIN, media_player.MediaPlayerDeviceClass.SPEAKER): TYPE_SPEAKER,
(media_player.DOMAIN, media_player.MediaPlayerDeviceClass.TV): TYPE_TV,
(media_player.DOMAIN, media_player.MediaPlayerDeviceClass.PROJECTOR): TYPE_TV,
(sensor.DOMAIN, sensor.SensorDeviceClass.AQI): TYPE_SENSOR,
(sensor.DOMAIN, sensor.SensorDeviceClass.HUMIDITY): TYPE_SENSOR,
(sensor.DOMAIN, sensor.SensorDeviceClass.TEMPERATURE): TYPE_SENSOR,
@@ -2728,11 +2728,7 @@ class ChannelTrait(_Trait):
if (
domain == media_player.DOMAIN
and (features & MediaPlayerEntityFeature.PLAY_MEDIA)
and device_class
in (
media_player.MediaPlayerDeviceClass.TV,
media_player.MediaPlayerDeviceClass.PROJECTOR,
)
and device_class == media_player.MediaPlayerDeviceClass.TV
):
return True
@@ -34,7 +34,11 @@ from requests import RequestException
from homeassistant.const import CONF_PASSWORD, CONF_TOKEN, CONF_URL, CONF_USERNAME
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import ConfigEntryAuthFailed, ConfigEntryError
from homeassistant.exceptions import (
ConfigEntryAuthFailed,
ConfigEntryError,
ConfigEntryNotReady,
)
from homeassistant.helpers import config_validation as cv, device_registry as dr
from homeassistant.helpers.dispatcher import async_dispatcher_send
from homeassistant.helpers.event import async_track_time_interval
@@ -55,6 +59,7 @@ from .const import (
PLATFORMS,
SUPPORTED_DEVICE_TYPES,
V1_API_ERROR_NO_PRIVILEGE,
V1_API_ERROR_RATE_LIMITED,
V1_DEVICE_TYPES,
)
from .coordinator import GrowattConfigEntry, GrowattCoordinator
@@ -264,6 +269,10 @@ def get_device_list_v1(
raise ConfigEntryAuthFailed(
f"Authentication failed for Growatt API: {e.error_msg or str(e)}"
) from e
if e.error_code == V1_API_ERROR_RATE_LIMITED:
raise ConfigEntryNotReady(
f"Growatt API rate limited, will retry: {e.error_msg or str(e)}"
) from e
raise ConfigEntryError(
f"API error during device list: {e.error_msg or str(e)}"
f" (Code: {e.error_code})"
@@ -202,10 +202,7 @@ def get_accessory( # noqa: C901
if device_class == MediaPlayerDeviceClass.RECEIVER:
a_type = "ReceiverMediaPlayer"
elif device_class in (
MediaPlayerDeviceClass.TV,
MediaPlayerDeviceClass.PROJECTOR,
):
elif device_class == MediaPlayerDeviceClass.TV:
a_type = "TelevisionMediaPlayer"
elif validate_media_player_features(state, feature_list):
a_type = "MediaPlayer"
+1 -5
View File
@@ -695,11 +695,7 @@ def state_needs_accessory_mode(state: State) -> bool:
return (
state.domain == MEDIA_PLAYER_DOMAIN
and state.attributes.get(ATTR_DEVICE_CLASS)
in (
MediaPlayerDeviceClass.TV,
MediaPlayerDeviceClass.RECEIVER,
MediaPlayerDeviceClass.PROJECTOR,
)
in (MediaPlayerDeviceClass.TV, MediaPlayerDeviceClass.RECEIVER)
) or (
state.domain == REMOTE_DOMAIN
and state.attributes.get(ATTR_SUPPORTED_FEATURES, 0)
+1 -3
View File
@@ -108,7 +108,5 @@ def create_matter_ble_proxy(hass: HomeAssistant, ws_url: str) -> MatterBleProxy:
ws_url=ws_url,
scan_source=HaBluetoothScanSource(hass),
device_resolver=HaBluetoothDeviceResolver(hass),
task_factory=lambda coro: hass.async_create_background_task(
coro, name="matter_ble_proxy"
),
task_factory=hass.async_create_task,
)
@@ -155,7 +155,6 @@ class MediaPlayerDeviceClass(StrEnum):
TV = "tv"
SPEAKER = "speaker"
RECEIVER = "receiver"
PROJECTOR = "projector"
DEVICE_CLASSES_SCHEMA = vol.All(vol.Lower, vol.Coerce(MediaPlayerDeviceClass))
@@ -34,12 +34,6 @@
"playing": "mdi:cast-connected"
}
},
"projector": {
"default": "mdi:projector",
"state": {
"off": "mdi:projector-off"
}
},
"receiver": {
"default": "mdi:audio-video",
"state": {
@@ -261,9 +261,6 @@
}
}
},
"projector": {
"name": "Projector"
},
"receiver": {
"name": "Receiver"
},
@@ -38,7 +38,7 @@
"requirements": [
"getmac==0.9.5",
"samsungctl[websocket]==0.7.1",
"samsungtvws[async,encrypted]==3.0.5",
"samsungtvws[async,encrypted]==2.7.2",
"wakeonlan==3.3.0",
"async-upnp-client==0.46.2"
],
@@ -6,7 +6,6 @@ import logging
from sense_energy import (
ASyncSenseable,
SenseAPIException,
SenseAuthenticationException,
SenseMFARequiredException,
)
@@ -89,10 +88,6 @@ async def async_setup_entry(hass: HomeAssistant, entry: SenseConfigEntry) -> boo
) from err
except SENSE_WEBSOCKET_EXCEPTIONS as err:
raise ConfigEntryNotReady(str(err) or "Error during realtime update") from err
except SenseAPIException as err:
raise ConfigEntryNotReady(
str(err) or "API error retrieving realtime data"
) from err
trends_coordinator = SenseTrendCoordinator(hass, entry, gateway)
realtime_coordinator = SenseRealtimeCoordinator(hass, entry, gateway)
@@ -6,7 +6,6 @@ from typing import TYPE_CHECKING
from sense_energy import (
ASyncSenseable,
SenseAPIException,
SenseAuthenticationException,
SenseMFARequiredException,
)
@@ -94,8 +93,6 @@ class SenseRealtimeCoordinator(SenseCoordinator):
try:
await self._gateway.update_realtime()
except SENSE_TIMEOUT_EXCEPTIONS as ex:
raise UpdateFailed(f"Timeout retrieving realtime data: {ex}") from ex
_LOGGER.error("Timeout retrieving data: %s", ex)
except SENSE_WEBSOCKET_EXCEPTIONS as ex:
raise UpdateFailed(f"Failed to update realtime data: {ex}") from ex
except SenseAPIException as ex:
raise UpdateFailed(f"API error retrieving realtime data: {ex}") from ex
_LOGGER.error("Failed to update data: %s", ex)
@@ -50,7 +50,6 @@ DEVICE_CLASS_MAP: dict[Category | str, MediaPlayerDeviceClass] = {
Category.SPEAKER: MediaPlayerDeviceClass.SPEAKER,
Category.TELEVISION: MediaPlayerDeviceClass.TV,
Category.RECEIVER: MediaPlayerDeviceClass.RECEIVER,
Category.PROJECTOR: MediaPlayerDeviceClass.PROJECTOR,
}
VALUE_TO_STATE = {
+6 -6
View File
@@ -3759,12 +3759,6 @@
"iot_class": "cloud_push",
"name": "LG ThinQ"
},
"lg_tv_rs232": {
"integration_type": "device",
"config_flow": true,
"iot_class": "local_polling",
"name": "LG TV via Serial"
},
"webostv": {
"integration_type": "device",
"config_flow": true,
@@ -3773,6 +3767,12 @@
}
}
},
"lg_tv_rs232": {
"name": "LG TV via Serial",
"integration_type": "device",
"config_flow": true,
"iot_class": "local_polling"
},
"libre_hardware_monitor": {
"name": "Libre Hardware Monitor",
"integration_type": "device",
-23
View File
@@ -99,8 +99,6 @@ Every check has a code following the
| `W7407` | [`home-assistant-config-flow-polling-field`](#w7407-home-assistant-config-flow-polling-field) | Config flow should not include polling interval fields |
| `W7408` | [`home-assistant-config-flow-name-field`](#w7408-home-assistant-config-flow-name-field) | Config flow should not include name fields |
| `R7402` | [`home-assistant-unused-test-fixture-argument`](#r7402-home-assistant-unused-test-fixture-argument) | Unused test function argument should use `@pytest.mark.usefixtures` |
| `W7418` | [`home-assistant-tests-direct-async-setup-entry`](#w7418-home-assistant-tests-direct-async-setup-entry) | Tests should not call an integration's `async_setup_entry` directly |
| `W7420` | [`home-assistant-tests-direct-platform-async-setup-entry`](#w7420-home-assistant-tests-direct-platform-async-setup-entry) | Tests should not call a platform's `async_setup_entry` directly |
| `W7422` | [`home-assistant-tests-direct-async-setup`](#w7422-home-assistant-tests-direct-async-setup) | Tests should not call an integration's `async_setup` directly |
@@ -344,27 +342,6 @@ only needed for its side effects.
This rule only applies to `test_*` functions, not to fixture functions.
## `home_assistant_tests_direct_async_setup_entry` checker
Detects tests that call an integration's `async_setup_entry` directly.
### `W7418`: `home-assistant-tests-direct-async-setup-entry`
Tests should not invoke an integration's `async_setup_entry` from
`__init__.py` directly. Instead, tests should let Home Assistant perform
the setup via `await hass.config_entries.async_setup(entry.entry_id)` so
that the real setup pipeline (platforms, services, listeners, unload
handlers, etc.) is exercised.
### `W7420`: `home-assistant-tests-direct-platform-async-setup-entry`
Same as `W7418`, but for an entity platform's `async_setup_entry` (e.g.
`homeassistant.components.<integration>.sensor.async_setup_entry`).
Tests should drive setup through `hass.config_entries.async_setup` so
the platform is loaded via the normal Home Assistant flow.
See [epic #77](https://github.com/home-assistant/epics/issues/77).
## `home_assistant_tests_direct_async_setup` checker
@@ -1,138 +0,0 @@
"""Checker for direct calls to ``async_setup_entry`` from tests.
Tests should not invoke an integration's ``async_setup_entry`` directly
(either the one in ``__init__.py`` or in an entity-platform module).
Instead, tests should let Home Assistant perform the setup via
``await hass.config_entries.async_setup(entry.entry_id)`` so that the
real setup pipeline (platforms, services, listeners, unload handlers,
etc.) is exercised.
This checker flags any call to ``async_setup_entry`` (whether awaited or
not, accessed as a name or an attribute) made from a test module whose
target resolves to a module-level function defined under
``homeassistant.components.*``. The integration-init case and the
entity-platform case get separate messages so violations can be tracked
and fixed independently.
"""
from enum import Enum
import astroid
from astroid import nodes
from pylint.checkers import BaseChecker
from pylint.lint import PyLinter
from pylint_home_assistant.helpers.module_info import is_test_module, parse_module
class _SetupKind(Enum):
"""The kind of integration ``async_setup_entry`` being called."""
INIT = "init"
PLATFORM = "platform"
def _resolve_integration_async_setup_entry(call: nodes.Call) -> _SetupKind | None:
"""Return the kind of integration ``async_setup_entry`` *call* targets.
Returns ``_SetupKind.INIT`` if the target is in the integration's
``__init__`` module, ``_SetupKind.PLATFORM`` if it is in an
entity-platform module, or ``None`` if the call does not resolve to
an integration's ``async_setup_entry``.
"""
func = call.func
match func:
case nodes.Attribute(attrname="async_setup_entry"):
pass
case nodes.Name(name="async_setup_entry"):
pass
case _:
return None
seen_qnames: set[str] = set()
try:
for inferred in func.infer():
if inferred is astroid.Uninferable:
continue
if not isinstance(inferred, (nodes.FunctionDef, nodes.AsyncFunctionDef)):
continue
# Require the function to be defined at module level so that
# class methods named ``async_setup_entry`` (whose qname
# includes the class name) are not classified as integration
# setup functions.
if not isinstance(inferred.parent, nodes.Module):
continue
module_qname = inferred.parent.qname()
if not module_qname or module_qname in seen_qnames:
continue
seen_qnames.add(module_qname)
parsed = parse_module(module_qname)
if parsed is None:
continue
return _SetupKind.INIT if parsed.module is None else _SetupKind.PLATFORM
except astroid.exceptions.InferenceError, astroid.exceptions.AstroidError:
return None
return None
class DirectAsyncSetupEntry(BaseChecker):
"""Checker for direct calls to async_setup_entry in tests."""
name = "home_assistant_tests_direct_async_setup_entry"
priority = -1
msgs = {
"W7418": (
(
"Do not call `async_setup_entry` directly from tests; use "
"`await hass.config_entries.async_setup(entry.entry_id)` instead"
),
"home-assistant-tests-direct-async-setup-entry",
(
"Used when a test module calls an integration's "
"`async_setup_entry` from `__init__.py` directly. Tests should "
"let Home Assistant drive the setup so the full setup pipeline "
"is exercised."
),
),
"W7420": (
(
"Do not call a platform's `async_setup_entry` directly from "
"tests; use `await hass.config_entries.async_setup(entry.entry_id)`"
" instead"
),
"home-assistant-tests-direct-platform-async-setup-entry",
(
"Used when a test module calls an integration entity platform's "
"`async_setup_entry` directly. Tests should let Home Assistant "
"drive the setup so the full setup pipeline is exercised."
),
),
}
options = ()
_in_test_module: bool = False
def visit_module(self, node: nodes.Module) -> None:
"""Record whether the current module is a test module."""
self._in_test_module = is_test_module(node.name)
def visit_call(self, node: nodes.Call) -> None:
"""Flag direct calls to an integration's async_setup_entry."""
if not self._in_test_module:
return
match _resolve_integration_async_setup_entry(node):
case _SetupKind.INIT:
self.add_message(
"home-assistant-tests-direct-async-setup-entry",
node=node,
)
case _SetupKind.PLATFORM:
self.add_message(
"home-assistant-tests-direct-platform-async-setup-entry",
node=node,
)
def register(linter: PyLinter) -> None:
"""Register the checker."""
linter.register_checker(DirectAsyncSetupEntry(linter))
+1 -1
View File
@@ -2929,7 +2929,7 @@ rxv==0.7.0
samsungctl[websocket]==0.7.1
# homeassistant.components.samsungtv
samsungtvws[async,encrypted]==3.0.5
samsungtvws[async,encrypted]==2.7.2
# homeassistant.components.sanix
sanix==1.0.6
+1 -116
View File
@@ -6,18 +6,15 @@ from unittest.mock import patch
import pytest
from homeassistant.components.analytics import CONF_SNAPSHOTS_URL, LABS_SNAPSHOT_FEATURE
from homeassistant.components.analytics import LABS_SNAPSHOT_FEATURE
from homeassistant.components.analytics.const import (
BASIC_ENDPOINT_URL,
BASIC_ENDPOINT_URL_DEV,
DOMAIN,
SNAPSHOT_DEFAULT_URL,
SNAPSHOT_URL_PATH,
STORAGE_KEY,
)
from homeassistant.components.hassio import HassioNotReadyError
from homeassistant.components.labs import async_update_preview_feature
from homeassistant.config_entries import ConfigEntryState
from homeassistant.const import EVENT_HOMEASSISTANT_STARTED
from homeassistant.core import HomeAssistant
from homeassistant.setup import async_setup_component
@@ -40,118 +37,6 @@ async def test_setup(hass: HomeAssistant) -> None:
assert DOMAIN in hass.data
async def test_setup_with_snapshots_url(
hass: HomeAssistant,
hass_storage: dict[str, Any],
hass_ws_client: WebSocketGenerator,
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Test setup with snapshots_url in YAML config sends snapshots to that URL."""
custom_url = "https://custom-snapshot-endpoint.example.com"
snapshot_endpoint = custom_url + SNAPSHOT_URL_PATH
aioclient_mock.post(snapshot_endpoint, status=200, json={})
with patch(
"homeassistant.components.analytics.analytics._async_snapshot_payload",
return_value={"mock": {}},
):
assert await async_setup_component(hass, "labs", {})
assert await async_setup_component(
hass, DOMAIN, {DOMAIN: {CONF_SNAPSHOTS_URL: custom_url}}
)
await hass.async_block_till_done()
ws_client = await hass_ws_client(hass)
await ws_client.send_json_auto_id(
{"type": "analytics/preferences", "preferences": {"snapshots": True}}
)
assert (await ws_client.receive_json())["success"]
async_fire_time_changed(hass, dt_util.utcnow() + timedelta(hours=25))
await hass.async_block_till_done()
assert any(str(call[1]) == snapshot_endpoint for call in aioclient_mock.mock_calls)
async def test_setup_entry_supervisor_not_ready(hass: HomeAssistant) -> None:
"""Test that HassioNotReadyError raises ConfigEntryNotReady."""
with (
patch(
"homeassistant.components.analytics.analytics.is_hassio",
return_value=True,
),
patch(
"homeassistant.components.hassio.get_supervisor_info",
side_effect=HassioNotReadyError,
),
):
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {}})
await hass.async_block_till_done()
entry = hass.config_entries.async_entries(DOMAIN)[0]
assert entry.state is ConfigEntryState.SETUP_RETRY
async def test_schedule_starts_and_sends_analytics(
hass: HomeAssistant,
hass_storage: dict[str, Any],
hass_ws_client: WebSocketGenerator,
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Test that the analytics schedule fires and sends analytics after time travel."""
aioclient_mock.post(BASIC_ENDPOINT_URL, status=200)
aioclient_mock.post(BASIC_ENDPOINT_URL_DEV, status=200)
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {}})
await hass.async_block_till_done()
ws_client = await hass_ws_client(hass)
with patch("homeassistant.components.analytics.analytics.HA_VERSION", MOCK_VERSION):
await ws_client.send_json_auto_id(
{"type": "analytics/preferences", "preferences": {"base": True}}
)
assert (await ws_client.receive_json())["success"]
assert len(aioclient_mock.mock_calls) == 0
async_fire_time_changed(hass, dt_util.utcnow() + timedelta(seconds=901))
await hass.async_block_till_done()
assert len(aioclient_mock.mock_calls) == 1
@pytest.mark.parametrize(
("ws_type", "ws_options"),
[("analytics", {}), ("analytics/preferences", {"preferences": {"base": True}})],
)
async def test_websocket_not_loaded(
hass: HomeAssistant,
hass_ws_client: WebSocketGenerator,
ws_type: str,
ws_options: dict[str, Any],
) -> None:
"""Test websocket returns error when analytics entry failed to load."""
with (
patch(
"homeassistant.components.analytics.analytics.is_hassio",
return_value=True,
),
patch(
"homeassistant.components.hassio.get_supervisor_info",
side_effect=HassioNotReadyError,
),
):
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {}})
await hass.async_block_till_done()
ws_client = await hass_ws_client(hass)
await ws_client.send_json_auto_id({"type": ws_type} | ws_options)
response = await ws_client.receive_json()
assert not response["success"]
assert response["error"]["code"] == "not_found"
@pytest.mark.usefixtures("mock_snapshot_payload")
async def test_labs_feature_toggle(
hass: HomeAssistant,
@@ -81,7 +81,6 @@ async def test_config_exceptions(
),
pytest.raises(config_error),
):
# pylint: disable-next=home-assistant-tests-direct-async-setup-entry
await async_setup_entry(hass, config_entry)
-23
View File
@@ -98,29 +98,6 @@ async def test_setup_entry_success(
assert init_integration.state is ConfigEntryState.LOADED
@pytest.mark.parametrize(
"exception",
[
pytest.param(DucoError("lan info error"), id="duco_error"),
pytest.param(DucoConnectionError("lan info offline"), id="connection_error"),
],
)
async def test_setup_entry_ignores_lan_info_failures(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_duco_client: AsyncMock,
exception: Exception,
) -> None:
"""Test setup succeeds when the supplemental LAN info endpoint fails."""
mock_duco_client.async_get_lan_info.side_effect = exception
mock_config_entry.add_to_hass(hass)
await hass.config_entries.async_setup(mock_config_entry.entry_id)
await hass.async_block_till_done()
assert mock_config_entry.state is ConfigEntryState.LOADED
@pytest.mark.parametrize("unsupported_board_info", UNSUPPORTED_BOARD_INFOS)
async def test_setup_entry_unsupported_board_info(
hass: HomeAssistant,
+6 -16
View File
@@ -122,34 +122,24 @@ async def test_coordinator_update_duco_error_marks_unavailable(
assert state.state == STATE_UNAVAILABLE
@pytest.mark.parametrize(
"exception",
[
pytest.param(DucoError("lan info error"), id="duco_error"),
pytest.param(DucoConnectionError("lan info offline"), id="connection_error"),
],
)
@pytest.mark.usefixtures("entity_registry_enabled_by_default", "init_integration")
async def test_lan_info_failures_keep_node_entities_available(
async def test_lan_info_duco_error_marks_unavailable(
hass: HomeAssistant,
mock_duco_client: AsyncMock,
freezer: FrozenDateTimeFactory,
exception: Exception,
) -> None:
"""Test node entities stay available when LAN info retrieval fails."""
mock_duco_client.async_get_lan_info = AsyncMock(side_effect=exception)
"""Test entities become unavailable when async_get_lan_info raises DucoError."""
mock_duco_client.async_get_lan_info = AsyncMock(
side_effect=DucoError("lan info error")
)
freezer.tick(SCAN_INTERVAL)
async_fire_time_changed(hass)
await hass.async_block_till_done(wait_background_tasks=True)
state = hass.states.get("sensor.office_co2_carbon_dioxide")
assert state is not None
assert state.state == "405"
state = hass.states.get("sensor.living_signal_strength")
assert state is not None
assert state.state == "-60"
assert state.state == STATE_UNAVAILABLE
@pytest.mark.parametrize(
@@ -83,7 +83,6 @@ async def test_setup_entry_successful(hass: HomeAssistant) -> None:
"homeassistant.components.emulated_roku.binding.EmulatedRokuServer",
return_value=Mock(start=AsyncMock(), close=AsyncMock()),
) as instantiate:
# pylint: disable-next=home-assistant-tests-direct-async-setup-entry
assert await emulated_roku.async_setup_entry(hass, entry) is True
assert len(instantiate.mock_calls) == 1
@@ -102,7 +101,6 @@ async def test_unload_entry(hass: HomeAssistant) -> None:
"homeassistant.components.emulated_roku.binding.EmulatedRokuServer",
return_value=Mock(start=AsyncMock(), close=AsyncMock()),
):
# pylint: disable-next=home-assistant-tests-direct-async-setup-entry
assert await emulated_roku.async_setup_entry(hass, entry) is True
await hass.async_block_till_done()
@@ -4176,12 +4176,6 @@ async def test_channel(hass: HomeAssistant) -> None:
media_player.MediaPlayerDeviceClass.TV,
None,
)
assert trait.ChannelTrait.supported(
media_player.DOMAIN,
MediaPlayerEntityFeature.PLAY_MEDIA,
media_player.MediaPlayerDeviceClass.PROJECTOR,
None,
)
assert (
trait.ChannelTrait.supported(
media_player.DOMAIN,
@@ -20,6 +20,7 @@ from homeassistant.components.growatt_server.const import (
DEVICE_SCAN_INTERVAL,
DOMAIN,
LOGIN_INVALID_AUTH_CODE,
V1_API_ERROR_RATE_LIMITED,
V1_API_ERROR_WRONG_DOMAIN,
)
from homeassistant.config_entries import ConfigEntryState
@@ -79,6 +80,14 @@ async def test_device_info(
json.decoder.JSONDecodeError("Invalid JSON", "", 0),
ConfigEntryState.SETUP_ERROR,
),
(
growattServer.GrowattV1ApiError(
message="Rate limited",
error_code=V1_API_ERROR_RATE_LIMITED,
error_msg="Access frequency limit",
),
ConfigEntryState.SETUP_RETRY,
),
],
)
async def test_setup_error_on_api_failure(
@@ -246,13 +246,6 @@ def test_type_covers(type_name, entity_id, state, attrs) -> None:
{ATTR_DEVICE_CLASS: MediaPlayerDeviceClass.RECEIVER},
{},
),
(
"TelevisionMediaPlayer",
"media_player.projector",
"on",
{ATTR_DEVICE_CLASS: MediaPlayerDeviceClass.PROJECTOR},
{},
),
],
)
def test_type_media_player(type_name, entity_id, state, attrs, config) -> None:
-3
View File
@@ -32,7 +32,6 @@ async def test_ha_mqtt_publish(
mock_discovery.start.return_value = []
mock_discovery_class.return_value = mock_discovery
# pylint: disable-next=home-assistant-tests-direct-async-setup-entry
await inels.async_setup_entry(hass, config_entry)
topic, payload, qos, retain = "test/topic", "test_payload", 1, True
@@ -61,7 +60,6 @@ async def test_ha_mqtt_subscribe(
mock_discovery.start.return_value = []
mock_discovery_class.return_value = mock_discovery
# pylint: disable-next=home-assistant-tests-direct-async-setup-entry
await inels.async_setup_entry(hass, config_entry)
topic = "test/topic"
@@ -84,7 +82,6 @@ async def test_ha_mqtt_not_available(
),
pytest.raises(ConfigEntryNotReady, match="MQTT integration not available"),
):
# pylint: disable-next=home-assistant-tests-direct-async-setup-entry
await inels.async_setup_entry(hass, config_entry)
-1
View File
@@ -62,7 +62,6 @@ async def test_async_setup_entry_connection_error(
)
with pytest.raises(ConfigEntryNotReady):
# pylint: disable-next=home-assistant-tests-direct-async-setup-entry
await async_setup_entry(hass, mock_config_entry)
assert mock_iometer_client.get_current_status.await_count == 1
@@ -42,7 +42,6 @@ async def test_setup_demo_platform(hass: HomeAssistant) -> None:
"""Test setup."""
mock = MagicMock()
add_entities = mock.MagicMock()
# pylint: disable-next=home-assistant-tests-direct-platform-async-setup-entry
await demo.async_setup_entry(hass, {}, add_entities)
assert add_entities.call_count == 1
+1 -7
View File
@@ -69,15 +69,9 @@ def test_create_matter_ble_proxy_wires_ha_backends(hass: HomeAssistant) -> None:
assert kwargs["ws_url"] == "ws://localhost:5580/ble"
assert isinstance(kwargs["scan_source"], HaBluetoothScanSource)
assert isinstance(kwargs["device_resolver"], HaBluetoothDeviceResolver)
assert kwargs["task_factory"] == hass.async_create_task
assert result is proxy_cls.return_value
coro = MagicMock()
with patch.object(hass, "async_create_background_task") as bg_task:
task = kwargs["task_factory"](coro)
bg_task.assert_called_once_with(coro, name="matter_ble_proxy")
assert task is bg_task.return_value
async def test_scan_source_start_registers_passive_callback(
hass: HomeAssistant,
+4 -53
View File
@@ -1,21 +1,19 @@
"""The tests for Sense binary sensor platform."""
from datetime import timedelta
from unittest.mock import MagicMock, patch
from unittest.mock import MagicMock
from freezegun.api import FrozenDateTimeFactory
from sense_energy import SenseAPIException
from syrupy.assertion import SnapshotAssertion
from homeassistant.components.binary_sensor import DOMAIN as BINARY_SENSOR_DOMAIN
from homeassistant.components.sense.const import ACTIVE_UPDATE_RATE, DOMAIN
from homeassistant.const import STATE_OFF, STATE_ON, STATE_UNAVAILABLE, Platform
from homeassistant.components.sense.const import ACTIVE_UPDATE_RATE
from homeassistant.const import STATE_OFF, STATE_ON, Platform
from homeassistant.core import HomeAssistant
from homeassistant.helpers import entity_registry as er
from homeassistant.util.dt import utcnow
from . import setup_platform
from .const import DEVICE_1_ID, DEVICE_1_NAME, DEVICE_2_NAME, MONITOR_ID
from .const import DEVICE_1_NAME, DEVICE_2_NAME
from tests.common import MockConfigEntry, async_fire_time_changed, snapshot_platform
@@ -68,50 +66,3 @@ async def test_on_off_sensors(
state = hass.states.get(f"binary_sensor.{DEVICE_2_NAME.lower()}_power")
assert state.state == STATE_ON
async def test_realtime_update_exception(
hass: HomeAssistant,
mock_sense: MagicMock,
config_entry: MockConfigEntry,
freezer: FrozenDateTimeFactory,
) -> None:
"""Test that binary sensor entities become unavailable on realtime coordinator failure."""
await setup_platform(hass, config_entry, Platform.BINARY_SENSOR)
state = hass.states.get(f"binary_sensor.{DEVICE_1_NAME.lower()}_power")
assert state is not None
assert state.state != STATE_UNAVAILABLE
mock_sense.update_realtime.side_effect = SenseAPIException("api error")
freezer.tick(timedelta(seconds=ACTIVE_UPDATE_RATE))
async_fire_time_changed(hass, freezer())
await hass.async_block_till_done()
state = hass.states.get(f"binary_sensor.{DEVICE_1_NAME.lower()}_power")
assert state.state == STATE_UNAVAILABLE
async def test_migrate_unique_ids(
hass: HomeAssistant,
mock_sense: MagicMock,
config_entry: MockConfigEntry,
entity_registry: er.EntityRegistry,
) -> None:
"""Test that entities registered under the old bare device-ID unique_id are migrated."""
config_entry.add_to_hass(hass)
old_entry = entity_registry.async_get_or_create(
BINARY_SENSOR_DOMAIN,
DOMAIN,
DEVICE_1_ID,
config_entry=config_entry,
)
assert old_entry.unique_id == DEVICE_1_ID
with patch("homeassistant.components.sense.PLATFORMS", [Platform.BINARY_SENSOR]):
assert await hass.config_entries.async_setup(config_entry.entry_id)
await hass.async_block_till_done()
migrated = entity_registry.async_get(old_entry.entity_id)
assert migrated.unique_id == f"{MONITOR_ID}-{DEVICE_1_ID}"
+189 -127
View File
@@ -1,7 +1,6 @@
"""Test the Sense config flow."""
from collections.abc import Iterator
from unittest.mock import AsyncMock, MagicMock, patch
from unittest.mock import AsyncMock, patch
import pytest
from sense_energy import (
@@ -22,9 +21,9 @@ from .const import MOCK_CONFIG
from tests.common import MockConfigEntry
@pytest.fixture(name="mock_flow_sense")
def mock_flow_sense_fixture() -> Iterator[MagicMock]:
"""Mock Sense object for authentication."""
@pytest.fixture(name="mock_sense")
def mock_sense():
"""Mock Sense object for authenticatation."""
with patch(
"homeassistant.components.sense.config_flow.ASyncSenseable"
) as mock_sense:
@@ -38,196 +37,259 @@ def mock_flow_sense_fixture() -> Iterator[MagicMock]:
yield mock_sense
@pytest.mark.usefixtures("mock_flow_sense")
async def test_form(
hass: HomeAssistant,
mock_setup_entry: AsyncMock,
) -> None:
async def test_form(hass: HomeAssistant, mock_sense) -> None:
"""Test we get the form."""
result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": config_entries.SOURCE_USER}
)
assert result["type"] is FlowResultType.FORM
assert result["errors"] == {}
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
{"timeout": "6", "email": "test-email", "password": "test-password"},
)
await hass.async_block_till_done()
with patch(
"homeassistant.components.sense.async_setup_entry",
return_value=True,
) as mock_setup_entry:
result2 = await hass.config_entries.flow.async_configure(
result["flow_id"],
{"timeout": "6", "email": "test-email", "password": "test-password"},
)
await hass.async_block_till_done()
assert result["type"] is FlowResultType.CREATE_ENTRY
assert result["title"] == "test-email"
assert result["data"] == MOCK_CONFIG
mock_setup_entry.assert_called_once()
assert result2["type"] is FlowResultType.CREATE_ENTRY
assert result2["title"] == "test-email"
assert result2["data"] == MOCK_CONFIG
assert len(mock_setup_entry.mock_calls) == 1
@pytest.mark.parametrize(
("exception", "error"),
[
(SenseAuthenticationException(), "invalid_auth"),
(SenseAPITimeoutException(), "cannot_connect"),
(SenseAPIException(), "cannot_connect"),
(Exception("unknown exception"), "unknown"),
],
)
@pytest.mark.usefixtures("mock_setup_entry")
async def test_form_exceptions(
hass: HomeAssistant,
mock_flow_sense: MagicMock,
exception: Exception,
error: str,
) -> None:
"""Test we handle all exceptions in the user flow and can recover."""
mock_flow_sense.return_value.authenticate.side_effect = exception
async def test_form_invalid_auth(hass: HomeAssistant) -> None:
"""Test we handle invalid auth."""
result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": config_entries.SOURCE_USER}
)
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
{"timeout": "6", "email": "test-email", "password": "test-password"},
)
assert result["type"] is FlowResultType.FORM
assert result["errors"] == {"base": error}
with patch(
"sense_energy.ASyncSenseable.authenticate",
side_effect=SenseAuthenticationException,
):
result2 = await hass.config_entries.flow.async_configure(
result["flow_id"],
{"timeout": "6", "email": "test-email", "password": "test-password"},
)
# Verify recovery: clear the error and complete the flow successfully
mock_flow_sense.return_value.authenticate.side_effect = None
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
{"timeout": "6", "email": "test-email", "password": "test-password"},
)
await hass.async_block_till_done()
assert result["type"] is FlowResultType.CREATE_ENTRY
assert result2["type"] is FlowResultType.FORM
assert result2["errors"] == {"base": "invalid_auth"}
@pytest.mark.usefixtures("mock_setup_entry")
async def test_form_mfa_required(
hass: HomeAssistant,
mock_flow_sense: MagicMock,
) -> None:
"""Test we handle the MFA flow."""
mock_flow_sense.return_value.authenticate.side_effect = SenseMFARequiredException()
async def test_form_mfa_required(hass: HomeAssistant, mock_sense) -> None:
"""Test we handle invalid auth."""
result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": config_entries.SOURCE_USER}
)
result = await hass.config_entries.flow.async_configure(
mock_sense.return_value.authenticate.side_effect = SenseMFARequiredException
result2 = await hass.config_entries.flow.async_configure(
result["flow_id"],
{"timeout": "6", "email": "test-email", "password": "test-password"},
)
assert result["type"] is FlowResultType.FORM
assert result["step_id"] == "validation"
assert result2["type"] is FlowResultType.FORM
assert result2["step_id"] == "validation"
result = await hass.config_entries.flow.async_configure(
mock_sense.return_value.validate_mfa.side_effect = None
result3 = await hass.config_entries.flow.async_configure(
result["flow_id"],
{CONF_CODE: "012345"},
)
await hass.async_block_till_done()
assert result["type"] is FlowResultType.CREATE_ENTRY
assert result["title"] == "test-email"
assert result["data"] == MOCK_CONFIG
assert result3["type"] is FlowResultType.CREATE_ENTRY
assert result3["title"] == "test-email"
assert result3["data"] == MOCK_CONFIG
@pytest.mark.parametrize(
("exception", "error"),
[
(SenseAuthenticationException(), "invalid_auth"),
(SenseAPITimeoutException(), "cannot_connect"),
(SenseAPIException(), "cannot_connect"),
(Exception("Unknown exception"), "unknown"),
],
)
@pytest.mark.usefixtures("mock_setup_entry")
async def test_form_mfa_exceptions(
hass: HomeAssistant,
mock_flow_sense: MagicMock,
exception: Exception,
error: str,
) -> None:
"""Test we handle all MFA validation exceptions and can recover."""
mock_flow_sense.return_value.authenticate.side_effect = SenseMFARequiredException()
async def test_form_mfa_required_wrong(hass: HomeAssistant, mock_sense) -> None:
"""Test we handle invalid auth."""
result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": config_entries.SOURCE_USER}
)
result = await hass.config_entries.flow.async_configure(
mock_sense.return_value.authenticate.side_effect = SenseMFARequiredException
result2 = await hass.config_entries.flow.async_configure(
result["flow_id"],
{"timeout": "6", "email": "test-email", "password": "test-password"},
)
assert result["type"] is FlowResultType.FORM
assert result["step_id"] == "validation"
assert result2["type"] is FlowResultType.FORM
assert result2["step_id"] == "validation"
mock_flow_sense.return_value.validate_mfa.side_effect = exception
result = await hass.config_entries.flow.async_configure(
mock_sense.return_value.validate_mfa.side_effect = SenseAuthenticationException
# Try with the WRONG verification code give us the form back again
result3 = await hass.config_entries.flow.async_configure(
result["flow_id"],
{CONF_CODE: "000000"},
)
assert result["type"] is FlowResultType.FORM
assert result["errors"] == {"base": error}
assert result["step_id"] == "validation"
assert result3["type"] is FlowResultType.FORM
assert result3["errors"] == {"base": "invalid_auth"}
assert result3["step_id"] == "validation"
# Verify recovery: clear the error and complete MFA successfully
mock_flow_sense.return_value.validate_mfa.side_effect = None
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
{CONF_CODE: "012345"},
async def test_form_mfa_required_timeout(hass: HomeAssistant, mock_sense) -> None:
"""Test we handle invalid auth."""
result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": config_entries.SOURCE_USER}
)
await hass.async_block_till_done()
assert result["type"] is FlowResultType.CREATE_ENTRY
assert result["title"] == "test-email"
assert result["data"] == MOCK_CONFIG
mock_sense.return_value.authenticate.side_effect = SenseMFARequiredException
result2 = await hass.config_entries.flow.async_configure(
result["flow_id"],
{"timeout": "6", "email": "test-email", "password": "test-password"},
)
assert result2["type"] is FlowResultType.FORM
assert result2["step_id"] == "validation"
mock_sense.return_value.validate_mfa.side_effect = SenseAPITimeoutException
result3 = await hass.config_entries.flow.async_configure(
result["flow_id"],
{CONF_CODE: "000000"},
)
assert result3["type"] is FlowResultType.FORM
assert result3["errors"] == {"base": "cannot_connect"}
@pytest.mark.usefixtures("mock_flow_sense")
async def test_reauth_no_form(
hass: HomeAssistant,
mock_setup_entry: AsyncMock,
) -> None:
async def test_form_mfa_required_exception(hass: HomeAssistant, mock_sense) -> None:
"""Test we handle invalid auth."""
result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": config_entries.SOURCE_USER}
)
mock_sense.return_value.authenticate.side_effect = SenseMFARequiredException
result2 = await hass.config_entries.flow.async_configure(
result["flow_id"],
{"timeout": "6", "email": "test-email", "password": "test-password"},
)
assert result2["type"] is FlowResultType.FORM
assert result2["step_id"] == "validation"
mock_sense.return_value.validate_mfa.side_effect = Exception
result3 = await hass.config_entries.flow.async_configure(
result["flow_id"],
{CONF_CODE: "000000"},
)
assert result3["type"] is FlowResultType.FORM
assert result3["errors"] == {"base": "unknown"}
async def test_form_timeout(hass: HomeAssistant) -> None:
"""Test we handle cannot connect error."""
result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": config_entries.SOURCE_USER}
)
with patch(
"sense_energy.ASyncSenseable.authenticate",
side_effect=SenseAPITimeoutException,
):
result2 = await hass.config_entries.flow.async_configure(
result["flow_id"],
{"timeout": "6", "email": "test-email", "password": "test-password"},
)
assert result2["type"] is FlowResultType.FORM
assert result2["errors"] == {"base": "cannot_connect"}
async def test_form_cannot_connect(hass: HomeAssistant) -> None:
"""Test we handle cannot connect error."""
result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": config_entries.SOURCE_USER}
)
with patch(
"sense_energy.ASyncSenseable.authenticate",
side_effect=SenseAPIException,
):
result2 = await hass.config_entries.flow.async_configure(
result["flow_id"],
{"timeout": "6", "email": "test-email", "password": "test-password"},
)
assert result2["type"] is FlowResultType.FORM
assert result2["errors"] == {"base": "cannot_connect"}
async def test_form_unknown_exception(hass: HomeAssistant) -> None:
"""Test we handle unknown error."""
result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": config_entries.SOURCE_USER}
)
with patch(
"sense_energy.ASyncSenseable.authenticate",
side_effect=Exception,
):
result2 = await hass.config_entries.flow.async_configure(
result["flow_id"],
{"timeout": "6", "email": "test-email", "password": "test-password"},
)
assert result2["type"] is FlowResultType.FORM
assert result2["errors"] == {"base": "unknown"}
async def test_reauth_no_form(hass: HomeAssistant, mock_sense) -> None:
"""Test reauth where no form needed."""
# set up initially
entry = MockConfigEntry(
domain=DOMAIN,
data=MOCK_CONFIG,
unique_id="test-email",
)
entry.add_to_hass(hass)
result = await entry.start_reauth_flow(hass)
await hass.async_block_till_done()
with patch(
"homeassistant.config_entries.ConfigEntries.async_reload",
return_value=True,
):
result = await entry.start_reauth_flow(hass)
assert result["type"] is FlowResultType.ABORT
assert result["reason"] == "reauth_successful"
mock_setup_entry.assert_called_once()
@pytest.mark.usefixtures("mock_setup_entry")
async def test_reauth_password(
hass: HomeAssistant,
mock_flow_sense: MagicMock,
) -> None:
async def test_reauth_password(hass: HomeAssistant, mock_sense) -> None:
"""Test reauth form."""
# set up initially
entry = MockConfigEntry(
domain=DOMAIN,
data=MOCK_CONFIG,
unique_id="test-email",
)
entry.add_to_hass(hass)
mock_flow_sense.return_value.authenticate.side_effect = SenseAuthenticationException
mock_sense.return_value.authenticate.side_effect = SenseAuthenticationException
# Reauth success without user input
result = await entry.start_reauth_flow(hass)
assert result["type"] is FlowResultType.FORM
mock_flow_sense.return_value.authenticate.side_effect = None
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
{"password": "test-password"},
)
await hass.async_block_till_done()
mock_sense.return_value.authenticate.side_effect = None
with patch(
"homeassistant.components.sense.async_setup_entry",
return_value=True,
):
result2 = await hass.config_entries.flow.async_configure(
result["flow_id"],
{"password": "test-password"},
)
await hass.async_block_till_done()
assert result["type"] is FlowResultType.ABORT
assert result["reason"] == "reauth_successful"
assert result2["type"] is FlowResultType.ABORT
assert result2["reason"] == "reauth_successful"
@@ -1,53 +0,0 @@
"""Tests for the Sense coordinators."""
from datetime import timedelta
from unittest.mock import MagicMock
from freezegun.api import FrozenDateTimeFactory
import pytest
from sense_energy import SenseAuthenticationException, SenseMFARequiredException
from homeassistant.components.sense.const import DOMAIN, TREND_UPDATE_RATE
from homeassistant.config_entries import SOURCE_REAUTH
from homeassistant.const import STATE_UNAVAILABLE, Platform
from homeassistant.core import HomeAssistant
from . import setup_platform
from .const import MONITOR_ID
from tests.common import MockConfigEntry, async_fire_time_changed
@pytest.mark.parametrize(
"exception",
[
SenseAuthenticationException("auth expired"),
SenseMFARequiredException("auth expired"),
],
)
async def test_trend_coordinator_auth_failure(
hass: HomeAssistant,
mock_sense: MagicMock,
config_entry: MockConfigEntry,
freezer: FrozenDateTimeFactory,
exception: Exception,
) -> None:
"""Test that auth errors from the trend coordinator start a reauth flow."""
await setup_platform(hass, config_entry, Platform.SENSOR)
mock_sense.update_trend_data.side_effect = exception
freezer.tick(timedelta(seconds=TREND_UPDATE_RATE))
async_fire_time_changed(hass, freezer())
await hass.async_block_till_done()
state = hass.states.get(f"sensor.sense_{MONITOR_ID}_daily_energy")
assert state.state == STATE_UNAVAILABLE
flows = hass.config_entries.flow.async_progress()
assert len(flows) == 1
flow = flows[0]
assert flow.get("step_id") == "reauth_validate"
assert flow.get("handler") == DOMAIN
assert flow["context"].get("source") == SOURCE_REAUTH
assert flow["context"].get("entry_id") == config_entry.entry_id
-123
View File
@@ -1,123 +0,0 @@
"""Tests for the Sense integration setup."""
import socket
from unittest.mock import MagicMock
import pytest
from sense_energy import (
SenseAPIException,
SenseAPITimeoutException,
SenseAuthenticationException,
SenseMFARequiredException,
SenseWebsocketException,
)
from homeassistant.config_entries import ConfigEntryState
from homeassistant.core import HomeAssistant
from tests.common import MockConfigEntry
@pytest.mark.parametrize(
"exception",
[
SenseAPITimeoutException(),
SenseWebsocketException(),
],
)
async def test_setup_entry_exceptions(
hass: HomeAssistant,
mock_sense: MagicMock,
config_entry: MockConfigEntry,
exception: Exception,
) -> None:
"""Test we handle exceptions during async_setup_entry and can recover."""
mock_sense.update_realtime.side_effect = exception
config_entry.add_to_hass(hass)
assert not await hass.config_entries.async_setup(config_entry.entry_id)
await hass.async_block_till_done()
assert config_entry.state is ConfigEntryState.SETUP_RETRY
# Verify recovery: clear the error and reload the entry
mock_sense.update_realtime.side_effect = None
assert await hass.config_entries.async_reload(config_entry.entry_id)
await hass.async_block_till_done()
assert config_entry.state is ConfigEntryState.LOADED
@pytest.mark.parametrize(
"exception",
[
SenseAuthenticationException(),
SenseMFARequiredException(),
],
)
async def test_setup_get_monitor_data_auth_exceptions(
hass: HomeAssistant,
mock_sense: MagicMock,
config_entry: MockConfigEntry,
exception: Exception,
) -> None:
"""Test auth exceptions from get_monitor_data result in a failed entry."""
mock_sense.get_monitor_data.side_effect = exception
config_entry.add_to_hass(hass)
assert not await hass.config_entries.async_setup(config_entry.entry_id)
await hass.async_block_till_done()
assert config_entry.state is ConfigEntryState.SETUP_ERROR
@pytest.mark.parametrize(
"exception",
[
SenseAPITimeoutException(),
TimeoutError(),
SenseAPIException("connect error"),
socket.gaierror(),
],
)
async def test_setup_get_monitor_data_retry_exceptions(
hass: HomeAssistant,
mock_sense: MagicMock,
config_entry: MockConfigEntry,
exception: Exception,
) -> None:
"""Test timeout and connect exceptions from get_monitor_data result in a retryable entry."""
mock_sense.get_monitor_data.side_effect = exception
config_entry.add_to_hass(hass)
assert not await hass.config_entries.async_setup(config_entry.entry_id)
await hass.async_block_till_done()
assert config_entry.state is ConfigEntryState.SETUP_RETRY
@pytest.mark.parametrize(
"exception",
[
SenseAPITimeoutException(),
TimeoutError(),
SenseAPIException("connect error"),
socket.gaierror(),
SenseWebsocketException("ws error"),
SenseAPIException(),
],
)
async def test_setup_get_realtime_retry_exceptions(
hass: HomeAssistant,
mock_sense: MagicMock,
config_entry: MockConfigEntry,
exception: Exception,
) -> None:
"""Test timeout and connect exceptions from update_realtime result in a retryable entry."""
mock_sense.update_realtime.side_effect = exception
config_entry.add_to_hass(hass)
assert not await hass.config_entries.async_setup(config_entry.entry_id)
await hass.async_block_till_done()
assert config_entry.state is ConfigEntryState.SETUP_RETRY
+2 -93
View File
@@ -1,22 +1,16 @@
"""The tests for Sense sensor platform."""
from datetime import timedelta
import socket
from unittest.mock import MagicMock, PropertyMock
from freezegun.api import FrozenDateTimeFactory
import pytest
from sense_energy import (
Scale,
SenseAPIException,
SenseAPITimeoutException,
SenseWebsocketException,
)
from sense_energy import Scale
from syrupy.assertion import SnapshotAssertion
from homeassistant.components.sense.const import ACTIVE_UPDATE_RATE, TREND_UPDATE_RATE
from homeassistant.components.sensor import DOMAIN as SENSOR_DOMAIN
from homeassistant.const import STATE_UNAVAILABLE, Platform
from homeassistant.const import Platform
from homeassistant.core import HomeAssistant
from homeassistant.helpers import entity_registry as er
from homeassistant.util.dt import utcnow
@@ -238,88 +232,3 @@ async def test_trend_energy_sensors(
state = hass.states.get(f"sensor.sense_{MONITOR_ID}_daily_net_production")
assert state.state == "5000"
@pytest.mark.parametrize(
"exception",
[
SenseAPIException("api error"),
SenseAPITimeoutException("timeout"),
TimeoutError("timeout"),
socket.gaierror("addr info error"),
],
)
async def test_trend_coordinator_update_failure(
hass: HomeAssistant,
mock_sense: MagicMock,
config_entry: MockConfigEntry,
freezer: FrozenDateTimeFactory,
exception: Exception,
) -> None:
"""Test that connection errors from the trend coordinator mark entities unavailable."""
await setup_platform(hass, config_entry, Platform.SENSOR)
state = hass.states.get(f"sensor.sense_{MONITOR_ID}_daily_energy")
assert state is not None
assert state.state != STATE_UNAVAILABLE
mock_sense.update_trend_data.side_effect = exception
freezer.tick(timedelta(seconds=TREND_UPDATE_RATE))
async_fire_time_changed(hass, freezer())
await hass.async_block_till_done()
state = hass.states.get(f"sensor.sense_{MONITOR_ID}_daily_energy")
assert state.state == STATE_UNAVAILABLE
mock_sense.update_trend_data.side_effect = None
freezer.tick(timedelta(seconds=TREND_UPDATE_RATE))
async_fire_time_changed(hass, freezer())
await hass.async_block_till_done()
state = hass.states.get(f"sensor.sense_{MONITOR_ID}_daily_energy")
assert state.state != STATE_UNAVAILABLE
@pytest.mark.parametrize(
"exception",
[
SenseAPIException("api error"),
SenseAPITimeoutException("timeout"),
TimeoutError("timeout"),
SenseWebsocketException("ws error"),
socket.gaierror("addr info error"),
],
)
async def test_realtime_coordinator_update_failure(
hass: HomeAssistant,
mock_sense: MagicMock,
config_entry: MockConfigEntry,
freezer: FrozenDateTimeFactory,
exception: Exception,
) -> None:
"""Test that errors from the realtime coordinator mark entities unavailable."""
await setup_platform(hass, config_entry, Platform.SENSOR)
state = hass.states.get(f"sensor.sense_{MONITOR_ID}_energy")
assert state is not None
assert state.state != STATE_UNAVAILABLE
mock_sense.update_realtime.side_effect = exception
freezer.tick(timedelta(seconds=ACTIVE_UPDATE_RATE))
async_fire_time_changed(hass, freezer())
await hass.async_block_till_done()
state = hass.states.get(f"sensor.sense_{MONITOR_ID}_energy")
assert state.state == STATE_UNAVAILABLE
mock_sense.update_realtime.side_effect = None
freezer.tick(timedelta(seconds=ACTIVE_UPDATE_RATE))
async_fire_time_changed(hass, freezer())
await hass.async_block_till_done()
state = hass.states.get(f"sensor.sense_{MONITOR_ID}_energy")
assert state.state != STATE_UNAVAILABLE
@@ -1378,7 +1378,6 @@ async def test_async_setup_entry_failed(
mock_bot.side_effect = InvalidToken("mock invalid token error")
with pytest.raises(ConfigEntryAuthFailed) as err:
# pylint: disable-next=home-assistant-tests-direct-async-setup-entry
await async_setup_entry(hass, mock_broadcast_config_entry)
await hass.async_block_till_done()
@@ -229,7 +229,6 @@ async def test_thermopro_restores_entities_on_restart_behavior(
await hass.async_block_till_done()
# Manually set up sensor platform with our callback
# pylint: disable-next=home-assistant-tests-direct-platform-async-setup-entry
await thermopro_sensor.async_setup_entry(hass, entry1, add_entities_first)
await hass.async_block_till_done()
@@ -243,7 +242,6 @@ async def test_thermopro_restores_entities_on_restart_behavior(
assert await hass.config_entries.async_setup(entry2.entry_id)
await hass.async_block_till_done()
# pylint: disable-next=home-assistant-tests-direct-platform-async-setup-entry
await thermopro_sensor.async_setup_entry(hass, entry2, add_entities_second)
await hass.async_block_till_done()
-1
View File
@@ -96,5 +96,4 @@ async def test_setup_requires_data_api_reauth(hass: HomeAssistant) -> None:
)
with pytest.raises(ConfigEntryAuthFailed):
# pylint: disable-next=home-assistant-tests-direct-async-setup-entry
await async_setup_entry(hass, entry)
-2
View File
@@ -54,7 +54,6 @@ async def test_async_setup_entry__no_devices(
) -> None:
"""Test setup connects to vesync and creates empty config when no devices."""
with patch.object(hass.config_entries, "async_forward_entry_setups") as setups_mock:
# pylint: disable-next=home-assistant-tests-direct-async-setup-entry
assert await async_setup_entry(hass, config_entry)
# Assert platforms loaded
await hass.async_block_till_done()
@@ -82,7 +81,6 @@ async def test_async_setup_entry__loads_fans(
manager._dev_list["fans"].append(fan)
with patch.object(hass.config_entries, "async_forward_entry_setups") as setups_mock:
# pylint: disable-next=home-assistant-tests-direct-async-setup-entry
assert await async_setup_entry(hass, config_entry)
# Assert platforms loaded
await hass.async_block_till_done()
@@ -1,170 +0,0 @@
"""Tests for the direct async_setup_entry checker."""
import astroid
from pylint.testutils import UnittestLinter
from pylint.utils.ast_walker import ASTWalker
from pylint_home_assistant.checkers.tests.direct_async_setup_entry import (
DirectAsyncSetupEntry,
)
import pytest
from tests.pylint import assert_no_messages
# Pre-load so astroid can resolve ``async_setup_entry`` in parsed snippets.
astroid.MANAGER.ast_from_module_name("homeassistant.components.sun")
astroid.MANAGER.ast_from_module_name("homeassistant.components.sun.sensor")
@pytest.fixture(name="checker")
def checker_fixture(linter: UnittestLinter) -> DirectAsyncSetupEntry:
"""Fixture to provide a direct async_setup_entry checker."""
return DirectAsyncSetupEntry(linter)
@pytest.mark.parametrize(
("code", "module_name"),
[
pytest.param(
"""
async def test_setup(hass):
await hass.config_entries.async_setup(entry.entry_id)
""",
"tests.components.sun.test_init",
id="proper_setup_call",
),
pytest.param(
"""
from homeassistant.components.sun import async_setup_entry
async def test_setup(hass, mock_config_entry):
await async_setup_entry(hass, mock_config_entry)
""",
"homeassistant.components.sun",
id="not_a_test_module",
),
pytest.param(
"""
async def test_setup(hass, mock_config_entry):
await some_local.async_setup_entry(hass, mock_config_entry)
""",
"tests.components.sun.test_init",
id="unresolved_attribute_call",
),
pytest.param(
"""
async def async_setup_entry(hass, entry):
return True
async def test_setup(hass, entry):
await async_setup_entry(hass, entry)
""",
"tests.components.sun.test_init",
id="local_async_setup_entry_not_an_integration",
),
],
)
def test_no_warning(
linter: UnittestLinter,
checker: DirectAsyncSetupEntry,
code: str,
module_name: str,
) -> None:
"""Test cases that should not trigger a warning."""
root_node = astroid.parse(code, module_name)
walker = ASTWalker(linter)
walker.add_checker(checker)
with assert_no_messages(linter):
walker.walk(root_node)
@pytest.mark.parametrize(
("code", "module_name", "expected_msg"),
[
pytest.param(
"""
from homeassistant.components.sun import async_setup_entry
async def test_setup(hass, mock_config_entry):
await async_setup_entry(hass, mock_config_entry)
""",
"tests.components.sun.test_init",
"home-assistant-tests-direct-async-setup-entry",
id="direct_name_call_from_init",
),
pytest.param(
"""
from homeassistant.components import sun
async def test_setup(hass, mock_config_entry):
await sun.async_setup_entry(hass, mock_config_entry)
""",
"tests.components.sun.test_init",
"home-assistant-tests-direct-async-setup-entry",
id="attribute_call_from_init",
),
pytest.param(
"""
from homeassistant.components.sun.sensor import async_setup_entry
async def test_setup(hass, mock_config_entry, add_entities):
await async_setup_entry(hass, mock_config_entry, add_entities)
""",
"tests.components.sun.test_sensor",
"home-assistant-tests-direct-platform-async-setup-entry",
id="direct_call_from_platform",
),
pytest.param(
"""
from homeassistant.components.sun import sensor
async def test_setup(hass, mock_config_entry, add_entities):
await sensor.async_setup_entry(hass, mock_config_entry, add_entities)
""",
"tests.components.sun.test_sensor",
"home-assistant-tests-direct-platform-async-setup-entry",
id="attribute_call_from_platform",
),
],
)
def test_warning(
linter: UnittestLinter,
checker: DirectAsyncSetupEntry,
code: str,
module_name: str,
expected_msg: str,
) -> None:
"""Test cases that should trigger a warning."""
root_node = astroid.parse(code, module_name)
walker = ASTWalker(linter)
walker.add_checker(checker)
walker.walk(root_node)
messages = linter.release_messages()
assert len(messages) == 1
assert messages[0].msg_id == expected_msg
def test_multiple_calls_each_flagged(
linter: UnittestLinter,
checker: DirectAsyncSetupEntry,
) -> None:
"""Test that multiple direct calls are each flagged."""
root_node = astroid.parse(
"""
from homeassistant.components.sun import async_setup_entry
async def test_a(hass, mock_config_entry):
await async_setup_entry(hass, mock_config_entry)
async def test_b(hass, mock_config_entry):
await async_setup_entry(hass, mock_config_entry)
""",
"tests.components.sun.test_init",
)
walker = ASTWalker(linter)
walker.add_checker(checker)
walker.walk(root_node)
messages = linter.release_messages()
assert len(messages) == 2