Move services to entity services in blink (#105413)
* Use device name to lookup camera * Fix device registry serial * Move to entity based services * Update tests * Use config_entry Move refresh service out of camera * Use config entry for services * Fix service schema * Add depreciation note * Depreciation note * key error changes deprecated (not depreciated) repair issue * tweak message * deprication v2 * back out update field change * backout update schema changes * Finish rollback on update service * update doc strings * move to 2024.7.0 More verbosity to deprecation message
This commit is contained in:
mkmer
GitHub
parent
1909163c8e
commit
e7e0ae8f6a
6 changed files with 209 additions and 387 deletions
|
|
@ -4,22 +4,15 @@ from unittest.mock import AsyncMock, MagicMock, Mock
|
|||
import pytest
|
||||
|
||||
from homeassistant.components.blink.const import (
|
||||
ATTR_CONFIG_ENTRY_ID,
|
||||
DOMAIN,
|
||||
SERVICE_REFRESH,
|
||||
SERVICE_SAVE_RECENT_CLIPS,
|
||||
SERVICE_SAVE_VIDEO,
|
||||
SERVICE_SEND_PIN,
|
||||
)
|
||||
from homeassistant.config_entries import ConfigEntryState
|
||||
from homeassistant.const import (
|
||||
ATTR_DEVICE_ID,
|
||||
CONF_FILE_PATH,
|
||||
CONF_FILENAME,
|
||||
CONF_NAME,
|
||||
CONF_PIN,
|
||||
)
|
||||
from homeassistant.const import ATTR_DEVICE_ID, CONF_PIN
|
||||
from homeassistant.core import HomeAssistant
|
||||
from homeassistant.exceptions import HomeAssistantError, ServiceValidationError
|
||||
from homeassistant.exceptions import HomeAssistantError
|
||||
from homeassistant.helpers import device_registry as dr
|
||||
|
||||
from tests.common import MockConfigEntry
|
||||
|
|
@ -43,7 +36,6 @@ async def test_refresh_service_calls(
|
|||
await hass.async_block_till_done()
|
||||
|
||||
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "12345")})
|
||||
|
||||
assert device_entry
|
||||
|
||||
assert mock_config_entry.state is ConfigEntryState.LOADED
|
||||
|
|
@ -67,163 +59,8 @@ async def test_refresh_service_calls(
|
|||
)
|
||||
|
||||
|
||||
async def test_video_service_calls(
|
||||
hass: HomeAssistant,
|
||||
device_registry: dr.DeviceRegistry,
|
||||
mock_blink_api: MagicMock,
|
||||
mock_blink_auth_api: MagicMock,
|
||||
mock_config_entry: MockConfigEntry,
|
||||
caplog: pytest.LogCaptureFixture,
|
||||
) -> None:
|
||||
"""Test video service calls."""
|
||||
|
||||
mock_config_entry.add_to_hass(hass)
|
||||
assert await hass.config_entries.async_setup(mock_config_entry.entry_id)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "12345")})
|
||||
|
||||
assert device_entry
|
||||
|
||||
assert mock_config_entry.state is ConfigEntryState.LOADED
|
||||
assert mock_blink_api.refresh.call_count == 1
|
||||
|
||||
with pytest.raises(HomeAssistantError):
|
||||
await hass.services.async_call(
|
||||
DOMAIN,
|
||||
SERVICE_SAVE_VIDEO,
|
||||
{
|
||||
ATTR_DEVICE_ID: [device_entry.id],
|
||||
CONF_NAME: CAMERA_NAME,
|
||||
CONF_FILENAME: FILENAME,
|
||||
},
|
||||
blocking=True,
|
||||
)
|
||||
|
||||
hass.config.is_allowed_path = Mock(return_value=True)
|
||||
caplog.clear()
|
||||
mock_blink_api.cameras = {CAMERA_NAME: AsyncMock()}
|
||||
await hass.services.async_call(
|
||||
DOMAIN,
|
||||
SERVICE_SAVE_VIDEO,
|
||||
{
|
||||
ATTR_DEVICE_ID: [device_entry.id],
|
||||
CONF_NAME: CAMERA_NAME,
|
||||
CONF_FILENAME: FILENAME,
|
||||
},
|
||||
blocking=True,
|
||||
)
|
||||
mock_blink_api.cameras[CAMERA_NAME].video_to_file.assert_awaited_once()
|
||||
|
||||
with pytest.raises(HomeAssistantError):
|
||||
await hass.services.async_call(
|
||||
DOMAIN,
|
||||
SERVICE_SAVE_VIDEO,
|
||||
{
|
||||
ATTR_DEVICE_ID: ["bad-device_id"],
|
||||
CONF_NAME: CAMERA_NAME,
|
||||
CONF_FILENAME: FILENAME,
|
||||
},
|
||||
blocking=True,
|
||||
)
|
||||
|
||||
mock_blink_api.cameras[CAMERA_NAME].video_to_file = AsyncMock(side_effect=OSError)
|
||||
|
||||
with pytest.raises(ServiceValidationError):
|
||||
await hass.services.async_call(
|
||||
DOMAIN,
|
||||
SERVICE_SAVE_VIDEO,
|
||||
{
|
||||
ATTR_DEVICE_ID: [device_entry.id],
|
||||
CONF_NAME: CAMERA_NAME,
|
||||
CONF_FILENAME: FILENAME,
|
||||
},
|
||||
blocking=True,
|
||||
)
|
||||
|
||||
hass.config.is_allowed_path = Mock(return_value=False)
|
||||
|
||||
|
||||
async def test_picture_service_calls(
|
||||
hass: HomeAssistant,
|
||||
device_registry: dr.DeviceRegistry,
|
||||
mock_blink_api: MagicMock,
|
||||
mock_blink_auth_api: MagicMock,
|
||||
mock_config_entry: MockConfigEntry,
|
||||
caplog: pytest.LogCaptureFixture,
|
||||
) -> None:
|
||||
"""Test picture servcie calls."""
|
||||
|
||||
mock_config_entry.add_to_hass(hass)
|
||||
assert await hass.config_entries.async_setup(mock_config_entry.entry_id)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "12345")})
|
||||
|
||||
assert device_entry
|
||||
|
||||
assert mock_config_entry.state is ConfigEntryState.LOADED
|
||||
assert mock_blink_api.refresh.call_count == 1
|
||||
|
||||
with pytest.raises(ServiceValidationError):
|
||||
await hass.services.async_call(
|
||||
DOMAIN,
|
||||
SERVICE_SAVE_RECENT_CLIPS,
|
||||
{
|
||||
ATTR_DEVICE_ID: [device_entry.id],
|
||||
CONF_NAME: CAMERA_NAME,
|
||||
CONF_FILE_PATH: FILENAME,
|
||||
},
|
||||
blocking=True,
|
||||
)
|
||||
|
||||
hass.config.is_allowed_path = Mock(return_value=True)
|
||||
mock_blink_api.cameras = {CAMERA_NAME: AsyncMock()}
|
||||
|
||||
await hass.services.async_call(
|
||||
DOMAIN,
|
||||
SERVICE_SAVE_RECENT_CLIPS,
|
||||
{
|
||||
ATTR_DEVICE_ID: [device_entry.id],
|
||||
CONF_NAME: CAMERA_NAME,
|
||||
CONF_FILE_PATH: FILENAME,
|
||||
},
|
||||
blocking=True,
|
||||
)
|
||||
mock_blink_api.cameras[CAMERA_NAME].save_recent_clips.assert_awaited_once()
|
||||
|
||||
mock_blink_api.cameras[CAMERA_NAME].save_recent_clips = AsyncMock(
|
||||
side_effect=OSError
|
||||
)
|
||||
|
||||
with pytest.raises(ServiceValidationError):
|
||||
await hass.services.async_call(
|
||||
DOMAIN,
|
||||
SERVICE_SAVE_RECENT_CLIPS,
|
||||
{
|
||||
ATTR_DEVICE_ID: [device_entry.id],
|
||||
CONF_NAME: CAMERA_NAME,
|
||||
CONF_FILE_PATH: FILENAME,
|
||||
},
|
||||
blocking=True,
|
||||
)
|
||||
|
||||
with pytest.raises(HomeAssistantError):
|
||||
await hass.services.async_call(
|
||||
DOMAIN,
|
||||
SERVICE_SAVE_RECENT_CLIPS,
|
||||
{
|
||||
ATTR_DEVICE_ID: ["bad-device_id"],
|
||||
CONF_NAME: CAMERA_NAME,
|
||||
CONF_FILE_PATH: FILENAME,
|
||||
},
|
||||
blocking=True,
|
||||
)
|
||||
|
||||
|
||||
async def test_pin_service_calls(
|
||||
hass: HomeAssistant,
|
||||
device_registry: dr.DeviceRegistry,
|
||||
mock_blink_api: MagicMock,
|
||||
mock_blink_auth_api: MagicMock,
|
||||
mock_config_entry: MockConfigEntry,
|
||||
|
|
@ -234,17 +71,13 @@ async def test_pin_service_calls(
|
|||
assert await hass.config_entries.async_setup(mock_config_entry.entry_id)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "12345")})
|
||||
|
||||
assert device_entry
|
||||
|
||||
assert mock_config_entry.state is ConfigEntryState.LOADED
|
||||
assert mock_blink_api.refresh.call_count == 1
|
||||
|
||||
await hass.services.async_call(
|
||||
DOMAIN,
|
||||
SERVICE_SEND_PIN,
|
||||
{ATTR_DEVICE_ID: [device_entry.id], CONF_PIN: PIN},
|
||||
{ATTR_CONFIG_ENTRY_ID: [mock_config_entry.entry_id], CONF_PIN: PIN},
|
||||
blocking=True,
|
||||
)
|
||||
assert mock_blink_api.auth.send_auth_key.assert_awaited_once
|
||||
|
|
@ -253,41 +86,18 @@ async def test_pin_service_calls(
|
|||
await hass.services.async_call(
|
||||
DOMAIN,
|
||||
SERVICE_SEND_PIN,
|
||||
{ATTR_DEVICE_ID: ["bad-device_id"], CONF_PIN: PIN},
|
||||
{ATTR_CONFIG_ENTRY_ID: ["bad-config_id"], CONF_PIN: PIN},
|
||||
blocking=True,
|
||||
)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("service", "params"),
|
||||
[
|
||||
(SERVICE_SEND_PIN, {CONF_PIN: PIN}),
|
||||
(
|
||||
SERVICE_SAVE_RECENT_CLIPS,
|
||||
{
|
||||
CONF_NAME: CAMERA_NAME,
|
||||
CONF_FILE_PATH: FILENAME,
|
||||
},
|
||||
),
|
||||
(
|
||||
SERVICE_SAVE_VIDEO,
|
||||
{
|
||||
CONF_NAME: CAMERA_NAME,
|
||||
CONF_FILENAME: FILENAME,
|
||||
},
|
||||
),
|
||||
],
|
||||
)
|
||||
async def test_service_called_with_non_blink_device(
|
||||
async def test_service_pin_called_with_non_blink_device(
|
||||
hass: HomeAssistant,
|
||||
device_registry: dr.DeviceRegistry,
|
||||
mock_blink_api: MagicMock,
|
||||
mock_blink_auth_api: MagicMock,
|
||||
mock_config_entry: MockConfigEntry,
|
||||
service,
|
||||
params,
|
||||
) -> None:
|
||||
"""Test service calls with non blink device."""
|
||||
"""Test pin service calls with non blink device."""
|
||||
|
||||
mock_config_entry.add_to_hass(hass)
|
||||
assert await hass.config_entries.async_setup(mock_config_entry.entry_id)
|
||||
|
|
@ -295,11 +105,48 @@ async def test_service_called_with_non_blink_device(
|
|||
|
||||
other_domain = "NotBlink"
|
||||
other_config_id = "555"
|
||||
await hass.config_entries.async_add(
|
||||
MockConfigEntry(
|
||||
title="Not Blink", domain=other_domain, entry_id=other_config_id
|
||||
)
|
||||
other_mock_config_entry = MockConfigEntry(
|
||||
title="Not Blink", domain=other_domain, entry_id=other_config_id
|
||||
)
|
||||
await hass.config_entries.async_add(other_mock_config_entry)
|
||||
|
||||
hass.config.is_allowed_path = Mock(return_value=True)
|
||||
mock_blink_api.cameras = {CAMERA_NAME: AsyncMock()}
|
||||
|
||||
parameters = {
|
||||
ATTR_CONFIG_ENTRY_ID: [other_mock_config_entry.entry_id],
|
||||
CONF_PIN: PIN,
|
||||
}
|
||||
|
||||
with pytest.raises(HomeAssistantError):
|
||||
await hass.services.async_call(
|
||||
DOMAIN,
|
||||
SERVICE_SEND_PIN,
|
||||
parameters,
|
||||
blocking=True,
|
||||
)
|
||||
|
||||
|
||||
async def test_service_update_called_with_non_blink_device(
|
||||
hass: HomeAssistant,
|
||||
mock_blink_api: MagicMock,
|
||||
device_registry: dr.DeviceRegistry,
|
||||
mock_blink_auth_api: MagicMock,
|
||||
mock_config_entry: MockConfigEntry,
|
||||
) -> None:
|
||||
"""Test update service calls with non blink device."""
|
||||
|
||||
mock_config_entry.add_to_hass(hass)
|
||||
assert await hass.config_entries.async_setup(mock_config_entry.entry_id)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
other_domain = "NotBlink"
|
||||
other_config_id = "555"
|
||||
other_mock_config_entry = MockConfigEntry(
|
||||
title="Not Blink", domain=other_domain, entry_id=other_config_id
|
||||
)
|
||||
await hass.config_entries.async_add(other_mock_config_entry)
|
||||
|
||||
device_entry = device_registry.async_get_or_create(
|
||||
config_entry_id=other_config_id,
|
||||
identifiers={
|
||||
|
|
@ -311,67 +158,68 @@ async def test_service_called_with_non_blink_device(
|
|||
mock_blink_api.cameras = {CAMERA_NAME: AsyncMock()}
|
||||
|
||||
parameters = {ATTR_DEVICE_ID: [device_entry.id]}
|
||||
parameters.update(params)
|
||||
|
||||
with pytest.raises(ServiceValidationError):
|
||||
with pytest.raises(HomeAssistantError):
|
||||
await hass.services.async_call(
|
||||
DOMAIN,
|
||||
service,
|
||||
SERVICE_REFRESH,
|
||||
parameters,
|
||||
blocking=True,
|
||||
)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("service", "params"),
|
||||
[
|
||||
(SERVICE_SEND_PIN, {CONF_PIN: PIN}),
|
||||
(
|
||||
SERVICE_SAVE_RECENT_CLIPS,
|
||||
{
|
||||
CONF_NAME: CAMERA_NAME,
|
||||
CONF_FILE_PATH: FILENAME,
|
||||
},
|
||||
),
|
||||
(
|
||||
SERVICE_SAVE_VIDEO,
|
||||
{
|
||||
CONF_NAME: CAMERA_NAME,
|
||||
CONF_FILENAME: FILENAME,
|
||||
},
|
||||
),
|
||||
],
|
||||
)
|
||||
async def test_service_called_with_unloaded_entry(
|
||||
async def test_service_pin_called_with_unloaded_entry(
|
||||
hass: HomeAssistant,
|
||||
mock_blink_api: MagicMock,
|
||||
mock_blink_auth_api: MagicMock,
|
||||
mock_config_entry: MockConfigEntry,
|
||||
) -> None:
|
||||
"""Test pin service calls with not ready config entry."""
|
||||
|
||||
mock_config_entry.add_to_hass(hass)
|
||||
assert await hass.config_entries.async_setup(mock_config_entry.entry_id)
|
||||
await hass.async_block_till_done()
|
||||
mock_config_entry.state = ConfigEntryState.SETUP_ERROR
|
||||
hass.config.is_allowed_path = Mock(return_value=True)
|
||||
mock_blink_api.cameras = {CAMERA_NAME: AsyncMock()}
|
||||
|
||||
parameters = {ATTR_CONFIG_ENTRY_ID: [mock_config_entry.entry_id], CONF_PIN: PIN}
|
||||
|
||||
with pytest.raises(HomeAssistantError):
|
||||
await hass.services.async_call(
|
||||
DOMAIN,
|
||||
SERVICE_SEND_PIN,
|
||||
parameters,
|
||||
blocking=True,
|
||||
)
|
||||
|
||||
|
||||
async def test_service_update_called_with_unloaded_entry(
|
||||
hass: HomeAssistant,
|
||||
device_registry: dr.DeviceRegistry,
|
||||
mock_blink_api: MagicMock,
|
||||
mock_blink_auth_api: MagicMock,
|
||||
mock_config_entry: MockConfigEntry,
|
||||
service,
|
||||
params,
|
||||
) -> None:
|
||||
"""Test service calls with unloaded config entry."""
|
||||
"""Test update service calls with not ready config entry."""
|
||||
|
||||
mock_config_entry.add_to_hass(hass)
|
||||
assert await hass.config_entries.async_setup(mock_config_entry.entry_id)
|
||||
await hass.async_block_till_done()
|
||||
await mock_config_entry.async_unload(hass)
|
||||
|
||||
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "12345")})
|
||||
|
||||
assert device_entry
|
||||
|
||||
mock_config_entry.state = ConfigEntryState.SETUP_ERROR
|
||||
hass.config.is_allowed_path = Mock(return_value=True)
|
||||
mock_blink_api.cameras = {CAMERA_NAME: AsyncMock()}
|
||||
|
||||
device_entry = device_registry.async_get_device(identifiers={(DOMAIN, "12345")})
|
||||
assert device_entry
|
||||
|
||||
parameters = {ATTR_DEVICE_ID: [device_entry.id]}
|
||||
parameters.update(params)
|
||||
|
||||
with pytest.raises(HomeAssistantError):
|
||||
await hass.services.async_call(
|
||||
DOMAIN,
|
||||
service,
|
||||
SERVICE_REFRESH,
|
||||
parameters,
|
||||
blocking=True,
|
||||
)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue