Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: treat no access to keyrings/users as empty #323

Merged
merged 6 commits into from
Dec 11, 2024
Merged

fix: treat no access to keyrings/users as empty #323

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
dccce99
fix: treat no access to keyrings/users as empty
bdraco Dec 11, 2024
d0d4adc
fix: rushed logic
bdraco Dec 11, 2024
6351bda
chore: coverage and cleanups
bdraco Dec 11, 2024
6e3f028
chore: preen
bdraco Dec 11, 2024
a316e11
fix: should be a 403
bdraco Dec 11, 2024
6efe305
fix: use internal exception
bdraco Dec 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions src/uiprotect/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -829,21 +829,21 @@ async def update(self) -> Bootstrap:
async with self._update_lock:
bootstrap = await self.get_bootstrap()
if bootstrap.nvr.version >= NFC_FINGERPRINT_SUPPORT_VERSION:
try:
keyrings = await self.api_request_list("keyrings")
except NotAuthorized as err:
_LOGGER.debug("No access to keyrings %s, skipping", err)
keyrings = []
try:
ulp_users = await self.api_request_list("ulp-users")
except NotAuthorized as err:
_LOGGER.debug("No access to ulp-users %s, skipping", err)
ulp_users = []
bootstrap.keyrings = Keyrings.from_list(
cast(
list[Keyring],
list_from_unifi_list(
self, await self.api_request_list("keyrings")
),
)
cast(list[Keyring], list_from_unifi_list(self, keyrings))
)
bootstrap.ulp_users = UlpUsers.from_list(
cast(
list[UlpUser],
list_from_unifi_list(
self, await self.api_request_list("ulp-users")
),
)
cast(list[UlpUser], list_from_unifi_list(self, ulp_users))
)
self.__dict__.pop("bootstrap", None)
self._bootstrap = bootstrap
Expand Down
3 changes: 3 additions & 0 deletions src/uiprotect/data/user.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,9 @@ class UlpUserKeyringBase(Generic[T]):
def __init__(self) -> None:
self._id_to_item: dict[str, T] = {}

def __len__(self) -> int:
return len(self._id_to_item)

@classmethod
def from_list(cls, items: list[T]) -> Self:
instance = cls()
Expand Down
152 changes: 106 additions & 46 deletions tests/test_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
create_from_unifi_dict,
)
from uiprotect.data.types import Version, VideoMode
from uiprotect.exceptions import BadRequest, NvrError
from uiprotect.exceptions import BadRequest, NotAuthorized, NvrError
from uiprotect.utils import to_js_time

from .common import assert_equal_dump
Expand Down Expand Up @@ -327,55 +327,115 @@ async def test_force_update_with_nfc_fingerprint_version(
assert protect_client.bootstrap
original_bootstrap = protect_client.bootstrap
protect_client._bootstrap = None
with patch(
"uiprotect.api.ProtectApiClient.get_bootstrap",
AsyncMock(
with (
patch(
"uiprotect.api.ProtectApiClient.get_bootstrap",
return_value=AsyncMock(
nvr=AsyncMock(version=NFC_FINGERPRINT_SUPPORT_VERSION)
)
),
) as get_bootstrap_mock:
with patch(
),
) as get_bootstrap_mock,
patch(
"uiprotect.api.ProtectApiClient.api_request_list",
side_effect=lambda endpoint: {
"keyrings": [
{
"deviceType": "camera",
"deviceId": "new_device_id_1",
"registryType": "fingerprint",
"registryId": "new_registry_id_1",
"lastActivity": 1733432893331,
"metadata": {},
"ulpUser": "new_ulp_user_id_1",
"id": "new_keyring_id_1",
"modelKey": "keyring",
}
],
"ulp-users": [
{
"ulpId": "new_ulp_id_1",
"firstName": "localadmin",
"lastName": "",
"fullName": "localadmin",
"avatar": "",
"status": "ACTIVE",
"id": "new_ulp_user_id_1",
"modelKey": "ulpUser",
}
],
}.get(endpoint, []),
) as api_request_list_mock,
):
await protect_client.update()
assert get_bootstrap_mock.called
assert api_request_list_mock.called
api_request_list_mock.assert_any_call("keyrings")
api_request_list_mock.assert_any_call("ulp-users")
assert api_request_list_mock.call_count == 2

assert protect_client.bootstrap
assert original_bootstrap != protect_client.bootstrap
assert len(protect_client.bootstrap.keyrings)
assert len(protect_client.bootstrap.ulp_users)


@pytest.mark.asyncio()
async def test_force_update_no_user_keyring_access(protect_client: ProtectApiClient):
protect_client._bootstrap = None

await protect_client.update()

assert protect_client.bootstrap
original_bootstrap = protect_client.bootstrap
protect_client._bootstrap = None
with (
patch(
"uiprotect.api.ProtectApiClient.get_bootstrap",
return_value=AsyncMock(
nvr=AsyncMock(version=NFC_FINGERPRINT_SUPPORT_VERSION)
),
) as get_bootstrap_mock,
patch(
"uiprotect.api.ProtectApiClient.api_request_list",
AsyncMock(
side_effect=lambda endpoint: {
"keyrings": [
{
"deviceType": "camera",
"deviceId": "new_device_id_1",
"registryType": "fingerprint",
"registryId": "new_registry_id_1",
"lastActivity": 1733432893331,
"metadata": {},
"ulpUser": "new_ulp_user_id_1",
"id": "new_keyring_id_1",
"modelKey": "keyring",
}
],
"ulp-users": [
{
"ulpId": "new_ulp_id_1",
"firstName": "localadmin",
"lastName": "",
"fullName": "localadmin",
"avatar": "",
"status": "ACTIVE",
"id": "new_ulp_user_id_1",
"modelKey": "ulpUser",
}
],
}.get(endpoint, [])
side_effect=NotAuthorized,
) as api_request_list_mock,
):
await protect_client.update()
assert get_bootstrap_mock.called
assert api_request_list_mock.called
api_request_list_mock.assert_any_call("keyrings")
api_request_list_mock.assert_any_call("ulp-users")
assert api_request_list_mock.call_count == 2

assert protect_client.bootstrap
assert original_bootstrap != protect_client.bootstrap
assert not len(protect_client.bootstrap.keyrings)
assert not len(protect_client.bootstrap.ulp_users)


@pytest.mark.asyncio()
async def test_force_update_user_keyring_internal_error(
protect_client: ProtectApiClient,
):
protect_client._bootstrap = None

await protect_client.update()

assert protect_client.bootstrap
protect_client._bootstrap = None
with (
pytest.raises(BadRequest),
patch(
"uiprotect.api.ProtectApiClient.get_bootstrap",
return_value=AsyncMock(
nvr=AsyncMock(version=NFC_FINGERPRINT_SUPPORT_VERSION)
),
) as api_request_list_mock:
await protect_client.update()
assert get_bootstrap_mock.called
assert api_request_list_mock.called
api_request_list_mock.assert_any_call("keyrings")
api_request_list_mock.assert_any_call("ulp-users")
assert api_request_list_mock.call_count == 2

assert protect_client.bootstrap
assert original_bootstrap != protect_client.bootstrap
),
patch(
"uiprotect.api.ProtectApiClient.api_request_list",
side_effect=BadRequest,
),
):
await protect_client.update()


@pytest.mark.asyncio()
Expand Down
Loading