test_mqtt_relay_status_3401.py 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  1. """The relay's printer status topic carries what the REST status does (#3401).
  2. Door, active extruder, tray, AMS, external spool and HMS errors were only
  3. available by polling REST. The broker also gets a Last Will, so a crash does
  4. not leave the retained "online" standing, and a printer dropping is published
  5. even straight after a regular update.
  6. """
  7. import json
  8. from unittest.mock import AsyncMock, MagicMock, patch
  9. import pytest
  10. from backend.app.services.bambu_mqtt import HMSError, PrinterState
  11. from backend.app.services.mqtt_relay import MQTTRelayService
  12. @pytest.fixture
  13. def relay():
  14. service = MQTTRelayService()
  15. service.enabled = True
  16. service.connected = True
  17. service.topic_prefix = "bambuddy"
  18. service._publish = MagicMock()
  19. return service
  20. def _state(**kwargs) -> PrinterState:
  21. return PrinterState(connected=True, state="RUNNING", **kwargs)
  22. def _published(relay) -> dict:
  23. topic, payload = relay._publish.call_args.args[:2]
  24. assert topic == "bambuddy/printers/SERIAL1/status"
  25. return payload
  26. async def _send(relay, state, printer_id=1):
  27. await relay.on_printer_status(printer_id, state, "H2D", "SERIAL1")
  28. class TestStatusPayload:
  29. async def test_door_extruder_and_tray_are_published(self, relay):
  30. await _send(relay, _state(door_open=True, active_extruder=1, tray_now=5))
  31. payload = _published(relay)
  32. assert payload["door_open"] is True
  33. assert payload["active_extruder"] == 1
  34. assert payload["tray_now"] == 5
  35. async def test_hms_errors_are_published_like_the_rest_status(self, relay):
  36. error = HMSError(code="0x0700_8010", attr=117473280, module=7, severity=2)
  37. await _send(relay, _state(hms_errors=[error]))
  38. errors = _published(relay)["hms_errors"]
  39. assert [e["code"] for e in errors] == ["0x0700_8010"]
  40. assert errors[0]["severity"] == 2
  41. assert "description" in errors[0]
  42. async def test_ams_and_external_spool_are_published(self, relay):
  43. raw = {
  44. "ams": [
  45. {
  46. "id": 0,
  47. "humidity": 4,
  48. "temp": 25.0,
  49. "tray": [{"id": 0, "tray_type": "PLA", "tray_color": "FF0000FF", "tray_sub_brands": "PLA Basic"}],
  50. }
  51. ],
  52. "vt_tray": [{"id": 254, "tray_type": "ABS", "tray_color": "000000FF"}],
  53. }
  54. await _send(relay, _state(raw_data=raw))
  55. payload = _published(relay)
  56. assert payload["ams"][0]["tray"][0]["tray_type"] == "PLA"
  57. assert payload["vt_tray"][0]["tray_type"] == "ABS"
  58. async def test_a_printer_without_an_ams_publishes_null_and_empty_lists(self, relay):
  59. await _send(relay, _state())
  60. payload = _published(relay)
  61. assert payload["ams"] is None
  62. assert payload["vt_tray"] == []
  63. assert payload["hms_errors"] == []
  64. async def test_the_payload_stays_json_serialisable(self, relay):
  65. error = HMSError(code="0x0700_8010", attr=1, module=7, severity=2)
  66. await _send(relay, _state(hms_errors=[error], door_open=False, active_extruder=0, tray_now=255))
  67. json.dumps(_published(relay), default=str)
  68. async def test_existing_fields_are_unchanged(self, relay):
  69. await _send(relay, _state(progress=42.0))
  70. payload = _published(relay)
  71. assert payload["state"] == "RUNNING"
  72. assert payload["progress"] == 42.0
  73. assert payload["awaiting_plate_clear"] is False
  74. class TestThrottle:
  75. async def test_a_second_update_within_a_second_is_dropped(self, relay):
  76. await _send(relay, _state())
  77. await _send(relay, _state(progress=50.0))
  78. assert relay._publish.call_count == 1
  79. async def test_a_printer_dropping_is_published_straight_after_an_update(self, relay):
  80. await _send(relay, _state())
  81. await _send(relay, PrinterState(connected=False, state="unknown"))
  82. assert relay._publish.call_count == 2
  83. assert _published(relay)["connected"] is False
  84. async def test_a_printer_coming_back_is_published_straight_after(self, relay):
  85. await _send(relay, PrinterState(connected=False))
  86. await _send(relay, _state())
  87. assert relay._publish.call_count == 2
  88. assert _published(relay)["connected"] is True
  89. async def test_each_printer_is_throttled_on_its_own(self, relay):
  90. await _send(relay, _state(), printer_id=1)
  91. await _send(relay, _state(), printer_id=2)
  92. assert relay._publish.call_count == 2
  93. class TestLastWill:
  94. async def test_connect_sets_a_retained_offline_will_before_connecting(self):
  95. service = MQTTRelayService()
  96. service.topic_prefix = "home/bb"
  97. client = MagicMock()
  98. order = []
  99. client.will_set.side_effect = lambda *a, **k: order.append("will")
  100. client.connect_async.side_effect = lambda *a, **k: order.append("connect")
  101. with (
  102. patch("backend.app.services.mqtt_relay.mqtt.Client", return_value=client),
  103. patch("backend.app.services.mqtt_relay.asyncio.sleep", new=AsyncMock()),
  104. ):
  105. await service._connect("broker.local", 1883, "", "", False)
  106. client.will_set.assert_called_once()
  107. args, kwargs = client.will_set.call_args
  108. assert args[0] == "home/bb/status"
  109. assert json.loads(args[1]) == {"status": "offline"}
  110. assert kwargs == {"qos": 1, "retain": True}
  111. assert order == ["will", "connect"]