test_printer_manager.py 87 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202
  1. """Unit tests for PrinterManager service.
  2. Tests printer connection management, status tracking, and print control.
  3. """
  4. import logging
  5. from unittest.mock import AsyncMock, MagicMock, patch
  6. import pytest
  7. from backend.app.services.printer_manager import (
  8. PrinterManager,
  9. display_temperatures,
  10. drying_screen_only,
  11. get_derived_status_name,
  12. has_stg_cur_idle_bug,
  13. init_printer_connections,
  14. parse_plate_id,
  15. printer_state_to_dict,
  16. supports_chamber_temp,
  17. supports_drying,
  18. supports_drying_while_printing,
  19. )
  20. class TestPrinterManager:
  21. """Tests for PrinterManager class."""
  22. @pytest.fixture
  23. def manager(self):
  24. """Create a fresh PrinterManager instance."""
  25. return PrinterManager()
  26. @pytest.fixture
  27. def mock_printer(self):
  28. """Create a mock Printer object."""
  29. printer = MagicMock()
  30. printer.id = 1
  31. printer.ip_address = "192.168.1.100"
  32. printer.serial_number = "00M09A123456789"
  33. printer.access_code = "12345678"
  34. printer.is_active = True
  35. return printer
  36. @pytest.fixture
  37. def mock_client(self):
  38. """Create a mock BambuMQTTClient."""
  39. client = MagicMock()
  40. client.state = MagicMock()
  41. client.state.connected = True
  42. client.state.state = "IDLE"
  43. client.state.progress = 0
  44. client.state.temperatures = {"nozzle": 25, "bed": 25}
  45. client.state.raw_data = {}
  46. client.logging_enabled = False
  47. # mark_power_off is real logic on BambuMQTTClient (#2629) — mirror it so
  48. # the manager tests still exercise the state transition they assert on.
  49. # The real implementation (and its recovery path) is covered in
  50. # test_bambu_mqtt.py::TestPresumedPowerOffRecovery.
  51. def _mark_power_off():
  52. if not client.state.connected:
  53. return False
  54. client.state.connected = False
  55. client.state.state = "unknown"
  56. return True
  57. client.mark_power_off.side_effect = _mark_power_off
  58. return client
  59. # ========================================================================
  60. # Tests for initialization
  61. # ========================================================================
  62. def test_init_creates_empty_clients_dict(self, manager):
  63. """Verify manager initializes with empty clients dict."""
  64. assert manager._clients == {}
  65. def test_init_callbacks_are_none(self, manager):
  66. """Verify all callbacks are initially None."""
  67. assert manager._on_print_start is None
  68. assert manager._on_print_complete is None
  69. assert manager._on_status_change is None
  70. assert manager._on_ams_change is None
  71. def test_init_loop_is_none(self, manager):
  72. """Verify event loop is initially None."""
  73. assert manager._loop is None
  74. # ========================================================================
  75. # Tests for callback setters
  76. # ========================================================================
  77. def test_set_event_loop(self, manager):
  78. """Verify event loop can be set."""
  79. mock_loop = MagicMock()
  80. manager.set_event_loop(mock_loop)
  81. assert manager._loop == mock_loop
  82. def test_set_print_start_callback(self, manager):
  83. """Verify print start callback can be set."""
  84. callback = MagicMock()
  85. manager.set_print_start_callback(callback)
  86. assert manager._on_print_start == callback
  87. def test_set_print_complete_callback(self, manager):
  88. """Verify print complete callback can be set."""
  89. callback = MagicMock()
  90. manager.set_print_complete_callback(callback)
  91. assert manager._on_print_complete == callback
  92. def test_set_status_change_callback(self, manager):
  93. """Verify status change callback can be set."""
  94. callback = MagicMock()
  95. manager.set_status_change_callback(callback)
  96. assert manager._on_status_change == callback
  97. def test_set_ams_change_callback(self, manager):
  98. """Verify AMS change callback can be set."""
  99. callback = MagicMock()
  100. manager.set_ams_change_callback(callback)
  101. assert manager._on_ams_change == callback
  102. # ========================================================================
  103. # Tests for _schedule_async
  104. # ========================================================================
  105. def test_schedule_async_with_running_loop(self, manager):
  106. """Verify async coroutine is scheduled when loop is running."""
  107. mock_loop = MagicMock()
  108. mock_loop.is_running.return_value = True
  109. manager._loop = mock_loop
  110. async def dummy_coro():
  111. pass
  112. coro = dummy_coro()
  113. manager._schedule_async(coro)
  114. mock_loop.is_running.assert_called_once()
  115. # Clean up the coroutine
  116. coro.close()
  117. def test_schedule_async_without_loop(self, manager):
  118. """Verify nothing happens when no loop is set."""
  119. async def dummy_coro():
  120. pass
  121. coro = dummy_coro()
  122. # Should not raise
  123. manager._schedule_async(coro)
  124. coro.close()
  125. def test_schedule_async_with_stopped_loop(self, manager):
  126. """Verify nothing happens when loop is not running."""
  127. mock_loop = MagicMock()
  128. mock_loop.is_running.return_value = False
  129. manager._loop = mock_loop
  130. async def dummy_coro():
  131. pass
  132. coro = dummy_coro()
  133. manager._schedule_async(coro)
  134. coro.close()
  135. # ========================================================================
  136. # Tests for connect_printer
  137. # ========================================================================
  138. @pytest.mark.asyncio
  139. async def test_connect_printer_creates_client(self, manager, mock_printer):
  140. """Verify connecting creates an MQTT client."""
  141. with patch("backend.app.services.printer_manager.BambuMQTTClient") as MockClient:
  142. mock_instance = MagicMock()
  143. mock_instance.state = MagicMock()
  144. mock_instance.state.connected = True
  145. MockClient.return_value = mock_instance
  146. result = await manager.connect_printer(mock_printer)
  147. MockClient.assert_called_once()
  148. mock_instance.connect.assert_called_once()
  149. assert mock_printer.id in manager._clients
  150. assert result is True
  151. @pytest.mark.asyncio
  152. async def test_connect_printer_disconnects_existing(self, manager, mock_printer, mock_client):
  153. """Verify connecting disconnects existing client first."""
  154. manager._clients[mock_printer.id] = mock_client
  155. with patch("backend.app.services.printer_manager.BambuMQTTClient") as MockClient:
  156. new_client = MagicMock()
  157. new_client.state = MagicMock()
  158. new_client.state.connected = True
  159. MockClient.return_value = new_client
  160. await manager.connect_printer(mock_printer)
  161. mock_client.disconnect.assert_called_once()
  162. @pytest.mark.asyncio
  163. async def test_connect_printer_returns_false_on_failure(self, manager, mock_printer):
  164. """Verify returns False when connection fails."""
  165. with patch("backend.app.services.printer_manager.BambuMQTTClient") as MockClient:
  166. mock_instance = MagicMock()
  167. mock_instance.state = MagicMock()
  168. mock_instance.state.connected = False
  169. MockClient.return_value = mock_instance
  170. result = await manager.connect_printer(mock_printer)
  171. assert result is False
  172. # ========================================================================
  173. # Tests for disconnect_printer
  174. # ========================================================================
  175. def test_disconnect_printer_removes_client(self, manager, mock_client):
  176. """Verify disconnecting removes and disconnects client."""
  177. manager._clients[1] = mock_client
  178. manager.disconnect_printer(1)
  179. mock_client.disconnect.assert_called_once()
  180. assert 1 not in manager._clients
  181. def test_disconnect_printer_handles_missing(self, manager):
  182. """Verify disconnecting non-existent printer doesn't raise."""
  183. manager.disconnect_printer(999) # Should not raise
  184. # ========================================================================
  185. # Tests for disconnect_all
  186. # ========================================================================
  187. def test_disconnect_all_disconnects_all_clients(self, manager):
  188. """Verify all clients are disconnected."""
  189. client1 = MagicMock()
  190. client2 = MagicMock()
  191. manager._clients[1] = client1
  192. manager._clients[2] = client2
  193. manager.disconnect_all()
  194. client1.disconnect.assert_called_once()
  195. client2.disconnect.assert_called_once()
  196. assert len(manager._clients) == 0
  197. # ========================================================================
  198. # Tests for get_status
  199. # ========================================================================
  200. def test_get_status_returns_state(self, manager, mock_client):
  201. """Verify get_status returns client state."""
  202. manager._clients[1] = mock_client
  203. result = manager.get_status(1)
  204. mock_client.check_staleness.assert_called_once()
  205. assert result == mock_client.state
  206. def test_get_status_returns_none_for_unknown(self, manager):
  207. """Verify get_status returns None for unknown printer."""
  208. result = manager.get_status(999)
  209. assert result is None
  210. # ========================================================================
  211. # Tests for get_all_statuses
  212. # ========================================================================
  213. def test_get_all_statuses_returns_all(self, manager):
  214. """Verify all statuses are returned."""
  215. client1 = MagicMock()
  216. client1.state = MagicMock(connected=True)
  217. client2 = MagicMock()
  218. client2.state = MagicMock(connected=False)
  219. manager._clients[1] = client1
  220. manager._clients[2] = client2
  221. result = manager.get_all_statuses()
  222. assert len(result) == 2
  223. assert 1 in result
  224. assert 2 in result
  225. client1.check_staleness.assert_called_once()
  226. client2.check_staleness.assert_called_once()
  227. # ========================================================================
  228. # Tests for is_connected
  229. # ========================================================================
  230. def test_is_connected_returns_true(self, manager, mock_client):
  231. """Verify is_connected returns True for connected printer."""
  232. mock_client.check_staleness.return_value = True
  233. manager._clients[1] = mock_client
  234. result = manager.is_connected(1)
  235. assert result is True
  236. def test_is_connected_returns_false_for_unknown(self, manager):
  237. """Verify is_connected returns False for unknown printer."""
  238. result = manager.is_connected(999)
  239. assert result is False
  240. # ========================================================================
  241. # Tests for get_client
  242. # ========================================================================
  243. def test_get_client_returns_client(self, manager, mock_client):
  244. """Verify get_client returns the client."""
  245. manager._clients[1] = mock_client
  246. result = manager.get_client(1)
  247. assert result == mock_client
  248. def test_get_client_returns_none_for_unknown(self, manager):
  249. """Verify get_client returns None for unknown printer."""
  250. result = manager.get_client(999)
  251. assert result is None
  252. # ========================================================================
  253. # Tests for mark_printer_offline
  254. # ========================================================================
  255. def test_mark_printer_offline_updates_state(self, manager, mock_client):
  256. """Verify mark_printer_offline updates client state."""
  257. mock_client.state.connected = True
  258. manager._clients[1] = mock_client
  259. manager.mark_printer_offline(1)
  260. assert mock_client.state.connected is False
  261. assert mock_client.state.state == "unknown"
  262. def test_mark_printer_offline_triggers_callback(self, manager, mock_client):
  263. """Verify mark_printer_offline triggers status callback."""
  264. mock_client.state.connected = True
  265. manager._clients[1] = mock_client
  266. # Callback must return a coroutine
  267. async def async_callback(printer_id, state):
  268. pass
  269. manager._on_status_change = async_callback
  270. # Need a running loop for callback
  271. mock_loop = MagicMock()
  272. mock_loop.is_running.return_value = True
  273. manager._loop = mock_loop
  274. manager.mark_printer_offline(1)
  275. # Callback should be scheduled via run_coroutine_threadsafe
  276. mock_loop.is_running.assert_called()
  277. # State should be updated
  278. assert mock_client.state.connected is False
  279. def test_mark_printer_offline_handles_unknown(self, manager):
  280. """Verify mark_printer_offline handles unknown printer."""
  281. manager.mark_printer_offline(999) # Should not raise
  282. def test_mark_printer_offline_skips_already_offline(self, manager, mock_client):
  283. """Verify mark_printer_offline skips already offline printer."""
  284. mock_client.state.connected = False
  285. manager._clients[1] = mock_client
  286. manager.mark_printer_offline(1)
  287. # State should remain unchanged
  288. assert mock_client.state.connected is False
  289. # ========================================================================
  290. # Tests for start_print
  291. # ========================================================================
  292. def test_start_print_calls_client(self, manager, mock_client):
  293. """Verify start_print calls client method."""
  294. mock_client.start_print.return_value = True
  295. manager._clients[1] = mock_client
  296. result = manager.start_print(1, "test.gcode")
  297. mock_client.start_print.assert_called_once_with(
  298. "test.gcode",
  299. 1,
  300. ams_mapping=None,
  301. timelapse=False,
  302. bed_levelling="auto",
  303. flow_cali="auto",
  304. vibration_cali=True,
  305. layer_inspect=False,
  306. use_ams=True,
  307. nozzle_offset_cali="auto",
  308. nozzle_mapping=None,
  309. nozzle_slot_extruders=None,
  310. )
  311. assert result is True
  312. def test_start_print_returns_false_for_unknown(self, manager):
  313. """Verify start_print returns False for unknown printer."""
  314. result = manager.start_print(999, "test.gcode")
  315. assert result is False
  316. def test_start_print_logs_print_command_with_caller(self, manager, mock_client, caplog):
  317. """Verify start_print logs PRINT COMMAND with caller info (#374)."""
  318. mock_client.start_print.return_value = True
  319. manager._clients[1] = mock_client
  320. with caplog.at_level(logging.INFO, logger="backend.app.services.printer_manager"):
  321. manager.start_print(1, "benchy.3mf")
  322. print_cmd_logs = [r for r in caplog.records if "PRINT COMMAND" in r.message]
  323. assert len(print_cmd_logs) == 1
  324. log_msg = print_cmd_logs[0].message
  325. assert "printer=1" in log_msg
  326. assert "file=benchy.3mf" in log_msg
  327. assert "caller=" in log_msg
  328. def test_start_print_logs_even_when_printer_unknown(self, manager, caplog):
  329. """Verify PRINT COMMAND is logged even for unknown printers (#374)."""
  330. with caplog.at_level(logging.INFO, logger="backend.app.services.printer_manager"):
  331. result = manager.start_print(999, "ghost.3mf")
  332. assert result is False
  333. print_cmd_logs = [r for r in caplog.records if "PRINT COMMAND" in r.message]
  334. assert len(print_cmd_logs) == 1
  335. # ========================================================================
  336. # Tests for stop_print
  337. # ========================================================================
  338. def test_stop_print_calls_client(self, manager, mock_client):
  339. """Verify stop_print calls client method."""
  340. mock_client.stop_print.return_value = True
  341. manager._clients[1] = mock_client
  342. result = manager.stop_print(1)
  343. mock_client.stop_print.assert_called_once()
  344. assert result is True
  345. def test_stop_print_returns_false_for_unknown(self, manager):
  346. """Verify stop_print returns False for unknown printer."""
  347. result = manager.stop_print(999)
  348. assert result is False
  349. # ========================================================================
  350. # Tests for wait_for_cooldown
  351. # ========================================================================
  352. @pytest.mark.asyncio
  353. async def test_wait_for_cooldown_returns_true_when_cool(self, manager, mock_client):
  354. """Verify wait_for_cooldown returns True when printer is cool."""
  355. mock_client.state.connected = True
  356. mock_client.state.temperatures = {"nozzle": 40, "bed": 30}
  357. mock_client.check_staleness.return_value = True
  358. manager._clients[1] = mock_client
  359. result = await manager.wait_for_cooldown(1, target_temp=50)
  360. assert result is True
  361. @pytest.mark.asyncio
  362. async def test_wait_for_cooldown_returns_false_on_disconnect(self, manager, mock_client):
  363. """Verify wait_for_cooldown returns False when printer disconnects."""
  364. mock_client.state.connected = False
  365. mock_client.check_staleness.return_value = False
  366. manager._clients[1] = mock_client
  367. result = await manager.wait_for_cooldown(1, target_temp=50, timeout=1)
  368. assert result is False
  369. @pytest.mark.asyncio
  370. async def test_wait_for_cooldown_returns_false_for_unknown(self, manager):
  371. """Verify wait_for_cooldown returns False for unknown printer."""
  372. result = await manager.wait_for_cooldown(999, target_temp=50, timeout=1)
  373. assert result is False
  374. @pytest.mark.asyncio
  375. async def test_wait_for_cooldown_checks_both_nozzles(self, manager, mock_client):
  376. """Verify wait_for_cooldown checks both nozzles for dual extruders."""
  377. mock_client.state.connected = True
  378. mock_client.state.temperatures = {"nozzle": 40, "nozzle_2": 45, "bed": 30}
  379. mock_client.check_staleness.return_value = True
  380. manager._clients[1] = mock_client
  381. result = await manager.wait_for_cooldown(1, target_temp=50)
  382. assert result is True
  383. # ========================================================================
  384. # Tests for is_print_active (#1890)
  385. # ========================================================================
  386. @pytest.mark.parametrize(
  387. "state,expected",
  388. [
  389. ("RUNNING", True),
  390. ("PAUSE", True),
  391. ("PREPARE", True),
  392. ("SLICING", True),
  393. ("FINISH", False),
  394. ("IDLE", False),
  395. ("FAILED", False),
  396. ("unknown", False),
  397. ],
  398. )
  399. def test_is_print_active_state_matrix(self, manager, mock_client, state, expected):
  400. """A job-loaded state is 'active'; idle/terminal states are not."""
  401. mock_client.state.connected = True
  402. mock_client.state.state = state
  403. mock_client.check_staleness.return_value = True
  404. manager._clients[1] = mock_client
  405. assert manager.is_print_active(1) is expected
  406. def test_is_print_active_false_when_disconnected(self, manager, mock_client):
  407. """Even in RUNNING, a disconnected printer is not treated as active —
  408. we fail safe (no active print) only for the 'nothing printing' cases."""
  409. mock_client.state.connected = False
  410. mock_client.state.state = "RUNNING"
  411. mock_client.check_staleness.return_value = False
  412. manager._clients[1] = mock_client
  413. assert manager.is_print_active(1) is False
  414. def test_is_print_active_false_for_unknown_printer(self, manager):
  415. """Unknown printer id → not active (no client)."""
  416. assert manager.is_print_active(999) is False
  417. # ========================================================================
  418. # Tests for logging methods
  419. # ========================================================================
  420. def test_enable_logging_calls_client(self, manager, mock_client):
  421. """Verify enable_logging calls client method."""
  422. manager._clients[1] = mock_client
  423. result = manager.enable_logging(1, True)
  424. mock_client.enable_logging.assert_called_once_with(True)
  425. assert result is True
  426. def test_enable_logging_returns_false_for_unknown(self, manager):
  427. """Verify enable_logging returns False for unknown printer."""
  428. result = manager.enable_logging(999, True)
  429. assert result is False
  430. def test_get_logs_returns_logs(self, manager, mock_client):
  431. """Verify get_logs returns client logs."""
  432. mock_logs = [MagicMock(), MagicMock()]
  433. mock_client.get_logs.return_value = mock_logs
  434. manager._clients[1] = mock_client
  435. result = manager.get_logs(1)
  436. assert result == mock_logs
  437. def test_get_logs_returns_empty_for_unknown(self, manager):
  438. """Verify get_logs returns empty list for unknown printer."""
  439. result = manager.get_logs(999)
  440. assert result == []
  441. def test_clear_logs_calls_client(self, manager, mock_client):
  442. """Verify clear_logs calls client method."""
  443. manager._clients[1] = mock_client
  444. result = manager.clear_logs(1)
  445. mock_client.clear_logs.assert_called_once()
  446. assert result is True
  447. def test_clear_logs_returns_false_for_unknown(self, manager):
  448. """Verify clear_logs returns False for unknown printer."""
  449. result = manager.clear_logs(999)
  450. assert result is False
  451. def test_is_logging_enabled_returns_status(self, manager, mock_client):
  452. """Verify is_logging_enabled returns client status."""
  453. mock_client.logging_enabled = True
  454. manager._clients[1] = mock_client
  455. result = manager.is_logging_enabled(1)
  456. assert result is True
  457. def test_is_logging_enabled_returns_false_for_unknown(self, manager):
  458. """Verify is_logging_enabled returns False for unknown printer."""
  459. result = manager.is_logging_enabled(999)
  460. assert result is False
  461. # ========================================================================
  462. # Tests for request_status_update
  463. # ========================================================================
  464. def test_request_status_update_calls_client(self, manager, mock_client):
  465. """Verify request_status_update calls client method."""
  466. mock_client.request_status_update.return_value = True
  467. manager._clients[1] = mock_client
  468. result = manager.request_status_update(1)
  469. mock_client.request_status_update.assert_called_once()
  470. assert result is True
  471. def test_request_status_update_returns_false_for_unknown(self, manager):
  472. """Verify request_status_update returns False for unknown printer."""
  473. result = manager.request_status_update(999)
  474. assert result is False
  475. # ========================================================================
  476. # Tests for test_connection
  477. # ========================================================================
  478. @pytest.mark.asyncio
  479. async def test_test_connection_success(self, manager):
  480. """Verify test_connection returns success on connection."""
  481. with patch("backend.app.services.printer_manager.BambuMQTTClient") as MockClient:
  482. mock_instance = MagicMock()
  483. mock_instance.state = MagicMock()
  484. mock_instance.state.connected = True
  485. mock_instance.state.state = "IDLE"
  486. mock_instance.state.raw_data = {"device_model": "X1C"}
  487. MockClient.return_value = mock_instance
  488. result = await manager.test_connection("192.168.1.100", "00M09A123456789", "12345678")
  489. assert result["success"] is True
  490. assert result["state"] == "IDLE"
  491. assert result["model"] == "X1C"
  492. mock_instance.disconnect.assert_called_once()
  493. @pytest.mark.asyncio
  494. async def test_test_connection_failure(self, manager):
  495. """Verify test_connection returns failure on connection error."""
  496. with patch("backend.app.services.printer_manager.BambuMQTTClient") as MockClient:
  497. mock_instance = MagicMock()
  498. mock_instance.state = MagicMock()
  499. mock_instance.state.connected = False
  500. MockClient.return_value = mock_instance
  501. # Shorten the probe budget so the test doesn't burn the full
  502. # 8-second production timeout while polling a failing connection.
  503. with (
  504. patch.object(manager, "PROBE_TIMEOUT_SECONDS", 0.4),
  505. patch.object(manager, "PROBE_POLL_INTERVAL_SECONDS", 0.1),
  506. ):
  507. result = await manager.test_connection("192.168.1.100", "00M09A123456789", "12345678")
  508. assert result["success"] is False
  509. assert result["state"] is None
  510. mock_instance.disconnect.assert_called_once()
  511. @pytest.mark.asyncio
  512. async def test_test_connection_polls_and_returns_early_on_connect(self, manager):
  513. """#1445: a slow printer that finishes its handshake mid-probe must
  514. not be reported as a failure. Previously a fixed 2s sleep meant P1S
  515. TLS / CONNACK that took 3-5s got falsely rejected; now we poll and
  516. early-return as soon as connected flips True.
  517. """
  518. import asyncio
  519. import time
  520. with patch("backend.app.services.printer_manager.BambuMQTTClient") as MockClient:
  521. mock_instance = MagicMock()
  522. mock_instance.state = MagicMock()
  523. mock_instance.state.connected = False # not connected at probe start
  524. mock_instance.state.state = "IDLE"
  525. mock_instance.state.raw_data = {"device_model": "P1S"}
  526. MockClient.return_value = mock_instance
  527. async def flip_connected_after(delay: float):
  528. await asyncio.sleep(delay)
  529. mock_instance.state.connected = True
  530. # Simulates the P1S broker finishing its slow handshake ~0.5s in,
  531. # well past the old 2s-or-fail boundary's natural variance.
  532. with (
  533. patch.object(manager, "PROBE_TIMEOUT_SECONDS", 3.0),
  534. patch.object(manager, "PROBE_POLL_INTERVAL_SECONDS", 0.05),
  535. ):
  536. start = time.monotonic()
  537. flip_task = asyncio.create_task(flip_connected_after(0.5))
  538. try:
  539. result = await manager.test_connection("192.168.1.100", "00M09A123456789", "12345678")
  540. finally:
  541. await flip_task
  542. elapsed = time.monotonic() - start
  543. assert result["success"] is True
  544. assert result["state"] == "IDLE"
  545. # Early-return guarantee: must come back well before the configured
  546. # timeout once connected flips. ~0.5s + one poll interval is plenty.
  547. assert elapsed < 1.5, f"probe should have early-returned shortly after 0.5s, took {elapsed:.2f}s"
  548. @pytest.mark.asyncio
  549. async def test_test_connection_disconnect_runs_off_loop(self, manager):
  550. """#1445: the root cause of the "Docker container hangs" symptom was
  551. `client.disconnect()` running on the asyncio thread — paho's
  552. `loop_stop()` does a thread-join that blocks until its network
  553. thread exits, which on a slow P1S TLS handshake could take many
  554. seconds. This test pins the off-loop teardown so a regression that
  555. reintroduces sync disconnect breaks CI immediately.
  556. """
  557. import asyncio
  558. import threading
  559. import time
  560. with patch("backend.app.services.printer_manager.BambuMQTTClient") as MockClient:
  561. asyncio_thread_id = threading.get_ident()
  562. disconnect_thread_ids: list[int] = []
  563. disconnect_blocked_for: list[float] = []
  564. def slow_blocking_disconnect():
  565. # Mirrors paho.Client.loop_stop()'s thread-join semantics —
  566. # if this runs on the asyncio thread the event loop stalls.
  567. disconnect_thread_ids.append(threading.get_ident())
  568. start = time.monotonic()
  569. time.sleep(0.4)
  570. disconnect_blocked_for.append(time.monotonic() - start)
  571. mock_instance = MagicMock()
  572. mock_instance.state = MagicMock()
  573. mock_instance.state.connected = True
  574. mock_instance.state.state = "IDLE"
  575. mock_instance.state.raw_data = {"device_model": "P1S"}
  576. mock_instance.disconnect = slow_blocking_disconnect
  577. MockClient.return_value = mock_instance
  578. # Another coroutine must keep making progress while disconnect()
  579. # runs — proves the event loop was not blocked.
  580. event_loop_alive_ticks = 0
  581. async def heartbeat():
  582. nonlocal event_loop_alive_ticks
  583. while True:
  584. await asyncio.sleep(0.05)
  585. event_loop_alive_ticks += 1
  586. heartbeat_task = asyncio.create_task(heartbeat())
  587. try:
  588. await manager.test_connection("192.168.1.100", "00M09A123456789", "12345678")
  589. finally:
  590. heartbeat_task.cancel()
  591. try:
  592. await heartbeat_task
  593. except asyncio.CancelledError:
  594. pass
  595. # disconnect ran on a different thread than asyncio's
  596. assert disconnect_thread_ids, "disconnect was never called"
  597. assert disconnect_thread_ids[0] != asyncio_thread_id, (
  598. "disconnect ran on the asyncio thread — this blocks the event loop (#1445)"
  599. )
  600. # Heartbeat made progress while the 0.4s disconnect was blocking
  601. # the worker thread (proves the loop wasn't stalled).
  602. assert event_loop_alive_ticks >= 3, (
  603. f"event loop appears to have stalled during disconnect "
  604. f"(only {event_loop_alive_ticks} heartbeats; expected >=3)"
  605. )
  606. # ========================================================================
  607. # Tests for current print user tracking (Issue #206)
  608. # ========================================================================
  609. def test_set_current_print_user(self, manager):
  610. """Verify current print user can be set."""
  611. manager.set_current_print_user(1, 42, "testuser")
  612. assert 1 in manager._current_print_user
  613. assert manager._current_print_user[1]["user_id"] == 42
  614. assert manager._current_print_user[1]["username"] == "testuser"
  615. def test_get_current_print_user_returns_user(self, manager):
  616. """Verify get_current_print_user returns the stored user."""
  617. manager.set_current_print_user(1, 42, "testuser")
  618. result = manager.get_current_print_user(1)
  619. assert result is not None
  620. assert result["user_id"] == 42
  621. assert result["username"] == "testuser"
  622. def test_get_current_print_user_returns_none_for_unknown(self, manager):
  623. """Verify get_current_print_user returns None for unknown printer."""
  624. result = manager.get_current_print_user(999)
  625. assert result is None
  626. def test_clear_current_print_user(self, manager):
  627. """Verify current print user can be cleared."""
  628. manager.set_current_print_user(1, 42, "testuser")
  629. manager.clear_current_print_user(1)
  630. result = manager.get_current_print_user(1)
  631. assert result is None
  632. def test_clear_current_print_user_no_error_for_unknown(self, manager):
  633. """Verify clearing unknown printer doesn't raise error."""
  634. # Should not raise
  635. manager.clear_current_print_user(999)
  636. def test_set_current_print_user_overwrites_existing(self, manager):
  637. """Verify setting user overwrites existing value."""
  638. manager.set_current_print_user(1, 42, "user1")
  639. manager.set_current_print_user(1, 99, "user2")
  640. result = manager.get_current_print_user(1)
  641. assert result["user_id"] == 99
  642. assert result["username"] == "user2"
  643. def test_multiple_printers_have_separate_users(self, manager):
  644. """Verify each printer tracks its own user separately."""
  645. manager.set_current_print_user(1, 42, "user1")
  646. manager.set_current_print_user(2, 99, "user2")
  647. result1 = manager.get_current_print_user(1)
  648. result2 = manager.get_current_print_user(2)
  649. assert result1["username"] == "user1"
  650. assert result2["username"] == "user2"
  651. class TestPrinterStateToDict:
  652. """Tests for printer_state_to_dict helper function."""
  653. @pytest.fixture
  654. def mock_state(self):
  655. """Create a mock PrinterState."""
  656. state = MagicMock()
  657. state.connected = True
  658. state.state = "RUNNING"
  659. state.current_print = "test.3mf"
  660. state.subtask_name = "Test Print"
  661. state.gcode_file = "/sdcard/test.gcode"
  662. state.progress = 50
  663. state.remaining_time = 3600
  664. state.layer_num = 10
  665. state.total_layers = 20
  666. state.temperatures = {"nozzle": 200, "bed": 60}
  667. state.hms_errors = []
  668. state.ams_status_main = 0
  669. state.ams_status_sub = 0
  670. state.tray_now = "1"
  671. state.wifi_signal = -50
  672. state.raw_data = {}
  673. state.stg_cur = -1 # No calibration stage active
  674. state.firmware_version = None
  675. return state
  676. def test_fila_switch_and_inlets_ride_the_websocket(self, mock_state):
  677. """The FTS fields must be in the broadcast dict, not only the REST status.
  678. The frontend shallow-merges each WebSocket push over its cached status,
  679. so a field this dict omits keeps whatever the last full fetch left —
  680. which is why the AMS inlet badges only ever changed on a page reload.
  681. """
  682. from backend.app.services.bambu_mqtt import FilaSwitchState
  683. mock_state.fila_switch = FilaSwitchState(
  684. installed=True, in_slots=[-1, 0x0102], out_extruders=[1, 0], stat=0, info=1
  685. )
  686. mock_state.ams_switch_inlet = {"0": "A", "1": "B"}
  687. result = printer_state_to_dict(mock_state)
  688. assert result["ams_switch_inlet"] == {"0": "A", "1": "B"}
  689. assert result["fila_switch"] == {
  690. "installed": True,
  691. "in_slots": [-1, 0x0102],
  692. "out_extruders": [1, 0],
  693. "stat": 0,
  694. "info": 1,
  695. }
  696. def test_inlets_are_dropped_without_a_switch(self, mock_state):
  697. """A binding must not outlive the accessory being unplugged."""
  698. from backend.app.services.bambu_mqtt import FilaSwitchState
  699. mock_state.fila_switch = FilaSwitchState(installed=False)
  700. mock_state.ams_switch_inlet = {"0": "A"}
  701. result = printer_state_to_dict(mock_state)
  702. assert result["fila_switch"] is None
  703. assert result["ams_switch_inlet"] == {}
  704. def test_basic_conversion(self, mock_state):
  705. """Verify basic state fields are converted."""
  706. result = printer_state_to_dict(mock_state)
  707. assert result["connected"] is True
  708. assert result["state"] == "RUNNING"
  709. assert result["progress"] == 50
  710. assert result["temperatures"] == {"nozzle": 200, "bed": 60}
  711. def test_ams_data_parsing(self, mock_state):
  712. """Verify AMS data is parsed correctly."""
  713. mock_state.raw_data = {
  714. "ams": [
  715. {
  716. "id": 0,
  717. "humidity_raw": 45,
  718. "temp": 25,
  719. "tray": [
  720. {
  721. "id": 0,
  722. "tray_color": "FF0000",
  723. "tray_type": "PLA",
  724. "tray_sub_brands": "Generic",
  725. "remain": 80,
  726. "k": 0.5,
  727. "tag_uid": "ABC123",
  728. "tray_uuid": "uuid-123",
  729. }
  730. ],
  731. }
  732. ]
  733. }
  734. result = printer_state_to_dict(mock_state)
  735. assert result["ams"] is not None
  736. assert len(result["ams"]) == 1
  737. assert result["ams"][0]["humidity"] == 45
  738. assert len(result["ams"][0]["tray"]) == 1
  739. assert result["ams"][0]["tray"][0]["tray_color"] == "FF0000"
  740. def test_empty_tag_uid_becomes_none(self, mock_state):
  741. """Verify empty tag_uid is converted to None."""
  742. mock_state.raw_data = {
  743. "ams": [
  744. {
  745. "id": 0,
  746. "tray": [
  747. {
  748. "id": 0,
  749. "tag_uid": "",
  750. "tray_uuid": "00000000000000000000000000000000",
  751. }
  752. ],
  753. }
  754. ]
  755. }
  756. result = printer_state_to_dict(mock_state)
  757. assert result["ams"][0]["tray"][0]["tag_uid"] is None
  758. assert result["ams"][0]["tray"][0]["tray_uuid"] is None
  759. def test_bare_tray_emulates_state_9(self, mock_state):
  760. """P1S / A1 Mini physically-empty-slot signal (#1322 follow-up by @RosdasHH):
  761. the firmware sends only `{"id": N}` for a truly empty slot. Treat that as
  762. the firmware's "no spool" state (state=9) so the inventory assign-spool
  763. path can short-circuit the doomed MQTT publish.
  764. """
  765. mock_state.raw_data = {
  766. "ams": [
  767. {
  768. "id": 0,
  769. "tray": [
  770. {"id": 0, "state": 11, "tray_type": "PLA"}, # loaded slot
  771. {"id": 1}, # P1S empty-slot signal — only id
  772. ],
  773. }
  774. ]
  775. }
  776. result = printer_state_to_dict(mock_state)
  777. trays = result["ams"][0]["tray"]
  778. assert trays[0]["state"] == 11, "loaded slot keeps its firmware state"
  779. assert trays[1]["state"] == 9, "bare {id} tray must be promoted to state=9"
  780. def test_populated_payload_with_empty_state_3_is_not_promoted(self, mock_state):
  781. """A1 Mini BMCU / P1S Standard AMS post-Reset-Slot case (#1322 root):
  782. firmware sends state=3 + tray_type="" but with the FULL field set
  783. populated. Must NOT be confused with the bare-tray empty signal —
  784. else inventory.py would short-circuit MQTT and we'd reintroduce the
  785. deadlock the #1322 fix removed.
  786. """
  787. mock_state.raw_data = {
  788. "ams": [
  789. {
  790. "id": 0,
  791. "tray": [
  792. {
  793. "id": 0,
  794. "state": 3,
  795. "tray_type": "", # cleared
  796. "tray_color": "",
  797. "tag_uid": "0000000000000000",
  798. "remain": 0,
  799. }
  800. ],
  801. }
  802. ]
  803. }
  804. result = printer_state_to_dict(mock_state)
  805. # state stays at 3 — the bare-tray promotion requires the dict to have
  806. # ONLY the id key, not just empty/falsy values for the other fields.
  807. assert result["ams"][0]["tray"][0]["state"] == 3
  808. def test_zero_tag_uid_becomes_none(self, mock_state):
  809. """Verify zero tag_uid is converted to None."""
  810. mock_state.raw_data = {
  811. "ams": [
  812. {
  813. "id": 0,
  814. "tray": [
  815. {
  816. "id": 0,
  817. "tag_uid": "0000000000000000",
  818. }
  819. ],
  820. }
  821. ]
  822. }
  823. result = printer_state_to_dict(mock_state)
  824. assert result["ams"][0]["tray"][0]["tag_uid"] is None
  825. def test_exists_bit_is_serialized_for_websocket(self, mock_state):
  826. """#2670: the WS status payload must carry the firmware presence bit
  827. `exists` (set by apply_tray_exist_bits) — the REST serializer already
  828. does. Without it the frontend shallow-merge drops `exists` after the
  829. first WS frame and getEmptySlotKind falls back to the firmware-variant
  830. state 9/10 heuristic, which is wrong for AMS-HT in both directions.
  831. """
  832. mock_state.raw_data = {
  833. "ams": [
  834. {
  835. "id": 128,
  836. "tray": [
  837. # Empty HT: apply_tray_exist_bits cleared it and set exists=False.
  838. {"id": 0, "state": 9, "tray_type": "", "exists": False},
  839. ],
  840. },
  841. {
  842. "id": 0,
  843. "tray": [
  844. # Present non-RFID spool: exists=True, no tray_type ("?").
  845. {"id": 0, "state": 10, "tray_type": "", "exists": True},
  846. ],
  847. },
  848. ]
  849. }
  850. result = printer_state_to_dict(mock_state)
  851. ht_tray = result["ams"][0]["tray"][0]
  852. reg_tray = result["ams"][1]["tray"][0]
  853. assert ht_tray["exists"] is False
  854. assert reg_tray["exists"] is True
  855. def test_vt_tray_parsing(self, mock_state):
  856. """Verify virtual tray is parsed correctly as a list."""
  857. mock_state.raw_data = {
  858. "vt_tray": [
  859. {
  860. "tray_color": "00FF00",
  861. "tray_type": "PETG",
  862. "tray_sub_brands": "Generic",
  863. "remain": 60,
  864. "tag_uid": "VT123",
  865. }
  866. ]
  867. }
  868. result = printer_state_to_dict(mock_state)
  869. assert isinstance(result["vt_tray"], list)
  870. assert len(result["vt_tray"]) == 1
  871. assert result["vt_tray"][0]["id"] == 254
  872. assert result["vt_tray"][0]["tray_color"] == "00FF00"
  873. assert result["vt_tray"][0]["tray_type"] == "PETG"
  874. def test_vt_tray_dict_normalized_to_list(self, mock_state):
  875. """Verify vt_tray as a raw dict (from MQTT) is normalized to a list."""
  876. mock_state.raw_data = {
  877. "vt_tray": {
  878. "id": "254",
  879. "tray_color": "FF0000",
  880. "tray_type": "PLA",
  881. "tray_sub_brands": "Generic",
  882. "tag_uid": "0000000000000000",
  883. "tray_uuid": "00000000000000000000000000000000",
  884. "remain": 0,
  885. }
  886. }
  887. result = printer_state_to_dict(mock_state)
  888. assert isinstance(result["vt_tray"], list)
  889. assert len(result["vt_tray"]) == 1
  890. assert result["vt_tray"][0]["tray_color"] == "FF0000"
  891. assert result["vt_tray"][0]["tray_type"] == "PLA"
  892. assert result["vt_tray"][0]["tag_uid"] is None
  893. assert result["vt_tray"][0]["tray_uuid"] is None
  894. def test_vt_tray_non_list_non_dict_ignored(self, mock_state):
  895. """Verify unexpected vt_tray types (e.g. string) produce empty list."""
  896. mock_state.raw_data = {"vt_tray": "unexpected_string"}
  897. result = printer_state_to_dict(mock_state)
  898. assert result["vt_tray"] == []
  899. def test_hms_errors_conversion(self, mock_state):
  900. """Verify HMS errors are converted correctly."""
  901. error = MagicMock()
  902. error.code = "0700_0100"
  903. error.attr = 1
  904. error.module = "AMS"
  905. error.severity = 2
  906. mock_state.hms_errors = [error]
  907. result = printer_state_to_dict(mock_state)
  908. assert len(result["hms_errors"]) == 1
  909. assert result["hms_errors"][0]["code"] == "0700_0100"
  910. assert result["hms_errors"][0]["module"] == "AMS"
  911. def test_cover_url_added_for_running_print(self, mock_state):
  912. """Verify cover_url is added for running prints."""
  913. result = printer_state_to_dict(mock_state, printer_id=1)
  914. assert result["cover_url"] == "/api/v1/printers/1/cover"
  915. def test_current_plate_id_extracted_from_gcode_file(self, mock_state):
  916. """Verify current_plate_id is parsed from a Bambu plate path (#881)."""
  917. mock_state.gcode_file = "/Metadata/plate_3.gcode"
  918. result = printer_state_to_dict(mock_state)
  919. assert result["current_plate_id"] == 3
  920. def test_current_plate_id_none_when_no_plate_segment(self, mock_state):
  921. """Verify current_plate_id stays None when gcode_file has no plate marker."""
  922. mock_state.gcode_file = "/sdcard/test.gcode"
  923. result = printer_state_to_dict(mock_state)
  924. assert result["current_plate_id"] is None
  925. def test_cover_url_none_when_not_running(self, mock_state):
  926. """Verify cover_url is None when not printing."""
  927. mock_state.state = "IDLE"
  928. result = printer_state_to_dict(mock_state, printer_id=1)
  929. assert result["cover_url"] is None
  930. def test_ams_ht_detection(self, mock_state):
  931. """Verify AMS-HT is detected (1 tray vs 4)."""
  932. mock_state.raw_data = {
  933. "ams": [
  934. {
  935. "id": 0,
  936. "tray": [{"id": 0}], # Only 1 tray = AMS-HT
  937. }
  938. ]
  939. }
  940. result = printer_state_to_dict(mock_state)
  941. assert result["ams"][0]["is_ams_ht"] is True
  942. def test_regular_ams_detection(self, mock_state):
  943. """Verify regular AMS is detected (4 trays)."""
  944. mock_state.raw_data = {"ams": [{"id": 0, "tray": [{"id": 0}, {"id": 1}, {"id": 2}, {"id": 3}]}]}
  945. result = printer_state_to_dict(mock_state)
  946. assert result["ams"][0]["is_ams_ht"] is False
  947. def test_chamber_temp_filtered_for_p1s(self, mock_state):
  948. """Verify chamber temperature is filtered out for P1S (no chamber sensor)."""
  949. mock_state.temperatures = {
  950. "nozzle": 200,
  951. "bed": 60,
  952. "chamber": 5,
  953. "chamber_target": 0,
  954. "chamber_heating": False,
  955. }
  956. result = printer_state_to_dict(mock_state, model="P1S")
  957. assert "chamber" not in result["temperatures"]
  958. assert "chamber_target" not in result["temperatures"]
  959. assert "chamber_heating" not in result["temperatures"]
  960. assert result["temperatures"]["nozzle"] == 200
  961. assert result["temperatures"]["bed"] == 60
  962. def test_chamber_temp_kept_for_x1c(self, mock_state):
  963. """Verify chamber temperature is kept for X1C (has chamber sensor)."""
  964. mock_state.temperatures = {
  965. "nozzle": 200,
  966. "bed": 60,
  967. "chamber": 25,
  968. "chamber_target": 45,
  969. "chamber_heating": True,
  970. }
  971. result = printer_state_to_dict(mock_state, model="X1C")
  972. assert result["temperatures"]["chamber"] == 25
  973. assert result["temperatures"]["chamber_target"] == 45
  974. assert result["temperatures"]["chamber_heating"] is True
  975. def test_chamber_temp_filtered_for_a1(self, mock_state):
  976. """Verify chamber temperature is filtered out for A1 (no chamber sensor)."""
  977. mock_state.temperatures = {"nozzle": 200, "bed": 60, "chamber": 5}
  978. result = printer_state_to_dict(mock_state, model="A1")
  979. assert "chamber" not in result["temperatures"]
  980. def test_chamber_temp_kept_when_no_model(self, mock_state):
  981. """Verify chamber temperature is kept when model is not specified (conservative approach)."""
  982. mock_state.temperatures = {"nozzle": 200, "bed": 60, "chamber": 25}
  983. result = printer_state_to_dict(mock_state) # No model specified
  984. # When model is unknown, we can't filter - leave as is
  985. # Actually supports_chamber_temp returns False for None, so it will filter
  986. # Let's check the actual behavior
  987. assert "chamber" not in result["temperatures"]
  988. def test_ams_drying_fields_included(self, mock_state):
  989. """Verify AMS drying fields (dry_time, module_type) are included in output."""
  990. mock_state.raw_data = {
  991. "ams": [
  992. {
  993. "id": 0,
  994. "dry_time": 42,
  995. "module_type": "n3f",
  996. "tray": [
  997. {
  998. "id": 0,
  999. "tray_color": "FF0000",
  1000. "tray_type": "PLA",
  1001. "drying_temp": 55,
  1002. "drying_time": 240,
  1003. }
  1004. ],
  1005. }
  1006. ]
  1007. }
  1008. result = printer_state_to_dict(mock_state)
  1009. ams_unit = result["ams"][0]
  1010. assert ams_unit["dry_time"] == 42
  1011. assert ams_unit["module_type"] == "n3f"
  1012. # Tray-level drying fields
  1013. tray = ams_unit["tray"][0]
  1014. assert tray["drying_temp"] == 55
  1015. assert tray["drying_time"] == 240
  1016. def test_awaiting_plate_clear_defaults_false(self, mock_state):
  1017. """Without a printer_id, awaiting_plate_clear is False (no lookup possible)."""
  1018. result = printer_state_to_dict(mock_state)
  1019. assert result["awaiting_plate_clear"] is False
  1020. def test_awaiting_plate_clear_surfaced_when_set(self, mock_state):
  1021. """With printer_id, awaiting_plate_clear reflects PrinterManager state.
  1022. Regression: PR #939 left this flag off the WebSocket payload, so the
  1023. "Clear Plate" button only appeared after the 30 s REST fallback poll.
  1024. """
  1025. from backend.app.services.printer_manager import printer_manager
  1026. printer_manager.set_awaiting_plate_clear(12345, True)
  1027. try:
  1028. result = printer_state_to_dict(mock_state, printer_id=12345)
  1029. assert result["awaiting_plate_clear"] is True
  1030. finally:
  1031. printer_manager.set_awaiting_plate_clear(12345, False)
  1032. def test_name_and_model_surfaced_when_registered(self, mock_state):
  1033. """Registered PrinterInfo name + model arg should land in the WS payload.
  1034. Regression for #963 follow-up: without this, the gcode viewer's printer
  1035. selector had to wait on a /printers fetch before it could render real
  1036. names, and the initial WS snapshot showed "Printer 1" fallbacks.
  1037. """
  1038. from backend.app.services.printer_manager import PrinterInfo, printer_manager
  1039. # Register a stub PrinterInfo; the real manager writes this on connect.
  1040. printer_manager._printer_info[98765] = PrinterInfo(name="My X1C", serial_number="01S00-0")
  1041. try:
  1042. result = printer_state_to_dict(mock_state, printer_id=98765, model="X1C")
  1043. assert result["name"] == "My X1C"
  1044. assert result["model"] == "X1C"
  1045. finally:
  1046. printer_manager._printer_info.pop(98765, None)
  1047. def test_name_and_model_absent_when_no_printer_id(self, mock_state):
  1048. """Without a printer_id (unusual callsites), name/model keys stay absent.
  1049. The consumers (gcode viewer, frontend card) tolerate missing keys; what
  1050. they can't tolerate is an unrelated printer's name accidentally leaking
  1051. into a status meant for a different one.
  1052. """
  1053. result = printer_state_to_dict(mock_state)
  1054. assert "name" not in result
  1055. assert "model" not in result
  1056. def test_model_absent_when_arg_is_none(self, mock_state):
  1057. """`model` arg=None must not plant a `model` key at all.
  1058. If the arg is None, callers didn't know the model yet; emitting a
  1059. `model: null` field would overwrite a good value cached client-side.
  1060. """
  1061. from backend.app.services.printer_manager import PrinterInfo, printer_manager
  1062. printer_manager._printer_info[55555] = PrinterInfo(name="N", serial_number="S")
  1063. try:
  1064. result = printer_state_to_dict(mock_state, printer_id=55555, model=None)
  1065. assert "model" not in result
  1066. assert result["name"] == "N"
  1067. finally:
  1068. printer_manager._printer_info.pop(55555, None)
  1069. class TestStatusKeyDryingDedup:
  1070. """Regression tests for WebSocket dedup including drying fields.
  1071. The WebSocket broadcast deduplication uses printer_state_to_dict output
  1072. to detect changes. If drying fields (like dry_time) are missing from
  1073. the dict, changes to those fields won't trigger broadcasts.
  1074. """
  1075. def test_dry_time_change_changes_status_key(self):
  1076. """Verify dry_time is present in AMS unit data so dedup can detect changes."""
  1077. state = MagicMock()
  1078. state.connected = True
  1079. state.state = "IDLE"
  1080. state.current_print = None
  1081. state.subtask_name = None
  1082. state.gcode_file = None
  1083. state.progress = 0
  1084. state.remaining_time = 0
  1085. state.layer_num = 0
  1086. state.total_layers = 0
  1087. state.temperatures = {"nozzle": 25, "bed": 25}
  1088. state.hms_errors = []
  1089. state.ams_status_main = 0
  1090. state.ams_status_sub = 0
  1091. state.tray_now = None
  1092. state.wifi_signal = -50
  1093. state.stg_cur = -1
  1094. # First state: drying active with 30 minutes remaining
  1095. state.raw_data = {"ams": [{"id": 0, "dry_time": 30, "module_type": "n3f", "tray": [{"id": 0}]}]}
  1096. result1 = printer_state_to_dict(state)
  1097. # Second state: drying time decreased
  1098. state.raw_data = {"ams": [{"id": 0, "dry_time": 29, "module_type": "n3f", "tray": [{"id": 0}]}]}
  1099. result2 = printer_state_to_dict(state)
  1100. # The dicts should differ — dry_time changed
  1101. assert result1["ams"][0]["dry_time"] == 30
  1102. assert result2["ams"][0]["dry_time"] == 29
  1103. assert result1["ams"] != result2["ams"]
  1104. class TestDryingTargetExposure:
  1105. """Tests for dry_target_temp / dry_filament surfacing on AMS state dict.
  1106. Bambu does not echo the active cycle's chosen filament + target
  1107. temperature on the per-tick AMS push, only the dry_time countdown.
  1108. The badge needs the cached target so it can render "PETG @ 65°C".
  1109. """
  1110. def _state_with_ams(self, ams_data: dict) -> object:
  1111. state = MagicMock()
  1112. state.connected = True
  1113. state.state = "IDLE"
  1114. state.current_print = None
  1115. state.subtask_name = None
  1116. state.gcode_file = None
  1117. state.progress = 0
  1118. state.remaining_time = 0
  1119. state.layer_num = 0
  1120. state.total_layers = 0
  1121. state.temperatures = {"nozzle": 25, "bed": 25}
  1122. state.hms_errors = []
  1123. state.ams_status_main = 0
  1124. state.ams_status_sub = 0
  1125. state.tray_now = None
  1126. state.wifi_signal = -50
  1127. state.stg_cur = -1
  1128. state.raw_data = {"ams": [ams_data]}
  1129. return state
  1130. def test_cached_target_wins_over_tray_fallback(self):
  1131. """When the cache has a target for this AMS, use it verbatim — even
  1132. if the loaded tray's filament/recommended-drying-temp differ."""
  1133. state = self._state_with_ams(
  1134. {
  1135. "id": 0,
  1136. "dry_time": 600,
  1137. "tray": [
  1138. {"id": 0, "tray_type": "PLA", "drying_temp": 50, "state": 11},
  1139. ],
  1140. }
  1141. )
  1142. result = printer_state_to_dict(state, drying_targets={0: {"filament": "PETG", "temp": 65}})
  1143. assert result["ams"][0]["dry_filament"] == "PETG"
  1144. assert result["ams"][0]["dry_target_temp"] == 65
  1145. def test_falls_back_to_loaded_tray_filament_when_no_cache(self):
  1146. """No cached target → name the filament from the loaded trays when they
  1147. agree on a type. The temperature stays unknown: only the cache records
  1148. what we actually sent."""
  1149. state = self._state_with_ams(
  1150. {
  1151. "id": 0,
  1152. "dry_time": 600,
  1153. "tray": [
  1154. {"id": 0, "tray_type": "ABS", "drying_temp": 70, "state": 11},
  1155. ],
  1156. }
  1157. )
  1158. result = printer_state_to_dict(state, drying_targets=None)
  1159. assert result["ams"][0]["dry_filament"] == "ABS"
  1160. assert result["ams"][0]["dry_target_temp"] is None
  1161. def test_returns_none_when_no_cache_and_empty_trays(self):
  1162. """No cache + no loaded tray with tray_type → both fields are None."""
  1163. state = self._state_with_ams(
  1164. {
  1165. "id": 0,
  1166. "dry_time": 600,
  1167. "tray": [{"id": 0}],
  1168. }
  1169. )
  1170. result = printer_state_to_dict(state, drying_targets={})
  1171. assert result["ams"][0]["dry_filament"] is None
  1172. assert result["ams"][0]["dry_target_temp"] is None
  1173. def test_targets_for_other_ams_id_dont_leak(self):
  1174. """A cached target for AMS 1 must not surface on AMS 0."""
  1175. state = self._state_with_ams(
  1176. {
  1177. "id": 0,
  1178. "dry_time": 600,
  1179. "tray": [{"id": 0}],
  1180. }
  1181. )
  1182. result = printer_state_to_dict(state, drying_targets={1: {"filament": "PETG", "temp": 65}})
  1183. assert result["ams"][0]["dry_filament"] is None
  1184. assert result["ams"][0]["dry_target_temp"] is None
  1185. def test_no_fallback_when_loaded_trays_disagree(self):
  1186. """#2759 — the reporter's AMS held 2 PETG and 2 PLA and was drying the
  1187. PLA at 45°C, but the fallback read slot 1 and labelled it "PETG @ 65°C".
  1188. A mixed unit gives no evidence of what the cycle is running, so the
  1189. badge must show the countdown alone rather than a confident wrong
  1190. answer."""
  1191. state = self._state_with_ams(
  1192. {
  1193. "id": 0,
  1194. "dry_time": 719,
  1195. "tray": [
  1196. {"id": 0, "tray_type": "PETG", "drying_temp": 65, "state": 11},
  1197. {"id": 1, "tray_type": "PETG", "drying_temp": 65, "state": 11},
  1198. {"id": 2, "tray_type": "PLA", "drying_temp": 45, "state": 11},
  1199. {"id": 3, "tray_type": "PLA", "drying_temp": 45, "state": 11},
  1200. ],
  1201. }
  1202. )
  1203. result = printer_state_to_dict(state, drying_targets={})
  1204. assert result["ams"][0]["dry_filament"] is None
  1205. assert result["ams"][0]["dry_target_temp"] is None
  1206. def test_fallback_survives_multiple_trays_of_one_type(self):
  1207. """Agreement across slots is still evidence of the filament — a unit
  1208. loaded entirely with PLA keeps the name the mixed case gives up."""
  1209. state = self._state_with_ams(
  1210. {
  1211. "id": 0,
  1212. "dry_time": 719,
  1213. "tray": [
  1214. {"id": 0, "tray_type": "PLA", "drying_temp": 45, "state": 11},
  1215. {"id": 1, "tray_type": "PLA", "drying_temp": 45, "state": 11},
  1216. {"id": 2},
  1217. ],
  1218. }
  1219. )
  1220. result = printer_state_to_dict(state, drying_targets={})
  1221. assert result["ams"][0]["dry_filament"] == "PLA"
  1222. def test_uniform_unit_never_invents_a_temperature(self):
  1223. """#2759 follow-up — the reporter's second AMS held only PLA and was
  1224. drying at the 45°C they picked, but with no cached target the badge
  1225. answered with the RFID recommendation and read "PLA @ 55°C". Every
  1226. spool agreeing tells us the filament; it tells us nothing about a
  1227. temperature the user chose freely in the popover."""
  1228. state = self._state_with_ams(
  1229. {
  1230. "id": 0,
  1231. "dry_time": 719,
  1232. "tray": [
  1233. {"id": 0, "tray_type": "PLA", "drying_temp": 55, "state": 11},
  1234. {"id": 1, "tray_type": "PLA", "drying_temp": 55, "state": 11},
  1235. ],
  1236. }
  1237. )
  1238. result = printer_state_to_dict(state, drying_targets={})
  1239. assert result["ams"][0]["dry_filament"] == "PLA"
  1240. assert result["ams"][0]["dry_target_temp"] is None
  1241. def test_cached_temp_survives_a_unit_whose_trays_disagree(self):
  1242. """The cache is authoritative for both fields. A mixed unit costs us the
  1243. filament fallback but must not touch a target we actually sent."""
  1244. state = self._state_with_ams(
  1245. {
  1246. "id": 0,
  1247. "dry_time": 719,
  1248. "tray": [
  1249. {"id": 0, "tray_type": "PETG", "drying_temp": 65, "state": 11},
  1250. {"id": 1, "tray_type": "PLA", "drying_temp": 55, "state": 11},
  1251. ],
  1252. }
  1253. )
  1254. result = printer_state_to_dict(state, drying_targets={0: {"filament": "PLA", "temp": 45}})
  1255. assert result["ams"][0]["dry_filament"] == "PLA"
  1256. assert result["ams"][0]["dry_target_temp"] == 45
  1257. class TestDisplayTemperatures:
  1258. """#1422 — the readings handed to the streaming overlay.
  1259. `state.temperatures` doubles as the MQTT client's working memory: alongside
  1260. the readings it carries derived heater flags and private timestamps. The
  1261. overlay feed is reached by a token rather than a login, so it gets an
  1262. allow-list rather than the dict.
  1263. """
  1264. def test_keeps_the_readings_the_overlay_draws(self):
  1265. result = display_temperatures({"nozzle": 219.5, "nozzle_target": 220.0, "bed": 60.0, "bed_target": 60.0}, "X1C")
  1266. assert result == {"nozzle": 219.5, "nozzle_target": 220.0, "bed": 60.0, "bed_target": 60.0}
  1267. def test_drops_heater_flags_and_private_bookkeeping(self):
  1268. result = display_temperatures(
  1269. {
  1270. "nozzle": 219.5,
  1271. "nozzle_heating": True,
  1272. "bed_heating": False,
  1273. "_nozzle_target_set_time": 1754300000.0,
  1274. "_chamber_target_set_time": 1754300000.0,
  1275. },
  1276. "X1C",
  1277. )
  1278. assert result == {"nozzle": 219.5}
  1279. def test_chamber_kept_on_models_with_a_real_sensor(self):
  1280. result = display_temperatures({"chamber": 38.0, "chamber_target": 40.0}, "X1C")
  1281. assert result == {"chamber": 38.0, "chamber_target": 40.0}
  1282. def test_chamber_dropped_on_models_without_one(self):
  1283. """P1P, P1S, A1 and A1 mini publish a meaningless chamber_temper. Drawing
  1284. it on a live stream would state a measurement that doesn't exist."""
  1285. for model in ("P1S", "P1P", "A1", "A1MINI"):
  1286. assert display_temperatures({"nozzle": 200.0, "chamber": 38.0}, model) == {"nozzle": 200.0}
  1287. def test_second_nozzle_is_included(self):
  1288. result = display_temperatures({"nozzle": 220.0, "nozzle_2": 240.0, "nozzle_2_target": 250.0}, "H2D")
  1289. assert result == {"nozzle": 220.0, "nozzle_2": 240.0, "nozzle_2_target": 250.0}
  1290. def test_unparseable_and_missing_values_are_skipped(self):
  1291. """A reading that isn't a number is dropped rather than crashing the
  1292. feed or reaching the page as a string."""
  1293. assert display_temperatures({"nozzle": None, "bed": "warm", "chamber": 38.0}, "X1C") == {"chamber": 38.0}
  1294. def test_empty_and_none_are_empty(self):
  1295. assert display_temperatures(None, "X1C") == {}
  1296. assert display_temperatures({}, "X1C") == {}
  1297. class TestSupportsChamberTemp:
  1298. """Tests for supports_chamber_temp helper function."""
  1299. def test_x1_series_supported(self):
  1300. """Verify X1 series printers support chamber temp."""
  1301. assert supports_chamber_temp("X1") is True
  1302. assert supports_chamber_temp("X1C") is True
  1303. assert supports_chamber_temp("X1E") is True
  1304. def test_p2_series_supported(self):
  1305. """Verify P2 series printers support chamber temp."""
  1306. assert supports_chamber_temp("P2S") is True
  1307. def test_h2_series_supported(self):
  1308. """Verify H2 series printers support chamber temp."""
  1309. assert supports_chamber_temp("H2C") is True
  1310. assert supports_chamber_temp("H2D") is True
  1311. assert supports_chamber_temp("H2DPRO") is True
  1312. assert supports_chamber_temp("H2S") is True
  1313. def test_p1_series_not_supported(self):
  1314. """Verify P1 series printers do NOT support chamber temp."""
  1315. assert supports_chamber_temp("P1P") is False
  1316. assert supports_chamber_temp("P1S") is False
  1317. def test_a1_series_not_supported(self):
  1318. """Verify A1 series printers do NOT support chamber temp."""
  1319. assert supports_chamber_temp("A1") is False
  1320. assert supports_chamber_temp("A1MINI") is False
  1321. def test_none_model_not_supported(self):
  1322. """Verify None model returns False."""
  1323. assert supports_chamber_temp(None) is False
  1324. def test_case_insensitive(self):
  1325. """Verify model matching is case-insensitive."""
  1326. assert supports_chamber_temp("x1c") is True
  1327. assert supports_chamber_temp("X1c") is True
  1328. assert supports_chamber_temp("p1s") is False
  1329. def test_internal_model_codes_supported(self):
  1330. """Verify internal model codes from MQTT/SSDP are recognized."""
  1331. # X1/X1C
  1332. assert supports_chamber_temp("BL-P001") is True
  1333. # X1E
  1334. assert supports_chamber_temp("C13") is True
  1335. # H2D
  1336. assert supports_chamber_temp("O1D") is True
  1337. # H2C
  1338. assert supports_chamber_temp("O1C") is True
  1339. # H2S
  1340. assert supports_chamber_temp("O1S") is True
  1341. # H2D Pro
  1342. assert supports_chamber_temp("O1E") is True
  1343. # P2S
  1344. assert supports_chamber_temp("N7") is True
  1345. def test_internal_model_codes_not_supported(self):
  1346. """Verify A1/P1 internal codes are NOT supported."""
  1347. # P1P
  1348. assert supports_chamber_temp("C11") is False
  1349. # P1S
  1350. assert supports_chamber_temp("C12") is False
  1351. # A1
  1352. assert supports_chamber_temp("N2S") is False
  1353. # A1 Mini
  1354. assert supports_chamber_temp("N1") is False
  1355. class TestIsBedSlinger:
  1356. """Tests for is_bed_slinger helper function (#1334)."""
  1357. def test_a1_series_is_bed_slinger(self):
  1358. """A1 / A1 Mini are open-frame bed-slingers — Z axis is the toolhead."""
  1359. from backend.app.services.printer_manager import is_bed_slinger
  1360. assert is_bed_slinger("A1") is True
  1361. assert is_bed_slinger("A1 Mini") is True
  1362. assert is_bed_slinger("A1MINI") is True
  1363. assert is_bed_slinger("A1-MINI") is True
  1364. def test_a1_internal_codes_recognised(self):
  1365. """Internal MQTT/SSDP codes for A1 family must also classify as bed-slinger."""
  1366. from backend.app.services.printer_manager import is_bed_slinger
  1367. # A1 Mini
  1368. assert is_bed_slinger("N1") is True
  1369. # A1
  1370. assert is_bed_slinger("N2S") is True
  1371. def test_bed_on_z_models_not_bed_slingers(self):
  1372. """X1 / P1 / H2 / H2C / H2D / H2S / P2S all have the bed on Z."""
  1373. from backend.app.services.printer_manager import is_bed_slinger
  1374. for model in ("X1", "X1C", "X1E", "P1P", "P1S", "P2S", "H2C", "H2D", "H2DPRO", "H2S"):
  1375. assert is_bed_slinger(model) is False, f"{model} should NOT be classified as bed-slinger"
  1376. def test_none_model_returns_false(self):
  1377. from backend.app.services.printer_manager import is_bed_slinger
  1378. assert is_bed_slinger(None) is False
  1379. assert is_bed_slinger("") is False
  1380. def test_case_insensitive(self):
  1381. from backend.app.services.printer_manager import is_bed_slinger
  1382. assert is_bed_slinger("a1") is True
  1383. assert is_bed_slinger("a1 mini") is True
  1384. assert is_bed_slinger("x1c") is False
  1385. class TestSupportsDrying:
  1386. """Tests for supports_drying helper function."""
  1387. def test_known_supported_with_firmware(self):
  1388. """Verify known models with sufficient firmware return True."""
  1389. assert supports_drying("X1C", "01.09.00.00") is True
  1390. assert supports_drying("H2D", "01.02.30.00") is True
  1391. assert supports_drying("H2S", "01.02.00.00") is True
  1392. assert supports_drying("H2C", "01.02.00.00") is True
  1393. assert supports_drying("O1C", "01.02.00.00") is True
  1394. assert supports_drying("O1C2", "01.02.00.00") is True
  1395. assert supports_drying("P2S", "01.02.00.00") is True
  1396. assert supports_drying("N7", "01.02.00.00") is True
  1397. def test_known_supported_old_firmware(self):
  1398. """Verify known models with old firmware return False."""
  1399. assert supports_drying("X1C", "01.08.00.00") is False
  1400. assert supports_drying("H2S", "01.01.00.00") is False
  1401. assert supports_drying("H2C", "01.01.99.99") is False
  1402. assert supports_drying("O1C", "01.01.99.99") is False
  1403. assert supports_drying("O1C2", "01.01.99.99") is False
  1404. assert supports_drying("P2S", "01.01.99.99") is False
  1405. assert supports_drying("N7", "01.01.99.99") is False
  1406. def test_known_supported_no_firmware(self):
  1407. """Verify known models with no firmware return False."""
  1408. assert supports_drying("X1C", None) is False
  1409. assert supports_drying("P2S", None) is False
  1410. def test_unsupported_models(self):
  1411. """Verify models without AMS drying support return False regardless of firmware."""
  1412. for model in ["A1", "A1MINI", "A1-MINI", "N1", "N2S"]:
  1413. assert supports_drying(model, "99.99.99.99") is False, f"Expected False for {model}"
  1414. def test_unknown_models_allowed(self):
  1415. """Verify unknown models are allowed (graceful fallback).
  1416. Models not in the unsupported set AND not matching any known firmware-gated
  1417. model substring get the benefit of the doubt and return True.
  1418. "H2D Pro" contains "H2D" so it IS firmware-gated (needs firmware).
  1419. """
  1420. # Truly unknown models: no substring match in _DRYING_MIN_FIRMWARE
  1421. assert supports_drying("FUTURE_MODEL", None) is True
  1422. # X1E contains "X1" substring, so it IS firmware-gated
  1423. assert supports_drying("X1E", "01.09.00.00") is True
  1424. # H2D Pro contains "H2D" substring, so it IS firmware-gated
  1425. assert supports_drying("H2D Pro", "01.02.30.00") is True
  1426. def test_none_model(self):
  1427. """Verify None model returns False."""
  1428. assert supports_drying(None, "01.09.00.00") is False
  1429. def test_case_insensitive(self):
  1430. """Verify model matching is case-insensitive."""
  1431. assert supports_drying("x1c", "01.09.00.00") is True
  1432. assert supports_drying("p2s", "01.02.00.00") is True
  1433. assert supports_drying("a1", "99.99.99.99") is False
  1434. class TestDryingScreenOnly:
  1435. """P1-series AMS drying is screen-only (#2533).
  1436. Bambu's P1 manual: "P1S connected AMS drying functions may only be controlled
  1437. from the P1S screen." The firmware acks `ams_filament_drying` with
  1438. result: success and then does nothing — so no command we send can ever start a
  1439. cycle, whatever the firmware version.
  1440. """
  1441. @pytest.mark.parametrize("model", ["P1S", "P1P", "p1s", " p1p "])
  1442. def test_screen_only_models_reject_remote_drying(self, model):
  1443. assert drying_screen_only(model) is True
  1444. # Not firmware-gated: even the newest firmware won't take the command.
  1445. assert supports_drying(model, "99.99.99.99") is False
  1446. @pytest.mark.parametrize("model", ["X1C", "P2S", "H2D", "A1", None])
  1447. def test_other_models_are_not_screen_only(self, model):
  1448. assert drying_screen_only(model) is False
  1449. def test_screen_only_is_not_the_same_as_unsupported(self):
  1450. # The A1 has no drying-capable AMS at all; the P1S does, it just can't be
  1451. # driven remotely. The UI needs to tell those two apart.
  1452. assert drying_screen_only("A1") is False
  1453. assert supports_drying("A1", "99.99.99.99") is False
  1454. class TestSupportsDryingWhilePrinting:
  1455. """Tests for the supports_drying_while_printing gate (concurrent drying during print).
  1456. Stricter than supports_drying — only models explicitly confirmed by Bambu wiki
  1457. release notes are allowed (verified phrase: "printing while filament is drying"
  1458. / "Print While Drying").
  1459. """
  1460. def test_known_supported_with_firmware(self):
  1461. """Matrix-confirmed models with min firmware return True."""
  1462. assert supports_drying_while_printing("H2D", "01.03.00.00") is True
  1463. assert supports_drying_while_printing("H2D Pro", "01.02.00.00") is True
  1464. assert supports_drying_while_printing("O1E", "01.02.00.00") is True
  1465. assert supports_drying_while_printing("O2D", "01.02.00.00") is True
  1466. assert supports_drying_while_printing("H2C", "01.02.00.00") is True
  1467. assert supports_drying_while_printing("O1C", "01.02.00.00") is True
  1468. assert supports_drying_while_printing("O1C2", "01.02.00.00") is True
  1469. assert supports_drying_while_printing("H2S", "01.02.00.00") is True
  1470. assert supports_drying_while_printing("X2D", "01.01.00.00") is True
  1471. assert supports_drying_while_printing("N6", "01.01.00.00") is True
  1472. assert supports_drying_while_printing("X1C", "01.11.02.00") is True
  1473. assert supports_drying_while_printing("BL-P001", "01.11.02.00") is True
  1474. assert supports_drying_while_printing("P2S", "01.02.00.00") is True
  1475. assert supports_drying_while_printing("N7", "01.02.00.00") is True
  1476. assert supports_drying_while_printing("A2L", "01.01.00.00") is True
  1477. assert supports_drying_while_printing("N9", "01.01.00.00") is True
  1478. def test_known_supported_below_min_firmware(self):
  1479. """Matrix-confirmed models on too-old firmware return False."""
  1480. assert supports_drying_while_printing("H2D", "01.02.30.00") is False
  1481. assert supports_drying_while_printing("X1C", "01.11.01.00") is False
  1482. assert supports_drying_while_printing("P2S", "01.01.99.99") is False
  1483. assert supports_drying_while_printing("H2S", "01.01.99.99") is False
  1484. assert supports_drying_while_printing("A2L", "01.00.99.99") is False
  1485. def test_not_in_matrix_excluded(self):
  1486. """Models absent from the matrix return False regardless of firmware.
  1487. P1*, A1, A1 Mini, X1 (non-C), X1E are intentionally excluded — their wiki
  1488. release notes never mention "Print While Drying" / "printing while filament
  1489. is drying".
  1490. """
  1491. for model in [
  1492. "P1P",
  1493. "P1S",
  1494. "C11",
  1495. "C12",
  1496. "A1",
  1497. "A1 MINI",
  1498. "A1MINI",
  1499. "N1",
  1500. "N2S",
  1501. "X1",
  1502. "X1E",
  1503. "BL-P002",
  1504. "C13",
  1505. ]:
  1506. assert supports_drying_while_printing(model, "99.99.99.99") is False, f"Expected False for {model}"
  1507. def test_no_firmware_returns_false(self):
  1508. """Missing firmware version returns False even for supported models."""
  1509. assert supports_drying_while_printing("H2D", None) is False
  1510. assert supports_drying_while_printing("P2S", None) is False
  1511. def test_none_model_returns_false(self):
  1512. """None model returns False."""
  1513. assert supports_drying_while_printing(None, "01.03.00.00") is False
  1514. def test_case_insensitive(self):
  1515. """Model matching is case-insensitive."""
  1516. assert supports_drying_while_printing("h2d", "01.03.00.00") is True
  1517. assert supports_drying_while_printing("p2s", "01.02.00.00") is True
  1518. assert supports_drying_while_printing("a1", "99.99.99.99") is False
  1519. def test_unknown_model_returns_false(self):
  1520. """Unknown models default to FALSE (strict gate — not the lenient default-allow).
  1521. This contrasts with supports_drying which defaults to True for unknown
  1522. models. For while-printing the cost of being wrong is real (firmware
  1523. rejection mid-print is annoying; melted spool is worse), so we err
  1524. toward conservative.
  1525. """
  1526. assert supports_drying_while_printing("FUTURE_MODEL", "99.99.99.99") is False
  1527. class TestGetDerivedStatusName:
  1528. """Tests for get_derived_status_name function."""
  1529. def test_stg_cur_255_returns_none(self):
  1530. """Verify stg_cur=255 (A1/P1 idle) returns None, not 'Unknown stage (255)'."""
  1531. state = MagicMock()
  1532. state.stg_cur = 255
  1533. state.state = "IDLE"
  1534. result = get_derived_status_name(state)
  1535. assert result is None
  1536. def test_stg_cur_negative_one_returns_none_when_idle(self):
  1537. """Verify stg_cur=-1 (X1 idle) returns None."""
  1538. state = MagicMock()
  1539. state.stg_cur = -1
  1540. state.state = "IDLE"
  1541. result = get_derived_status_name(state)
  1542. assert result is None
  1543. def test_valid_stage_returns_name(self):
  1544. """Verify valid stg_cur values return stage name."""
  1545. state = MagicMock()
  1546. state.stg_cur = 1 # Auto bed leveling
  1547. result = get_derived_status_name(state)
  1548. assert result == "Auto bed leveling"
  1549. def test_stg_cur_zero_returns_printing(self):
  1550. """Verify stg_cur=0 returns 'Printing' when no model specified."""
  1551. state = MagicMock()
  1552. state.stg_cur = 0
  1553. result = get_derived_status_name(state)
  1554. assert result == "Printing"
  1555. def test_a1_idle_with_stg_cur_zero_returns_none(self):
  1556. """Verify A1 with IDLE state and stg_cur=0 returns None (bug workaround)."""
  1557. state = MagicMock()
  1558. state.stg_cur = 0
  1559. state.state = "IDLE"
  1560. # Test various A1 model names
  1561. for model in ["A1", "A1 Mini", "A1-Mini", "A1MINI", "N1", "N2S"]:
  1562. result = get_derived_status_name(state, model)
  1563. assert result is None, f"Expected None for model {model}"
  1564. def test_a1_running_with_stg_cur_zero_returns_printing(self):
  1565. """Verify A1 with RUNNING state and stg_cur=0 still returns 'Printing'."""
  1566. state = MagicMock()
  1567. state.stg_cur = 0
  1568. state.state = "RUNNING"
  1569. result = get_derived_status_name(state, "A1")
  1570. assert result == "Printing"
  1571. def test_non_a1_idle_with_stg_cur_zero_returns_printing(self):
  1572. """Verify non-A1 models with IDLE and stg_cur=0 still return 'Printing'."""
  1573. state = MagicMock()
  1574. state.stg_cur = 0
  1575. state.state = "IDLE"
  1576. # X1C should not get the workaround
  1577. result = get_derived_status_name(state, "X1C")
  1578. assert result == "Printing"
  1579. class TestHasStgCurIdleBug:
  1580. """Tests for has_stg_cur_idle_bug function."""
  1581. def test_a1_models_return_true(self):
  1582. """Verify A1 model variants return True."""
  1583. assert has_stg_cur_idle_bug("A1") is True
  1584. assert has_stg_cur_idle_bug("A1 Mini") is True
  1585. assert has_stg_cur_idle_bug("A1-Mini") is True
  1586. assert has_stg_cur_idle_bug("A1MINI") is True
  1587. assert has_stg_cur_idle_bug("a1") is True # case insensitive
  1588. assert has_stg_cur_idle_bug("a1 mini") is True
  1589. def test_p1_models_return_true(self):
  1590. """Verify P1P/P1S model variants return True."""
  1591. assert has_stg_cur_idle_bug("P1P") is True
  1592. assert has_stg_cur_idle_bug("P1S") is True
  1593. assert has_stg_cur_idle_bug("p1p") is True # case insensitive
  1594. def test_internal_codes_return_true(self):
  1595. """Verify internal model codes return True."""
  1596. assert has_stg_cur_idle_bug("N1") is True # A1 Mini
  1597. assert has_stg_cur_idle_bug("N2S") is True # A1
  1598. assert has_stg_cur_idle_bug("C11") is True # P1P
  1599. assert has_stg_cur_idle_bug("C12") is True # P1S
  1600. def test_non_affected_models_return_false(self):
  1601. """Verify non-affected models return False."""
  1602. assert has_stg_cur_idle_bug("X1C") is False
  1603. assert has_stg_cur_idle_bug("X1") is False
  1604. assert has_stg_cur_idle_bug("H2D") is False
  1605. def test_none_model_returns_false(self):
  1606. """Verify None model returns False."""
  1607. assert has_stg_cur_idle_bug(None) is False
  1608. def test_empty_model_returns_false(self):
  1609. """Verify empty model returns False."""
  1610. assert has_stg_cur_idle_bug("") is False
  1611. class TestInitPrinterConnections:
  1612. """Tests for init_printer_connections function."""
  1613. @pytest.mark.asyncio
  1614. async def test_connects_all_active_printers(self):
  1615. """Verify all active printers are connected."""
  1616. mock_db = AsyncMock()
  1617. mock_printer1 = MagicMock(id=1, is_active=True)
  1618. mock_printer2 = MagicMock(id=2, is_active=True)
  1619. mock_result = MagicMock()
  1620. mock_result.scalars.return_value.all.return_value = [mock_printer1, mock_printer2]
  1621. mock_db.execute.return_value = mock_result
  1622. with patch("backend.app.services.printer_manager.printer_manager") as mock_manager:
  1623. mock_manager.connect_printer = AsyncMock()
  1624. await init_printer_connections(mock_db)
  1625. assert mock_manager.connect_printer.call_count == 2
  1626. @pytest.mark.asyncio
  1627. async def test_handles_empty_printer_list(self):
  1628. """Verify empty printer list is handled."""
  1629. mock_db = AsyncMock()
  1630. mock_result = MagicMock()
  1631. mock_result.scalars.return_value.all.return_value = []
  1632. mock_db.execute.return_value = mock_result
  1633. with patch("backend.app.services.printer_manager.printer_manager") as mock_manager:
  1634. mock_manager.connect_printer = AsyncMock()
  1635. await init_printer_connections(mock_db)
  1636. mock_manager.connect_printer.assert_not_called()
  1637. @pytest.mark.asyncio
  1638. async def test_one_failing_printer_does_not_abort_the_rest(self):
  1639. """A single unreachable printer must not abort startup or the others (#2572).
  1640. The connections are gathered with return_exceptions=True. The old serial
  1641. ``await`` loop had no error handling, so the first printer that raised
  1642. propagated straight out of init_printer_connections and failed the
  1643. FastAPI lifespan — taking the whole app down over one bad row, and
  1644. skipping every printer after it. This asserts the isolation: every
  1645. printer is still attempted and the exception never escapes.
  1646. """
  1647. mock_db = AsyncMock()
  1648. printers = [MagicMock(id=i, name=f"p{i}", is_active=True) for i in range(3)]
  1649. mock_result = MagicMock()
  1650. mock_result.scalars.return_value.all.return_value = printers
  1651. mock_db.execute.return_value = mock_result
  1652. async def connect(printer):
  1653. if printer.id == 1:
  1654. raise ConnectionError("printer 1 is unreachable")
  1655. return True
  1656. with patch("backend.app.services.printer_manager.printer_manager") as mock_manager:
  1657. mock_manager.connect_printer = AsyncMock(side_effect=connect)
  1658. # Must not raise despite printer 1 failing.
  1659. await init_printer_connections(mock_db)
  1660. # All three were still attempted (not aborted at the failing one).
  1661. assert mock_manager.connect_printer.call_count == 3
  1662. class TestAmsChangeCallback:
  1663. """Tests for AMS change callback functionality."""
  1664. @pytest.fixture
  1665. def manager(self):
  1666. """Create a fresh PrinterManager instance."""
  1667. return PrinterManager()
  1668. def test_ams_change_callback_is_triggered(self, manager):
  1669. """Verify AMS change callback is called when AMS data changes."""
  1670. callback = MagicMock()
  1671. manager.set_ams_change_callback(callback)
  1672. # Verify callback was set
  1673. assert manager._on_ams_change == callback
  1674. def test_ams_change_callback_receives_correct_data(self, manager):
  1675. """Verify AMS change callback receives the correct AMS data format."""
  1676. received_data = []
  1677. def capture_callback(printer_id, ams_data):
  1678. received_data.append((printer_id, ams_data))
  1679. manager.set_ams_change_callback(capture_callback)
  1680. # The callback should accept printer_id and ams_data
  1681. # This tests the callback signature
  1682. assert manager._on_ams_change is not None
  1683. assert callable(manager._on_ams_change)
  1684. class TestParsePlateId:
  1685. """Tests for parse_plate_id() — active-print plate extraction from gcode paths.
  1686. Regression coverage for #881 follow-up: the REST /status endpoint and the
  1687. WebSocket push path both use this helper, so they must agree on the plate
  1688. number the frontend sees.
  1689. """
  1690. def test_bambu_metadata_path(self):
  1691. # Canonical path that Bambu Studio / OrcaSlicer stamp into the 3MF.
  1692. assert parse_plate_id("/Metadata/plate_2.gcode") == 2
  1693. def test_plate_one(self):
  1694. assert parse_plate_id("/Metadata/plate_1.gcode") == 1
  1695. def test_double_digit_plate(self):
  1696. assert parse_plate_id("/Metadata/plate_12.gcode") == 12
  1697. def test_none_input(self):
  1698. assert parse_plate_id(None) is None
  1699. def test_empty_string(self):
  1700. assert parse_plate_id("") is None
  1701. def test_path_without_plate_segment(self):
  1702. # Some firmware / slicers report a bare filename without the plate marker.
  1703. assert parse_plate_id("/upload/my-model.gcode") is None
  1704. def test_similar_but_non_matching_names(self):
  1705. # "plate.gcode" (no number) and "nameplate_2.gcode" (substring) must not
  1706. # be mistaken for real plate markers. The regex anchors on `plate_<num>`.
  1707. assert parse_plate_id("/Metadata/plate.gcode") is None
  1708. assert parse_plate_id("/plates/3.gcode") is None
  1709. def test_substring_match_still_extracts(self):
  1710. # The regex isn't anchored to the start of a segment — any occurrence
  1711. # wins. This matches real Bambu paths where the segment is preceded by
  1712. # arbitrary directory noise, and matches the equivalent frontend regex.
  1713. assert parse_plate_id("/uploads/project/plate_5.gcode.md5") == 5
  1714. class TestResolvePlateId:
  1715. """Tests for resolve_plate_id() — plate resolution with dispatch precedence.
  1716. Regression coverage for #1166: P1S firmware 01.10.00.00 only puts the .3mf
  1717. filename in print.gcode_file, so parse_plate_id() returns None and the
  1718. printer card falls back to plate 1. When Bambuddy dispatches the print
  1719. itself we know the right plate; resolve_plate_id() prefers that record over
  1720. the gcode_file regex when subtask_name matches.
  1721. """
  1722. def _make_state(self, **kwargs):
  1723. from backend.app.services.bambu_mqtt import PrinterState
  1724. state = PrinterState()
  1725. for k, v in kwargs.items():
  1726. setattr(state, k, v)
  1727. return state
  1728. def test_dispatched_plate_wins_when_subtask_matches(self):
  1729. # User dispatches plate 4 via Bambuddy. Printer reflects subtask_name
  1730. # but firmware drops the plate path from gcode_file. Without the dispatch
  1731. # record we'd default to plate 1.
  1732. from backend.app.services.printer_manager import resolve_plate_id
  1733. state = self._make_state(
  1734. gcode_file="MyModel.3mf", # No plate path — firmware bug
  1735. subtask_name="MyModel",
  1736. dispatched_plate_id=4,
  1737. dispatched_subtask="MyModel",
  1738. )
  1739. assert resolve_plate_id(state) == 4
  1740. def test_dispatched_ignored_when_subtask_differs(self):
  1741. # Bambuddy's dispatch record is for a previous print; the printer is
  1742. # now running a different subtask (Studio-direct dispatch). The stale
  1743. # record must not be used — fall back to gcode_file regex.
  1744. from backend.app.services.printer_manager import resolve_plate_id
  1745. state = self._make_state(
  1746. gcode_file="/Metadata/plate_2.gcode",
  1747. subtask_name="DifferentPrint",
  1748. dispatched_plate_id=4,
  1749. dispatched_subtask="MyModel",
  1750. )
  1751. assert resolve_plate_id(state) == 2
  1752. def test_falls_back_to_gcode_regex_without_dispatch(self):
  1753. # Studio-direct dispatch — no Bambuddy dispatch record. Existing logic
  1754. # (parse_plate_id on gcode_file) must still work.
  1755. from backend.app.services.printer_manager import resolve_plate_id
  1756. state = self._make_state(
  1757. gcode_file="/Metadata/plate_3.gcode",
  1758. subtask_name="MyModel",
  1759. )
  1760. assert resolve_plate_id(state) == 3
  1761. def test_returns_none_when_nothing_resolvable(self):
  1762. # No dispatch record AND firmware swallowed the plate path. The route
  1763. # uses this signal to invoke the 3MF-scan fallback.
  1764. from backend.app.services.printer_manager import resolve_plate_id
  1765. state = self._make_state(
  1766. gcode_file="MyModel.3mf",
  1767. subtask_name="MyModel",
  1768. )
  1769. assert resolve_plate_id(state) is None
  1770. def test_dispatched_subtask_required_to_avoid_false_match(self):
  1771. # dispatched_plate_id without dispatched_subtask is incomplete — we
  1772. # can't validate it points at the current print, so we ignore it.
  1773. from backend.app.services.printer_manager import resolve_plate_id
  1774. state = self._make_state(
  1775. gcode_file="MyModel.3mf",
  1776. subtask_name="MyModel",
  1777. dispatched_plate_id=4,
  1778. dispatched_subtask=None,
  1779. )
  1780. assert resolve_plate_id(state) is None