chore: update test fixtures

Author: allenporter

tests/e2e/__snapshots__/test_mqtt_session.ambr

@@ -5,11 +5,7 @@
   00000010  08 75 73 65 72 6e 61 6d 65 00 08 70 61 73 73 77  |.username..passw|
   00000020  6f 72 64                                         |ord|
   [mqtt <]
-  00000000  20                                               | |
-  [mqtt <]
-  00000000  09                                               |.|
-  [mqtt <]
-  00000000  02 00 06 22 00 0a 21 00 14                       |..."..!..|
+  00000000  20 09 02 00 06 22 00 0a 21 00 14                 | ...."..!..|
   [mqtt >]
   00000000  30 41 00 07 74 6f 70 69 63 2d 31 00 31 2e 30 00  |0A..topic-1.1.0.|
   00000010  00 01 c8 00 00 23 82 68 a6 a2 23 00 65 00 20 91  |.....#.h..#.e. .|
@@ -23,26 +19,14 @@
   00000010  08 75 73 65 72 6e 61 6d 65 00 08 70 61 73 73 77  |.username..passw|
   00000020  6f 72 64                                         |ord|
   [mqtt <]
-  00000000  20                                               | |
-  [mqtt <]
-  00000000  09                                               |.|
-  [mqtt <]
-  00000000  02 00 06 22 00 0a 21 00 14                       |..."..!..|
+  00000000  20 09 02 00 06 22 00 0a 21 00 14                 | ...."..!..|
   [mqtt <]
-  00000000  90                                               |.|
-  [mqtt <]
-  00000000  04                                               |.|
-  [mqtt <]
-  00000000  00 01 00 00                                      |....|
+  00000000  90 04 00 01 00 00                                |......|
   [mqtt >]
   00000000  82 0d 00 01 00 00 07 74 6f 70 69 63 2d 31 00     |.......topic-1.|
   [mqtt <]
-  00000000  30                                               |0|
-  [mqtt <]
-  00000000  31                                               |1|
-  [mqtt <]
-  00000000  00 07 74 6f 70 69 63 2d 31 00 31 2e 30 00 00 00  |..topic-1.1.0...|
-  00000010  7b 00 00 23 82 68 a6 a2 23 00 66 00 10 45 3b c3  |{..#.h..#.f..E;.|
-  00000020  2b 12 a6 77 d9 55 f6 e0 89 f5 93 a5 30 5d a0 72  |+..w.U......0].r|
-  00000030  fa                                               |.|
+  00000000  30 31 00 07 74 6f 70 69 63 2d 31 00 31 2e 30 00  |01..topic-1.1.0.|
+  00000010  00 00 7b 00 00 23 82 68 a6 a2 23 00 66 00 10 45  |..{..#.h..#.f..E|
+  00000020  3b c3 2b 12 a6 77 d9 55 f6 e0 89 f5 93 a5 30 5d  |;.+..w.U......0]|
+  00000030  a0 72 fa                                         |.r.|
 # ---

tests/fixtures/mqtt.py

@@ -46,7 +46,7 @@ def handle_socket_recv(self, read_size: int) -> bytes:
         self.response_buf.seek(0)
         data = self.response_buf.read(read_size)
         _LOGGER.debug("Response: 0x%s", data.hex())
-        self.log.add_log_entry("[mqtt <]", data)
+        
         # Consume the rest of the data in the buffer
         remaining_data = self.response_buf.read()
         self.response_buf = io.BytesIO(remaining_data)
@@ -61,6 +61,7 @@ def handle_socket_send(self, client_request: bytes) -> int:
             # 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.log.add_log_entry("[mqtt <]", response)
             self.response_buf.write(response)
         return len(client_request)
 
@@ -71,6 +72,7 @@ def push_response(self) -> 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.log.add_log_entry("[mqtt <]", response)
             self.response_buf.write(response)
 
 

tests/fixtures/pahomqtt_fixtures.py

@@ -5,6 +5,7 @@
 from queue import Queue
 from typing import Any
 from unittest.mock import Mock, patch
+import warnings
 
 import pytest
 
@@ -50,9 +51,12 @@ def handle_select(rlist: list, wlist: list, *args: Any) -> list:
 @pytest.fixture(name="fake_mqtt_socket_handler")
 def fake_mqtt_socket_handler_fixture(
     mqtt_request_handler: MqttRequestHandler, mqtt_response_queue: Queue[bytes], log: CapturedRequestLog
-) -> FakeMqttSocketHandler:
+) -> Generator[FakeMqttSocketHandler, None, None]:
     """Fixture that creates a fake MQTT broker."""
-    return FakeMqttSocketHandler(mqtt_request_handler, mqtt_response_queue, log)
+    socket_handler = FakeMqttSocketHandler(mqtt_request_handler, mqtt_response_queue, log)
+    yield socket_handler
+    if len(socket_handler.response_buf.getvalue()) > 0:
+        warnings.warn("Some enqueued MQTT responses were not consumed during the test")
 
 
 @pytest.fixture(name="mock_sock")
@@ -76,7 +80,8 @@ def response_queue_fixture() -> Generator[Queue[bytes], None, None]:
     """Fixture that provides a queue for enqueueing responses to be sent to the client under test."""
     response_queue: Queue[bytes] = Queue()
     yield response_queue
-    assert response_queue.empty(), "Not all fake responses were consumed"
+    if not response_queue.empty():
+        warnings.warn("Some enqueued MQTT responses were not consumed during the test")
 
 
 @pytest.fixture(name="mqtt_request_handler")

tests/mqtt/test_roborock_session.py

@@ -151,8 +151,6 @@ async def test_session_no_subscribers(push_mqtt_response: Callable[[bytes], None
     """Test the MQTT session."""
 
     push_mqtt_response(mqtt_packet.gen_connack(rc=0, flags=2))
-    push_mqtt_response(mqtt_packet.gen_publish("topic-1", mid=3, payload=b"12345"))
-    push_mqtt_response(mqtt_packet.gen_publish("topic-2", mid=4, payload=b"67890"))
     session = await create_mqtt_session(FAKE_PARAMS)
     assert session.connected
 
@@ -528,8 +526,6 @@ def succeed_then_fail_unauthorized() -> Any:
     # Don't produce messages, just exit and restart to reconnect
     message_iterator.loop = False
 
-    push_mqtt_response(mqtt_packet.gen_connack(rc=0, flags=2))
-
     session = await create_mqtt_session(params)
     assert session.connected