Files
core/tests/components/unifiprotect/test_camera.py
T

1094 lines
39 KiB
Python

"""Test the UniFi Protect camera platform."""
from typing import Any
from unittest.mock import AsyncMock, Mock, patch
from aiohttp.client_exceptions import ServerDisconnectedError
import pytest
from uiprotect.api import RTSPSStreams
from uiprotect.data import (
AiPort,
Camera as ProtectCamera,
ChannelQuality,
DeviceState,
ModelType,
StateType,
WSAction,
)
from uiprotect.exceptions import ClientError, NotAuthorized
from uiprotect.websocket import WebsocketState
from homeassistant.components.camera import (
CameraEntityFeature,
async_get_image,
async_get_stream_source,
)
from homeassistant.components.unifiprotect.const import CONF_DISABLE_RTSP, DOMAIN
from homeassistant.components.unifiprotect.utils import get_camera_base_name
from homeassistant.config_entries import SOURCE_REAUTH, ConfigEntryState
from homeassistant.const import ATTR_ENTITY_ID, STATE_UNAVAILABLE, Platform
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError
from homeassistant.helpers import (
device_registry as dr,
entity_registry as er,
issue_registry as ir,
)
from . import patch_ufp_method
from .utils import (
MockUFPFixture,
adopt_devices,
assert_entity_counts,
enable_entity,
init_entry,
make_public_camera,
public_device_ws_message,
public_rtsps_for,
remove_entities,
)
def _channel_entity_id(camera_obj: ProtectCamera, channel_id: int) -> str:
"""Return the entity_id for a camera channel."""
quality = camera_obj.channels[channel_id].rtsps_quality
assert quality is not None
base_name = get_camera_base_name(quality)
return f"camera.{camera_obj.name}_{base_name}".replace(" ", "_").lower()
def _assert_entity(
hass: HomeAssistant,
camera_obj: ProtectCamera,
channel_id: int,
*,
enabled: bool,
) -> str:
"""Assert a camera entity exists with the secure unique_id and no insecure twin."""
entity_id = _channel_entity_id(camera_obj, channel_id)
entity_registry = er.async_get(hass)
entity = entity_registry.async_get(entity_id)
assert entity
assert entity.disabled is not enabled
assert entity.unique_id == f"{camera_obj.mac}_{camera_obj.channels[channel_id].id}"
# The legacy insecure private-path entity must not exist anymore.
assert (
entity_registry.async_get(f"{entity_id}_insecure".replace(" ", "_").lower())
is None
)
return entity_id
async def test_basic_setup(
hass: HomeAssistant, ufp: MockUFPFixture, camera_all: ProtectCamera
) -> None:
"""One enabled high entity plus disabled medium/low, all secure."""
await init_entry(hass, ufp, [camera_all])
# high (enabled) + medium + low (disabled); no insecure entities
assert_entity_counts(hass, Platform.CAMERA, 3, 1)
high_id = _assert_entity(hass, camera_all, 0, enabled=True)
assert (
await async_get_stream_source(hass, high_id)
== camera_all.channels[0].rtsps_no_srtp_url
)
# medium starts disabled; once enabled it streams from the public API
medium_id = _assert_entity(hass, camera_all, 1, enabled=False)
await enable_entity(hass, ufp.entry.entry_id, medium_id)
assert (
await async_get_stream_source(hass, medium_id)
== camera_all.channels[1].rtsps_no_srtp_url
)
_assert_entity(hass, camera_all, 2, enabled=False)
async def test_doorbell_setup(
hass: HomeAssistant, ufp: MockUFPFixture, doorbell: ProtectCamera
) -> None:
"""Doorbell exposes its active qualities; the package channel is just one of them."""
await init_entry(hass, ufp, [doorbell])
# high (enabled) + package (active too, disabled by default); both stream
assert_entity_counts(hass, Platform.CAMERA, 2, 1)
high_id = _assert_entity(hass, doorbell, 0, enabled=True)
assert (
await async_get_stream_source(hass, high_id)
== doorbell.channels[0].rtsps_no_srtp_url
)
# the package channel is not special-cased: it streams like any quality tier
package_id = _assert_entity(hass, doorbell, 3, enabled=False)
await enable_entity(hass, ufp.entry.entry_id, package_id)
assert (
await async_get_stream_source(hass, package_id)
== doorbell.channels[3].rtsps_no_srtp_url
)
async def test_first_active_quality_is_default(
hass: HomeAssistant,
ufp: MockUFPFixture,
camera_all: ProtectCamera,
issue_registry: ir.IssueRegistry,
) -> None:
"""The first active quality is the default; inactive ones get no entity."""
camera_all.channels = [c.model_copy() for c in camera_all.channels]
camera_all.channels[0].is_rtsp_enabled = False # high inactive
camera_all.channels[1].is_rtsp_enabled = True # medium active
camera_all.channels[2].is_rtsp_enabled = False # low inactive
await init_entry(hass, ufp, [camera_all])
# only medium exists, enabled by default, with a working stream
assert_entity_counts(hass, Platform.CAMERA, 1, 1)
medium_id = _assert_entity(hass, camera_all, 1, enabled=True)
assert (
await async_get_stream_source(hass, medium_id)
== camera_all.channels[1].rtsps_no_srtp_url
)
entity_registry = er.async_get(hass) # pylint: disable=home-assistant-tests-registry-fixtures
assert entity_registry.async_get(_channel_entity_id(camera_all, 0)) is None
assert entity_registry.async_get(_channel_entity_id(camera_all, 2)) is None
assert (
issue_registry.async_get_issue(DOMAIN, f"rtsp_disabled_{camera_all.id}") is None
)
async def test_no_active_stream(
hass: HomeAssistant,
ufp: MockUFPFixture,
camera: ProtectCamera,
issue_registry: ir.IssueRegistry,
) -> None:
"""A camera with no active stream is exposed for snapshots and raises a repair."""
camera.channels = [c.model_copy() for c in camera.channels]
for channel in camera.channels:
channel.is_rtsp_enabled = False
await init_entry(hass, ufp, [camera])
high_id = _assert_entity(hass, camera, 0, enabled=True)
assert await async_get_stream_source(hass, high_id) is None
state = hass.states.get(high_id)
assert state
assert state.attributes["supported_features"] == CameraEntityFeature(0)
assert (
issue_registry.async_get_issue(DOMAIN, f"rtsp_disabled_{camera.id}") is not None
)
async def test_offline_camera_no_repair(
hass: HomeAssistant,
ufp: MockUFPFixture,
camera: ProtectCamera,
issue_registry: ir.IssueRegistry,
) -> None:
"""An offline camera with no stream gets no repair (offline, not disabled)."""
camera.state = StateType.DISCONNECTED
await init_entry(hass, ufp, [camera])
_assert_entity(hass, camera, 0, enabled=True)
assert issue_registry.async_get_issue(DOMAIN, f"rtsp_disabled_{camera.id}") is None
@pytest.mark.parametrize("ufp_options", [{CONF_DISABLE_RTSP: True}], indirect=True)
async def test_disable_rtsp(
hass: HomeAssistant, ufp: MockUFPFixture, camera_all: ProtectCamera
) -> None:
"""Disabling RTSP globally removes the stream source."""
await init_entry(hass, ufp, [camera_all])
high_id = _assert_entity(hass, camera_all, 0, enabled=True)
assert await async_get_stream_source(hass, high_id) is None
async def test_camera_image(
hass: HomeAssistant, ufp: MockUFPFixture, camera: ProtectCamera
) -> None:
"""Main snapshot is fetched from the public API."""
await init_entry(hass, ufp, [camera])
assert_entity_counts(hass, Platform.CAMERA, 1, 1)
ufp.api.get_public_api_camera_snapshot = AsyncMock()
await async_get_image(hass, _channel_entity_id(camera, 0))
ufp.api.get_public_api_camera_snapshot.assert_called_once()
assert ufp.api.get_public_api_camera_snapshot.call_args.kwargs["package"] is False
async def test_package_camera_image(
hass: HomeAssistant, ufp: MockUFPFixture, doorbell: ProtectCamera
) -> None:
"""Package snapshot is fetched from the public API with package=True."""
await init_entry(hass, ufp, [doorbell])
assert_entity_counts(hass, Platform.CAMERA, 2, 1)
package_id = _channel_entity_id(doorbell, 3)
await enable_entity(hass, ufp.entry.entry_id, package_id)
ufp.api.get_public_api_camera_snapshot = AsyncMock()
await async_get_image(hass, package_id)
ufp.api.get_public_api_camera_snapshot.assert_called_once()
assert ufp.api.get_public_api_camera_snapshot.call_args.kwargs["package"] is True
async def test_package_camera_without_stream(
hass: HomeAssistant, ufp: MockUFPFixture, doorbell: ProtectCamera
) -> None:
"""The package camera stays available for snapshots when its stream is off."""
doorbell.channels = [c.model_copy() for c in doorbell.channels]
doorbell.channels[3].is_rtsp_enabled = False # package stream off (the default)
await init_entry(hass, ufp, [doorbell])
# high (enabled, streaming) + package (disabled, snapshot-only) still present
assert_entity_counts(hass, Platform.CAMERA, 2, 1)
package_id = _assert_entity(hass, doorbell, 3, enabled=False)
await enable_entity(hass, ufp.entry.entry_id, package_id)
assert await async_get_stream_source(hass, package_id) is None
state = hass.states.get(package_id)
assert state
assert state.attributes["supported_features"] == CameraEntityFeature(0)
# snapshots still work, fetched with package=True
ufp.api.get_public_api_camera_snapshot = AsyncMock()
await async_get_image(hass, package_id)
assert ufp.api.get_public_api_camera_snapshot.call_args.kwargs["package"] is True
async def test_camera_not_in_public_bootstrap(
hass: HomeAssistant, ufp: MockUFPFixture, camera: ProtectCamera
) -> None:
"""A camera not yet mirrored into the public bootstrap is deferred."""
async def _prime_without_camera() -> Any:
pb = ufp.api.public_bootstrap
pb.cameras = {}
return pb
ufp.api.update_public = AsyncMock(side_effect=_prime_without_camera)
await init_entry(hass, ufp, [camera])
assert_entity_counts(hass, Platform.CAMERA, 0, 0)
# the public mirror arriving on the devices websocket creates the entity
public = make_public_camera(camera)
public.rtsps_streams = public_rtsps_for(camera)
ufp.api.public_bootstrap.cameras = {camera.id: public}
ufp.devices_ws_subscription(public_device_ws_message(public))
await hass.async_block_till_done()
assert_entity_counts(hass, Platform.CAMERA, 1, 1)
async def test_streams_unavailable(
hass: HomeAssistant,
ufp: MockUFPFixture,
camera_all: ProtectCamera,
issue_registry: ir.IssueRegistry,
caplog: pytest.LogCaptureFixture,
) -> None:
"""A camera whose RTSPS streams could not be read has no stream source.
An unreadable stream state is not "no streams": it must log a warning
instead of raising the enable-stream repair, which could offer to create a
stream that already exists on the console.
"""
async def _prime_streamless() -> Any:
pb = ufp.api.public_bootstrap
public = make_public_camera(camera_all)
public.rtsps_streams = None
pb.cameras = {camera_all.id: public}
return pb
ufp.api.update_public = AsyncMock(side_effect=_prime_streamless)
await init_entry(hass, ufp, [camera_all])
high_id = _channel_entity_id(camera_all, 0)
assert await async_get_stream_source(hass, high_id) is None
assert (
issue_registry.async_get_issue(DOMAIN, f"rtsp_disabled_{camera_all.id}") is None
)
assert "Could not read RTSPS streams" in caplog.text
async def test_public_bootstrap_failure_not_ready(
hass: HomeAssistant, ufp: MockUFPFixture, camera: ProtectCamera
) -> None:
"""A failed public bootstrap prime leaves the entry in setup-retry.
The websockets/poll subscriptions opened during setup must be torn down so
a retry does not leak another set.
"""
ufp.api.update_public = AsyncMock(side_effect=ClientError("boom"))
await init_entry(hass, ufp, [camera])
assert ufp.entry.state is ConfigEntryState.SETUP_RETRY
ufp.api.async_disconnect_ws.assert_called()
async def test_public_bootstrap_revoked_key_reauth(
hass: HomeAssistant, ufp: MockUFPFixture, camera: ProtectCamera
) -> None:
"""A revoked API key (public 401) triggers reauth, not an endless retry."""
ufp.api.update_public = AsyncMock(side_effect=NotAuthorized("revoked"))
await init_entry(hass, ufp, [camera])
assert ufp.entry.state is ConfigEntryState.SETUP_ERROR
ufp.api.async_disconnect_ws.assert_called()
assert any(ufp.entry.async_get_active_flows(hass, {SOURCE_REAUTH}))
async def test_adopt(
hass: HomeAssistant, ufp: MockUFPFixture, camera_all: ProtectCamera
) -> None:
"""A camera adopted at runtime loads its public streams before entities."""
await init_entry(hass, ufp, [camera_all])
assert_entity_counts(hass, Platform.CAMERA, 3, 1)
await remove_entities(hass, ufp, [camera_all])
assert_entity_counts(hass, Platform.CAMERA, 0, 0)
await adopt_devices(hass, ufp, [camera_all])
assert_entity_counts(hass, Platform.CAMERA, 3, 1)
high_id = _assert_entity(hass, camera_all, 0, enabled=True)
assert (
await async_get_stream_source(hass, high_id)
== camera_all.channels[0].rtsps_no_srtp_url
)
@pytest.mark.parametrize(
("service", "expected_value"),
[
("enable_motion_detection", True),
("disable_motion_detection", False),
],
)
async def test_camera_motion_detection(
hass: HomeAssistant,
ufp: MockUFPFixture,
camera: ProtectCamera,
service: str,
expected_value: bool,
) -> None:
"""Test enabling/disabling motion detection on a camera."""
await init_entry(hass, ufp, [camera])
assert_entity_counts(hass, Platform.CAMERA, 1, 1)
entity_id = _channel_entity_id(camera, 0)
with patch_ufp_method(
camera, "set_motion_detection", new_callable=AsyncMock
) as mock_method:
await hass.services.async_call(
"camera",
service,
{ATTR_ENTITY_ID: entity_id},
blocking=True,
)
mock_method.assert_called_once_with(expected_value)
async def test_aiport_no_camera_entities(
hass: HomeAssistant, ufp: MockUFPFixture, aiport: AiPort
) -> None:
"""AI Port devices do not create camera entities."""
await init_entry(hass, ufp, [aiport])
assert_entity_counts(hass, Platform.CAMERA, 0, 0)
async def test_public_only_camera(
hass: HomeAssistant, ufp: MockUFPFixture, camera: ProtectCamera
) -> None:
"""A public-only camera builds a working entity with degraded diagnostics."""
# This camera is intentionally kept out of the private bootstrap; wire the
# channel api so its public RTSPS URLs resolve, as add_device would.
for channel in camera.channels:
channel._api = ufp.api
public = make_public_camera(camera)
public.rtsps_streams = public_rtsps_for(camera)
async def _prime_public_only() -> Any:
pb = ufp.api.public_bootstrap
pb.cameras = {camera.id: public}
return pb
ufp.api.update_public = AsyncMock(side_effect=_prime_public_only)
ufp.api.is_public_only = True
# No private cameras in the bootstrap: the public object is the only source.
await init_entry(hass, ufp, [])
assert_entity_counts(hass, Platform.CAMERA, 1, 1)
entity_id = _channel_entity_id(camera, 0)
state = hass.states.get(entity_id)
assert state
assert state.state != STATE_UNAVAILABLE
# diagnostics have no public equivalent and degrade to None
assert state.attributes["fps"] is None
# device identity degrades to name-only; the NVR link is omitted (resolving
# the NVR identity publicly is wired with the config-mode setup)
device_registry = dr.async_get(hass) # pylint: disable=home-assistant-tests-registry-fixtures
device = device_registry.async_get_device(
connections={(dr.CONNECTION_NETWORK_MAC, public.mac)}
)
assert device is not None
assert device.via_device_id is None
assert device.name == camera.display_name
assert device.model == camera.type
assert (
await async_get_stream_source(hass, entity_id)
== camera.channels[0].rtsps_no_srtp_url
)
ufp.api.get_public_api_camera_snapshot = AsyncMock()
await async_get_image(hass, entity_id)
ufp.api.get_public_api_camera_snapshot.assert_called_once()
# a frame without a merged object re-reads the public bootstrap and stays up
none_msg = Mock()
none_msg.changed_data = {}
none_msg.new_obj = None
none_msg.old_obj = public
ufp.devices_ws_subscription(none_msg)
await hass.async_block_till_done()
assert hass.states.get(entity_id).state != STATE_UNAVAILABLE
# a public devices websocket update drives availability
public.state = DeviceState.DISCONNECTED
ufp.devices_ws_subscription(public_device_ws_message(public))
await hass.async_block_till_done()
assert hass.states.get(entity_id).state == STATE_UNAVAILABLE
async def test_adopt_before_public_bootstrap(
hass: HomeAssistant, ufp: MockUFPFixture, camera: ProtectCamera
) -> None:
"""A camera adopted before the public bootstrap mirrors it is deferred."""
async def _prime_empty() -> Any:
pb = ufp.api.public_bootstrap
pb.cameras = {}
return pb
ufp.api.update_public = AsyncMock(side_effect=_prime_empty)
await init_entry(hass, ufp, [])
assert_entity_counts(hass, Platform.CAMERA, 0, 0)
# adopt the camera while it is still absent from the public bootstrap
camera._api = ufp.api
await adopt_devices(hass, ufp, [camera], fully_adopt=True)
assert_entity_counts(hass, Platform.CAMERA, 0, 0)
# the public mirror arriving on the devices websocket creates the entity
for channel in camera.channels:
channel._api = ufp.api
public = make_public_camera(camera)
public.rtsps_streams = public_rtsps_for(camera)
ufp.api.public_bootstrap.cameras = {camera.id: public}
ufp.devices_ws_subscription(public_device_ws_message(public))
await hass.async_block_till_done()
assert_entity_counts(hass, Platform.CAMERA, 1, 1)
async def test_public_only_camera_removed(
hass: HomeAssistant, ufp: MockUFPFixture, camera: ProtectCamera
) -> None:
"""A public-only camera removed from the public bootstrap goes unavailable."""
for channel in camera.channels:
channel._api = ufp.api
public = make_public_camera(camera)
public.rtsps_streams = public_rtsps_for(camera)
async def _prime_public_only() -> Any:
pb = ufp.api.public_bootstrap
pb.cameras = {camera.id: public}
return pb
ufp.api.update_public = AsyncMock(side_effect=_prime_public_only)
ufp.api.is_public_only = True
await init_entry(hass, ufp, [])
entity_id = _channel_entity_id(camera, 0)
assert hass.states.get(entity_id).state != STATE_UNAVAILABLE
# on a delete the library has already dropped the object; the re-read
# comes up empty and the entity goes unavailable
ufp.api.public_bootstrap.cameras = {}
delete_msg = Mock()
delete_msg.changed_data = {}
delete_msg.new_obj = None
delete_msg.old_obj = public
ufp.devices_ws_subscription(delete_msg)
await hass.async_block_till_done()
assert hass.states.get(entity_id).state == STATE_UNAVAILABLE
# the camera reappearing on the websocket recovers it
ufp.api.public_bootstrap.cameras = {camera.id: public}
ufp.devices_ws_subscription(public_device_ws_message(public))
await hass.async_block_till_done()
assert hass.states.get(entity_id).state != STATE_UNAVAILABLE
async def test_public_only_camera_ws_state_availability(
hass: HomeAssistant, ufp: MockUFPFixture, camera: ProtectCamera
) -> None:
"""Public devices websocket state drives a public-only camera without private reads."""
for channel in camera.channels:
channel._api = ufp.api
public = make_public_camera(camera)
public.rtsps_streams = public_rtsps_for(camera)
async def _prime_public_only() -> Any:
pb = ufp.api.public_bootstrap
pb.cameras = {camera.id: public}
return pb
ufp.api.update_public = AsyncMock(side_effect=_prime_public_only)
ufp.api.is_public_only = True
await init_entry(hass, ufp, [])
entity_id = _channel_entity_id(camera, 0)
assert hass.states.get(entity_id).state != STATE_UNAVAILABLE
# tripwire: from here on nothing may read the private bootstrap
ufp.api.bootstrap = None
# a public NVR frame has no private NVR to signal and is ignored
nvr_msg = Mock()
nvr_msg.changed_data = {}
nvr_msg.old_obj = None
nvr_msg.new_obj = Mock(model=ModelType.NVR)
ufp.devices_ws_subscription(nvr_msg)
await hass.async_block_till_done()
assert hass.states.get(entity_id).state != STATE_UNAVAILABLE
# a websocket drop marks the camera unavailable, a reconnect recovers it
ufp.devices_ws_state_subscription(WebsocketState.DISCONNECTED)
await hass.async_block_till_done()
assert hass.states.get(entity_id).state == STATE_UNAVAILABLE
ufp.devices_ws_state_subscription(WebsocketState.CONNECTED)
await hass.async_block_till_done()
assert hass.states.get(entity_id).state != STATE_UNAVAILABLE
async def test_camera_motion_detection_uses_replaced_device(
hass: HomeAssistant, ufp: MockUFPFixture, camera: ProtectCamera
) -> None:
"""Motion commands act on the refreshed device after a bootstrap replacement."""
await init_entry(hass, ufp, [camera])
entity_id = _channel_entity_id(camera, 0)
new_camera = camera.model_copy()
ufp.api.bootstrap.cameras = {new_camera.id: new_camera}
mock_msg = Mock()
mock_msg.changed_data = {}
mock_msg.new_obj = new_camera
ufp.ws_msg(mock_msg)
await hass.async_block_till_done()
with patch_ufp_method(
new_camera, "set_motion_detection", new_callable=AsyncMock
) as mock_method:
await hass.services.async_call(
"camera",
"enable_motion_detection",
{ATTR_ENTITY_ID: entity_id},
blocking=True,
)
mock_method.assert_called_once_with(True)
@pytest.mark.parametrize(
"service", ["enable_motion_detection", "disable_motion_detection"]
)
async def test_public_only_camera_motion_detection_raises(
hass: HomeAssistant, ufp: MockUFPFixture, camera: ProtectCamera, service: str
) -> None:
"""Motion detection cannot be changed without a private session."""
for channel in camera.channels:
channel._api = ufp.api
public = make_public_camera(camera)
public.rtsps_streams = public_rtsps_for(camera)
async def _prime_public_only() -> Any:
pb = ufp.api.public_bootstrap
pb.cameras = {camera.id: public}
return pb
ufp.api.update_public = AsyncMock(side_effect=_prime_public_only)
ufp.api.is_public_only = True
await init_entry(hass, ufp, [])
entity_id = _channel_entity_id(camera, 0)
with pytest.raises(HomeAssistantError, match="public API"):
await hass.services.async_call(
"camera",
service,
{ATTR_ENTITY_ID: entity_id},
blocking=True,
)
async def test_hybrid_public_camera_without_private_deferred(
hass: HomeAssistant, ufp: MockUFPFixture, camera: ProtectCamera
) -> None:
"""Hybrid: a public camera without its private twin is left to the adopt flow."""
public = make_public_camera(camera)
async def _prime_public_only() -> Any:
pb = ufp.api.public_bootstrap
pb.cameras = {camera.id: public}
return pb
ufp.api.update_public = AsyncMock(side_effect=_prime_public_only)
# Not public-only mode (conftest default): the entity must not be built
# private-less; the later adopt dispatch creates it with its private fill.
await init_entry(hass, ufp, [])
assert_entity_counts(hass, Platform.CAMERA, 0, 0)
async def test_snapshot_low_quality_without_stream(
hass: HomeAssistant, ufp: MockUFPFixture, camera: ProtectCamera
) -> None:
"""Without a live stream, snapshots are requested at low quality."""
camera.channels = [c.model_copy() for c in camera.channels]
for channel in camera.channels:
channel.is_rtsp_enabled = False
await init_entry(hass, ufp, [camera])
ufp.api.get_public_api_camera_snapshot = AsyncMock()
await async_get_image(hass, _channel_entity_id(camera, 0))
ufp.api.get_public_api_camera_snapshot.assert_called_once()
assert (
ufp.api.get_public_api_camera_snapshot.call_args.kwargs["high_quality"] is False
)
async def test_private_enumeration_upgrade_keeps_entities(
hass: HomeAssistant,
entity_registry: er.EntityRegistry,
ufp: MockUFPFixture,
camera_all: ProtectCamera,
) -> None:
"""Old private-enumeration registry entries survive the public enumeration.
Same unique_ids, entity_ids, and enabled split — including across a reload.
"""
seeded: dict[str, str] = {}
for channel_id, disabled_by in (
(0, None),
(1, er.RegistryEntryDisabler.INTEGRATION),
(2, er.RegistryEntryDisabler.INTEGRATION),
):
entry = entity_registry.async_get_or_create(
Platform.CAMERA,
DOMAIN,
f"{camera_all.mac}_{channel_id}",
config_entry=ufp.entry,
suggested_object_id=f"my_renamed_cam_{channel_id}",
disabled_by=disabled_by,
)
seeded[entry.unique_id] = entry.entity_id
await init_entry(hass, ufp, [camera_all], regenerate_ids=False)
# Same totals as a fresh setup: nothing duplicated, nothing orphaned.
assert_entity_counts(hass, Platform.CAMERA, 3, 1)
for unique_id, entity_id in seeded.items():
entry = entity_registry.async_get(entity_id)
assert entry is not None
assert entry.unique_id == unique_id
# The customized (enabled) entity is live and streams from the public API.
high_id = seeded[f"{camera_all.mac}_0"]
assert hass.states.get(high_id) is not None
assert (
await async_get_stream_source(hass, high_id)
== camera_all.channels[0].rtsps_no_srtp_url
)
await hass.config_entries.async_reload(ufp.entry.entry_id)
await hass.async_block_till_done()
assert_entity_counts(hass, Platform.CAMERA, 3, 1)
for unique_id, entity_id in seeded.items():
entry = entity_registry.async_get(entity_id)
assert entry is not None
assert entry.unique_id == unique_id
assert hass.states.get(high_id) is not None
async def test_streamless_camera_reenumerated_on_rtsps_prime(
hass: HomeAssistant,
entity_registry: er.EntityRegistry,
ufp: MockUFPFixture,
camera_all: ProtectCamera,
caplog: pytest.LogCaptureFixture,
) -> None:
"""A camera primed after enumeration gains its active-quality entities.
A disconnected camera enumerates streamless (only the snapshot fallback).
When it comes online the library primes its RTSPS streams in the background
and announces the change with an ``rtsps_streams`` devices-WS frame; the
integration must re-enumerate so the now-active tiers get their entities,
without re-adding the live fallback entity, and the existing entity must
pick up its now-available stream URL.
"""
camera_all.state = StateType.DISCONNECTED
await init_entry(hass, ufp, [camera_all])
# Streamless: only the snapshot fallback (high) exists, without a stream.
assert_entity_counts(hass, Platform.CAMERA, 1, 1)
high_id = _channel_entity_id(camera_all, 0)
assert await async_get_stream_source(hass, high_id) is None
assert entity_registry.async_get(_channel_entity_id(camera_all, 1)) is None
assert entity_registry.async_get(_channel_entity_id(camera_all, 2)) is None
# The camera comes online and the library primes its streams, announced by
# an rtsps_streams change on the public devices websocket (sent twice: the
# re-enumeration must not attempt to re-add live entities).
camera_all.state = StateType.CONNECTED
public = ufp.api.public_bootstrap.cameras[camera_all.id]
public.state = DeviceState.CONNECTED
public.rtsps_streams = public_rtsps_for(camera_all)
msg = public_device_ws_message(public)
msg.changed_data = {"rtsps_streams": public.rtsps_streams}
ufp.devices_ws_subscription(msg)
await hass.async_block_till_done()
ufp.devices_ws_subscription(msg)
await hass.async_block_till_done()
# The active medium/low tiers now have entities, the existing high entity
# streams, and no duplicate-add errors were logged.
assert_entity_counts(hass, Platform.CAMERA, 3, 1)
_assert_entity(hass, camera_all, 0, enabled=True)
_assert_entity(hass, camera_all, 1, enabled=False)
_assert_entity(hass, camera_all, 2, enabled=False)
assert (
await async_get_stream_source(hass, high_id)
== camera_all.channels[0].rtsps_no_srtp_url
)
assert "does not generate unique IDs" not in caplog.text
async def test_public_only_camera_added_after_setup(
hass: HomeAssistant, ufp: MockUFPFixture, camera: ProtectCamera
) -> None:
"""In public-only mode a camera added later is discovered from its frame.
There is no private adopt path without a local user, so the public devices
websocket ``add`` frame is the only discovery signal.
"""
async def _prime_public_only() -> Any:
pb = ufp.api.public_bootstrap
pb.cameras = {}
return pb
ufp.api.update_public = AsyncMock(side_effect=_prime_public_only)
ufp.api.is_public_only = True
await init_entry(hass, ufp, [])
assert_entity_counts(hass, Platform.CAMERA, 0, 0)
# A new camera appears on the public devices websocket.
for channel in camera.channels:
channel._api = ufp.api
public = make_public_camera(camera)
public.rtsps_streams = public_rtsps_for(camera)
ufp.api.public_bootstrap.cameras = {camera.id: public}
msg = public_device_ws_message(public)
msg.action = WSAction.ADD
ufp.devices_ws_subscription(msg)
await hass.async_block_till_done()
assert_entity_counts(hass, Platform.CAMERA, 1, 1)
state = hass.states.get(_channel_entity_id(camera, 0))
assert state
assert state.state != STATE_UNAVAILABLE
async def test_public_only_streamless_camera_gets_repair(
hass: HomeAssistant,
ufp: MockUFPFixture,
camera: ProtectCamera,
issue_registry: ir.IssueRegistry,
) -> None:
"""A streamless public-only camera raises the RTSP repair.
The fix flow verifies and creates the stream entirely through the public
API, so it works without a private session.
"""
for channel in camera.channels:
channel._api = ufp.api
public = make_public_camera(camera)
public.rtsps_streams = RTSPSStreams()
async def _prime_public_only() -> Any:
pb = ufp.api.public_bootstrap
pb.cameras = {camera.id: public}
return pb
ufp.api.update_public = AsyncMock(side_effect=_prime_public_only)
ufp.api.is_public_only = True
await init_entry(hass, ufp, [])
assert_entity_counts(hass, Platform.CAMERA, 1, 1)
assert (
issue_registry.async_get_issue(DOMAIN, f"rtsp_disabled_{camera.id}") is not None
)
async def test_stream_capability_published_on_prime(
hass: HomeAssistant, ufp: MockUFPFixture, camera_all: ProtectCamera
) -> None:
"""Gaining a stream publishes the STREAM capability when nothing else changes."""
camera_all.channels = [c.model_copy() for c in camera_all.channels]
for channel in camera_all.channels:
channel.is_rtsp_enabled = False
await init_entry(hass, ufp, [camera_all])
high_id = _channel_entity_id(camera_all, 0)
state = hass.states.get(high_id)
assert state
assert state.attributes["supported_features"] == CameraEntityFeature(0)
# The library primes the streams; availability, recording, and motion are
# unchanged, so the capability flip is the only observable difference.
camera_all.channels[0].is_rtsp_enabled = True
public = ufp.api.public_bootstrap.cameras[camera_all.id]
public.rtsps_streams = public_rtsps_for(camera_all)
msg = public_device_ws_message(public)
msg.changed_data = {"rtsps_streams": public.rtsps_streams}
ufp.devices_ws_subscription(msg)
await hass.async_block_till_done()
state = hass.states.get(high_id)
assert state
assert state.attributes["supported_features"] == CameraEntityFeature.STREAM
async def test_camera_without_main_tiers_skipped_with_warning(
hass: HomeAssistant,
ufp: MockUFPFixture,
camera: ProtectCamera,
caplog: pytest.LogCaptureFixture,
) -> None:
"""A camera violating the main-tier contract is skipped loudly, not fatally."""
for channel in camera.channels:
channel._api = ufp.api
healthy = make_public_camera(camera)
healthy.rtsps_streams = public_rtsps_for(camera)
broken = make_public_camera(camera)
broken.id = "broken-camera"
broken.mac = "FFEEDDCCBBAA"
broken.display_name = "Broken"
broken.rtsps_streams = None
broken.hardware_stream_qualities.return_value = [ChannelQuality.PACKAGE]
async def _prime_public_only() -> Any:
pb = ufp.api.public_bootstrap
pb.cameras = {camera.id: healthy, broken.id: broken}
return pb
ufp.api.update_public = AsyncMock(side_effect=_prime_public_only)
ufp.api.is_public_only = True
await init_entry(hass, ufp, [])
# The healthy camera enumerates; the broken one is skipped with a warning
# instead of aborting the platform setup.
assert "reports no main stream tiers" in caplog.text
assert_entity_counts(hass, Platform.CAMERA, 1, 1)
assert hass.states.get(_channel_entity_id(camera, 0)) is not None
async def test_public_only_camera_deleted_during_gap(
hass: HomeAssistant, ufp: MockUFPFixture, camera: ProtectCamera
) -> None:
"""A camera deleted while the websocket was down reads as unavailable.
The library resyncs its public bootstrap on reconnect but applies the
snapshot silently; the integration must re-read behind a fresh snapshot
rather than resurrect the entity from the pre-disconnect cache.
"""
for channel in camera.channels:
channel._api = ufp.api
public = make_public_camera(camera)
public.rtsps_streams = public_rtsps_for(camera)
async def _prime_public_only() -> Any:
pb = ufp.api.public_bootstrap
pb.cameras = {camera.id: public}
return pb
ufp.api.update_public = AsyncMock(side_effect=_prime_public_only)
ufp.api.is_public_only = True
await init_entry(hass, ufp, [])
entity_id = _channel_entity_id(camera, 0)
assert hass.states.get(entity_id).state != STATE_UNAVAILABLE
# The websocket drops; the camera is deleted during the gap, so the
# reconnect resync returns a snapshot without it.
async def _prime_empty() -> Any:
pb = ufp.api.public_bootstrap
pb.cameras = {}
return pb
ufp.api.update_public = AsyncMock(side_effect=_prime_empty)
ufp.devices_ws_state_subscription(WebsocketState.DISCONNECTED)
await hass.async_block_till_done()
assert hass.states.get(entity_id).state == STATE_UNAVAILABLE
ufp.devices_ws_state_subscription(WebsocketState.CONNECTED)
await hass.async_block_till_done()
# Not resurrected from the stale cache: the fresh snapshot has no camera.
assert hass.states.get(entity_id).state == STATE_UNAVAILABLE
@pytest.mark.parametrize(
("error", "expect_reauth"),
[
pytest.param(NotAuthorized("revoked"), True, id="revoked_key"),
pytest.param(ServerDisconnectedError(), False, id="transport_error"),
],
)
async def test_reconnect_refresh_failures(
hass: HomeAssistant,
ufp: MockUFPFixture,
camera: ProtectCamera,
error: Exception,
expect_reauth: bool,
) -> None:
"""A failed reconnect refresh starts reauth on 401 and retries on transport."""
for channel in camera.channels:
channel._api = ufp.api
public = make_public_camera(camera)
public.rtsps_streams = public_rtsps_for(camera)
async def _prime_public_only() -> Any:
pb = ufp.api.public_bootstrap
pb.cameras = {camera.id: public}
return pb
ufp.api.update_public = AsyncMock(side_effect=_prime_public_only)
ufp.api.is_public_only = True
await init_entry(hass, ufp, [])
ufp.api.update_public = AsyncMock(side_effect=error)
ufp.devices_ws_state_subscription(WebsocketState.DISCONNECTED)
await hass.async_block_till_done()
with patch.object(ufp.entry, "async_start_reauth") as mock_reauth:
ufp.devices_ws_state_subscription(WebsocketState.CONNECTED)
await hass.async_block_till_done()
assert mock_reauth.called is expect_reauth
async def test_hybrid_camera_lost_public_mirror_logs(
hass: HomeAssistant,
ufp: MockUFPFixture,
camera: ProtectCamera,
caplog: pytest.LogCaptureFixture,
) -> None:
"""A vanished public mirror is observable instead of a silent no-op."""
await init_entry(hass, ufp, [camera])
ufp.api.public_bootstrap.cameras = {}
mock_msg = Mock()
mock_msg.changed_data = {}
mock_msg.new_obj = camera
ufp.ws_msg(mock_msg)
await hass.async_block_till_done()
assert "has no public mirror" in caplog.text
async def test_public_only_camera_added_during_gap(
hass: HomeAssistant, ufp: MockUFPFixture, camera_all: ProtectCamera
) -> None:
"""A camera added while the websocket was down enumerates on reconnect.
The resync snapshot is applied silently and no add frame ever arrives for
a camera that appeared during the gap, so the reconnect refresh must
dispatch it for enumeration itself.
"""
for channel in camera_all.channels:
channel._api = ufp.api
first = make_public_camera(camera_all)
first.rtsps_streams = public_rtsps_for(camera_all)
async def _prime_one() -> Any:
pb = ufp.api.public_bootstrap
pb.cameras = {camera_all.id: first}
return pb
ufp.api.update_public = AsyncMock(side_effect=_prime_one)
ufp.api.is_public_only = True
await init_entry(hass, ufp, [])
assert_entity_counts(hass, Platform.CAMERA, 3, 1)
# A second camera appears during the gap; the reconnect resync includes it.
second = make_public_camera(camera_all)
second.id = "gap-camera"
second.mac = "FFEEDDCCBB01"
second.name = "Gap Camera"
second.display_name = "Gap Camera"
second.rtsps_streams = first.rtsps_streams
async def _prime_two() -> Any:
pb = ufp.api.public_bootstrap
pb.cameras = {camera_all.id: first, second.id: second}
return pb
ufp.api.update_public = AsyncMock(side_effect=_prime_two)
ufp.devices_ws_state_subscription(WebsocketState.DISCONNECTED)
await hass.async_block_till_done()
ufp.devices_ws_state_subscription(WebsocketState.CONNECTED)
await hass.async_block_till_done()
# Three tiers each for both cameras; no duplicates for the first one.
assert_entity_counts(hass, Platform.CAMERA, 6, 2)
assert hass.states.get("camera.gap_camera_high_resolution_channel") is not None
async def test_unadopted_camera_not_enumerated_from_public_frame(
hass: HomeAssistant, ufp: MockUFPFixture, camera: ProtectCamera
) -> None:
"""A public frame cannot create entities for an unadopted camera."""
camera.is_adopted = False
await init_entry(hass, ufp, [camera])
assert_entity_counts(hass, Platform.CAMERA, 0, 0)
public = ufp.api.public_bootstrap.cameras[camera.id]
msg = public_device_ws_message(public)
msg.changed_data = {"rtsps_streams": public.rtsps_streams}
ufp.devices_ws_subscription(msg)
await hass.async_block_till_done()
# still excluded, exactly like the startup enumeration
assert_entity_counts(hass, Platform.CAMERA, 0, 0)