278 lines
10 KiB
Python
278 lines
10 KiB
Python
"""Tests for Renault sensors."""
|
|
|
|
from collections.abc import Generator
|
|
import datetime
|
|
from unittest.mock import AsyncMock, patch
|
|
|
|
from freezegun.api import FrozenDateTimeFactory
|
|
import pytest
|
|
from renault_api.kamereon.exceptions import (
|
|
AccessDeniedException,
|
|
NotSupportedException,
|
|
QuotaLimitException,
|
|
)
|
|
from syrupy.assertion import SnapshotAssertion
|
|
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import ATTR_ASSUMED_STATE, STATE_UNAVAILABLE, Platform
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers import entity_registry as er
|
|
|
|
from .conftest import _get_fixtures, patch_get_vehicle_data
|
|
|
|
from tests.common import async_fire_time_changed, snapshot_platform
|
|
|
|
pytestmark = pytest.mark.usefixtures("patch_renault_account", "patch_get_vehicles")
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def override_platforms() -> Generator[None]:
|
|
"""Override PLATFORMS."""
|
|
with patch("homeassistant.components.renault.PLATFORMS", [Platform.SENSOR]):
|
|
yield
|
|
|
|
|
|
@pytest.mark.usefixtures("fixtures_with_data", "entity_registry_enabled_by_default")
|
|
async def test_sensors(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
entity_registry: er.EntityRegistry,
|
|
snapshot: SnapshotAssertion,
|
|
) -> None:
|
|
"""Test for Renault sensors."""
|
|
await hass.config_entries.async_setup(config_entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
await snapshot_platform(hass, entity_registry, snapshot, config_entry.entry_id)
|
|
|
|
|
|
@pytest.mark.usefixtures("fixtures_with_no_data", "entity_registry_enabled_by_default")
|
|
@pytest.mark.parametrize("vehicle_type", ["zoe_40"], indirect=True)
|
|
async def test_sensor_empty(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
entity_registry: er.EntityRegistry,
|
|
snapshot: SnapshotAssertion,
|
|
) -> None:
|
|
"""Test for Renault sensors with empty data from Renault."""
|
|
await hass.config_entries.async_setup(config_entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
await snapshot_platform(hass, entity_registry, snapshot, config_entry.entry_id)
|
|
|
|
|
|
@pytest.mark.usefixtures(
|
|
"fixtures_with_invalid_upstream_exception", "entity_registry_enabled_by_default"
|
|
)
|
|
@pytest.mark.parametrize("vehicle_type", ["zoe_40"], indirect=True)
|
|
async def test_sensor_errors(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
entity_registry: er.EntityRegistry,
|
|
snapshot: SnapshotAssertion,
|
|
) -> None:
|
|
"""Test for Renault sensors with temporary failure."""
|
|
await hass.config_entries.async_setup(config_entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
await snapshot_platform(hass, entity_registry, snapshot, config_entry.entry_id)
|
|
|
|
|
|
@pytest.mark.usefixtures("fixtures_with_access_denied_exception")
|
|
@pytest.mark.parametrize("vehicle_type", ["zoe_40"], indirect=True)
|
|
async def test_sensor_access_denied(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
entity_registry: er.EntityRegistry,
|
|
) -> None:
|
|
"""Test for Renault sensors with access denied failure."""
|
|
await hass.config_entries.async_setup(config_entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
assert len(entity_registry.entities) == 0
|
|
|
|
|
|
@pytest.mark.usefixtures("fixtures_with_not_supported_exception")
|
|
@pytest.mark.parametrize("vehicle_type", ["zoe_40"], indirect=True)
|
|
async def test_sensor_not_supported(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
entity_registry: er.EntityRegistry,
|
|
) -> None:
|
|
"""Test for Renault sensors with access denied failure."""
|
|
await hass.config_entries.async_setup(config_entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
assert len(entity_registry.entities) == 0
|
|
|
|
|
|
@pytest.mark.parametrize("vehicle_type", ["zoe_40"], indirect=True)
|
|
async def test_sensor_throttling_during_setup(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
vehicle_type: str,
|
|
freezer: FrozenDateTimeFactory,
|
|
) -> None:
|
|
"""Test for Renault sensors with a throttling error during setup."""
|
|
mock_fixtures = _get_fixtures(vehicle_type)
|
|
with patch_get_vehicle_data() as patches:
|
|
for key, get_data_mock in patches.items():
|
|
get_data_mock.return_value = mock_fixtures[key]
|
|
get_data_mock.side_effect = QuotaLimitException(
|
|
"err.func.wired.overloaded", "You have reached your quota limit"
|
|
)
|
|
await hass.config_entries.async_setup(config_entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
# Initial state
|
|
entity_id = "sensor.reg_zoe_40_battery"
|
|
assert hass.states.get(entity_id).state == STATE_UNAVAILABLE
|
|
|
|
# Test QuotaLimitException recovery, with new battery level
|
|
for get_data_mock in patches.values():
|
|
get_data_mock.side_effect = None
|
|
patches["battery_status"].return_value.batteryLevel = 55
|
|
freezer.tick(datetime.timedelta(minutes=20))
|
|
async_fire_time_changed(hass)
|
|
await hass.async_block_till_done()
|
|
|
|
assert hass.states.get(entity_id).state == "55"
|
|
|
|
|
|
@pytest.mark.parametrize("vehicle_type", ["zoe_40"], indirect=True)
|
|
async def test_sensor_throttling_after_init(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
vehicle_type: str,
|
|
caplog: pytest.LogCaptureFixture,
|
|
freezer: FrozenDateTimeFactory,
|
|
) -> None:
|
|
"""Test for Renault sensors with a throttling error during setup."""
|
|
mock_fixtures = _get_fixtures(vehicle_type)
|
|
with patch_get_vehicle_data() as patches:
|
|
for key, get_data_mock in patches.items():
|
|
get_data_mock.return_value = mock_fixtures[key]
|
|
await hass.config_entries.async_setup(config_entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
# Initial state
|
|
entity_id = "sensor.reg_zoe_40_battery"
|
|
assert hass.states.get(entity_id).state == "60"
|
|
assert not hass.states.get(entity_id).attributes.get(ATTR_ASSUMED_STATE)
|
|
assert "Renault API throttled: scan skipped" not in caplog.text
|
|
|
|
# Test QuotaLimitException state
|
|
caplog.clear()
|
|
for get_data_mock in patches.values():
|
|
get_data_mock.side_effect = QuotaLimitException(
|
|
"err.func.wired.overloaded", "You have reached your quota limit"
|
|
)
|
|
freezer.tick(datetime.timedelta(minutes=10))
|
|
async_fire_time_changed(hass)
|
|
await hass.async_block_till_done()
|
|
|
|
assert hass.states.get(entity_id).state == "60"
|
|
assert hass.states.get(entity_id).attributes.get(ATTR_ASSUMED_STATE)
|
|
assert "Renault API throttled" in caplog.text
|
|
assert "Renault hub currently throttled: scan skipped" in caplog.text
|
|
|
|
# Test QuotaLimitException recovery, with new battery level
|
|
caplog.clear()
|
|
for get_data_mock in patches.values():
|
|
get_data_mock.side_effect = None
|
|
patches["battery_status"].return_value.batteryLevel = 55
|
|
freezer.tick(datetime.timedelta(minutes=20))
|
|
async_fire_time_changed(hass)
|
|
await hass.async_block_till_done()
|
|
|
|
assert hass.states.get(entity_id).state == "55"
|
|
assert not hass.states.get(entity_id).attributes.get(ATTR_ASSUMED_STATE)
|
|
assert "Renault API throttled" not in caplog.text
|
|
assert "Renault hub currently throttled: scan skipped" not in caplog.text
|
|
|
|
|
|
# scan interval in seconds = (3600 * num_calls) / MAX_CALLS_PER_HOURS
|
|
# MAX_CALLS_PER_HOURS being a constant, for now 60 calls per hour
|
|
# num_calls = num_coordinator_car_0 + num_coordinator_car_1 + ... + num_coordinator_car_n
|
|
@pytest.mark.parametrize(
|
|
("vehicle_type", "vehicle_count", "scan_interval"),
|
|
[
|
|
("zoe_50", 1, 300), # 5 coordinators => 5 minutes interval
|
|
("captur_fuel", 1, 240), # 4 coordinators => 4 minutes interval
|
|
("multi", 2, 480), # 8 coordinators => 8 minutes interval
|
|
],
|
|
indirect=["vehicle_type"],
|
|
)
|
|
async def test_dynamic_scan_interval(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
vehicle_count: int,
|
|
scan_interval: int,
|
|
freezer: FrozenDateTimeFactory,
|
|
fixtures_with_data: dict[str, AsyncMock],
|
|
) -> None:
|
|
"""Test scan interval."""
|
|
await hass.config_entries.async_setup(config_entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
assert fixtures_with_data["cockpit"].call_count == vehicle_count
|
|
|
|
# 2 seconds before the expected scan interval > not called
|
|
freezer.tick(datetime.timedelta(seconds=scan_interval - 2))
|
|
async_fire_time_changed(hass)
|
|
await hass.async_block_till_done()
|
|
assert fixtures_with_data["cockpit"].call_count == vehicle_count
|
|
|
|
# 2 seconds after the expected scan interval > called
|
|
freezer.tick(datetime.timedelta(seconds=4))
|
|
async_fire_time_changed(hass)
|
|
await hass.async_block_till_done()
|
|
assert fixtures_with_data["cockpit"].call_count == vehicle_count * 2
|
|
|
|
|
|
# scan interval in seconds = (3600 * num_calls) / MAX_CALLS_PER_HOURS
|
|
# MAX_CALLS_PER_HOURS being a constant, for now 60 calls per hour
|
|
# num_calls = num_coordinator_car_0 + num_coordinator_car_1 + ... + num_coordinator_car_n
|
|
@pytest.mark.parametrize(
|
|
("vehicle_type", "vehicle_count", "scan_interval"),
|
|
[
|
|
("zoe_50", 1, 240), # (6-2) coordinators => 4 minutes interval
|
|
("captur_fuel", 1, 180), # (4-1) coordinators => 3 minutes interval
|
|
("multi", 2, 360), # (8-2) coordinators => 6 minutes interval
|
|
],
|
|
indirect=["vehicle_type"],
|
|
)
|
|
async def test_dynamic_scan_interval_failed_coordinator(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
vehicle_count: int,
|
|
scan_interval: int,
|
|
freezer: FrozenDateTimeFactory,
|
|
fixtures_with_data: dict[str, AsyncMock],
|
|
) -> None:
|
|
"""Test scan interval."""
|
|
fixtures_with_data["battery_status"].side_effect = NotSupportedException(
|
|
"err.tech.501",
|
|
"This feature is not technically supported by this gateway",
|
|
)
|
|
fixtures_with_data["lock_status"].side_effect = AccessDeniedException(
|
|
"err.func.403",
|
|
"Access is denied for this resource",
|
|
)
|
|
|
|
await hass.config_entries.async_setup(config_entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
assert fixtures_with_data["cockpit"].call_count == vehicle_count
|
|
|
|
# 2 seconds before the expected scan interval > not called
|
|
freezer.tick(datetime.timedelta(seconds=scan_interval - 2))
|
|
async_fire_time_changed(hass)
|
|
await hass.async_block_till_done()
|
|
assert fixtures_with_data["cockpit"].call_count == vehicle_count
|
|
|
|
# 2 seconds after the expected scan interval > called
|
|
freezer.tick(datetime.timedelta(seconds=4))
|
|
async_fire_time_changed(hass)
|
|
await hass.async_block_till_done()
|
|
assert fixtures_with_data["cockpit"].call_count == vehicle_count * 2
|