test_spoolman_tracking.py 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274
  1. """Unit tests for Spoolman tracking service helpers."""
  2. import json
  3. from types import SimpleNamespace
  4. from unittest.mock import AsyncMock, MagicMock, patch
  5. import pytest
  6. from backend.app.services.spoolman_tracking import (
  7. _get_fallback_spool_tag,
  8. _global_tray_id_to_ams_slot,
  9. _hash_serial_to_hex32,
  10. _resolve_global_tray_id,
  11. _resolve_spool_tag,
  12. build_ams_tray_lookup,
  13. store_print_data,
  14. )
  15. class TestResolveSpoolTag:
  16. """Tests for _resolve_spool_tag()."""
  17. def test_prefers_tray_uuid_over_tag_uid(self):
  18. tray = {"tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4", "tag_uid": "DEADBEEF"}
  19. assert _resolve_spool_tag(tray) == "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"
  20. def test_falls_back_to_tag_uid_when_no_uuid(self):
  21. tray = {"tray_uuid": "", "tag_uid": "DEADBEEF"}
  22. assert _resolve_spool_tag(tray) == "DEADBEEF"
  23. def test_falls_back_to_tag_uid_when_uuid_zero(self):
  24. tray = {"tray_uuid": "00000000000000000000000000000000", "tag_uid": "DEADBEEF"}
  25. assert _resolve_spool_tag(tray) == "DEADBEEF"
  26. def test_rejects_zero_tag_uid(self):
  27. tray = {"tray_uuid": "", "tag_uid": "0000000000000000"}
  28. assert _resolve_spool_tag(tray) == ""
  29. def test_uses_fallback_tag_when_ids_missing(self):
  30. tray = {"tray_uuid": "", "tag_uid": ""}
  31. # global_tray_id 0 -> ams_id 0, tray_id 0
  32. assert _resolve_spool_tag(tray, "01P00A000000000", 0) == "ABA7845700000000"
  33. def test_uses_fallback_tag_when_ids_zero(self):
  34. tray = {"tray_uuid": "00000000000000000000000000000000", "tag_uid": "0000000000000000"}
  35. # global_tray_id 5 -> ams_id 1, tray_id 1
  36. assert _resolve_spool_tag(tray, "01P00A000000000", 5) == "ABA7845700010001"
  37. def test_prefers_tray_uuid_over_fallback_when_non_zero(self):
  38. tray = {"tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4", "tag_uid": ""}
  39. assert _resolve_spool_tag(tray, "01P00A000000000", 0) == "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"
  40. def test_empty_both(self):
  41. tray = {"tray_uuid": "", "tag_uid": ""}
  42. assert _resolve_spool_tag(tray) == ""
  43. def test_missing_keys(self):
  44. assert _resolve_spool_tag({}) == ""
  45. def test_zero_uuid_no_tag(self):
  46. tray = {"tray_uuid": "00000000000000000000000000000000", "tag_uid": ""}
  47. assert _resolve_spool_tag(tray) == ""
  48. class TestResolveGlobalTrayId:
  49. """Tests for _resolve_global_tray_id()."""
  50. def test_default_mapping(self):
  51. """slot 1 -> tray 0, slot 2 -> tray 1, etc."""
  52. assert _resolve_global_tray_id(1, None) == 0
  53. assert _resolve_global_tray_id(2, None) == 1
  54. assert _resolve_global_tray_id(4, None) == 3
  55. def test_custom_mapping(self):
  56. """Custom slot_to_tray overrides default."""
  57. mapping = [5, 2, -1, 0]
  58. assert _resolve_global_tray_id(1, mapping) == 5
  59. assert _resolve_global_tray_id(2, mapping) == 2
  60. assert _resolve_global_tray_id(4, mapping) == 0
  61. def test_unmapped_slot(self):
  62. """Slot with -1 in mapping uses default."""
  63. mapping = [5, -1, 2, 0]
  64. assert _resolve_global_tray_id(2, mapping) == 1 # default: slot 2 -> tray 1
  65. def test_slot_beyond_mapping(self):
  66. """Slot beyond mapping length uses default."""
  67. mapping = [5, 2]
  68. assert _resolve_global_tray_id(3, mapping) == 2 # default: slot 3 -> tray 2
  69. def test_empty_mapping(self):
  70. mapping = []
  71. assert _resolve_global_tray_id(1, mapping) == 0
  72. class TestFallbackTagHelpers:
  73. """Tests for frontend-mirrored fallback tag helpers."""
  74. def test_hash_serial_matches_frontend_algorithm(self):
  75. assert _hash_serial_to_hex32("01P00A000000000") == "ABA78457"
  76. # Frontend trims and uppercases before hashing
  77. assert _hash_serial_to_hex32(" 01p00a000000000 ") == "ABA78457"
  78. def test_global_tray_to_ams_slot_standard_ams(self):
  79. assert _global_tray_id_to_ams_slot(0) == (0, 0)
  80. assert _global_tray_id_to_ams_slot(7) == (1, 3)
  81. def test_global_tray_to_ams_slot_ams_ht(self):
  82. assert _global_tray_id_to_ams_slot(128) == (128, 0)
  83. assert _global_tray_id_to_ams_slot(135) == (135, 0)
  84. def test_global_tray_to_ams_slot_external(self):
  85. assert _global_tray_id_to_ams_slot(254) == (255, 0)
  86. assert _global_tray_id_to_ams_slot(255) == (255, 1)
  87. def test_get_fallback_spool_tag_standard(self):
  88. assert _get_fallback_spool_tag("01P00A000000000", 5) == "ABA7845700010001"
  89. def test_get_fallback_spool_tag_ams_ht(self):
  90. assert _get_fallback_spool_tag("01P00A000000000", 128) == "ABA7845700800000"
  91. def test_get_fallback_spool_tag_external(self):
  92. assert _get_fallback_spool_tag("01P00A000000000", 255) == "ABA7845700FF0001"
  93. class TestBuildAmsTrayLookup:
  94. """Tests for build_ams_tray_lookup()."""
  95. def test_single_ams_unit(self):
  96. raw = {
  97. "ams": [
  98. {
  99. "id": 0,
  100. "tray": [
  101. {"id": 0, "tray_uuid": "AAA", "tag_uid": "111", "tray_type": "PLA"},
  102. {"id": 1, "tray_uuid": "BBB", "tag_uid": "222", "tray_type": "ABS"},
  103. ],
  104. }
  105. ]
  106. }
  107. lookup = build_ams_tray_lookup(raw)
  108. assert lookup[0] == {"tray_uuid": "AAA", "tag_uid": "111", "tray_type": "PLA"}
  109. assert lookup[1] == {"tray_uuid": "BBB", "tag_uid": "222", "tray_type": "ABS"}
  110. def test_multiple_ams_units(self):
  111. raw = {
  112. "ams": [
  113. {"id": 0, "tray": [{"id": 0, "tray_uuid": "A", "tag_uid": "", "tray_type": "PLA"}]},
  114. {"id": 1, "tray": [{"id": 0, "tray_uuid": "B", "tag_uid": "", "tray_type": "PETG"}]},
  115. ]
  116. }
  117. lookup = build_ams_tray_lookup(raw)
  118. assert 0 in lookup # AMS 0, tray 0
  119. assert 4 in lookup # AMS 1, tray 0 (1*4+0)
  120. assert lookup[4]["tray_uuid"] == "B"
  121. def test_external_spool(self):
  122. raw = {
  123. "ams": [],
  124. "vt_tray": [{"tray_uuid": "EXT", "tag_uid": "X", "tray_type": "TPU"}],
  125. }
  126. lookup = build_ams_tray_lookup(raw)
  127. assert 254 in lookup
  128. assert lookup[254]["tray_type"] == "TPU"
  129. def test_empty_external_spool_skipped(self):
  130. raw = {"ams": [], "vt_tray": [{"tray_type": ""}]}
  131. lookup = build_ams_tray_lookup(raw)
  132. assert 254 not in lookup
  133. def test_no_ams_data(self):
  134. assert build_ams_tray_lookup({}) == {}
  135. assert build_ams_tray_lookup({"ams": []}) == {}
  136. def test_missing_fields_default(self):
  137. raw = {"ams": [{"id": 0, "tray": [{"id": 0}]}]}
  138. lookup = build_ams_tray_lookup(raw)
  139. assert lookup[0] == {"tray_uuid": "", "tag_uid": "", "tray_type": ""}
  140. class TestStorePrintData:
  141. """Tests for store_print_data()."""
  142. @pytest.mark.asyncio
  143. async def test_prefers_explicit_ams_mapping_over_queue_mapping(self):
  144. db = AsyncMock()
  145. # store_print_data now queries the queue item unconditionally (to pick up
  146. # plate_id for multi-plate 3MFs, #1697), then deletes any stale spoolman
  147. # row before inserting the new one. Two execute calls in that order.
  148. queue_item = SimpleNamespace(ams_mapping=json.dumps([2, -1, -1, -1]), plate_id=None)
  149. queue_result = MagicMock()
  150. queue_result.scalar_one_or_none.return_value = queue_item
  151. delete_result = MagicMock()
  152. db.execute = AsyncMock(side_effect=[queue_result, delete_result])
  153. db.add = MagicMock()
  154. db.commit = AsyncMock()
  155. printer_manager = MagicMock()
  156. printer_manager.get_status.return_value = SimpleNamespace(
  157. raw_data={"ams": [{"id": 0, "tray": [{"id": 0, "tray_type": "PLA"}, {"id": 1, "tray_type": "PLA"}]}]}
  158. )
  159. mock_settings = MagicMock()
  160. mock_path = MagicMock()
  161. mock_path.exists.return_value = True
  162. mock_settings.base_dir.__truediv__.return_value = mock_path
  163. with (
  164. patch("backend.app.services.spoolman_tracking.app_settings", mock_settings),
  165. patch("backend.app.api.routes.settings.get_setting", AsyncMock(side_effect=["true", "true"])),
  166. patch(
  167. "backend.app.utils.threemf_tools.extract_filament_usage_from_3mf",
  168. return_value=[{"slot_id": 1, "used_g": 3.83, "type": "PLA", "color": "#FF0000"}],
  169. ),
  170. patch("backend.app.utils.threemf_tools.extract_layer_filament_usage_from_3mf", return_value=None),
  171. patch("backend.app.utils.threemf_tools.extract_filament_properties_from_3mf", return_value={}),
  172. ):
  173. await store_print_data(
  174. printer_id=1,
  175. archive_id=15,
  176. file_path="archives/test.3mf",
  177. db=db,
  178. printer_manager=printer_manager,
  179. ams_mapping=[1, -1, -1, -1],
  180. )
  181. db.add.assert_called_once()
  182. tracking = db.add.call_args.args[0]
  183. assert tracking.slot_to_tray == [1, -1, -1, -1]
  184. assert db.execute.await_count == 2
  185. @pytest.mark.asyncio
  186. async def test_passes_queue_plate_id_to_3mf_extract(self):
  187. """Multi-plate 3MFs queued for one plate must only count that plate's filament (#1697)."""
  188. db = AsyncMock()
  189. queue_item = SimpleNamespace(ams_mapping=None, plate_id=2)
  190. queue_result = MagicMock()
  191. queue_result.scalar_one_or_none.return_value = queue_item
  192. delete_result = MagicMock()
  193. db.execute = AsyncMock(side_effect=[queue_result, delete_result])
  194. db.add = MagicMock()
  195. db.commit = AsyncMock()
  196. printer_manager = MagicMock()
  197. printer_manager.get_status.return_value = SimpleNamespace(
  198. raw_data={"ams": [{"id": 0, "tray": [{"id": 0, "tray_type": "PLA"}]}]}
  199. )
  200. mock_settings = MagicMock()
  201. mock_path = MagicMock()
  202. mock_path.exists.return_value = True
  203. mock_settings.base_dir.__truediv__.return_value = mock_path
  204. extract_mock = MagicMock(return_value=[{"slot_id": 1, "used_g": 190.0, "type": "PETG", "color": "#888888"}])
  205. with (
  206. patch("backend.app.services.spoolman_tracking.app_settings", mock_settings),
  207. patch("backend.app.api.routes.settings.get_setting", AsyncMock(side_effect=["true", "true"])),
  208. patch("backend.app.utils.threemf_tools.extract_filament_usage_from_3mf", extract_mock),
  209. patch("backend.app.utils.threemf_tools.extract_layer_filament_usage_from_3mf", return_value=None),
  210. patch("backend.app.utils.threemf_tools.extract_filament_properties_from_3mf", return_value={}),
  211. ):
  212. await store_print_data(
  213. printer_id=1,
  214. archive_id=15,
  215. file_path="archives/test.3mf",
  216. db=db,
  217. printer_manager=printer_manager,
  218. ams_mapping=[1, -1, -1, -1],
  219. )
  220. # plate_id=2 must be passed as the second positional arg
  221. assert extract_mock.call_count == 1
  222. assert extract_mock.call_args.args[1] == 2