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
|
import asyncio
import json
from collections.abc import AsyncGenerator
from queue import Queue
from typing import Any
from unittest.mock import patch
import paho.mqtt.client as mqtt
import pytest
from Crypto.Cipher import AES
from Crypto.Util.Padding import pad
from roborock import (
HomeData,
UserData,
)
from roborock.code_mappings import ZeoState, ZeoTemperature
from roborock.containers import DeviceData, RoborockCategory
from roborock.exceptions import RoborockException
from roborock.protocol import MessageParser
from roborock.roborock_message import (
RoborockMessage,
RoborockMessageProtocol,
RoborockZeoProtocol,
)
from roborock.version_a01_apis import RoborockMqttClientA01
from tests.mock_data import (
HOME_DATA_RAW,
LOCAL_KEY,
MQTT_PUBLISH_TOPIC,
USER_DATA,
WASHER_PRODUCT,
ZEO_ONE_DEVICE,
)
from . import mqtt_packet
from .conftest import QUEUE_TIMEOUT
RELEASE_TIMEOUT = 2
@pytest.fixture(name="a01_mqtt_client")
async def a01_mqtt_client_fixture(
mock_create_connection: None, mock_select: None
) -> AsyncGenerator[RoborockMqttClientA01, None]:
user_data = UserData.from_dict(USER_DATA)
home_data = HomeData.from_dict(
{
**HOME_DATA_RAW,
"devices": [ZEO_ONE_DEVICE],
"products": [WASHER_PRODUCT],
}
)
device_info = DeviceData(
device=home_data.devices[0],
model=home_data.products[0].model,
)
client = RoborockMqttClientA01(
user_data, device_info, RoborockCategory.WASHING_MACHINE, queue_timeout=QUEUE_TIMEOUT
)
try:
yield client
finally:
# Cleanup is best effort to reduce number of active threads
if client.is_connected():
try:
async with asyncio.timeout(RELEASE_TIMEOUT):
await client.async_release()
except Exception:
pass
@pytest.fixture(name="connected_a01_mqtt_client")
async def connected_a01_mqtt_client_fixture(
response_queue: Queue, a01_mqtt_client: RoborockMqttClientA01
) -> AsyncGenerator[RoborockMqttClientA01, None]:
response_queue.put(mqtt_packet.gen_connack(rc=0, flags=2))
response_queue.put(mqtt_packet.gen_suback(1, 0))
await a01_mqtt_client.async_connect()
yield a01_mqtt_client
async def test_async_connect(received_requests: Queue, connected_a01_mqtt_client: RoborockMqttClientA01) -> None:
"""Test connecting to the MQTT broker."""
assert connected_a01_mqtt_client.is_connected()
# Connecting again is a no-op
await connected_a01_mqtt_client.async_connect()
assert connected_a01_mqtt_client.is_connected()
await connected_a01_mqtt_client.async_disconnect()
assert not connected_a01_mqtt_client.is_connected()
# Broker received a connect and subscribe. Disconnect packet is not
# guaranteed to be captured by the time the async_disconnect returns
assert received_requests.qsize() >= 2 # Connect and Subscribe
async def test_connect_failure(
received_requests: Queue, response_queue: Queue, a01_mqtt_client: RoborockMqttClientA01
) -> None:
"""Test the broker responding with a connect failure."""
response_queue.put(mqtt_packet.gen_connack(rc=1))
with pytest.raises(RoborockException, match="Failed to connect"):
await a01_mqtt_client.async_connect()
assert not a01_mqtt_client.is_connected()
assert received_requests.qsize() == 1 # Connect attempt
async def test_disconnect_already_disconnected(connected_a01_mqtt_client: RoborockMqttClientA01) -> None:
"""Test the MQTT client error handling for a no-op disconnect."""
assert connected_a01_mqtt_client.is_connected()
# Make the MQTT client simulate returning that it already thinks it is disconnected
with patch("roborock.cloud_api.mqtt.Client.disconnect", return_value=mqtt.MQTT_ERR_NO_CONN):
await connected_a01_mqtt_client.async_disconnect()
async def test_disconnect_failure(connected_a01_mqtt_client: RoborockMqttClientA01) -> None:
"""Test that the MQTT client ignores MQTT client error handling for a no-op disconnect."""
assert connected_a01_mqtt_client.is_connected()
# Make the MQTT client returns with an error when disconnecting
with patch("roborock.cloud_api.mqtt.Client.disconnect", return_value=mqtt.MQTT_ERR_PROTOCOL), pytest.raises(
RoborockException, match="Failed to disconnect"
):
await connected_a01_mqtt_client.async_disconnect()
async def test_async_release(connected_a01_mqtt_client: RoborockMqttClientA01) -> None:
"""Test the async_release API will disconnect the client."""
await connected_a01_mqtt_client.async_release()
assert not connected_a01_mqtt_client.is_connected()
async def test_subscribe_failure(
received_requests: Queue, response_queue: Queue, a01_mqtt_client: RoborockMqttClientA01
) -> None:
"""Test the broker responding with the wrong message type on subscribe."""
response_queue.put(mqtt_packet.gen_connack(rc=0, flags=2))
with patch("roborock.cloud_api.mqtt.Client.subscribe", return_value=(mqtt.MQTT_ERR_NO_CONN, None)), pytest.raises(
RoborockException, match="Failed to subscribe"
):
await a01_mqtt_client.async_connect()
assert received_requests.qsize() == 1 # Connect attempt
# NOTE: The client is "connected" but not "subscribed" and cannot recover
# from this state without disconnecting first. This can likely be improved.
assert a01_mqtt_client.is_connected()
# Attempting to reconnect is a no-op since the client already thinks it is connected
await a01_mqtt_client.async_connect()
assert a01_mqtt_client.is_connected()
assert received_requests.qsize() == 1
def build_rpc_response(message: dict[Any, Any]) -> bytes:
"""Build an encoded RPC response message."""
return MessageParser.build(
[
RoborockMessage(
protocol=RoborockMessageProtocol.RPC_RESPONSE,
payload=pad(
json.dumps(
{
"dps": message, # {10000: json.dumps(message)},
}
).encode(),
AES.block_size,
),
version=b"A01",
seq=2020,
),
],
local_key=LOCAL_KEY,
)
async def test_update_values(
received_requests: Queue,
response_queue: Queue,
connected_a01_mqtt_client: RoborockMqttClientA01,
) -> None:
"""Test sending an arbitrary MQTT message and parsing the response."""
message = build_rpc_response(
{
203: 6, # spinning
207: 3, # medium
}
)
response_queue.put(mqtt_packet.gen_publish(MQTT_PUBLISH_TOPIC, payload=message))
data = await connected_a01_mqtt_client.update_values([RoborockZeoProtocol.STATE, RoborockZeoProtocol.TEMP])
assert data.get(RoborockZeoProtocol.STATE) == ZeoState.spinning.name
assert data.get(RoborockZeoProtocol.TEMP) == ZeoTemperature.medium.name
async def test_set_value(
received_requests: Queue,
response_queue: Queue,
connected_a01_mqtt_client: RoborockMqttClientA01,
) -> None:
"""Test sending an arbitrary MQTT message and parsing the response."""
# Clear existing messages received during setup
assert received_requests.qsize() == 2
assert received_requests.get(block=True, timeout=QUEUE_TIMEOUT)
assert received_requests.get(block=True, timeout=QUEUE_TIMEOUT)
assert received_requests.empty()
# Prepare the response message
message = build_rpc_response({})
response_queue.put(mqtt_packet.gen_publish(MQTT_PUBLISH_TOPIC, payload=message))
await connected_a01_mqtt_client.set_value(RoborockZeoProtocol.STATE, "spinning")
assert received_requests.get(block=True)
async def test_publish_failure(
connected_a01_mqtt_client: RoborockMqttClientA01,
) -> None:
"""Test a failure return code when publishing a messaage."""
msg = mqtt.MQTTMessageInfo(0)
msg.rc = mqtt.MQTT_ERR_PROTOCOL
with patch("roborock.cloud_api.mqtt.Client.publish", return_value=msg), pytest.raises(
RoborockException, match="Failed to publish"
):
await connected_a01_mqtt_client.update_values([RoborockZeoProtocol.STATE])
async def test_future_timeout(
connected_a01_mqtt_client: RoborockMqttClientA01,
) -> None:
"""Test a timeout raised while waiting for an RPC response."""
with patch("roborock.roborock_future.async_timeout.timeout", side_effect=asyncio.TimeoutError):
data = await connected_a01_mqtt_client.update_values([RoborockZeoProtocol.STATE])
assert data.get(RoborockZeoProtocol.STATE) is None
|