test_printer_manager.py 66 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720
  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. get_derived_status_name,
  10. has_stg_cur_idle_bug,
  11. init_printer_connections,
  12. parse_plate_id,
  13. printer_state_to_dict,
  14. supports_chamber_temp,
  15. supports_drying,
  16. )
  17. class TestPrinterManager:
  18. """Tests for PrinterManager class."""
  19. @pytest.fixture
  20. def manager(self):
  21. """Create a fresh PrinterManager instance."""
  22. return PrinterManager()
  23. @pytest.fixture
  24. def mock_printer(self):
  25. """Create a mock Printer object."""
  26. printer = MagicMock()
  27. printer.id = 1
  28. printer.ip_address = "192.168.1.100"
  29. printer.serial_number = "00M09A123456789"
  30. printer.access_code = "12345678"
  31. printer.is_active = True
  32. return printer
  33. @pytest.fixture
  34. def mock_client(self):
  35. """Create a mock BambuMQTTClient."""
  36. client = MagicMock()
  37. client.state = MagicMock()
  38. client.state.connected = True
  39. client.state.state = "IDLE"
  40. client.state.progress = 0
  41. client.state.temperatures = {"nozzle": 25, "bed": 25}
  42. client.state.raw_data = {}
  43. client.logging_enabled = False
  44. return client
  45. # ========================================================================
  46. # Tests for initialization
  47. # ========================================================================
  48. def test_init_creates_empty_clients_dict(self, manager):
  49. """Verify manager initializes with empty clients dict."""
  50. assert manager._clients == {}
  51. def test_init_callbacks_are_none(self, manager):
  52. """Verify all callbacks are initially None."""
  53. assert manager._on_print_start is None
  54. assert manager._on_print_complete is None
  55. assert manager._on_status_change is None
  56. assert manager._on_ams_change is None
  57. def test_init_loop_is_none(self, manager):
  58. """Verify event loop is initially None."""
  59. assert manager._loop is None
  60. # ========================================================================
  61. # Tests for callback setters
  62. # ========================================================================
  63. def test_set_event_loop(self, manager):
  64. """Verify event loop can be set."""
  65. mock_loop = MagicMock()
  66. manager.set_event_loop(mock_loop)
  67. assert manager._loop == mock_loop
  68. def test_set_print_start_callback(self, manager):
  69. """Verify print start callback can be set."""
  70. callback = MagicMock()
  71. manager.set_print_start_callback(callback)
  72. assert manager._on_print_start == callback
  73. def test_set_print_complete_callback(self, manager):
  74. """Verify print complete callback can be set."""
  75. callback = MagicMock()
  76. manager.set_print_complete_callback(callback)
  77. assert manager._on_print_complete == callback
  78. def test_set_status_change_callback(self, manager):
  79. """Verify status change callback can be set."""
  80. callback = MagicMock()
  81. manager.set_status_change_callback(callback)
  82. assert manager._on_status_change == callback
  83. def test_set_ams_change_callback(self, manager):
  84. """Verify AMS change callback can be set."""
  85. callback = MagicMock()
  86. manager.set_ams_change_callback(callback)
  87. assert manager._on_ams_change == callback
  88. # ========================================================================
  89. # Tests for _schedule_async
  90. # ========================================================================
  91. def test_schedule_async_with_running_loop(self, manager):
  92. """Verify async coroutine is scheduled when loop is running."""
  93. mock_loop = MagicMock()
  94. mock_loop.is_running.return_value = True
  95. manager._loop = mock_loop
  96. async def dummy_coro():
  97. pass
  98. coro = dummy_coro()
  99. manager._schedule_async(coro)
  100. mock_loop.is_running.assert_called_once()
  101. # Clean up the coroutine
  102. coro.close()
  103. def test_schedule_async_without_loop(self, manager):
  104. """Verify nothing happens when no loop is set."""
  105. async def dummy_coro():
  106. pass
  107. coro = dummy_coro()
  108. # Should not raise
  109. manager._schedule_async(coro)
  110. coro.close()
  111. def test_schedule_async_with_stopped_loop(self, manager):
  112. """Verify nothing happens when loop is not running."""
  113. mock_loop = MagicMock()
  114. mock_loop.is_running.return_value = False
  115. manager._loop = mock_loop
  116. async def dummy_coro():
  117. pass
  118. coro = dummy_coro()
  119. manager._schedule_async(coro)
  120. coro.close()
  121. # ========================================================================
  122. # Tests for connect_printer
  123. # ========================================================================
  124. @pytest.mark.asyncio
  125. async def test_connect_printer_creates_client(self, manager, mock_printer):
  126. """Verify connecting creates an MQTT client."""
  127. with patch("backend.app.services.printer_manager.BambuMQTTClient") as MockClient:
  128. mock_instance = MagicMock()
  129. mock_instance.state = MagicMock()
  130. mock_instance.state.connected = True
  131. MockClient.return_value = mock_instance
  132. result = await manager.connect_printer(mock_printer)
  133. MockClient.assert_called_once()
  134. mock_instance.connect.assert_called_once()
  135. assert mock_printer.id in manager._clients
  136. assert result is True
  137. @pytest.mark.asyncio
  138. async def test_connect_printer_disconnects_existing(self, manager, mock_printer, mock_client):
  139. """Verify connecting disconnects existing client first."""
  140. manager._clients[mock_printer.id] = mock_client
  141. with patch("backend.app.services.printer_manager.BambuMQTTClient") as MockClient:
  142. new_client = MagicMock()
  143. new_client.state = MagicMock()
  144. new_client.state.connected = True
  145. MockClient.return_value = new_client
  146. await manager.connect_printer(mock_printer)
  147. mock_client.disconnect.assert_called_once()
  148. @pytest.mark.asyncio
  149. async def test_connect_printer_returns_false_on_failure(self, manager, mock_printer):
  150. """Verify returns False when connection fails."""
  151. with patch("backend.app.services.printer_manager.BambuMQTTClient") as MockClient:
  152. mock_instance = MagicMock()
  153. mock_instance.state = MagicMock()
  154. mock_instance.state.connected = False
  155. MockClient.return_value = mock_instance
  156. result = await manager.connect_printer(mock_printer)
  157. assert result is False
  158. # ========================================================================
  159. # Tests for disconnect_printer
  160. # ========================================================================
  161. def test_disconnect_printer_removes_client(self, manager, mock_client):
  162. """Verify disconnecting removes and disconnects client."""
  163. manager._clients[1] = mock_client
  164. manager.disconnect_printer(1)
  165. mock_client.disconnect.assert_called_once()
  166. assert 1 not in manager._clients
  167. def test_disconnect_printer_handles_missing(self, manager):
  168. """Verify disconnecting non-existent printer doesn't raise."""
  169. manager.disconnect_printer(999) # Should not raise
  170. # ========================================================================
  171. # Tests for disconnect_all
  172. # ========================================================================
  173. def test_disconnect_all_disconnects_all_clients(self, manager):
  174. """Verify all clients are disconnected."""
  175. client1 = MagicMock()
  176. client2 = MagicMock()
  177. manager._clients[1] = client1
  178. manager._clients[2] = client2
  179. manager.disconnect_all()
  180. client1.disconnect.assert_called_once()
  181. client2.disconnect.assert_called_once()
  182. assert len(manager._clients) == 0
  183. # ========================================================================
  184. # Tests for get_status
  185. # ========================================================================
  186. def test_get_status_returns_state(self, manager, mock_client):
  187. """Verify get_status returns client state."""
  188. manager._clients[1] = mock_client
  189. result = manager.get_status(1)
  190. mock_client.check_staleness.assert_called_once()
  191. assert result == mock_client.state
  192. def test_get_status_returns_none_for_unknown(self, manager):
  193. """Verify get_status returns None for unknown printer."""
  194. result = manager.get_status(999)
  195. assert result is None
  196. # ========================================================================
  197. # Tests for get_all_statuses
  198. # ========================================================================
  199. def test_get_all_statuses_returns_all(self, manager):
  200. """Verify all statuses are returned."""
  201. client1 = MagicMock()
  202. client1.state = MagicMock(connected=True)
  203. client2 = MagicMock()
  204. client2.state = MagicMock(connected=False)
  205. manager._clients[1] = client1
  206. manager._clients[2] = client2
  207. result = manager.get_all_statuses()
  208. assert len(result) == 2
  209. assert 1 in result
  210. assert 2 in result
  211. client1.check_staleness.assert_called_once()
  212. client2.check_staleness.assert_called_once()
  213. # ========================================================================
  214. # Tests for is_connected
  215. # ========================================================================
  216. def test_is_connected_returns_true(self, manager, mock_client):
  217. """Verify is_connected returns True for connected printer."""
  218. mock_client.check_staleness.return_value = True
  219. manager._clients[1] = mock_client
  220. result = manager.is_connected(1)
  221. assert result is True
  222. def test_is_connected_returns_false_for_unknown(self, manager):
  223. """Verify is_connected returns False for unknown printer."""
  224. result = manager.is_connected(999)
  225. assert result is False
  226. # ========================================================================
  227. # Tests for get_client
  228. # ========================================================================
  229. def test_get_client_returns_client(self, manager, mock_client):
  230. """Verify get_client returns the client."""
  231. manager._clients[1] = mock_client
  232. result = manager.get_client(1)
  233. assert result == mock_client
  234. def test_get_client_returns_none_for_unknown(self, manager):
  235. """Verify get_client returns None for unknown printer."""
  236. result = manager.get_client(999)
  237. assert result is None
  238. # ========================================================================
  239. # Tests for mark_printer_offline
  240. # ========================================================================
  241. def test_mark_printer_offline_updates_state(self, manager, mock_client):
  242. """Verify mark_printer_offline updates client state."""
  243. mock_client.state.connected = True
  244. manager._clients[1] = mock_client
  245. manager.mark_printer_offline(1)
  246. assert mock_client.state.connected is False
  247. assert mock_client.state.state == "unknown"
  248. def test_mark_printer_offline_triggers_callback(self, manager, mock_client):
  249. """Verify mark_printer_offline triggers status callback."""
  250. mock_client.state.connected = True
  251. manager._clients[1] = mock_client
  252. # Callback must return a coroutine
  253. async def async_callback(printer_id, state):
  254. pass
  255. manager._on_status_change = async_callback
  256. # Need a running loop for callback
  257. mock_loop = MagicMock()
  258. mock_loop.is_running.return_value = True
  259. manager._loop = mock_loop
  260. manager.mark_printer_offline(1)
  261. # Callback should be scheduled via run_coroutine_threadsafe
  262. mock_loop.is_running.assert_called()
  263. # State should be updated
  264. assert mock_client.state.connected is False
  265. def test_mark_printer_offline_handles_unknown(self, manager):
  266. """Verify mark_printer_offline handles unknown printer."""
  267. manager.mark_printer_offline(999) # Should not raise
  268. def test_mark_printer_offline_skips_already_offline(self, manager, mock_client):
  269. """Verify mark_printer_offline skips already offline printer."""
  270. mock_client.state.connected = False
  271. manager._clients[1] = mock_client
  272. manager.mark_printer_offline(1)
  273. # State should remain unchanged
  274. assert mock_client.state.connected is False
  275. # ========================================================================
  276. # Tests for start_print
  277. # ========================================================================
  278. def test_start_print_calls_client(self, manager, mock_client):
  279. """Verify start_print calls client method."""
  280. mock_client.start_print.return_value = True
  281. manager._clients[1] = mock_client
  282. result = manager.start_print(1, "test.gcode")
  283. mock_client.start_print.assert_called_once_with(
  284. "test.gcode",
  285. 1,
  286. ams_mapping=None,
  287. timelapse=False,
  288. bed_levelling=True,
  289. flow_cali=False,
  290. vibration_cali=True,
  291. layer_inspect=False,
  292. use_ams=True,
  293. nozzle_offset_cali=False,
  294. nozzle_mapping=None,
  295. )
  296. assert result is True
  297. def test_start_print_returns_false_for_unknown(self, manager):
  298. """Verify start_print returns False for unknown printer."""
  299. result = manager.start_print(999, "test.gcode")
  300. assert result is False
  301. def test_start_print_logs_print_command_with_caller(self, manager, mock_client, caplog):
  302. """Verify start_print logs PRINT COMMAND with caller info (#374)."""
  303. mock_client.start_print.return_value = True
  304. manager._clients[1] = mock_client
  305. with caplog.at_level(logging.INFO, logger="backend.app.services.printer_manager"):
  306. manager.start_print(1, "benchy.3mf")
  307. print_cmd_logs = [r for r in caplog.records if "PRINT COMMAND" in r.message]
  308. assert len(print_cmd_logs) == 1
  309. log_msg = print_cmd_logs[0].message
  310. assert "printer=1" in log_msg
  311. assert "file=benchy.3mf" in log_msg
  312. assert "caller=" in log_msg
  313. def test_start_print_logs_even_when_printer_unknown(self, manager, caplog):
  314. """Verify PRINT COMMAND is logged even for unknown printers (#374)."""
  315. with caplog.at_level(logging.INFO, logger="backend.app.services.printer_manager"):
  316. result = manager.start_print(999, "ghost.3mf")
  317. assert result is False
  318. print_cmd_logs = [r for r in caplog.records if "PRINT COMMAND" in r.message]
  319. assert len(print_cmd_logs) == 1
  320. # ========================================================================
  321. # Tests for stop_print
  322. # ========================================================================
  323. def test_stop_print_calls_client(self, manager, mock_client):
  324. """Verify stop_print calls client method."""
  325. mock_client.stop_print.return_value = True
  326. manager._clients[1] = mock_client
  327. result = manager.stop_print(1)
  328. mock_client.stop_print.assert_called_once()
  329. assert result is True
  330. def test_stop_print_returns_false_for_unknown(self, manager):
  331. """Verify stop_print returns False for unknown printer."""
  332. result = manager.stop_print(999)
  333. assert result is False
  334. # ========================================================================
  335. # Tests for wait_for_cooldown
  336. # ========================================================================
  337. @pytest.mark.asyncio
  338. async def test_wait_for_cooldown_returns_true_when_cool(self, manager, mock_client):
  339. """Verify wait_for_cooldown returns True when printer is cool."""
  340. mock_client.state.connected = True
  341. mock_client.state.temperatures = {"nozzle": 40, "bed": 30}
  342. mock_client.check_staleness.return_value = True
  343. manager._clients[1] = mock_client
  344. result = await manager.wait_for_cooldown(1, target_temp=50)
  345. assert result is True
  346. @pytest.mark.asyncio
  347. async def test_wait_for_cooldown_returns_false_on_disconnect(self, manager, mock_client):
  348. """Verify wait_for_cooldown returns False when printer disconnects."""
  349. mock_client.state.connected = False
  350. mock_client.check_staleness.return_value = False
  351. manager._clients[1] = mock_client
  352. result = await manager.wait_for_cooldown(1, target_temp=50, timeout=1)
  353. assert result is False
  354. @pytest.mark.asyncio
  355. async def test_wait_for_cooldown_returns_false_for_unknown(self, manager):
  356. """Verify wait_for_cooldown returns False for unknown printer."""
  357. result = await manager.wait_for_cooldown(999, target_temp=50, timeout=1)
  358. assert result is False
  359. @pytest.mark.asyncio
  360. async def test_wait_for_cooldown_checks_both_nozzles(self, manager, mock_client):
  361. """Verify wait_for_cooldown checks both nozzles for dual extruders."""
  362. mock_client.state.connected = True
  363. mock_client.state.temperatures = {"nozzle": 40, "nozzle_2": 45, "bed": 30}
  364. mock_client.check_staleness.return_value = True
  365. manager._clients[1] = mock_client
  366. result = await manager.wait_for_cooldown(1, target_temp=50)
  367. assert result is True
  368. # ========================================================================
  369. # Tests for logging methods
  370. # ========================================================================
  371. def test_enable_logging_calls_client(self, manager, mock_client):
  372. """Verify enable_logging calls client method."""
  373. manager._clients[1] = mock_client
  374. result = manager.enable_logging(1, True)
  375. mock_client.enable_logging.assert_called_once_with(True)
  376. assert result is True
  377. def test_enable_logging_returns_false_for_unknown(self, manager):
  378. """Verify enable_logging returns False for unknown printer."""
  379. result = manager.enable_logging(999, True)
  380. assert result is False
  381. def test_get_logs_returns_logs(self, manager, mock_client):
  382. """Verify get_logs returns client logs."""
  383. mock_logs = [MagicMock(), MagicMock()]
  384. mock_client.get_logs.return_value = mock_logs
  385. manager._clients[1] = mock_client
  386. result = manager.get_logs(1)
  387. assert result == mock_logs
  388. def test_get_logs_returns_empty_for_unknown(self, manager):
  389. """Verify get_logs returns empty list for unknown printer."""
  390. result = manager.get_logs(999)
  391. assert result == []
  392. def test_clear_logs_calls_client(self, manager, mock_client):
  393. """Verify clear_logs calls client method."""
  394. manager._clients[1] = mock_client
  395. result = manager.clear_logs(1)
  396. mock_client.clear_logs.assert_called_once()
  397. assert result is True
  398. def test_clear_logs_returns_false_for_unknown(self, manager):
  399. """Verify clear_logs returns False for unknown printer."""
  400. result = manager.clear_logs(999)
  401. assert result is False
  402. def test_is_logging_enabled_returns_status(self, manager, mock_client):
  403. """Verify is_logging_enabled returns client status."""
  404. mock_client.logging_enabled = True
  405. manager._clients[1] = mock_client
  406. result = manager.is_logging_enabled(1)
  407. assert result is True
  408. def test_is_logging_enabled_returns_false_for_unknown(self, manager):
  409. """Verify is_logging_enabled returns False for unknown printer."""
  410. result = manager.is_logging_enabled(999)
  411. assert result is False
  412. # ========================================================================
  413. # Tests for request_status_update
  414. # ========================================================================
  415. def test_request_status_update_calls_client(self, manager, mock_client):
  416. """Verify request_status_update calls client method."""
  417. mock_client.request_status_update.return_value = True
  418. manager._clients[1] = mock_client
  419. result = manager.request_status_update(1)
  420. mock_client.request_status_update.assert_called_once()
  421. assert result is True
  422. def test_request_status_update_returns_false_for_unknown(self, manager):
  423. """Verify request_status_update returns False for unknown printer."""
  424. result = manager.request_status_update(999)
  425. assert result is False
  426. # ========================================================================
  427. # Tests for test_connection
  428. # ========================================================================
  429. @pytest.mark.asyncio
  430. async def test_test_connection_success(self, manager):
  431. """Verify test_connection returns success on connection."""
  432. with patch("backend.app.services.printer_manager.BambuMQTTClient") as MockClient:
  433. mock_instance = MagicMock()
  434. mock_instance.state = MagicMock()
  435. mock_instance.state.connected = True
  436. mock_instance.state.state = "IDLE"
  437. mock_instance.state.raw_data = {"device_model": "X1C"}
  438. MockClient.return_value = mock_instance
  439. result = await manager.test_connection("192.168.1.100", "00M09A123456789", "12345678")
  440. assert result["success"] is True
  441. assert result["state"] == "IDLE"
  442. assert result["model"] == "X1C"
  443. mock_instance.disconnect.assert_called_once()
  444. @pytest.mark.asyncio
  445. async def test_test_connection_failure(self, manager):
  446. """Verify test_connection returns failure on connection error."""
  447. with patch("backend.app.services.printer_manager.BambuMQTTClient") as MockClient:
  448. mock_instance = MagicMock()
  449. mock_instance.state = MagicMock()
  450. mock_instance.state.connected = False
  451. MockClient.return_value = mock_instance
  452. # Shorten the probe budget so the test doesn't burn the full
  453. # 8-second production timeout while polling a failing connection.
  454. with (
  455. patch.object(manager, "PROBE_TIMEOUT_SECONDS", 0.4),
  456. patch.object(manager, "PROBE_POLL_INTERVAL_SECONDS", 0.1),
  457. ):
  458. result = await manager.test_connection("192.168.1.100", "00M09A123456789", "12345678")
  459. assert result["success"] is False
  460. assert result["state"] is None
  461. mock_instance.disconnect.assert_called_once()
  462. @pytest.mark.asyncio
  463. async def test_test_connection_polls_and_returns_early_on_connect(self, manager):
  464. """#1445: a slow printer that finishes its handshake mid-probe must
  465. not be reported as a failure. Previously a fixed 2s sleep meant P1S
  466. TLS / CONNACK that took 3-5s got falsely rejected; now we poll and
  467. early-return as soon as connected flips True.
  468. """
  469. import asyncio
  470. import time
  471. with patch("backend.app.services.printer_manager.BambuMQTTClient") as MockClient:
  472. mock_instance = MagicMock()
  473. mock_instance.state = MagicMock()
  474. mock_instance.state.connected = False # not connected at probe start
  475. mock_instance.state.state = "IDLE"
  476. mock_instance.state.raw_data = {"device_model": "P1S"}
  477. MockClient.return_value = mock_instance
  478. async def flip_connected_after(delay: float):
  479. await asyncio.sleep(delay)
  480. mock_instance.state.connected = True
  481. # Simulates the P1S broker finishing its slow handshake ~0.5s in,
  482. # well past the old 2s-or-fail boundary's natural variance.
  483. with (
  484. patch.object(manager, "PROBE_TIMEOUT_SECONDS", 3.0),
  485. patch.object(manager, "PROBE_POLL_INTERVAL_SECONDS", 0.05),
  486. ):
  487. start = time.monotonic()
  488. flip_task = asyncio.create_task(flip_connected_after(0.5))
  489. try:
  490. result = await manager.test_connection("192.168.1.100", "00M09A123456789", "12345678")
  491. finally:
  492. await flip_task
  493. elapsed = time.monotonic() - start
  494. assert result["success"] is True
  495. assert result["state"] == "IDLE"
  496. # Early-return guarantee: must come back well before the configured
  497. # timeout once connected flips. ~0.5s + one poll interval is plenty.
  498. assert elapsed < 1.5, f"probe should have early-returned shortly after 0.5s, took {elapsed:.2f}s"
  499. @pytest.mark.asyncio
  500. async def test_test_connection_disconnect_runs_off_loop(self, manager):
  501. """#1445: the root cause of the "Docker container hangs" symptom was
  502. `client.disconnect()` running on the asyncio thread — paho's
  503. `loop_stop()` does a thread-join that blocks until its network
  504. thread exits, which on a slow P1S TLS handshake could take many
  505. seconds. This test pins the off-loop teardown so a regression that
  506. reintroduces sync disconnect breaks CI immediately.
  507. """
  508. import asyncio
  509. import threading
  510. import time
  511. with patch("backend.app.services.printer_manager.BambuMQTTClient") as MockClient:
  512. asyncio_thread_id = threading.get_ident()
  513. disconnect_thread_ids: list[int] = []
  514. disconnect_blocked_for: list[float] = []
  515. def slow_blocking_disconnect():
  516. # Mirrors paho.Client.loop_stop()'s thread-join semantics —
  517. # if this runs on the asyncio thread the event loop stalls.
  518. disconnect_thread_ids.append(threading.get_ident())
  519. start = time.monotonic()
  520. time.sleep(0.4)
  521. disconnect_blocked_for.append(time.monotonic() - start)
  522. mock_instance = MagicMock()
  523. mock_instance.state = MagicMock()
  524. mock_instance.state.connected = True
  525. mock_instance.state.state = "IDLE"
  526. mock_instance.state.raw_data = {"device_model": "P1S"}
  527. mock_instance.disconnect = slow_blocking_disconnect
  528. MockClient.return_value = mock_instance
  529. # Another coroutine must keep making progress while disconnect()
  530. # runs — proves the event loop was not blocked.
  531. event_loop_alive_ticks = 0
  532. async def heartbeat():
  533. nonlocal event_loop_alive_ticks
  534. while True:
  535. await asyncio.sleep(0.05)
  536. event_loop_alive_ticks += 1
  537. heartbeat_task = asyncio.create_task(heartbeat())
  538. try:
  539. await manager.test_connection("192.168.1.100", "00M09A123456789", "12345678")
  540. finally:
  541. heartbeat_task.cancel()
  542. try:
  543. await heartbeat_task
  544. except asyncio.CancelledError:
  545. pass
  546. # disconnect ran on a different thread than asyncio's
  547. assert disconnect_thread_ids, "disconnect was never called"
  548. assert disconnect_thread_ids[0] != asyncio_thread_id, (
  549. "disconnect ran on the asyncio thread — this blocks the event loop (#1445)"
  550. )
  551. # Heartbeat made progress while the 0.4s disconnect was blocking
  552. # the worker thread (proves the loop wasn't stalled).
  553. assert event_loop_alive_ticks >= 3, (
  554. f"event loop appears to have stalled during disconnect "
  555. f"(only {event_loop_alive_ticks} heartbeats; expected >=3)"
  556. )
  557. # ========================================================================
  558. # Tests for current print user tracking (Issue #206)
  559. # ========================================================================
  560. def test_set_current_print_user(self, manager):
  561. """Verify current print user can be set."""
  562. manager.set_current_print_user(1, 42, "testuser")
  563. assert 1 in manager._current_print_user
  564. assert manager._current_print_user[1]["user_id"] == 42
  565. assert manager._current_print_user[1]["username"] == "testuser"
  566. def test_get_current_print_user_returns_user(self, manager):
  567. """Verify get_current_print_user returns the stored user."""
  568. manager.set_current_print_user(1, 42, "testuser")
  569. result = manager.get_current_print_user(1)
  570. assert result is not None
  571. assert result["user_id"] == 42
  572. assert result["username"] == "testuser"
  573. def test_get_current_print_user_returns_none_for_unknown(self, manager):
  574. """Verify get_current_print_user returns None for unknown printer."""
  575. result = manager.get_current_print_user(999)
  576. assert result is None
  577. def test_clear_current_print_user(self, manager):
  578. """Verify current print user can be cleared."""
  579. manager.set_current_print_user(1, 42, "testuser")
  580. manager.clear_current_print_user(1)
  581. result = manager.get_current_print_user(1)
  582. assert result is None
  583. def test_clear_current_print_user_no_error_for_unknown(self, manager):
  584. """Verify clearing unknown printer doesn't raise error."""
  585. # Should not raise
  586. manager.clear_current_print_user(999)
  587. def test_set_current_print_user_overwrites_existing(self, manager):
  588. """Verify setting user overwrites existing value."""
  589. manager.set_current_print_user(1, 42, "user1")
  590. manager.set_current_print_user(1, 99, "user2")
  591. result = manager.get_current_print_user(1)
  592. assert result["user_id"] == 99
  593. assert result["username"] == "user2"
  594. def test_multiple_printers_have_separate_users(self, manager):
  595. """Verify each printer tracks its own user separately."""
  596. manager.set_current_print_user(1, 42, "user1")
  597. manager.set_current_print_user(2, 99, "user2")
  598. result1 = manager.get_current_print_user(1)
  599. result2 = manager.get_current_print_user(2)
  600. assert result1["username"] == "user1"
  601. assert result2["username"] == "user2"
  602. class TestPrinterStateToDict:
  603. """Tests for printer_state_to_dict helper function."""
  604. @pytest.fixture
  605. def mock_state(self):
  606. """Create a mock PrinterState."""
  607. state = MagicMock()
  608. state.connected = True
  609. state.state = "RUNNING"
  610. state.current_print = "test.3mf"
  611. state.subtask_name = "Test Print"
  612. state.gcode_file = "/sdcard/test.gcode"
  613. state.progress = 50
  614. state.remaining_time = 3600
  615. state.layer_num = 10
  616. state.total_layers = 20
  617. state.temperatures = {"nozzle": 200, "bed": 60}
  618. state.hms_errors = []
  619. state.ams_status_main = 0
  620. state.ams_status_sub = 0
  621. state.tray_now = "1"
  622. state.wifi_signal = -50
  623. state.raw_data = {}
  624. state.stg_cur = -1 # No calibration stage active
  625. state.firmware_version = None
  626. return state
  627. def test_basic_conversion(self, mock_state):
  628. """Verify basic state fields are converted."""
  629. result = printer_state_to_dict(mock_state)
  630. assert result["connected"] is True
  631. assert result["state"] == "RUNNING"
  632. assert result["progress"] == 50
  633. assert result["temperatures"] == {"nozzle": 200, "bed": 60}
  634. def test_ams_data_parsing(self, mock_state):
  635. """Verify AMS data is parsed correctly."""
  636. mock_state.raw_data = {
  637. "ams": [
  638. {
  639. "id": 0,
  640. "humidity_raw": 45,
  641. "temp": 25,
  642. "tray": [
  643. {
  644. "id": 0,
  645. "tray_color": "FF0000",
  646. "tray_type": "PLA",
  647. "tray_sub_brands": "Generic",
  648. "remain": 80,
  649. "k": 0.5,
  650. "tag_uid": "ABC123",
  651. "tray_uuid": "uuid-123",
  652. }
  653. ],
  654. }
  655. ]
  656. }
  657. result = printer_state_to_dict(mock_state)
  658. assert result["ams"] is not None
  659. assert len(result["ams"]) == 1
  660. assert result["ams"][0]["humidity"] == 45
  661. assert len(result["ams"][0]["tray"]) == 1
  662. assert result["ams"][0]["tray"][0]["tray_color"] == "FF0000"
  663. def test_empty_tag_uid_becomes_none(self, mock_state):
  664. """Verify empty tag_uid is converted to None."""
  665. mock_state.raw_data = {
  666. "ams": [
  667. {
  668. "id": 0,
  669. "tray": [
  670. {
  671. "id": 0,
  672. "tag_uid": "",
  673. "tray_uuid": "00000000000000000000000000000000",
  674. }
  675. ],
  676. }
  677. ]
  678. }
  679. result = printer_state_to_dict(mock_state)
  680. assert result["ams"][0]["tray"][0]["tag_uid"] is None
  681. assert result["ams"][0]["tray"][0]["tray_uuid"] is None
  682. def test_bare_tray_emulates_state_9(self, mock_state):
  683. """P1S / A1 Mini physically-empty-slot signal (#1322 follow-up by @RosdasHH):
  684. the firmware sends only `{"id": N}` for a truly empty slot. Treat that as
  685. the firmware's "no spool" state (state=9) so the inventory assign-spool
  686. path can short-circuit the doomed MQTT publish.
  687. """
  688. mock_state.raw_data = {
  689. "ams": [
  690. {
  691. "id": 0,
  692. "tray": [
  693. {"id": 0, "state": 11, "tray_type": "PLA"}, # loaded slot
  694. {"id": 1}, # P1S empty-slot signal — only id
  695. ],
  696. }
  697. ]
  698. }
  699. result = printer_state_to_dict(mock_state)
  700. trays = result["ams"][0]["tray"]
  701. assert trays[0]["state"] == 11, "loaded slot keeps its firmware state"
  702. assert trays[1]["state"] == 9, "bare {id} tray must be promoted to state=9"
  703. def test_populated_payload_with_empty_state_3_is_not_promoted(self, mock_state):
  704. """A1 Mini BMCU / P1S Standard AMS post-Reset-Slot case (#1322 root):
  705. firmware sends state=3 + tray_type="" but with the FULL field set
  706. populated. Must NOT be confused with the bare-tray empty signal —
  707. else inventory.py would short-circuit MQTT and we'd reintroduce the
  708. deadlock the #1322 fix removed.
  709. """
  710. mock_state.raw_data = {
  711. "ams": [
  712. {
  713. "id": 0,
  714. "tray": [
  715. {
  716. "id": 0,
  717. "state": 3,
  718. "tray_type": "", # cleared
  719. "tray_color": "",
  720. "tag_uid": "0000000000000000",
  721. "remain": 0,
  722. }
  723. ],
  724. }
  725. ]
  726. }
  727. result = printer_state_to_dict(mock_state)
  728. # state stays at 3 — the bare-tray promotion requires the dict to have
  729. # ONLY the id key, not just empty/falsy values for the other fields.
  730. assert result["ams"][0]["tray"][0]["state"] == 3
  731. def test_zero_tag_uid_becomes_none(self, mock_state):
  732. """Verify zero tag_uid is converted to None."""
  733. mock_state.raw_data = {
  734. "ams": [
  735. {
  736. "id": 0,
  737. "tray": [
  738. {
  739. "id": 0,
  740. "tag_uid": "0000000000000000",
  741. }
  742. ],
  743. }
  744. ]
  745. }
  746. result = printer_state_to_dict(mock_state)
  747. assert result["ams"][0]["tray"][0]["tag_uid"] is None
  748. def test_vt_tray_parsing(self, mock_state):
  749. """Verify virtual tray is parsed correctly as a list."""
  750. mock_state.raw_data = {
  751. "vt_tray": [
  752. {
  753. "tray_color": "00FF00",
  754. "tray_type": "PETG",
  755. "tray_sub_brands": "Generic",
  756. "remain": 60,
  757. "tag_uid": "VT123",
  758. }
  759. ]
  760. }
  761. result = printer_state_to_dict(mock_state)
  762. assert isinstance(result["vt_tray"], list)
  763. assert len(result["vt_tray"]) == 1
  764. assert result["vt_tray"][0]["id"] == 254
  765. assert result["vt_tray"][0]["tray_color"] == "00FF00"
  766. assert result["vt_tray"][0]["tray_type"] == "PETG"
  767. def test_vt_tray_dict_normalized_to_list(self, mock_state):
  768. """Verify vt_tray as a raw dict (from MQTT) is normalized to a list."""
  769. mock_state.raw_data = {
  770. "vt_tray": {
  771. "id": "254",
  772. "tray_color": "FF0000",
  773. "tray_type": "PLA",
  774. "tray_sub_brands": "Generic",
  775. "tag_uid": "0000000000000000",
  776. "tray_uuid": "00000000000000000000000000000000",
  777. "remain": 0,
  778. }
  779. }
  780. result = printer_state_to_dict(mock_state)
  781. assert isinstance(result["vt_tray"], list)
  782. assert len(result["vt_tray"]) == 1
  783. assert result["vt_tray"][0]["tray_color"] == "FF0000"
  784. assert result["vt_tray"][0]["tray_type"] == "PLA"
  785. assert result["vt_tray"][0]["tag_uid"] is None
  786. assert result["vt_tray"][0]["tray_uuid"] is None
  787. def test_vt_tray_non_list_non_dict_ignored(self, mock_state):
  788. """Verify unexpected vt_tray types (e.g. string) produce empty list."""
  789. mock_state.raw_data = {"vt_tray": "unexpected_string"}
  790. result = printer_state_to_dict(mock_state)
  791. assert result["vt_tray"] == []
  792. def test_hms_errors_conversion(self, mock_state):
  793. """Verify HMS errors are converted correctly."""
  794. error = MagicMock()
  795. error.code = "0700_0100"
  796. error.attr = 1
  797. error.module = "AMS"
  798. error.severity = 2
  799. mock_state.hms_errors = [error]
  800. result = printer_state_to_dict(mock_state)
  801. assert len(result["hms_errors"]) == 1
  802. assert result["hms_errors"][0]["code"] == "0700_0100"
  803. assert result["hms_errors"][0]["module"] == "AMS"
  804. def test_cover_url_added_for_running_print(self, mock_state):
  805. """Verify cover_url is added for running prints."""
  806. result = printer_state_to_dict(mock_state, printer_id=1)
  807. assert result["cover_url"] == "/api/v1/printers/1/cover"
  808. def test_current_plate_id_extracted_from_gcode_file(self, mock_state):
  809. """Verify current_plate_id is parsed from a Bambu plate path (#881)."""
  810. mock_state.gcode_file = "/Metadata/plate_3.gcode"
  811. result = printer_state_to_dict(mock_state)
  812. assert result["current_plate_id"] == 3
  813. def test_current_plate_id_none_when_no_plate_segment(self, mock_state):
  814. """Verify current_plate_id stays None when gcode_file has no plate marker."""
  815. mock_state.gcode_file = "/sdcard/test.gcode"
  816. result = printer_state_to_dict(mock_state)
  817. assert result["current_plate_id"] is None
  818. def test_cover_url_none_when_not_running(self, mock_state):
  819. """Verify cover_url is None when not printing."""
  820. mock_state.state = "IDLE"
  821. result = printer_state_to_dict(mock_state, printer_id=1)
  822. assert result["cover_url"] is None
  823. def test_ams_ht_detection(self, mock_state):
  824. """Verify AMS-HT is detected (1 tray vs 4)."""
  825. mock_state.raw_data = {
  826. "ams": [
  827. {
  828. "id": 0,
  829. "tray": [{"id": 0}], # Only 1 tray = AMS-HT
  830. }
  831. ]
  832. }
  833. result = printer_state_to_dict(mock_state)
  834. assert result["ams"][0]["is_ams_ht"] is True
  835. def test_regular_ams_detection(self, mock_state):
  836. """Verify regular AMS is detected (4 trays)."""
  837. mock_state.raw_data = {"ams": [{"id": 0, "tray": [{"id": 0}, {"id": 1}, {"id": 2}, {"id": 3}]}]}
  838. result = printer_state_to_dict(mock_state)
  839. assert result["ams"][0]["is_ams_ht"] is False
  840. def test_chamber_temp_filtered_for_p1s(self, mock_state):
  841. """Verify chamber temperature is filtered out for P1S (no chamber sensor)."""
  842. mock_state.temperatures = {
  843. "nozzle": 200,
  844. "bed": 60,
  845. "chamber": 5,
  846. "chamber_target": 0,
  847. "chamber_heating": False,
  848. }
  849. result = printer_state_to_dict(mock_state, model="P1S")
  850. assert "chamber" not in result["temperatures"]
  851. assert "chamber_target" not in result["temperatures"]
  852. assert "chamber_heating" not in result["temperatures"]
  853. assert result["temperatures"]["nozzle"] == 200
  854. assert result["temperatures"]["bed"] == 60
  855. def test_chamber_temp_kept_for_x1c(self, mock_state):
  856. """Verify chamber temperature is kept for X1C (has chamber sensor)."""
  857. mock_state.temperatures = {
  858. "nozzle": 200,
  859. "bed": 60,
  860. "chamber": 25,
  861. "chamber_target": 45,
  862. "chamber_heating": True,
  863. }
  864. result = printer_state_to_dict(mock_state, model="X1C")
  865. assert result["temperatures"]["chamber"] == 25
  866. assert result["temperatures"]["chamber_target"] == 45
  867. assert result["temperatures"]["chamber_heating"] is True
  868. def test_chamber_temp_filtered_for_a1(self, mock_state):
  869. """Verify chamber temperature is filtered out for A1 (no chamber sensor)."""
  870. mock_state.temperatures = {"nozzle": 200, "bed": 60, "chamber": 5}
  871. result = printer_state_to_dict(mock_state, model="A1")
  872. assert "chamber" not in result["temperatures"]
  873. def test_chamber_temp_kept_when_no_model(self, mock_state):
  874. """Verify chamber temperature is kept when model is not specified (conservative approach)."""
  875. mock_state.temperatures = {"nozzle": 200, "bed": 60, "chamber": 25}
  876. result = printer_state_to_dict(mock_state) # No model specified
  877. # When model is unknown, we can't filter - leave as is
  878. # Actually supports_chamber_temp returns False for None, so it will filter
  879. # Let's check the actual behavior
  880. assert "chamber" not in result["temperatures"]
  881. def test_ams_drying_fields_included(self, mock_state):
  882. """Verify AMS drying fields (dry_time, module_type) are included in output."""
  883. mock_state.raw_data = {
  884. "ams": [
  885. {
  886. "id": 0,
  887. "dry_time": 42,
  888. "module_type": "n3f",
  889. "tray": [
  890. {
  891. "id": 0,
  892. "tray_color": "FF0000",
  893. "tray_type": "PLA",
  894. "drying_temp": 55,
  895. "drying_time": 240,
  896. }
  897. ],
  898. }
  899. ]
  900. }
  901. result = printer_state_to_dict(mock_state)
  902. ams_unit = result["ams"][0]
  903. assert ams_unit["dry_time"] == 42
  904. assert ams_unit["module_type"] == "n3f"
  905. # Tray-level drying fields
  906. tray = ams_unit["tray"][0]
  907. assert tray["drying_temp"] == 55
  908. assert tray["drying_time"] == 240
  909. def test_awaiting_plate_clear_defaults_false(self, mock_state):
  910. """Without a printer_id, awaiting_plate_clear is False (no lookup possible)."""
  911. result = printer_state_to_dict(mock_state)
  912. assert result["awaiting_plate_clear"] is False
  913. def test_awaiting_plate_clear_surfaced_when_set(self, mock_state):
  914. """With printer_id, awaiting_plate_clear reflects PrinterManager state.
  915. Regression: PR #939 left this flag off the WebSocket payload, so the
  916. "Clear Plate" button only appeared after the 30 s REST fallback poll.
  917. """
  918. from backend.app.services.printer_manager import printer_manager
  919. printer_manager.set_awaiting_plate_clear(12345, True)
  920. try:
  921. result = printer_state_to_dict(mock_state, printer_id=12345)
  922. assert result["awaiting_plate_clear"] is True
  923. finally:
  924. printer_manager.set_awaiting_plate_clear(12345, False)
  925. def test_name_and_model_surfaced_when_registered(self, mock_state):
  926. """Registered PrinterInfo name + model arg should land in the WS payload.
  927. Regression for #963 follow-up: without this, the gcode viewer's printer
  928. selector had to wait on a /printers fetch before it could render real
  929. names, and the initial WS snapshot showed "Printer 1" fallbacks.
  930. """
  931. from backend.app.services.printer_manager import PrinterInfo, printer_manager
  932. # Register a stub PrinterInfo; the real manager writes this on connect.
  933. printer_manager._printer_info[98765] = PrinterInfo(name="My X1C", serial_number="01S00-0")
  934. try:
  935. result = printer_state_to_dict(mock_state, printer_id=98765, model="X1C")
  936. assert result["name"] == "My X1C"
  937. assert result["model"] == "X1C"
  938. finally:
  939. printer_manager._printer_info.pop(98765, None)
  940. def test_name_and_model_absent_when_no_printer_id(self, mock_state):
  941. """Without a printer_id (unusual callsites), name/model keys stay absent.
  942. The consumers (gcode viewer, frontend card) tolerate missing keys; what
  943. they can't tolerate is an unrelated printer's name accidentally leaking
  944. into a status meant for a different one.
  945. """
  946. result = printer_state_to_dict(mock_state)
  947. assert "name" not in result
  948. assert "model" not in result
  949. def test_model_absent_when_arg_is_none(self, mock_state):
  950. """`model` arg=None must not plant a `model` key at all.
  951. If the arg is None, callers didn't know the model yet; emitting a
  952. `model: null` field would overwrite a good value cached client-side.
  953. """
  954. from backend.app.services.printer_manager import PrinterInfo, printer_manager
  955. printer_manager._printer_info[55555] = PrinterInfo(name="N", serial_number="S")
  956. try:
  957. result = printer_state_to_dict(mock_state, printer_id=55555, model=None)
  958. assert "model" not in result
  959. assert result["name"] == "N"
  960. finally:
  961. printer_manager._printer_info.pop(55555, None)
  962. class TestStatusKeyDryingDedup:
  963. """Regression tests for WebSocket dedup including drying fields.
  964. The WebSocket broadcast deduplication uses printer_state_to_dict output
  965. to detect changes. If drying fields (like dry_time) are missing from
  966. the dict, changes to those fields won't trigger broadcasts.
  967. """
  968. def test_dry_time_change_changes_status_key(self):
  969. """Verify dry_time is present in AMS unit data so dedup can detect changes."""
  970. state = MagicMock()
  971. state.connected = True
  972. state.state = "IDLE"
  973. state.current_print = None
  974. state.subtask_name = None
  975. state.gcode_file = None
  976. state.progress = 0
  977. state.remaining_time = 0
  978. state.layer_num = 0
  979. state.total_layers = 0
  980. state.temperatures = {"nozzle": 25, "bed": 25}
  981. state.hms_errors = []
  982. state.ams_status_main = 0
  983. state.ams_status_sub = 0
  984. state.tray_now = None
  985. state.wifi_signal = -50
  986. state.stg_cur = -1
  987. # First state: drying active with 30 minutes remaining
  988. state.raw_data = {"ams": [{"id": 0, "dry_time": 30, "module_type": "n3f", "tray": [{"id": 0}]}]}
  989. result1 = printer_state_to_dict(state)
  990. # Second state: drying time decreased
  991. state.raw_data = {"ams": [{"id": 0, "dry_time": 29, "module_type": "n3f", "tray": [{"id": 0}]}]}
  992. result2 = printer_state_to_dict(state)
  993. # The dicts should differ — dry_time changed
  994. assert result1["ams"][0]["dry_time"] == 30
  995. assert result2["ams"][0]["dry_time"] == 29
  996. assert result1["ams"] != result2["ams"]
  997. class TestSupportsChamberTemp:
  998. """Tests for supports_chamber_temp helper function."""
  999. def test_x1_series_supported(self):
  1000. """Verify X1 series printers support chamber temp."""
  1001. assert supports_chamber_temp("X1") is True
  1002. assert supports_chamber_temp("X1C") is True
  1003. assert supports_chamber_temp("X1E") is True
  1004. def test_p2_series_supported(self):
  1005. """Verify P2 series printers support chamber temp."""
  1006. assert supports_chamber_temp("P2S") is True
  1007. def test_h2_series_supported(self):
  1008. """Verify H2 series printers support chamber temp."""
  1009. assert supports_chamber_temp("H2C") is True
  1010. assert supports_chamber_temp("H2D") is True
  1011. assert supports_chamber_temp("H2DPRO") is True
  1012. assert supports_chamber_temp("H2S") is True
  1013. def test_p1_series_not_supported(self):
  1014. """Verify P1 series printers do NOT support chamber temp."""
  1015. assert supports_chamber_temp("P1P") is False
  1016. assert supports_chamber_temp("P1S") is False
  1017. def test_a1_series_not_supported(self):
  1018. """Verify A1 series printers do NOT support chamber temp."""
  1019. assert supports_chamber_temp("A1") is False
  1020. assert supports_chamber_temp("A1MINI") is False
  1021. def test_none_model_not_supported(self):
  1022. """Verify None model returns False."""
  1023. assert supports_chamber_temp(None) is False
  1024. def test_case_insensitive(self):
  1025. """Verify model matching is case-insensitive."""
  1026. assert supports_chamber_temp("x1c") is True
  1027. assert supports_chamber_temp("X1c") is True
  1028. assert supports_chamber_temp("p1s") is False
  1029. def test_internal_model_codes_supported(self):
  1030. """Verify internal model codes from MQTT/SSDP are recognized."""
  1031. # X1/X1C
  1032. assert supports_chamber_temp("BL-P001") is True
  1033. # X1E
  1034. assert supports_chamber_temp("C13") is True
  1035. # H2D
  1036. assert supports_chamber_temp("O1D") is True
  1037. # H2C
  1038. assert supports_chamber_temp("O1C") is True
  1039. # H2S
  1040. assert supports_chamber_temp("O1S") is True
  1041. # H2D Pro
  1042. assert supports_chamber_temp("O1E") is True
  1043. # P2S
  1044. assert supports_chamber_temp("N7") is True
  1045. def test_internal_model_codes_not_supported(self):
  1046. """Verify A1/P1 internal codes are NOT supported."""
  1047. # P1P
  1048. assert supports_chamber_temp("C11") is False
  1049. # P1S
  1050. assert supports_chamber_temp("C12") is False
  1051. # A1
  1052. assert supports_chamber_temp("N2S") is False
  1053. # A1 Mini
  1054. assert supports_chamber_temp("N1") is False
  1055. class TestIsBedSlinger:
  1056. """Tests for is_bed_slinger helper function (#1334)."""
  1057. def test_a1_series_is_bed_slinger(self):
  1058. """A1 / A1 Mini are open-frame bed-slingers — Z axis is the toolhead."""
  1059. from backend.app.services.printer_manager import is_bed_slinger
  1060. assert is_bed_slinger("A1") is True
  1061. assert is_bed_slinger("A1 Mini") is True
  1062. assert is_bed_slinger("A1MINI") is True
  1063. assert is_bed_slinger("A1-MINI") is True
  1064. def test_a1_internal_codes_recognised(self):
  1065. """Internal MQTT/SSDP codes for A1 family must also classify as bed-slinger."""
  1066. from backend.app.services.printer_manager import is_bed_slinger
  1067. # A1 Mini
  1068. assert is_bed_slinger("N1") is True
  1069. # A1
  1070. assert is_bed_slinger("N2S") is True
  1071. def test_bed_on_z_models_not_bed_slingers(self):
  1072. """X1 / P1 / H2 / H2C / H2D / H2S / P2S all have the bed on Z."""
  1073. from backend.app.services.printer_manager import is_bed_slinger
  1074. for model in ("X1", "X1C", "X1E", "P1P", "P1S", "P2S", "H2C", "H2D", "H2DPRO", "H2S"):
  1075. assert is_bed_slinger(model) is False, f"{model} should NOT be classified as bed-slinger"
  1076. def test_none_model_returns_false(self):
  1077. from backend.app.services.printer_manager import is_bed_slinger
  1078. assert is_bed_slinger(None) is False
  1079. assert is_bed_slinger("") is False
  1080. def test_case_insensitive(self):
  1081. from backend.app.services.printer_manager import is_bed_slinger
  1082. assert is_bed_slinger("a1") is True
  1083. assert is_bed_slinger("a1 mini") is True
  1084. assert is_bed_slinger("x1c") is False
  1085. class TestSupportsDrying:
  1086. """Tests for supports_drying helper function."""
  1087. def test_known_supported_with_firmware(self):
  1088. """Verify known models with sufficient firmware return True."""
  1089. assert supports_drying("X1C", "01.09.00.00") is True
  1090. assert supports_drying("P1S", "01.08.00.00") is True
  1091. assert supports_drying("H2D", "01.02.30.00") is True
  1092. assert supports_drying("H2S", "01.02.00.00") is True
  1093. assert supports_drying("H2C", "01.02.00.00") is True
  1094. assert supports_drying("O1C", "01.02.00.00") is True
  1095. assert supports_drying("O1C2", "01.02.00.00") is True
  1096. assert supports_drying("P2S", "01.02.00.00") is True
  1097. assert supports_drying("N7", "01.02.00.00") is True
  1098. def test_known_supported_old_firmware(self):
  1099. """Verify known models with old firmware return False."""
  1100. assert supports_drying("X1C", "01.08.00.00") is False
  1101. assert supports_drying("P1S", "01.07.00.00") is False
  1102. assert supports_drying("H2S", "01.01.00.00") is False
  1103. assert supports_drying("H2C", "01.01.99.99") is False
  1104. assert supports_drying("O1C", "01.01.99.99") is False
  1105. assert supports_drying("O1C2", "01.01.99.99") is False
  1106. assert supports_drying("P2S", "01.01.99.99") is False
  1107. assert supports_drying("N7", "01.01.99.99") is False
  1108. def test_known_supported_no_firmware(self):
  1109. """Verify known models with no firmware return False."""
  1110. assert supports_drying("X1C", None) is False
  1111. assert supports_drying("P2S", None) is False
  1112. def test_unsupported_models(self):
  1113. """Verify models without AMS drying support return False regardless of firmware."""
  1114. for model in ["A1", "A1MINI", "A1-MINI", "N1", "N2S"]:
  1115. assert supports_drying(model, "99.99.99.99") is False, f"Expected False for {model}"
  1116. def test_unknown_models_allowed(self):
  1117. """Verify unknown models are allowed (graceful fallback).
  1118. Models not in the unsupported set AND not matching any known firmware-gated
  1119. model substring get the benefit of the doubt and return True.
  1120. "H2D Pro" contains "H2D" so it IS firmware-gated (needs firmware).
  1121. """
  1122. # Truly unknown models: no substring match in _DRYING_MIN_FIRMWARE
  1123. assert supports_drying("FUTURE_MODEL", None) is True
  1124. # X1E contains "X1" substring, so it IS firmware-gated
  1125. assert supports_drying("X1E", "01.09.00.00") is True
  1126. # H2D Pro contains "H2D" substring, so it IS firmware-gated
  1127. assert supports_drying("H2D Pro", "01.02.30.00") is True
  1128. def test_none_model(self):
  1129. """Verify None model returns False."""
  1130. assert supports_drying(None, "01.09.00.00") is False
  1131. def test_case_insensitive(self):
  1132. """Verify model matching is case-insensitive."""
  1133. assert supports_drying("x1c", "01.09.00.00") is True
  1134. assert supports_drying("p2s", "01.02.00.00") is True
  1135. assert supports_drying("a1", "99.99.99.99") is False
  1136. class TestGetDerivedStatusName:
  1137. """Tests for get_derived_status_name function."""
  1138. def test_stg_cur_255_returns_none(self):
  1139. """Verify stg_cur=255 (A1/P1 idle) returns None, not 'Unknown stage (255)'."""
  1140. state = MagicMock()
  1141. state.stg_cur = 255
  1142. state.state = "IDLE"
  1143. result = get_derived_status_name(state)
  1144. assert result is None
  1145. def test_stg_cur_negative_one_returns_none_when_idle(self):
  1146. """Verify stg_cur=-1 (X1 idle) returns None."""
  1147. state = MagicMock()
  1148. state.stg_cur = -1
  1149. state.state = "IDLE"
  1150. result = get_derived_status_name(state)
  1151. assert result is None
  1152. def test_valid_stage_returns_name(self):
  1153. """Verify valid stg_cur values return stage name."""
  1154. state = MagicMock()
  1155. state.stg_cur = 1 # Auto bed leveling
  1156. result = get_derived_status_name(state)
  1157. assert result == "Auto bed leveling"
  1158. def test_stg_cur_zero_returns_printing(self):
  1159. """Verify stg_cur=0 returns 'Printing' when no model specified."""
  1160. state = MagicMock()
  1161. state.stg_cur = 0
  1162. result = get_derived_status_name(state)
  1163. assert result == "Printing"
  1164. def test_a1_idle_with_stg_cur_zero_returns_none(self):
  1165. """Verify A1 with IDLE state and stg_cur=0 returns None (bug workaround)."""
  1166. state = MagicMock()
  1167. state.stg_cur = 0
  1168. state.state = "IDLE"
  1169. # Test various A1 model names
  1170. for model in ["A1", "A1 Mini", "A1-Mini", "A1MINI", "N1", "N2S"]:
  1171. result = get_derived_status_name(state, model)
  1172. assert result is None, f"Expected None for model {model}"
  1173. def test_a1_running_with_stg_cur_zero_returns_printing(self):
  1174. """Verify A1 with RUNNING state and stg_cur=0 still returns 'Printing'."""
  1175. state = MagicMock()
  1176. state.stg_cur = 0
  1177. state.state = "RUNNING"
  1178. result = get_derived_status_name(state, "A1")
  1179. assert result == "Printing"
  1180. def test_non_a1_idle_with_stg_cur_zero_returns_printing(self):
  1181. """Verify non-A1 models with IDLE and stg_cur=0 still return 'Printing'."""
  1182. state = MagicMock()
  1183. state.stg_cur = 0
  1184. state.state = "IDLE"
  1185. # X1C should not get the workaround
  1186. result = get_derived_status_name(state, "X1C")
  1187. assert result == "Printing"
  1188. class TestHasStgCurIdleBug:
  1189. """Tests for has_stg_cur_idle_bug function."""
  1190. def test_a1_models_return_true(self):
  1191. """Verify A1 model variants return True."""
  1192. assert has_stg_cur_idle_bug("A1") is True
  1193. assert has_stg_cur_idle_bug("A1 Mini") is True
  1194. assert has_stg_cur_idle_bug("A1-Mini") is True
  1195. assert has_stg_cur_idle_bug("A1MINI") is True
  1196. assert has_stg_cur_idle_bug("a1") is True # case insensitive
  1197. assert has_stg_cur_idle_bug("a1 mini") is True
  1198. def test_p1_models_return_true(self):
  1199. """Verify P1P/P1S model variants return True."""
  1200. assert has_stg_cur_idle_bug("P1P") is True
  1201. assert has_stg_cur_idle_bug("P1S") is True
  1202. assert has_stg_cur_idle_bug("p1p") is True # case insensitive
  1203. def test_internal_codes_return_true(self):
  1204. """Verify internal model codes return True."""
  1205. assert has_stg_cur_idle_bug("N1") is True # A1 Mini
  1206. assert has_stg_cur_idle_bug("N2S") is True # A1
  1207. assert has_stg_cur_idle_bug("C11") is True # P1P
  1208. assert has_stg_cur_idle_bug("C12") is True # P1S
  1209. def test_non_affected_models_return_false(self):
  1210. """Verify non-affected models return False."""
  1211. assert has_stg_cur_idle_bug("X1C") is False
  1212. assert has_stg_cur_idle_bug("X1") is False
  1213. assert has_stg_cur_idle_bug("H2D") is False
  1214. def test_none_model_returns_false(self):
  1215. """Verify None model returns False."""
  1216. assert has_stg_cur_idle_bug(None) is False
  1217. def test_empty_model_returns_false(self):
  1218. """Verify empty model returns False."""
  1219. assert has_stg_cur_idle_bug("") is False
  1220. class TestInitPrinterConnections:
  1221. """Tests for init_printer_connections function."""
  1222. @pytest.mark.asyncio
  1223. async def test_connects_all_active_printers(self):
  1224. """Verify all active printers are connected."""
  1225. mock_db = AsyncMock()
  1226. mock_printer1 = MagicMock(id=1, is_active=True)
  1227. mock_printer2 = MagicMock(id=2, is_active=True)
  1228. mock_result = MagicMock()
  1229. mock_result.scalars.return_value.all.return_value = [mock_printer1, mock_printer2]
  1230. mock_db.execute.return_value = mock_result
  1231. with patch("backend.app.services.printer_manager.printer_manager") as mock_manager:
  1232. mock_manager.connect_printer = AsyncMock()
  1233. await init_printer_connections(mock_db)
  1234. assert mock_manager.connect_printer.call_count == 2
  1235. @pytest.mark.asyncio
  1236. async def test_handles_empty_printer_list(self):
  1237. """Verify empty printer list is handled."""
  1238. mock_db = AsyncMock()
  1239. mock_result = MagicMock()
  1240. mock_result.scalars.return_value.all.return_value = []
  1241. mock_db.execute.return_value = mock_result
  1242. with patch("backend.app.services.printer_manager.printer_manager") as mock_manager:
  1243. mock_manager.connect_printer = AsyncMock()
  1244. await init_printer_connections(mock_db)
  1245. mock_manager.connect_printer.assert_not_called()
  1246. class TestAmsChangeCallback:
  1247. """Tests for AMS change callback functionality."""
  1248. @pytest.fixture
  1249. def manager(self):
  1250. """Create a fresh PrinterManager instance."""
  1251. return PrinterManager()
  1252. def test_ams_change_callback_is_triggered(self, manager):
  1253. """Verify AMS change callback is called when AMS data changes."""
  1254. callback = MagicMock()
  1255. manager.set_ams_change_callback(callback)
  1256. # Verify callback was set
  1257. assert manager._on_ams_change == callback
  1258. def test_ams_change_callback_receives_correct_data(self, manager):
  1259. """Verify AMS change callback receives the correct AMS data format."""
  1260. received_data = []
  1261. def capture_callback(printer_id, ams_data):
  1262. received_data.append((printer_id, ams_data))
  1263. manager.set_ams_change_callback(capture_callback)
  1264. # The callback should accept printer_id and ams_data
  1265. # This tests the callback signature
  1266. assert manager._on_ams_change is not None
  1267. assert callable(manager._on_ams_change)
  1268. class TestParsePlateId:
  1269. """Tests for parse_plate_id() — active-print plate extraction from gcode paths.
  1270. Regression coverage for #881 follow-up: the REST /status endpoint and the
  1271. WebSocket push path both use this helper, so they must agree on the plate
  1272. number the frontend sees.
  1273. """
  1274. def test_bambu_metadata_path(self):
  1275. # Canonical path that Bambu Studio / OrcaSlicer stamp into the 3MF.
  1276. assert parse_plate_id("/Metadata/plate_2.gcode") == 2
  1277. def test_plate_one(self):
  1278. assert parse_plate_id("/Metadata/plate_1.gcode") == 1
  1279. def test_double_digit_plate(self):
  1280. assert parse_plate_id("/Metadata/plate_12.gcode") == 12
  1281. def test_none_input(self):
  1282. assert parse_plate_id(None) is None
  1283. def test_empty_string(self):
  1284. assert parse_plate_id("") is None
  1285. def test_path_without_plate_segment(self):
  1286. # Some firmware / slicers report a bare filename without the plate marker.
  1287. assert parse_plate_id("/upload/my-model.gcode") is None
  1288. def test_similar_but_non_matching_names(self):
  1289. # "plate.gcode" (no number) and "nameplate_2.gcode" (substring) must not
  1290. # be mistaken for real plate markers. The regex anchors on `plate_<num>`.
  1291. assert parse_plate_id("/Metadata/plate.gcode") is None
  1292. assert parse_plate_id("/plates/3.gcode") is None
  1293. def test_substring_match_still_extracts(self):
  1294. # The regex isn't anchored to the start of a segment — any occurrence
  1295. # wins. This matches real Bambu paths where the segment is preceded by
  1296. # arbitrary directory noise, and matches the equivalent frontend regex.
  1297. assert parse_plate_id("/uploads/project/plate_5.gcode.md5") == 5
  1298. class TestResolvePlateId:
  1299. """Tests for resolve_plate_id() — plate resolution with dispatch precedence.
  1300. Regression coverage for #1166: P1S firmware 01.10.00.00 only puts the .3mf
  1301. filename in print.gcode_file, so parse_plate_id() returns None and the
  1302. printer card falls back to plate 1. When Bambuddy dispatches the print
  1303. itself we know the right plate; resolve_plate_id() prefers that record over
  1304. the gcode_file regex when subtask_name matches.
  1305. """
  1306. def _make_state(self, **kwargs):
  1307. from backend.app.services.bambu_mqtt import PrinterState
  1308. state = PrinterState()
  1309. for k, v in kwargs.items():
  1310. setattr(state, k, v)
  1311. return state
  1312. def test_dispatched_plate_wins_when_subtask_matches(self):
  1313. # User dispatches plate 4 via Bambuddy. Printer reflects subtask_name
  1314. # but firmware drops the plate path from gcode_file. Without the dispatch
  1315. # record we'd default to plate 1.
  1316. from backend.app.services.printer_manager import resolve_plate_id
  1317. state = self._make_state(
  1318. gcode_file="MyModel.3mf", # No plate path — firmware bug
  1319. subtask_name="MyModel",
  1320. dispatched_plate_id=4,
  1321. dispatched_subtask="MyModel",
  1322. )
  1323. assert resolve_plate_id(state) == 4
  1324. def test_dispatched_ignored_when_subtask_differs(self):
  1325. # Bambuddy's dispatch record is for a previous print; the printer is
  1326. # now running a different subtask (Studio-direct dispatch). The stale
  1327. # record must not be used — fall back to gcode_file regex.
  1328. from backend.app.services.printer_manager import resolve_plate_id
  1329. state = self._make_state(
  1330. gcode_file="/Metadata/plate_2.gcode",
  1331. subtask_name="DifferentPrint",
  1332. dispatched_plate_id=4,
  1333. dispatched_subtask="MyModel",
  1334. )
  1335. assert resolve_plate_id(state) == 2
  1336. def test_falls_back_to_gcode_regex_without_dispatch(self):
  1337. # Studio-direct dispatch — no Bambuddy dispatch record. Existing logic
  1338. # (parse_plate_id on gcode_file) must still work.
  1339. from backend.app.services.printer_manager import resolve_plate_id
  1340. state = self._make_state(
  1341. gcode_file="/Metadata/plate_3.gcode",
  1342. subtask_name="MyModel",
  1343. )
  1344. assert resolve_plate_id(state) == 3
  1345. def test_returns_none_when_nothing_resolvable(self):
  1346. # No dispatch record AND firmware swallowed the plate path. The route
  1347. # uses this signal to invoke the 3MF-scan fallback.
  1348. from backend.app.services.printer_manager import resolve_plate_id
  1349. state = self._make_state(
  1350. gcode_file="MyModel.3mf",
  1351. subtask_name="MyModel",
  1352. )
  1353. assert resolve_plate_id(state) is None
  1354. def test_dispatched_subtask_required_to_avoid_false_match(self):
  1355. # dispatched_plate_id without dispatched_subtask is incomplete — we
  1356. # can't validate it points at the current print, so we ignore it.
  1357. from backend.app.services.printer_manager import resolve_plate_id
  1358. state = self._make_state(
  1359. gcode_file="MyModel.3mf",
  1360. subtask_name="MyModel",
  1361. dispatched_plate_id=4,
  1362. dispatched_subtask=None,
  1363. )
  1364. assert resolve_plate_id(state) is None