mirror of
https://github.com/home-assistant/core.git
synced 2026-09-05 04:51:05 +01:00
220 lines
8.0 KiB
Python
220 lines
8.0 KiB
Python
"""Test the Sofar Inverter Modbus integration setup and unload."""
|
|
|
|
from datetime import timedelta
|
|
from unittest.mock import patch
|
|
|
|
from freezegun.api import FrozenDateTimeFactory
|
|
from modbus_connection import ModbusConnectionError, ModbusTimeoutError
|
|
from modbus_connection.mock import MockModbusConnection
|
|
|
|
from homeassistant.components.sensor import DOMAIN as SENSOR_DOMAIN
|
|
from homeassistant.components.sofar.const import DOMAIN, SETTINGS_SCAN_INTERVAL
|
|
from homeassistant.components.sofar.coordinator import SofarRuntimeData
|
|
from homeassistant.config_entries import ConfigEntryState
|
|
from homeassistant.const import STATE_UNAVAILABLE
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers import device_registry as dr, entity_registry as er
|
|
|
|
from . import MOCK_HW_VERSION, MOCK_SERIAL, MOCK_SW_VERSION, MOCK_USER_INPUT
|
|
|
|
from tests.common import MockConfigEntry, async_fire_time_changed
|
|
|
|
|
|
async def test_setup_and_unload_entry(
|
|
hass: HomeAssistant, init_integration: MockConfigEntry
|
|
) -> None:
|
|
"""Test a config entry sets up and unloads with runtime_data populated."""
|
|
entry = init_integration
|
|
assert entry.state is ConfigEntryState.LOADED
|
|
assert isinstance(entry.runtime_data, SofarRuntimeData)
|
|
|
|
await hass.config_entries.async_unload(entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
assert entry.state is ConfigEntryState.NOT_LOADED
|
|
|
|
|
|
async def test_setup_entry_unrecognized_inverter_raises_setup_error(
|
|
hass: HomeAssistant,
|
|
) -> None:
|
|
"""Test setup fails permanently (no retry) for an unrecognized serial."""
|
|
# Not reachable via the config flow; covers an existing entry
|
|
# outliving a sofar-modbus library downgrade. Caught before any
|
|
# Modbus I/O, so no connection needs mocking here.
|
|
entry = MockConfigEntry(
|
|
domain=DOMAIN, unique_id="UNRECOGNIZED_SERIAL_XYZ", data=MOCK_USER_INPUT
|
|
)
|
|
entry.add_to_hass(hass)
|
|
|
|
await hass.config_entries.async_setup(entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
assert entry.state is ConfigEntryState.SETUP_ERROR
|
|
|
|
|
|
async def test_setup_entry_unreachable_link_retries_and_recovers(
|
|
hass: HomeAssistant,
|
|
freezer: FrozenDateTimeFactory,
|
|
mock_connection: MockModbusConnection,
|
|
mock_config_entry: MockConfigEntry,
|
|
) -> None:
|
|
"""Test a dead link on first refresh retries setup, then recovers."""
|
|
mock_config_entry.add_to_hass(hass)
|
|
unit = mock_connection.for_unit(1)
|
|
unit.fail_requests(ModbusTimeoutError("stuck"))
|
|
|
|
with patch(
|
|
"homeassistant.components.sofar.async_get_unit",
|
|
side_effect=lambda hass, entry, params, unit_id: mock_connection.for_unit(
|
|
unit_id
|
|
),
|
|
):
|
|
await hass.config_entries.async_setup(mock_config_entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
assert mock_config_entry.state is ConfigEntryState.SETUP_RETRY
|
|
|
|
unit.fail_requests(None)
|
|
freezer.tick(timedelta(seconds=5))
|
|
async_fire_time_changed(hass)
|
|
await hass.async_block_till_done(wait_background_tasks=True)
|
|
|
|
assert mock_config_entry.state is ConfigEntryState.LOADED
|
|
|
|
|
|
async def test_settings_failure_does_not_block_reading_sensors(
|
|
hass: HomeAssistant,
|
|
entity_registry: er.EntityRegistry,
|
|
mock_connection: MockModbusConnection,
|
|
mock_config_entry: MockConfigEntry,
|
|
) -> None:
|
|
"""Test a settings-block failure still lets reading sensors set up."""
|
|
mock_config_entry.add_to_hass(hass)
|
|
|
|
with (
|
|
patch(
|
|
"homeassistant.components.sofar.async_get_unit",
|
|
side_effect=lambda hass, entry, params, unit_id: mock_connection.for_unit(
|
|
unit_id
|
|
),
|
|
),
|
|
patch(
|
|
"sofar_modbus.modern.device.SofarInverter.async_update_settings",
|
|
side_effect=ModbusConnectionError("settings unreachable"),
|
|
),
|
|
):
|
|
await hass.config_entries.async_setup(mock_config_entry.entry_id)
|
|
await hass.async_block_till_done(wait_background_tasks=True)
|
|
|
|
assert mock_config_entry.state is ConfigEntryState.LOADED
|
|
assert hass.states.async_entity_ids("sensor")
|
|
|
|
# Created despite the failure, so the coordinator keeps a listener and
|
|
# retries; without one it would never poll again short of a reload.
|
|
entity_id = entity_registry.async_get_entity_id(
|
|
SENSOR_DOMAIN, DOMAIN, f"{MOCK_SERIAL}_serial_number"
|
|
)
|
|
assert entity_id is not None
|
|
assert (state := hass.states.get(entity_id)) is not None
|
|
assert state.state == STATE_UNAVAILABLE
|
|
|
|
|
|
async def test_settings_recover_without_a_reload(
|
|
hass: HomeAssistant,
|
|
freezer: FrozenDateTimeFactory,
|
|
entity_registry: er.EntityRegistry,
|
|
mock_connection: MockModbusConnection,
|
|
mock_config_entry: MockConfigEntry,
|
|
) -> None:
|
|
"""Test settings sensors come back on their own once the link heals."""
|
|
mock_config_entry.add_to_hass(hass)
|
|
unit = mock_connection.for_unit(1)
|
|
# A settings-only register, so the readings poll still sets up.
|
|
unit.fail_read(0x1105, ModbusConnectionError("settings unreachable"))
|
|
|
|
with patch(
|
|
"homeassistant.components.sofar.async_get_unit",
|
|
side_effect=lambda hass, entry, params, unit_id: mock_connection.for_unit(
|
|
unit_id
|
|
),
|
|
):
|
|
await hass.config_entries.async_setup(mock_config_entry.entry_id)
|
|
await hass.async_block_till_done(wait_background_tasks=True)
|
|
|
|
entity_id = entity_registry.async_get_entity_id(
|
|
SENSOR_DOMAIN, DOMAIN, f"{MOCK_SERIAL}_serial_number"
|
|
)
|
|
assert entity_id is not None
|
|
assert hass.states.get(entity_id).state == STATE_UNAVAILABLE
|
|
|
|
unit.fail_read(0x1105, None)
|
|
freezer.tick(timedelta(seconds=SETTINGS_SCAN_INTERVAL))
|
|
async_fire_time_changed(hass)
|
|
await hass.async_block_till_done()
|
|
|
|
assert hass.states.get(entity_id).state == MOCK_SERIAL
|
|
|
|
|
|
async def test_sensor_platform_is_forwarded(
|
|
hass: HomeAssistant, init_integration: MockConfigEntry
|
|
) -> None:
|
|
"""Test the sensor platform is set up as part of config entry setup."""
|
|
assert hass.states.async_entity_ids("sensor")
|
|
|
|
|
|
async def test_device_info_carries_the_firmware_versions(
|
|
hass: HomeAssistant,
|
|
device_registry: dr.DeviceRegistry,
|
|
init_integration: MockConfigEntry,
|
|
) -> None:
|
|
"""Test the identity registers reach the device, not the state machine."""
|
|
device = device_registry.async_get_device_by_identifier(
|
|
(DOMAIN, MOCK_SERIAL), init_integration.entry_id
|
|
)
|
|
|
|
assert device is not None
|
|
assert device.hw_version == MOCK_HW_VERSION
|
|
assert device.sw_version == MOCK_SW_VERSION
|
|
assert device.serial_number == MOCK_SERIAL
|
|
|
|
|
|
async def test_device_versions_recover_without_a_reload(
|
|
hass: HomeAssistant,
|
|
freezer: FrozenDateTimeFactory,
|
|
device_registry: dr.DeviceRegistry,
|
|
mock_connection: MockModbusConnection,
|
|
mock_config_entry: MockConfigEntry,
|
|
) -> None:
|
|
"""Test firmware versions reach the device once identity answers."""
|
|
mock_config_entry.add_to_hass(hass)
|
|
unit = mock_connection.for_unit(1)
|
|
# Inside the identity block, so the whole component fails to read.
|
|
unit.fail_read(0x044D, ModbusConnectionError("identity unreachable"))
|
|
|
|
with patch(
|
|
"homeassistant.components.sofar.async_get_unit",
|
|
side_effect=lambda hass, entry, params, unit_id: mock_connection.for_unit(
|
|
unit_id
|
|
),
|
|
):
|
|
await hass.config_entries.async_setup(mock_config_entry.entry_id)
|
|
await hass.async_block_till_done(wait_background_tasks=True)
|
|
|
|
device = device_registry.async_get_device_by_identifier(
|
|
(DOMAIN, MOCK_SERIAL), mock_config_entry.entry_id
|
|
)
|
|
assert device is not None
|
|
assert device.hw_version is None
|
|
assert device.sw_version is None
|
|
|
|
unit.fail_read(0x044D, None)
|
|
freezer.tick(timedelta(seconds=SETTINGS_SCAN_INTERVAL))
|
|
async_fire_time_changed(hass)
|
|
await hass.async_block_till_done()
|
|
|
|
device = device_registry.async_get_device_by_identifier(
|
|
(DOMAIN, MOCK_SERIAL), mock_config_entry.entry_id
|
|
)
|
|
assert device is not None
|
|
assert device.hw_version == MOCK_HW_VERSION
|
|
assert device.sw_version == MOCK_SW_VERSION
|