test_vp_mqtt_bridge.py 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952
  1. """Tests for the VP MQTT bridge — non-proxy mirror of target printer state to slicer."""
  2. import asyncio
  3. import json
  4. from pathlib import Path
  5. from unittest.mock import AsyncMock, MagicMock, patch
  6. import pytest
  7. from backend.app.services.virtual_printer.mqtt_bridge import MQTTBridge, _ip_to_uint32_le
  8. from backend.app.services.virtual_printer.mqtt_server import SimpleMQTTServer
  9. H2D_SERIAL = "0948BB540200427"
  10. VP_SERIAL = "09400A391800003"
  11. H2D_IP = "192.168.255.133"
  12. VP_IP = "192.168.255.16"
  13. def _make_server(serial: str = VP_SERIAL, bind_address: str = VP_IP) -> SimpleMQTTServer:
  14. return SimpleMQTTServer(
  15. serial=serial,
  16. access_code="deadbeef",
  17. cert_path=Path("/tmp/unused.crt"), # nosec B108
  18. key_path=Path("/tmp/unused.key"), # nosec B108
  19. model="O1D",
  20. bind_address=bind_address,
  21. )
  22. def _make_paho_client(
  23. serial: str = H2D_SERIAL,
  24. ip: str = H2D_IP,
  25. *,
  26. connected: bool = True,
  27. ) -> MagicMock:
  28. """Build a mock BambuMQTTClient that satisfies MQTTBridge's interface."""
  29. client = MagicMock()
  30. client.serial_number = serial
  31. client.ip_address = ip
  32. client.state = MagicMock()
  33. client.state.connected = connected
  34. client.publish_raw = MagicMock(return_value=True)
  35. client._raw_handlers: list = []
  36. def _register(handler):
  37. client._raw_handlers.append(handler)
  38. def _unregister(handler):
  39. if handler in client._raw_handlers:
  40. client._raw_handlers.remove(handler)
  41. client.register_raw_message_handler.side_effect = _register
  42. client.unregister_raw_message_handler.side_effect = _unregister
  43. # No-op for _request_version / request_status_update so the post-bind nudge doesn't crash.
  44. client._request_version = MagicMock()
  45. client.request_status_update = MagicMock()
  46. return client
  47. def _make_printer_manager(client) -> MagicMock:
  48. pm = MagicMock()
  49. pm.get_client = MagicMock(return_value=client)
  50. return pm
  51. def _make_bridge(server: SimpleMQTTServer, target: MagicMock | None = None) -> MQTTBridge:
  52. target = target if target is not None else _make_paho_client()
  53. pm = _make_printer_manager(target)
  54. return MQTTBridge(
  55. vp_id=1,
  56. vp_name="vp1",
  57. vp_serial=VP_SERIAL,
  58. target_printer_id=42,
  59. mqtt_server=server,
  60. printer_manager=pm,
  61. )
  62. # ---------------------------------------------------------------------------
  63. # Lifecycle
  64. # ---------------------------------------------------------------------------
  65. class TestBridgeLifecycle:
  66. @pytest.mark.asyncio
  67. async def test_start_registers_handler_on_target_client(self):
  68. target = _make_paho_client()
  69. bridge = _make_bridge(_make_server(), target)
  70. await bridge.start()
  71. assert len(target._raw_handlers) == 1
  72. assert bridge.is_active is True
  73. await bridge.stop()
  74. assert len(target._raw_handlers) == 0
  75. @pytest.mark.asyncio
  76. async def test_start_with_no_target_client_does_not_crash(self):
  77. pm = MagicMock()
  78. pm.get_client = MagicMock(return_value=None)
  79. bridge = MQTTBridge(
  80. vp_id=1,
  81. vp_name="vp1",
  82. vp_serial=VP_SERIAL,
  83. target_printer_id=42,
  84. mqtt_server=_make_server(),
  85. printer_manager=pm,
  86. )
  87. await bridge.start()
  88. assert bridge.is_active is False
  89. await bridge.stop()
  90. @pytest.mark.asyncio
  91. async def test_resolve_rebinds_when_paho_client_replaced(self):
  92. """BambuMQTTClient is destroyed and recreated on connect_printer; bridge must rebind."""
  93. old_client = _make_paho_client(serial="REAL_OLD")
  94. new_client = _make_paho_client(serial="REAL_NEW")
  95. pm = _make_printer_manager(old_client)
  96. bridge = MQTTBridge(
  97. vp_id=1,
  98. vp_name="vp1",
  99. vp_serial=VP_SERIAL,
  100. target_printer_id=42,
  101. mqtt_server=_make_server(),
  102. printer_manager=pm,
  103. )
  104. await bridge.start()
  105. assert len(old_client._raw_handlers) == 1
  106. assert bridge._target_serial == "REAL_OLD"
  107. pm.get_client.return_value = new_client
  108. bridge._resolve_client()
  109. assert len(old_client._raw_handlers) == 0
  110. assert len(new_client._raw_handlers) == 1
  111. assert bridge._target_serial == "REAL_NEW"
  112. await bridge.stop()
  113. @pytest.mark.asyncio
  114. async def test_post_bind_nudge_requests_version_and_status(self):
  115. target = _make_paho_client()
  116. bridge = _make_bridge(_make_server(), target)
  117. await bridge.start()
  118. target._request_version.assert_called_once()
  119. target.request_status_update.assert_called_once()
  120. await bridge.stop()
  121. # ---------------------------------------------------------------------------
  122. # Caching: push_status
  123. # ---------------------------------------------------------------------------
  124. class TestPushStatusCache:
  125. """push_status snapshots feed `_send_status_report` via the cache, not a fan-out."""
  126. @pytest.mark.asyncio
  127. async def test_push_status_is_cached_not_fanned_out(self):
  128. server = _make_server()
  129. server.push_raw_to_clients = AsyncMock()
  130. bridge = _make_bridge(server)
  131. await bridge.start()
  132. payload = json.dumps({"print": {"command": "push_status", "ams": {"ams": []}, "gcode_state": "IDLE"}}).encode()
  133. bridge._on_printer_raw(f"device/{H2D_SERIAL}/report", payload)
  134. await asyncio.sleep(0.01)
  135. server.push_raw_to_clients.assert_not_awaited()
  136. cached = bridge.get_latest_print_state()
  137. assert cached is not None
  138. assert cached["command"] == "push_status"
  139. assert cached["gcode_state"] == "IDLE"
  140. await bridge.stop()
  141. @pytest.mark.asyncio
  142. async def test_serial_rewritten_in_cached_push(self):
  143. server = _make_server()
  144. bridge = _make_bridge(server)
  145. await bridge.start()
  146. payload = json.dumps(
  147. {
  148. "print": {
  149. "command": "push_status",
  150. "upgrade_state": {"sn": H2D_SERIAL, "status": "IDLE"},
  151. }
  152. }
  153. ).encode()
  154. bridge._on_printer_raw(f"device/{H2D_SERIAL}/report", payload)
  155. await asyncio.sleep(0.01)
  156. cached = bridge.get_latest_print_state()
  157. assert cached["upgrade_state"]["sn"] == VP_SERIAL
  158. await bridge.stop()
  159. @pytest.mark.asyncio
  160. async def test_net_info_ip_rewritten_to_vp_ip(self):
  161. """BambuStudio reads `net.info[].ip` (LE uint32) for the FTP destination —
  162. must be rewritten to the VP's bind IP or the slicer bypasses the VP."""
  163. server = _make_server(bind_address=VP_IP)
  164. bridge = _make_bridge(server)
  165. await bridge.start()
  166. h2d_le = _ip_to_uint32_le(H2D_IP)
  167. vp_le = _ip_to_uint32_le(VP_IP)
  168. payload = json.dumps(
  169. {
  170. "print": {
  171. "command": "push_status",
  172. "net": {"info": [{"ip": h2d_le, "mask": 0xFFFFFF}, {"ip": 0, "mask": 0}]},
  173. }
  174. }
  175. ).encode()
  176. bridge._on_printer_raw(f"device/{H2D_SERIAL}/report", payload)
  177. await asyncio.sleep(0.01)
  178. cached = bridge.get_latest_print_state()
  179. assert cached["net"]["info"][0]["ip"] == vp_le
  180. assert cached["net"]["info"][1]["ip"] == 0 # untouched
  181. await bridge.stop()
  182. @pytest.mark.asyncio
  183. async def test_request_topic_message_is_ignored(self):
  184. server = _make_server()
  185. bridge = _make_bridge(server)
  186. await bridge.start()
  187. payload = json.dumps({"print": {"command": "push_status"}}).encode()
  188. bridge._on_printer_raw(f"device/{H2D_SERIAL}/request", payload)
  189. await asyncio.sleep(0.01)
  190. assert bridge.get_latest_print_state() is None
  191. await bridge.stop()
  192. @pytest.mark.asyncio
  193. async def test_incremental_push_preserves_ams_from_previous_cache(self):
  194. """Regression for #1371: Bambu firmware sends FULL push_status on
  195. pushall (with AMS/vt_tray/net/etc.) but typically OMITS those fields
  196. from 1 Hz incremental push_status updates. Without preserving the
  197. sticky keys across pushes, the cache forgets AMS info after the first
  198. incremental update, and BambuStudio (which reads the cache via the
  199. VP's 1 Hz status push) sees no AMS info until the user power-cycles
  200. the printer (forcing a fresh pushall).
  201. """
  202. server = _make_server()
  203. bridge = _make_bridge(server)
  204. await bridge.start()
  205. # 1. Initial pushall response with full state, AMS included.
  206. full_push = json.dumps(
  207. {
  208. "print": {
  209. "command": "push_status",
  210. "gcode_state": "IDLE",
  211. "wifi_signal": "-50dBm",
  212. "ams": {
  213. "ams": [
  214. {
  215. "id": "0",
  216. "tray": [
  217. {"id": "0", "tray_type": "PLA", "tray_color": "FF0000FF"},
  218. {"id": "1", "tray_type": "PETG", "tray_color": "00FF00FF"},
  219. ],
  220. }
  221. ],
  222. "tray_exist_bits": "3",
  223. },
  224. "vt_tray": {"id": "254", "tray_type": ""},
  225. "lights_report": [{"node": "chamber_light", "mode": "on"}],
  226. }
  227. }
  228. ).encode()
  229. bridge._on_printer_raw(f"device/{H2D_SERIAL}/report", full_push)
  230. await asyncio.sleep(0.01)
  231. cached = bridge.get_latest_print_state()
  232. assert cached["ams"]["ams"][0]["tray"][0]["tray_type"] == "PLA"
  233. assert cached["vt_tray"]["id"] == "254"
  234. assert cached["lights_report"][0]["mode"] == "on"
  235. # 2. Incremental push with only temp/wifi changes — NO ams field.
  236. # This is what the printer sends every ~1 s between full pushalls.
  237. incremental_push = json.dumps(
  238. {
  239. "print": {
  240. "command": "push_status",
  241. "wifi_signal": "-55dBm",
  242. "chamber_temper": 26.0,
  243. }
  244. }
  245. ).encode()
  246. bridge._on_printer_raw(f"device/{H2D_SERIAL}/report", incremental_push)
  247. await asyncio.sleep(0.01)
  248. cached = bridge.get_latest_print_state()
  249. # New fields take effect.
  250. assert cached["wifi_signal"] == "-55dBm"
  251. assert cached["chamber_temper"] == 26.0
  252. # Sticky fields preserved from the previous cache (the #1371 fix).
  253. assert "ams" in cached, "AMS field must be preserved across incremental pushes (#1371)"
  254. assert cached["ams"]["ams"][0]["tray"][0]["tray_type"] == "PLA"
  255. assert cached["ams"]["tray_exist_bits"] == "3"
  256. assert cached["vt_tray"]["id"] == "254"
  257. assert cached["lights_report"][0]["mode"] == "on"
  258. await bridge.stop()
  259. @pytest.mark.asyncio
  260. async def test_partial_ams_status_update_preserves_unit_list(self):
  261. """#1387: Bambu firmware also sends `ams` updates where the key is
  262. present but the inner `ams` array is missing — e.g. just
  263. ``{ams_status: 1}`` or a humidity change. Before the deep-merge fix
  264. the bridge would overwrite the cached AMS with this stripped blob,
  265. the slicer would read it on the next 1 Hz push, and BambuStudio
  266. would drop the unit list and fall back to its "no AMS" render
  267. (only the external spool visible — the reporter's exact symptom).
  268. Now the partial update only mutates the fields it carries; the
  269. cached unit list survives.
  270. """
  271. server = _make_server()
  272. bridge = _make_bridge(server)
  273. await bridge.start()
  274. # 1. Pushall with full AMS state.
  275. bridge._on_printer_raw(
  276. f"device/{H2D_SERIAL}/report",
  277. json.dumps(
  278. {
  279. "print": {
  280. "command": "push_status",
  281. "ams": {
  282. "ams": [
  283. {
  284. "id": "0",
  285. "humidity": "1",
  286. "tray": [{"id": "0", "tray_type": "PLA", "tray_color": "FF0000FF"}],
  287. }
  288. ],
  289. "tray_exist_bits": "1",
  290. "ams_status": "0",
  291. },
  292. }
  293. }
  294. ).encode(),
  295. )
  296. await asyncio.sleep(0.01)
  297. # 2. Partial AMS update — only `ams_status` and `humidity` changed.
  298. # No `ams.ams` array, so prev's unit list must be preserved.
  299. bridge._on_printer_raw(
  300. f"device/{H2D_SERIAL}/report",
  301. json.dumps(
  302. {
  303. "print": {
  304. "command": "push_status",
  305. "ams": {"ams_status": "1", "humidity": "2"},
  306. }
  307. }
  308. ).encode(),
  309. )
  310. await asyncio.sleep(0.01)
  311. cached = bridge.get_latest_print_state()
  312. # Scalar fields take the new values.
  313. assert cached["ams"]["ams_status"] == "1"
  314. assert cached["ams"]["humidity"] == "2"
  315. # Unit + tray data preserved from the pushall.
  316. assert cached["ams"]["tray_exist_bits"] == "1"
  317. assert len(cached["ams"]["ams"]) == 1
  318. assert cached["ams"]["ams"][0]["tray"][0]["tray_type"] == "PLA"
  319. assert cached["ams"]["ams"][0]["tray"][0]["tray_color"] == "FF0000FF"
  320. await bridge.stop()
  321. @pytest.mark.asyncio
  322. async def test_partial_ams_unit_update_preserves_other_units(self):
  323. """#1387: when multiple AMS units are configured (e.g. H2D with two
  324. AMS), an incremental push during a print typically only carries the
  325. unit / tray that changed state. Naive replacement of `ams.ams` wipes
  326. the other unit. The bridge merges unit-by-unit by id, preserving
  327. units the incremental doesn't mention.
  328. """
  329. server = _make_server()
  330. bridge = _make_bridge(server)
  331. await bridge.start()
  332. # 1. Pushall with two AMS units configured.
  333. bridge._on_printer_raw(
  334. f"device/{H2D_SERIAL}/report",
  335. json.dumps(
  336. {
  337. "print": {
  338. "command": "push_status",
  339. "ams": {
  340. "ams": [
  341. {"id": "0", "tray": [{"id": "0", "tray_type": "PLA"}]},
  342. {"id": "1", "tray": [{"id": "0", "tray_type": "PETG"}]},
  343. ],
  344. "tray_exist_bits": "3",
  345. },
  346. }
  347. }
  348. ).encode(),
  349. )
  350. await asyncio.sleep(0.01)
  351. # 2. Tray-targeted incremental: unit 0 / tray 0 state changed.
  352. # Unit 1 is not in the update — must survive.
  353. bridge._on_printer_raw(
  354. f"device/{H2D_SERIAL}/report",
  355. json.dumps(
  356. {
  357. "print": {
  358. "command": "push_status",
  359. "ams": {"ams": [{"id": "0", "tray": [{"id": "0", "state": "11"}]}]},
  360. }
  361. }
  362. ).encode(),
  363. )
  364. await asyncio.sleep(0.01)
  365. cached = bridge.get_latest_print_state()
  366. units = {u["id"]: u for u in cached["ams"]["ams"]}
  367. # Unit 0 keeps its tray_type from the pushall + picks up the new state.
  368. assert units["0"]["tray"][0]["tray_type"] == "PLA"
  369. assert units["0"]["tray"][0]["state"] == "11"
  370. # Unit 1 survives the incremental.
  371. assert "1" in units
  372. assert units["1"]["tray"][0]["tray_type"] == "PETG"
  373. await bridge.stop()
  374. @pytest.mark.asyncio
  375. async def test_partial_ams_tray_update_preserves_other_trays(self):
  376. """Same shape as the unit-level test but at the tray level. AMS
  377. unit 0 has four trays; the incremental only mentions tray 0.
  378. Trays 1-3 must survive intact."""
  379. server = _make_server()
  380. bridge = _make_bridge(server)
  381. await bridge.start()
  382. bridge._on_printer_raw(
  383. f"device/{H2D_SERIAL}/report",
  384. json.dumps(
  385. {
  386. "print": {
  387. "command": "push_status",
  388. "ams": {
  389. "ams": [
  390. {
  391. "id": "0",
  392. "tray": [
  393. {"id": "0", "tray_type": "PLA", "tray_color": "FF0000FF"},
  394. {"id": "1", "tray_type": "PETG", "tray_color": "00FF00FF"},
  395. {"id": "2", "tray_type": "ABS", "tray_color": "0000FFFF"},
  396. {"id": "3", "tray_type": "TPU", "tray_color": "FFFF00FF"},
  397. ],
  398. }
  399. ],
  400. },
  401. }
  402. }
  403. ).encode(),
  404. )
  405. await asyncio.sleep(0.01)
  406. bridge._on_printer_raw(
  407. f"device/{H2D_SERIAL}/report",
  408. json.dumps(
  409. {
  410. "print": {
  411. "command": "push_status",
  412. "ams": {"ams": [{"id": "0", "tray": [{"id": "0", "state": "11"}]}]},
  413. }
  414. }
  415. ).encode(),
  416. )
  417. await asyncio.sleep(0.01)
  418. cached = bridge.get_latest_print_state()
  419. trays = {t["id"]: t for t in cached["ams"]["ams"][0]["tray"]}
  420. assert trays["0"]["tray_type"] == "PLA"
  421. assert trays["0"]["state"] == "11"
  422. # Trays not mentioned in the incremental survive intact.
  423. assert trays["1"]["tray_type"] == "PETG"
  424. assert trays["2"]["tray_type"] == "ABS"
  425. assert trays["3"]["tray_type"] == "TPU"
  426. await bridge.stop()
  427. @pytest.mark.asyncio
  428. async def test_incoming_ams_update_replaces_cached_ams(self):
  429. """Counterpart to the #1371 fix: preservation only kicks in when the
  430. incoming push OMITS a sticky key. When the printer DOES send a fresh
  431. `ams` value (e.g. on a pushall, or when AMS state genuinely changes),
  432. that value must take effect — the preservation must not shadow real
  433. updates.
  434. """
  435. server = _make_server()
  436. bridge = _make_bridge(server)
  437. await bridge.start()
  438. # 1. Initial state: PLA in tray 0.
  439. bridge._on_printer_raw(
  440. f"device/{H2D_SERIAL}/report",
  441. json.dumps(
  442. {
  443. "print": {
  444. "command": "push_status",
  445. "ams": {"ams": [{"id": "0", "tray": [{"id": "0", "tray_type": "PLA"}]}]},
  446. }
  447. }
  448. ).encode(),
  449. )
  450. await asyncio.sleep(0.01)
  451. # 2. Fresh push with PETG — must replace, not get shadowed by the old PLA.
  452. bridge._on_printer_raw(
  453. f"device/{H2D_SERIAL}/report",
  454. json.dumps(
  455. {
  456. "print": {
  457. "command": "push_status",
  458. "ams": {"ams": [{"id": "0", "tray": [{"id": "0", "tray_type": "PETG"}]}]},
  459. }
  460. }
  461. ).encode(),
  462. )
  463. await asyncio.sleep(0.01)
  464. cached = bridge.get_latest_print_state()
  465. assert cached["ams"]["ams"][0]["tray"][0]["tray_type"] == "PETG"
  466. await bridge.stop()
  467. # ---------------------------------------------------------------------------
  468. # Caching: get_version response
  469. # ---------------------------------------------------------------------------
  470. class TestVersionCache:
  471. @pytest.mark.asyncio
  472. async def test_get_version_response_caches_modules(self):
  473. server = _make_server()
  474. bridge = _make_bridge(server)
  475. await bridge.start()
  476. payload = json.dumps(
  477. {
  478. "info": {
  479. "command": "get_version",
  480. "module": [
  481. {"name": "ota", "sn": H2D_SERIAL, "sw_ver": "01.03.00.00"},
  482. {"name": "n3f/0", "sn": "AMS_HW_1", "sw_ver": "04.00.21.87"},
  483. ],
  484. }
  485. }
  486. ).encode()
  487. bridge._on_printer_raw(f"device/{H2D_SERIAL}/report", payload)
  488. await asyncio.sleep(0.01)
  489. modules = bridge.get_latest_version_modules()
  490. assert modules is not None
  491. assert len(modules) == 2
  492. # Device-level sn rewritten; AMS-hardware sn left alone.
  493. assert modules[0]["sn"] == VP_SERIAL
  494. assert modules[1]["sn"] == "AMS_HW_1"
  495. await bridge.stop()
  496. # ---------------------------------------------------------------------------
  497. # Selective fan-out (everything that's not push_status / get_version)
  498. # ---------------------------------------------------------------------------
  499. class TestCommandResponseFanout:
  500. @pytest.mark.asyncio
  501. async def test_extrusion_cali_get_response_is_fanned_out(self):
  502. """Slicer's extrusion_cali_get goes to the printer; the printer's response
  503. must reach the slicer or BambuStudio's pre-flight blocks Send."""
  504. server = _make_server()
  505. server.push_raw_to_clients = AsyncMock()
  506. bridge = _make_bridge(server)
  507. await bridge.start()
  508. body = json.dumps({"print": {"command": "extrusion_cali_get", "filaments": []}}).encode()
  509. bridge._on_printer_raw(f"device/{H2D_SERIAL}/report", body)
  510. await asyncio.sleep(0.01)
  511. server.push_raw_to_clients.assert_awaited_once()
  512. topic, _payload = server.push_raw_to_clients.await_args.args
  513. assert topic == f"device/{VP_SERIAL}/report"
  514. await bridge.stop()
  515. # ---------------------------------------------------------------------------
  516. # Forwarding: slicer → printer
  517. # ---------------------------------------------------------------------------
  518. class TestForwardToPrinter:
  519. @pytest.mark.asyncio
  520. async def test_forward_publishes_to_real_serial_request_topic(self):
  521. target = _make_paho_client()
  522. bridge = _make_bridge(_make_server(), target)
  523. await bridge.start()
  524. ok = bridge.forward_to_printer({"print": {"command": "stop"}})
  525. assert ok is True
  526. target.publish_raw.assert_called_once()
  527. topic, payload = target.publish_raw.call_args.args
  528. assert topic == f"device/{H2D_SERIAL}/request"
  529. assert json.loads(payload) == {"print": {"command": "stop"}}
  530. await bridge.stop()
  531. @pytest.mark.asyncio
  532. async def test_forward_returns_false_when_not_bound(self):
  533. pm = MagicMock()
  534. pm.get_client = MagicMock(return_value=None)
  535. bridge = MQTTBridge(
  536. vp_id=1,
  537. vp_name="vp1",
  538. vp_serial=VP_SERIAL,
  539. target_printer_id=42,
  540. mqtt_server=_make_server(),
  541. printer_manager=pm,
  542. )
  543. await bridge.start()
  544. assert bridge.forward_to_printer({"print": {"command": "stop"}}) is False
  545. await bridge.stop()
  546. # ---------------------------------------------------------------------------
  547. # SimpleMQTTServer status response: cached-as-base
  548. # ---------------------------------------------------------------------------
  549. class TestStatusReportCachedAsBase:
  550. """`_send_status_report` sends near-byte-identical real data when bridge cache exists."""
  551. def _capture_published(self, server: SimpleMQTTServer):
  552. """Wrap _publish_to_report to capture (topic, payload_dict)."""
  553. published: list = []
  554. async def _capture(writer, payload, serial=""):
  555. published.append((serial or server.serial, payload))
  556. server._publish_to_report = _capture # type: ignore[assignment]
  557. return published
  558. @pytest.mark.asyncio
  559. async def test_uses_real_cache_when_bridge_active(self):
  560. server = _make_server()
  561. bridge = MagicMock()
  562. bridge.get_latest_print_state.return_value = {
  563. "command": "push_status",
  564. "msg": 0,
  565. "ams": {"ams": [{"id": "0"}]},
  566. "device": {"extruder": {"info": [{"id": 0}, {"id": 1}]}},
  567. "nozzle_diameter": "0.4",
  568. "nozzle_type": "HH01", # real H2D value, not synthetic 'hardened_steel'
  569. }
  570. server.set_bridge(bridge)
  571. published = self._capture_published(server)
  572. await server._send_status_report(MagicMock())
  573. assert len(published) == 1
  574. _serial, payload = published[0]
  575. # AMS / device / nozzle_type all from cache
  576. assert payload["print"]["nozzle_type"] == "HH01"
  577. assert payload["print"]["device"]["extruder"]["info"][1]["id"] == 1
  578. # Protocol fields under our control
  579. assert payload["print"]["command"] == "push_status"
  580. assert payload["print"]["gcode_state"] == "IDLE"
  581. @pytest.mark.asyncio
  582. async def test_falls_back_to_synthetic_when_no_cache(self):
  583. server = _make_server()
  584. bridge = MagicMock()
  585. bridge.get_latest_print_state.return_value = None
  586. server.set_bridge(bridge)
  587. published = self._capture_published(server)
  588. await server._send_status_report(MagicMock())
  589. assert len(published) == 1
  590. _serial, payload = published[0]
  591. # Synthetic baseline has stub fields like nozzle_type='hardened_steel'
  592. # and a `storage` field that the real H2D doesn't push.
  593. assert payload["print"]["nozzle_type"] == "hardened_steel"
  594. assert "storage" in payload["print"]
  595. @pytest.mark.asyncio
  596. async def test_storage_indicators_overlaid_for_send_preflight(self):
  597. """#1228: P1S/A1-class firmware doesn't always include the SD/storage
  598. fields BambuStudio's "Send" pre-flight reads. Without these the
  599. slicer rejects with 'storage needs to be inserted' before even
  600. attempting FTP. The cached-as-base path now overlays them so the
  601. pre-flight passes regardless of what the real printer reports.
  602. """
  603. server = _make_server()
  604. bridge = MagicMock()
  605. # Real P1S push without SD card inserted: home_flag has other bits set
  606. # but the SD bit (0x100) is clear; sdcard is False; no storage field.
  607. bridge.get_latest_print_state.return_value = {
  608. "command": "push_status",
  609. "msg": 0,
  610. "home_flag": 0x42,
  611. "sdcard": False,
  612. }
  613. server.set_bridge(bridge)
  614. published = self._capture_published(server)
  615. await server._send_status_report(MagicMock())
  616. _serial, payload = published[0]
  617. # SD bit ORed onto whatever was there — other bits preserved.
  618. assert payload["print"]["home_flag"] & 0x100 == 0x100
  619. assert payload["print"]["home_flag"] & 0x42 == 0x42
  620. # Force-set so a False from the printer doesn't trip the pre-flight.
  621. assert payload["print"]["sdcard"] is True
  622. # storage was missing — the overlay must inject a non-empty default.
  623. assert "storage" in payload["print"]
  624. assert payload["print"]["storage"]["free"] > 0
  625. assert payload["print"]["storage"]["total"] > 0
  626. @pytest.mark.asyncio
  627. async def test_storage_indicators_preserve_real_storage_when_present(self):
  628. """When the real printer DOES report a storage block, pass it through
  629. unchanged (the overlay only fills in the missing field, not overrides).
  630. """
  631. server = _make_server()
  632. bridge = MagicMock()
  633. real_storage = {"free": 12345, "total": 67890}
  634. bridge.get_latest_print_state.return_value = {
  635. "command": "push_status",
  636. "msg": 0,
  637. "home_flag": 0x100, # SD bit already set on the real printer
  638. "sdcard": True,
  639. "storage": real_storage,
  640. }
  641. server.set_bridge(bridge)
  642. published = self._capture_published(server)
  643. await server._send_status_report(MagicMock())
  644. _serial, payload = published[0]
  645. # SD bit OR is idempotent — already-set bit stays set.
  646. assert payload["print"]["home_flag"] == 0x100
  647. assert payload["print"]["sdcard"] is True
  648. # Real values pass through, NOT the synthetic defaults.
  649. assert payload["print"]["storage"] == real_storage
  650. @pytest.mark.asyncio
  651. async def test_overrides_protocol_fields_even_when_cache_present(self):
  652. """Cached value's gcode_state must NOT win over our local upload-state-machine value."""
  653. server = _make_server()
  654. server._gcode_state = "PREPARE"
  655. server._current_file = "foo.3mf"
  656. bridge = MagicMock()
  657. bridge.get_latest_print_state.return_value = {
  658. "command": "push_status",
  659. "gcode_state": "IDLE", # printer is idle; we are mid-FTP-upload
  660. "gcode_file": "",
  661. "gcode_file_prepare_percent": "0",
  662. }
  663. server.set_bridge(bridge)
  664. published = self._capture_published(server)
  665. await server._send_status_report(MagicMock())
  666. _serial, payload = published[0]
  667. assert payload["print"]["gcode_state"] == "PREPARE"
  668. assert payload["print"]["gcode_file"] == "foo.3mf"
  669. # ---------------------------------------------------------------------------
  670. # Wire format
  671. # ---------------------------------------------------------------------------
  672. class TestWireFormat:
  673. """BambuStudio's Send pre-flight rejects compact JSON — must match real printer's
  674. indented format (32K bytes for an idle H2D vs 14K compact)."""
  675. @pytest.mark.asyncio
  676. async def test_publish_uses_indent_4_json_format(self):
  677. server = _make_server()
  678. captured: list = []
  679. async def _capture_drain():
  680. pass
  681. writer = MagicMock()
  682. writer.write = lambda data: captured.append(data)
  683. writer.drain = AsyncMock()
  684. await server._publish_to_report(writer, {"print": {"command": "push_status", "ams": {}}})
  685. body = b"".join(captured)
  686. assert b'\n "print"' in body, "publish_to_report must use indent=4 JSON"
  687. # ---------------------------------------------------------------------------
  688. # Routing: _handle_publish
  689. # ---------------------------------------------------------------------------
  690. class TestPublishRouting:
  691. """Slicer-issued commands: project_file/gcode_file handled locally, everything
  692. else forwarded to the real printer."""
  693. def _build_publish_payload(self, topic: str, body: bytes) -> bytes:
  694. topic_bytes = topic.encode("utf-8")
  695. return bytes([len(topic_bytes) >> 8, len(topic_bytes) & 0xFF]) + topic_bytes + body
  696. def _attach_active_bridge(self, server: SimpleMQTTServer) -> MagicMock:
  697. bridge = MagicMock()
  698. bridge.is_active = True
  699. bridge.forward_to_printer = MagicMock(return_value=True)
  700. server.set_bridge(bridge)
  701. return bridge
  702. @pytest.mark.asyncio
  703. async def test_project_file_handled_locally_not_forwarded(self):
  704. server = _make_server()
  705. bridge = self._attach_active_bridge(server)
  706. writer = MagicMock()
  707. writer.write = MagicMock()
  708. writer.drain = AsyncMock()
  709. body = json.dumps({"print": {"command": "project_file", "subtask_name": "f", "sequence_id": "1"}}).encode()
  710. payload = self._build_publish_payload(f"device/{VP_SERIAL}/request", body)
  711. with patch.object(server, "_send_print_response", new=AsyncMock()) as mock_resp:
  712. await server._handle_publish(0x30, payload, writer, "client1")
  713. bridge.forward_to_printer.assert_not_called()
  714. mock_resp.assert_awaited_once()
  715. @pytest.mark.asyncio
  716. async def test_gcode_file_handled_locally_not_forwarded(self):
  717. server = _make_server()
  718. bridge = self._attach_active_bridge(server)
  719. writer = MagicMock()
  720. writer.write = MagicMock()
  721. writer.drain = AsyncMock()
  722. body = json.dumps({"print": {"command": "gcode_file", "subtask_name": "f.gcode", "sequence_id": "1"}}).encode()
  723. payload = self._build_publish_payload(f"device/{VP_SERIAL}/request", body)
  724. with patch.object(server, "_send_print_response", new=AsyncMock()):
  725. await server._handle_publish(0x30, payload, writer, "client1")
  726. bridge.forward_to_printer.assert_not_called()
  727. @pytest.mark.asyncio
  728. async def test_pushall_handled_locally_not_forwarded(self):
  729. server = _make_server()
  730. bridge = self._attach_active_bridge(server)
  731. writer = MagicMock()
  732. writer.write = MagicMock()
  733. writer.drain = AsyncMock()
  734. body = json.dumps({"pushing": {"command": "pushall", "sequence_id": "0"}}).encode()
  735. payload = self._build_publish_payload(f"device/{VP_SERIAL}/request", body)
  736. with patch.object(server, "_send_status_report", new=AsyncMock()) as mock_status:
  737. await server._handle_publish(0x30, payload, writer, "client1")
  738. # Synthetic answer fires (fast, low latency); no forwarding (the
  739. # cache already mirrors what the printer would respond with).
  740. bridge.forward_to_printer.assert_not_called()
  741. mock_status.assert_awaited_once()
  742. @pytest.mark.asyncio
  743. async def test_get_version_handled_locally_not_forwarded(self):
  744. server = _make_server()
  745. bridge = self._attach_active_bridge(server)
  746. writer = MagicMock()
  747. writer.write = MagicMock()
  748. writer.drain = AsyncMock()
  749. body = json.dumps({"info": {"command": "get_version", "sequence_id": "1"}}).encode()
  750. payload = self._build_publish_payload(f"device/{VP_SERIAL}/request", body)
  751. with patch.object(server, "_send_version_response", new=AsyncMock()) as mock_ver:
  752. await server._handle_publish(0x30, payload, writer, "client1")
  753. bridge.forward_to_printer.assert_not_called()
  754. mock_ver.assert_awaited_once()
  755. @pytest.mark.asyncio
  756. async def test_extrusion_cali_get_is_forwarded(self):
  757. """extrusion_cali_get fetches per-filament k-profiles — must reach the printer."""
  758. server = _make_server()
  759. bridge = self._attach_active_bridge(server)
  760. writer = MagicMock()
  761. writer.write = MagicMock()
  762. writer.drain = AsyncMock()
  763. body = json.dumps(
  764. {
  765. "print": {
  766. "command": "extrusion_cali_get",
  767. "filament_id": "",
  768. "nozzle_diameter": "0.4",
  769. "sequence_id": "5",
  770. }
  771. }
  772. ).encode()
  773. payload = self._build_publish_payload(f"device/{VP_SERIAL}/request", body)
  774. await server._handle_publish(0x30, payload, writer, "client1")
  775. bridge.forward_to_printer.assert_called_once()
  776. forwarded = bridge.forward_to_printer.call_args.args[0]
  777. assert forwarded["print"]["command"] == "extrusion_cali_get"
  778. @pytest.mark.asyncio
  779. async def test_print_stop_is_forwarded(self):
  780. server = _make_server()
  781. bridge = self._attach_active_bridge(server)
  782. writer = MagicMock()
  783. writer.write = MagicMock()
  784. writer.drain = AsyncMock()
  785. body = json.dumps({"print": {"command": "stop", "sequence_id": "5"}}).encode()
  786. payload = self._build_publish_payload(f"device/{VP_SERIAL}/request", body)
  787. await server._handle_publish(0x30, payload, writer, "client1")
  788. bridge.forward_to_printer.assert_called_once()
  789. # ---------------------------------------------------------------------------
  790. # IP encoding helper
  791. # ---------------------------------------------------------------------------
  792. class TestIpEncoding:
  793. def test_le_uint32_matches_real_h2d_capture(self):
  794. # 192.168.255.133 captured from real H2D's net.info[0].ip = 2248124608
  795. assert _ip_to_uint32_le("192.168.255.133") == 2248124608
  796. def test_vp_ip_round_trip(self):
  797. assert _ip_to_uint32_le("192.168.255.16") == 285190336
  798. def test_invalid_ip_raises(self):
  799. with pytest.raises(ValueError):
  800. _ip_to_uint32_le("not.an.ip.actually")