mirror of https://github.com/home-assistant/core
242 lines
7.3 KiB
Python
242 lines
7.3 KiB
Python
"""Test the UniFi Protect global services."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from unittest.mock import AsyncMock, Mock
|
|
|
|
import pytest
|
|
from uiprotect.data import Camera, Chime, Color, Light, ModelType
|
|
from uiprotect.data.devices import CameraZone
|
|
from uiprotect.exceptions import BadRequest
|
|
|
|
from homeassistant.components.unifiprotect.const import ATTR_MESSAGE, DOMAIN
|
|
from homeassistant.components.unifiprotect.services import (
|
|
SERVICE_ADD_DOORBELL_TEXT,
|
|
SERVICE_REMOVE_DOORBELL_TEXT,
|
|
SERVICE_REMOVE_PRIVACY_ZONE,
|
|
SERVICE_SET_CHIME_PAIRED,
|
|
)
|
|
from homeassistant.config_entries import ConfigEntryDisabler
|
|
from homeassistant.const import ATTR_DEVICE_ID, ATTR_ENTITY_ID, ATTR_NAME
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.exceptions import HomeAssistantError
|
|
from homeassistant.helpers import device_registry as dr, entity_registry as er
|
|
|
|
from .utils import MockUFPFixture, init_entry
|
|
|
|
|
|
@pytest.fixture(name="device")
|
|
async def device_fixture(
|
|
hass: HomeAssistant, device_registry: dr.DeviceRegistry, ufp: MockUFPFixture
|
|
):
|
|
"""Fixture with entry setup to call services with."""
|
|
|
|
await init_entry(hass, ufp, [])
|
|
|
|
return list(device_registry.devices.values())[0]
|
|
|
|
|
|
@pytest.fixture(name="subdevice")
|
|
async def subdevice_fixture(
|
|
hass: HomeAssistant,
|
|
device_registry: dr.DeviceRegistry,
|
|
ufp: MockUFPFixture,
|
|
light: Light,
|
|
):
|
|
"""Fixture with entry setup to call services with."""
|
|
|
|
await init_entry(hass, ufp, [light])
|
|
|
|
return [d for d in device_registry.devices.values() if d.name != "UnifiProtect"][0]
|
|
|
|
|
|
async def test_global_service_bad_device(
|
|
hass: HomeAssistant, ufp: MockUFPFixture
|
|
) -> None:
|
|
"""Test global service, invalid device ID."""
|
|
|
|
nvr = ufp.api.bootstrap.nvr
|
|
nvr.__fields__["add_custom_doorbell_message"] = Mock(final=False)
|
|
nvr.add_custom_doorbell_message = AsyncMock()
|
|
|
|
with pytest.raises(HomeAssistantError):
|
|
await hass.services.async_call(
|
|
DOMAIN,
|
|
SERVICE_ADD_DOORBELL_TEXT,
|
|
{ATTR_DEVICE_ID: "bad_device_id", ATTR_MESSAGE: "Test Message"},
|
|
blocking=True,
|
|
)
|
|
assert not nvr.add_custom_doorbell_message.called
|
|
|
|
|
|
async def test_global_service_exception(
|
|
hass: HomeAssistant, device: dr.DeviceEntry, ufp: MockUFPFixture
|
|
) -> None:
|
|
"""Test global service, unexpected error."""
|
|
|
|
nvr = ufp.api.bootstrap.nvr
|
|
nvr.__fields__["add_custom_doorbell_message"] = Mock(final=False)
|
|
nvr.add_custom_doorbell_message = AsyncMock(side_effect=BadRequest)
|
|
|
|
with pytest.raises(HomeAssistantError):
|
|
await hass.services.async_call(
|
|
DOMAIN,
|
|
SERVICE_ADD_DOORBELL_TEXT,
|
|
{ATTR_DEVICE_ID: device.id, ATTR_MESSAGE: "Test Message"},
|
|
blocking=True,
|
|
)
|
|
assert nvr.add_custom_doorbell_message.called
|
|
|
|
|
|
async def test_add_doorbell_text(
|
|
hass: HomeAssistant, device: dr.DeviceEntry, ufp: MockUFPFixture
|
|
) -> None:
|
|
"""Test add_doorbell_text service."""
|
|
|
|
nvr = ufp.api.bootstrap.nvr
|
|
nvr.__fields__["add_custom_doorbell_message"] = Mock(final=False)
|
|
nvr.add_custom_doorbell_message = AsyncMock()
|
|
|
|
await hass.services.async_call(
|
|
DOMAIN,
|
|
SERVICE_ADD_DOORBELL_TEXT,
|
|
{ATTR_DEVICE_ID: device.id, ATTR_MESSAGE: "Test Message"},
|
|
blocking=True,
|
|
)
|
|
nvr.add_custom_doorbell_message.assert_called_once_with("Test Message")
|
|
|
|
|
|
async def test_remove_doorbell_text(
|
|
hass: HomeAssistant, subdevice: dr.DeviceEntry, ufp: MockUFPFixture
|
|
) -> None:
|
|
"""Test remove_doorbell_text service."""
|
|
|
|
nvr = ufp.api.bootstrap.nvr
|
|
nvr.__fields__["remove_custom_doorbell_message"] = Mock(final=False)
|
|
nvr.remove_custom_doorbell_message = AsyncMock()
|
|
|
|
await hass.services.async_call(
|
|
DOMAIN,
|
|
SERVICE_REMOVE_DOORBELL_TEXT,
|
|
{ATTR_DEVICE_ID: subdevice.id, ATTR_MESSAGE: "Test Message"},
|
|
blocking=True,
|
|
)
|
|
nvr.remove_custom_doorbell_message.assert_called_once_with("Test Message")
|
|
|
|
|
|
async def test_add_doorbell_text_disabled_config_entry(
|
|
hass: HomeAssistant, device: dr.DeviceEntry, ufp: MockUFPFixture
|
|
) -> None:
|
|
"""Test add_doorbell_text service."""
|
|
nvr = ufp.api.bootstrap.nvr
|
|
nvr.__fields__["add_custom_doorbell_message"] = Mock(final=False)
|
|
nvr.add_custom_doorbell_message = AsyncMock()
|
|
|
|
await hass.config_entries.async_set_disabled_by(
|
|
ufp.entry.entry_id, ConfigEntryDisabler.USER
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
with pytest.raises(HomeAssistantError):
|
|
await hass.services.async_call(
|
|
DOMAIN,
|
|
SERVICE_ADD_DOORBELL_TEXT,
|
|
{ATTR_DEVICE_ID: device.id, ATTR_MESSAGE: "Test Message"},
|
|
blocking=True,
|
|
)
|
|
assert not nvr.add_custom_doorbell_message.called
|
|
|
|
|
|
async def test_set_chime_paired_doorbells(
|
|
hass: HomeAssistant,
|
|
entity_registry: er.EntityRegistry,
|
|
ufp: MockUFPFixture,
|
|
chime: Chime,
|
|
doorbell: Camera,
|
|
) -> None:
|
|
"""Test set_chime_paired_doorbells."""
|
|
|
|
ufp.api.update_device = AsyncMock()
|
|
|
|
camera1 = doorbell.copy()
|
|
camera1.name = "Test Camera 1"
|
|
|
|
camera2 = doorbell.copy()
|
|
camera2.name = "Test Camera 2"
|
|
|
|
await init_entry(hass, ufp, [camera1, camera2, chime])
|
|
|
|
chime_entry = entity_registry.async_get("button.test_chime_play_chime")
|
|
camera_entry = entity_registry.async_get("binary_sensor.test_camera_2_doorbell")
|
|
assert chime_entry is not None
|
|
assert camera_entry is not None
|
|
|
|
await hass.services.async_call(
|
|
DOMAIN,
|
|
SERVICE_SET_CHIME_PAIRED,
|
|
{
|
|
ATTR_DEVICE_ID: chime_entry.device_id,
|
|
"doorbells": {
|
|
ATTR_ENTITY_ID: ["binary_sensor.test_camera_1_doorbell"],
|
|
ATTR_DEVICE_ID: [camera_entry.device_id],
|
|
},
|
|
},
|
|
blocking=True,
|
|
)
|
|
|
|
ufp.api.update_device.assert_called_once_with(
|
|
ModelType.CHIME, chime.id, {"cameraIds": sorted([camera1.id, camera2.id])}
|
|
)
|
|
|
|
|
|
async def test_remove_privacy_zone_no_zone(
|
|
hass: HomeAssistant,
|
|
entity_registry: er.EntityRegistry,
|
|
ufp: MockUFPFixture,
|
|
doorbell: Camera,
|
|
) -> None:
|
|
"""Test remove_privacy_zone service."""
|
|
|
|
ufp.api.update_device = AsyncMock()
|
|
doorbell.privacy_zones = []
|
|
|
|
await init_entry(hass, ufp, [doorbell])
|
|
|
|
camera_entry = entity_registry.async_get("binary_sensor.test_camera_doorbell")
|
|
|
|
with pytest.raises(HomeAssistantError):
|
|
await hass.services.async_call(
|
|
DOMAIN,
|
|
SERVICE_REMOVE_PRIVACY_ZONE,
|
|
{ATTR_DEVICE_ID: camera_entry.device_id, ATTR_NAME: "Testing"},
|
|
blocking=True,
|
|
)
|
|
ufp.api.update_device.assert_not_called()
|
|
|
|
|
|
async def test_remove_privacy_zone(
|
|
hass: HomeAssistant,
|
|
entity_registry: er.EntityRegistry,
|
|
ufp: MockUFPFixture,
|
|
doorbell: Camera,
|
|
) -> None:
|
|
"""Test remove_privacy_zone service."""
|
|
|
|
ufp.api.update_device = AsyncMock()
|
|
doorbell.privacy_zones = [
|
|
CameraZone(id=0, name="Testing", color=Color("red"), points=[(0, 0), (1, 1)])
|
|
]
|
|
|
|
await init_entry(hass, ufp, [doorbell])
|
|
|
|
camera_entry = entity_registry.async_get("binary_sensor.test_camera_doorbell")
|
|
|
|
await hass.services.async_call(
|
|
DOMAIN,
|
|
SERVICE_REMOVE_PRIVACY_ZONE,
|
|
{ATTR_DEVICE_ID: camera_entry.device_id, ATTR_NAME: "Testing"},
|
|
blocking=True,
|
|
)
|
|
ufp.api.update_device.assert_called()
|
|
assert not doorbell.privacy_zones
|