test_spoolman_api.py 59 KB

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