test_printer_manager.py 48 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291
  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. printer_state_to_dict,
  13. supports_chamber_temp,
  14. supports_drying,
  15. )
  16. class TestPrinterManager:
  17. """Tests for PrinterManager class."""
  18. @pytest.fixture
  19. def manager(self):
  20. """Create a fresh PrinterManager instance."""
  21. return PrinterManager()
  22. @pytest.fixture
  23. def mock_printer(self):
  24. """Create a mock Printer object."""
  25. printer = MagicMock()
  26. printer.id = 1
  27. printer.ip_address = "192.168.1.100"
  28. printer.serial_number = "00M09A123456789"
  29. printer.access_code = "12345678"
  30. printer.is_active = True
  31. return printer
  32. @pytest.fixture
  33. def mock_client(self):
  34. """Create a mock BambuMQTTClient."""
  35. client = MagicMock()
  36. client.state = MagicMock()
  37. client.state.connected = True
  38. client.state.state = "IDLE"
  39. client.state.progress = 0
  40. client.state.temperatures = {"nozzle": 25, "bed": 25}
  41. client.state.raw_data = {}
  42. client.logging_enabled = False
  43. return client
  44. # ========================================================================
  45. # Tests for initialization
  46. # ========================================================================
  47. def test_init_creates_empty_clients_dict(self, manager):
  48. """Verify manager initializes with empty clients dict."""
  49. assert manager._clients == {}
  50. def test_init_callbacks_are_none(self, manager):
  51. """Verify all callbacks are initially None."""
  52. assert manager._on_print_start is None
  53. assert manager._on_print_complete is None
  54. assert manager._on_status_change is None
  55. assert manager._on_ams_change is None
  56. def test_init_loop_is_none(self, manager):
  57. """Verify event loop is initially None."""
  58. assert manager._loop is None
  59. # ========================================================================
  60. # Tests for callback setters
  61. # ========================================================================
  62. def test_set_event_loop(self, manager):
  63. """Verify event loop can be set."""
  64. mock_loop = MagicMock()
  65. manager.set_event_loop(mock_loop)
  66. assert manager._loop == mock_loop
  67. def test_set_print_start_callback(self, manager):
  68. """Verify print start callback can be set."""
  69. callback = MagicMock()
  70. manager.set_print_start_callback(callback)
  71. assert manager._on_print_start == callback
  72. def test_set_print_complete_callback(self, manager):
  73. """Verify print complete callback can be set."""
  74. callback = MagicMock()
  75. manager.set_print_complete_callback(callback)
  76. assert manager._on_print_complete == callback
  77. def test_set_status_change_callback(self, manager):
  78. """Verify status change callback can be set."""
  79. callback = MagicMock()
  80. manager.set_status_change_callback(callback)
  81. assert manager._on_status_change == callback
  82. def test_set_ams_change_callback(self, manager):
  83. """Verify AMS change callback can be set."""
  84. callback = MagicMock()
  85. manager.set_ams_change_callback(callback)
  86. assert manager._on_ams_change == callback
  87. # ========================================================================
  88. # Tests for _schedule_async
  89. # ========================================================================
  90. def test_schedule_async_with_running_loop(self, manager):
  91. """Verify async coroutine is scheduled when loop is running."""
  92. mock_loop = MagicMock()
  93. mock_loop.is_running.return_value = True
  94. manager._loop = mock_loop
  95. async def dummy_coro():
  96. pass
  97. coro = dummy_coro()
  98. manager._schedule_async(coro)
  99. mock_loop.is_running.assert_called_once()
  100. # Clean up the coroutine
  101. coro.close()
  102. def test_schedule_async_without_loop(self, manager):
  103. """Verify nothing happens when no loop is set."""
  104. async def dummy_coro():
  105. pass
  106. coro = dummy_coro()
  107. # Should not raise
  108. manager._schedule_async(coro)
  109. coro.close()
  110. def test_schedule_async_with_stopped_loop(self, manager):
  111. """Verify nothing happens when loop is not running."""
  112. mock_loop = MagicMock()
  113. mock_loop.is_running.return_value = False
  114. manager._loop = mock_loop
  115. async def dummy_coro():
  116. pass
  117. coro = dummy_coro()
  118. manager._schedule_async(coro)
  119. coro.close()
  120. # ========================================================================
  121. # Tests for connect_printer
  122. # ========================================================================
  123. @pytest.mark.asyncio
  124. async def test_connect_printer_creates_client(self, manager, mock_printer):
  125. """Verify connecting creates an MQTT client."""
  126. with patch("backend.app.services.printer_manager.BambuMQTTClient") as MockClient:
  127. mock_instance = MagicMock()
  128. mock_instance.state = MagicMock()
  129. mock_instance.state.connected = True
  130. MockClient.return_value = mock_instance
  131. result = await manager.connect_printer(mock_printer)
  132. MockClient.assert_called_once()
  133. mock_instance.connect.assert_called_once()
  134. assert mock_printer.id in manager._clients
  135. assert result is True
  136. @pytest.mark.asyncio
  137. async def test_connect_printer_disconnects_existing(self, manager, mock_printer, mock_client):
  138. """Verify connecting disconnects existing client first."""
  139. manager._clients[mock_printer.id] = mock_client
  140. with patch("backend.app.services.printer_manager.BambuMQTTClient") as MockClient:
  141. new_client = MagicMock()
  142. new_client.state = MagicMock()
  143. new_client.state.connected = True
  144. MockClient.return_value = new_client
  145. await manager.connect_printer(mock_printer)
  146. mock_client.disconnect.assert_called_once()
  147. @pytest.mark.asyncio
  148. async def test_connect_printer_returns_false_on_failure(self, manager, mock_printer):
  149. """Verify returns False when connection fails."""
  150. with patch("backend.app.services.printer_manager.BambuMQTTClient") as MockClient:
  151. mock_instance = MagicMock()
  152. mock_instance.state = MagicMock()
  153. mock_instance.state.connected = False
  154. MockClient.return_value = mock_instance
  155. result = await manager.connect_printer(mock_printer)
  156. assert result is False
  157. # ========================================================================
  158. # Tests for disconnect_printer
  159. # ========================================================================
  160. def test_disconnect_printer_removes_client(self, manager, mock_client):
  161. """Verify disconnecting removes and disconnects client."""
  162. manager._clients[1] = mock_client
  163. manager.disconnect_printer(1)
  164. mock_client.disconnect.assert_called_once()
  165. assert 1 not in manager._clients
  166. def test_disconnect_printer_handles_missing(self, manager):
  167. """Verify disconnecting non-existent printer doesn't raise."""
  168. manager.disconnect_printer(999) # Should not raise
  169. # ========================================================================
  170. # Tests for disconnect_all
  171. # ========================================================================
  172. def test_disconnect_all_disconnects_all_clients(self, manager):
  173. """Verify all clients are disconnected."""
  174. client1 = MagicMock()
  175. client2 = MagicMock()
  176. manager._clients[1] = client1
  177. manager._clients[2] = client2
  178. manager.disconnect_all()
  179. client1.disconnect.assert_called_once()
  180. client2.disconnect.assert_called_once()
  181. assert len(manager._clients) == 0
  182. # ========================================================================
  183. # Tests for get_status
  184. # ========================================================================
  185. def test_get_status_returns_state(self, manager, mock_client):
  186. """Verify get_status returns client state."""
  187. manager._clients[1] = mock_client
  188. result = manager.get_status(1)
  189. mock_client.check_staleness.assert_called_once()
  190. assert result == mock_client.state
  191. def test_get_status_returns_none_for_unknown(self, manager):
  192. """Verify get_status returns None for unknown printer."""
  193. result = manager.get_status(999)
  194. assert result is None
  195. # ========================================================================
  196. # Tests for get_all_statuses
  197. # ========================================================================
  198. def test_get_all_statuses_returns_all(self, manager):
  199. """Verify all statuses are returned."""
  200. client1 = MagicMock()
  201. client1.state = MagicMock(connected=True)
  202. client2 = MagicMock()
  203. client2.state = MagicMock(connected=False)
  204. manager._clients[1] = client1
  205. manager._clients[2] = client2
  206. result = manager.get_all_statuses()
  207. assert len(result) == 2
  208. assert 1 in result
  209. assert 2 in result
  210. client1.check_staleness.assert_called_once()
  211. client2.check_staleness.assert_called_once()
  212. # ========================================================================
  213. # Tests for is_connected
  214. # ========================================================================
  215. def test_is_connected_returns_true(self, manager, mock_client):
  216. """Verify is_connected returns True for connected printer."""
  217. mock_client.check_staleness.return_value = True
  218. manager._clients[1] = mock_client
  219. result = manager.is_connected(1)
  220. assert result is True
  221. def test_is_connected_returns_false_for_unknown(self, manager):
  222. """Verify is_connected returns False for unknown printer."""
  223. result = manager.is_connected(999)
  224. assert result is False
  225. # ========================================================================
  226. # Tests for get_client
  227. # ========================================================================
  228. def test_get_client_returns_client(self, manager, mock_client):
  229. """Verify get_client returns the client."""
  230. manager._clients[1] = mock_client
  231. result = manager.get_client(1)
  232. assert result == mock_client
  233. def test_get_client_returns_none_for_unknown(self, manager):
  234. """Verify get_client returns None for unknown printer."""
  235. result = manager.get_client(999)
  236. assert result is None
  237. # ========================================================================
  238. # Tests for mark_printer_offline
  239. # ========================================================================
  240. def test_mark_printer_offline_updates_state(self, manager, mock_client):
  241. """Verify mark_printer_offline updates client state."""
  242. mock_client.state.connected = True
  243. manager._clients[1] = mock_client
  244. manager.mark_printer_offline(1)
  245. assert mock_client.state.connected is False
  246. assert mock_client.state.state == "unknown"
  247. def test_mark_printer_offline_triggers_callback(self, manager, mock_client):
  248. """Verify mark_printer_offline triggers status callback."""
  249. mock_client.state.connected = True
  250. manager._clients[1] = mock_client
  251. # Callback must return a coroutine
  252. async def async_callback(printer_id, state):
  253. pass
  254. manager._on_status_change = async_callback
  255. # Need a running loop for callback
  256. mock_loop = MagicMock()
  257. mock_loop.is_running.return_value = True
  258. manager._loop = mock_loop
  259. manager.mark_printer_offline(1)
  260. # Callback should be scheduled via run_coroutine_threadsafe
  261. mock_loop.is_running.assert_called()
  262. # State should be updated
  263. assert mock_client.state.connected is False
  264. def test_mark_printer_offline_handles_unknown(self, manager):
  265. """Verify mark_printer_offline handles unknown printer."""
  266. manager.mark_printer_offline(999) # Should not raise
  267. def test_mark_printer_offline_skips_already_offline(self, manager, mock_client):
  268. """Verify mark_printer_offline skips already offline printer."""
  269. mock_client.state.connected = False
  270. manager._clients[1] = mock_client
  271. manager.mark_printer_offline(1)
  272. # State should remain unchanged
  273. assert mock_client.state.connected is False
  274. # ========================================================================
  275. # Tests for start_print
  276. # ========================================================================
  277. def test_start_print_calls_client(self, manager, mock_client):
  278. """Verify start_print calls client method."""
  279. mock_client.start_print.return_value = True
  280. manager._clients[1] = mock_client
  281. result = manager.start_print(1, "test.gcode")
  282. mock_client.start_print.assert_called_once_with(
  283. "test.gcode",
  284. 1,
  285. ams_mapping=None,
  286. timelapse=False,
  287. bed_levelling=True,
  288. flow_cali=False,
  289. vibration_cali=True,
  290. layer_inspect=False,
  291. use_ams=True,
  292. )
  293. assert result is True
  294. def test_start_print_returns_false_for_unknown(self, manager):
  295. """Verify start_print returns False for unknown printer."""
  296. result = manager.start_print(999, "test.gcode")
  297. assert result is False
  298. def test_start_print_logs_print_command_with_caller(self, manager, mock_client, caplog):
  299. """Verify start_print logs PRINT COMMAND with caller info (#374)."""
  300. mock_client.start_print.return_value = True
  301. manager._clients[1] = mock_client
  302. with caplog.at_level(logging.INFO, logger="backend.app.services.printer_manager"):
  303. manager.start_print(1, "benchy.3mf")
  304. print_cmd_logs = [r for r in caplog.records if "PRINT COMMAND" in r.message]
  305. assert len(print_cmd_logs) == 1
  306. log_msg = print_cmd_logs[0].message
  307. assert "printer=1" in log_msg
  308. assert "file=benchy.3mf" in log_msg
  309. assert "caller=" in log_msg
  310. def test_start_print_logs_even_when_printer_unknown(self, manager, caplog):
  311. """Verify PRINT COMMAND is logged even for unknown printers (#374)."""
  312. with caplog.at_level(logging.INFO, logger="backend.app.services.printer_manager"):
  313. result = manager.start_print(999, "ghost.3mf")
  314. assert result is False
  315. print_cmd_logs = [r for r in caplog.records if "PRINT COMMAND" in r.message]
  316. assert len(print_cmd_logs) == 1
  317. # ========================================================================
  318. # Tests for stop_print
  319. # ========================================================================
  320. def test_stop_print_calls_client(self, manager, mock_client):
  321. """Verify stop_print calls client method."""
  322. mock_client.stop_print.return_value = True
  323. manager._clients[1] = mock_client
  324. result = manager.stop_print(1)
  325. mock_client.stop_print.assert_called_once()
  326. assert result is True
  327. def test_stop_print_returns_false_for_unknown(self, manager):
  328. """Verify stop_print returns False for unknown printer."""
  329. result = manager.stop_print(999)
  330. assert result is False
  331. # ========================================================================
  332. # Tests for wait_for_cooldown
  333. # ========================================================================
  334. @pytest.mark.asyncio
  335. async def test_wait_for_cooldown_returns_true_when_cool(self, manager, mock_client):
  336. """Verify wait_for_cooldown returns True when printer is cool."""
  337. mock_client.state.connected = True
  338. mock_client.state.temperatures = {"nozzle": 40, "bed": 30}
  339. mock_client.check_staleness.return_value = True
  340. manager._clients[1] = mock_client
  341. result = await manager.wait_for_cooldown(1, target_temp=50)
  342. assert result is True
  343. @pytest.mark.asyncio
  344. async def test_wait_for_cooldown_returns_false_on_disconnect(self, manager, mock_client):
  345. """Verify wait_for_cooldown returns False when printer disconnects."""
  346. mock_client.state.connected = False
  347. mock_client.check_staleness.return_value = False
  348. manager._clients[1] = mock_client
  349. result = await manager.wait_for_cooldown(1, target_temp=50, timeout=1)
  350. assert result is False
  351. @pytest.mark.asyncio
  352. async def test_wait_for_cooldown_returns_false_for_unknown(self, manager):
  353. """Verify wait_for_cooldown returns False for unknown printer."""
  354. result = await manager.wait_for_cooldown(999, target_temp=50, timeout=1)
  355. assert result is False
  356. @pytest.mark.asyncio
  357. async def test_wait_for_cooldown_checks_both_nozzles(self, manager, mock_client):
  358. """Verify wait_for_cooldown checks both nozzles for dual extruders."""
  359. mock_client.state.connected = True
  360. mock_client.state.temperatures = {"nozzle": 40, "nozzle_2": 45, "bed": 30}
  361. mock_client.check_staleness.return_value = True
  362. manager._clients[1] = mock_client
  363. result = await manager.wait_for_cooldown(1, target_temp=50)
  364. assert result is True
  365. # ========================================================================
  366. # Tests for logging methods
  367. # ========================================================================
  368. def test_enable_logging_calls_client(self, manager, mock_client):
  369. """Verify enable_logging calls client method."""
  370. manager._clients[1] = mock_client
  371. result = manager.enable_logging(1, True)
  372. mock_client.enable_logging.assert_called_once_with(True)
  373. assert result is True
  374. def test_enable_logging_returns_false_for_unknown(self, manager):
  375. """Verify enable_logging returns False for unknown printer."""
  376. result = manager.enable_logging(999, True)
  377. assert result is False
  378. def test_get_logs_returns_logs(self, manager, mock_client):
  379. """Verify get_logs returns client logs."""
  380. mock_logs = [MagicMock(), MagicMock()]
  381. mock_client.get_logs.return_value = mock_logs
  382. manager._clients[1] = mock_client
  383. result = manager.get_logs(1)
  384. assert result == mock_logs
  385. def test_get_logs_returns_empty_for_unknown(self, manager):
  386. """Verify get_logs returns empty list for unknown printer."""
  387. result = manager.get_logs(999)
  388. assert result == []
  389. def test_clear_logs_calls_client(self, manager, mock_client):
  390. """Verify clear_logs calls client method."""
  391. manager._clients[1] = mock_client
  392. result = manager.clear_logs(1)
  393. mock_client.clear_logs.assert_called_once()
  394. assert result is True
  395. def test_clear_logs_returns_false_for_unknown(self, manager):
  396. """Verify clear_logs returns False for unknown printer."""
  397. result = manager.clear_logs(999)
  398. assert result is False
  399. def test_is_logging_enabled_returns_status(self, manager, mock_client):
  400. """Verify is_logging_enabled returns client status."""
  401. mock_client.logging_enabled = True
  402. manager._clients[1] = mock_client
  403. result = manager.is_logging_enabled(1)
  404. assert result is True
  405. def test_is_logging_enabled_returns_false_for_unknown(self, manager):
  406. """Verify is_logging_enabled returns False for unknown printer."""
  407. result = manager.is_logging_enabled(999)
  408. assert result is False
  409. # ========================================================================
  410. # Tests for request_status_update
  411. # ========================================================================
  412. def test_request_status_update_calls_client(self, manager, mock_client):
  413. """Verify request_status_update calls client method."""
  414. mock_client.request_status_update.return_value = True
  415. manager._clients[1] = mock_client
  416. result = manager.request_status_update(1)
  417. mock_client.request_status_update.assert_called_once()
  418. assert result is True
  419. def test_request_status_update_returns_false_for_unknown(self, manager):
  420. """Verify request_status_update returns False for unknown printer."""
  421. result = manager.request_status_update(999)
  422. assert result is False
  423. # ========================================================================
  424. # Tests for test_connection
  425. # ========================================================================
  426. @pytest.mark.asyncio
  427. async def test_test_connection_success(self, manager):
  428. """Verify test_connection returns success on connection."""
  429. with patch("backend.app.services.printer_manager.BambuMQTTClient") as MockClient:
  430. mock_instance = MagicMock()
  431. mock_instance.state = MagicMock()
  432. mock_instance.state.connected = True
  433. mock_instance.state.state = "IDLE"
  434. mock_instance.state.raw_data = {"device_model": "X1C"}
  435. MockClient.return_value = mock_instance
  436. result = await manager.test_connection("192.168.1.100", "00M09A123456789", "12345678")
  437. assert result["success"] is True
  438. assert result["state"] == "IDLE"
  439. assert result["model"] == "X1C"
  440. mock_instance.disconnect.assert_called_once()
  441. @pytest.mark.asyncio
  442. async def test_test_connection_failure(self, manager):
  443. """Verify test_connection returns failure on connection error."""
  444. with patch("backend.app.services.printer_manager.BambuMQTTClient") as MockClient:
  445. mock_instance = MagicMock()
  446. mock_instance.state = MagicMock()
  447. mock_instance.state.connected = False
  448. MockClient.return_value = mock_instance
  449. result = await manager.test_connection("192.168.1.100", "00M09A123456789", "12345678")
  450. assert result["success"] is False
  451. assert result["state"] is None
  452. mock_instance.disconnect.assert_called_once()
  453. # ========================================================================
  454. # Tests for current print user tracking (Issue #206)
  455. # ========================================================================
  456. def test_set_current_print_user(self, manager):
  457. """Verify current print user can be set."""
  458. manager.set_current_print_user(1, 42, "testuser")
  459. assert 1 in manager._current_print_user
  460. assert manager._current_print_user[1]["user_id"] == 42
  461. assert manager._current_print_user[1]["username"] == "testuser"
  462. def test_get_current_print_user_returns_user(self, manager):
  463. """Verify get_current_print_user returns the stored user."""
  464. manager.set_current_print_user(1, 42, "testuser")
  465. result = manager.get_current_print_user(1)
  466. assert result is not None
  467. assert result["user_id"] == 42
  468. assert result["username"] == "testuser"
  469. def test_get_current_print_user_returns_none_for_unknown(self, manager):
  470. """Verify get_current_print_user returns None for unknown printer."""
  471. result = manager.get_current_print_user(999)
  472. assert result is None
  473. def test_clear_current_print_user(self, manager):
  474. """Verify current print user can be cleared."""
  475. manager.set_current_print_user(1, 42, "testuser")
  476. manager.clear_current_print_user(1)
  477. result = manager.get_current_print_user(1)
  478. assert result is None
  479. def test_clear_current_print_user_no_error_for_unknown(self, manager):
  480. """Verify clearing unknown printer doesn't raise error."""
  481. # Should not raise
  482. manager.clear_current_print_user(999)
  483. def test_set_current_print_user_overwrites_existing(self, manager):
  484. """Verify setting user overwrites existing value."""
  485. manager.set_current_print_user(1, 42, "user1")
  486. manager.set_current_print_user(1, 99, "user2")
  487. result = manager.get_current_print_user(1)
  488. assert result["user_id"] == 99
  489. assert result["username"] == "user2"
  490. def test_multiple_printers_have_separate_users(self, manager):
  491. """Verify each printer tracks its own user separately."""
  492. manager.set_current_print_user(1, 42, "user1")
  493. manager.set_current_print_user(2, 99, "user2")
  494. result1 = manager.get_current_print_user(1)
  495. result2 = manager.get_current_print_user(2)
  496. assert result1["username"] == "user1"
  497. assert result2["username"] == "user2"
  498. class TestPrinterStateToDict:
  499. """Tests for printer_state_to_dict helper function."""
  500. @pytest.fixture
  501. def mock_state(self):
  502. """Create a mock PrinterState."""
  503. state = MagicMock()
  504. state.connected = True
  505. state.state = "RUNNING"
  506. state.current_print = "test.3mf"
  507. state.subtask_name = "Test Print"
  508. state.gcode_file = "/sdcard/test.gcode"
  509. state.progress = 50
  510. state.remaining_time = 3600
  511. state.layer_num = 10
  512. state.total_layers = 20
  513. state.temperatures = {"nozzle": 200, "bed": 60}
  514. state.hms_errors = []
  515. state.ams_status_main = 0
  516. state.ams_status_sub = 0
  517. state.tray_now = "1"
  518. state.wifi_signal = -50
  519. state.raw_data = {}
  520. state.stg_cur = -1 # No calibration stage active
  521. state.firmware_version = None
  522. return state
  523. def test_basic_conversion(self, mock_state):
  524. """Verify basic state fields are converted."""
  525. result = printer_state_to_dict(mock_state)
  526. assert result["connected"] is True
  527. assert result["state"] == "RUNNING"
  528. assert result["progress"] == 50
  529. assert result["temperatures"] == {"nozzle": 200, "bed": 60}
  530. def test_ams_data_parsing(self, mock_state):
  531. """Verify AMS data is parsed correctly."""
  532. mock_state.raw_data = {
  533. "ams": [
  534. {
  535. "id": 0,
  536. "humidity_raw": 45,
  537. "temp": 25,
  538. "tray": [
  539. {
  540. "id": 0,
  541. "tray_color": "FF0000",
  542. "tray_type": "PLA",
  543. "tray_sub_brands": "Generic",
  544. "remain": 80,
  545. "k": 0.5,
  546. "tag_uid": "ABC123",
  547. "tray_uuid": "uuid-123",
  548. }
  549. ],
  550. }
  551. ]
  552. }
  553. result = printer_state_to_dict(mock_state)
  554. assert result["ams"] is not None
  555. assert len(result["ams"]) == 1
  556. assert result["ams"][0]["humidity"] == 45
  557. assert len(result["ams"][0]["tray"]) == 1
  558. assert result["ams"][0]["tray"][0]["tray_color"] == "FF0000"
  559. def test_empty_tag_uid_becomes_none(self, mock_state):
  560. """Verify empty tag_uid is converted to None."""
  561. mock_state.raw_data = {
  562. "ams": [
  563. {
  564. "id": 0,
  565. "tray": [
  566. {
  567. "id": 0,
  568. "tag_uid": "",
  569. "tray_uuid": "00000000000000000000000000000000",
  570. }
  571. ],
  572. }
  573. ]
  574. }
  575. result = printer_state_to_dict(mock_state)
  576. assert result["ams"][0]["tray"][0]["tag_uid"] is None
  577. assert result["ams"][0]["tray"][0]["tray_uuid"] is None
  578. def test_zero_tag_uid_becomes_none(self, mock_state):
  579. """Verify zero tag_uid is converted to None."""
  580. mock_state.raw_data = {
  581. "ams": [
  582. {
  583. "id": 0,
  584. "tray": [
  585. {
  586. "id": 0,
  587. "tag_uid": "0000000000000000",
  588. }
  589. ],
  590. }
  591. ]
  592. }
  593. result = printer_state_to_dict(mock_state)
  594. assert result["ams"][0]["tray"][0]["tag_uid"] is None
  595. def test_vt_tray_parsing(self, mock_state):
  596. """Verify virtual tray is parsed correctly as a list."""
  597. mock_state.raw_data = {
  598. "vt_tray": [
  599. {
  600. "tray_color": "00FF00",
  601. "tray_type": "PETG",
  602. "tray_sub_brands": "Generic",
  603. "remain": 60,
  604. "tag_uid": "VT123",
  605. }
  606. ]
  607. }
  608. result = printer_state_to_dict(mock_state)
  609. assert isinstance(result["vt_tray"], list)
  610. assert len(result["vt_tray"]) == 1
  611. assert result["vt_tray"][0]["id"] == 254
  612. assert result["vt_tray"][0]["tray_color"] == "00FF00"
  613. assert result["vt_tray"][0]["tray_type"] == "PETG"
  614. def test_vt_tray_dict_normalized_to_list(self, mock_state):
  615. """Verify vt_tray as a raw dict (from MQTT) is normalized to a list."""
  616. mock_state.raw_data = {
  617. "vt_tray": {
  618. "id": "254",
  619. "tray_color": "FF0000",
  620. "tray_type": "PLA",
  621. "tray_sub_brands": "Generic",
  622. "tag_uid": "0000000000000000",
  623. "tray_uuid": "00000000000000000000000000000000",
  624. "remain": 0,
  625. }
  626. }
  627. result = printer_state_to_dict(mock_state)
  628. assert isinstance(result["vt_tray"], list)
  629. assert len(result["vt_tray"]) == 1
  630. assert result["vt_tray"][0]["tray_color"] == "FF0000"
  631. assert result["vt_tray"][0]["tray_type"] == "PLA"
  632. assert result["vt_tray"][0]["tag_uid"] is None
  633. assert result["vt_tray"][0]["tray_uuid"] is None
  634. def test_vt_tray_non_list_non_dict_ignored(self, mock_state):
  635. """Verify unexpected vt_tray types (e.g. string) produce empty list."""
  636. mock_state.raw_data = {"vt_tray": "unexpected_string"}
  637. result = printer_state_to_dict(mock_state)
  638. assert result["vt_tray"] == []
  639. def test_hms_errors_conversion(self, mock_state):
  640. """Verify HMS errors are converted correctly."""
  641. error = MagicMock()
  642. error.code = "0700_0100"
  643. error.attr = 1
  644. error.module = "AMS"
  645. error.severity = 2
  646. mock_state.hms_errors = [error]
  647. result = printer_state_to_dict(mock_state)
  648. assert len(result["hms_errors"]) == 1
  649. assert result["hms_errors"][0]["code"] == "0700_0100"
  650. assert result["hms_errors"][0]["module"] == "AMS"
  651. def test_cover_url_added_for_running_print(self, mock_state):
  652. """Verify cover_url is added for running prints."""
  653. result = printer_state_to_dict(mock_state, printer_id=1)
  654. assert result["cover_url"] == "/api/v1/printers/1/cover"
  655. def test_cover_url_none_when_not_running(self, mock_state):
  656. """Verify cover_url is None when not printing."""
  657. mock_state.state = "IDLE"
  658. result = printer_state_to_dict(mock_state, printer_id=1)
  659. assert result["cover_url"] is None
  660. def test_ams_ht_detection(self, mock_state):
  661. """Verify AMS-HT is detected (1 tray vs 4)."""
  662. mock_state.raw_data = {
  663. "ams": [
  664. {
  665. "id": 0,
  666. "tray": [{"id": 0}], # Only 1 tray = AMS-HT
  667. }
  668. ]
  669. }
  670. result = printer_state_to_dict(mock_state)
  671. assert result["ams"][0]["is_ams_ht"] is True
  672. def test_regular_ams_detection(self, mock_state):
  673. """Verify regular AMS is detected (4 trays)."""
  674. mock_state.raw_data = {"ams": [{"id": 0, "tray": [{"id": 0}, {"id": 1}, {"id": 2}, {"id": 3}]}]}
  675. result = printer_state_to_dict(mock_state)
  676. assert result["ams"][0]["is_ams_ht"] is False
  677. def test_chamber_temp_filtered_for_p1s(self, mock_state):
  678. """Verify chamber temperature is filtered out for P1S (no chamber sensor)."""
  679. mock_state.temperatures = {
  680. "nozzle": 200,
  681. "bed": 60,
  682. "chamber": 5,
  683. "chamber_target": 0,
  684. "chamber_heating": False,
  685. }
  686. result = printer_state_to_dict(mock_state, model="P1S")
  687. assert "chamber" not in result["temperatures"]
  688. assert "chamber_target" not in result["temperatures"]
  689. assert "chamber_heating" not in result["temperatures"]
  690. assert result["temperatures"]["nozzle"] == 200
  691. assert result["temperatures"]["bed"] == 60
  692. def test_chamber_temp_kept_for_x1c(self, mock_state):
  693. """Verify chamber temperature is kept for X1C (has chamber sensor)."""
  694. mock_state.temperatures = {
  695. "nozzle": 200,
  696. "bed": 60,
  697. "chamber": 25,
  698. "chamber_target": 45,
  699. "chamber_heating": True,
  700. }
  701. result = printer_state_to_dict(mock_state, model="X1C")
  702. assert result["temperatures"]["chamber"] == 25
  703. assert result["temperatures"]["chamber_target"] == 45
  704. assert result["temperatures"]["chamber_heating"] is True
  705. def test_chamber_temp_filtered_for_a1(self, mock_state):
  706. """Verify chamber temperature is filtered out for A1 (no chamber sensor)."""
  707. mock_state.temperatures = {"nozzle": 200, "bed": 60, "chamber": 5}
  708. result = printer_state_to_dict(mock_state, model="A1")
  709. assert "chamber" not in result["temperatures"]
  710. def test_chamber_temp_kept_when_no_model(self, mock_state):
  711. """Verify chamber temperature is kept when model is not specified (conservative approach)."""
  712. mock_state.temperatures = {"nozzle": 200, "bed": 60, "chamber": 25}
  713. result = printer_state_to_dict(mock_state) # No model specified
  714. # When model is unknown, we can't filter - leave as is
  715. # Actually supports_chamber_temp returns False for None, so it will filter
  716. # Let's check the actual behavior
  717. assert "chamber" not in result["temperatures"]
  718. def test_ams_drying_fields_included(self, mock_state):
  719. """Verify AMS drying fields (dry_time, module_type) are included in output."""
  720. mock_state.raw_data = {
  721. "ams": [
  722. {
  723. "id": 0,
  724. "dry_time": 42,
  725. "module_type": "n3f",
  726. "tray": [
  727. {
  728. "id": 0,
  729. "tray_color": "FF0000",
  730. "tray_type": "PLA",
  731. "drying_temp": 55,
  732. "drying_time": 240,
  733. }
  734. ],
  735. }
  736. ]
  737. }
  738. result = printer_state_to_dict(mock_state)
  739. ams_unit = result["ams"][0]
  740. assert ams_unit["dry_time"] == 42
  741. assert ams_unit["module_type"] == "n3f"
  742. # Tray-level drying fields
  743. tray = ams_unit["tray"][0]
  744. assert tray["drying_temp"] == 55
  745. assert tray["drying_time"] == 240
  746. class TestStatusKeyDryingDedup:
  747. """Regression tests for WebSocket dedup including drying fields.
  748. The WebSocket broadcast deduplication uses printer_state_to_dict output
  749. to detect changes. If drying fields (like dry_time) are missing from
  750. the dict, changes to those fields won't trigger broadcasts.
  751. """
  752. def test_dry_time_change_changes_status_key(self):
  753. """Verify dry_time is present in AMS unit data so dedup can detect changes."""
  754. state = MagicMock()
  755. state.connected = True
  756. state.state = "IDLE"
  757. state.current_print = None
  758. state.subtask_name = None
  759. state.gcode_file = None
  760. state.progress = 0
  761. state.remaining_time = 0
  762. state.layer_num = 0
  763. state.total_layers = 0
  764. state.temperatures = {"nozzle": 25, "bed": 25}
  765. state.hms_errors = []
  766. state.ams_status_main = 0
  767. state.ams_status_sub = 0
  768. state.tray_now = None
  769. state.wifi_signal = -50
  770. state.stg_cur = -1
  771. # First state: drying active with 30 minutes remaining
  772. state.raw_data = {"ams": [{"id": 0, "dry_time": 30, "module_type": "n3f", "tray": [{"id": 0}]}]}
  773. result1 = printer_state_to_dict(state)
  774. # Second state: drying time decreased
  775. state.raw_data = {"ams": [{"id": 0, "dry_time": 29, "module_type": "n3f", "tray": [{"id": 0}]}]}
  776. result2 = printer_state_to_dict(state)
  777. # The dicts should differ — dry_time changed
  778. assert result1["ams"][0]["dry_time"] == 30
  779. assert result2["ams"][0]["dry_time"] == 29
  780. assert result1["ams"] != result2["ams"]
  781. class TestSupportsChamberTemp:
  782. """Tests for supports_chamber_temp helper function."""
  783. def test_x1_series_supported(self):
  784. """Verify X1 series printers support chamber temp."""
  785. assert supports_chamber_temp("X1") is True
  786. assert supports_chamber_temp("X1C") is True
  787. assert supports_chamber_temp("X1E") is True
  788. def test_p2_series_supported(self):
  789. """Verify P2 series printers support chamber temp."""
  790. assert supports_chamber_temp("P2S") is True
  791. def test_h2_series_supported(self):
  792. """Verify H2 series printers support chamber temp."""
  793. assert supports_chamber_temp("H2C") is True
  794. assert supports_chamber_temp("H2D") is True
  795. assert supports_chamber_temp("H2DPRO") is True
  796. assert supports_chamber_temp("H2S") is True
  797. def test_p1_series_not_supported(self):
  798. """Verify P1 series printers do NOT support chamber temp."""
  799. assert supports_chamber_temp("P1P") is False
  800. assert supports_chamber_temp("P1S") is False
  801. def test_a1_series_not_supported(self):
  802. """Verify A1 series printers do NOT support chamber temp."""
  803. assert supports_chamber_temp("A1") is False
  804. assert supports_chamber_temp("A1MINI") is False
  805. def test_none_model_not_supported(self):
  806. """Verify None model returns False."""
  807. assert supports_chamber_temp(None) is False
  808. def test_case_insensitive(self):
  809. """Verify model matching is case-insensitive."""
  810. assert supports_chamber_temp("x1c") is True
  811. assert supports_chamber_temp("X1c") is True
  812. assert supports_chamber_temp("p1s") is False
  813. def test_internal_model_codes_supported(self):
  814. """Verify internal model codes from MQTT/SSDP are recognized."""
  815. # X1/X1C
  816. assert supports_chamber_temp("BL-P001") is True
  817. # X1E
  818. assert supports_chamber_temp("C13") is True
  819. # H2D
  820. assert supports_chamber_temp("O1D") is True
  821. # H2C
  822. assert supports_chamber_temp("O1C") is True
  823. # H2S
  824. assert supports_chamber_temp("O1S") is True
  825. # H2D Pro
  826. assert supports_chamber_temp("O1E") is True
  827. # P2S
  828. assert supports_chamber_temp("N7") is True
  829. def test_internal_model_codes_not_supported(self):
  830. """Verify A1/P1 internal codes are NOT supported."""
  831. # P1P
  832. assert supports_chamber_temp("C11") is False
  833. # P1S
  834. assert supports_chamber_temp("C12") is False
  835. # A1
  836. assert supports_chamber_temp("N2S") is False
  837. # A1 Mini
  838. assert supports_chamber_temp("N1") is False
  839. class TestSupportsDrying:
  840. """Tests for supports_drying helper function."""
  841. def test_known_supported_with_firmware(self):
  842. """Verify known models with sufficient firmware return True."""
  843. assert supports_drying("X1C", "01.09.00.00") is True
  844. assert supports_drying("P1S", "01.08.00.00") is True
  845. assert supports_drying("H2D", "01.02.30.00") is True
  846. assert supports_drying("H2S", "01.02.00.00") is True
  847. def test_known_supported_old_firmware(self):
  848. """Verify known models with old firmware return False."""
  849. assert supports_drying("X1C", "01.08.00.00") is False
  850. assert supports_drying("P1S", "01.07.00.00") is False
  851. assert supports_drying("H2S", "01.01.00.00") is False
  852. def test_known_supported_no_firmware(self):
  853. """Verify known models with no firmware return False."""
  854. assert supports_drying("X1C", None) is False
  855. def test_unsupported_models(self):
  856. """Verify models without AMS drying support return False regardless of firmware."""
  857. for model in ["P2S", "A1", "A1MINI", "A1-MINI", "H2C", "N7", "N1", "N2S"]:
  858. assert supports_drying(model, "99.99.99.99") is False, f"Expected False for {model}"
  859. def test_unknown_models_allowed(self):
  860. """Verify unknown models are allowed (graceful fallback).
  861. Models not in the unsupported set AND not matching any known firmware-gated
  862. model substring get the benefit of the doubt and return True.
  863. "H2D Pro" contains "H2D" so it IS firmware-gated (needs firmware).
  864. """
  865. # Truly unknown models: no substring match in _DRYING_MIN_FIRMWARE
  866. assert supports_drying("FUTURE_MODEL", None) is True
  867. # X1E contains "X1" substring, so it IS firmware-gated
  868. assert supports_drying("X1E", "01.09.00.00") is True
  869. # H2D Pro contains "H2D" substring, so it IS firmware-gated
  870. assert supports_drying("H2D Pro", "01.02.30.00") is True
  871. def test_none_model(self):
  872. """Verify None model returns False."""
  873. assert supports_drying(None, "01.09.00.00") is False
  874. def test_case_insensitive(self):
  875. """Verify model matching is case-insensitive."""
  876. assert supports_drying("x1c", "01.09.00.00") is True
  877. assert supports_drying("p2s", "99.99.99.99") is False
  878. class TestGetDerivedStatusName:
  879. """Tests for get_derived_status_name function."""
  880. def test_stg_cur_255_returns_none(self):
  881. """Verify stg_cur=255 (A1/P1 idle) returns None, not 'Unknown stage (255)'."""
  882. state = MagicMock()
  883. state.stg_cur = 255
  884. state.state = "IDLE"
  885. result = get_derived_status_name(state)
  886. assert result is None
  887. def test_stg_cur_negative_one_returns_none_when_idle(self):
  888. """Verify stg_cur=-1 (X1 idle) returns None."""
  889. state = MagicMock()
  890. state.stg_cur = -1
  891. state.state = "IDLE"
  892. result = get_derived_status_name(state)
  893. assert result is None
  894. def test_valid_stage_returns_name(self):
  895. """Verify valid stg_cur values return stage name."""
  896. state = MagicMock()
  897. state.stg_cur = 1 # Auto bed leveling
  898. result = get_derived_status_name(state)
  899. assert result == "Auto bed leveling"
  900. def test_stg_cur_zero_returns_printing(self):
  901. """Verify stg_cur=0 returns 'Printing' when no model specified."""
  902. state = MagicMock()
  903. state.stg_cur = 0
  904. result = get_derived_status_name(state)
  905. assert result == "Printing"
  906. def test_a1_idle_with_stg_cur_zero_returns_none(self):
  907. """Verify A1 with IDLE state and stg_cur=0 returns None (bug workaround)."""
  908. state = MagicMock()
  909. state.stg_cur = 0
  910. state.state = "IDLE"
  911. # Test various A1 model names
  912. for model in ["A1", "A1 Mini", "A1-Mini", "A1MINI", "N1", "N2S"]:
  913. result = get_derived_status_name(state, model)
  914. assert result is None, f"Expected None for model {model}"
  915. def test_a1_running_with_stg_cur_zero_returns_printing(self):
  916. """Verify A1 with RUNNING state and stg_cur=0 still returns 'Printing'."""
  917. state = MagicMock()
  918. state.stg_cur = 0
  919. state.state = "RUNNING"
  920. result = get_derived_status_name(state, "A1")
  921. assert result == "Printing"
  922. def test_non_a1_idle_with_stg_cur_zero_returns_printing(self):
  923. """Verify non-A1 models with IDLE and stg_cur=0 still return 'Printing'."""
  924. state = MagicMock()
  925. state.stg_cur = 0
  926. state.state = "IDLE"
  927. # X1C should not get the workaround
  928. result = get_derived_status_name(state, "X1C")
  929. assert result == "Printing"
  930. class TestHasStgCurIdleBug:
  931. """Tests for has_stg_cur_idle_bug function."""
  932. def test_a1_models_return_true(self):
  933. """Verify A1 model variants return True."""
  934. assert has_stg_cur_idle_bug("A1") is True
  935. assert has_stg_cur_idle_bug("A1 Mini") is True
  936. assert has_stg_cur_idle_bug("A1-Mini") is True
  937. assert has_stg_cur_idle_bug("A1MINI") is True
  938. assert has_stg_cur_idle_bug("a1") is True # case insensitive
  939. assert has_stg_cur_idle_bug("a1 mini") is True
  940. def test_p1_models_return_true(self):
  941. """Verify P1P/P1S model variants return True."""
  942. assert has_stg_cur_idle_bug("P1P") is True
  943. assert has_stg_cur_idle_bug("P1S") is True
  944. assert has_stg_cur_idle_bug("p1p") is True # case insensitive
  945. def test_internal_codes_return_true(self):
  946. """Verify internal model codes return True."""
  947. assert has_stg_cur_idle_bug("N1") is True # A1 Mini
  948. assert has_stg_cur_idle_bug("N2S") is True # A1
  949. assert has_stg_cur_idle_bug("C11") is True # P1P
  950. assert has_stg_cur_idle_bug("C12") is True # P1S
  951. def test_non_affected_models_return_false(self):
  952. """Verify non-affected models return False."""
  953. assert has_stg_cur_idle_bug("X1C") is False
  954. assert has_stg_cur_idle_bug("X1") is False
  955. assert has_stg_cur_idle_bug("H2D") is False
  956. def test_none_model_returns_false(self):
  957. """Verify None model returns False."""
  958. assert has_stg_cur_idle_bug(None) is False
  959. def test_empty_model_returns_false(self):
  960. """Verify empty model returns False."""
  961. assert has_stg_cur_idle_bug("") is False
  962. class TestInitPrinterConnections:
  963. """Tests for init_printer_connections function."""
  964. @pytest.mark.asyncio
  965. async def test_connects_all_active_printers(self):
  966. """Verify all active printers are connected."""
  967. mock_db = AsyncMock()
  968. mock_printer1 = MagicMock(id=1, is_active=True)
  969. mock_printer2 = MagicMock(id=2, is_active=True)
  970. mock_result = MagicMock()
  971. mock_result.scalars.return_value.all.return_value = [mock_printer1, mock_printer2]
  972. mock_db.execute.return_value = mock_result
  973. with patch("backend.app.services.printer_manager.printer_manager") as mock_manager:
  974. mock_manager.connect_printer = AsyncMock()
  975. await init_printer_connections(mock_db)
  976. assert mock_manager.connect_printer.call_count == 2
  977. @pytest.mark.asyncio
  978. async def test_handles_empty_printer_list(self):
  979. """Verify empty printer list is handled."""
  980. mock_db = AsyncMock()
  981. mock_result = MagicMock()
  982. mock_result.scalars.return_value.all.return_value = []
  983. mock_db.execute.return_value = mock_result
  984. with patch("backend.app.services.printer_manager.printer_manager") as mock_manager:
  985. mock_manager.connect_printer = AsyncMock()
  986. await init_printer_connections(mock_db)
  987. mock_manager.connect_printer.assert_not_called()
  988. class TestAmsChangeCallback:
  989. """Tests for AMS change callback functionality."""
  990. @pytest.fixture
  991. def manager(self):
  992. """Create a fresh PrinterManager instance."""
  993. return PrinterManager()
  994. def test_ams_change_callback_is_triggered(self, manager):
  995. """Verify AMS change callback is called when AMS data changes."""
  996. callback = MagicMock()
  997. manager.set_ams_change_callback(callback)
  998. # Verify callback was set
  999. assert manager._on_ams_change == callback
  1000. def test_ams_change_callback_receives_correct_data(self, manager):
  1001. """Verify AMS change callback receives the correct AMS data format."""
  1002. received_data = []
  1003. def capture_callback(printer_id, ams_data):
  1004. received_data.append((printer_id, ams_data))
  1005. manager.set_ams_change_callback(capture_callback)
  1006. # The callback should accept printer_id and ams_data
  1007. # This tests the callback signature
  1008. assert manager._on_ams_change is not None
  1009. assert callable(manager._on_ams_change)