1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
|
"""Test configuration for the Ring platform."""
from __future__ import annotations
import datetime
import json
import re
from pathlib import Path
from time import time
from typing import TYPE_CHECKING
from unittest.mock import patch
import pytest
from aioresponses import CallbackResult, aioresponses
from ring_doorbell import Auth, Ring
from ring_doorbell.const import USER_AGENT
if TYPE_CHECKING:
from collections.abc import Generator
# The kwargs below are useful for request assertions
def json_request_kwargs():
return {
"headers": {
"User-Agent": "android:com.ringapp",
"hardware_id": "21ac3af1-0eac-5fbd-8b0f-0b784889bfbd",
"Content-Type": "application/json",
"Authorization": "Bearer dummyBearerToken",
},
"timeout": 10,
"data": None,
"params": {},
"json": {},
}
def nojson_request_kwargs():
return {
"headers": {
"User-Agent": "android:com.ringapp",
"hardware_id": "21ac3af1-0eac-5fbd-8b0f-0b784889bfbd",
"Authorization": "Bearer dummyBearerToken",
},
"timeout": 10,
"data": None,
"params": {},
}
def pytest_configure(config):
config.addinivalue_line(
"markers", "nolistenmock: mark test to not want the autouse listenmock"
)
@pytest.fixture
async def auth():
"""Return auth object."""
auth = Auth(USER_AGENT)
await auth.async_fetch_token("foo", "bar")
yield auth
await auth.async_close()
@pytest.fixture
async def ring(auth):
"""Return updated ring object."""
ring = Ring(auth)
await ring.async_update_data()
return ring
def _set_dings_to_now(active_dings) -> None:
for ding in active_dings:
ding["now"] = time()
return active_dings
def load_fixture(filename):
"""Load a fixture."""
path = Path(Path(__file__).parent / "fixtures" / filename)
with path.open() as fdp:
return fdp.read()
def load_fixture_as_dict(filename):
"""Load a fixture."""
return json.loads(load_fixture(filename))
def load_alert_v1(
alert_type: str, device_id, *, ding_id_inc: int = 0, created_at: str | None = None
) -> dict:
msg = json.loads(load_fixture(Path().joinpath("listen", "fcmdata_v1.json")))
gcmdata = json.loads(
load_fixture(Path().joinpath("listen", f"{alert_type}_gcmdata.json"))
)
if created_at is None:
created_at = datetime.datetime.utcnow().isoformat(timespec="milliseconds") + "Z" # noqa: DTZ003
if "ding" in gcmdata:
gcmdata["ding"]["doorbot_id"] = device_id
gcmdata["ding"]["created_at"] = created_at
gcmdata["ding"]["id"] = gcmdata["ding"]["id"] + ding_id_inc
else:
gcmdata["alarm_meta"]["device_zid"] = device_id
msg["data"]["gcmData"] = json.dumps(gcmdata)
return msg
def load_alert_v2(
alert_type: str, device_id, *, ding_id_inc: int = 0, created_at: str | None = None
) -> dict:
msg = json.loads(load_fixture(Path().joinpath("listen", "fcmdata_v2.json")))
data = json.loads(
load_fixture(Path().joinpath("listen", f"{alert_type}_data.json"))
)
android_config = json.loads(
load_fixture(Path().joinpath("listen", f"{alert_type}_android_config.json"))
)
analytics = json.loads(
load_fixture(Path().joinpath("listen", f"{alert_type}_analytics.json"))
)
if created_at is None:
created_at = datetime.datetime.utcnow().isoformat(timespec="milliseconds") + "Z" # noqa: DTZ003
data["device"]["id"] = device_id
data["event"]["ding"]["created_at"] = created_at
data["event"]["ding"]["id"] = str(int(data["event"]["ding"]["id"]) + ding_id_inc)
msg["data"]["data"] = json.dumps(data)
msg["data"]["android_config"] = json.dumps(android_config)
msg["data"]["analytics"] = json.dumps(analytics)
return msg
@pytest.fixture(autouse=True)
def _listen_mock(mocker, request) -> None:
if "nolistenmock" in request.keywords:
return
mocker.patch(
"firebase_messaging.FcmPushClient.checkin_or_register", return_value="foobar"
)
mocker.patch("firebase_messaging.FcmPushClient.start")
mocker.patch("firebase_messaging.FcmPushClient.stop")
mocker.patch("firebase_messaging.FcmPushClient.is_started", return_value=True)
def callback(url, **kwargs): # noqa: ANN003
return CallbackResult(status=418)
# tests to pull in request_mock and append uris
@pytest.fixture
def devices_fixture():
class Devices:
def __init__(self) -> None:
"""Initialise the class."""
self.updated = False
def devices(self) -> dict:
"""Get the devices."""
if not self.updated:
return load_fixture_as_dict("ring_devices.json")
return load_fixture_as_dict("ring_devices_updated.json")
def callback(self, url, **kwargs) -> CallbackResult: # noqa: ARG002, ANN003
"""Return the callback result."""
return CallbackResult(payload=self.devices())
return Devices()
@pytest.fixture
def putpatch_status_fixture():
class StatusOverrides:
def __init__(self) -> None:
"""Initialise the class."""
self.overrides = {}
def callback(self, url, **kwargs) -> CallbackResult: # noqa: ANN003, ARG002
"""Return the callback."""
plain_url = str(url)
if plain_url in self.overrides:
return CallbackResult(body=b"", status=self.overrides[plain_url])
return CallbackResult(body=b"", status=204)
return StatusOverrides()
@pytest.fixture(autouse=True, name="hardware_id_mock")
def _hardware_id_mock_fixture() -> Generator:
"""Fixture to patch getnode ensures all tests generate same hardware_id."""
with patch("uuid.getnode", return_value=12345678901):
yield
# setting the fixture name to requests_mock allows other
# tests to pull in request_mock and append uris
@pytest.fixture(autouse=True, name="aioresponses_mock")
def aioresponses_mock_fixture(request, devices_fixture, putpatch_status_fixture):
with aioresponses() as mock:
mock.post(
"https://oauth.ring.com/oauth/token",
payload=load_fixture_as_dict("ring_oauth.json"),
repeat=True,
)
mock.post(
"https://api.ring.com/clients_api/session",
payload=load_fixture_as_dict("ring_session.json"),
repeat=True,
)
mock.get(
"https://api.ring.com/clients_api/ring_devices",
callback=devices_fixture.callback,
repeat=True,
)
mock.get(
re.compile(r"https:\/\/api\.ring\.com\/clients_api\/chimes\/\d+\/health"),
payload=load_fixture_as_dict("ring_chime_health_attrs.json"),
repeat=True,
)
mock.get(
re.compile(r"https:\/\/api\.ring\.com\/clients_api\/doorbots\/\d+\/health"),
payload=load_fixture_as_dict("ring_doorboot_health_attrs.json"),
repeat=True,
)
mock.get(
re.compile(
r"https:\/\/api\.ring\.com\/clients_api\/doorbots\/185036587\/history.*$"
),
payload=load_fixture_as_dict("ring_intercom_history.json"),
repeat=True,
)
mock.get(
re.compile(
r"https:\/\/api\.ring\.com\/clients_api\/doorbots\/\d+\/history.*$"
),
payload=load_fixture_as_dict("ring_doorbot_history.json"),
repeat=True,
)
mock.get(
"https://api.ring.com/clients_api/dings/active",
payload=_set_dings_to_now(load_fixture_as_dict("ring_ding_active.json")),
repeat=True,
)
mock.put(
"https://api.ring.com/clients_api/doorbots/987652/floodlight_light_off",
payload="ok",
repeat=True,
)
mock.put(
"https://api.ring.com/clients_api/doorbots/987652/floodlight_light_on",
payload="ok",
repeat=True,
)
mock.put(
"https://api.ring.com/clients_api/doorbots/987652/siren_on",
payload="ok",
repeat=True,
)
mock.put(
"https://api.ring.com/clients_api/doorbots/987652/siren_off",
payload="ok",
repeat=True,
)
mock.get(
"https://api.ring.com/groups/v1/locations/mock-location-id/groups",
payload=load_fixture_as_dict("ring_groups.json"),
repeat=True,
)
mock.get(
"https://api.ring.com/groups/v1/locations/"
"mock-location-id/groups/mock-group-id/devices",
payload=load_fixture_as_dict("ring_group_devices.json"),
repeat=True,
)
mock.post(
"https://api.ring.com/groups/v1/locations/"
"mock-location-id/groups/mock-group-id/devices",
payload="ok",
repeat=True,
)
mock.patch(
re.compile(
r"https:\/\/api\.ring\.com\/devices\/v1\/devices\/\d+\/settings"
),
payload="ok",
repeat=True,
)
mock.get(
re.compile(r"https:\/\/api\.ring\.com\/clients_api\/dings\/\d+\/recording"),
status=200,
body=b"123456",
repeat=True,
)
mock.get(
"https://api.ring.com/clients_api/dings/9876543212/recording",
status=200,
body=b"123456",
repeat=True,
)
mock.patch(
"https://api.ring.com/clients_api/device",
callback=putpatch_status_fixture.callback,
repeat=True,
)
mock.put(
re.compile(r"https:\/\/api\.ring\.com\/clients_api\/doorbots\/.*$"),
status=204,
body=b"",
repeat=True,
)
mock.get(
"https://api.ring.com/devices/v1/devices/185036587/settings",
payload=load_fixture_as_dict("ring_intercom_settings.json"),
repeat=True,
)
mock.get(
"https://api.ring.com/clients_api/locations/mock-location-id/users",
payload=load_fixture_as_dict("ring_intercom_users.json"),
repeat=True,
)
mock.post(
"https://api.ring.com/clients_api/locations/mock-location-id/invitations",
payload="ok",
repeat=True,
)
mock.delete(
(
"https://api.ring.com/clients_api/locations/"
"mock-location-id/invitations/123456789"
),
payload="ok",
repeat=True,
)
requestid = "44529542-3ed7-41da-807e-c170a01bac1d"
mock.put(
"https://api.ring.com/commands/v1/devices/185036587/device_rpc",
body=(
'{"result": {"code": 0}, "id": "' + requestid + '", "jsonrpc": "2.0"}'
).encode(),
repeat=True,
)
yield mock
|