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
|
"""Tests for the Device class."""
import pathlib
from collections.abc import Callable
from typing import Any
from unittest.mock import AsyncMock, Mock
import pytest
from syrupy import SnapshotAssertion
from roborock.data import HomeData, S7MaxVStatus, UserData
from roborock.devices.cache import NoCache
from roborock.devices.device import RoborockDevice
from roborock.devices.traits import v1
from roborock.devices.traits.v1.common import V1TraitMixin
from roborock.protocols.v1_protocol import decode_rpc_response
from roborock.roborock_message import RoborockMessage, RoborockMessageProtocol
from .. import mock_data
USER_DATA = UserData.from_dict(mock_data.USER_DATA)
HOME_DATA = HomeData.from_dict(mock_data.HOME_DATA_RAW)
STATUS = S7MaxVStatus.from_dict(mock_data.STATUS)
TESTDATA = pathlib.Path("tests/protocols/testdata/v1_protocol/")
@pytest.fixture(autouse=True, name="channel")
def device_channel_fixture() -> AsyncMock:
"""Fixture to set up the channel for tests."""
return AsyncMock()
@pytest.fixture(autouse=True, name="rpc_channel")
def rpc_channel_fixture() -> AsyncMock:
"""Fixture to set up the channel for tests."""
return AsyncMock()
@pytest.fixture(autouse=True, name="mqtt_rpc_channel")
def mqtt_rpc_channel_fixture() -> AsyncMock:
"""Fixture to set up the channel for tests."""
return AsyncMock()
@pytest.fixture(autouse=True, name="map_rpc_channel")
def map_rpc_channel_fixture() -> AsyncMock:
"""Fixture to set up the channel for tests."""
return AsyncMock()
@pytest.fixture(autouse=True, name="device")
def device_fixture(channel: AsyncMock, rpc_channel: AsyncMock, mqtt_rpc_channel: AsyncMock) -> RoborockDevice:
"""Fixture to set up the device for tests."""
return RoborockDevice(
device_info=HOME_DATA.devices[0],
product=HOME_DATA.products[0],
channel=channel,
trait=v1.create(
HOME_DATA.devices[0].duid,
HOME_DATA.products[0],
HOME_DATA,
rpc_channel,
mqtt_rpc_channel,
AsyncMock(),
AsyncMock(),
NoCache(),
),
)
async def test_device_connection(device: RoborockDevice, channel: AsyncMock, setup_rpc_channel: AsyncMock) -> None:
"""Test the Device connection setup."""
unsub = Mock()
subscribe = AsyncMock()
subscribe.return_value = unsub
channel.subscribe = subscribe
assert device.duid == "abc123"
assert device.name == "Roborock S7 MaxV"
assert not subscribe.called
await device.connect()
assert subscribe.called
assert not unsub.called
await device.close()
assert unsub.called
@pytest.mark.parametrize(
("connected", "local_connected"),
[
(True, False),
(False, False),
(True, True),
(False, True),
],
)
async def test_connection_status(
device: RoborockDevice,
channel: AsyncMock,
connected: bool,
local_connected: bool,
) -> None:
"""Test successful RPC command sending and response handling."""
channel.is_connected = connected
channel.is_local_connected = local_connected
assert device.is_connected is connected
assert device.is_local_connected is local_connected
@pytest.fixture(name="payloads")
def payloads_fixture() -> list[pathlib.Path]:
"""Fixture to provide the payload for the tests."""
return []
@pytest.fixture(name="setup_rpc_channel")
def setup_rpc_channel_fixture(rpc_channel: AsyncMock, payloads: list[pathlib.Path]) -> AsyncMock:
"""Fixture to set up the RPC channel for the tests."""
# Device discovery calls
side_effects: list[dict[str, Any] | list[Any] | int] = [
[mock_data.APP_GET_INIT_STATUS],
mock_data.STATUS,
]
# Subsequent calls return the data payloads setup by the test.
for payload in payloads:
# The values other than the payload are arbitrary
message = RoborockMessage(
protocol=RoborockMessageProtocol.GENERAL_RESPONSE,
payload=payload.read_bytes(),
seq=12750,
version=b"1.0",
random=97431,
timestamp=1652547161,
)
response_message = decode_rpc_response(message)
side_effects.append(response_message.data)
rpc_channel.send_command.side_effect = side_effects
return rpc_channel
@pytest.mark.parametrize(
("payloads", "property_method"),
[
([TESTDATA / "get_status.json"], lambda x: x.status),
([TESTDATA / "get_dnd.json"], lambda x: x.dnd),
([TESTDATA / "get_clean_summary.json", TESTDATA / "get_last_clean_record.json"], lambda x: x.clean_summary),
([TESTDATA / "get_volume.json"], lambda x: x.sound_volume),
],
ids=[
"status",
"dnd",
"clean_summary",
"volume",
],
)
async def test_device_trait_command_parsing(
device: RoborockDevice,
setup_rpc_channel: AsyncMock,
snapshot: SnapshotAssertion,
property_method: Callable[..., V1TraitMixin],
) -> None:
"""Test the device trait command."""
await device.connect()
trait = property_method(device.v1_properties)
assert trait
assert isinstance(trait, V1TraitMixin)
await trait.refresh()
assert setup_rpc_channel.send_command.called
assert trait == snapshot
assert device.v1_properties
device_dict = device.diagnostic_data()
assert device_dict == snapshot
|