test_spoolman_api.py 59 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462
  1. """Integration tests for Spoolman API endpoints."""
  2. from unittest.mock import AsyncMock, MagicMock, patch
  3. import pytest
  4. from httpx import AsyncClient
  5. class TestSpoolmanAPI:
  6. """Integration tests for /api/v1/spoolman/ endpoints."""
  7. @pytest.fixture
  8. async def spoolman_settings(self, db_session):
  9. """Create Spoolman settings in the database (enabled with URL)."""
  10. from backend.app.models.settings import Settings
  11. # Both settings are required for Spoolman to work
  12. enabled_setting = Settings(key="spoolman_enabled", value="true")
  13. url_setting = Settings(key="spoolman_url", value="http://localhost:7912")
  14. db_session.add(enabled_setting)
  15. db_session.add(url_setting)
  16. await db_session.commit()
  17. return {"enabled": enabled_setting, "url": url_setting}
  18. @pytest.fixture
  19. async def spoolman_url_only(self, db_session):
  20. """Create only the URL setting (not enabled)."""
  21. from backend.app.models.settings import Settings
  22. setting = Settings(key="spoolman_url", value="http://localhost:7912")
  23. db_session.add(setting)
  24. await db_session.commit()
  25. return setting
  26. @pytest.fixture
  27. def mock_spoolman_client(self):
  28. """Mock the Spoolman client functions."""
  29. mock_client = MagicMock()
  30. mock_client.is_connected = True
  31. mock_client.base_url = "http://localhost:7912"
  32. mock_client.health_check = AsyncMock(return_value=True)
  33. mock_client.ensure_tag_extra_field = AsyncMock(return_value=True)
  34. mock_client.ensure_extra_field = AsyncMock(return_value=True)
  35. mock_client.get_spools = AsyncMock(return_value=[])
  36. mock_client.get_filaments = AsyncMock(return_value=[])
  37. mock_client.create_spool = AsyncMock(return_value={"id": 1})
  38. mock_client.update_spool = AsyncMock(return_value={"id": 1})
  39. mock_client.merge_spool_extra = AsyncMock(return_value={"id": 1, "extra": {}})
  40. mock_client.close = AsyncMock()
  41. with (
  42. patch(
  43. "backend.app.api.routes.spoolman.get_spoolman_client",
  44. AsyncMock(return_value=mock_client),
  45. ),
  46. patch(
  47. "backend.app.api.routes.spoolman.init_spoolman_client",
  48. AsyncMock(return_value=mock_client),
  49. ),
  50. patch(
  51. "backend.app.api.routes.spoolman.close_spoolman_client",
  52. AsyncMock(),
  53. ),
  54. ):
  55. yield mock_client
  56. @pytest.fixture
  57. def mock_spoolman_disconnected(self):
  58. """Mock the Spoolman client as disconnected (returns None)."""
  59. with (
  60. patch(
  61. "backend.app.api.routes.spoolman.get_spoolman_client",
  62. AsyncMock(return_value=None),
  63. ),
  64. patch(
  65. "backend.app.api.routes.spoolman.init_spoolman_client",
  66. AsyncMock(return_value=None),
  67. ),
  68. ):
  69. yield
  70. # =========================================================================
  71. # Status Endpoint Tests
  72. # =========================================================================
  73. @pytest.mark.asyncio
  74. @pytest.mark.integration
  75. async def test_get_status_not_configured(self, async_client: AsyncClient):
  76. """Verify status shows not enabled when no settings exist."""
  77. response = await async_client.get("/api/v1/spoolman/status")
  78. assert response.status_code == 200
  79. data = response.json()
  80. assert data["enabled"] is False
  81. assert data["connected"] is False
  82. @pytest.mark.asyncio
  83. @pytest.mark.integration
  84. async def test_get_status_url_only_not_enabled(self, async_client: AsyncClient, spoolman_url_only):
  85. """Verify status shows not enabled when only URL is set."""
  86. response = await async_client.get("/api/v1/spoolman/status")
  87. assert response.status_code == 200
  88. data = response.json()
  89. assert data["enabled"] is False
  90. assert data["url"] == "http://localhost:7912"
  91. @pytest.mark.asyncio
  92. @pytest.mark.integration
  93. async def test_get_status_enabled_and_connected(
  94. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  95. ):
  96. """Verify status shows enabled and connected when properly configured."""
  97. response = await async_client.get("/api/v1/spoolman/status")
  98. assert response.status_code == 200
  99. data = response.json()
  100. assert data["enabled"] is True
  101. assert data["connected"] is True
  102. assert data["url"] == "http://localhost:7912"
  103. # =========================================================================
  104. # Connect/Disconnect Tests
  105. # =========================================================================
  106. @pytest.mark.asyncio
  107. @pytest.mark.integration
  108. async def test_connect_not_enabled(self, async_client: AsyncClient):
  109. """Verify connect fails when not enabled."""
  110. response = await async_client.post("/api/v1/spoolman/connect")
  111. assert response.status_code == 400
  112. assert "not enabled" in response.json()["detail"].lower()
  113. @pytest.mark.asyncio
  114. @pytest.mark.integration
  115. async def test_connect_success(self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client):
  116. """Verify successful connection to Spoolman."""
  117. response = await async_client.post("/api/v1/spoolman/connect")
  118. assert response.status_code == 200
  119. data = response.json()
  120. assert data["success"] is True
  121. assert "connected" in data["message"].lower()
  122. @pytest.mark.asyncio
  123. @pytest.mark.integration
  124. async def test_disconnect(self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client):
  125. """Verify disconnect works."""
  126. response = await async_client.post("/api/v1/spoolman/disconnect")
  127. assert response.status_code == 200
  128. assert "disconnected" in response.json()["message"].lower()
  129. # =========================================================================
  130. # Spools Endpoint Tests
  131. # =========================================================================
  132. @pytest.mark.asyncio
  133. @pytest.mark.integration
  134. async def test_get_spools_not_enabled(self, async_client: AsyncClient):
  135. """Verify get spools fails when not enabled."""
  136. response = await async_client.get("/api/v1/spoolman/spools")
  137. assert response.status_code == 400
  138. assert "not enabled" in response.json()["detail"].lower()
  139. @pytest.mark.asyncio
  140. @pytest.mark.integration
  141. async def test_get_spools_success(self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client):
  142. """Verify get spools returns data in expected format."""
  143. mock_spool = {
  144. "id": 1,
  145. "remaining_weight": 500,
  146. "used_weight": 500,
  147. "filament": {
  148. "id": 1,
  149. "name": "PLA Basic",
  150. "material": "PLA",
  151. "color_hex": "FF0000",
  152. },
  153. "first_used": "2024-01-01",
  154. "last_used": "2024-01-15",
  155. "location": "AMS1",
  156. "lot_nr": "LOT123",
  157. "comment": "Test spool",
  158. "extra": {"tag": '"ABC123"'},
  159. }
  160. mock_spoolman_client.get_spools = AsyncMock(return_value=[mock_spool])
  161. response = await async_client.get("/api/v1/spoolman/spools")
  162. assert response.status_code == 200
  163. data = response.json()
  164. assert "spools" in data
  165. assert isinstance(data["spools"], list)
  166. assert len(data["spools"]) == 1
  167. assert data["spools"][0]["id"] == 1
  168. # =========================================================================
  169. # Unlinked Spools Tests
  170. # =========================================================================
  171. @pytest.mark.asyncio
  172. @pytest.mark.integration
  173. async def test_get_unlinked_spools_not_enabled(self, async_client: AsyncClient):
  174. """Verify get unlinked spools fails when not enabled."""
  175. response = await async_client.get("/api/v1/spoolman/spools/unlinked")
  176. assert response.status_code == 400
  177. @pytest.mark.asyncio
  178. @pytest.mark.integration
  179. async def test_get_unlinked_spools_success(
  180. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  181. ):
  182. """A spool with no slot assignment is assignable even when extra.tag is set.
  183. #1122 — extra.tag is only an RFID/NFC matching key (OpenSpoolman writes
  184. its own NFC tag value there too); it must NOT gate assignability. A spool
  185. with a non-empty extra.tag but no spoolman_slot_assignments row still
  186. appears in the picker.
  187. """
  188. mock_spool = {
  189. "id": 1,
  190. "remaining_weight": 800,
  191. "used_weight": 200,
  192. "extra": {"tag": '"04A1B2C3D4E5F6"'}, # OpenSpoolman-style NFC tag value
  193. "filament": {
  194. "id": 1,
  195. "name": "PLA Basic",
  196. "material": "PLA",
  197. "color_hex": "FF0000",
  198. },
  199. "location": "Shelf A",
  200. }
  201. mock_spoolman_client.get_spools = AsyncMock(return_value=[mock_spool])
  202. response = await async_client.get("/api/v1/spoolman/spools/unlinked")
  203. assert response.status_code == 200
  204. data = response.json()
  205. assert isinstance(data, list)
  206. assert len(data) == 1
  207. assert data[0]["id"] == 1
  208. assert data[0]["filament_name"] == "PLA Basic"
  209. @pytest.mark.asyncio
  210. @pytest.mark.integration
  211. async def test_get_unlinked_spools_excludes_slot_assigned(
  212. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client, printer_factory, db_session
  213. ):
  214. """Verify spools that currently occupy an AMS slot are excluded."""
  215. from backend.app.models.spoolman_slot_assignment import SpoolmanSlotAssignment
  216. printer = await printer_factory()
  217. # Spool 1 occupies a slot; spool 2 has an extra.tag but no slot row.
  218. db_session.add(SpoolmanSlotAssignment(printer_id=printer.id, ams_id=0, tray_id=1, spoolman_spool_id=1))
  219. await db_session.commit()
  220. mock_spool_assigned = {
  221. "id": 1,
  222. "remaining_weight": 800,
  223. "used_weight": 200,
  224. "extra": {"tag": '"A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"'},
  225. "filament": {"id": 1, "name": "PLA Red", "material": "PLA", "color_hex": "FF0000"},
  226. }
  227. mock_spool_unassigned = {
  228. "id": 2,
  229. "remaining_weight": 900,
  230. "used_weight": 100,
  231. "extra": {"tag": '"04DEADBEEF1122"'}, # tagged but not slot-assigned
  232. "filament": {"id": 2, "name": "PLA Blue", "material": "PLA", "color_hex": "0000FF"},
  233. }
  234. mock_spoolman_client.get_spools = AsyncMock(return_value=[mock_spool_assigned, mock_spool_unassigned])
  235. response = await async_client.get("/api/v1/spoolman/spools/unlinked")
  236. assert response.status_code == 200
  237. data = response.json()
  238. assert len(data) == 1
  239. assert data[0]["id"] == 2 # Only the spool not occupying a slot
  240. # =========================================================================
  241. # Linked Spools Tests
  242. # =========================================================================
  243. @pytest.mark.asyncio
  244. @pytest.mark.integration
  245. async def test_get_linked_spools_not_enabled(self, async_client: AsyncClient):
  246. """Verify get linked spools fails when not enabled."""
  247. response = await async_client.get("/api/v1/spoolman/spools/linked")
  248. assert response.status_code == 400
  249. @pytest.mark.asyncio
  250. @pytest.mark.integration
  251. async def test_get_linked_spools_success(self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client):
  252. """Verify get linked spools returns map of tag -> spool_id."""
  253. # Mock spool with extra.tag (linked)
  254. mock_spool = {
  255. "id": 42,
  256. "remaining_weight": 800,
  257. "extra": {"tag": '"A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"'},
  258. "filament": {"id": 1, "name": "PLA Red", "material": "PLA", "weight": 1000},
  259. }
  260. mock_spoolman_client.get_spools = AsyncMock(return_value=[mock_spool])
  261. response = await async_client.get("/api/v1/spoolman/spools/linked")
  262. assert response.status_code == 200
  263. data = response.json()
  264. assert "linked" in data
  265. assert isinstance(data["linked"], dict)
  266. # Tag should be uppercase and stripped of quotes
  267. assert "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4" in data["linked"]
  268. linked_info = data["linked"]["A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"]
  269. assert linked_info["id"] == 42
  270. assert linked_info["remaining_weight"] == 800
  271. assert linked_info["filament_weight"] == 1000
  272. @pytest.mark.asyncio
  273. @pytest.mark.integration
  274. async def test_get_linked_spools_excludes_unlinked(
  275. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  276. ):
  277. """Verify unlinked spools (without tag) are excluded."""
  278. # Mock spool with tag (linked)
  279. mock_spool_linked = {
  280. "id": 1,
  281. "extra": {"tag": '"ABC12345678901234567890123456789A"'},
  282. "filament": {"id": 1, "name": "PLA Red", "material": "PLA"},
  283. }
  284. # Mock spool without tag (unlinked)
  285. mock_spool_unlinked = {
  286. "id": 2,
  287. "extra": {},
  288. "filament": {"id": 2, "name": "PLA Blue", "material": "PLA"},
  289. }
  290. mock_spoolman_client.get_spools = AsyncMock(return_value=[mock_spool_linked, mock_spool_unlinked])
  291. response = await async_client.get("/api/v1/spoolman/spools/linked")
  292. assert response.status_code == 200
  293. data = response.json()
  294. assert len(data["linked"]) == 1 # Only linked spool
  295. @pytest.mark.asyncio
  296. @pytest.mark.integration
  297. async def test_get_linked_spools_empty_tag_excluded(
  298. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  299. ):
  300. """Verify spools with empty tag (JSON-encoded empty string) are excluded."""
  301. # Mock spool with empty JSON-encoded tag
  302. mock_spool = {
  303. "id": 1,
  304. "extra": {"tag": '""'}, # JSON-encoded empty string
  305. "filament": {"id": 1, "name": "PLA Red", "material": "PLA"},
  306. }
  307. mock_spoolman_client.get_spools = AsyncMock(return_value=[mock_spool])
  308. response = await async_client.get("/api/v1/spoolman/spools/linked")
  309. assert response.status_code == 200
  310. data = response.json()
  311. assert len(data["linked"]) == 0 # Empty tag should be excluded
  312. @pytest.mark.asyncio
  313. @pytest.mark.integration
  314. async def test_get_linked_spools_includes_weight_data(
  315. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  316. ):
  317. """Verify linked spools response includes remaining_weight and filament_weight."""
  318. mock_spool = {
  319. "id": 10,
  320. "remaining_weight": 500.5,
  321. "extra": {"tag": '"AABB11223344556677889900AABBCCDD"'},
  322. "filament": {"id": 1, "name": "PETG Blue", "material": "PETG", "weight": 750},
  323. }
  324. mock_spoolman_client.get_spools = AsyncMock(return_value=[mock_spool])
  325. response = await async_client.get("/api/v1/spoolman/spools/linked")
  326. assert response.status_code == 200
  327. data = response.json()
  328. info = data["linked"]["AABB11223344556677889900AABBCCDD"]
  329. assert info["id"] == 10
  330. assert info["remaining_weight"] == 500.5
  331. assert info["filament_weight"] == 750
  332. @pytest.mark.asyncio
  333. @pytest.mark.integration
  334. async def test_get_linked_spools_missing_weight_fields(
  335. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  336. ):
  337. """Verify linked spools handles missing weight data gracefully."""
  338. mock_spool = {
  339. "id": 5,
  340. "extra": {"tag": '"CCDD11223344556677889900AABBCCDD"'},
  341. "filament": {"id": 1, "name": "PLA Red", "material": "PLA"},
  342. }
  343. mock_spoolman_client.get_spools = AsyncMock(return_value=[mock_spool])
  344. response = await async_client.get("/api/v1/spoolman/spools/linked")
  345. assert response.status_code == 200
  346. data = response.json()
  347. info = data["linked"]["CCDD11223344556677889900AABBCCDD"]
  348. assert info["id"] == 5
  349. assert info["remaining_weight"] is None
  350. assert info["filament_weight"] is None
  351. @pytest.mark.asyncio
  352. @pytest.mark.integration
  353. async def test_get_linked_spools_null_filament(
  354. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  355. ):
  356. """Verify linked spools handles null filament object."""
  357. mock_spool = {
  358. "id": 7,
  359. "remaining_weight": 300,
  360. "extra": {"tag": '"EEFF11223344556677889900AABBCCDD"'},
  361. "filament": None,
  362. }
  363. mock_spoolman_client.get_spools = AsyncMock(return_value=[mock_spool])
  364. response = await async_client.get("/api/v1/spoolman/spools/linked")
  365. assert response.status_code == 200
  366. data = response.json()
  367. info = data["linked"]["EEFF11223344556677889900AABBCCDD"]
  368. assert info["id"] == 7
  369. assert info["remaining_weight"] == 300
  370. assert info["filament_weight"] is None
  371. # =========================================================================
  372. # Link Spool Tests
  373. # =========================================================================
  374. @pytest.mark.asyncio
  375. @pytest.mark.integration
  376. async def test_link_spool_not_enabled(self, async_client: AsyncClient):
  377. """Verify link spool fails when not enabled."""
  378. response = await async_client.post(
  379. "/api/v1/spoolman/spools/1/link",
  380. json={"tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"},
  381. )
  382. assert response.status_code == 400
  383. @pytest.mark.asyncio
  384. @pytest.mark.integration
  385. async def test_link_spool_invalid_uuid_length(
  386. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  387. ):
  388. """Verify link spool fails with invalid UUID length."""
  389. response = await async_client.post(
  390. "/api/v1/spoolman/spools/1/link",
  391. json={"tray_uuid": "ABC123"}, # Too short
  392. )
  393. assert response.status_code == 400
  394. assert "16 or 32 hex characters" in response.json()["detail"]
  395. @pytest.mark.asyncio
  396. @pytest.mark.integration
  397. async def test_link_spool_invalid_uuid_format(
  398. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  399. ):
  400. """Verify link spool fails with non-hex UUID."""
  401. response = await async_client.post(
  402. "/api/v1/spoolman/spools/1/link",
  403. json={"tray_uuid": "ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"}, # Not hex
  404. )
  405. assert response.status_code == 400
  406. assert "hex" in response.json()["detail"].lower()
  407. @pytest.mark.asyncio
  408. @pytest.mark.integration
  409. async def test_link_spool_success(self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client):
  410. """Verify successfully linking a spool — uses merge_spool_extra to preserve custom fields."""
  411. mock_spoolman_client.merge_spool_extra = AsyncMock(
  412. return_value={"id": 1, "extra": {"tag": '"A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"'}}
  413. )
  414. response = await async_client.post(
  415. "/api/v1/spoolman/spools/1/link",
  416. json={"tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"},
  417. )
  418. assert response.status_code == 200
  419. data = response.json()
  420. assert data["success"] is True
  421. assert "linked" in data["message"].lower()
  422. mock_spoolman_client.merge_spool_extra.assert_called_once_with(1, {"tag": '"A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"'})
  423. @pytest.mark.asyncio
  424. @pytest.mark.integration
  425. async def test_link_spool_with_printer_context_creates_slot_assignment(
  426. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client, printer_factory
  427. ):
  428. """link with printer_id+ams_id+tray_id upserts into local slot-assignment table."""
  429. mock_spoolman_client.merge_spool_extra = AsyncMock(
  430. return_value={"id": 5, "extra": {"tag": '"A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"'}}
  431. )
  432. printer = await printer_factory()
  433. response = await async_client.post(
  434. "/api/v1/spoolman/spools/5/link",
  435. json={
  436. "tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4",
  437. "printer_id": printer.id,
  438. "ams_id": 0,
  439. "tray_id": 1,
  440. },
  441. )
  442. assert response.status_code == 200
  443. # Verify the slot assignment row was written via the /all endpoint
  444. all_resp = await async_client.get(
  445. "/api/v1/spoolman/inventory/slot-assignments/all",
  446. params={"printer_id": printer.id},
  447. )
  448. assert all_resp.status_code == 200
  449. rows = all_resp.json()
  450. assert len(rows) == 1
  451. assert rows[0]["spoolman_spool_id"] == 5
  452. assert rows[0]["ams_id"] == 0
  453. assert rows[0]["tray_id"] == 1
  454. @pytest.mark.asyncio
  455. @pytest.mark.integration
  456. async def test_link_spool_without_printer_context_no_slot_assignment(
  457. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  458. ):
  459. """link without printer context calls merge_spool_extra and no slot assignment is created."""
  460. mock_spoolman_client.merge_spool_extra = AsyncMock(
  461. return_value={"id": 5, "extra": {"tag": '"A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"'}}
  462. )
  463. response = await async_client.post(
  464. "/api/v1/spoolman/spools/5/link",
  465. json={"tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"},
  466. )
  467. assert response.status_code == 200
  468. mock_spoolman_client.merge_spool_extra.assert_called_once_with(5, {"tag": '"A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"'})
  469. @pytest.mark.asyncio
  470. @pytest.mark.integration
  471. async def test_unlink_spool_success(self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client):
  472. """Unlink clears extra.tag via merge_spool_extra with json-encoded empty string.
  473. Spoolman PATCHes the extra dict by MERGING with the existing keys —
  474. popping a key from a Python dict copy and PATCHing the rest doesn't
  475. clear it. To actually clear we send the JSON-encoded empty string
  476. ('""'); read-side filters strip the wrapping quotes via .strip('"')
  477. so the spool drops out of get_linked_spools.
  478. """
  479. import json as _json
  480. mock_spoolman_client.merge_spool_extra = AsyncMock(
  481. return_value={"id": 1, "extra": {"tag": '""', "custom": "keep"}}
  482. )
  483. response = await async_client.post("/api/v1/spoolman/spools/1/unlink")
  484. assert response.status_code == 200
  485. data = response.json()
  486. assert data["success"] is True
  487. assert "unlinked" in data["message"].lower()
  488. mock_spoolman_client.merge_spool_extra.assert_called_once_with(1, {"tag": _json.dumps("")})
  489. @pytest.mark.asyncio
  490. @pytest.mark.integration
  491. async def test_unlink_spool_no_deadlock(self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client):
  492. """Regression: unlink must NOT acquire extra_lock around merge_spool_extra.
  493. merge_spool_extra acquires extra_lock(spool_id) internally, so wrapping
  494. the call in another `async with client.extra_lock(spool_id)` deadlocks
  495. — asyncio.Lock is non-reentrant. Pre-fix: every unlink request hung
  496. indefinitely; the SpoolBuddy kiosk's "Unassign" button looked
  497. unresponsive because the mutation isPending stayed true forever.
  498. This test verifies the request completes promptly by mocking
  499. merge_spool_extra to fail if the lock is already held by the caller —
  500. if the caller still wraps merge_spool_extra in `client.extra_lock(...)`,
  501. merge_spool_extra would block forever waiting for the lock.
  502. """
  503. # Real extra_lock dictionary so we can detect contention
  504. import asyncio as _asyncio
  505. real_lock = _asyncio.Lock()
  506. mock_spoolman_client.extra_lock = MagicMock(return_value=real_lock)
  507. async def fake_merge(spool_id, fields):
  508. # If the route still wraps this call in `async with extra_lock(...)`,
  509. # the lock will be held when this fires and we'll deadlock without
  510. # the timeout. The wait_for asserts we get the lock fast.
  511. await _asyncio.wait_for(real_lock.acquire(), timeout=2.0)
  512. try:
  513. return {"id": spool_id, "extra": {"tag": '""', **fields}}
  514. finally:
  515. real_lock.release()
  516. mock_spoolman_client.merge_spool_extra = AsyncMock(side_effect=fake_merge)
  517. # Cap the request at 5s to fail fast on a deadlock.
  518. response = await _asyncio.wait_for(
  519. async_client.post("/api/v1/spoolman/spools/1/unlink"),
  520. timeout=5.0,
  521. )
  522. assert response.status_code == 200
  523. mock_spoolman_client.merge_spool_extra.assert_called_once()
  524. @pytest.mark.asyncio
  525. @pytest.mark.integration
  526. async def test_unlink_spool_deletes_slot_assignment(
  527. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client, printer_factory
  528. ):
  529. """unlink removes the local slot assignment for the spool."""
  530. # link_spool calls merge_spool_extra; unlink_spool uses get_spool + update_spool_full.
  531. mock_spoolman_client.merge_spool_extra = AsyncMock(
  532. return_value={"id": 7, "extra": {"tag": '"A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"'}}
  533. )
  534. printer = await printer_factory()
  535. # First link to create the slot assignment
  536. await async_client.post(
  537. "/api/v1/spoolman/spools/7/link",
  538. json={
  539. "tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4",
  540. "printer_id": printer.id,
  541. "ams_id": 0,
  542. "tray_id": 0,
  543. },
  544. )
  545. # unlink_spool uses merge_spool_extra to clear the tag (Spoolman
  546. # PATCH merges, so the tag must be sent as json.dumps("") not popped).
  547. mock_spoolman_client.merge_spool_extra.reset_mock()
  548. mock_spoolman_client.merge_spool_extra = AsyncMock(return_value={"id": 7, "extra": {"tag": '""'}})
  549. response = await async_client.post("/api/v1/spoolman/spools/7/unlink")
  550. assert response.status_code == 200
  551. # Slot assignment must be gone
  552. all_resp = await async_client.get(
  553. "/api/v1/spoolman/inventory/slot-assignments/all",
  554. params={"printer_id": printer.id},
  555. )
  556. assert all_resp.status_code == 200
  557. assert all_resp.json() == []
  558. @pytest.mark.asyncio
  559. @pytest.mark.integration
  560. async def test_link_spool_spoolman_not_found(
  561. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  562. ):
  563. """link returns 404 when Spoolman reports the spool does not exist."""
  564. from backend.app.services.spoolman import SpoolmanNotFoundError
  565. mock_spoolman_client.merge_spool_extra = AsyncMock(side_effect=SpoolmanNotFoundError("not found"))
  566. response = await async_client.post(
  567. "/api/v1/spoolman/spools/99/link",
  568. json={"tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"},
  569. )
  570. assert response.status_code == 404
  571. @pytest.mark.asyncio
  572. @pytest.mark.integration
  573. async def test_link_spool_spoolman_unavailable(
  574. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  575. ):
  576. """link returns 503 when Spoolman is unreachable."""
  577. from backend.app.services.spoolman import SpoolmanUnavailableError
  578. mock_spoolman_client.merge_spool_extra = AsyncMock(side_effect=SpoolmanUnavailableError("down"))
  579. response = await async_client.post(
  580. "/api/v1/spoolman/spools/1/link",
  581. json={"tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"},
  582. )
  583. assert response.status_code == 503
  584. @pytest.mark.asyncio
  585. @pytest.mark.integration
  586. async def test_unlink_spool_spoolman_not_found(
  587. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  588. ):
  589. """unlink returns 404 when Spoolman reports the spool does not exist.
  590. The endpoint calls merge_spool_extra directly (no longer get_spool +
  591. update_spool_full), so the not-found surface lives there.
  592. """
  593. from backend.app.services.spoolman import SpoolmanNotFoundError
  594. mock_spoolman_client.merge_spool_extra = AsyncMock(side_effect=SpoolmanNotFoundError("not found"))
  595. response = await async_client.post("/api/v1/spoolman/spools/99/unlink")
  596. assert response.status_code == 404
  597. # =========================================================================
  598. # Sync Tests
  599. # =========================================================================
  600. @pytest.mark.asyncio
  601. @pytest.mark.integration
  602. async def test_sync_printer_not_enabled(self, async_client: AsyncClient, printer_factory):
  603. """Verify sync fails when Spoolman not enabled."""
  604. printer = await printer_factory()
  605. response = await async_client.post(f"/api/v1/spoolman/sync/{printer.id}")
  606. assert response.status_code == 400
  607. assert "not enabled" in response.json()["detail"].lower()
  608. @pytest.mark.asyncio
  609. @pytest.mark.integration
  610. async def test_sync_printer_not_found(self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client):
  611. """Verify sync fails for non-existent printer."""
  612. response = await async_client.post("/api/v1/spoolman/sync/9999")
  613. assert response.status_code == 404
  614. @pytest.mark.asyncio
  615. @pytest.mark.integration
  616. async def test_sync_returns_result_structure(
  617. self,
  618. async_client: AsyncClient,
  619. spoolman_settings,
  620. mock_spoolman_client,
  621. printer_factory,
  622. ):
  623. """Verify sync returns proper result structure."""
  624. printer = await printer_factory()
  625. # Mock printer manager to return AMS data
  626. with patch("backend.app.api.routes.spoolman.printer_manager") as pm_mock:
  627. mock_state = MagicMock()
  628. mock_state.raw_data = {"ams": [{"id": 0, "tray": []}]}
  629. pm_mock.get_status = MagicMock(return_value=mock_state)
  630. response = await async_client.post(f"/api/v1/spoolman/sync/{printer.id}")
  631. assert response.status_code == 200
  632. data = response.json()
  633. # Verify SyncResult structure
  634. assert "success" in data
  635. assert "synced_count" in data
  636. assert "skipped_count" in data
  637. assert "skipped" in data
  638. assert "errors" in data
  639. assert isinstance(data["skipped"], list)
  640. assert isinstance(data["errors"], list)
  641. @pytest.mark.asyncio
  642. @pytest.mark.integration
  643. async def test_sync_printer_not_connected(
  644. self,
  645. async_client: AsyncClient,
  646. spoolman_settings,
  647. mock_spoolman_client,
  648. printer_factory,
  649. ):
  650. """Verify sync fails when printer is not connected (no status)."""
  651. printer = await printer_factory()
  652. with patch("backend.app.api.routes.spoolman.printer_manager") as pm_mock:
  653. pm_mock.get_status = MagicMock(return_value=None)
  654. response = await async_client.post(f"/api/v1/spoolman/sync/{printer.id}")
  655. assert response.status_code == 404
  656. assert "not connected" in response.json()["detail"].lower()
  657. @pytest.mark.asyncio
  658. @pytest.mark.integration
  659. async def test_sync_writes_slot_assignment_to_db(
  660. self,
  661. async_client: AsyncClient,
  662. spoolman_settings,
  663. mock_spoolman_client,
  664. printer_factory,
  665. db_session,
  666. ):
  667. """sync persists a slot assignment row for each successfully synced spool."""
  668. from sqlalchemy import select
  669. from backend.app.models.spoolman_slot_assignment import SpoolmanSlotAssignment
  670. from backend.app.services.spoolman import AMSTray
  671. printer = await printer_factory()
  672. synced_spool = {"id": 42, "filament": {"material": "PLA"}, "remaining_weight": 500}
  673. fake_tray = AMSTray(
  674. ams_id=0,
  675. tray_id=2,
  676. tray_type="PLA",
  677. tray_sub_brands="PLA Basic",
  678. tray_color="FF0000FF",
  679. remain=80,
  680. tag_uid="",
  681. tray_uuid="A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4",
  682. tray_info_idx="",
  683. tray_weight=1000,
  684. )
  685. mock_spoolman_client.parse_ams_tray = MagicMock(return_value=fake_tray)
  686. mock_spoolman_client.sync_ams_tray = AsyncMock(return_value=synced_spool)
  687. with patch("backend.app.api.routes.spoolman.printer_manager") as pm_mock:
  688. mock_state = MagicMock()
  689. mock_state.raw_data = {"ams": [{"id": 0, "tray": [{"id": 2}]}]}
  690. pm_mock.get_status = MagicMock(return_value=mock_state)
  691. response = await async_client.post(f"/api/v1/spoolman/sync/{printer.id}")
  692. assert response.status_code == 200
  693. data = response.json()
  694. assert data["synced_count"] == 1
  695. # Verify slot assignment was written to the DB
  696. result = await db_session.execute(
  697. select(SpoolmanSlotAssignment).where(SpoolmanSlotAssignment.printer_id == printer.id)
  698. )
  699. rows = result.scalars().all()
  700. assert len(rows) == 1
  701. assert rows[0].ams_id == 0
  702. assert rows[0].tray_id == 2
  703. assert rows[0].spoolman_spool_id == 42
  704. @pytest.mark.asyncio
  705. @pytest.mark.integration
  706. async def test_sync_passes_slot_hint_when_no_rfid(
  707. self,
  708. async_client: AsyncClient,
  709. spoolman_settings,
  710. mock_spoolman_client,
  711. printer_factory,
  712. db_session,
  713. ):
  714. """sync passes the spoolman_spool_id_hint from the local slot-assignment table when no RFID tag is present."""
  715. from sqlalchemy import text
  716. from backend.app.services.spoolman import AMSTray
  717. printer = await printer_factory()
  718. # Pre-seed a slot assignment to serve as the hint
  719. await db_session.execute(
  720. text(
  721. "INSERT INTO spoolman_slot_assignments (printer_id, ams_id, tray_id, spoolman_spool_id)"
  722. " VALUES (:p, :a, :t, :s)"
  723. ),
  724. {"p": printer.id, "a": 0, "t": 1, "s": 55},
  725. )
  726. await db_session.commit()
  727. captured_hints: list = []
  728. async def capturing_sync(tray, printer_name, **kwargs):
  729. captured_hints.append(kwargs.get("spoolman_spool_id_hint"))
  730. return None
  731. fake_tray_no_rfid = AMSTray(
  732. ams_id=0,
  733. tray_id=1,
  734. tray_type="PLA",
  735. tray_sub_brands="Generic PLA",
  736. tray_color="FFFFFFFF",
  737. remain=-1,
  738. tag_uid="",
  739. tray_uuid="",
  740. tray_info_idx="",
  741. tray_weight=1000,
  742. )
  743. mock_spoolman_client.parse_ams_tray = MagicMock(return_value=fake_tray_no_rfid)
  744. mock_spoolman_client.sync_ams_tray = capturing_sync
  745. with patch("backend.app.api.routes.spoolman.printer_manager") as pm_mock:
  746. mock_state = MagicMock()
  747. mock_state.raw_data = {"ams": [{"id": 0, "tray": [{"id": 1}]}]}
  748. pm_mock.get_status = MagicMock(return_value=mock_state)
  749. response = await async_client.post(f"/api/v1/spoolman/sync/{printer.id}")
  750. assert response.status_code == 200
  751. assert len(captured_hints) == 1
  752. assert captured_hints[0] == 55
  753. @pytest.mark.asyncio
  754. @pytest.mark.integration
  755. async def test_sync_no_rfid_no_hint_produces_skipped_entry(
  756. self,
  757. async_client: AsyncClient,
  758. spoolman_settings,
  759. mock_spoolman_client,
  760. printer_factory,
  761. ):
  762. """sync reports a SkippedSpool for a tray with no RFID tag and no prior slot assignment."""
  763. from backend.app.services.spoolman import AMSTray
  764. printer = await printer_factory()
  765. fake_tray = AMSTray(
  766. ams_id=0,
  767. tray_id=3,
  768. tray_type="ABS",
  769. tray_sub_brands="Generic ABS",
  770. tray_color="333333FF",
  771. remain=60,
  772. tag_uid="",
  773. tray_uuid="",
  774. tray_info_idx="",
  775. tray_weight=1000,
  776. )
  777. mock_spoolman_client.parse_ams_tray = MagicMock(return_value=fake_tray)
  778. mock_spoolman_client.sync_ams_tray = AsyncMock(return_value=None)
  779. with patch("backend.app.api.routes.spoolman.printer_manager") as pm_mock:
  780. mock_state = MagicMock()
  781. mock_state.raw_data = {"ams": [{"id": 0, "tray": [{"id": 3}]}]}
  782. pm_mock.get_status = MagicMock(return_value=mock_state)
  783. response = await async_client.post(f"/api/v1/spoolman/sync/{printer.id}")
  784. assert response.status_code == 200
  785. data = response.json()
  786. assert data["synced_count"] == 0
  787. assert data["skipped_count"] == 1
  788. assert len(data["skipped"]) == 1
  789. skipped = data["skipped"][0]
  790. assert "No RFID" in skipped["reason"]
  791. assert skipped["filament_type"] == "ABS"
  792. # =========================================================================
  793. # Filaments Endpoint Tests
  794. # =========================================================================
  795. @pytest.mark.asyncio
  796. @pytest.mark.integration
  797. async def test_get_filaments_not_enabled(self, async_client: AsyncClient):
  798. """Verify get filaments fails when not enabled."""
  799. response = await async_client.get("/api/v1/spoolman/filaments")
  800. assert response.status_code == 400
  801. assert "not enabled" in response.json()["detail"].lower()
  802. @pytest.mark.asyncio
  803. @pytest.mark.integration
  804. async def test_get_filaments_success(self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client):
  805. """Verify get filaments returns data in expected format."""
  806. mock_filament = {
  807. "id": 1,
  808. "name": "PLA Basic",
  809. "material": "PLA",
  810. "color_hex": "FF0000",
  811. "vendor_id": 1,
  812. "weight": 1000,
  813. }
  814. mock_spoolman_client.get_filaments = AsyncMock(return_value=[mock_filament])
  815. response = await async_client.get("/api/v1/spoolman/filaments")
  816. assert response.status_code == 200
  817. data = response.json()
  818. assert "filaments" in data
  819. assert isinstance(data["filaments"], list)
  820. assert len(data["filaments"]) == 1
  821. assert data["filaments"][0]["name"] == "PLA Basic"
  822. # =========================================================================
  823. # Disable Weight Sync Tests
  824. # =========================================================================
  825. @pytest.fixture
  826. async def spoolman_settings_weight_sync_disabled(self, db_session):
  827. """Create Spoolman settings with weight sync disabled."""
  828. from backend.app.models.settings import Settings
  829. enabled_setting = Settings(key="spoolman_enabled", value="true")
  830. url_setting = Settings(key="spoolman_url", value="http://localhost:7912")
  831. disable_weight_setting = Settings(key="spoolman_disable_weight_sync", value="true")
  832. partial_usage_setting = Settings(key="spoolman_report_partial_usage", value="true")
  833. db_session.add(enabled_setting)
  834. db_session.add(url_setting)
  835. db_session.add(disable_weight_setting)
  836. db_session.add(partial_usage_setting)
  837. await db_session.commit()
  838. return {
  839. "enabled": enabled_setting,
  840. "url": url_setting,
  841. "disable_weight": disable_weight_setting,
  842. "partial_usage": partial_usage_setting,
  843. }
  844. @pytest.mark.asyncio
  845. @pytest.mark.integration
  846. async def test_settings_returns_disable_weight_sync(
  847. self, async_client: AsyncClient, spoolman_settings_weight_sync_disabled
  848. ):
  849. """Verify settings endpoint returns the disable_weight_sync setting."""
  850. response = await async_client.get("/api/v1/settings/spoolman")
  851. assert response.status_code == 200
  852. data = response.json()
  853. assert "spoolman_disable_weight_sync" in data
  854. assert data["spoolman_disable_weight_sync"] == "true"
  855. @pytest.mark.asyncio
  856. @pytest.mark.integration
  857. async def test_settings_update_disable_weight_sync(self, async_client: AsyncClient, spoolman_settings):
  858. """Verify settings endpoint can update the disable_weight_sync setting."""
  859. # First verify it's false by default
  860. response = await async_client.get("/api/v1/settings/spoolman")
  861. assert response.status_code == 200
  862. data = response.json()
  863. assert data.get("spoolman_disable_weight_sync", "false") == "false"
  864. # Update the setting
  865. response = await async_client.put(
  866. "/api/v1/settings/spoolman",
  867. json={"spoolman_disable_weight_sync": "true"},
  868. )
  869. assert response.status_code == 200
  870. data = response.json()
  871. assert data["spoolman_disable_weight_sync"] == "true"
  872. # Verify it persisted
  873. response = await async_client.get("/api/v1/settings/spoolman")
  874. assert response.status_code == 200
  875. data = response.json()
  876. assert data["spoolman_disable_weight_sync"] == "true"
  877. @pytest.mark.asyncio
  878. @pytest.mark.integration
  879. async def test_sync_with_weight_sync_disabled_passes_flag(
  880. self,
  881. async_client: AsyncClient,
  882. spoolman_settings_weight_sync_disabled,
  883. mock_spoolman_client,
  884. printer_factory,
  885. ):
  886. """Verify sync passes disable_weight_sync=True to sync_ams_tray when the setting is on."""
  887. printer = await printer_factory()
  888. # Mock existing spool
  889. mock_existing_spool = {
  890. "id": 42,
  891. "remaining_weight": 800,
  892. "extra": {"tag": '"A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"'},
  893. "filament": {"id": 1, "name": "PLA Red", "material": "PLA"},
  894. }
  895. mock_spoolman_client.find_spool_by_tag = AsyncMock(return_value=mock_existing_spool)
  896. mock_spoolman_client.parse_ams_tray = MagicMock()
  897. # Create mock AMSTray
  898. from backend.app.services.spoolman import AMSTray
  899. mock_tray = AMSTray(
  900. ams_id=0,
  901. tray_id=0,
  902. tray_type="PLA",
  903. tray_sub_brands="PLA Basic",
  904. tray_color="FF0000FF",
  905. remain=50,
  906. tag_uid="",
  907. tray_uuid="A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4",
  908. tray_info_idx="GFA00",
  909. tray_weight=1000,
  910. )
  911. mock_spoolman_client.parse_ams_tray.return_value = mock_tray
  912. mock_spoolman_client.convert_ams_slot_to_location = MagicMock(return_value="AMS A1")
  913. mock_spoolman_client.sync_ams_tray = AsyncMock(return_value={"id": 42})
  914. mock_spoolman_client.clear_location_for_removed_spools = AsyncMock(return_value=0)
  915. with patch("backend.app.api.routes.spoolman.printer_manager") as pm_mock:
  916. mock_state = MagicMock()
  917. mock_state.raw_data = {
  918. "ams": [
  919. {
  920. "id": 0,
  921. "tray": [
  922. {
  923. "id": 0,
  924. "tray_type": "PLA",
  925. "tray_sub_brands": "PLA Basic",
  926. "tray_color": "FF0000FF",
  927. "remain": 50,
  928. "tag_uid": "",
  929. "tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4",
  930. "tray_info_idx": "GFA00",
  931. "tray_weight": 1000,
  932. }
  933. ],
  934. }
  935. ]
  936. }
  937. pm_mock.get_status = MagicMock(return_value=mock_state)
  938. response = await async_client.post(f"/api/v1/spoolman/sync/{printer.id}")
  939. assert response.status_code == 200
  940. # Verify sync_ams_tray was called with disable_weight_sync=True
  941. mock_spoolman_client.sync_ams_tray.assert_called()
  942. call_kwargs = mock_spoolman_client.sync_ams_tray.call_args.kwargs
  943. assert call_kwargs.get("disable_weight_sync") is True
  944. # =========================================================================
  945. # Report Partial Usage Tests
  946. # =========================================================================
  947. @pytest.fixture
  948. async def spoolman_settings_partial_usage_disabled(self, db_session):
  949. """Create Spoolman settings with partial usage reporting disabled."""
  950. from backend.app.models.settings import Settings
  951. enabled_setting = Settings(key="spoolman_enabled", value="true")
  952. url_setting = Settings(key="spoolman_url", value="http://localhost:7912")
  953. partial_usage_setting = Settings(key="spoolman_report_partial_usage", value="false")
  954. db_session.add(enabled_setting)
  955. db_session.add(url_setting)
  956. db_session.add(partial_usage_setting)
  957. await db_session.commit()
  958. return {
  959. "enabled": enabled_setting,
  960. "url": url_setting,
  961. "partial_usage": partial_usage_setting,
  962. }
  963. @pytest.mark.asyncio
  964. @pytest.mark.integration
  965. async def test_settings_returns_report_partial_usage(
  966. self, async_client: AsyncClient, spoolman_settings_partial_usage_disabled
  967. ):
  968. """Verify settings endpoint returns the report_partial_usage setting."""
  969. response = await async_client.get("/api/v1/settings/spoolman")
  970. assert response.status_code == 200
  971. data = response.json()
  972. assert "spoolman_report_partial_usage" in data
  973. assert data["spoolman_report_partial_usage"] == "false"
  974. @pytest.mark.asyncio
  975. @pytest.mark.integration
  976. async def test_settings_update_report_partial_usage(self, async_client: AsyncClient, spoolman_settings):
  977. """Verify settings endpoint can update the report_partial_usage setting."""
  978. # First verify it's true by default
  979. response = await async_client.get("/api/v1/settings/spoolman")
  980. assert response.status_code == 200
  981. data = response.json()
  982. assert data.get("spoolman_report_partial_usage", "true") == "true"
  983. # Update the setting to false
  984. response = await async_client.put(
  985. "/api/v1/settings/spoolman",
  986. json={"spoolman_report_partial_usage": "false"},
  987. )
  988. assert response.status_code == 200
  989. data = response.json()
  990. assert data["spoolman_report_partial_usage"] == "false"
  991. # Verify it persisted
  992. response = await async_client.get("/api/v1/settings/spoolman")
  993. assert response.status_code == 200
  994. data = response.json()
  995. assert data["spoolman_report_partial_usage"] == "false"
  996. @pytest.mark.asyncio
  997. @pytest.mark.integration
  998. async def test_settings_report_partial_usage_defaults_to_true(self, async_client: AsyncClient, spoolman_settings):
  999. """Verify report_partial_usage defaults to true (unlike disable_weight_sync which defaults to false)."""
  1000. response = await async_client.get("/api/v1/settings/spoolman")
  1001. assert response.status_code == 200
  1002. data = response.json()
  1003. # Should default to "true"
  1004. assert data["spoolman_report_partial_usage"] == "true"
  1005. class TestLinkSpoolMqttConfigure:
  1006. """P9-TEST-BE (Bug #8): link_spool sends MQTT configure when printer context is provided."""
  1007. @pytest.fixture
  1008. async def spoolman_settings(self, db_session):
  1009. from backend.app.models.settings import Settings
  1010. db_session.add(Settings(key="spoolman_enabled", value="true"))
  1011. db_session.add(Settings(key="spoolman_url", value="http://localhost:7912"))
  1012. await db_session.commit()
  1013. @pytest.fixture
  1014. def mock_spoolman_client(self):
  1015. mock_client = MagicMock()
  1016. mock_client.is_connected = True
  1017. mock_client.base_url = "http://localhost:7912"
  1018. mock_client.health_check = AsyncMock(return_value=True)
  1019. mock_client.ensure_tag_extra_field = AsyncMock(return_value=True)
  1020. mock_client.merge_spool_extra = AsyncMock(
  1021. return_value={"id": 5, "extra": {"tag": '"A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"'}}
  1022. )
  1023. # #1457 stale-tag cleanup enumerates spools; default to empty so it's a no-op.
  1024. mock_client.get_spools = AsyncMock(return_value=[])
  1025. mock_client.get_spool = AsyncMock(
  1026. return_value={
  1027. "id": 5,
  1028. "remaining_weight": 800.0,
  1029. "used_weight": 200.0,
  1030. "spool_weight": None,
  1031. "filament": {
  1032. "id": 1,
  1033. "name": "PLA Basic",
  1034. "material": "PLA",
  1035. "color_hex": "FF0000",
  1036. "color_name": "Red",
  1037. "vendor": {"id": 1, "name": "Bambu Lab"},
  1038. "weight": 1000,
  1039. "spool_weight": 250,
  1040. },
  1041. "extra": {},
  1042. "location": None,
  1043. "comment": None,
  1044. "archived": False,
  1045. }
  1046. )
  1047. mock_client.close = AsyncMock()
  1048. mock_client.extra_lock = MagicMock()
  1049. mock_client.extra_lock.return_value.__aenter__ = AsyncMock(return_value=None)
  1050. mock_client.extra_lock.return_value.__aexit__ = AsyncMock(return_value=False)
  1051. with (
  1052. patch(
  1053. "backend.app.api.routes.spoolman.get_spoolman_client",
  1054. AsyncMock(return_value=mock_client),
  1055. ),
  1056. patch(
  1057. "backend.app.api.routes.spoolman.init_spoolman_client",
  1058. AsyncMock(return_value=mock_client),
  1059. ),
  1060. patch(
  1061. "backend.app.api.routes.spoolman.close_spoolman_client",
  1062. AsyncMock(),
  1063. ),
  1064. ):
  1065. yield mock_client
  1066. @pytest.fixture
  1067. def printer_factory(self, db_session):
  1068. _counter = [0]
  1069. async def _create(**kwargs):
  1070. from backend.app.models.printer import Printer
  1071. _counter[0] += 1
  1072. defaults = {
  1073. "name": f"Test Printer {_counter[0]}",
  1074. "serial_number": f"MQTTTEST{_counter[0]:06d}",
  1075. "ip_address": f"192.168.100.{_counter[0]}",
  1076. "access_code": "12345678",
  1077. "is_active": True,
  1078. "auto_archive": True,
  1079. "model": "X1C",
  1080. }
  1081. defaults.update(kwargs)
  1082. p = Printer(**defaults)
  1083. db_session.add(p)
  1084. await db_session.commit()
  1085. await db_session.refresh(p)
  1086. return p
  1087. return _create
  1088. @pytest.mark.asyncio
  1089. @pytest.mark.integration
  1090. async def test_link_spool_sends_ams_set_filament_with_printer_context(
  1091. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client, printer_factory
  1092. ):
  1093. """link_spool with printer context calls ams_set_filament_setting via MQTT."""
  1094. printer = await printer_factory()
  1095. mqtt_mock = MagicMock()
  1096. mqtt_mock.printer_state = MagicMock(
  1097. nozzles=[MagicMock(nozzle_diameter="0.4")],
  1098. ams_extruder_map={"0": 0},
  1099. raw_data={"ams": [{"id": 0, "tray": [{"id": 1, "cali_idx": None}]}]},
  1100. )
  1101. with patch("backend.app.api.routes.spoolman.printer_manager") as mock_pm:
  1102. mock_pm.get_client.return_value = mqtt_mock
  1103. response = await async_client.post(
  1104. "/api/v1/spoolman/spools/5/link",
  1105. json={
  1106. "tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4",
  1107. "printer_id": printer.id,
  1108. "ams_id": 0,
  1109. "tray_id": 1,
  1110. },
  1111. )
  1112. assert response.status_code == 200
  1113. assert response.json()["success"] is True
  1114. mqtt_mock.ams_set_filament_setting.assert_called_once()
  1115. call_kwargs = mqtt_mock.ams_set_filament_setting.call_args.kwargs
  1116. assert call_kwargs["ams_id"] == 0
  1117. assert call_kwargs["tray_id"] == 1
  1118. @pytest.mark.asyncio
  1119. @pytest.mark.integration
  1120. async def test_link_spool_no_printer_context_no_mqtt(
  1121. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  1122. ):
  1123. """link_spool without printer context does not attempt MQTT configure."""
  1124. mqtt_mock = MagicMock()
  1125. with patch("backend.app.api.routes.spoolman.printer_manager") as mock_pm:
  1126. mock_pm.get_client.return_value = mqtt_mock
  1127. response = await async_client.post(
  1128. "/api/v1/spoolman/spools/5/link",
  1129. json={"tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"},
  1130. )
  1131. assert response.status_code == 200
  1132. mock_pm.get_client.assert_not_called()
  1133. mqtt_mock.ams_set_filament_setting.assert_not_called()
  1134. @pytest.mark.asyncio
  1135. @pytest.mark.integration
  1136. async def test_link_spool_mqtt_failure_does_not_prevent_link(
  1137. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client, printer_factory
  1138. ):
  1139. """MQTT failure is best-effort: link still succeeds if ams_set_filament_setting throws."""
  1140. printer = await printer_factory()
  1141. mqtt_mock = MagicMock()
  1142. mqtt_mock.printer_state = MagicMock(
  1143. nozzles=[MagicMock(nozzle_diameter="0.4")],
  1144. ams_extruder_map={"0": 0},
  1145. raw_data={"ams": []},
  1146. )
  1147. mqtt_mock.ams_set_filament_setting.side_effect = RuntimeError("MQTT connection lost")
  1148. with patch("backend.app.api.routes.spoolman.printer_manager") as mock_pm:
  1149. mock_pm.get_client.return_value = mqtt_mock
  1150. response = await async_client.post(
  1151. "/api/v1/spoolman/spools/5/link",
  1152. json={
  1153. "tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4",
  1154. "printer_id": printer.id,
  1155. "ams_id": 0,
  1156. "tray_id": 0,
  1157. },
  1158. )
  1159. assert response.status_code == 200
  1160. data = response.json()
  1161. assert data["success"] is True
  1162. assert "linked" in data["message"].lower()
  1163. @pytest.mark.asyncio
  1164. @pytest.mark.integration
  1165. async def test_link_spool_realigns_filament_context_to_printer_kp(
  1166. self,
  1167. async_client: AsyncClient,
  1168. spoolman_settings,
  1169. mock_spoolman_client,
  1170. printer_factory,
  1171. db_session,
  1172. ):
  1173. """link_spool MQTT auto-configure realigns tray_info_idx + setting_id
  1174. to the printer-side kp's filament context — same fix as assign path.
  1175. Pre-fix link_spool used `mqtt_client.printer_state` (a non-existent
  1176. attribute that always evaluated to None), so state.kprofiles /
  1177. nozzles / ams_extruder_map were all skipped — every link sent
  1178. generic-PLA tray_info_idx with empty setting_id, and the cali_idx
  1179. in the printer's table couldn't be linked. (#1114)
  1180. """
  1181. from backend.app.models.spoolman_k_profile import SpoolmanKProfile
  1182. printer = await printer_factory()
  1183. kp = SpoolmanKProfile(
  1184. spoolman_spool_id=5,
  1185. printer_id=printer.id,
  1186. extruder=0,
  1187. nozzle_diameter="0.4",
  1188. k_value=0.025,
  1189. cali_idx=8948,
  1190. setting_id="PFUSedbf16b803ff3e",
  1191. )
  1192. db_session.add(kp)
  1193. await db_session.commit()
  1194. printer_kp = MagicMock(
  1195. slot_id=8948,
  1196. nozzle_diameter="0.4",
  1197. filament_id="P4d64437",
  1198. setting_id="PFUSedbf16b803ff3e",
  1199. )
  1200. printer_state = MagicMock(
  1201. nozzles=[MagicMock(nozzle_diameter="0.4")],
  1202. ams_extruder_map={"0": 0},
  1203. raw_data={"ams": [{"id": 0, "tray": [{"id": 1, "cali_idx": None}]}]},
  1204. kprofiles=[printer_kp],
  1205. )
  1206. mqtt_mock = MagicMock()
  1207. mqtt_mock.ams_set_filament_setting = MagicMock()
  1208. mqtt_mock.extrusion_cali_sel = MagicMock()
  1209. # Production never had this attribute; pre-fix code read it and got
  1210. # None, defeating the cascade. The new code uses get_status instead.
  1211. mqtt_mock.printer_state = None
  1212. with patch("backend.app.api.routes.spoolman.printer_manager") as mock_pm:
  1213. mock_pm.get_client.return_value = mqtt_mock
  1214. mock_pm.get_status.return_value = printer_state
  1215. response = await async_client.post(
  1216. "/api/v1/spoolman/spools/5/link",
  1217. json={
  1218. "tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4",
  1219. "printer_id": printer.id,
  1220. "ams_id": 0,
  1221. "tray_id": 1,
  1222. },
  1223. )
  1224. assert response.status_code == 200
  1225. amf_kwargs = mqtt_mock.ams_set_filament_setting.call_args.kwargs
  1226. assert amf_kwargs["tray_info_idx"] == "P4d64437"
  1227. assert amf_kwargs["setting_id"] == "PFUSedbf16b803ff3e"
  1228. cs_kwargs = mqtt_mock.extrusion_cali_sel.call_args.kwargs
  1229. assert cs_kwargs["cali_idx"] == 8948
  1230. assert cs_kwargs["filament_id"] == "P4d64437"
  1231. @pytest.mark.asyncio
  1232. @pytest.mark.integration
  1233. async def test_link_spool_uses_printer_manager_not_mqtt_client_state(
  1234. self,
  1235. async_client: AsyncClient,
  1236. spoolman_settings,
  1237. mock_spoolman_client,
  1238. printer_factory,
  1239. db_session,
  1240. ):
  1241. """Regression: state comes from printer_manager.get_status, not
  1242. mqtt_client.printer_state (which didn't exist on the real client)."""
  1243. from backend.app.models.spoolman_k_profile import SpoolmanKProfile
  1244. printer = await printer_factory()
  1245. kp = SpoolmanKProfile(
  1246. spoolman_spool_id=5,
  1247. printer_id=printer.id,
  1248. extruder=0,
  1249. nozzle_diameter="0.4",
  1250. k_value=0.025,
  1251. cali_idx=42,
  1252. setting_id="GFSL05",
  1253. )
  1254. db_session.add(kp)
  1255. await db_session.commit()
  1256. printer_state = MagicMock(
  1257. nozzles=[MagicMock(nozzle_diameter="0.4")],
  1258. ams_extruder_map={"0": 0},
  1259. raw_data=None,
  1260. kprofiles=[],
  1261. )
  1262. mqtt_mock = MagicMock()
  1263. mqtt_mock.ams_set_filament_setting = MagicMock()
  1264. mqtt_mock.extrusion_cali_sel = MagicMock()
  1265. # Production didn't have mqtt_client.printer_state — drop the spec
  1266. # so an accidental read raises AttributeError instead of silently
  1267. # returning a MagicMock.
  1268. del mqtt_mock.printer_state
  1269. with patch("backend.app.api.routes.spoolman.printer_manager") as mock_pm:
  1270. mock_pm.get_client.return_value = mqtt_mock
  1271. mock_pm.get_status.return_value = printer_state
  1272. response = await async_client.post(
  1273. "/api/v1/spoolman/spools/5/link",
  1274. json={
  1275. "tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4",
  1276. "printer_id": printer.id,
  1277. "ams_id": 0,
  1278. "tray_id": 2,
  1279. },
  1280. )
  1281. assert response.status_code == 200
  1282. # cali_sel must fire with cali_idx=42 — proves get_status was used
  1283. mqtt_mock.extrusion_cali_sel.assert_called_once()
  1284. assert mqtt_mock.extrusion_cali_sel.call_args.kwargs["cali_idx"] == 42