Files
core/tests/components/imou/test_select.py
T

249 lines
8.4 KiB
Python

"""Tests for Imou select platform."""
from unittest.mock import MagicMock
from freezegun.api import FrozenDateTimeFactory
from pyimouapi.const import (
PARAM_CURRENT_OPTION,
PARAM_DEVICE_VOLUME,
PARAM_NIGHT_VISION_MODE,
PARAM_OPTIONS,
PARAM_STATE,
PARAM_STATUS,
)
from pyimouapi.exceptions import ImouException
from pyimouapi.ha_device import DeviceStatus, ImouHaDevice
import pytest
from syrupy.assertion import SnapshotAssertion
from homeassistant.components.imou.coordinator import SCAN_INTERVAL
from homeassistant.components.select import DOMAIN as SELECT_DOMAIN
from homeassistant.const import (
ATTR_ENTITY_ID,
ATTR_OPTION,
SERVICE_SELECT_OPTION,
STATE_UNAVAILABLE,
Platform,
)
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError
from homeassistant.helpers import entity_registry as er
from .const import UNKNOWN_SELECT_KEY, create_online_device, select_mock_devices
from tests.common import MockConfigEntry, async_fire_time_changed, snapshot_platform
@pytest.mark.parametrize("platforms", [[Platform.SELECT]], indirect=True)
@pytest.mark.parametrize("imou_mock_devices", [select_mock_devices], indirect=True)
@pytest.mark.usefixtures("init_integration")
async def test_select_entities_snapshot(
hass: HomeAssistant,
entity_registry: er.EntityRegistry,
snapshot: SnapshotAssertion,
mock_config_entry: MockConfigEntry,
) -> None:
"""Snapshot select entities created from the mock device list."""
await snapshot_platform(hass, entity_registry, snapshot, mock_config_entry.entry_id)
@pytest.mark.parametrize("platforms", [[Platform.SELECT]], indirect=True)
@pytest.mark.parametrize(
"imou_mock_devices",
[
[
create_online_device(
"d1",
"Device 1",
button_keys=(),
selects={
UNKNOWN_SELECT_KEY: {
PARAM_CURRENT_OPTION: "0",
PARAM_OPTIONS: ["0", "1"],
},
PARAM_NIGHT_VISION_MODE: {
PARAM_CURRENT_OPTION: "intelligent",
PARAM_OPTIONS: ["intelligent", "fullcolor", "infrared", "off"],
},
},
)
]
],
indirect=True,
)
@pytest.mark.usefixtures("init_integration")
async def test_setup_ignores_unknown_select_types(
entity_registry: er.EntityRegistry,
mock_config_entry: MockConfigEntry,
) -> None:
"""Unknown select keys from the API are not turned into entities."""
entries = er.async_entries_for_config_entry(
entity_registry, mock_config_entry.entry_id
)
select_entries = [entry for entry in entries if entry.domain == SELECT_DOMAIN]
assert len(select_entries) == 1
assert select_entries[0].translation_key == PARAM_NIGHT_VISION_MODE
@pytest.mark.parametrize("platforms", [[Platform.SELECT]], indirect=True)
@pytest.mark.parametrize("imou_mock_devices", [select_mock_devices], indirect=True)
@pytest.mark.usefixtures("init_integration")
async def test_select_option_via_domain_service(
hass: HomeAssistant,
entity_registry: er.EntityRegistry,
mock_config_entry: MockConfigEntry,
mock_imou_ha_device_manager: MagicMock,
) -> None:
"""Selecting an option calls the vendor library through the coordinator."""
async def _side_effect(device: ImouHaDevice, select_type: str, option: str) -> None:
device.selects[select_type][PARAM_CURRENT_OPTION] = option
mock_imou_ha_device_manager.async_select_option.side_effect = _side_effect
volume_entry = next(
entry
for entry in er.async_entries_for_config_entry(
entity_registry, mock_config_entry.entry_id
)
if entry.unique_id == "d1$device_volume"
)
await hass.services.async_call(
SELECT_DOMAIN,
SERVICE_SELECT_OPTION,
{ATTR_ENTITY_ID: volume_entry.entity_id, ATTR_OPTION: "high"},
blocking=True,
)
mock_imou_ha_device_manager.async_select_option.assert_awaited_once()
call = mock_imou_ha_device_manager.async_select_option.await_args
assert call is not None
assert call.args[1] == PARAM_DEVICE_VOLUME
assert call.args[2] == "high"
assert hass.states.get(volume_entry.entity_id).state == "high"
@pytest.mark.parametrize("platforms", [[Platform.SELECT]], indirect=True)
@pytest.mark.parametrize("imou_mock_devices", [select_mock_devices], indirect=True)
@pytest.mark.usefixtures("init_integration")
async def test_select_option_propagates_api_error(
hass: HomeAssistant,
entity_registry: er.EntityRegistry,
mock_config_entry: MockConfigEntry,
mock_imou_ha_device_manager: MagicMock,
) -> None:
"""Imou API errors from async_select_option surface to the service call."""
mock_imou_ha_device_manager.async_select_option.side_effect = ImouException(
"cloud failure"
)
volume_entry = next(
entry
for entry in er.async_entries_for_config_entry(
entity_registry, mock_config_entry.entry_id
)
if entry.unique_id == "d1$device_volume"
)
with pytest.raises(
HomeAssistantError, match="Imou rejected the new option: cloud failure"
):
await hass.services.async_call(
SELECT_DOMAIN,
SERVICE_SELECT_OPTION,
{ATTR_ENTITY_ID: volume_entry.entity_id, ATTR_OPTION: "high"},
blocking=True,
)
@pytest.mark.parametrize("platforms", [[Platform.SELECT]], indirect=True)
@pytest.mark.parametrize(
"imou_mock_devices",
[
[
create_online_device(
"d1",
"Device 1",
button_keys=(),
selects={
PARAM_NIGHT_VISION_MODE: {
PARAM_CURRENT_OPTION: "intelligent",
PARAM_OPTIONS: ["intelligent", "fullcolor", "infrared", "off"],
}
},
)
]
],
indirect=True,
)
@pytest.mark.usefixtures("init_integration")
async def test_select_option_unavailable_offline_device(
hass: HomeAssistant,
freezer: FrozenDateTimeFactory,
entity_registry: er.EntityRegistry,
mock_config_entry: MockConfigEntry,
mock_imou_ha_device_manager: MagicMock,
) -> None:
"""Selecting an option on an offline device does not call the vendor library."""
night_entry = next(
entry
for entry in er.async_entries_for_config_entry(
entity_registry, mock_config_entry.entry_id
)
if entry.unique_id == "d1$night_vision_mode"
)
async def set_device_offline(device: ImouHaDevice) -> None:
device._sensors[PARAM_STATUS] = {PARAM_STATE: DeviceStatus.OFFLINE.value}
mock_imou_ha_device_manager.async_update_device_status.side_effect = (
set_device_offline
)
freezer.tick(SCAN_INTERVAL)
async_fire_time_changed(hass)
await hass.async_block_till_done(wait_background_tasks=True)
assert hass.states.get(night_entry.entity_id).state == STATE_UNAVAILABLE
await hass.services.async_call(
SELECT_DOMAIN,
SERVICE_SELECT_OPTION,
{ATTR_ENTITY_ID: night_entry.entity_id, ATTR_OPTION: "fullcolor"},
blocking=True,
)
mock_imou_ha_device_manager.async_select_option.assert_not_called()
@pytest.mark.parametrize("platforms", [[Platform.SELECT]], indirect=True)
@pytest.mark.parametrize("imou_mock_devices", [select_mock_devices], indirect=True)
@pytest.mark.usefixtures("init_integration")
async def test_entities_removed_when_device_leaves_account(
hass: HomeAssistant,
entity_registry: er.EntityRegistry,
mock_config_entry: MockConfigEntry,
mock_imou_ha_device_manager: MagicMock,
freezer: FrozenDateTimeFactory,
) -> None:
"""Select entities are removed when the device is no longer on the account."""
volume_entry = next(
entry
for entry in er.async_entries_for_config_entry(
entity_registry, mock_config_entry.entry_id
)
if entry.unique_id == "d1$device_volume"
)
assert hass.states.get(volume_entry.entity_id).state != STATE_UNAVAILABLE
mock_imou_ha_device_manager.async_get_devices.return_value = []
freezer.tick(SCAN_INTERVAL)
async_fire_time_changed(hass)
await hass.async_block_till_done(wait_background_tasks=True)
assert (
er.async_entries_for_config_entry(entity_registry, mock_config_entry.entry_id)
== []
)
assert hass.states.get(volume_entry.entity_id) is None