Refactor integration tests to use stateful fakes and fixtures

Author: allenporter

roborock/testing/channel.py

@@ -5,6 +5,7 @@
 in-memory replacement for `MqttChannel` and `LocalChannel` during testing.
 """
 
+import inspect
 from collections.abc import Callable
 from typing import Any
 from unittest.mock import AsyncMock, MagicMock
@@ -37,6 +38,9 @@ class FakeChannel(Channel):
       publish (useful for low-level RPC request/response testing).
     - **Push unsolicited messages**: Call ``channel.notify_subscribers(msg)``
       to simulate the device broadcasting a state change.
+    - **Intercept published messages**: Register a handler/callback via
+      ``channel.publish_handler = my_handler`` (e.g. stateful simulator)
+      to reactively process commands.
     """
 
     subscribe: Any
@@ -49,6 +53,11 @@ def __init__(self, is_local: bool = False):
         self._is_connected = False
         self._is_local = is_local
 
+        # A callback to intercept published messages (e.g., bound simulator handler).
+        # Can be either synchronous or asynchronous: Callable[[RoborockMessage], Any].
+        # By default, routes to self._default_publish_handler to handle the response_queue.
+        self.publish_handler: Callable[[RoborockMessage], Any] | None = self._default_publish_handler
+
         # Set this to an exception instance to make the next publish raise it.
         # This is a convenience shortcut; callers can also replace
         # ``publish.side_effect`` directly for more control.
@@ -96,14 +105,18 @@ def is_local_connected(self) -> bool:
     async def _publish(self, message: RoborockMessage) -> None:
         """Default publish implementation.
 
-        Records the message in ``published_messages`` and, if
-        ``response_queue`` is non-empty, pops the first response and
-        delivers it to all current subscribers (simulating a
-        request/response round-trip).
+        Records the message in ``published_messages`` and executes ``publish_handler``.
         """
         self.published_messages.append(message)
         if self.publish_side_effect:
             raise self.publish_side_effect
+        if self.publish_handler:
+            res = self.publish_handler(message)
+            if inspect.isawaitable(res):
+                await res
+
+    def _default_publish_handler(self, message: RoborockMessage) -> None:
+        """Default handler that pops canned responses from response_queue."""
         if self.response_queue:
             response = self.response_queue.pop(0)
             self.notify_subscribers(response)
@@ -124,3 +137,15 @@ def notify_subscribers(self, message: RoborockMessage) -> None:
         """
         for subscriber in list(self.subscribers):
             subscriber(message)
+
+    def inject_error(self, exception: Exception) -> None:
+        """Inject a transient failure into all channel operations (publish, subscribe, connect)."""
+        self.publish.side_effect = exception
+        self.subscribe.side_effect = exception
+        self.connect.side_effect = exception
+
+    def clear_error(self) -> None:
+        """Restore default success behaviors on all channel operations."""
+        self.publish.side_effect = self._publish
+        self.subscribe.side_effect = self._subscribe
+        self.connect.side_effect = self._connect

roborock/testing/cloud.py

@@ -6,6 +6,7 @@
 """
 
 import contextlib
+import datetime
 import re
 from typing import Any
 from unittest.mock import AsyncMock, patch
@@ -173,6 +174,44 @@ def get_homes_callback(url, **kwargs):
             callback=get_homes_callback,
         )
 
+    def get_default_home_data(self) -> HomeData:
+        """Construct the default HomeData using simulated devices registered in the cloud."""
+        devices = [d.device_info for d in self.cloud.simulated_devices.values()]
+        products = [d.product for d in self.cloud.simulated_devices.values()]
+        return HomeData(
+            id=self.cloud.home_id,
+            name=self.cloud.home_name,
+            devices=devices,
+            products=products,
+            received_devices=[],
+            rooms=[],
+        )
+
+    def set_homes_response(
+        self,
+        home_data: HomeData | None = None,
+        status: int = 200,
+    ) -> None:
+        """Easily set the faked response payload for the homes endpoint using a HomeData dataclass.
+
+        If home_data is None, it defaults to the active get_default_home_data() state.
+        """
+        self.homes_status = status
+        if status != 200:
+            self.homes_payload_override = None
+            return
+
+        if home_data is None:
+            home_data = self.get_default_home_data()
+
+        self.homes_payload_override = {
+            "api": None,
+            "code": 200,
+            "result": home_data.as_dict(),
+            "status": "ok",
+            "success": True,
+        }
+
 
 class FakeRoborockCloud:
     """A central state object representing the Roborock Cloud environment under test."""
@@ -234,7 +273,9 @@ def mock_create_mqtt_channel(user_data, mqtt_params, mqtt_session, device):
         with aioresponses() as mocked:
             self.web_api.mock_requests(mocked)
 
-            # Patch Channel factories and rate limiters
+            # Mock sleep logic to speed up tests.
+            sleep_time = datetime.timedelta(seconds=0.001)
+            # Patch Channel factories, rate limiters, and backoff sleep intervals
             with (
                 patch(
                     "roborock.web_api.RoborockApiClient._login_limiter.try_acquire_async",
@@ -243,5 +284,7 @@ def mock_create_mqtt_channel(user_data, mqtt_params, mqtt_session, device):
                 patch("roborock.web_api.RoborockApiClient._home_data_limiter.try_acquire", return_value=True),
                 patch("roborock.devices.device_manager.create_v1_channel", side_effect=mock_create_v1_channel),
                 patch("roborock.devices.device_manager.create_mqtt_channel", side_effect=mock_create_mqtt_channel),
+                patch("roborock.devices.device.MIN_BACKOFF_INTERVAL", sleep_time),
+                patch("roborock.devices.device.MAX_BACKOFF_INTERVAL", sleep_time),
             ):
                 yield

roborock/testing/simulator.py

@@ -73,26 +73,20 @@ def __init__(
 
         # MQTT channel is always present — all protocols use it.
         self.mqtt_channel = FakeChannel(is_local=False)
-        self.mqtt_channel.publish.side_effect = self._handle_mqtt_publish
+        self.mqtt_channel.publish_handler = self._handle_mqtt_publish
 
         # Local channel is only used by V1 devices. A01/B01 (MQTT-only)
         # simulators should pass has_local_channel=False.
         self.local_channel: FakeChannel | None = None
         if has_local_channel:
             self.local_channel = FakeChannel(is_local=True)
-            self.local_channel.publish.side_effect = self._handle_local_publish
+            self.local_channel.publish_handler = self._handle_local_publish
 
     async def _handle_local_publish(self, message: RoborockMessage) -> None:
         assert self.local_channel is not None
-        self.local_channel.published_messages.append(message)
-        if self.local_channel.publish_side_effect:
-            raise self.local_channel.publish_side_effect
         await self._handle_publish(message, self.local_channel)
 
     async def _handle_mqtt_publish(self, message: RoborockMessage) -> None:
-        self.mqtt_channel.published_messages.append(message)
-        if self.mqtt_channel.publish_side_effect:
-            raise self.mqtt_channel.publish_side_effect
         await self._handle_publish(message, self.mqtt_channel)
 
     async def _handle_publish(self, message: RoborockMessage, channel: FakeChannel) -> None:

tests/conftest.py

@@ -0,0 +1,37 @@
+"""Pytest fixtures for python-roborock tests."""
+
+from collections.abc import Generator
+
+import pytest
+
+from roborock.data import HomeData, UserData
+from roborock.testing import FakeRoborockCloud, V1VacuumSimulator
+from tests import mock_data
+
+USER_DATA = UserData.from_dict(mock_data.USER_DATA)
+HOME_DATA = HomeData.from_dict(mock_data.HOME_DATA_RAW)
+
+
+@pytest.fixture(name="cloud")
+def cloud_fixture() -> FakeRoborockCloud:
+    """Fixture to set up FakeRoborockCloud."""
+    return FakeRoborockCloud(user_data=USER_DATA)
+
+
+@pytest.fixture(name="fake_device")
+def fake_device_fixture(cloud: FakeRoborockCloud) -> V1VacuumSimulator:
+    """Fixture to set up a stateful V1VacuumSimulator registered to the cloud."""
+    device = V1VacuumSimulator(
+        duid="abc123",
+        device_info=HOME_DATA.devices[0],
+        product=HOME_DATA.products[0],
+    )
+    cloud.add_device(device)
+    return device
+
+
+@pytest.fixture(name="patch_device_manager")
+def patch_device_manager_fixture(cloud: FakeRoborockCloud) -> Generator[None, None, None]:
+    """Fixture to patch the device manager and HTTP client."""
+    with cloud.patch_device_manager():
+        yield

tests/devices/__snapshots__/test_device_manager.ambr

@@ -382,7 +382,7 @@
             'debugMode': 0,
             'dndEnabled': 0,
             'dockErrorStatus': 0,
-            'dockType': 3,
+            'dockType': 7,
             'dss': 169,
             'dustCollectionStatus': 0,
             'errorCode': 0,
@@ -409,7 +409,7 @@
             'washPhase': 0,
             'washReady': 0,
             'waterBoxCarriageStatus': 1,
-            'waterBoxMode': 203,
+            'waterBoxMode': 200,
             'waterBoxStatus': 1,
             'waterShortageStatus': 0,
           }),
@@ -595,18 +595,6 @@
       'receivedDevices': list([
       ]),
       'rooms': list([
-        dict({
-          'id': 2362048,
-          'name': '**REDACTED**',
-        }),
-        dict({
-          'id': 2362044,
-          'name': '**REDACTED**',
-        }),
-        dict({
-          'id': 2362041,
-          'name': '**REDACTED**',
-        }),
       ]),
     }),
   })