mirror of
https://github.com/maziggy/bambuddy.git
synced 2026-09-30 03:01:21 +02:00
maziggy
72044e3a53
When a print targets a single plate from a multi-plate 3MF, both the
internal Filament Inventory tracker and the Spoolman-mode tracker parsed
the 3MF without a plate filter and summed every plate's filament — so a
single lid print debited the spool the entire file's grey + black totals.
The 3MF parser already supports plate_id (queue pre-flight uses it at
print_queue.py:254/:286). Plumbed it through both dispatch paths:
Queue path:
- PrintSession gains a plate_id field; on_print_start queries the
printer's currently-printing queue row and records queue_item.plate_id
onto the session.
- _track_from_3mf accepts plate_id and passes it to the extractor.
- store_print_data moves its existing queue-item lookup above the
extract and uses queue_item.plate_id as the plate filter.
Direct-Print path (reprintArchive / printLibraryFile — never goes
through the queue):
- _print_plate_ids dict added in main.py, parallel to _print_ams_mappings.
- register_expected_print accepts plate_id and stores it; the 2 sites in
background_dispatch.py and the 1 site in print_scheduler.py now pass
it (resolve was already happening, just needed reordering before the
register call so the value is available).
- Expected-print promotion in main.py injects _print_plate_ids[archive_id]
into the session, guarded so a queue capture wins over the dict.
- _get_start_plate_id helper feeds plate_id into all 3
_store_spoolman_print_data call sites; spoolman_tracking.store_print_data
takes the caller value first, falls back to queue_item.plate_id.
PrintArchive.filament_used_grams stays file-level summed by design
(#1593's contract — the archive describes the file, not the run); only
the per-run usage attribution becomes plate-aware. Single-plate direct
prints resolve to plate_id=1 → plate 1 = whole file, identical to the
prior no-filter behaviour.
377 lines
15 KiB
Python
377 lines
15 KiB
Python
"""Unit tests for Spoolman tracking service helpers."""
|
|
|
|
import json
|
|
from types import SimpleNamespace
|
|
from unittest.mock import AsyncMock, MagicMock, patch
|
|
|
|
import pytest
|
|
|
|
from backend.app.services.spoolman_tracking import (
|
|
_apply_spool_colors_to_archive,
|
|
_get_fallback_spool_tag,
|
|
_global_tray_id_to_ams_slot,
|
|
_hash_serial_to_hex32,
|
|
_resolve_global_tray_id,
|
|
_resolve_spool_tag,
|
|
build_ams_tray_lookup,
|
|
store_print_data,
|
|
)
|
|
|
|
|
|
class TestResolveSpoolTag:
|
|
"""Tests for _resolve_spool_tag()."""
|
|
|
|
def test_prefers_tray_uuid_over_tag_uid(self):
|
|
tray = {"tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4", "tag_uid": "DEADBEEF"}
|
|
assert _resolve_spool_tag(tray) == "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"
|
|
|
|
def test_falls_back_to_tag_uid_when_no_uuid(self):
|
|
tray = {"tray_uuid": "", "tag_uid": "DEADBEEF"}
|
|
assert _resolve_spool_tag(tray) == "DEADBEEF"
|
|
|
|
def test_falls_back_to_tag_uid_when_uuid_zero(self):
|
|
tray = {"tray_uuid": "00000000000000000000000000000000", "tag_uid": "DEADBEEF"}
|
|
assert _resolve_spool_tag(tray) == "DEADBEEF"
|
|
|
|
def test_rejects_zero_tag_uid(self):
|
|
tray = {"tray_uuid": "", "tag_uid": "0000000000000000"}
|
|
assert _resolve_spool_tag(tray) == ""
|
|
|
|
def test_uses_fallback_tag_when_ids_missing(self):
|
|
tray = {"tray_uuid": "", "tag_uid": ""}
|
|
# global_tray_id 0 -> ams_id 0, tray_id 0
|
|
assert _resolve_spool_tag(tray, "01P00A000000000", 0) == "ABA7845700000000"
|
|
|
|
def test_uses_fallback_tag_when_ids_zero(self):
|
|
tray = {"tray_uuid": "00000000000000000000000000000000", "tag_uid": "0000000000000000"}
|
|
# global_tray_id 5 -> ams_id 1, tray_id 1
|
|
assert _resolve_spool_tag(tray, "01P00A000000000", 5) == "ABA7845700010001"
|
|
|
|
def test_prefers_tray_uuid_over_fallback_when_non_zero(self):
|
|
tray = {"tray_uuid": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4", "tag_uid": ""}
|
|
assert _resolve_spool_tag(tray, "01P00A000000000", 0) == "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"
|
|
|
|
def test_empty_both(self):
|
|
tray = {"tray_uuid": "", "tag_uid": ""}
|
|
assert _resolve_spool_tag(tray) == ""
|
|
|
|
def test_missing_keys(self):
|
|
assert _resolve_spool_tag({}) == ""
|
|
|
|
def test_zero_uuid_no_tag(self):
|
|
tray = {"tray_uuid": "00000000000000000000000000000000", "tag_uid": ""}
|
|
assert _resolve_spool_tag(tray) == ""
|
|
|
|
|
|
class TestResolveGlobalTrayId:
|
|
"""Tests for _resolve_global_tray_id()."""
|
|
|
|
def test_default_mapping(self):
|
|
"""slot 1 -> tray 0, slot 2 -> tray 1, etc."""
|
|
assert _resolve_global_tray_id(1, None) == 0
|
|
assert _resolve_global_tray_id(2, None) == 1
|
|
assert _resolve_global_tray_id(4, None) == 3
|
|
|
|
def test_custom_mapping(self):
|
|
"""Custom slot_to_tray overrides default."""
|
|
mapping = [5, 2, -1, 0]
|
|
assert _resolve_global_tray_id(1, mapping) == 5
|
|
assert _resolve_global_tray_id(2, mapping) == 2
|
|
assert _resolve_global_tray_id(4, mapping) == 0
|
|
|
|
def test_unmapped_slot(self):
|
|
"""Slot with -1 in mapping uses default."""
|
|
mapping = [5, -1, 2, 0]
|
|
assert _resolve_global_tray_id(2, mapping) == 1 # default: slot 2 -> tray 1
|
|
|
|
def test_slot_beyond_mapping(self):
|
|
"""Slot beyond mapping length uses default."""
|
|
mapping = [5, 2]
|
|
assert _resolve_global_tray_id(3, mapping) == 2 # default: slot 3 -> tray 2
|
|
|
|
def test_empty_mapping(self):
|
|
mapping = []
|
|
assert _resolve_global_tray_id(1, mapping) == 0
|
|
|
|
def test_minus_one_resolves_to_external_spool_when_present(self):
|
|
"""#1276 (regression of #853): -1 in slot_to_tray is BambuStudio's
|
|
encoding for "external spool used" — look up the external spool in
|
|
ams_trays rather than falling through to the position-based default
|
|
(which would credit an unrelated AMS tray). Reporter ojimpo's H2S
|
|
had AMS slot 0 occupied with PLA and ran a TPU external-spool print;
|
|
the bug credited the TPU usage to the PLA spool.
|
|
"""
|
|
# Single external spool (most common: H2S/X1C/P1S + external)
|
|
assert _resolve_global_tray_id(1, [-1], ams_trays={254: {}}) == 254
|
|
# AMS occupied with material AND external in use — fix prevents
|
|
# crediting AMS slot 0 (the actual bug from #1276)
|
|
assert _resolve_global_tray_id(1, [-1], ams_trays={0: {}, 1: {}, 2: {}, 3: {}, 254: {}}) == 254
|
|
# H2D-style deputy nozzle at 255
|
|
assert _resolve_global_tray_id(1, [-1], ams_trays={0: {}, 255: {}}) == 255
|
|
# Both external slots present (multi-nozzle) — prefer 254 (main on
|
|
# single-nozzle, deputy on H2D — matches tray_now reporting)
|
|
assert _resolve_global_tray_id(1, [-1], ams_trays={254: {}, 255: {}}) == 254
|
|
|
|
def test_minus_one_falls_through_when_no_external_in_ams_trays(self):
|
|
"""If -1 is seen but ams_trays has no external spool (254/255),
|
|
fall through to position-based default (legacy behavior preserved
|
|
for callers that don't pass ams_trays or pre-fix call sites).
|
|
"""
|
|
# ams_trays without external — fall through to legacy behavior
|
|
assert _resolve_global_tray_id(1, [-1], ams_trays={0: {}, 1: {}}) == 0
|
|
# No ams_trays passed at all — legacy fallback
|
|
assert _resolve_global_tray_id(1, [-1]) == 0
|
|
|
|
|
|
class TestFallbackTagHelpers:
|
|
"""Tests for frontend-mirrored fallback tag helpers."""
|
|
|
|
def test_hash_serial_matches_frontend_algorithm(self):
|
|
assert _hash_serial_to_hex32("01P00A000000000") == "ABA78457"
|
|
# Frontend trims and uppercases before hashing
|
|
assert _hash_serial_to_hex32(" 01p00a000000000 ") == "ABA78457"
|
|
|
|
def test_global_tray_to_ams_slot_standard_ams(self):
|
|
assert _global_tray_id_to_ams_slot(0) == (0, 0)
|
|
assert _global_tray_id_to_ams_slot(7) == (1, 3)
|
|
|
|
def test_global_tray_to_ams_slot_ams_ht(self):
|
|
assert _global_tray_id_to_ams_slot(128) == (128, 0)
|
|
assert _global_tray_id_to_ams_slot(135) == (135, 0)
|
|
|
|
def test_global_tray_to_ams_slot_external(self):
|
|
assert _global_tray_id_to_ams_slot(254) == (255, 0)
|
|
assert _global_tray_id_to_ams_slot(255) == (255, 1)
|
|
|
|
def test_get_fallback_spool_tag_standard(self):
|
|
assert _get_fallback_spool_tag("01P00A000000000", 5) == "ABA7845700010001"
|
|
|
|
def test_get_fallback_spool_tag_ams_ht(self):
|
|
assert _get_fallback_spool_tag("01P00A000000000", 128) == "ABA7845700800000"
|
|
|
|
def test_get_fallback_spool_tag_external(self):
|
|
assert _get_fallback_spool_tag("01P00A000000000", 255) == "ABA7845700FF0001"
|
|
|
|
|
|
class TestBuildAmsTrayLookup:
|
|
"""Tests for build_ams_tray_lookup()."""
|
|
|
|
def test_single_ams_unit(self):
|
|
raw = {
|
|
"ams": [
|
|
{
|
|
"id": 0,
|
|
"tray": [
|
|
{"id": 0, "tray_uuid": "AAA", "tag_uid": "111", "tray_type": "PLA"},
|
|
{"id": 1, "tray_uuid": "BBB", "tag_uid": "222", "tray_type": "ABS"},
|
|
],
|
|
}
|
|
]
|
|
}
|
|
lookup = build_ams_tray_lookup(raw)
|
|
assert lookup[0] == {"tray_uuid": "AAA", "tag_uid": "111", "tray_type": "PLA"}
|
|
assert lookup[1] == {"tray_uuid": "BBB", "tag_uid": "222", "tray_type": "ABS"}
|
|
|
|
def test_multiple_ams_units(self):
|
|
raw = {
|
|
"ams": [
|
|
{"id": 0, "tray": [{"id": 0, "tray_uuid": "A", "tag_uid": "", "tray_type": "PLA"}]},
|
|
{"id": 1, "tray": [{"id": 0, "tray_uuid": "B", "tag_uid": "", "tray_type": "PETG"}]},
|
|
]
|
|
}
|
|
lookup = build_ams_tray_lookup(raw)
|
|
assert 0 in lookup # AMS 0, tray 0
|
|
assert 4 in lookup # AMS 1, tray 0 (1*4+0)
|
|
assert lookup[4]["tray_uuid"] == "B"
|
|
|
|
def test_external_spool(self):
|
|
raw = {
|
|
"ams": [],
|
|
"vt_tray": [{"tray_uuid": "EXT", "tag_uid": "X", "tray_type": "TPU"}],
|
|
}
|
|
lookup = build_ams_tray_lookup(raw)
|
|
assert 254 in lookup
|
|
assert lookup[254]["tray_type"] == "TPU"
|
|
|
|
def test_empty_external_spool_skipped(self):
|
|
raw = {"ams": [], "vt_tray": [{"tray_type": ""}]}
|
|
lookup = build_ams_tray_lookup(raw)
|
|
assert 254 not in lookup
|
|
|
|
def test_no_ams_data(self):
|
|
assert build_ams_tray_lookup({}) == {}
|
|
assert build_ams_tray_lookup({"ams": []}) == {}
|
|
|
|
def test_missing_fields_default(self):
|
|
raw = {"ams": [{"id": 0, "tray": [{"id": 0}]}]}
|
|
lookup = build_ams_tray_lookup(raw)
|
|
assert lookup[0] == {"tray_uuid": "", "tag_uid": "", "tray_type": ""}
|
|
|
|
|
|
class TestStorePrintData:
|
|
"""Tests for store_print_data()."""
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_prefers_explicit_ams_mapping_over_queue_mapping(self):
|
|
db = AsyncMock()
|
|
# store_print_data now queries the queue item unconditionally (to pick up
|
|
# plate_id for multi-plate 3MFs, #1697), then deletes any stale spoolman
|
|
# row before inserting the new one. Two execute calls in that order.
|
|
queue_item = SimpleNamespace(ams_mapping=json.dumps([2, -1, -1, -1]), plate_id=None)
|
|
queue_result = MagicMock()
|
|
queue_result.scalar_one_or_none.return_value = queue_item
|
|
delete_result = MagicMock()
|
|
db.execute = AsyncMock(side_effect=[queue_result, delete_result])
|
|
db.add = MagicMock()
|
|
db.commit = AsyncMock()
|
|
|
|
printer_manager = MagicMock()
|
|
printer_manager.get_status.return_value = SimpleNamespace(
|
|
raw_data={"ams": [{"id": 0, "tray": [{"id": 0, "tray_type": "PLA"}, {"id": 1, "tray_type": "PLA"}]}]}
|
|
)
|
|
|
|
mock_settings = MagicMock()
|
|
mock_path = MagicMock()
|
|
mock_path.exists.return_value = True
|
|
mock_settings.base_dir.__truediv__.return_value = mock_path
|
|
|
|
with (
|
|
patch("backend.app.services.spoolman_tracking.app_settings", mock_settings),
|
|
patch("backend.app.api.routes.settings.get_setting", AsyncMock(side_effect=["true", "true"])),
|
|
patch(
|
|
"backend.app.utils.threemf_tools.extract_filament_usage_from_3mf",
|
|
return_value=[{"slot_id": 1, "used_g": 3.83, "type": "PLA", "color": "#FF0000"}],
|
|
),
|
|
patch("backend.app.utils.threemf_tools.extract_layer_filament_usage_from_3mf", return_value=None),
|
|
patch("backend.app.utils.threemf_tools.extract_filament_properties_from_3mf", return_value={}),
|
|
):
|
|
await store_print_data(
|
|
printer_id=1,
|
|
archive_id=15,
|
|
file_path="archives/test.3mf",
|
|
db=db,
|
|
printer_manager=printer_manager,
|
|
ams_mapping=[1, -1, -1, -1],
|
|
)
|
|
|
|
db.add.assert_called_once()
|
|
tracking = db.add.call_args.args[0]
|
|
assert tracking.slot_to_tray == [1, -1, -1, -1]
|
|
assert db.execute.await_count == 2
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_stores_tracking_when_disable_weight_sync_is_false(self):
|
|
"""#1119: per-print tracking must run regardless of disable_weight_sync.
|
|
|
|
Previously store_print_data short-circuited when the deprecated
|
|
`spoolman_disable_weight_sync` flag was off, leaving non-BL spools
|
|
with no weight-update path at all. Per-print tracking is now the
|
|
only weight writer for Spoolman, so it must run whenever Spoolman
|
|
is enabled.
|
|
"""
|
|
db = AsyncMock()
|
|
db.execute = AsyncMock(return_value=MagicMock())
|
|
db.add = MagicMock()
|
|
db.commit = AsyncMock()
|
|
|
|
printer_manager = MagicMock()
|
|
printer_manager.get_status.return_value = SimpleNamespace(
|
|
raw_data={"ams": [{"id": 0, "tray": [{"id": 0, "tray_type": "PLA"}]}]}
|
|
)
|
|
|
|
mock_settings = MagicMock()
|
|
mock_path = MagicMock()
|
|
mock_path.exists.return_value = True
|
|
mock_settings.base_dir.__truediv__.return_value = mock_path
|
|
|
|
# Only spoolman_enabled is consulted now (disable_weight_sync is no
|
|
# longer read). The single side_effect entry proves no extra
|
|
# get_setting calls slip back in.
|
|
with (
|
|
patch("backend.app.services.spoolman_tracking.app_settings", mock_settings),
|
|
patch("backend.app.api.routes.settings.get_setting", AsyncMock(side_effect=["true"])),
|
|
patch(
|
|
"backend.app.utils.threemf_tools.extract_filament_usage_from_3mf",
|
|
return_value=[{"slot_id": 1, "used_g": 5.0, "type": "PLA", "color": "#FF0000"}],
|
|
),
|
|
patch("backend.app.utils.threemf_tools.extract_layer_filament_usage_from_3mf", return_value=None),
|
|
patch("backend.app.utils.threemf_tools.extract_filament_properties_from_3mf", return_value={}),
|
|
):
|
|
await store_print_data(
|
|
printer_id=1,
|
|
archive_id=20,
|
|
file_path="archives/test.3mf",
|
|
db=db,
|
|
printer_manager=printer_manager,
|
|
ams_mapping=[0],
|
|
)
|
|
|
|
# Tracking row was inserted — the fix is working.
|
|
db.add.assert_called_once()
|
|
|
|
|
|
class TestApplySpoolColorsToArchive:
|
|
"""`_apply_spool_colors_to_archive` stamps the archive's filament_color
|
|
from the matched Spoolman spools (#1494) — the Spoolman-mode mirror of
|
|
the built-in inventory rewrite in usage_tracker."""
|
|
|
|
def _make_db(self, archive):
|
|
db = AsyncMock()
|
|
db.execute = AsyncMock(return_value=MagicMock(scalar_one_or_none=MagicMock(return_value=archive)))
|
|
return db
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_rewrites_color_from_spoolman_spool(self):
|
|
"""The #1494 case: 3MF said #161616, the Spoolman spool is 000000."""
|
|
archive = MagicMock()
|
|
archive.filament_color = "#161616"
|
|
db = self._make_db(archive)
|
|
|
|
await _apply_spool_colors_to_archive(
|
|
db,
|
|
archive_id=10,
|
|
filament_usage=[{"slot_id": 1, "used_g": 15.9}],
|
|
slot_colors={1: "000000"},
|
|
)
|
|
|
|
assert archive.filament_color == "#000000"
|
|
db.commit.assert_awaited()
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_empty_slot_colors_is_noop(self):
|
|
"""No resolved spool colours — never touches the DB."""
|
|
db = self._make_db(MagicMock())
|
|
await _apply_spool_colors_to_archive(
|
|
db, archive_id=10, filament_usage=[{"slot_id": 1, "used_g": 15.9}], slot_colors={}
|
|
)
|
|
db.execute.assert_not_awaited()
|
|
db.commit.assert_not_awaited()
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_partial_match_leaves_archive_untouched(self):
|
|
"""Slot 2 used but unresolved — keep the 3MF colour, don't load the archive."""
|
|
db = self._make_db(MagicMock())
|
|
await _apply_spool_colors_to_archive(
|
|
db,
|
|
archive_id=10,
|
|
filament_usage=[
|
|
{"slot_id": 1, "used_g": 10.0},
|
|
{"slot_id": 2, "used_g": 20.0},
|
|
],
|
|
slot_colors={1: "000000"},
|
|
)
|
|
db.execute.assert_not_awaited()
|
|
db.commit.assert_not_awaited()
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_missing_archive_does_not_crash(self):
|
|
"""Archive row gone (deleted between completion and reporting)."""
|
|
db = self._make_db(None)
|
|
await _apply_spool_colors_to_archive(
|
|
db,
|
|
archive_id=10,
|
|
filament_usage=[{"slot_id": 1, "used_g": 15.9}],
|
|
slot_colors={1: "000000"},
|
|
)
|
|
db.commit.assert_not_awaited()
|