test_spoolman_api.py 17 KB

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