test_spoolman_api.py 60 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472
  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. # A link onto a slot checks the spool is not archived first.
  436. mock_spoolman_client.get_spool = AsyncMock(return_value={"id": 5, "archived": False, "extra": {}})
  437. printer = await printer_factory()
  438. response = await async_client.post(
  439. "/api/v1/spoolman/spools/5/link",
  440. json={
  441. "tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4",
  442. "printer_id": printer.id,
  443. "ams_id": 0,
  444. "tray_id": 1,
  445. },
  446. )
  447. assert response.status_code == 200
  448. # Verify the slot assignment row was written via the /all endpoint
  449. all_resp = await async_client.get(
  450. "/api/v1/spoolman/inventory/slot-assignments/all",
  451. params={"printer_id": printer.id},
  452. )
  453. assert all_resp.status_code == 200
  454. rows = all_resp.json()
  455. assert len(rows) == 1
  456. assert rows[0]["spoolman_spool_id"] == 5
  457. assert rows[0]["ams_id"] == 0
  458. assert rows[0]["tray_id"] == 1
  459. @pytest.mark.asyncio
  460. @pytest.mark.integration
  461. async def test_link_spool_without_printer_context_no_slot_assignment(
  462. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  463. ):
  464. """link without printer context calls merge_spool_extra and no slot assignment is created."""
  465. mock_spoolman_client.merge_spool_extra = AsyncMock(
  466. return_value={"id": 5, "extra": {"tag": '"A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"'}}
  467. )
  468. response = await async_client.post(
  469. "/api/v1/spoolman/spools/5/link",
  470. json={"tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"},
  471. )
  472. assert response.status_code == 200
  473. mock_spoolman_client.merge_spool_extra.assert_called_once_with(5, {"tag": '"A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"'})
  474. @pytest.mark.asyncio
  475. @pytest.mark.integration
  476. async def test_unlink_spool_success(self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client):
  477. """Unlink clears extra.tag via merge_spool_extra with json-encoded empty string.
  478. Spoolman PATCHes the extra dict by MERGING with the existing keys —
  479. popping a key from a Python dict copy and PATCHing the rest doesn't
  480. clear it. To actually clear we send the JSON-encoded empty string
  481. ('""'); read-side filters strip the wrapping quotes via .strip('"')
  482. so the spool drops out of get_linked_spools.
  483. """
  484. import json as _json
  485. mock_spoolman_client.merge_spool_extra = AsyncMock(
  486. return_value={"id": 1, "extra": {"tag": '""', "custom": "keep"}}
  487. )
  488. response = await async_client.post("/api/v1/spoolman/spools/1/unlink")
  489. assert response.status_code == 200
  490. data = response.json()
  491. assert data["success"] is True
  492. assert "unlinked" in data["message"].lower()
  493. mock_spoolman_client.merge_spool_extra.assert_called_once_with(1, {"tag": _json.dumps("")})
  494. @pytest.mark.asyncio
  495. @pytest.mark.integration
  496. async def test_unlink_spool_no_deadlock(self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client):
  497. """Regression: unlink must NOT acquire extra_lock around merge_spool_extra.
  498. merge_spool_extra acquires extra_lock(spool_id) internally, so wrapping
  499. the call in another `async with client.extra_lock(spool_id)` deadlocks
  500. — asyncio.Lock is non-reentrant. Pre-fix: every unlink request hung
  501. indefinitely; the SpoolBuddy kiosk's "Unassign" button looked
  502. unresponsive because the mutation isPending stayed true forever.
  503. This test verifies the request completes promptly by mocking
  504. merge_spool_extra to fail if the lock is already held by the caller —
  505. if the caller still wraps merge_spool_extra in `client.extra_lock(...)`,
  506. merge_spool_extra would block forever waiting for the lock.
  507. """
  508. # Real extra_lock dictionary so we can detect contention
  509. import asyncio as _asyncio
  510. real_lock = _asyncio.Lock()
  511. mock_spoolman_client.extra_lock = MagicMock(return_value=real_lock)
  512. async def fake_merge(spool_id, fields):
  513. # If the route still wraps this call in `async with extra_lock(...)`,
  514. # the lock will be held when this fires and we'll deadlock without
  515. # the timeout. The wait_for asserts we get the lock fast.
  516. await _asyncio.wait_for(real_lock.acquire(), timeout=2.0)
  517. try:
  518. return {"id": spool_id, "extra": {"tag": '""', **fields}}
  519. finally:
  520. real_lock.release()
  521. mock_spoolman_client.merge_spool_extra = AsyncMock(side_effect=fake_merge)
  522. # Cap the request at 5s to fail fast on a deadlock.
  523. response = await _asyncio.wait_for(
  524. async_client.post("/api/v1/spoolman/spools/1/unlink"),
  525. timeout=5.0,
  526. )
  527. assert response.status_code == 200
  528. mock_spoolman_client.merge_spool_extra.assert_called_once()
  529. @pytest.mark.asyncio
  530. @pytest.mark.integration
  531. async def test_unlink_spool_deletes_slot_assignment(
  532. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client, printer_factory
  533. ):
  534. """unlink removes the local slot assignment for the spool."""
  535. # link_spool calls merge_spool_extra; unlink_spool uses get_spool + update_spool_full.
  536. mock_spoolman_client.merge_spool_extra = AsyncMock(
  537. return_value={"id": 7, "extra": {"tag": '"A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"'}}
  538. )
  539. # A link onto a slot checks the spool is not archived first.
  540. mock_spoolman_client.get_spool = AsyncMock(return_value={"id": 7, "archived": False, "extra": {}})
  541. printer = await printer_factory()
  542. # First link to create the slot assignment
  543. await async_client.post(
  544. "/api/v1/spoolman/spools/7/link",
  545. json={
  546. "tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4",
  547. "printer_id": printer.id,
  548. "ams_id": 0,
  549. "tray_id": 0,
  550. },
  551. )
  552. # unlink_spool uses merge_spool_extra to clear the tag (Spoolman
  553. # PATCH merges, so the tag must be sent as json.dumps("") not popped).
  554. mock_spoolman_client.merge_spool_extra.reset_mock()
  555. mock_spoolman_client.merge_spool_extra = AsyncMock(return_value={"id": 7, "extra": {"tag": '""'}})
  556. response = await async_client.post("/api/v1/spoolman/spools/7/unlink")
  557. assert response.status_code == 200
  558. # Slot assignment must be gone
  559. all_resp = await async_client.get(
  560. "/api/v1/spoolman/inventory/slot-assignments/all",
  561. params={"printer_id": printer.id},
  562. )
  563. assert all_resp.status_code == 200
  564. assert all_resp.json() == []
  565. @pytest.mark.asyncio
  566. @pytest.mark.integration
  567. async def test_link_spool_spoolman_not_found(
  568. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  569. ):
  570. """link returns 404 when Spoolman reports the spool does not exist."""
  571. from backend.app.services.spoolman import SpoolmanNotFoundError
  572. mock_spoolman_client.merge_spool_extra = AsyncMock(side_effect=SpoolmanNotFoundError("not found"))
  573. response = await async_client.post(
  574. "/api/v1/spoolman/spools/99/link",
  575. json={"tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"},
  576. )
  577. assert response.status_code == 404
  578. @pytest.mark.asyncio
  579. @pytest.mark.integration
  580. async def test_link_spool_spoolman_unavailable(
  581. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  582. ):
  583. """link returns 503 when Spoolman is unreachable."""
  584. from backend.app.services.spoolman import SpoolmanUnavailableError
  585. mock_spoolman_client.merge_spool_extra = AsyncMock(side_effect=SpoolmanUnavailableError("down"))
  586. response = await async_client.post(
  587. "/api/v1/spoolman/spools/1/link",
  588. json={"tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"},
  589. )
  590. assert response.status_code == 503
  591. @pytest.mark.asyncio
  592. @pytest.mark.integration
  593. async def test_unlink_spool_spoolman_not_found(
  594. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  595. ):
  596. """unlink returns 404 when Spoolman reports the spool does not exist.
  597. The endpoint calls merge_spool_extra directly (no longer get_spool +
  598. update_spool_full), so the not-found surface lives there.
  599. """
  600. from backend.app.services.spoolman import SpoolmanNotFoundError
  601. mock_spoolman_client.merge_spool_extra = AsyncMock(side_effect=SpoolmanNotFoundError("not found"))
  602. response = await async_client.post("/api/v1/spoolman/spools/99/unlink")
  603. assert response.status_code == 404
  604. # =========================================================================
  605. # Sync Tests
  606. # =========================================================================
  607. @pytest.mark.asyncio
  608. @pytest.mark.integration
  609. async def test_sync_printer_not_enabled(self, async_client: AsyncClient, printer_factory):
  610. """Verify sync fails when Spoolman not enabled."""
  611. printer = await printer_factory()
  612. response = await async_client.post(f"/api/v1/spoolman/sync/{printer.id}")
  613. assert response.status_code == 400
  614. assert "not enabled" in response.json()["detail"].lower()
  615. @pytest.mark.asyncio
  616. @pytest.mark.integration
  617. async def test_sync_printer_not_found(self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client):
  618. """Verify sync fails for non-existent printer."""
  619. response = await async_client.post("/api/v1/spoolman/sync/9999")
  620. assert response.status_code == 404
  621. @pytest.mark.asyncio
  622. @pytest.mark.integration
  623. async def test_sync_returns_result_structure(
  624. self,
  625. async_client: AsyncClient,
  626. spoolman_settings,
  627. mock_spoolman_client,
  628. printer_factory,
  629. ):
  630. """Verify sync returns proper result structure."""
  631. printer = await printer_factory()
  632. # Mock printer manager to return AMS data
  633. with patch("backend.app.api.routes.spoolman.printer_manager") as pm_mock:
  634. mock_state = MagicMock()
  635. mock_state.raw_data = {"ams": [{"id": 0, "tray": []}]}
  636. pm_mock.get_status = MagicMock(return_value=mock_state)
  637. response = await async_client.post(f"/api/v1/spoolman/sync/{printer.id}")
  638. assert response.status_code == 200
  639. data = response.json()
  640. # Verify SyncResult structure
  641. assert "success" in data
  642. assert "synced_count" in data
  643. assert "skipped_count" in data
  644. assert "skipped" in data
  645. assert "errors" in data
  646. assert isinstance(data["skipped"], list)
  647. assert isinstance(data["errors"], list)
  648. @pytest.mark.asyncio
  649. @pytest.mark.integration
  650. async def test_sync_printer_not_connected(
  651. self,
  652. async_client: AsyncClient,
  653. spoolman_settings,
  654. mock_spoolman_client,
  655. printer_factory,
  656. ):
  657. """Verify sync fails when printer is not connected (no status)."""
  658. printer = await printer_factory()
  659. with patch("backend.app.api.routes.spoolman.printer_manager") as pm_mock:
  660. pm_mock.get_status = MagicMock(return_value=None)
  661. response = await async_client.post(f"/api/v1/spoolman/sync/{printer.id}")
  662. assert response.status_code == 404
  663. assert "not connected" in response.json()["detail"].lower()
  664. @pytest.mark.asyncio
  665. @pytest.mark.integration
  666. async def test_sync_writes_slot_assignment_to_db(
  667. self,
  668. async_client: AsyncClient,
  669. spoolman_settings,
  670. mock_spoolman_client,
  671. printer_factory,
  672. db_session,
  673. ):
  674. """sync persists a slot assignment row for each successfully synced spool."""
  675. from sqlalchemy import select
  676. from backend.app.models.spoolman_slot_assignment import SpoolmanSlotAssignment
  677. from backend.app.services.spoolman import AMSTray
  678. printer = await printer_factory()
  679. synced_spool = {"id": 42, "filament": {"material": "PLA"}, "remaining_weight": 500}
  680. fake_tray = AMSTray(
  681. ams_id=0,
  682. tray_id=2,
  683. tray_type="PLA",
  684. tray_sub_brands="PLA Basic",
  685. tray_color="FF0000FF",
  686. remain=80,
  687. tag_uid="",
  688. tray_uuid="A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4",
  689. tray_info_idx="",
  690. tray_weight=1000,
  691. )
  692. mock_spoolman_client.parse_ams_tray = MagicMock(return_value=fake_tray)
  693. mock_spoolman_client.sync_ams_tray = AsyncMock(return_value=synced_spool)
  694. with patch("backend.app.api.routes.spoolman.printer_manager") as pm_mock:
  695. mock_state = MagicMock()
  696. mock_state.raw_data = {"ams": [{"id": 0, "tray": [{"id": 2}]}]}
  697. pm_mock.get_status = MagicMock(return_value=mock_state)
  698. response = await async_client.post(f"/api/v1/spoolman/sync/{printer.id}")
  699. assert response.status_code == 200
  700. data = response.json()
  701. assert data["synced_count"] == 1
  702. # Verify slot assignment was written to the DB
  703. result = await db_session.execute(
  704. select(SpoolmanSlotAssignment).where(SpoolmanSlotAssignment.printer_id == printer.id)
  705. )
  706. rows = result.scalars().all()
  707. assert len(rows) == 1
  708. assert rows[0].ams_id == 0
  709. assert rows[0].tray_id == 2
  710. assert rows[0].spoolman_spool_id == 42
  711. @pytest.mark.asyncio
  712. @pytest.mark.integration
  713. async def test_sync_passes_slot_hint_when_no_rfid(
  714. self,
  715. async_client: AsyncClient,
  716. spoolman_settings,
  717. mock_spoolman_client,
  718. printer_factory,
  719. db_session,
  720. ):
  721. """sync passes the spoolman_spool_id_hint from the local slot-assignment table when no RFID tag is present."""
  722. from sqlalchemy import text
  723. from backend.app.services.spoolman import AMSTray
  724. printer = await printer_factory()
  725. # Pre-seed a slot assignment to serve as the hint
  726. await db_session.execute(
  727. text(
  728. "INSERT INTO spoolman_slot_assignments (printer_id, ams_id, tray_id, spoolman_spool_id)"
  729. " VALUES (:p, :a, :t, :s)"
  730. ),
  731. {"p": printer.id, "a": 0, "t": 1, "s": 55},
  732. )
  733. await db_session.commit()
  734. captured_hints: list = []
  735. async def capturing_sync(tray, printer_name, db, **kwargs):
  736. captured_hints.append(kwargs.get("spoolman_spool_id_hint"))
  737. return None
  738. fake_tray_no_rfid = AMSTray(
  739. ams_id=0,
  740. tray_id=1,
  741. tray_type="PLA",
  742. tray_sub_brands="Generic PLA",
  743. tray_color="FFFFFFFF",
  744. remain=-1,
  745. tag_uid="",
  746. tray_uuid="",
  747. tray_info_idx="",
  748. tray_weight=1000,
  749. )
  750. mock_spoolman_client.parse_ams_tray = MagicMock(return_value=fake_tray_no_rfid)
  751. mock_spoolman_client.sync_ams_tray = capturing_sync
  752. with patch("backend.app.api.routes.spoolman.printer_manager") as pm_mock:
  753. mock_state = MagicMock()
  754. mock_state.raw_data = {"ams": [{"id": 0, "tray": [{"id": 1}]}]}
  755. pm_mock.get_status = MagicMock(return_value=mock_state)
  756. response = await async_client.post(f"/api/v1/spoolman/sync/{printer.id}")
  757. assert response.status_code == 200
  758. assert len(captured_hints) == 1
  759. assert captured_hints[0] == 55
  760. @pytest.mark.asyncio
  761. @pytest.mark.integration
  762. async def test_sync_no_rfid_no_hint_produces_skipped_entry(
  763. self,
  764. async_client: AsyncClient,
  765. spoolman_settings,
  766. mock_spoolman_client,
  767. printer_factory,
  768. ):
  769. """sync reports a SkippedSpool for a tray with no RFID tag and no prior slot assignment."""
  770. from backend.app.services.spoolman import AMSTray
  771. printer = await printer_factory()
  772. fake_tray = AMSTray(
  773. ams_id=0,
  774. tray_id=3,
  775. tray_type="ABS",
  776. tray_sub_brands="Generic ABS",
  777. tray_color="333333FF",
  778. remain=60,
  779. tag_uid="",
  780. tray_uuid="",
  781. tray_info_idx="",
  782. tray_weight=1000,
  783. )
  784. mock_spoolman_client.parse_ams_tray = MagicMock(return_value=fake_tray)
  785. mock_spoolman_client.sync_ams_tray = AsyncMock(return_value=None)
  786. with patch("backend.app.api.routes.spoolman.printer_manager") as pm_mock:
  787. mock_state = MagicMock()
  788. mock_state.raw_data = {"ams": [{"id": 0, "tray": [{"id": 3}]}]}
  789. pm_mock.get_status = MagicMock(return_value=mock_state)
  790. response = await async_client.post(f"/api/v1/spoolman/sync/{printer.id}")
  791. assert response.status_code == 200
  792. data = response.json()
  793. assert data["synced_count"] == 0
  794. assert data["skipped_count"] == 1
  795. assert len(data["skipped"]) == 1
  796. skipped = data["skipped"][0]
  797. assert "No RFID" in skipped["reason"]
  798. assert skipped["filament_type"] == "ABS"
  799. # =========================================================================
  800. # Filaments Endpoint Tests
  801. # =========================================================================
  802. @pytest.mark.asyncio
  803. @pytest.mark.integration
  804. async def test_get_filaments_not_enabled(self, async_client: AsyncClient):
  805. """Verify get filaments fails when not enabled."""
  806. response = await async_client.get("/api/v1/spoolman/filaments")
  807. assert response.status_code == 400
  808. assert "not enabled" in response.json()["detail"].lower()
  809. @pytest.mark.asyncio
  810. @pytest.mark.integration
  811. async def test_get_filaments_success(self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client):
  812. """Verify get filaments returns data in expected format."""
  813. mock_filament = {
  814. "id": 1,
  815. "name": "PLA Basic",
  816. "material": "PLA",
  817. "color_hex": "FF0000",
  818. "vendor_id": 1,
  819. "weight": 1000,
  820. }
  821. mock_spoolman_client.get_filaments = AsyncMock(return_value=[mock_filament])
  822. response = await async_client.get("/api/v1/spoolman/filaments")
  823. assert response.status_code == 200
  824. data = response.json()
  825. assert "filaments" in data
  826. assert isinstance(data["filaments"], list)
  827. assert len(data["filaments"]) == 1
  828. assert data["filaments"][0]["name"] == "PLA Basic"
  829. # =========================================================================
  830. # Disable Weight Sync Tests
  831. # =========================================================================
  832. @pytest.fixture
  833. async def spoolman_settings_weight_sync_disabled(self, db_session):
  834. """Create Spoolman settings with weight sync disabled."""
  835. from backend.app.models.settings import Settings
  836. enabled_setting = Settings(key="spoolman_enabled", value="true")
  837. url_setting = Settings(key="spoolman_url", value="http://localhost:7912")
  838. disable_weight_setting = Settings(key="spoolman_disable_weight_sync", value="true")
  839. partial_usage_setting = Settings(key="spoolman_report_partial_usage", value="true")
  840. db_session.add(enabled_setting)
  841. db_session.add(url_setting)
  842. db_session.add(disable_weight_setting)
  843. db_session.add(partial_usage_setting)
  844. await db_session.commit()
  845. return {
  846. "enabled": enabled_setting,
  847. "url": url_setting,
  848. "disable_weight": disable_weight_setting,
  849. "partial_usage": partial_usage_setting,
  850. }
  851. @pytest.mark.asyncio
  852. @pytest.mark.integration
  853. async def test_settings_returns_disable_weight_sync(
  854. self, async_client: AsyncClient, spoolman_settings_weight_sync_disabled
  855. ):
  856. """Verify settings endpoint returns the disable_weight_sync setting."""
  857. response = await async_client.get("/api/v1/settings/spoolman")
  858. assert response.status_code == 200
  859. data = response.json()
  860. assert "spoolman_disable_weight_sync" in data
  861. assert data["spoolman_disable_weight_sync"] == "true"
  862. @pytest.mark.asyncio
  863. @pytest.mark.integration
  864. async def test_settings_update_disable_weight_sync(self, async_client: AsyncClient, spoolman_settings):
  865. """Verify settings endpoint can update the disable_weight_sync setting."""
  866. # First verify it's false by default
  867. response = await async_client.get("/api/v1/settings/spoolman")
  868. assert response.status_code == 200
  869. data = response.json()
  870. assert data.get("spoolman_disable_weight_sync", "false") == "false"
  871. # Update the setting
  872. response = await async_client.put(
  873. "/api/v1/settings/spoolman",
  874. json={"spoolman_disable_weight_sync": "true"},
  875. )
  876. assert response.status_code == 200
  877. data = response.json()
  878. assert data["spoolman_disable_weight_sync"] == "true"
  879. # Verify it persisted
  880. response = await async_client.get("/api/v1/settings/spoolman")
  881. assert response.status_code == 200
  882. data = response.json()
  883. assert data["spoolman_disable_weight_sync"] == "true"
  884. @pytest.mark.asyncio
  885. @pytest.mark.integration
  886. async def test_sync_with_weight_sync_disabled_passes_flag(
  887. self,
  888. async_client: AsyncClient,
  889. spoolman_settings_weight_sync_disabled,
  890. mock_spoolman_client,
  891. printer_factory,
  892. ):
  893. """Verify sync passes disable_weight_sync=True to sync_ams_tray when the setting is on."""
  894. printer = await printer_factory()
  895. # Mock existing spool
  896. mock_existing_spool = {
  897. "id": 42,
  898. "remaining_weight": 800,
  899. "extra": {"tag": '"A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"'},
  900. "filament": {"id": 1, "name": "PLA Red", "material": "PLA"},
  901. }
  902. mock_spoolman_client.find_spool_by_tag = AsyncMock(return_value=mock_existing_spool)
  903. mock_spoolman_client.parse_ams_tray = MagicMock()
  904. # Create mock AMSTray
  905. from backend.app.services.spoolman import AMSTray
  906. mock_tray = AMSTray(
  907. ams_id=0,
  908. tray_id=0,
  909. tray_type="PLA",
  910. tray_sub_brands="PLA Basic",
  911. tray_color="FF0000FF",
  912. remain=50,
  913. tag_uid="",
  914. tray_uuid="A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4",
  915. tray_info_idx="GFA00",
  916. tray_weight=1000,
  917. )
  918. mock_spoolman_client.parse_ams_tray.return_value = mock_tray
  919. mock_spoolman_client.convert_ams_slot_to_location = MagicMock(return_value="AMS A1")
  920. mock_spoolman_client.sync_ams_tray = AsyncMock(return_value={"id": 42})
  921. mock_spoolman_client.clear_location_for_removed_spools = AsyncMock(return_value=0)
  922. with patch("backend.app.api.routes.spoolman.printer_manager") as pm_mock:
  923. mock_state = MagicMock()
  924. mock_state.raw_data = {
  925. "ams": [
  926. {
  927. "id": 0,
  928. "tray": [
  929. {
  930. "id": 0,
  931. "tray_type": "PLA",
  932. "tray_sub_brands": "PLA Basic",
  933. "tray_color": "FF0000FF",
  934. "remain": 50,
  935. "tag_uid": "",
  936. "tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4",
  937. "tray_info_idx": "GFA00",
  938. "tray_weight": 1000,
  939. }
  940. ],
  941. }
  942. ]
  943. }
  944. pm_mock.get_status = MagicMock(return_value=mock_state)
  945. response = await async_client.post(f"/api/v1/spoolman/sync/{printer.id}")
  946. assert response.status_code == 200
  947. # Verify sync_ams_tray was called with disable_weight_sync=True
  948. mock_spoolman_client.sync_ams_tray.assert_called()
  949. call_kwargs = mock_spoolman_client.sync_ams_tray.call_args.kwargs
  950. assert call_kwargs.get("disable_weight_sync") is True
  951. # =========================================================================
  952. # Report Partial Usage Tests
  953. # =========================================================================
  954. @pytest.fixture
  955. async def spoolman_settings_partial_usage_disabled(self, db_session):
  956. """Create Spoolman settings with partial usage reporting disabled."""
  957. from backend.app.models.settings import Settings
  958. enabled_setting = Settings(key="spoolman_enabled", value="true")
  959. url_setting = Settings(key="spoolman_url", value="http://localhost:7912")
  960. partial_usage_setting = Settings(key="spoolman_report_partial_usage", value="false")
  961. db_session.add(enabled_setting)
  962. db_session.add(url_setting)
  963. db_session.add(partial_usage_setting)
  964. await db_session.commit()
  965. return {
  966. "enabled": enabled_setting,
  967. "url": url_setting,
  968. "partial_usage": partial_usage_setting,
  969. }
  970. @pytest.mark.asyncio
  971. @pytest.mark.integration
  972. async def test_settings_returns_report_partial_usage(
  973. self, async_client: AsyncClient, spoolman_settings_partial_usage_disabled
  974. ):
  975. """Verify settings endpoint returns the report_partial_usage setting."""
  976. response = await async_client.get("/api/v1/settings/spoolman")
  977. assert response.status_code == 200
  978. data = response.json()
  979. assert "spoolman_report_partial_usage" in data
  980. assert data["spoolman_report_partial_usage"] == "false"
  981. @pytest.mark.asyncio
  982. @pytest.mark.integration
  983. async def test_settings_update_report_partial_usage(self, async_client: AsyncClient, spoolman_settings):
  984. """Verify settings endpoint can update the report_partial_usage setting."""
  985. # First verify it's true by default
  986. response = await async_client.get("/api/v1/settings/spoolman")
  987. assert response.status_code == 200
  988. data = response.json()
  989. assert data.get("spoolman_report_partial_usage", "true") == "true"
  990. # Update the setting to false
  991. response = await async_client.put(
  992. "/api/v1/settings/spoolman",
  993. json={"spoolman_report_partial_usage": "false"},
  994. )
  995. assert response.status_code == 200
  996. data = response.json()
  997. assert data["spoolman_report_partial_usage"] == "false"
  998. # Verify it persisted
  999. response = await async_client.get("/api/v1/settings/spoolman")
  1000. assert response.status_code == 200
  1001. data = response.json()
  1002. assert data["spoolman_report_partial_usage"] == "false"
  1003. @pytest.mark.asyncio
  1004. @pytest.mark.integration
  1005. async def test_settings_report_partial_usage_defaults_to_true(self, async_client: AsyncClient, spoolman_settings):
  1006. """Verify report_partial_usage defaults to true (unlike disable_weight_sync which defaults to false)."""
  1007. response = await async_client.get("/api/v1/settings/spoolman")
  1008. assert response.status_code == 200
  1009. data = response.json()
  1010. # Should default to "true"
  1011. assert data["spoolman_report_partial_usage"] == "true"
  1012. class TestLinkSpoolMqttConfigure:
  1013. """P9-TEST-BE (Bug #8): link_spool sends MQTT configure when printer context is provided."""
  1014. @pytest.fixture
  1015. async def spoolman_settings(self, db_session):
  1016. from backend.app.models.settings import Settings
  1017. db_session.add(Settings(key="spoolman_enabled", value="true"))
  1018. db_session.add(Settings(key="spoolman_url", value="http://localhost:7912"))
  1019. await db_session.commit()
  1020. @pytest.fixture
  1021. def mock_spoolman_client(self):
  1022. mock_client = MagicMock()
  1023. mock_client.has_tag_api = AsyncMock(return_value=False)
  1024. mock_client.add_native_tags = AsyncMock(return_value=0)
  1025. mock_client.unlink_all_native_tags = AsyncMock()
  1026. mock_client.is_connected = True
  1027. mock_client.base_url = "http://localhost:7912"
  1028. mock_client.health_check = AsyncMock(return_value=True)
  1029. mock_client.ensure_tag_extra_field = AsyncMock(return_value=True)
  1030. mock_client.merge_spool_extra = AsyncMock(
  1031. return_value={"id": 5, "extra": {"tag": '"A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"'}}
  1032. )
  1033. # #1457 stale-tag cleanup enumerates spools; default to empty so it's a no-op.
  1034. mock_client.get_spools = AsyncMock(return_value=[])
  1035. mock_client.get_spool = AsyncMock(
  1036. return_value={
  1037. "id": 5,
  1038. "remaining_weight": 800.0,
  1039. "used_weight": 200.0,
  1040. "spool_weight": None,
  1041. "filament": {
  1042. "id": 1,
  1043. "name": "PLA Basic",
  1044. "material": "PLA",
  1045. "color_hex": "FF0000",
  1046. "color_name": "Red",
  1047. "vendor": {"id": 1, "name": "Bambu Lab"},
  1048. "weight": 1000,
  1049. "spool_weight": 250,
  1050. },
  1051. "extra": {},
  1052. "location": None,
  1053. "comment": None,
  1054. "archived": False,
  1055. }
  1056. )
  1057. mock_client.close = AsyncMock()
  1058. mock_client.extra_lock = MagicMock()
  1059. mock_client.extra_lock.return_value.__aenter__ = AsyncMock(return_value=None)
  1060. mock_client.extra_lock.return_value.__aexit__ = AsyncMock(return_value=False)
  1061. with (
  1062. patch(
  1063. "backend.app.api.routes.spoolman.get_spoolman_client",
  1064. AsyncMock(return_value=mock_client),
  1065. ),
  1066. patch(
  1067. "backend.app.api.routes.spoolman.init_spoolman_client",
  1068. AsyncMock(return_value=mock_client),
  1069. ),
  1070. patch(
  1071. "backend.app.api.routes.spoolman.close_spoolman_client",
  1072. AsyncMock(),
  1073. ),
  1074. ):
  1075. yield mock_client
  1076. @pytest.fixture
  1077. def printer_factory(self, db_session):
  1078. _counter = [0]
  1079. async def _create(**kwargs):
  1080. from backend.app.models.printer import Printer
  1081. _counter[0] += 1
  1082. defaults = {
  1083. "name": f"Test Printer {_counter[0]}",
  1084. "serial_number": f"MQTTTEST{_counter[0]:06d}",
  1085. "ip_address": f"192.168.100.{_counter[0]}",
  1086. "access_code": "12345678",
  1087. "is_active": True,
  1088. "auto_archive": True,
  1089. "model": "X1C",
  1090. }
  1091. defaults.update(kwargs)
  1092. p = Printer(**defaults)
  1093. db_session.add(p)
  1094. await db_session.commit()
  1095. await db_session.refresh(p)
  1096. return p
  1097. return _create
  1098. @pytest.mark.asyncio
  1099. @pytest.mark.integration
  1100. async def test_link_spool_sends_ams_set_filament_with_printer_context(
  1101. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client, printer_factory
  1102. ):
  1103. """link_spool with printer context calls ams_set_filament_setting via MQTT."""
  1104. printer = await printer_factory()
  1105. mqtt_mock = MagicMock()
  1106. mqtt_mock.printer_state = MagicMock(
  1107. nozzles=[MagicMock(nozzle_diameter="0.4")],
  1108. ams_extruder_map={"0": 0},
  1109. raw_data={"ams": [{"id": 0, "tray": [{"id": 1, "cali_idx": None}]}]},
  1110. )
  1111. with patch("backend.app.api.routes.spoolman.printer_manager") as mock_pm:
  1112. mock_pm.get_client.return_value = mqtt_mock
  1113. response = await async_client.post(
  1114. "/api/v1/spoolman/spools/5/link",
  1115. json={
  1116. "tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4",
  1117. "printer_id": printer.id,
  1118. "ams_id": 0,
  1119. "tray_id": 1,
  1120. },
  1121. )
  1122. assert response.status_code == 200
  1123. assert response.json()["success"] is True
  1124. mqtt_mock.ams_set_filament_setting.assert_called_once()
  1125. call_kwargs = mqtt_mock.ams_set_filament_setting.call_args.kwargs
  1126. assert call_kwargs["ams_id"] == 0
  1127. assert call_kwargs["tray_id"] == 1
  1128. @pytest.mark.asyncio
  1129. @pytest.mark.integration
  1130. async def test_link_spool_no_printer_context_no_mqtt(
  1131. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  1132. ):
  1133. """link_spool without printer context does not attempt MQTT configure."""
  1134. mqtt_mock = MagicMock()
  1135. with patch("backend.app.api.routes.spoolman.printer_manager") as mock_pm:
  1136. mock_pm.get_client.return_value = mqtt_mock
  1137. response = await async_client.post(
  1138. "/api/v1/spoolman/spools/5/link",
  1139. json={"tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"},
  1140. )
  1141. assert response.status_code == 200
  1142. mock_pm.get_client.assert_not_called()
  1143. mqtt_mock.ams_set_filament_setting.assert_not_called()
  1144. @pytest.mark.asyncio
  1145. @pytest.mark.integration
  1146. async def test_link_spool_mqtt_failure_does_not_prevent_link(
  1147. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client, printer_factory
  1148. ):
  1149. """MQTT failure is best-effort: link still succeeds if ams_set_filament_setting throws."""
  1150. printer = await printer_factory()
  1151. mqtt_mock = MagicMock()
  1152. mqtt_mock.printer_state = MagicMock(
  1153. nozzles=[MagicMock(nozzle_diameter="0.4")],
  1154. ams_extruder_map={"0": 0},
  1155. raw_data={"ams": []},
  1156. )
  1157. mqtt_mock.ams_set_filament_setting.side_effect = RuntimeError("MQTT connection lost")
  1158. with patch("backend.app.api.routes.spoolman.printer_manager") as mock_pm:
  1159. mock_pm.get_client.return_value = mqtt_mock
  1160. response = await async_client.post(
  1161. "/api/v1/spoolman/spools/5/link",
  1162. json={
  1163. "tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4",
  1164. "printer_id": printer.id,
  1165. "ams_id": 0,
  1166. "tray_id": 0,
  1167. },
  1168. )
  1169. assert response.status_code == 200
  1170. data = response.json()
  1171. assert data["success"] is True
  1172. assert "linked" in data["message"].lower()
  1173. @pytest.mark.asyncio
  1174. @pytest.mark.integration
  1175. async def test_link_spool_realigns_filament_context_to_printer_kp(
  1176. self,
  1177. async_client: AsyncClient,
  1178. spoolman_settings,
  1179. mock_spoolman_client,
  1180. printer_factory,
  1181. db_session,
  1182. ):
  1183. """link_spool MQTT auto-configure realigns tray_info_idx + setting_id
  1184. to the printer-side kp's filament context — same fix as assign path.
  1185. Pre-fix link_spool used `mqtt_client.printer_state` (a non-existent
  1186. attribute that always evaluated to None), so state.kprofiles /
  1187. nozzles / ams_extruder_map were all skipped — every link sent
  1188. generic-PLA tray_info_idx with empty setting_id, and the cali_idx
  1189. in the printer's table couldn't be linked. (#1114)
  1190. """
  1191. from backend.app.models.spoolman_k_profile import SpoolmanKProfile
  1192. printer = await printer_factory()
  1193. kp = SpoolmanKProfile(
  1194. spoolman_spool_id=5,
  1195. printer_id=printer.id,
  1196. extruder=0,
  1197. nozzle_diameter="0.4",
  1198. k_value=0.025,
  1199. cali_idx=8948,
  1200. setting_id="PFUSedbf16b803ff3e",
  1201. )
  1202. db_session.add(kp)
  1203. await db_session.commit()
  1204. printer_kp = MagicMock(
  1205. slot_id=8948,
  1206. nozzle_diameter="0.4",
  1207. filament_id="P4d64437",
  1208. setting_id="PFUSedbf16b803ff3e",
  1209. )
  1210. printer_state = MagicMock(
  1211. nozzles=[MagicMock(nozzle_diameter="0.4")],
  1212. ams_extruder_map={"0": 0},
  1213. raw_data={"ams": [{"id": 0, "tray": [{"id": 1, "cali_idx": None}]}]},
  1214. kprofiles=[printer_kp],
  1215. )
  1216. mqtt_mock = MagicMock()
  1217. mqtt_mock.ams_set_filament_setting = MagicMock()
  1218. mqtt_mock.extrusion_cali_sel = MagicMock()
  1219. # Production never had this attribute; pre-fix code read it and got
  1220. # None, defeating the cascade. The new code uses get_status instead.
  1221. mqtt_mock.printer_state = None
  1222. with patch("backend.app.api.routes.spoolman.printer_manager") as mock_pm:
  1223. mock_pm.get_client.return_value = mqtt_mock
  1224. mock_pm.get_status.return_value = printer_state
  1225. response = await async_client.post(
  1226. "/api/v1/spoolman/spools/5/link",
  1227. json={
  1228. "tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4",
  1229. "printer_id": printer.id,
  1230. "ams_id": 0,
  1231. "tray_id": 1,
  1232. },
  1233. )
  1234. assert response.status_code == 200
  1235. amf_kwargs = mqtt_mock.ams_set_filament_setting.call_args.kwargs
  1236. assert amf_kwargs["tray_info_idx"] == "P4d64437"
  1237. assert amf_kwargs["setting_id"] == "PFUSedbf16b803ff3e"
  1238. cs_kwargs = mqtt_mock.extrusion_cali_sel.call_args.kwargs
  1239. assert cs_kwargs["cali_idx"] == 8948
  1240. assert cs_kwargs["filament_id"] == "P4d64437"
  1241. @pytest.mark.asyncio
  1242. @pytest.mark.integration
  1243. async def test_link_spool_uses_printer_manager_not_mqtt_client_state(
  1244. self,
  1245. async_client: AsyncClient,
  1246. spoolman_settings,
  1247. mock_spoolman_client,
  1248. printer_factory,
  1249. db_session,
  1250. ):
  1251. """Regression: state comes from printer_manager.get_status, not
  1252. mqtt_client.printer_state (which didn't exist on the real client)."""
  1253. from backend.app.models.spoolman_k_profile import SpoolmanKProfile
  1254. printer = await printer_factory()
  1255. kp = SpoolmanKProfile(
  1256. spoolman_spool_id=5,
  1257. printer_id=printer.id,
  1258. extruder=0,
  1259. nozzle_diameter="0.4",
  1260. k_value=0.025,
  1261. cali_idx=42,
  1262. setting_id="GFSL05",
  1263. )
  1264. db_session.add(kp)
  1265. await db_session.commit()
  1266. printer_state = MagicMock(
  1267. nozzles=[MagicMock(nozzle_diameter="0.4")],
  1268. ams_extruder_map={"0": 0},
  1269. raw_data=None,
  1270. kprofiles=[],
  1271. )
  1272. mqtt_mock = MagicMock()
  1273. mqtt_mock.ams_set_filament_setting = MagicMock()
  1274. mqtt_mock.extrusion_cali_sel = MagicMock()
  1275. # Production didn't have mqtt_client.printer_state — drop the spec
  1276. # so an accidental read raises AttributeError instead of silently
  1277. # returning a MagicMock.
  1278. del mqtt_mock.printer_state
  1279. with patch("backend.app.api.routes.spoolman.printer_manager") as mock_pm:
  1280. mock_pm.get_client.return_value = mqtt_mock
  1281. mock_pm.get_status.return_value = printer_state
  1282. response = await async_client.post(
  1283. "/api/v1/spoolman/spools/5/link",
  1284. json={
  1285. "tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4",
  1286. "printer_id": printer.id,
  1287. "ams_id": 0,
  1288. "tray_id": 2,
  1289. },
  1290. )
  1291. assert response.status_code == 200
  1292. # cali_sel must fire with cali_idx=42 — proves get_status was used
  1293. mqtt_mock.extrusion_cali_sel.assert_called_once()
  1294. assert mqtt_mock.extrusion_cali_sel.call_args.kwargs["cali_idx"] == 42