test_spoolman_api.py 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424
  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.get_spools = AsyncMock(return_value=[])
  35. mock_client.get_filaments = AsyncMock(return_value=[])
  36. mock_client.create_spool = AsyncMock(return_value={"id": 1})
  37. mock_client.update_spool = AsyncMock(return_value={"id": 1})
  38. mock_client.close = AsyncMock()
  39. with (
  40. patch(
  41. "backend.app.api.routes.spoolman.get_spoolman_client",
  42. AsyncMock(return_value=mock_client),
  43. ),
  44. patch(
  45. "backend.app.api.routes.spoolman.init_spoolman_client",
  46. AsyncMock(return_value=mock_client),
  47. ),
  48. patch(
  49. "backend.app.api.routes.spoolman.close_spoolman_client",
  50. AsyncMock(),
  51. ),
  52. ):
  53. yield mock_client
  54. @pytest.fixture
  55. def mock_spoolman_disconnected(self):
  56. """Mock the Spoolman client as disconnected (returns None)."""
  57. with (
  58. patch(
  59. "backend.app.api.routes.spoolman.get_spoolman_client",
  60. AsyncMock(return_value=None),
  61. ),
  62. patch(
  63. "backend.app.api.routes.spoolman.init_spoolman_client",
  64. AsyncMock(return_value=None),
  65. ),
  66. ):
  67. yield
  68. # =========================================================================
  69. # Status Endpoint Tests
  70. # =========================================================================
  71. @pytest.mark.asyncio
  72. @pytest.mark.integration
  73. async def test_get_status_not_configured(self, async_client: AsyncClient):
  74. """Verify status shows not enabled when no settings exist."""
  75. response = await async_client.get("/api/v1/spoolman/status")
  76. assert response.status_code == 200
  77. data = response.json()
  78. assert data["enabled"] is False
  79. assert data["connected"] is False
  80. @pytest.mark.asyncio
  81. @pytest.mark.integration
  82. async def test_get_status_url_only_not_enabled(self, async_client: AsyncClient, spoolman_url_only):
  83. """Verify status shows not enabled when only URL is set."""
  84. response = await async_client.get("/api/v1/spoolman/status")
  85. assert response.status_code == 200
  86. data = response.json()
  87. assert data["enabled"] is False
  88. assert data["url"] == "http://localhost:7912"
  89. @pytest.mark.asyncio
  90. @pytest.mark.integration
  91. async def test_get_status_enabled_and_connected(
  92. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  93. ):
  94. """Verify status shows enabled and connected when properly configured."""
  95. response = await async_client.get("/api/v1/spoolman/status")
  96. assert response.status_code == 200
  97. data = response.json()
  98. assert data["enabled"] is True
  99. assert data["connected"] is True
  100. assert data["url"] == "http://localhost:7912"
  101. # =========================================================================
  102. # Connect/Disconnect Tests
  103. # =========================================================================
  104. @pytest.mark.asyncio
  105. @pytest.mark.integration
  106. async def test_connect_not_enabled(self, async_client: AsyncClient):
  107. """Verify connect fails when not enabled."""
  108. response = await async_client.post("/api/v1/spoolman/connect")
  109. assert response.status_code == 400
  110. assert "not enabled" in response.json()["detail"].lower()
  111. @pytest.mark.asyncio
  112. @pytest.mark.integration
  113. async def test_connect_success(self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client):
  114. """Verify successful connection to Spoolman."""
  115. response = await async_client.post("/api/v1/spoolman/connect")
  116. assert response.status_code == 200
  117. data = response.json()
  118. assert data["success"] is True
  119. assert "connected" in data["message"].lower()
  120. @pytest.mark.asyncio
  121. @pytest.mark.integration
  122. async def test_disconnect(self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client):
  123. """Verify disconnect works."""
  124. response = await async_client.post("/api/v1/spoolman/disconnect")
  125. assert response.status_code == 200
  126. assert "disconnected" in response.json()["message"].lower()
  127. # =========================================================================
  128. # Spools Endpoint Tests
  129. # =========================================================================
  130. @pytest.mark.asyncio
  131. @pytest.mark.integration
  132. async def test_get_spools_not_enabled(self, async_client: AsyncClient):
  133. """Verify get spools fails when not enabled."""
  134. response = await async_client.get("/api/v1/spoolman/spools")
  135. assert response.status_code == 400
  136. assert "not enabled" in response.json()["detail"].lower()
  137. @pytest.mark.asyncio
  138. @pytest.mark.integration
  139. async def test_get_spools_success(self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client):
  140. """Verify get spools returns data in expected format."""
  141. mock_spool = {
  142. "id": 1,
  143. "remaining_weight": 500,
  144. "used_weight": 500,
  145. "filament": {
  146. "id": 1,
  147. "name": "PLA Basic",
  148. "material": "PLA",
  149. "color_hex": "FF0000",
  150. },
  151. "first_used": "2024-01-01",
  152. "last_used": "2024-01-15",
  153. "location": "AMS1",
  154. "lot_nr": "LOT123",
  155. "comment": "Test spool",
  156. "extra": {"tag": '"ABC123"'},
  157. }
  158. mock_spoolman_client.get_spools = AsyncMock(return_value=[mock_spool])
  159. response = await async_client.get("/api/v1/spoolman/spools")
  160. assert response.status_code == 200
  161. data = response.json()
  162. assert "spools" in data
  163. assert isinstance(data["spools"], list)
  164. assert len(data["spools"]) == 1
  165. assert data["spools"][0]["id"] == 1
  166. # =========================================================================
  167. # Unlinked Spools Tests
  168. # =========================================================================
  169. @pytest.mark.asyncio
  170. @pytest.mark.integration
  171. async def test_get_unlinked_spools_not_enabled(self, async_client: AsyncClient):
  172. """Verify get unlinked spools fails when not enabled."""
  173. response = await async_client.get("/api/v1/spoolman/spools/unlinked")
  174. assert response.status_code == 400
  175. @pytest.mark.asyncio
  176. @pytest.mark.integration
  177. async def test_get_unlinked_spools_success(
  178. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  179. ):
  180. """Verify get unlinked spools returns spools without tags."""
  181. # Mock spool without extra.tag (unlinked)
  182. mock_spool = {
  183. "id": 1,
  184. "remaining_weight": 800,
  185. "used_weight": 200,
  186. "extra": {}, # No tag = unlinked
  187. "filament": {
  188. "id": 1,
  189. "name": "PLA Basic",
  190. "material": "PLA",
  191. "color_hex": "FF0000",
  192. },
  193. "location": "Shelf A",
  194. }
  195. mock_spoolman_client.get_spools = AsyncMock(return_value=[mock_spool])
  196. response = await async_client.get("/api/v1/spoolman/spools/unlinked")
  197. assert response.status_code == 200
  198. data = response.json()
  199. assert isinstance(data, list)
  200. assert len(data) == 1
  201. assert data[0]["id"] == 1
  202. assert data[0]["filament_name"] == "PLA Basic"
  203. @pytest.mark.asyncio
  204. @pytest.mark.integration
  205. async def test_get_unlinked_spools_excludes_linked(
  206. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  207. ):
  208. """Verify linked spools (with tag) are excluded."""
  209. # Mock spool with extra.tag (linked)
  210. mock_spool_linked = {
  211. "id": 1,
  212. "remaining_weight": 800,
  213. "used_weight": 200,
  214. "extra": {"tag": '"ABC123"'}, # Has tag = linked
  215. "filament": {"id": 1, "name": "PLA Red", "material": "PLA", "color_hex": "FF0000"},
  216. }
  217. # Mock spool without tag (unlinked)
  218. mock_spool_unlinked = {
  219. "id": 2,
  220. "remaining_weight": 900,
  221. "used_weight": 100,
  222. "extra": {}, # No tag = unlinked
  223. "filament": {"id": 2, "name": "PLA Blue", "material": "PLA", "color_hex": "0000FF"},
  224. }
  225. mock_spoolman_client.get_spools = AsyncMock(return_value=[mock_spool_linked, mock_spool_unlinked])
  226. response = await async_client.get("/api/v1/spoolman/spools/unlinked")
  227. assert response.status_code == 200
  228. data = response.json()
  229. assert len(data) == 1
  230. assert data[0]["id"] == 2 # Only unlinked spool
  231. # =========================================================================
  232. # Link Spool Tests
  233. # =========================================================================
  234. @pytest.mark.asyncio
  235. @pytest.mark.integration
  236. async def test_link_spool_not_enabled(self, async_client: AsyncClient):
  237. """Verify link spool fails when not enabled."""
  238. response = await async_client.post(
  239. "/api/v1/spoolman/spools/1/link",
  240. json={"tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"},
  241. )
  242. assert response.status_code == 400
  243. @pytest.mark.asyncio
  244. @pytest.mark.integration
  245. async def test_link_spool_invalid_uuid_length(
  246. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  247. ):
  248. """Verify link spool fails with invalid UUID length."""
  249. response = await async_client.post(
  250. "/api/v1/spoolman/spools/1/link",
  251. json={"tray_uuid": "ABC123"}, # Too short
  252. )
  253. assert response.status_code == 400
  254. assert "32 hex characters" in response.json()["detail"]
  255. @pytest.mark.asyncio
  256. @pytest.mark.integration
  257. async def test_link_spool_invalid_uuid_format(
  258. self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client
  259. ):
  260. """Verify link spool fails with non-hex UUID."""
  261. response = await async_client.post(
  262. "/api/v1/spoolman/spools/1/link",
  263. json={"tray_uuid": "ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"}, # Not hex
  264. )
  265. assert response.status_code == 400
  266. assert "hex" in response.json()["detail"].lower()
  267. @pytest.mark.asyncio
  268. @pytest.mark.integration
  269. async def test_link_spool_success(self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client):
  270. """Verify successfully linking a spool to AMS tray."""
  271. mock_spoolman_client.update_spool = AsyncMock(
  272. return_value={"id": 1, "extra": {"tag": '"A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"'}}
  273. )
  274. response = await async_client.post(
  275. "/api/v1/spoolman/spools/1/link",
  276. json={"tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"},
  277. )
  278. assert response.status_code == 200
  279. data = response.json()
  280. assert data["success"] is True
  281. assert "linked" in data["message"].lower()
  282. # Verify update_spool was called
  283. mock_spoolman_client.update_spool.assert_called_once()
  284. # =========================================================================
  285. # Sync Tests
  286. # =========================================================================
  287. @pytest.mark.asyncio
  288. @pytest.mark.integration
  289. async def test_sync_printer_not_enabled(self, async_client: AsyncClient, printer_factory):
  290. """Verify sync fails when Spoolman not enabled."""
  291. printer = await printer_factory()
  292. response = await async_client.post(f"/api/v1/spoolman/sync/{printer.id}")
  293. assert response.status_code == 400
  294. assert "not enabled" in response.json()["detail"].lower()
  295. @pytest.mark.asyncio
  296. @pytest.mark.integration
  297. async def test_sync_printer_not_found(self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client):
  298. """Verify sync fails for non-existent printer."""
  299. response = await async_client.post("/api/v1/spoolman/sync/9999")
  300. assert response.status_code == 404
  301. @pytest.mark.asyncio
  302. @pytest.mark.integration
  303. async def test_sync_returns_result_structure(
  304. self,
  305. async_client: AsyncClient,
  306. spoolman_settings,
  307. mock_spoolman_client,
  308. printer_factory,
  309. ):
  310. """Verify sync returns proper result structure."""
  311. printer = await printer_factory()
  312. # Mock printer manager to return AMS data
  313. with patch("backend.app.api.routes.spoolman.printer_manager") as pm_mock:
  314. mock_state = MagicMock()
  315. mock_state.raw_data = {"ams": [{"id": 0, "tray": []}]}
  316. pm_mock.get_status = MagicMock(return_value=mock_state)
  317. response = await async_client.post(f"/api/v1/spoolman/sync/{printer.id}")
  318. assert response.status_code == 200
  319. data = response.json()
  320. # Verify SyncResult structure
  321. assert "success" in data
  322. assert "synced_count" in data
  323. assert "skipped_count" in data
  324. assert "skipped" in data
  325. assert "errors" in data
  326. assert isinstance(data["skipped"], list)
  327. assert isinstance(data["errors"], list)
  328. @pytest.mark.asyncio
  329. @pytest.mark.integration
  330. async def test_sync_printer_not_connected(
  331. self,
  332. async_client: AsyncClient,
  333. spoolman_settings,
  334. mock_spoolman_client,
  335. printer_factory,
  336. ):
  337. """Verify sync fails when printer is not connected (no status)."""
  338. printer = await printer_factory()
  339. with patch("backend.app.api.routes.spoolman.printer_manager") as pm_mock:
  340. pm_mock.get_status = MagicMock(return_value=None)
  341. response = await async_client.post(f"/api/v1/spoolman/sync/{printer.id}")
  342. assert response.status_code == 404
  343. assert "not connected" in response.json()["detail"].lower()
  344. # =========================================================================
  345. # Filaments Endpoint Tests
  346. # =========================================================================
  347. @pytest.mark.asyncio
  348. @pytest.mark.integration
  349. async def test_get_filaments_not_enabled(self, async_client: AsyncClient):
  350. """Verify get filaments fails when not enabled."""
  351. response = await async_client.get("/api/v1/spoolman/filaments")
  352. assert response.status_code == 400
  353. assert "not enabled" in response.json()["detail"].lower()
  354. @pytest.mark.asyncio
  355. @pytest.mark.integration
  356. async def test_get_filaments_success(self, async_client: AsyncClient, spoolman_settings, mock_spoolman_client):
  357. """Verify get filaments returns data in expected format."""
  358. mock_filament = {
  359. "id": 1,
  360. "name": "PLA Basic",
  361. "material": "PLA",
  362. "color_hex": "FF0000",
  363. "vendor_id": 1,
  364. "weight": 1000,
  365. }
  366. mock_spoolman_client.get_filaments = AsyncMock(return_value=[mock_filament])
  367. response = await async_client.get("/api/v1/spoolman/filaments")
  368. assert response.status_code == 200
  369. data = response.json()
  370. assert "filaments" in data
  371. assert isinstance(data["filaments"], list)
  372. assert len(data["filaments"]) == 1
  373. assert data["filaments"][0]["name"] == "PLA Basic"