1
0
mirror of https://github.com/home-assistant/core.git synced 2026-04-17 07:34:07 +01:00
Files
core/tests/components/growatt_server/test_services.py
johanzander d9a29bd486 growatt_server: add translation keys to all raised exceptions (#165927)
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: Norbert Rittel <norbert@rittel.de>
2026-03-19 21:08:15 +01:00

1188 lines
40 KiB
Python

"""Test Growatt Server services."""
import datetime as dt
from unittest.mock import MagicMock, patch
import growattServer
import pytest
from syrupy.assertion import SnapshotAssertion
from homeassistant.components.growatt_server.const import DOMAIN
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError, ServiceValidationError
from homeassistant.helpers import device_registry as dr
from tests.common import MockConfigEntry
@pytest.mark.usefixtures("mock_growatt_v1_api")
async def test_read_time_segments_single_device(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
device_registry: dr.DeviceRegistry,
snapshot: SnapshotAssertion,
) -> None:
"""Test reading time segments for single device."""
mock_config_entry.add_to_hass(hass)
await hass.config_entries.async_setup(mock_config_entry.entry_id)
await hass.async_block_till_done()
# Get the device registry ID
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "MIN123456")})
assert device_entry is not None
# Test service call
response = await hass.services.async_call(
DOMAIN,
"read_time_segments",
{"device_id": device_entry.id},
blocking=True,
return_response=True,
)
assert response == snapshot
async def test_update_time_segment_charge_mode(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_growatt_v1_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test updating time segment with charge mode."""
mock_config_entry.add_to_hass(hass)
await hass.config_entries.async_setup(mock_config_entry.entry_id)
await hass.async_block_till_done()
# Get the device registry ID
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "MIN123456")})
assert device_entry is not None
# Test successful update
await hass.services.async_call(
DOMAIN,
"update_time_segment",
{
"device_id": device_entry.id,
"segment_id": 1,
"start_time": "09:00",
"end_time": "11:00",
"batt_mode": "load_first",
"enabled": True,
},
blocking=True,
)
# Verify the API was called
mock_growatt_v1_api.min_write_time_segment.assert_called_once()
async def test_update_time_segment_discharge_mode(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_growatt_v1_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test updating time segment with discharge mode."""
mock_config_entry.add_to_hass(hass)
await hass.config_entries.async_setup(mock_config_entry.entry_id)
await hass.async_block_till_done()
# Get the device registry ID
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "MIN123456")})
assert device_entry is not None
await hass.services.async_call(
DOMAIN,
"update_time_segment",
{
"device_id": device_entry.id,
"segment_id": 2,
"start_time": "14:00",
"end_time": "16:00",
"batt_mode": "battery_first",
"enabled": True,
},
blocking=True,
)
mock_growatt_v1_api.min_write_time_segment.assert_called_once()
async def test_update_time_segment_standby_mode(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_growatt_v1_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test updating time segment with standby mode."""
mock_config_entry.add_to_hass(hass)
await hass.config_entries.async_setup(mock_config_entry.entry_id)
await hass.async_block_till_done()
# Get the device registry ID
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "MIN123456")})
assert device_entry is not None
await hass.services.async_call(
DOMAIN,
"update_time_segment",
{
"device_id": device_entry.id,
"segment_id": 3,
"start_time": "20:00",
"end_time": "22:00",
"batt_mode": "grid_first",
"enabled": True,
},
blocking=True,
)
mock_growatt_v1_api.min_write_time_segment.assert_called_once()
async def test_update_time_segment_disabled(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_growatt_v1_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test disabling a time segment."""
mock_config_entry.add_to_hass(hass)
await hass.config_entries.async_setup(mock_config_entry.entry_id)
await hass.async_block_till_done()
# Get the device registry ID
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "MIN123456")})
assert device_entry is not None
await hass.services.async_call(
DOMAIN,
"update_time_segment",
{
"device_id": device_entry.id,
"segment_id": 1,
"start_time": "06:00",
"end_time": "08:00",
"batt_mode": "load_first",
"enabled": False,
},
blocking=True,
)
mock_growatt_v1_api.min_write_time_segment.assert_called_once()
async def test_update_time_segment_with_seconds(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_growatt_v1_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test updating time segment with HH:MM:SS format from UI."""
mock_config_entry.add_to_hass(hass)
await hass.config_entries.async_setup(mock_config_entry.entry_id)
await hass.async_block_till_done()
# Get the device registry ID
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "MIN123456")})
assert device_entry is not None
# Test with HH:MM:SS format (what the UI time selector sends)
await hass.services.async_call(
DOMAIN,
"update_time_segment",
{
"device_id": device_entry.id,
"segment_id": 1,
"start_time": "09:00:00",
"end_time": "11:00:00",
"batt_mode": "load_first",
"enabled": True,
},
blocking=True,
)
mock_growatt_v1_api.min_write_time_segment.assert_called_once()
async def test_update_time_segment_api_error(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_growatt_v1_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test handling API error when updating time segment."""
mock_config_entry.add_to_hass(hass)
await hass.config_entries.async_setup(mock_config_entry.entry_id)
await hass.async_block_till_done()
# Get the device registry ID
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "MIN123456")})
assert device_entry is not None
# Mock API error - the library raises an exception instead of returning error dict
mock_growatt_v1_api.min_write_time_segment.side_effect = (
growattServer.GrowattV1ApiError(
"Error during writing time segment 1",
error_code=1,
error_msg="API Error",
)
)
with pytest.raises(HomeAssistantError) as excinfo:
await hass.services.async_call(
DOMAIN,
"update_time_segment",
{
"device_id": device_entry.id,
"segment_id": 1,
"start_time": "09:00",
"end_time": "11:00",
"batt_mode": "load_first",
"enabled": True,
},
blocking=True,
)
assert excinfo.value.translation_domain == DOMAIN
assert excinfo.value.translation_key == "api_error"
assert "error" in excinfo.value.translation_placeholders
async def test_no_min_devices_skips_service_registration(
hass: HomeAssistant,
mock_config_entry_classic: MockConfigEntry,
mock_growatt_classic_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test that services fail gracefully when no MIN devices exist."""
# Only non-MIN devices (TLX with classic API)
mock_growatt_classic_api.device_list.return_value = [
{"deviceSn": "TLX123456", "deviceType": "tlx"}
]
mock_config_entry_classic.add_to_hass(hass)
await hass.config_entries.async_setup(mock_config_entry_classic.entry_id)
await hass.async_block_till_done()
# Verify services are registered (they're always registered in async_setup)
assert hass.services.has_service(DOMAIN, "update_time_segment")
assert hass.services.has_service(DOMAIN, "read_time_segments")
# Get the TLX device (non-MIN)
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "TLX123456")})
assert device_entry is not None
# But calling them with a non-MIN device should fail with appropriate error
with pytest.raises(ServiceValidationError) as excinfo:
await hass.services.async_call(
DOMAIN,
"update_time_segment",
{
"device_id": device_entry.id,
"segment_id": 1,
"start_time": "09:00",
"end_time": "11:00",
"batt_mode": "load_first",
"enabled": True,
},
blocking=True,
)
assert excinfo.value.translation_domain == DOMAIN
assert excinfo.value.translation_key == "no_devices_configured"
async def test_multiple_devices_with_valid_device_id_works(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_growatt_v1_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test that multiple devices work when device_id is specified."""
# Configure mock to return two MIN devices
mock_growatt_v1_api.device_list.return_value = {
"devices": [
{"device_sn": "MIN123456", "type": 7},
{"device_sn": "MIN789012", "type": 7},
]
}
mock_config_entry.add_to_hass(hass)
await hass.config_entries.async_setup(mock_config_entry.entry_id)
await hass.async_block_till_done()
# Get the device registry ID for the first MIN device
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "MIN123456")})
assert device_entry is not None
# Test update service with specific device_id (device registry ID)
await hass.services.async_call(
DOMAIN,
"update_time_segment",
{
"device_id": device_entry.id,
"segment_id": 1,
"start_time": "09:00",
"end_time": "11:00",
"batt_mode": "load_first",
"enabled": True,
},
blocking=True,
)
mock_growatt_v1_api.min_write_time_segment.assert_called_once()
# Test read service with specific device_id (device registry ID)
response = await hass.services.async_call(
DOMAIN,
"read_time_segments",
{"device_id": device_entry.id},
blocking=True,
return_response=True,
)
assert response is not None
assert "time_segments" in response
@pytest.mark.usefixtures("mock_growatt_v1_api")
async def test_update_time_segment_invalid_time_format(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test handling invalid time format in update_time_segment."""
mock_config_entry.add_to_hass(hass)
await hass.config_entries.async_setup(mock_config_entry.entry_id)
await hass.async_block_till_done()
# Get the device registry ID
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "MIN123456")})
assert device_entry is not None
# Test with invalid time format
with pytest.raises(ServiceValidationError) as excinfo:
await hass.services.async_call(
DOMAIN,
"update_time_segment",
{
"device_id": device_entry.id,
"segment_id": 1,
"start_time": "invalid",
"end_time": "11:00",
"batt_mode": "load_first",
"enabled": True,
},
blocking=True,
)
assert excinfo.value.translation_domain == DOMAIN
assert excinfo.value.translation_key == "invalid_time_format"
assert excinfo.value.translation_placeholders == {"field_name": "start_time"}
@pytest.mark.usefixtures("mock_growatt_v1_api")
async def test_update_time_segment_invalid_segment_id(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test validation of segment_id range."""
mock_config_entry.add_to_hass(hass)
await hass.config_entries.async_setup(mock_config_entry.entry_id)
await hass.async_block_till_done()
# Get the device registry ID
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "MIN123456")})
assert device_entry is not None
# Test segment_id too low
with pytest.raises(ServiceValidationError) as excinfo:
await hass.services.async_call(
DOMAIN,
"update_time_segment",
{
"device_id": device_entry.id,
"segment_id": 0,
"start_time": "09:00",
"end_time": "11:00",
"batt_mode": "load_first",
"enabled": True,
},
blocking=True,
)
assert excinfo.value.translation_domain == DOMAIN
assert excinfo.value.translation_key == "invalid_segment_id"
assert excinfo.value.translation_placeholders == {"segment_id": "0"}
# Test segment_id too high
with pytest.raises(ServiceValidationError) as excinfo:
await hass.services.async_call(
DOMAIN,
"update_time_segment",
{
"device_id": device_entry.id,
"segment_id": 10,
"start_time": "09:00",
"end_time": "11:00",
"batt_mode": "load_first",
"enabled": True,
},
blocking=True,
)
assert excinfo.value.translation_domain == DOMAIN
assert excinfo.value.translation_key == "invalid_segment_id"
assert excinfo.value.translation_placeholders == {"segment_id": "10"}
@pytest.mark.usefixtures("mock_growatt_v1_api")
async def test_update_time_segment_invalid_batt_mode(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test validation of batt_mode value."""
mock_config_entry.add_to_hass(hass)
await hass.config_entries.async_setup(mock_config_entry.entry_id)
await hass.async_block_till_done()
# Get the device registry ID
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "MIN123456")})
assert device_entry is not None
# Test invalid batt_mode
with pytest.raises(ServiceValidationError) as excinfo:
await hass.services.async_call(
DOMAIN,
"update_time_segment",
{
"device_id": device_entry.id,
"segment_id": 1,
"start_time": "09:00",
"end_time": "11:00",
"batt_mode": "invalid_mode",
"enabled": True,
},
blocking=True,
)
assert excinfo.value.translation_domain == DOMAIN
assert excinfo.value.translation_key == "invalid_batt_mode"
assert excinfo.value.translation_placeholders["batt_mode"] == "invalid_mode"
assert "allowed_modes" in excinfo.value.translation_placeholders
@pytest.mark.usefixtures("mock_growatt_v1_api")
async def test_read_time_segments_api_error(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test handling API error when reading time segments."""
mock_config_entry.add_to_hass(hass)
await hass.config_entries.async_setup(mock_config_entry.entry_id)
await hass.async_block_till_done()
# Get the device registry ID
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "MIN123456")})
assert device_entry is not None
# Mock API error by making coordinator.read_time_segments raise an exception
with (
patch(
"homeassistant.components.growatt_server.coordinator.GrowattCoordinator.read_time_segments",
side_effect=HomeAssistantError(
translation_domain=DOMAIN,
translation_key="api_error",
translation_placeholders={"error": "API connection failed"},
),
),
pytest.raises(HomeAssistantError),
):
await hass.services.async_call(
DOMAIN,
"read_time_segments",
{"device_id": device_entry.id},
blocking=True,
return_response=True,
)
@pytest.mark.usefixtures("mock_growatt_v1_api")
async def test_service_with_invalid_device_id(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
) -> None:
"""Test service with device ID that doesn't exist in registry."""
mock_config_entry.add_to_hass(hass)
await hass.config_entries.async_setup(mock_config_entry.entry_id)
await hass.async_block_till_done()
# Test with invalid device_id (not in device registry)
with pytest.raises(ServiceValidationError) as excinfo:
await hass.services.async_call(
DOMAIN,
"update_time_segment",
{
"device_id": "invalid_device_id",
"segment_id": 1,
"start_time": "09:00",
"end_time": "11:00",
"batt_mode": "load_first",
"enabled": True,
},
blocking=True,
)
assert excinfo.value.translation_domain == DOMAIN
assert excinfo.value.translation_key == "device_not_found"
assert excinfo.value.translation_placeholders == {"device_id": "invalid_device_id"}
@pytest.mark.usefixtures("mock_growatt_v1_api")
async def test_service_with_non_growatt_device(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test service with device from another integration."""
mock_config_entry.add_to_hass(hass)
await hass.config_entries.async_setup(mock_config_entry.entry_id)
await hass.async_block_till_done()
# Create a device from a different integration
other_device = device_registry.async_get_or_create(
config_entry_id=mock_config_entry.entry_id,
identifiers={("other_domain", "other_device_123")},
name="Other Device",
)
# Test with device from different integration
with pytest.raises(ServiceValidationError) as excinfo:
await hass.services.async_call(
DOMAIN,
"update_time_segment",
{
"device_id": other_device.id,
"segment_id": 1,
"start_time": "09:00",
"end_time": "11:00",
"batt_mode": "load_first",
"enabled": True,
},
blocking=True,
)
assert excinfo.value.translation_domain == DOMAIN
assert excinfo.value.translation_key == "device_not_growatt"
assert excinfo.value.translation_placeholders == {"device_id": other_device.id}
@pytest.mark.usefixtures("mock_growatt_v1_api")
async def test_service_with_non_min_growatt_device(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test service with Growatt device that is not MIN type."""
mock_config_entry.add_to_hass(hass)
await hass.config_entries.async_setup(mock_config_entry.entry_id)
await hass.async_block_till_done()
# Manually create a TLX device (V1 API only creates MIN devices)
# This simulates having a non-MIN Growatt device from another source
tlx_device = device_registry.async_get_or_create(
config_entry_id=mock_config_entry.entry_id,
identifiers={(DOMAIN, "TLX789012")},
name="TLX Device",
)
# Test with TLX device (not a MIN device)
with pytest.raises(ServiceValidationError) as excinfo:
await hass.services.async_call(
DOMAIN,
"update_time_segment",
{
"device_id": tlx_device.id,
"segment_id": 1,
"start_time": "09:00",
"end_time": "11:00",
"batt_mode": "load_first",
"enabled": True,
},
blocking=True,
)
assert excinfo.value.translation_domain == DOMAIN
assert excinfo.value.translation_key == "device_not_configured"
assert excinfo.value.translation_placeholders == {
"device_type": "MIN",
"serial_number": "TLX789012",
}
@pytest.mark.parametrize(
"invalid_time",
["25:00", "12:99", "invalid", "12"],
ids=["invalid_hour", "invalid_minute", "non_numeric", "missing_parts"],
)
@pytest.mark.usefixtures("mock_growatt_v1_api")
async def test_update_time_segment_invalid_end_time_format(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
device_registry: dr.DeviceRegistry,
invalid_time: str,
) -> None:
"""Test handling invalid end_time format in update_time_segment."""
mock_config_entry.add_to_hass(hass)
await hass.config_entries.async_setup(mock_config_entry.entry_id)
await hass.async_block_till_done()
# Get the device registry ID
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "MIN123456")})
assert device_entry is not None
# Test with invalid end_time format
with pytest.raises(ServiceValidationError) as excinfo:
await hass.services.async_call(
DOMAIN,
"update_time_segment",
{
"device_id": device_entry.id,
"segment_id": 1,
"start_time": "09:00",
"end_time": invalid_time,
"batt_mode": "load_first",
"enabled": True,
},
blocking=True,
)
assert excinfo.value.translation_domain == DOMAIN
assert excinfo.value.translation_key == "invalid_time_format"
assert excinfo.value.translation_placeholders == {"field_name": "end_time"}
async def test_service_with_unloaded_config_entry(
hass: HomeAssistant,
mock_config_entry_classic: MockConfigEntry,
mock_growatt_classic_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test service call when config entry is not loaded."""
# Setup with TLX device
mock_growatt_classic_api.device_list.return_value = [
{"deviceSn": "TLX123456", "deviceType": "tlx"}
]
mock_config_entry_classic.add_to_hass(hass)
await hass.config_entries.async_setup(mock_config_entry_classic.entry_id)
await hass.async_block_till_done()
# Get the device
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "TLX123456")})
assert device_entry is not None
# Unload the config entry
await hass.config_entries.async_unload(mock_config_entry_classic.entry_id)
await hass.async_block_till_done()
# Test service call with unloaded entry (should skip it in get_min_coordinators)
with pytest.raises(ServiceValidationError):
await hass.services.async_call(
DOMAIN,
"update_time_segment",
{
"device_id": device_entry.id,
"segment_id": 1,
"start_time": "09:00",
"end_time": "11:00",
"batt_mode": "load_first",
"enabled": True,
},
blocking=True,
)
# ---------------------------------------------------------------------------
# SPH device service tests
# ---------------------------------------------------------------------------
async def _setup_sph_integration(
hass: HomeAssistant,
mock_config_entry,
mock_growatt_v1_api: MagicMock,
) -> None:
"""Set up the integration with a single SPH device."""
mock_growatt_v1_api.device_list.return_value = {
"devices": [{"device_sn": "SPH123456", "type": 5}]
}
mock_config_entry.add_to_hass(hass)
await hass.config_entries.async_setup(mock_config_entry.entry_id)
await hass.async_block_till_done()
@pytest.mark.usefixtures("mock_growatt_v1_api")
async def test_read_ac_charge_times(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_growatt_v1_api: MagicMock,
device_registry: dr.DeviceRegistry,
snapshot: SnapshotAssertion,
) -> None:
"""Test reading AC charge times from SPH device."""
await _setup_sph_integration(hass, mock_config_entry, mock_growatt_v1_api)
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "SPH123456")})
assert device_entry is not None
response = await hass.services.async_call(
DOMAIN,
"read_ac_charge_times",
{"device_id": device_entry.id},
blocking=True,
return_response=True,
)
assert response == snapshot
@pytest.mark.usefixtures("mock_growatt_v1_api")
async def test_read_ac_discharge_times(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_growatt_v1_api: MagicMock,
device_registry: dr.DeviceRegistry,
snapshot: SnapshotAssertion,
) -> None:
"""Test reading AC discharge times from SPH device."""
await _setup_sph_integration(hass, mock_config_entry, mock_growatt_v1_api)
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "SPH123456")})
assert device_entry is not None
response = await hass.services.async_call(
DOMAIN,
"read_ac_discharge_times",
{"device_id": device_entry.id},
blocking=True,
return_response=True,
)
assert response == snapshot
async def test_write_ac_charge_times(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_growatt_v1_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test writing AC charge times to SPH device."""
await _setup_sph_integration(hass, mock_config_entry, mock_growatt_v1_api)
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "SPH123456")})
assert device_entry is not None
await hass.services.async_call(
DOMAIN,
"write_ac_charge_times",
{
"device_id": device_entry.id,
"charge_power": 80,
"charge_stop_soc": 95,
"mains_enabled": True,
"period_1_start": "02:00",
"period_1_end": "06:00",
"period_1_enabled": True,
},
blocking=True,
)
mock_growatt_v1_api.sph_write_ac_charge_times.assert_called_once()
async def test_write_ac_charge_times_with_seconds_format(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_growatt_v1_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test writing AC charge times with HH:MM:SS format from UI time selector."""
await _setup_sph_integration(hass, mock_config_entry, mock_growatt_v1_api)
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "SPH123456")})
assert device_entry is not None
await hass.services.async_call(
DOMAIN,
"write_ac_charge_times",
{
"device_id": device_entry.id,
"charge_power": 100,
"charge_stop_soc": 90,
"mains_enabled": False,
"period_1_start": "02:00:00",
"period_1_end": "06:00:00",
"period_1_enabled": True,
},
blocking=True,
)
mock_growatt_v1_api.sph_write_ac_charge_times.assert_called_once()
async def test_write_ac_discharge_times(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_growatt_v1_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test writing AC discharge times to SPH device."""
await _setup_sph_integration(hass, mock_config_entry, mock_growatt_v1_api)
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "SPH123456")})
assert device_entry is not None
await hass.services.async_call(
DOMAIN,
"write_ac_discharge_times",
{
"device_id": device_entry.id,
"discharge_power": 75,
"discharge_stop_soc": 20,
"period_1_start": "11:00",
"period_1_end": "15:00",
"period_1_enabled": True,
},
blocking=True,
)
mock_growatt_v1_api.sph_write_ac_discharge_times.assert_called_once()
async def test_write_ac_charge_times_api_error(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_growatt_v1_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test handling API error when writing AC charge times."""
await _setup_sph_integration(hass, mock_config_entry, mock_growatt_v1_api)
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "SPH123456")})
assert device_entry is not None
mock_growatt_v1_api.sph_write_ac_charge_times.side_effect = (
growattServer.GrowattV1ApiError("Write failed", error_code=1, error_msg="Error")
)
with pytest.raises(HomeAssistantError):
await hass.services.async_call(
DOMAIN,
"write_ac_charge_times",
{
"device_id": device_entry.id,
"charge_power": 100,
"charge_stop_soc": 90,
"mains_enabled": True,
},
blocking=True,
)
async def test_write_ac_discharge_times_api_error(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_growatt_v1_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test handling API error when writing AC discharge times."""
await _setup_sph_integration(hass, mock_config_entry, mock_growatt_v1_api)
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "SPH123456")})
assert device_entry is not None
mock_growatt_v1_api.sph_write_ac_discharge_times.side_effect = (
growattServer.GrowattV1ApiError("Write failed", error_code=1, error_msg="Error")
)
with pytest.raises(HomeAssistantError):
await hass.services.async_call(
DOMAIN,
"write_ac_discharge_times",
{
"device_id": device_entry.id,
"discharge_power": 100,
"discharge_stop_soc": 10,
},
blocking=True,
)
async def test_write_ac_charge_times_invalid_charge_power(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_growatt_v1_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test validation of charge_power range."""
await _setup_sph_integration(hass, mock_config_entry, mock_growatt_v1_api)
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "SPH123456")})
assert device_entry is not None
with pytest.raises(ServiceValidationError) as excinfo:
await hass.services.async_call(
DOMAIN,
"write_ac_charge_times",
{
"device_id": device_entry.id,
"charge_power": 150,
"charge_stop_soc": 90,
"mains_enabled": True,
},
blocking=True,
)
assert excinfo.value.translation_domain == DOMAIN
assert excinfo.value.translation_key == "invalid_charge_power"
assert excinfo.value.translation_placeholders == {"value": "150"}
async def test_write_ac_charge_times_invalid_charge_stop_soc(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_growatt_v1_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test validation of charge_stop_soc range."""
await _setup_sph_integration(hass, mock_config_entry, mock_growatt_v1_api)
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "SPH123456")})
assert device_entry is not None
with pytest.raises(ServiceValidationError) as excinfo:
await hass.services.async_call(
DOMAIN,
"write_ac_charge_times",
{
"device_id": device_entry.id,
"charge_power": 100,
"charge_stop_soc": 110,
"mains_enabled": True,
},
blocking=True,
)
assert excinfo.value.translation_domain == DOMAIN
assert excinfo.value.translation_key == "invalid_charge_stop_soc"
assert excinfo.value.translation_placeholders == {"value": "110"}
async def test_write_ac_discharge_times_invalid_discharge_power(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_growatt_v1_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test validation of discharge_power range."""
await _setup_sph_integration(hass, mock_config_entry, mock_growatt_v1_api)
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "SPH123456")})
assert device_entry is not None
with pytest.raises(ServiceValidationError) as excinfo:
await hass.services.async_call(
DOMAIN,
"write_ac_discharge_times",
{
"device_id": device_entry.id,
"discharge_power": 200,
"discharge_stop_soc": 10,
},
blocking=True,
)
assert excinfo.value.translation_domain == DOMAIN
assert excinfo.value.translation_key == "invalid_discharge_power"
assert excinfo.value.translation_placeholders == {"value": "200"}
async def test_write_ac_discharge_times_invalid_discharge_stop_soc(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_growatt_v1_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test validation of discharge_stop_soc range."""
await _setup_sph_integration(hass, mock_config_entry, mock_growatt_v1_api)
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "SPH123456")})
assert device_entry is not None
with pytest.raises(ServiceValidationError) as excinfo:
await hass.services.async_call(
DOMAIN,
"write_ac_discharge_times",
{
"device_id": device_entry.id,
"discharge_power": 100,
"discharge_stop_soc": -5,
},
blocking=True,
)
assert excinfo.value.translation_domain == DOMAIN
assert excinfo.value.translation_key == "invalid_discharge_stop_soc"
assert excinfo.value.translation_placeholders == {"value": "-5"}
async def test_write_ac_charge_times_invalid_period_time(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_growatt_v1_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test validation of invalid period time format."""
await _setup_sph_integration(hass, mock_config_entry, mock_growatt_v1_api)
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "SPH123456")})
assert device_entry is not None
with pytest.raises(ServiceValidationError) as excinfo:
await hass.services.async_call(
DOMAIN,
"write_ac_charge_times",
{
"device_id": device_entry.id,
"charge_power": 100,
"charge_stop_soc": 90,
"mains_enabled": True,
"period_1_start": "invalid",
"period_1_end": "06:00",
},
blocking=True,
)
assert excinfo.value.translation_domain == DOMAIN
assert excinfo.value.translation_key == "invalid_time_format"
assert excinfo.value.translation_placeholders == {"field_name": "period_1_start"}
async def test_no_sph_devices_fails_gracefully(
hass: HomeAssistant,
mock_config_entry_classic: MockConfigEntry,
mock_growatt_classic_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test that SPH services fail gracefully when no SPH devices exist."""
mock_growatt_classic_api.device_list.return_value = [
{"deviceSn": "TLX123456", "deviceType": "tlx"}
]
mock_config_entry_classic.add_to_hass(hass)
await hass.config_entries.async_setup(mock_config_entry_classic.entry_id)
await hass.async_block_till_done()
assert hass.services.has_service(DOMAIN, "write_ac_charge_times")
assert hass.services.has_service(DOMAIN, "read_ac_charge_times")
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "TLX123456")})
assert device_entry is not None
with pytest.raises(ServiceValidationError) as excinfo:
await hass.services.async_call(
DOMAIN,
"write_ac_charge_times",
{
"device_id": device_entry.id,
"charge_power": 100,
"charge_stop_soc": 90,
"mains_enabled": True,
},
blocking=True,
)
assert excinfo.value.translation_domain == DOMAIN
assert excinfo.value.translation_key == "no_devices_configured"
async def test_sph_service_with_non_sph_growatt_device(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_growatt_v1_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test SPH service called with a non-SPH Growatt device."""
await _setup_sph_integration(hass, mock_config_entry, mock_growatt_v1_api)
# Manually register a MIN device (not SPH)
min_device = device_registry.async_get_or_create(
config_entry_id=mock_config_entry.entry_id,
identifiers={(DOMAIN, "MIN999999")},
name="MIN Device",
)
with pytest.raises(ServiceValidationError) as excinfo:
await hass.services.async_call(
DOMAIN,
"write_ac_charge_times",
{
"device_id": min_device.id,
"charge_power": 100,
"charge_stop_soc": 90,
"mains_enabled": True,
},
blocking=True,
)
assert excinfo.value.translation_domain == DOMAIN
assert excinfo.value.translation_key == "device_not_configured"
assert excinfo.value.translation_placeholders == {
"device_type": "SPH",
"serial_number": "MIN999999",
}
async def test_write_ac_charge_times_uses_cached_periods_for_unspecified(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_growatt_v1_api: MagicMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test that unspecified periods are filled from cached settings."""
await _setup_sph_integration(hass, mock_config_entry, mock_growatt_v1_api)
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "SPH123456")})
assert device_entry is not None
# Only override period 1; periods 2 and 3 should come from cache (all 00:00)
await hass.services.async_call(
DOMAIN,
"write_ac_charge_times",
{
"device_id": device_entry.id,
"charge_power": 100,
"charge_stop_soc": 90,
"mains_enabled": True,
"period_1_start": "03:00",
"period_1_end": "07:00",
"period_1_enabled": True,
},
blocking=True,
)
# Verify the API was called with datetime.time objects (not strings)
mock_growatt_v1_api.sph_write_ac_charge_times.assert_called_once_with(
"SPH123456",
100,
90,
True,
[
{
"start_time": dt.time(3, 0),
"end_time": dt.time(7, 0),
"enabled": True,
},
{
"start_time": dt.time(0, 0),
"end_time": dt.time(0, 0),
"enabled": False,
},
{
"start_time": dt.time(0, 0),
"end_time": dt.time(0, 0),
"enabled": False,
},
],
)