test_spoolman_api.py 58 KB

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