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 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
|
"""End-to-end tests for MQTT session.
These tests use a fake MQTT broker to verify the session implementation. We
mock out the lower level socket connections to simulate a broker which gets us
close to an "end to end" test without needing an actual MQTT broker server.
These are higher level tests than the similar tests in tests/mqtt/test_roborock_session.py
which use mocks to verify specific behaviors.
"""
import asyncio
import json
from collections.abc import AsyncGenerator, Awaitable, Callable
from typing import Any
import pytest
import syrupy
from Crypto.Cipher import AES
from Crypto.Util.Padding import pad
from roborock.data.b01_q7 import WorkStatusMapping
from roborock.data.b01_q10.b01_q10_code_mappings import B01_Q10_DP
from roborock.data.containers import UserData
from roborock.data.zeo.zeo_code_mappings import ZeoState
from roborock.devices.cache import Cache, InMemoryCache
from roborock.devices.device_manager import DeviceManager, UserParams, create_device_manager
from roborock.protocol import MessageParser
from roborock.protocols.a01_protocol import A01_VERSION
from roborock.protocols.b01_q7_protocol import B01_VERSION
from roborock.protocols.v1_protocol import LocalProtocolVersion
from roborock.roborock_message import RoborockB01Props, RoborockMessage, RoborockMessageProtocol, RoborockZeoProtocol
from roborock.web_api import RoborockApiClient
from tests import mock_data, mqtt_packet
from tests.fixtures.logging import CapturedRequestLog
from tests.mock_data import HOME_DATA_RAW, LOCAL_KEY
TEST_USERNAME = "user@example.com"
TEST_CODE = 1234
# The topic used for the user + device. This is determined from the fake Home
# data API response.
TEST_TOPIC_FORMAT = "rr/m/o/user123/19648f94/{duid}"
TEST_RANDOM = 23
TEST_HOST = mock_data.TEST_LOCAL_API_HOST
NETWORK_INFO = {
"ip": TEST_HOST,
"ssid": "test_wifi",
"mac": "aa:bb:cc:dd:ee:ff",
"bssid": "aa:bb:cc:dd:ee:ff",
"rssi": -50,
}
# For tests that want to skip the web API login flow
TEST_USER_PARAMS = UserParams(
username=TEST_USERNAME,
user_data=UserData.from_dict(mock_data.USER_DATA),
base_url=mock_data.BASE_URL,
)
MQTT_DEFAULT_RESPONSES: list[bytes] = [
# MQTT connection response
mqtt_packet.gen_connack(rc=0, flags=2),
# ACK the request to subscribe to the topic
mqtt_packet.gen_suback(mid=1),
]
@pytest.fixture(autouse=True)
def auto_mock_mqtt_client(mock_aiomqtt_client: None) -> None:
"""Automatically use the mock mqtt client fixture."""
@pytest.fixture(autouse=True)
def auto_fast_backoff(fast_backoff_fixture: None) -> None:
"""Automatically use the fast backoff fixture."""
@pytest.fixture(autouse=True)
def mqtt_server_fixture(mock_paho_mqtt_create_connection: None, mock_paho_mqtt_select: None) -> None:
"""Fixture to mock the MQTT connection.
This is here to pull in the mock socket fixtures into all tests used here.
"""
@pytest.fixture(autouse=True)
def auto_mock_local_client(mock_async_create_local_connection: None) -> None:
"""Automatically use the mock local client fixture."""
@pytest.fixture(name="device_manager_factory")
async def device_manager_factory_fixture() -> AsyncGenerator[Callable[[UserParams], Awaitable[DeviceManager]], None]:
"""Fixture to create a device manager and handle auto shutdown on test failure."""
cleanup_tasks: list[Callable[[], Awaitable[None]]] = []
cache: Cache = InMemoryCache()
async def factory(user_params: UserParams) -> DeviceManager:
"""Create a device manager and auto cleanup."""
device_manager = await create_device_manager(user_params, cache=cache)
cleanup_tasks.append(device_manager.close)
return device_manager
yield factory
await asyncio.gather(*[task() for task in cleanup_tasks])
class ResponseBuilder:
"""Utility class to build raw response messages.
This helps keep track of sequence numbers and timestamps mostly to remove
them from the main test body. These are mostly ignored by the client in the
response.
"""
def __init__(self) -> None:
"""Initialize the response builder."""
self.seq_counter = 0
self.timestamp_counter = 1766520441
self.connect_nonce: int | None = None
self.ack_nonce: int | None = None
self.protocol = RoborockMessageProtocol.RPC_RESPONSE
self.version: bytes = LocalProtocolVersion.V1.value.encode()
def build_v1(
self,
payload: bytes,
protocol: RoborockMessageProtocol | None = None,
) -> bytes:
"""Build an encoded response message."""
self.seq_counter += 1
return self._encrypt(
self._build_roborock_message(
payload=payload,
protocol=protocol if protocol is not None else self.protocol,
),
)
def build_v1_rpc(
self,
data: dict[str, Any],
) -> bytes:
"""Build an encoded RPC response message."""
self.timestamp_counter += 1
return self.build_v1(
payload=json.dumps(
{
"t": self.timestamp_counter,
"dps": {
"102": json.dumps(data),
},
}
).encode(),
)
def build_a01_rpc(self, data: dict[str, Any]) -> bytes:
"""Build an encoded A01 RPC response message."""
self.timestamp_counter += 1
return self._encrypt(
self._build_roborock_message(
payload=pad(json.dumps({"dps": data}).encode(), AES.block_size),
),
)
def build_b01_q7_rpc(self, data: dict[str, Any] | str, code: int | None = None, msg_id: int | None = None) -> bytes:
"""Build an encoded B01 RPC response message."""
message: dict[str, Any] = {
"msgId": str(msg_id),
"data": data,
}
if code is not None:
message["code"] = code
return self._build_b01_dps(message)
def _build_b01_dps(self, message: dict[str, Any] | str) -> bytes:
"""Build an encoded B01 RPC response message given an inner message."""
dps_payload = {"dps": {"10000": json.dumps(message)}}
self.seq_counter += 1
return self._encrypt(
self._build_roborock_message(
payload=json.dumps(dps_payload).encode(),
),
)
def _build_roborock_message(
self,
payload: bytes,
protocol: RoborockMessageProtocol | None = None,
) -> RoborockMessage:
"""Build a Roborock message."""
return RoborockMessage(
protocol=protocol if protocol is not None else self.protocol,
random=TEST_RANDOM,
seq=self.seq_counter,
payload=payload,
version=self.version,
)
def _encrypt(self, message: RoborockMessage) -> bytes:
"""Encrypt a message."""
return MessageParser.build(
message,
local_key=LOCAL_KEY,
connect_nonce=self.connect_nonce,
ack_nonce=self.ack_nonce,
)
async def test_v1_device(
mock_rest: Any,
push_mqtt_response: Callable[[bytes], None],
local_response_queue: asyncio.Queue[bytes],
local_received_requests: asyncio.Queue[bytes],
log: CapturedRequestLog,
snapshot: syrupy.SnapshotAssertion,
device_manager_factory: Callable[[UserParams], Awaitable[DeviceManager]],
) -> None:
"""Test the device manager end to end flow with a v1 device."""
# Simulate the login flow to get user params
web_api = RoborockApiClient(username=TEST_USERNAME)
await web_api.request_code()
user_data = await web_api.code_login(TEST_CODE)
# Prepare MQTT requests
response_builder = ResponseBuilder()
test_topic = TEST_TOPIC_FORMAT.format(duid="abc123")
mqtt_responses: list[bytes] = [
*MQTT_DEFAULT_RESPONSES,
# ACK the GET_NETWORK_INFO call. id is deterministic based on deterministic_message_fixtures
mqtt_packet.gen_publish(
test_topic, mid=2, payload=response_builder.build_v1_rpc(data={"id": 9090, "result": NETWORK_INFO})
),
]
for response in mqtt_responses:
push_mqtt_response(response)
# Prepare local device responses. The ids are deterministic based on deterministic_message_fixtures
response_builder.seq_counter = 0
local_responses: list[bytes] = [
# Queue HELLO response
response_builder.build_v1(protocol=RoborockMessageProtocol.HELLO_RESPONSE, payload=b"ok"),
# Feature discovery part 1 & 2
response_builder.build_v1_rpc(data={"id": 9094, "result": [mock_data.APP_GET_INIT_STATUS]}),
response_builder.build_v1_rpc(data={"id": 9097, "result": [mock_data.STATUS]}),
]
for payload in local_responses:
local_response_queue.put_nowait(payload)
# Create the device manager
user_params = UserParams(
username=TEST_USERNAME,
user_data=user_data,
base_url=await web_api.base_url,
)
device_manager = await device_manager_factory(user_params)
# The mocked Home Data API returns a single v1 device
devices = await device_manager.get_devices()
assert len(devices) == 1
device = devices[0]
assert device.duid == "abc123"
assert device.name == "Roborock S7 MaxV"
assert device.is_connected
assert device.is_local_connected
# Verify GET_STATUS response based on mock_data.STATUS
assert device.v1_properties
assert device.v1_properties.status
assert device.v1_properties.status.state_name == "charging"
assert device.v1_properties.status.battery == 100
assert device.v1_properties.status.clean_time == 1176
# Verify arbitrary device features
assert device.v1_properties.device_features.is_show_clean_finish_reason_supported
assert device.v1_properties.device_features.is_customized_clean_supported
assert not device.v1_properties.device_features.is_matter_supported
# Close the device manager. We will test re-connecting and reusing the network
# information and device discovery information from the cache.
await device_manager.close()
mqtt_responses = [
*MQTT_DEFAULT_RESPONSES,
# No network info call this time since it should be cached
]
for response in mqtt_responses:
push_mqtt_response(response)
# Prepare local device responses.
response_builder.seq_counter = 0
local_response_queue.put_nowait(
response_builder.build_v1(protocol=RoborockMessageProtocol.HELLO_RESPONSE, payload=b"ok")
)
device_manager = await device_manager_factory(user_params)
# The mocked Home Data API returns a single v1 device
devices = await device_manager.get_devices()
assert len(devices) == 1
device = devices[0]
assert device.duid == "abc123"
assert device.name == "Roborock S7 MaxV"
assert device.is_connected
assert device.is_local_connected
# Verify arbitrary device features from cache
assert device.v1_properties
assert device.v1_properties.device_features
assert device.v1_properties.device_features.is_show_clean_finish_reason_supported
assert device.v1_properties.device_features.is_customized_clean_supported
assert not device.v1_properties.device_features.is_matter_supported
# In the previous test, the dock information is fetched and has the side effect of
# populating the status trait. This test gets dock information from the cache so
# we have to manually refresh status the first time (like other traits).
assert device.v1_properties
assert device.v1_properties.status
assert device.v1_properties.status.state_name is None
# Exercise a GET_STATUS call. id is deterministic based on deterministic_message_fixtures
local_response_queue.put_nowait(response_builder.build_v1_rpc(data={"id": 9101, "result": [mock_data.STATUS]}))
# Verify GET_STATUS response
await device.v1_properties.status.refresh()
assert device.v1_properties.status.state_name == "charging"
assert snapshot == log
async def test_l01_device(
mock_rest: Any,
push_mqtt_response: Callable[[bytes], None],
local_response_queue: asyncio.Queue[bytes],
local_received_requests: asyncio.Queue[bytes],
log: CapturedRequestLog,
snapshot: syrupy.SnapshotAssertion,
device_manager_factory: Callable[[UserParams], Awaitable[DeviceManager]],
) -> None:
"""Test the device manager end to end flow with a l01 device."""
# Prepare MQTT requests
mqtt_response_builder = ResponseBuilder()
test_topic = TEST_TOPIC_FORMAT.format(duid="abc123")
mqtt_responses: list[bytes] = [
*MQTT_DEFAULT_RESPONSES,
# ACK the GET_NETWORK_INFO call. id is deterministic based on deterministic_message_fixtures
mqtt_packet.gen_publish(
test_topic, mid=2, payload=mqtt_response_builder.build_v1_rpc(data={"id": 9090, "result": NETWORK_INFO})
),
]
for response in mqtt_responses:
push_mqtt_response(response)
# Prepare local device responses. The ids are deterministic based on deterministic_message_fixtures
local_response_builder = ResponseBuilder()
local_response_builder.version = LocalProtocolVersion.L01.value.encode()
local_response_builder.connect_nonce = 9093
local_responses: list[bytes] = [
# Initial V1.0 Hello request will fail and cause a retry with L01
b"\x00",
# Queue HELLO response with L01
local_response_builder.build_v1(protocol=RoborockMessageProtocol.HELLO_RESPONSE, payload=b"ok"),
]
# Feature discovery requests are sent with an ack nonce based on the random sent in HELLO_RESPONSE
local_response_builder.ack_nonce = TEST_RANDOM
local_responses.extend(
[
local_response_builder.build_v1_rpc(data={"id": 9094, "result": [mock_data.APP_GET_INIT_STATUS]}),
local_response_builder.build_v1_rpc(data={"id": 9097, "result": [mock_data.STATUS]}),
]
)
for payload in local_responses:
local_response_queue.put_nowait(payload)
# Create the device manager
device_manager = await device_manager_factory(TEST_USER_PARAMS)
# The mocked Home Data API returns a single v1 device
devices = await device_manager.get_devices()
assert len(devices) == 1
device = devices[0]
assert device.duid == "abc123"
assert device.name == "Roborock S7 MaxV"
assert device.is_connected
assert device.is_local_connected
# Verify GET_STATUS response based on mock_data.STATUS
assert device.v1_properties
assert device.v1_properties.status
assert device.v1_properties.status.state_name == "charging"
assert device.v1_properties.status.battery == 100
assert device.v1_properties.status.clean_time == 1176
# Verify arbitrary device features
assert device.v1_properties.device_features.is_show_clean_finish_reason_supported
assert device.v1_properties.device_features.is_customized_clean_supported
assert not device.v1_properties.device_features.is_matter_supported
assert snapshot == log
@pytest.mark.parametrize(
"home_data",
[
(
{
**HOME_DATA_RAW,
"devices": [mock_data.Q10_DEVICE_DATA],
"products": [mock_data.SS07_PRODUCT_DATA],
}
)
],
)
async def test_q10_device(
mock_rest: Any,
push_mqtt_response: Callable[[bytes], None],
log: CapturedRequestLog,
device_manager_factory: Callable[[UserParams], Awaitable[DeviceManager]],
home_data: dict[str, Any],
snapshot: syrupy.SnapshotAssertion,
) -> None:
"""Test the device manager end to end flow with a B01 Q10 device."""
# Prepare MQTT requests
for response in MQTT_DEFAULT_RESPONSES:
push_mqtt_response(response)
# Create the device manager
device_manager = await device_manager_factory(TEST_USER_PARAMS)
# The mocked Home Data API returns a single v1 device
devices = await device_manager.get_devices()
assert len(devices) == 1
device = devices[0]
assert device.duid == "device-id-def456"
assert device.name == "Roborock Q10 S5+"
assert device.is_connected
assert not device.is_local_connected # Q10 does not support local connections
# Send a command. We don't block any response, but just use this to verify
# against the golden byte stream snapshot.
assert device.b01_q10_properties
command = device.b01_q10_properties.command
await command.send(B01_Q10_DP.REQUEST_DPS, params={})
# In the future here we can verify receiving requests from the device
assert snapshot == log
@pytest.mark.parametrize(
"home_data",
[
(
{
**HOME_DATA_RAW,
"devices": [mock_data.Q7_DEVICE_DATA],
"products": [mock_data.SC01_PRODUCT_DATA],
}
)
],
)
async def test_q7_device(
mock_rest: Any,
push_mqtt_response: Callable[[bytes], None],
log: CapturedRequestLog,
device_manager_factory: Callable[[UserParams], Awaitable[DeviceManager]],
home_data: dict[str, Any],
snapshot: syrupy.SnapshotAssertion,
) -> None:
"""Test the device manager end to end flow with a B01 Q10 device."""
# Prepare MQTT requests
response_builder = ResponseBuilder()
response_builder.version = B01_VERSION
test_topic = TEST_TOPIC_FORMAT.format(duid="device-id-q7")
mqtt_responses: list[bytes] = [
*MQTT_DEFAULT_RESPONSES,
# ACK the Query status call sent below. id is deterministic based on deterministic_message_fixtures
mqtt_packet.gen_publish(
test_topic, mid=2, payload=response_builder.build_b01_q7_rpc({"status": 2}, msg_id=9090)
),
# ACK the start clean call sent below. id is deterministic based on deterministic_message_fixtures
mqtt_packet.gen_publish(test_topic, mid=2, payload=response_builder.build_b01_q7_rpc("ok", msg_id=9093)),
]
for response in mqtt_responses:
push_mqtt_response(response)
# Create the device manager
device_manager = await device_manager_factory(TEST_USER_PARAMS)
# The mocked Home Data API returns a single v1 device
devices = await device_manager.get_devices()
assert len(devices) == 1
device = devices[0]
assert device.duid == "device-id-q7"
assert device.name == "Roborock Q7"
assert device.is_connected
assert not device.is_local_connected # Q7 does not support local connections
# Query a value from the device.
assert device.b01_q7_properties
props = await device.b01_q7_properties.query_values([RoborockB01Props.STATUS])
assert props
assert props.status == WorkStatusMapping.PAUSED
# Send a command and block on an OK response.
await device.b01_q7_properties.start_clean()
assert snapshot == log
@pytest.mark.parametrize(
"home_data",
[
(
{
**HOME_DATA_RAW,
"devices": [mock_data.ZEO_ONE_DEVICE_DATA],
"products": [mock_data.A102_PRODUCT_DATA],
}
)
],
)
async def test_a01_device(
mock_rest: Any,
push_mqtt_response: Callable[[bytes], None],
log: CapturedRequestLog,
device_manager_factory: Callable[[UserParams], Awaitable[DeviceManager]],
home_data: dict[str, Any],
snapshot: syrupy.SnapshotAssertion,
) -> None:
"""Test the device manager end to end flow with an A01 device."""
# Prepare MQTT requests
response_builder = ResponseBuilder()
response_builder.version = A01_VERSION
test_topic = TEST_TOPIC_FORMAT.format(duid="zeo_duid")
mqtt_responses: list[bytes] = [
*MQTT_DEFAULT_RESPONSES,
# ACK the Query state call sent below. id is deterministic based on deterministic_message_fixtures
mqtt_packet.gen_publish(test_topic, mid=2, payload=response_builder.build_a01_rpc({"203": 6})),
]
for response in mqtt_responses:
push_mqtt_response(response)
# Create the device manager
device_manager = await device_manager_factory(TEST_USER_PARAMS)
# The mocked Home Data API returns a single v1 device
devices = await device_manager.get_devices()
assert len(devices) == 1
device = devices[0]
assert device.duid == "zeo_duid"
assert device.name == "Zeo One"
assert device.is_connected
assert not device.is_local_connected # Washing Machine does not support local connections
# Query a value from the device.
assert device.zeo
props: dict[RoborockZeoProtocol, Any] = await device.zeo.query_values([RoborockZeoProtocol.STATE])
assert props
assert props[RoborockZeoProtocol.STATE] == ZeoState.spinning.name
assert snapshot == log
|