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 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
|
import asyncio
import io
import logging
import re
from asyncio import Protocol
from collections.abc import AsyncGenerator, Callable, Generator
from queue import Queue
from typing import Any
from unittest.mock import AsyncMock, Mock, patch
import pytest
from aioresponses import aioresponses
from roborock import HomeData, UserData
from roborock.containers import DeviceData
from roborock.roborock_message import RoborockMessage
from roborock.version_1_apis.roborock_local_client_v1 import RoborockLocalClientV1
from roborock.version_1_apis.roborock_mqtt_client_v1 import RoborockMqttClientV1
from tests.mock_data import HOME_DATA_RAW, HOME_DATA_SCENES_RAW, TEST_LOCAL_API_HOST, USER_DATA
_LOGGER = logging.getLogger(__name__)
# Used by fixtures to handle incoming requests and prepare responses
RequestHandler = Callable[[bytes], bytes | None]
QUEUE_TIMEOUT = 10
class FakeSocketHandler:
"""Fake socket used by the test to simulate a connection to the broker.
The socket handler is used to intercept the socket send and recv calls and
populate the response buffer with data to be sent back to the client. The
handle request callback handles the incoming requests and prepares the responses.
"""
def __init__(self, handle_request: RequestHandler, response_queue: Queue[bytes]) -> None:
self.response_buf = io.BytesIO()
self.handle_request = handle_request
self.response_queue = response_queue
def pending(self) -> int:
"""Return the number of bytes in the response buffer."""
return len(self.response_buf.getvalue())
def handle_socket_recv(self, read_size: int) -> bytes:
"""Intercept a client recv() and populate the buffer."""
if self.pending() == 0:
raise BlockingIOError("No response queued")
self.response_buf.seek(0)
data = self.response_buf.read(read_size)
_LOGGER.debug("Response: 0x%s", data.hex())
# Consume the rest of the data in the buffer
remaining_data = self.response_buf.read()
self.response_buf = io.BytesIO(remaining_data)
return data
def handle_socket_send(self, client_request: bytes) -> int:
"""Receive an incoming request from the client."""
_LOGGER.debug("Request: 0x%s", client_request.hex())
if (response := self.handle_request(client_request)) is not None:
# Enqueue a response to be sent back to the client in the buffer.
# The buffer will be emptied when the client calls recv() on the socket
_LOGGER.debug("Queued: 0x%s", response.hex())
self.response_buf.write(response)
return len(client_request)
def push_response(self) -> None:
"""Push a response to the client."""
if not self.response_queue.empty():
response = self.response_queue.get()
# Enqueue a response to be sent back to the client in the buffer.
# The buffer will be emptied when the client calls recv() on the socket
_LOGGER.debug("Queued: 0x%s", response.hex())
self.response_buf.write(response)
@pytest.fixture(name="received_requests")
def received_requests_fixture() -> Queue[bytes]:
"""Fixture that provides access to the received requests."""
return Queue()
@pytest.fixture(name="response_queue")
def response_queue_fixture() -> Generator[Queue[bytes], None, None]:
"""Fixture that provides access to the received requests."""
response_queue: Queue[bytes] = Queue()
yield response_queue
assert response_queue.empty(), "Not all fake responses were consumed"
@pytest.fixture(name="request_handler")
def request_handler_fixture(received_requests: Queue[bytes], response_queue: Queue[bytes]) -> RequestHandler:
"""Fixture records incoming requests and replies with responses from the queue."""
def handle_request(client_request: bytes) -> bytes | None:
"""Handle an incoming request from the client."""
received_requests.put(client_request)
# Insert a prepared response into the response buffer
if not response_queue.empty():
return response_queue.get()
return None
return handle_request
@pytest.fixture(name="fake_socket_handler")
def fake_socket_handler_fixture(request_handler: RequestHandler, response_queue: Queue[bytes]) -> FakeSocketHandler:
"""Fixture that creates a fake MQTT broker."""
return FakeSocketHandler(request_handler, response_queue)
@pytest.fixture(name="mock_sock")
def mock_sock_fixture(fake_socket_handler: FakeSocketHandler) -> Mock:
"""Fixture that creates a mock socket connection and wires it to the handler."""
mock_sock = Mock()
mock_sock.recv = fake_socket_handler.handle_socket_recv
mock_sock.send = fake_socket_handler.handle_socket_send
mock_sock.pending = fake_socket_handler.pending
return mock_sock
@pytest.fixture(name="mock_create_connection")
def create_connection_fixture(mock_sock: Mock) -> Generator[None, None, None]:
"""Fixture that overrides the MQTT socket creation to wire it up to the mock socket."""
with patch("paho.mqtt.client.socket.create_connection", return_value=mock_sock):
yield
@pytest.fixture(name="mock_select")
def select_fixture(mock_sock: Mock, fake_socket_handler: FakeSocketHandler) -> Generator[None, None, None]:
"""Fixture that overrides the MQTT client select calls to make select work on the mock socket.
This patch select to activate our mock socket when ready with data. Internal mqtt sockets are
always ready since they are used internally to wake the select loop. Ours is ready if there
is data in the buffer.
"""
def is_ready(sock: Any) -> bool:
return sock is not mock_sock or (fake_socket_handler.pending() > 0)
def handle_select(rlist: list, wlist: list, *args: Any) -> list:
return [list(filter(is_ready, rlist)), list(filter(is_ready, wlist))]
with patch("paho.mqtt.client.select.select", side_effect=handle_select):
yield
@pytest.fixture(name="mqtt_client")
async def mqtt_client(mock_create_connection: None, mock_select: None) -> AsyncGenerator[RoborockMqttClientV1, None]:
user_data = UserData.from_dict(USER_DATA)
home_data = HomeData.from_dict(HOME_DATA_RAW)
device_info = DeviceData(
device=home_data.devices[0],
model=home_data.products[0].model,
)
client = RoborockMqttClientV1(user_data, device_info, queue_timeout=QUEUE_TIMEOUT)
try:
yield client
finally:
if not client.is_connected():
try:
await client.async_release()
except Exception:
pass
@pytest.fixture(name="mock_rest", autouse=True)
def mock_rest() -> aioresponses:
"""Mock all rest endpoints so they won't hit real endpoints"""
with aioresponses() as mocked:
# Match the base URL and allow any query params
mocked.post(
re.compile(r"https://euiot\.roborock\.com/api/v1/getUrlByEmail.*"),
status=200,
payload={
"code": 200,
"data": {"country": "US", "countrycode": "1", "url": "https://usiot.roborock.com"},
"msg": "success",
},
)
mocked.post(
re.compile(r"https://.*iot\.roborock\.com/api/v1/login.*"),
status=200,
payload={"code": 200, "data": USER_DATA, "msg": "success"},
)
mocked.post(
re.compile(r"https://.*iot\.roborock\.com/api/v1/loginWithCode.*"),
status=200,
payload={"code": 200, "data": USER_DATA, "msg": "success"},
)
mocked.post(
re.compile(r"https://.*iot\.roborock\.com/api/v1/sendEmailCode.*"),
status=200,
payload={"code": 200, "data": None, "msg": "success"},
)
mocked.get(
re.compile(r"https://.*iot\.roborock\.com/api/v1/getHomeDetail.*"),
status=200,
payload={
"code": 200,
"data": {"deviceListOrder": None, "id": 123456, "name": "My Home", "rrHomeId": 123456, "tuyaHomeId": 0},
"msg": "success",
},
)
mocked.get(
re.compile(r"https://api-.*\.roborock\.com/v2/user/homes*"),
status=200,
payload={"api": None, "code": 200, "result": HOME_DATA_RAW, "status": "ok", "success": True},
)
mocked.post(
re.compile(r"https://api-.*\.roborock\.com/nc/prepare"),
status=200,
payload={
"api": None,
"result": {"r": "US", "s": "ffffff", "t": "eOf6d2BBBB"},
"status": "ok",
"success": True,
},
)
mocked.get(
re.compile(r"https://api-.*\.roborock\.com/user/devices/newadd/*"),
status=200,
payload={
"api": "获取新增设备信息",
"result": {
"activeTime": 1737724598,
"attribute": None,
"cid": None,
"createTime": 0,
"deviceStatus": None,
"duid": "rand_duid",
"extra": "{}",
"f": False,
"featureSet": "0",
"fv": "02.16.12",
"iconUrl": "",
"lat": None,
"localKey": "random_lk",
"lon": None,
"name": "S7",
"newFeatureSet": "0000000000002000",
"online": True,
"productId": "rand_prod_id",
"pv": "1.0",
"roomId": None,
"runtimeEnv": None,
"setting": None,
"share": False,
"shareTime": None,
"silentOtaSwitch": False,
"sn": "Rand_sn",
"timeZoneId": "America/New_York",
"tuyaMigrated": False,
"tuyaUuid": None,
},
"status": "ok",
"success": True,
},
)
mocked.get(
re.compile(r"https://api-.*\.roborock\.com/user/scene/device/.*"),
status=200,
payload={"api": None, "code": 200, "result": HOME_DATA_SCENES_RAW, "status": "ok", "success": True},
)
mocked.post(
re.compile(r"https://api-.*\.roborock\.com/user/scene/.*/execute"),
status=200,
payload={"api": None, "code": 200, "result": None, "status": "ok", "success": True},
)
yield mocked
@pytest.fixture(autouse=True)
def skip_rate_limit():
"""Don't rate limit tests as they aren't actually hitting the api."""
with (
patch("roborock.web_api.RoborockApiClient._login_limiter.try_acquire"),
patch("roborock.web_api.RoborockApiClient._home_data_limiter.try_acquire"),
):
yield
@pytest.fixture(name="mock_create_local_connection")
def create_local_connection_fixture(request_handler: RequestHandler) -> Generator[None, None, None]:
"""Fixture that overrides the transport creation to wire it up to the mock socket."""
async def create_connection(protocol_factory: Callable[[], Protocol], *args) -> tuple[Any, Any]:
protocol = protocol_factory()
def handle_write(data: bytes) -> None:
_LOGGER.debug("Received: %s", data)
response = request_handler(data)
if response is not None:
_LOGGER.debug("Replying with %s", response)
loop = asyncio.get_running_loop()
loop.call_soon(protocol.data_received, response)
closed = asyncio.Event()
mock_transport = Mock()
mock_transport.write = handle_write
mock_transport.close = closed.set
mock_transport.is_reading = lambda: not closed.is_set()
return (mock_transport, "proto")
with patch("roborock.version_1_apis.roborock_local_client_v1.get_running_loop") as mock_loop:
mock_loop.return_value.create_connection.side_effect = create_connection
yield
@pytest.fixture(name="local_client")
async def local_client_fixture(mock_create_local_connection: None) -> AsyncGenerator[RoborockLocalClientV1, None]:
home_data = HomeData.from_dict(HOME_DATA_RAW)
device_info = DeviceData(
device=home_data.devices[0],
model=home_data.products[0].model,
host=TEST_LOCAL_API_HOST,
)
client = RoborockLocalClientV1(device_info, queue_timeout=QUEUE_TIMEOUT)
try:
yield client
finally:
if not client.is_connected():
try:
await client.async_release()
except Exception:
pass
class FakeChannel:
"""A fake channel that handles publish and subscribe calls."""
def __init__(self):
"""Initialize the fake channel."""
self.subscribers: list[Callable[[RoborockMessage], None]] = []
self.published_messages: list[RoborockMessage] = []
self.response_queue: list[RoborockMessage] = []
self._is_connected = False
self.publish_side_effect: Exception | None = None
self.publish = AsyncMock(side_effect=self._publish)
self.subscribe = AsyncMock(side_effect=self._subscribe)
self.connect = AsyncMock(side_effect=self._connect)
self.close = AsyncMock(side_effect=self._close)
async def _connect(self) -> None:
self._is_connected = True
async def _close(self) -> None:
self._is_connected = False
@property
def is_connected(self) -> bool:
"""Return true if connected."""
return self._is_connected
async def _publish(self, message: RoborockMessage) -> None:
"""Simulate publishing a message and triggering a response."""
self.published_messages.append(message)
if self.publish_side_effect:
raise self.publish_side_effect
# When a message is published, simulate a response
if self.response_queue:
response = self.response_queue.pop(0)
# Give a chance for the subscriber to be registered
for subscriber in list(self.subscribers):
subscriber(response)
async def _subscribe(self, callback: Callable[[RoborockMessage], None]) -> Callable[[], None]:
"""Simulate subscribing to messages."""
self.subscribers.append(callback)
return lambda: self.subscribers.remove(callback)
|