test_spoolman_inventory_helpers.py 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685
  1. """Unit tests for _safe_int, _safe_float, and _map_spoolman_spool helpers."""
  2. import math
  3. import pytest
  4. from backend.app.api.routes._spoolman_helpers import (
  5. _map_spoolman_spool,
  6. _safe_float,
  7. _safe_int,
  8. spoolman_tare,
  9. )
  10. # ---------------------------------------------------------------------------
  11. # _safe_int
  12. # ---------------------------------------------------------------------------
  13. class TestSafeInt:
  14. def test_normal_int(self):
  15. assert _safe_int(1000, 0) == 1000
  16. def test_float_rounds_down(self):
  17. assert _safe_int(750.9, 0) == 750
  18. def test_none_returns_fallback(self):
  19. assert _safe_int(None, 999) == 999
  20. def test_nan_returns_fallback(self):
  21. assert _safe_int(math.nan, 999) == 999
  22. def test_inf_returns_fallback(self):
  23. assert _safe_int(math.inf, 999) == 999
  24. def test_neg_inf_returns_fallback(self):
  25. assert _safe_int(-math.inf, 999) == 999
  26. def test_string_numeric(self):
  27. assert _safe_int("500", 0) == 500
  28. def test_string_non_numeric_returns_fallback(self):
  29. assert _safe_int("abc", 42) == 42
  30. def test_zero(self):
  31. assert _safe_int(0, 999) == 0
  32. # ---------------------------------------------------------------------------
  33. # _safe_float
  34. # ---------------------------------------------------------------------------
  35. class TestSafeFloat:
  36. def test_normal_float(self):
  37. assert _safe_float(123.45, 0.0) == pytest.approx(123.45)
  38. def test_none_returns_fallback(self):
  39. assert _safe_float(None, -1.0) == -1.0
  40. def test_nan_returns_fallback(self):
  41. assert _safe_float(math.nan, -1.0) == -1.0
  42. def test_inf_returns_fallback(self):
  43. assert _safe_float(math.inf, -1.0) == -1.0
  44. def test_neg_inf_returns_fallback(self):
  45. assert _safe_float(-math.inf, -1.0) == -1.0
  46. def test_string_numeric(self):
  47. assert _safe_float("3.14", 0.0) == pytest.approx(3.14)
  48. def test_string_non_numeric_returns_fallback(self):
  49. assert _safe_float("bad", 0.0) == 0.0
  50. def test_zero(self):
  51. assert _safe_float(0.0, 99.0) == 0.0
  52. # ---------------------------------------------------------------------------
  53. # _map_spoolman_spool
  54. # ---------------------------------------------------------------------------
  55. MINIMAL_SPOOL = {
  56. "id": 1,
  57. "filament": {
  58. "material": "PLA",
  59. "name": "PLA Basic",
  60. "color_hex": "FF0000",
  61. "weight": 1000.0,
  62. "vendor": {"name": "Bambu Lab"},
  63. },
  64. "used_weight": 250.0,
  65. "archived": False,
  66. "registered": "2024-01-01T00:00:00Z",
  67. }
  68. class TestMapSpoolmanSpool:
  69. def test_basic_mapping(self):
  70. result = _map_spoolman_spool(MINIMAL_SPOOL)
  71. assert result["id"] == 1
  72. assert result["material"] == "PLA"
  73. assert result["rgba"] == "FF0000FF"
  74. assert result["label_weight"] == 1000
  75. # No remaining_weight set → fallback path: weight_used = used_weight, baseline = 0.
  76. assert result["weight_used"] == pytest.approx(250.0)
  77. assert result["weight_used_baseline"] == pytest.approx(0.0)
  78. assert result["data_origin"] == "spoolman"
  79. def test_article_number_maps_to_material_number(self):
  80. """Spoolman's filament.article_number is the material number (#2870)."""
  81. spool = {**MINIMAL_SPOOL, "filament": {**MINIMAL_SPOOL["filament"], "article_number": "15"}}
  82. assert _map_spoolman_spool(spool)["material_number"] == "15"
  83. def test_missing_or_blank_article_number_maps_to_none(self):
  84. assert _map_spoolman_spool(MINIMAL_SPOOL)["material_number"] is None
  85. for value in ("", " "):
  86. blank = {**MINIMAL_SPOOL, "filament": {**MINIMAL_SPOOL["filament"], "article_number": value}}
  87. assert _map_spoolman_spool(blank)["material_number"] is None
  88. def test_padded_article_number_is_trimmed(self):
  89. """The filter chip matches exactly against trimmed options (#2870)."""
  90. spool = {**MINIMAL_SPOOL, "filament": {**MINIMAL_SPOOL["filament"], "article_number": " 15 "}}
  91. assert _map_spoolman_spool(spool)["material_number"] == "15"
  92. def test_remaining_weight_drives_synthetic_used_for_parity(self):
  93. """When remaining_weight is set, weight_used = label - remaining and
  94. the baseline absorbs the used_weight delta. This mirrors the internal
  95. Spool model's split between consumed counter and physical depletion
  96. so the frontend computes the same display in both modes (#1390).
  97. """
  98. spool = {**MINIMAL_SPOOL, "used_weight": 250.0, "remaining_weight": 544.0}
  99. result = _map_spoolman_spool(spool)
  100. # Remaining = label - weight_used must equal real remaining_weight.
  101. assert result["label_weight"] - result["weight_used"] == pytest.approx(544.0)
  102. # Consumed = weight_used - baseline must equal real used_weight.
  103. assert result["weight_used"] - result["weight_used_baseline"] == pytest.approx(250.0)
  104. def test_remaining_weight_after_reset(self):
  105. """Spoolman reset: used_weight=0, remaining_weight unchanged. The
  106. mapper produces baseline = weight_used so the displayed consumed
  107. counter reads 0 while remaining stays at the real value.
  108. """
  109. spool = {**MINIMAL_SPOOL, "used_weight": 0.0, "remaining_weight": 544.0}
  110. result = _map_spoolman_spool(spool)
  111. assert result["weight_used"] == pytest.approx(456.0)
  112. assert result["weight_used_baseline"] == pytest.approx(456.0)
  113. assert result["weight_used"] - result["weight_used_baseline"] == pytest.approx(0.0)
  114. assert result["label_weight"] - result["weight_used"] == pytest.approx(544.0)
  115. def test_missing_id_raises(self):
  116. spool = {k: v for k, v in MINIMAL_SPOOL.items() if k != "id"}
  117. with pytest.raises(ValueError, match="missing required 'id'"):
  118. _map_spoolman_spool(spool)
  119. def test_none_id_raises(self):
  120. with pytest.raises(ValueError):
  121. _map_spoolman_spool({**MINIMAL_SPOOL, "id": None})
  122. def test_string_id_raises(self):
  123. with pytest.raises(ValueError, match="not a valid integer"):
  124. _map_spoolman_spool({**MINIMAL_SPOOL, "id": "abc"})
  125. def test_zero_id_raises(self):
  126. with pytest.raises(ValueError, match="positive integer"):
  127. _map_spoolman_spool({**MINIMAL_SPOOL, "id": 0})
  128. def test_negative_id_raises(self):
  129. with pytest.raises(ValueError, match="positive integer"):
  130. _map_spoolman_spool({**MINIMAL_SPOOL, "id": -5})
  131. def test_numeric_string_id_accepted(self):
  132. result = _map_spoolman_spool({**MINIMAL_SPOOL, "id": "42"})
  133. assert result["id"] == 42
  134. def test_zero_price_not_converted_to_none(self):
  135. spool = {**MINIMAL_SPOOL, "price": 0.0}
  136. result = _map_spoolman_spool(spool)
  137. assert result["cost_per_kg"] == 0.0
  138. def test_nonzero_price_preserved(self):
  139. spool = {**MINIMAL_SPOOL, "price": 9.99}
  140. result = _map_spoolman_spool(spool)
  141. assert result["cost_per_kg"] == pytest.approx(9.99)
  142. def test_none_price_stays_none(self):
  143. spool = {**MINIMAL_SPOOL, "price": None}
  144. result = _map_spoolman_spool(spool)
  145. assert result["cost_per_kg"] is None
  146. def test_infinity_weight_falls_back(self):
  147. spool = {**MINIMAL_SPOOL, "filament": {**MINIMAL_SPOOL["filament"], "weight": math.inf}}
  148. result = _map_spoolman_spool(spool)
  149. assert result["label_weight"] == 1000
  150. def test_nan_used_weight_falls_back(self):
  151. spool = {**MINIMAL_SPOOL, "used_weight": math.nan}
  152. result = _map_spoolman_spool(spool)
  153. assert result["weight_used"] == 0.0
  154. def test_invalid_color_hex_falls_back_to_grey(self):
  155. spool = {**MINIMAL_SPOOL, "filament": {**MINIMAL_SPOOL["filament"], "color_hex": "ZZZZZZ"}}
  156. result = _map_spoolman_spool(spool)
  157. assert result["rgba"] == "808080FF"
  158. def test_short_color_hex_falls_back(self):
  159. spool = {**MINIMAL_SPOOL, "filament": {**MINIMAL_SPOOL["filament"], "color_hex": "FFF"}}
  160. result = _map_spoolman_spool(spool)
  161. assert result["rgba"] == "808080FF"
  162. def test_eight_char_color_hex_is_read_back_with_its_alpha(self):
  163. """#2912: 8-char color_hex is a value the write side stores on purpose for a
  164. translucent spool, so the read must return it rather than grey it out.
  165. This test previously asserted the opposite, on the premise that only 6-char
  166. hex was valid from Spoolman. Spoolman stores whatever it is given, and
  167. Bambuddy's own rgba fields advertise RRGGBBAA — the read was what turned a
  168. clear spool into neutral grey.
  169. """
  170. spool = {**MINIMAL_SPOOL, "filament": {**MINIMAL_SPOOL["filament"], "color_hex": "FF000080"}}
  171. result = _map_spoolman_spool(spool)
  172. assert result["rgba"] == "FF000080"
  173. def test_fully_transparent_color_hex_survives_the_read(self):
  174. """The reported case: a clear spool stored as 00000000 must not come back
  175. as opaque black."""
  176. spool = {**MINIMAL_SPOOL, "filament": {**MINIMAL_SPOOL["filament"], "color_hex": "00000000"}}
  177. result = _map_spoolman_spool(spool)
  178. assert result["rgba"] == "00000000"
  179. def test_six_char_color_hex_still_gains_the_opaque_alpha(self):
  180. """Existing data is 6-char and must keep round-tripping unchanged — the
  181. opaque byte is appended, not doubled onto an alpha that is already there."""
  182. spool = {**MINIMAL_SPOOL, "filament": {**MINIMAL_SPOOL["filament"], "color_hex": "FF0000"}}
  183. result = _map_spoolman_spool(spool)
  184. assert result["rgba"] == "FF0000FF"
  185. def test_seven_char_color_hex_falls_back(self):
  186. """Only 6 or 8 are valid lengths; a 7-char value is malformed and still
  187. greys out rather than being padded into something plausible."""
  188. spool = {**MINIMAL_SPOOL, "filament": {**MINIMAL_SPOOL["filament"], "color_hex": "FF0000F"}}
  189. result = _map_spoolman_spool(spool)
  190. assert result["rgba"] == "808080FF"
  191. def test_color_name_uses_explicit_field_when_present(self):
  192. """When Spoolman's filament has color_name set, that wins over the subtype fallback."""
  193. spool = {
  194. **MINIMAL_SPOOL,
  195. "filament": {**MINIMAL_SPOOL["filament"], "color_name": "Sunrise Orange"},
  196. }
  197. result = _map_spoolman_spool(spool)
  198. assert result["color_name"] == "Sunrise Orange"
  199. # Real stored value — not synthesised from subtype.
  200. assert result["color_name_is_synthesized"] is False
  201. def test_color_name_flags_synthesized_when_falling_back_to_subtype(self):
  202. """#1319: when the read falls back to subtype, the response must flag it
  203. so the edit form doesn't round-trip the synth value back to Spoolman."""
  204. spool = {
  205. **MINIMAL_SPOOL,
  206. "filament": {
  207. **MINIMAL_SPOOL["filament"],
  208. "name": "PLA Basic Red",
  209. # No color_name field.
  210. },
  211. }
  212. result = _map_spoolman_spool(spool)
  213. assert result["color_name"] == "Basic Red"
  214. assert result["color_name_is_synthesized"] is True
  215. def test_color_name_falls_back_to_subtype_when_field_missing(self):
  216. """Spoolman doesn't standardise color_name; the LinkSpoolModal would
  217. otherwise show 'Unknown color' for every Spoolman spool. The mapper
  218. falls back to the filament's name minus material prefix (which the
  219. subtype field already carries) so the user can tell spools apart at a
  220. glance even on installs that don't fill color_name.
  221. """
  222. spool = {
  223. **MINIMAL_SPOOL,
  224. "filament": {
  225. **MINIMAL_SPOOL["filament"],
  226. "name": "PLA Basic Red",
  227. # No color_name field — the common case for default Spoolman installs.
  228. },
  229. }
  230. result = _map_spoolman_spool(spool)
  231. # subtype is filament_name minus material prefix → "Basic Red"
  232. assert result["subtype"] == "Basic Red"
  233. # color_name falls back to subtype.
  234. assert result["color_name"] == "Basic Red"
  235. def test_color_name_read_from_spool_extra_first(self):
  236. """#1357: the canonical store for color_name is
  237. spool.extra.bambu_color_name (JSON-encoded). Read priority is
  238. extra > filament.color_name > subtype-synth. The user's
  239. Bambuddy-saved value MUST win even when Spoolman's own
  240. filament.color_name happens to be populated from some other source.
  241. """
  242. spool = {
  243. **MINIMAL_SPOOL,
  244. "extra": {"bambu_color_name": '"Galaxy Black"'},
  245. "filament": {
  246. **MINIMAL_SPOOL["filament"],
  247. "name": "PLA Glow",
  248. "color_name": "Glow", # would be picked up if extra weren't preferred
  249. },
  250. }
  251. result = _map_spoolman_spool(spool)
  252. assert result["color_name"] == "Galaxy Black"
  253. assert result["color_name_is_synthesized"] is False
  254. def test_color_name_empty_extra_falls_through_to_filament(self):
  255. """An explicit empty string in spool.extra.bambu_color_name (the
  256. "user cleared the field" shape) must NOT mask Spoolman's own
  257. filament.color_name if one exists — it falls through to the next
  258. layer instead of suppressing it."""
  259. spool = {
  260. **MINIMAL_SPOOL,
  261. "extra": {"bambu_color_name": '""'},
  262. "filament": {
  263. **MINIMAL_SPOOL["filament"],
  264. "color_name": "Sunset",
  265. },
  266. }
  267. result = _map_spoolman_spool(spool)
  268. assert result["color_name"] == "Sunset"
  269. assert result["color_name_is_synthesized"] is False
  270. def test_color_name_empty_extra_falls_through_to_synth(self):
  271. """When extra is cleared and filament has no color_name either,
  272. fall all the way through to the subtype synth — same UX as a fresh
  273. Spoolman install."""
  274. spool = {
  275. **MINIMAL_SPOOL,
  276. "extra": {"bambu_color_name": '""'},
  277. "filament": {
  278. **MINIMAL_SPOOL["filament"],
  279. "name": "PLA Basic Red",
  280. },
  281. }
  282. result = _map_spoolman_spool(spool)
  283. assert result["color_name"] == "Basic Red"
  284. assert result["color_name_is_synthesized"] is True
  285. def test_color_name_none_when_both_fields_empty(self):
  286. """If neither color_name nor a usable subtype exists, return None — UI
  287. falls back to its own 'Unknown color' string rather than showing a
  288. misleading material-only label.
  289. """
  290. spool = {
  291. **MINIMAL_SPOOL,
  292. "filament": {
  293. **MINIMAL_SPOOL["filament"],
  294. "name": "PLA", # name == material → subtype becomes None
  295. },
  296. }
  297. result = _map_spoolman_spool(spool)
  298. assert result["subtype"] is None
  299. assert result["color_name"] is None
  300. # No synth happened — nothing to fall back to.
  301. assert result["color_name_is_synthesized"] is False
  302. def test_color_hex_with_hash_prefix_stripped(self):
  303. spool = {**MINIMAL_SPOOL, "filament": {**MINIMAL_SPOOL["filament"], "color_hex": "#00FF00"}}
  304. result = _map_spoolman_spool(spool)
  305. assert result["rgba"] == "00FF00FF"
  306. def test_color_hex_lowercase_normalised(self):
  307. spool = {**MINIMAL_SPOOL, "filament": {**MINIMAL_SPOOL["filament"], "color_hex": "ff0000"}}
  308. result = _map_spoolman_spool(spool)
  309. assert result["rgba"] == "FF0000FF"
  310. def test_none_filament(self):
  311. spool = {**MINIMAL_SPOOL, "filament": None}
  312. result = _map_spoolman_spool(spool)
  313. assert result["material"] == ""
  314. assert result["rgba"] == "808080FF"
  315. assert result["label_weight"] == 1000
  316. def test_archived_spool_has_archived_at(self):
  317. spool = {**MINIMAL_SPOOL, "archived": True}
  318. result = _map_spoolman_spool(spool)
  319. assert result["archived_at"] is not None
  320. def test_subtype_strips_material_prefix(self):
  321. spool = {**MINIMAL_SPOOL, "filament": {**MINIMAL_SPOOL["filament"], "material": "PLA", "name": "PLA Basic"}}
  322. result = _map_spoolman_spool(spool)
  323. assert result["subtype"] == "Basic"
  324. def test_brand_from_vendor(self):
  325. result = _map_spoolman_spool(MINIMAL_SPOOL)
  326. assert result["brand"] == "Bambu Lab"
  327. def test_no_vendor_brand_is_none(self):
  328. spool = {**MINIMAL_SPOOL, "filament": {**MINIMAL_SPOOL["filament"], "vendor": None}}
  329. result = _map_spoolman_spool(spool)
  330. assert result["brand"] is None
  331. def test_spoolman_location_mapped_to_storage_location(self):
  332. spool = {**MINIMAL_SPOOL, "location": "Shelf A"}
  333. result = _map_spoolman_spool(spool)
  334. assert result["storage_location"] == "Shelf A"
  335. def test_no_location_gives_none_storage_location(self):
  336. result = _map_spoolman_spool(MINIMAL_SPOOL)
  337. assert result["storage_location"] is None
  338. def test_empty_location_gives_none_storage_location(self):
  339. spool = {**MINIMAL_SPOOL, "location": ""}
  340. result = _map_spoolman_spool(spool)
  341. assert result["storage_location"] is None
  342. def test_spoolman_location_key_not_in_result(self):
  343. spool = {**MINIMAL_SPOOL, "location": "Shelf A"}
  344. result = _map_spoolman_spool(spool)
  345. assert "spoolman_location" not in result
  346. def test_core_weight_from_filament_spool_weight(self):
  347. spool = {**MINIMAL_SPOOL, "filament": {**MINIMAL_SPOOL["filament"], "spool_weight": 196}}
  348. result = _map_spoolman_spool(spool)
  349. assert result["core_weight"] == 196
  350. def test_core_weight_fallback_when_spool_weight_missing(self):
  351. result = _map_spoolman_spool(MINIMAL_SPOOL)
  352. assert result["core_weight"] == 250
  353. def test_core_weight_fallback_when_spool_weight_none(self):
  354. spool = {**MINIMAL_SPOOL, "filament": {**MINIMAL_SPOOL["filament"], "spool_weight": None}}
  355. result = _map_spoolman_spool(spool)
  356. assert result["core_weight"] == 250
  357. def test_core_weight_float_truncated_to_int(self):
  358. spool = {**MINIMAL_SPOOL, "filament": {**MINIMAL_SPOOL["filament"], "spool_weight": 180.9}}
  359. result = _map_spoolman_spool(spool)
  360. assert result["core_weight"] == 180
  361. def test_spool_level_spool_weight_takes_priority_over_filament(self):
  362. spool = {**MINIMAL_SPOOL, "spool_weight": 300, "filament": {**MINIMAL_SPOOL["filament"], "spool_weight": 196}}
  363. assert _map_spoolman_spool(spool)["core_weight"] == 300
  364. def test_spool_level_zero_spool_weight_not_treated_as_missing(self):
  365. spool = {**MINIMAL_SPOOL, "spool_weight": 0, "filament": {**MINIMAL_SPOOL["filament"], "spool_weight": 196}}
  366. assert _map_spoolman_spool(spool)["core_weight"] == 0
  367. def test_spool_level_none_falls_back_to_filament(self):
  368. spool = {**MINIMAL_SPOOL, "spool_weight": None, "filament": {**MINIMAL_SPOOL["filament"], "spool_weight": 196}}
  369. assert _map_spoolman_spool(spool)["core_weight"] == 196
  370. @pytest.mark.parametrize(
  371. ("spool_level", "inherited"),
  372. [(180, False), (0, False), (None, True), ("absent", True)],
  373. )
  374. def test_core_weight_is_inherited_says_whose_tare_it_is(self, spool_level, inherited):
  375. """The spool form copies an own tare onto a copy and leaves an
  376. inherited one alone (#2908). 0 is an own tare, not a missing one."""
  377. spool = {**MINIMAL_SPOOL, "filament": {**MINIMAL_SPOOL["filament"], "spool_weight": 196}}
  378. if spool_level != "absent":
  379. spool["spool_weight"] = spool_level
  380. assert _map_spoolman_spool(spool)["core_weight_is_inherited"] is inherited
  381. def test_spool_level_absent_falls_back_to_filament(self):
  382. spool = {**MINIMAL_SPOOL, "filament": {**MINIMAL_SPOOL["filament"], "spool_weight": 196}}
  383. assert _map_spoolman_spool(spool)["core_weight"] == 196
  384. def test_both_levels_none_uses_fallback(self):
  385. spool = {**MINIMAL_SPOOL, "spool_weight": None, "filament": {**MINIMAL_SPOOL["filament"], "spool_weight": None}}
  386. assert _map_spoolman_spool(spool)["core_weight"] == 250
  387. def test_core_weight_from_vendor_empty_spool_weight(self):
  388. """Spoolman's third tare level is the vendor's empty_spool_weight (#3195)."""
  389. spool = {
  390. **MINIMAL_SPOOL,
  391. "spool_weight": None,
  392. "filament": {**MINIMAL_SPOOL["filament"], "spool_weight": None, "vendor": {"empty_spool_weight": 211.7}},
  393. }
  394. result = _map_spoolman_spool(spool)
  395. assert result["core_weight"] == 211
  396. # Still inherited: the spool has no tare of its own, so the form must not stamp it.
  397. assert result["core_weight_is_inherited"] is True
  398. class TestSpoolmanTare:
  399. """spoolman_tare resolves the tare the way Spoolman's /measure does (#3195)."""
  400. @staticmethod
  401. def _spool(spool_level=None, filament_level=None, vendor_level=None, vendor=True):
  402. filament: dict = {"spool_weight": filament_level}
  403. if vendor:
  404. filament["vendor"] = {"id": 5, "name": "Sunlu", "empty_spool_weight": vendor_level}
  405. return {"id": 1, "spool_weight": spool_level, "filament": filament}
  406. @pytest.mark.parametrize(
  407. ("levels", "expected"),
  408. [
  409. ((300.0, 180.0, 211.7), (300.0, "spool")),
  410. ((None, 180.0, 211.7), (180.0, "filament")),
  411. ((None, None, 211.7), (211.7, "vendor")),
  412. ((None, None, None), (250.0, "fallback")),
  413. ],
  414. )
  415. def test_resolution_order(self, levels, expected):
  416. assert spoolman_tare(self._spool(*levels)) == expected
  417. @pytest.mark.parametrize("level", ["spool", "filament", "vendor"])
  418. def test_zero_is_a_real_tare_at_every_level(self, level):
  419. levels = {"spool": (0, 180.0, 211.7), "filament": (None, 0, 211.7), "vendor": (None, None, 0)}[level]
  420. assert spoolman_tare(self._spool(*levels)) == (0.0, level)
  421. @pytest.mark.parametrize("bad", [float("nan"), float("inf"), "abc"])
  422. def test_non_finite_value_counts_as_missing(self, bad):
  423. assert spoolman_tare(self._spool(bad, None, 211.7)) == (211.7, "vendor")
  424. def test_missing_vendor_null_vendor_and_null_filament(self):
  425. assert spoolman_tare(self._spool(vendor=False)) == (250.0, "fallback")
  426. assert spoolman_tare({"id": 1, "filament": {"vendor": None}}) == (250.0, "fallback")
  427. assert spoolman_tare({"id": 1, "filament": None}) == (250.0, "fallback")
  428. assert spoolman_tare({"id": 1}) == (250.0, "fallback")
  429. # ---------------------------------------------------------------------------
  430. # F4: _safe_optional_float unit tests
  431. # ---------------------------------------------------------------------------
  432. class TestSafeOptionalFloat:
  433. """F4: Direct unit tests for _safe_optional_float (NaN/Inf safety)."""
  434. def test_normal_value(self):
  435. import pytest
  436. from backend.app.api.routes._spoolman_helpers import _safe_optional_float
  437. assert _safe_optional_float(9.99) == pytest.approx(9.99)
  438. def test_none_returns_none(self):
  439. from backend.app.api.routes._spoolman_helpers import _safe_optional_float
  440. assert _safe_optional_float(None) is None
  441. def test_nan_returns_none(self):
  442. import math
  443. from backend.app.api.routes._spoolman_helpers import _safe_optional_float
  444. assert _safe_optional_float(math.nan) is None
  445. def test_inf_returns_none(self):
  446. import math
  447. from backend.app.api.routes._spoolman_helpers import _safe_optional_float
  448. assert _safe_optional_float(math.inf) is None
  449. def test_neg_inf_returns_none(self):
  450. import math
  451. from backend.app.api.routes._spoolman_helpers import _safe_optional_float
  452. assert _safe_optional_float(-math.inf) is None
  453. def test_zero_returns_zero(self):
  454. from backend.app.api.routes._spoolman_helpers import _safe_optional_float
  455. assert _safe_optional_float(0.0) == 0.0
  456. def test_string_numeric(self):
  457. import pytest
  458. from backend.app.api.routes._spoolman_helpers import _safe_optional_float
  459. assert _safe_optional_float("3.14") == pytest.approx(3.14)
  460. def test_string_non_numeric_returns_none(self):
  461. from backend.app.api.routes._spoolman_helpers import _safe_optional_float
  462. assert _safe_optional_float("bad") is None
  463. class TestMapSpoolmanSpoolSlicerFilament:
  464. """slicer_filament round-trip via Spoolman extra dict.
  465. Spoolman has no native slicer_filament field, so we persist BambuStudio
  466. presets under bambu_slicer_filament[_name] keys in the spool's extra
  467. dict (JSON-encoded strings, like every Spoolman extra value). The map
  468. function unwraps those values and exposes them as slicer_filament /
  469. slicer_filament_name on the InventorySpool shape. Without this round-trip
  470. the user's selected slicer preset is silently dropped on save (#1114).
  471. """
  472. def test_slicer_filament_unwrapped_from_extra(self):
  473. spool = {
  474. **MINIMAL_SPOOL,
  475. "extra": {
  476. "bambu_slicer_filament": '"PFUSf543b298f8ea66"',
  477. "bambu_slicer_filament_name": '"Devil Design PLA Basic @Bambu Lab H2D 0.4 nozzle (Custom)"',
  478. },
  479. }
  480. result = _map_spoolman_spool(spool)
  481. assert result["slicer_filament"] == "PFUSf543b298f8ea66"
  482. assert result["slicer_filament_name"] == "Devil Design PLA Basic @Bambu Lab H2D 0.4 nozzle (Custom)"
  483. def test_slicer_filament_falls_back_to_filament_name(self):
  484. # Spool has no bambu_slicer_filament_name override → use Spoolman's filament.name
  485. spool = {**MINIMAL_SPOOL, "extra": {}}
  486. result = _map_spoolman_spool(spool)
  487. assert result["slicer_filament"] is None
  488. assert result["slicer_filament_name"] == "PLA Basic" # from filament.name
  489. def test_empty_string_extra_treated_as_unset(self):
  490. # JSON-encoded empty string is how the user clears the field
  491. spool = {
  492. **MINIMAL_SPOOL,
  493. "extra": {
  494. "bambu_slicer_filament": '""',
  495. "bambu_slicer_filament_name": '""',
  496. },
  497. }
  498. result = _map_spoolman_spool(spool)
  499. assert result["slicer_filament"] is None
  500. # Falls back to filament.name when the override is cleared
  501. assert result["slicer_filament_name"] == "PLA Basic"
  502. def test_non_json_extra_value_passed_through(self):
  503. # Tolerate bare-string values written without JSON encoding
  504. # (older data, manual writes via Spoolman UI, etc.)
  505. spool = {
  506. **MINIMAL_SPOOL,
  507. "extra": {"bambu_slicer_filament": "GFL05"},
  508. }
  509. result = _map_spoolman_spool(spool)
  510. assert result["slicer_filament"] == "GFL05"
  511. class TestExtractExtraStr:
  512. """JSON-encoded extra-string unwrapper used by _map_spoolman_spool."""
  513. def test_unwraps_quoted_string(self):
  514. from backend.app.api.routes._spoolman_helpers import _extract_extra_str
  515. assert _extract_extra_str({"k": '"hello"'}, "k") == "hello"
  516. def test_returns_empty_for_missing_key(self):
  517. from backend.app.api.routes._spoolman_helpers import _extract_extra_str
  518. assert _extract_extra_str({}, "k") == ""
  519. def test_returns_empty_for_non_string_value(self):
  520. from backend.app.api.routes._spoolman_helpers import _extract_extra_str
  521. # Spoolman extra values are stringified; numeric values shouldn't sneak in
  522. # but if they do we treat them as unset rather than crashing
  523. assert _extract_extra_str({"k": 42}, "k") == ""
  524. def test_returns_empty_for_json_null(self):
  525. from backend.app.api.routes._spoolman_helpers import _extract_extra_str
  526. # null isn't a string after decode → treat as unset
  527. assert _extract_extra_str({"k": "null"}, "k") == ""
  528. def test_passes_through_bare_string_on_decode_error(self):
  529. from backend.app.api.routes._spoolman_helpers import _extract_extra_str
  530. # Tolerate non-JSON-encoded values
  531. assert _extract_extra_str({"k": "GFL05"}, "k") == "GFL05"
  532. class TestMapSpoolmanSpoolPrice:
  533. """F4: NaN/Inf price in _map_spoolman_spool gives None cost_per_kg."""
  534. def test_nan_price_gives_none_cost_per_kg(self):
  535. import math
  536. from backend.app.api.routes._spoolman_helpers import _map_spoolman_spool
  537. spool = {**MINIMAL_SPOOL, "price": math.nan}
  538. assert _map_spoolman_spool(spool)["cost_per_kg"] is None
  539. def test_inf_price_gives_none_cost_per_kg(self):
  540. import math
  541. from backend.app.api.routes._spoolman_helpers import _map_spoolman_spool
  542. spool = {**MINIMAL_SPOOL, "price": math.inf}
  543. assert _map_spoolman_spool(spool)["cost_per_kg"] is None