| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937 |
- """Unit tests for the filament-deficit pre-dispatch check (#1496).
- The check is the single source of truth that both ``POST /queue/{id}/start``
- and the dispatch scheduler call before sending a print to the printer. Pin
- the contract for the cases that matter:
- * Internal-inventory mode: shortfall + sufficient + no assignment.
- * AMS-mapping gating: a missing mapping means "not yet decided, skip".
- * Disabled-warnings setting + missing printer (model-based item) + no
- source 3MF all short-circuit to "no deficit".
- """
- from __future__ import annotations
- import json
- import logging
- import zipfile
- from pathlib import Path
- from unittest.mock import patch
- import pytest
- from backend.app.models.archive import PrintArchive
- from backend.app.models.print_queue import PrintQueueItem
- from backend.app.models.settings import Settings
- from backend.app.models.spool import Spool
- from backend.app.models.spool_assignment import SpoolAssignment
- from backend.app.services.filament_deficit import (
- FilamentDeficit,
- compute_deficit_for_queue_item,
- )
- def _write_3mf(file_path: Path, filaments: list[dict]) -> None:
- """Minimal 3MF that ``extract_filament_requirements`` can parse (flat shape)."""
- body = "".join(
- f'<filament id="{f["id"]}" type="{f["type"]}" color="{f["color"]}" '
- f'used_g="{f["used_g"]}" tray_info_idx="{f.get("tray_info_idx", "")}"/>'
- for f in filaments
- )
- config = f'<?xml version="1.0" encoding="utf-8"?><config>{body}</config>'
- with zipfile.ZipFile(file_path, "w") as zf:
- zf.writestr("Metadata/slice_info.config", config)
- async def _setup_archive_3mf(db_session, tmp_path: Path, filaments: list[dict]) -> PrintArchive:
- """Create a 3MF on disk and a PrintArchive row pointing at it."""
- file_name = "model.3mf"
- file_path = tmp_path / file_name
- _write_3mf(file_path, filaments)
- archive = PrintArchive(
- filename=file_name,
- print_name="Test",
- # The helper resolves via app_settings.base_dir / file_path, but
- # storing the absolute path on the model also works because
- # ``Path / abs`` collapses to the absolute side.
- file_path=str(file_path),
- file_size=file_path.stat().st_size,
- status="completed",
- )
- db_session.add(archive)
- await db_session.commit()
- await db_session.refresh(archive)
- return archive
- async def _setup_library_3mf(db_session, base_dir: Path, filaments: list[dict], *, absolute: bool = False):
- """Create a 3MF under ``base_dir`` and a LibraryFile row pointing at it.
- Mirrors production storage: the file lands in
- ``<base_dir>/archive/library/files/`` and the row stores the path
- *relative* to base_dir, exactly as ``library.py`` writes it (#2779).
- """
- from backend.app.models.library import LibraryFile
- rel_path = Path("archive/library/files/deficit_probe.gcode.3mf")
- abs_path = base_dir / rel_path
- abs_path.parent.mkdir(parents=True, exist_ok=True)
- _write_3mf(abs_path, filaments)
- lib_file = LibraryFile(
- filename="deficit_probe.gcode.3mf",
- file_path=str(abs_path) if absolute else str(rel_path),
- file_type="3mf",
- file_size=abs_path.stat().st_size,
- )
- db_session.add(lib_file)
- await db_session.commit()
- await db_session.refresh(lib_file)
- return lib_file
- async def _spool(
- db_session,
- *,
- label_weight: int,
- weight_used: float,
- color: str = "#000000",
- slicer_filament: str | None = None,
- ) -> Spool:
- spool = Spool(
- material="PLA",
- label_weight=label_weight,
- weight_used=weight_used,
- rgba=color,
- slicer_filament=slicer_filament,
- )
- db_session.add(spool)
- await db_session.commit()
- await db_session.refresh(spool)
- return spool
- async def _assign(db_session, *, printer_id: int, spool_id: int, ams_id: int = 0, tray_id: int = 0) -> None:
- db_session.add(
- SpoolAssignment(
- spool_id=spool_id,
- printer_id=printer_id,
- ams_id=ams_id,
- tray_id=tray_id,
- )
- )
- await db_session.commit()
- async def _queue_item(
- db_session,
- *,
- printer_id: int | None,
- archive: PrintArchive | None,
- ams_mapping: list[int] | None,
- plate_id: int | None = None,
- library_file=None,
- ) -> PrintQueueItem:
- item = PrintQueueItem(
- printer_id=printer_id,
- archive_id=archive.id if archive else None,
- library_file_id=library_file.id if library_file else None,
- ams_mapping=json.dumps(ams_mapping) if ams_mapping is not None else None,
- plate_id=plate_id,
- status="pending",
- manual_start=True,
- )
- db_session.add(item)
- await db_session.commit()
- await db_session.refresh(item, ["archive", "library_file"])
- return item
- class TestFilamentDeficit:
- @pytest.mark.asyncio
- async def test_returns_deficit_when_spool_too_light(self, db_session, printer_factory, tmp_path):
- """Spool with 30g remaining for a 100g print → one deficit row."""
- printer = await printer_factory()
- archive = await _setup_archive_3mf(
- db_session,
- tmp_path,
- [{"id": "1", "type": "PLA", "color": "#FFFFFF", "used_g": "100.0"}],
- )
- spool = await _spool(db_session, label_weight=1000, weight_used=970.0) # 30g left
- await _assign(db_session, printer_id=printer.id, spool_id=spool.id, ams_id=0, tray_id=0)
- item = await _queue_item(db_session, printer_id=printer.id, archive=archive, ams_mapping=[0])
- with patch("backend.app.services.filament_deficit.app_settings.base_dir", Path("/")):
- deficit = await compute_deficit_for_queue_item(db_session, item)
- assert len(deficit) == 1
- assert isinstance(deficit[0], FilamentDeficit)
- assert deficit[0].slot_id == 1
- assert deficit[0].required_grams == 100.0
- assert deficit[0].remaining_grams == 30.0
- assert deficit[0].filament_type == "PLA"
- @pytest.mark.asyncio
- async def test_returns_empty_when_spool_has_enough(self, db_session, printer_factory, tmp_path):
- printer = await printer_factory()
- archive = await _setup_archive_3mf(
- db_session,
- tmp_path,
- [{"id": "1", "type": "PLA", "color": "#FFFFFF", "used_g": "100.0"}],
- )
- spool = await _spool(db_session, label_weight=1000, weight_used=200.0) # 800g left
- await _assign(db_session, printer_id=printer.id, spool_id=spool.id, ams_id=0, tray_id=0)
- item = await _queue_item(db_session, printer_id=printer.id, archive=archive, ams_mapping=[0])
- with patch("backend.app.services.filament_deficit.app_settings.base_dir", Path("/")):
- deficit = await compute_deficit_for_queue_item(db_session, item)
- assert deficit == []
- @pytest.mark.asyncio
- async def test_returns_empty_when_ams_mapping_missing(self, db_session, printer_factory, tmp_path):
- """No mapping yet = scheduler hasn't decided which slot maps where."""
- printer = await printer_factory()
- archive = await _setup_archive_3mf(
- db_session,
- tmp_path,
- [{"id": "1", "type": "PLA", "color": "#FFFFFF", "used_g": "100.0"}],
- )
- item = await _queue_item(db_session, printer_id=printer.id, archive=archive, ams_mapping=None)
- with patch("backend.app.services.filament_deficit.app_settings.base_dir", Path("/")):
- deficit = await compute_deficit_for_queue_item(db_session, item)
- assert deficit == []
- @pytest.mark.asyncio
- async def test_returns_empty_when_no_printer_assigned(self, db_session, tmp_path):
- """Model-based queue items with no resolved printer_id can't be checked."""
- archive = await _setup_archive_3mf(
- db_session,
- tmp_path,
- [{"id": "1", "type": "PLA", "color": "#FFFFFF", "used_g": "100.0"}],
- )
- item = await _queue_item(db_session, printer_id=None, archive=archive, ams_mapping=[0])
- with patch("backend.app.services.filament_deficit.app_settings.base_dir", Path("/")):
- deficit = await compute_deficit_for_queue_item(db_session, item)
- assert deficit == []
- @pytest.mark.asyncio
- async def test_returns_empty_when_warnings_disabled(self, db_session, printer_factory, tmp_path):
- """Honour the disable_filament_warnings setting (#720 toggle)."""
- printer = await printer_factory()
- archive = await _setup_archive_3mf(
- db_session,
- tmp_path,
- [{"id": "1", "type": "PLA", "color": "#FFFFFF", "used_g": "100.0"}],
- )
- spool = await _spool(db_session, label_weight=1000, weight_used=970.0)
- await _assign(db_session, printer_id=printer.id, spool_id=spool.id)
- item = await _queue_item(db_session, printer_id=printer.id, archive=archive, ams_mapping=[0])
- db_session.add(Settings(key="disable_filament_warnings", value="true"))
- await db_session.commit()
- with patch("backend.app.services.filament_deficit.app_settings.base_dir", Path("/")):
- deficit = await compute_deficit_for_queue_item(db_session, item)
- assert deficit == []
- @pytest.mark.asyncio
- async def test_returns_empty_when_no_assignment(self, db_session, printer_factory, tmp_path):
- """Mapping points at a slot with no spool assigned → silent, not blocked."""
- printer = await printer_factory()
- archive = await _setup_archive_3mf(
- db_session,
- tmp_path,
- [{"id": "1", "type": "PLA", "color": "#FFFFFF", "used_g": "100.0"}],
- )
- item = await _queue_item(db_session, printer_id=printer.id, archive=archive, ams_mapping=[0])
- with patch("backend.app.services.filament_deficit.app_settings.base_dir", Path("/")):
- deficit = await compute_deficit_for_queue_item(db_session, item)
- assert deficit == []
- @pytest.mark.asyncio
- async def test_library_file_with_relative_path_is_checked(self, db_session, printer_factory, tmp_path):
- """#2779: a Library-backed item stores its path relative to base_dir.
- Resolving it against the process working directory finds nothing, and
- "no source" is treated as "nothing to verify" — so the check returned
- no deficit and the scheduler dispatched onto a spool that could not
- finish the print. Every Slicer Pipeline item and everything queued via
- the Library's Add to queue is library-backed, so the guard was absent
- for all of them. Numbers are the reporter's: 20.5 g needed, 9 g left.
- """
- printer = await printer_factory()
- lib_file = await _setup_library_3mf(
- db_session,
- tmp_path,
- [{"id": "1", "type": "PLA", "color": "#FFFFFF", "used_g": "20.5"}],
- )
- assert not Path(lib_file.file_path).is_absolute() # the shape that broke
- spool = await _spool(db_session, label_weight=1000, weight_used=991.0) # 9g left
- await _assign(db_session, printer_id=printer.id, spool_id=spool.id, ams_id=0, tray_id=0)
- item = await _queue_item(
- db_session, printer_id=printer.id, archive=None, library_file=lib_file, ams_mapping=[0]
- )
- with patch("backend.app.services.filament_deficit.app_settings.base_dir", tmp_path):
- deficit = await compute_deficit_for_queue_item(db_session, item)
- assert len(deficit) == 1
- assert deficit[0].required_grams == 20.5
- assert deficit[0].remaining_grams == 9.0
- @pytest.mark.asyncio
- async def test_library_file_with_absolute_path_is_checked(self, db_session, printer_factory, tmp_path):
- """The other half of the resolver: a row that already holds an absolute
- path must not be joined onto base_dir a second time."""
- printer = await printer_factory()
- lib_file = await _setup_library_3mf(
- db_session,
- tmp_path,
- [{"id": "1", "type": "PLA", "color": "#FFFFFF", "used_g": "100.0"}],
- absolute=True,
- )
- spool = await _spool(db_session, label_weight=1000, weight_used=970.0) # 30g left
- await _assign(db_session, printer_id=printer.id, spool_id=spool.id, ams_id=0, tray_id=0)
- item = await _queue_item(
- db_session, printer_id=printer.id, archive=None, library_file=lib_file, ams_mapping=[0]
- )
- # A base_dir the file is NOT under — joining it on would break the path.
- with patch("backend.app.services.filament_deficit.app_settings.base_dir", tmp_path / "elsewhere"):
- deficit = await compute_deficit_for_queue_item(db_session, item)
- assert len(deficit) == 1
- assert deficit[0].required_grams == 100.0
- @pytest.mark.asyncio
- async def test_missing_source_is_logged_not_just_skipped(self, db_session, printer_factory, caplog):
- """A source that is configured but absent still dispatches — the upload
- would fail seconds later anyway, and wedging the queue on a missing
- file is the worse trade. But it must not pass silently: skipping the
- check without a trace is what let #2779 go unnoticed for every
- library-backed item.
- """
- printer = await printer_factory()
- archive = PrintArchive(
- filename="ghost.3mf",
- file_path="/nonexistent/ghost.3mf",
- file_size=0,
- status="completed",
- )
- db_session.add(archive)
- await db_session.commit()
- await db_session.refresh(archive)
- item = await _queue_item(db_session, printer_id=printer.id, archive=archive, ams_mapping=[0])
- with caplog.at_level(logging.WARNING, logger="backend.app.services.filament_deficit"):
- deficit = await compute_deficit_for_queue_item(db_session, item)
- assert deficit == []
- assert any("ghost.3mf" in r.getMessage() for r in caplog.records)
- @pytest.mark.asyncio
- async def test_returns_empty_when_3mf_missing(self, db_session, printer_factory):
- printer = await printer_factory()
- archive = PrintArchive(
- filename="ghost.3mf",
- file_path="/nonexistent/ghost.3mf",
- file_size=0,
- status="completed",
- )
- db_session.add(archive)
- await db_session.commit()
- await db_session.refresh(archive)
- item = await _queue_item(db_session, printer_id=printer.id, archive=archive, ams_mapping=[0])
- deficit = await compute_deficit_for_queue_item(db_session, item)
- assert deficit == []
- @pytest.mark.asyncio
- async def test_multi_slot_only_shorted_slot_returned(self, db_session, printer_factory, tmp_path):
- """One slot fine, one short — only the short slot is in the result."""
- printer = await printer_factory()
- archive = await _setup_archive_3mf(
- db_session,
- tmp_path,
- [
- {"id": "1", "type": "PLA", "color": "#FFFFFF", "used_g": "100.0"},
- {"id": "2", "type": "PETG", "color": "#000000", "used_g": "80.0"},
- ],
- )
- plenty = await _spool(db_session, label_weight=1000, weight_used=100.0) # 900g
- shorted = await _spool(db_session, label_weight=1000, weight_used=950.0) # 50g
- await _assign(db_session, printer_id=printer.id, spool_id=plenty.id, ams_id=0, tray_id=0)
- await _assign(db_session, printer_id=printer.id, spool_id=shorted.id, ams_id=0, tray_id=1)
- item = await _queue_item(
- db_session,
- printer_id=printer.id,
- archive=archive,
- ams_mapping=[0, 1], # slot 1 -> tray 0, slot 2 -> tray 1
- )
- with patch("backend.app.services.filament_deficit.app_settings.base_dir", Path("/")):
- deficit = await compute_deficit_for_queue_item(db_session, item)
- assert [d.slot_id for d in deficit] == [2]
- assert deficit[0].remaining_grams == 50.0
- assert deficit[0].required_grams == 80.0
- class TestFilamentDeficitBackupAware:
- """#1762 — when AMS Filament Backup is ON, pool remaining grams across
- same-material spools on the printer (within the same extruder side on
- dual-nozzle models) before declaring a slot deficit.
- Reporter scenario: PLA Basic in AMS-1 slot 1 with 10 g left, same PLA
- Basic in AMS-2 slot 1 with 500 g left. Today's per-slot accounting
- blocks the print because slot 1 of AMS-1 is short. With backup ON,
- firmware switches mid-print, so the deficit shouldn't fire.
- """
- @staticmethod
- def _patch_status(
- *,
- printer_id: int,
- backup_on: bool,
- ams_extruder_map: dict | None = None,
- model: str | None = None,
- ):
- """Patch ``printer_manager.get_status`` + ``get_model`` for the test."""
- from types import SimpleNamespace
- from unittest.mock import patch as _patch
- fake_state = SimpleNamespace(
- ams_filament_backup=backup_on if backup_on is not None else None,
- ams_extruder_map=ams_extruder_map or {},
- )
- return [
- _patch(
- "backend.app.services.printer_manager.printer_manager.get_status",
- lambda pid: fake_state if pid == printer_id else None,
- ),
- _patch(
- "backend.app.services.printer_manager.printer_manager.get_model",
- lambda pid: model if pid == printer_id else None,
- ),
- ]
- @pytest.mark.asyncio
- async def test_backup_on_pool_covers_short_slot(self, db_session, printer_factory, tmp_path):
- """The reporter scenario: assigned slot is short, but the same
- material on a peer slot covers the print. With backup ON, no deficit."""
- printer = await printer_factory(model="X1C")
- archive = await _setup_archive_3mf(
- db_session,
- tmp_path,
- [{"id": "1", "type": "PLA", "color": "#000000", "used_g": "200.0"}],
- )
- # Mapped slot: 10 g remaining, same Bambu preset as peer.
- short = await _spool(db_session, label_weight=1000, weight_used=990.0, slicer_filament="GFA00")
- # Peer slot on AMS-2: same preset, 500 g remaining.
- peer = await _spool(db_session, label_weight=1000, weight_used=500.0, slicer_filament="GFA00")
- await _assign(db_session, printer_id=printer.id, spool_id=short.id, ams_id=0, tray_id=0)
- await _assign(db_session, printer_id=printer.id, spool_id=peer.id, ams_id=1, tray_id=0)
- item = await _queue_item(
- db_session,
- printer_id=printer.id,
- archive=archive,
- ams_mapping=[0],
- )
- patches = TestFilamentDeficitBackupAware._patch_status(printer_id=printer.id, backup_on=True, model="X1C")
- with patch("backend.app.services.filament_deficit.app_settings.base_dir", Path("/")):
- for p in patches:
- p.start()
- try:
- deficit = await compute_deficit_for_queue_item(db_session, item)
- finally:
- for p in patches:
- p.stop()
- # Pool (10 + 500 = 510 g) covers the 200 g print → no deficit.
- assert deficit == []
- @pytest.mark.asyncio
- async def test_backup_on_pool_insufficient_emits_deficit(self, db_session, printer_factory, tmp_path):
- """Backup ON but the same-material pool across all slots is still
- too small for the print → deficit emitted (real shortfall)."""
- printer = await printer_factory(model="X1C")
- archive = await _setup_archive_3mf(
- db_session,
- tmp_path,
- [{"id": "1", "type": "PLA", "color": "#000000", "used_g": "1500.0"}],
- )
- a = await _spool(db_session, label_weight=1000, weight_used=900.0, slicer_filament="GFA00") # 100g
- b = await _spool(db_session, label_weight=1000, weight_used=700.0, slicer_filament="GFA00") # 300g
- await _assign(db_session, printer_id=printer.id, spool_id=a.id, ams_id=0, tray_id=0)
- await _assign(db_session, printer_id=printer.id, spool_id=b.id, ams_id=1, tray_id=0)
- item = await _queue_item(
- db_session,
- printer_id=printer.id,
- archive=archive,
- ams_mapping=[0],
- )
- patches = TestFilamentDeficitBackupAware._patch_status(printer_id=printer.id, backup_on=True, model="X1C")
- with patch("backend.app.services.filament_deficit.app_settings.base_dir", Path("/")):
- for p in patches:
- p.start()
- try:
- deficit = await compute_deficit_for_queue_item(db_session, item)
- finally:
- for p in patches:
- p.stop()
- # Pool 400 g < required 1500 g → deficit fires.
- assert len(deficit) == 1
- assert deficit[0].slot_id == 1
- @pytest.mark.asyncio
- async def test_backup_on_different_materials_no_pool(self, db_session, printer_factory, tmp_path):
- """Backup ON, but the peer slot holds a DIFFERENT material — pool
- doesn't include it, deficit fires for the original short slot."""
- printer = await printer_factory(model="X1C")
- archive = await _setup_archive_3mf(
- db_session,
- tmp_path,
- [{"id": "1", "type": "PLA", "color": "#FFFFFF", "used_g": "200.0"}],
- )
- # Assigned slot: PLA White preset GFA01, 10 g.
- short = await _spool(db_session, label_weight=1000, weight_used=990.0, color="#FFFFFF", slicer_filament="GFA01")
- # Peer: PLA Black, different preset (GFA00) — NOT a backup peer under the strict rule.
- peer = await _spool(db_session, label_weight=1000, weight_used=500.0, color="#000000", slicer_filament="GFA00")
- await _assign(db_session, printer_id=printer.id, spool_id=short.id, ams_id=0, tray_id=0)
- await _assign(db_session, printer_id=printer.id, spool_id=peer.id, ams_id=1, tray_id=0)
- item = await _queue_item(
- db_session,
- printer_id=printer.id,
- archive=archive,
- ams_mapping=[0],
- )
- patches = TestFilamentDeficitBackupAware._patch_status(printer_id=printer.id, backup_on=True, model="X1C")
- with patch("backend.app.services.filament_deficit.app_settings.base_dir", Path("/")):
- for p in patches:
- p.start()
- try:
- deficit = await compute_deficit_for_queue_item(db_session, item)
- finally:
- for p in patches:
- p.stop()
- # Pool for white = 10 g, required = 200 g → deficit.
- assert len(deficit) == 1
- assert deficit[0].slot_id == 1
- assert deficit[0].remaining_grams == 10.0
- @pytest.mark.asyncio
- async def test_backup_off_falls_back_to_per_slot_accounting(self, db_session, printer_factory, tmp_path):
- """When backup is OFF the new code path must be a strict no-op vs.
- the pre-#1762 per-slot accounting. Identical inputs to the
- ``pool_covers_short_slot`` case but with backup OFF — deficit fires."""
- printer = await printer_factory(model="X1C")
- archive = await _setup_archive_3mf(
- db_session,
- tmp_path,
- [{"id": "1", "type": "PLA", "color": "#000000", "used_g": "200.0"}],
- )
- short = await _spool(db_session, label_weight=1000, weight_used=990.0, slicer_filament="GFA00")
- peer = await _spool(db_session, label_weight=1000, weight_used=500.0, slicer_filament="GFA00")
- await _assign(db_session, printer_id=printer.id, spool_id=short.id, ams_id=0, tray_id=0)
- await _assign(db_session, printer_id=printer.id, spool_id=peer.id, ams_id=1, tray_id=0)
- item = await _queue_item(
- db_session,
- printer_id=printer.id,
- archive=archive,
- ams_mapping=[0],
- )
- patches = TestFilamentDeficitBackupAware._patch_status(printer_id=printer.id, backup_on=False, model="X1C")
- with patch("backend.app.services.filament_deficit.app_settings.base_dir", Path("/")):
- for p in patches:
- p.start()
- try:
- deficit = await compute_deficit_for_queue_item(db_session, item)
- finally:
- for p in patches:
- p.stop()
- # Backup OFF → per-slot accounting → slot 1 has 10 g, needs 200 g.
- assert len(deficit) == 1
- assert deficit[0].remaining_grams == 10.0
- @pytest.mark.asyncio
- async def test_backup_on_dual_extruder_scopes_pool_per_side(self, db_session, printer_factory, tmp_path):
- """Dual-extruder printer (H2D): peer slot on the OPPOSITE extruder
- does NOT count toward the pool — firmware can't cross. Deficit fires."""
- printer = await printer_factory(model="O1D") # H2D internal code
- archive = await _setup_archive_3mf(
- db_session,
- tmp_path,
- [{"id": "1", "type": "PLA", "color": "#000000", "used_g": "200.0"}],
- )
- short = await _spool(db_session, label_weight=1000, weight_used=990.0, slicer_filament="GFA00")
- peer_other_side = await _spool(db_session, label_weight=1000, weight_used=500.0, slicer_filament="GFA00")
- # AMS 0 is on extruder 0 (right). AMS 1 is on extruder 1 (left).
- await _assign(db_session, printer_id=printer.id, spool_id=short.id, ams_id=0, tray_id=0)
- await _assign(db_session, printer_id=printer.id, spool_id=peer_other_side.id, ams_id=1, tray_id=0)
- item = await _queue_item(
- db_session,
- printer_id=printer.id,
- archive=archive,
- ams_mapping=[0],
- )
- patches = TestFilamentDeficitBackupAware._patch_status(
- printer_id=printer.id,
- backup_on=True,
- ams_extruder_map={"0": 0, "1": 1},
- model="O1D",
- )
- with patch("backend.app.services.filament_deficit.app_settings.base_dir", Path("/")):
- for p in patches:
- p.start()
- try:
- deficit = await compute_deficit_for_queue_item(db_session, item)
- finally:
- for p in patches:
- p.stop()
- # Pool for extruder 0 = 10 g (peer on extruder 1 is unreachable) <
- # required 200 g → deficit.
- assert len(deficit) == 1
- assert deficit[0].slot_id == 1
- @pytest.mark.asyncio
- async def test_backup_on_no_preset_never_pairs(self, db_session, printer_factory, tmp_path):
- """Strict rule: two user-tagged spools with no slicer_filament preset
- must NEVER pair, even when material + colour match. Mirrors Bambu
- firmware: the backup decision relies on the Bambu Lab preset ID, so
- generic spools without one can't be trusted to switch."""
- printer = await printer_factory(model="X1C")
- archive = await _setup_archive_3mf(
- db_session,
- tmp_path,
- [{"id": "1", "type": "PLA", "color": "#000000", "used_g": "200.0"}],
- )
- # Both spools: material PLA, colour black, NO preset → unique keys.
- short = await _spool(db_session, label_weight=1000, weight_used=990.0)
- peer_no_preset = await _spool(db_session, label_weight=1000, weight_used=500.0)
- await _assign(db_session, printer_id=printer.id, spool_id=short.id, ams_id=0, tray_id=0)
- await _assign(db_session, printer_id=printer.id, spool_id=peer_no_preset.id, ams_id=1, tray_id=0)
- item = await _queue_item(
- db_session,
- printer_id=printer.id,
- archive=archive,
- ams_mapping=[0],
- )
- patches = TestFilamentDeficitBackupAware._patch_status(printer_id=printer.id, backup_on=True, model="X1C")
- with patch("backend.app.services.filament_deficit.app_settings.base_dir", Path("/")):
- for p in patches:
- p.start()
- try:
- deficit = await compute_deficit_for_queue_item(db_session, item)
- finally:
- for p in patches:
- p.stop()
- # No preset means no pool — slot 1's 10 g vs 200 g required → deficit.
- assert len(deficit) == 1
- assert deficit[0].slot_id == 1
- assert deficit[0].remaining_grams == 10.0
- @pytest.mark.asyncio
- async def test_backup_on_same_preset_different_colors_does_not_pair(self, db_session, printer_factory, tmp_path):
- """STRICT colour rule: two spools sharing the same Bambu preset ID
- but DIFFERENT colours must NOT pool. Three PETG HF spools in
- different colours can't back each other up — the firmware would
- switch material correctly but the print would change colour
- mid-run. Pool is per-(preset, colour)."""
- printer = await printer_factory(model="X1C")
- archive = await _setup_archive_3mf(
- db_session,
- tmp_path,
- [{"id": "1", "type": "PLA", "color": "#000000", "used_g": "200.0"}],
- )
- # Assigned slot: PLA Basic + GFA00 + BLACK, only 10 g left.
- short = await _spool(db_session, label_weight=1000, weight_used=990.0, color="#000000", slicer_filament="GFA00")
- # Peer slot: same GFA00 profile but WHITE — must not pool.
- peer_diff_color = await _spool(
- db_session, label_weight=1000, weight_used=500.0, color="#FFFFFF", slicer_filament="GFA00"
- )
- await _assign(db_session, printer_id=printer.id, spool_id=short.id, ams_id=0, tray_id=0)
- await _assign(db_session, printer_id=printer.id, spool_id=peer_diff_color.id, ams_id=1, tray_id=0)
- item = await _queue_item(
- db_session,
- printer_id=printer.id,
- archive=archive,
- ams_mapping=[0],
- )
- patches = TestFilamentDeficitBackupAware._patch_status(printer_id=printer.id, backup_on=True, model="X1C")
- with patch("backend.app.services.filament_deficit.app_settings.base_dir", Path("/")):
- for p in patches:
- p.start()
- try:
- deficit = await compute_deficit_for_queue_item(db_session, item)
- finally:
- for p in patches:
- p.stop()
- # Pool for (GFA00, black) = 10 g; required = 200 g → deficit.
- assert len(deficit) == 1
- assert deficit[0].slot_id == 1
- assert deficit[0].remaining_grams == 10.0
- @pytest.mark.asyncio
- async def test_backup_on_color_alpha_normalized(self, db_session, printer_factory, tmp_path):
- """Colour normalisation: 6-char hex matches 8-char hex of the same
- RGB. ``000000`` and ``000000FF`` should both resolve to BLACK."""
- printer = await printer_factory(model="X1C")
- archive = await _setup_archive_3mf(
- db_session,
- tmp_path,
- [{"id": "1", "type": "PLA", "color": "#000000", "used_g": "200.0"}],
- )
- short = await _spool(db_session, label_weight=1000, weight_used=990.0, color="#000000", slicer_filament="GFA00")
- # Same colour but expressed with explicit alpha.
- peer = await _spool(
- db_session, label_weight=1000, weight_used=500.0, color="#000000FF", slicer_filament="GFA00"
- )
- await _assign(db_session, printer_id=printer.id, spool_id=short.id, ams_id=0, tray_id=0)
- await _assign(db_session, printer_id=printer.id, spool_id=peer.id, ams_id=1, tray_id=0)
- item = await _queue_item(
- db_session,
- printer_id=printer.id,
- archive=archive,
- ams_mapping=[0],
- )
- patches = TestFilamentDeficitBackupAware._patch_status(printer_id=printer.id, backup_on=True, model="X1C")
- with patch("backend.app.services.filament_deficit.app_settings.base_dir", Path("/")):
- for p in patches:
- p.start()
- try:
- deficit = await compute_deficit_for_queue_item(db_session, item)
- finally:
- for p in patches:
- p.stop()
- # Pool (10 + 500 = 510 g) covers 200 g → no deficit.
- assert deficit == []
- class TestBuildSlotMaterials:
- """``build_slot_materials`` is the pool the backup accounting draws on, and
- the payload ``GET /printers/{id}/inventory-remain`` hands the PrintModal.
- The modal used to resolve spools itself and knew nothing about AMS Filament
- Backup, so it blocked prints the dispatcher would have run — two full eSUN
- spools in A3/A4, 1441 g needed, "A3: needs 1441g, remaining 1000g". Both
- sides now group on the keys this builder emits, so the modal's warning and
- the dispatcher's 409 cannot disagree about what backs what up.
- """
- @pytest.mark.asyncio
- async def test_internal_mode_emits_shared_key_for_same_preset_and_colour(self, db_session, printer_factory):
- """The reporter's slots: same preset, same colour, adjacent trays."""
- from backend.app.services.filament_deficit import build_slot_materials
- printer = await printer_factory(model="H2D")
- a3 = await _spool(db_session, label_weight=1000, weight_used=0.0, color="#616777FF", slicer_filament="PFUS6488")
- a4 = await _spool(db_session, label_weight=1000, weight_used=0.0, color="#616777", slicer_filament="PFUS6488")
- await _assign(db_session, printer_id=printer.id, spool_id=a3.id, ams_id=0, tray_id=2)
- await _assign(db_session, printer_id=printer.id, spool_id=a4.id, ams_id=0, tray_id=3)
- patches = TestFilamentDeficitBackupAware._patch_status(printer_id=printer.id, backup_on=True, model="H2D")
- for p in patches:
- p.start()
- try:
- slots = await build_slot_materials(db_session, printer.id)
- finally:
- for p in patches:
- p.stop()
- by_tray = {s.global_tray_id: s for s in slots}
- assert set(by_tray) == {2, 3}
- assert by_tray[2].material_key == by_tray[3].material_key
- assert by_tray[2].remaining_grams == 1000.0
- # Pooled, the two cover the 1441 g the modal refused to start.
- assert sum(s.remaining_grams for s in slots) == 2000.0
- @pytest.mark.asyncio
- async def test_internal_mode_separates_colours_and_presetless_spools(self, db_session, printer_factory):
- """Different colour, and no preset at all, must never share a key."""
- from backend.app.services.filament_deficit import build_slot_materials
- printer = await printer_factory(model="X1C")
- black = await _spool(db_session, label_weight=1000, weight_used=0.0, color="#000000", slicer_filament="GFA00")
- white = await _spool(db_session, label_weight=1000, weight_used=0.0, color="#FFFFFF", slicer_filament="GFA00")
- untagged_a = await _spool(db_session, label_weight=1000, weight_used=0.0, color="#000000")
- untagged_b = await _spool(db_session, label_weight=1000, weight_used=0.0, color="#000000")
- for idx, spool in enumerate((black, white, untagged_a, untagged_b)):
- await _assign(db_session, printer_id=printer.id, spool_id=spool.id, ams_id=0, tray_id=idx)
- patches = TestFilamentDeficitBackupAware._patch_status(printer_id=printer.id, backup_on=True, model="X1C")
- for p in patches:
- p.start()
- try:
- slots = await build_slot_materials(db_session, printer.id)
- finally:
- for p in patches:
- p.stop()
- keys = [s.material_key for s in sorted(slots, key=lambda s: s.global_tray_id)]
- assert len(set(keys)) == 4, keys
- @pytest.mark.asyncio
- async def test_internal_mode_scopes_extruder_on_dual_nozzle(self, db_session, printer_factory):
- """Same material on opposite sides of an H2D can't back each other up."""
- from backend.app.services.filament_deficit import build_slot_materials
- printer = await printer_factory(model="H2D")
- right = await _spool(db_session, label_weight=1000, weight_used=0.0, slicer_filament="GFA00")
- left = await _spool(db_session, label_weight=1000, weight_used=0.0, slicer_filament="GFA00")
- await _assign(db_session, printer_id=printer.id, spool_id=right.id, ams_id=0, tray_id=0)
- await _assign(db_session, printer_id=printer.id, spool_id=left.id, ams_id=1, tray_id=0)
- patches = TestFilamentDeficitBackupAware._patch_status(
- printer_id=printer.id, backup_on=True, ams_extruder_map={"0": 0, "1": 1}, model="H2D"
- )
- for p in patches:
- p.start()
- try:
- slots = await build_slot_materials(db_session, printer.id)
- finally:
- for p in patches:
- p.stop()
- by_tray = {s.global_tray_id: s for s in slots}
- assert by_tray[0].material_key == by_tray[4].material_key # same material...
- assert {by_tray[0].extruder, by_tray[4].extruder} == {0, 1} # ...different side
- @pytest.mark.asyncio
- async def test_internal_mode_omits_slots_with_no_usable_weight(self, db_session, printer_factory):
- """A binding with no label weight is unknown, not empty — omit it so the
- client can't read a missing slot as a zero-gram one."""
- from backend.app.services.filament_deficit import build_slot_materials
- printer = await printer_factory(model="X1C")
- unweighed = await _spool(db_session, label_weight=0, weight_used=0.0, slicer_filament="GFA00")
- ok = await _spool(db_session, label_weight=1000, weight_used=250.0, slicer_filament="GFA00")
- await _assign(db_session, printer_id=printer.id, spool_id=unweighed.id, ams_id=0, tray_id=0)
- await _assign(db_session, printer_id=printer.id, spool_id=ok.id, ams_id=0, tray_id=1)
- patches = TestFilamentDeficitBackupAware._patch_status(printer_id=printer.id, backup_on=True, model="X1C")
- for p in patches:
- p.start()
- try:
- slots = await build_slot_materials(db_session, printer.id)
- finally:
- for p in patches:
- p.stop()
- assert [(s.global_tray_id, s.remaining_grams) for s in slots] == [(1, 750.0)]
- @pytest.mark.asyncio
- async def test_external_and_ht_slots_get_the_frontend_tray_numbering(self, db_session, printer_factory):
- """``global_tray_id`` must match the client's ``getGlobalTrayId`` or the
- modal looks up the wrong slot: 254+ for external, unit id for AMS-HT."""
- from backend.app.services.filament_deficit import build_slot_materials
- printer = await printer_factory(model="X1C")
- ht = await _spool(db_session, label_weight=1000, weight_used=0.0, slicer_filament="GFA00")
- ext = await _spool(db_session, label_weight=1000, weight_used=0.0, slicer_filament="GFA01")
- await _assign(db_session, printer_id=printer.id, spool_id=ht.id, ams_id=128, tray_id=0)
- await _assign(db_session, printer_id=printer.id, spool_id=ext.id, ams_id=255, tray_id=0)
- patches = TestFilamentDeficitBackupAware._patch_status(printer_id=printer.id, backup_on=True, model="X1C")
- for p in patches:
- p.start()
- try:
- slots = await build_slot_materials(db_session, printer.id)
- finally:
- for p in patches:
- p.stop()
- assert sorted(s.global_tray_id for s in slots) == [128, 254]
- @pytest.mark.asyncio
- async def test_spoolman_mode_pools_on_filament_id_and_colour(self, db_session, printer_factory):
- """Spoolman parity: same catalog filament + colour → one pool key."""
- from unittest.mock import AsyncMock
- from backend.app.models.spoolman_slot_assignment import SpoolmanSlotAssignment
- from backend.app.services.filament_deficit import build_slot_materials
- printer = await printer_factory(model="H2D")
- db_session.add(Settings(key="spoolman_enabled", value="true"))
- for tray_id, spool_id in ((2, 68), (3, 69)):
- db_session.add(
- SpoolmanSlotAssignment(printer_id=printer.id, ams_id=0, tray_id=tray_id, spoolman_spool_id=spool_id)
- )
- await db_session.commit()
- spools = {
- 68: {"id": 68, "remaining_weight": 1000.0, "filament": {"id": 7, "color_hex": "616777"}},
- # Same catalog entry, colour spelled with alpha, weight via used_weight.
- 69: {"id": 69, "used_weight": 0.0, "filament": {"id": 7, "weight": 1000.0, "color_hex": "616777FF"}},
- }
- client = AsyncMock()
- client.get_spool = AsyncMock(side_effect=lambda sid: spools[sid])
- patches = TestFilamentDeficitBackupAware._patch_status(printer_id=printer.id, backup_on=True, model="H2D")
- for p in patches:
- p.start()
- try:
- with patch(
- "backend.app.services.spoolman.get_spoolman_client",
- AsyncMock(return_value=client),
- ):
- slots = await build_slot_materials(db_session, printer.id)
- finally:
- for p in patches:
- p.stop()
- assert len({s.material_key for s in slots}) == 1
- assert sum(s.remaining_grams for s in slots) == 2000.0
- @pytest.mark.asyncio
- async def test_spoolman_unreachable_returns_no_slots(self, db_session, printer_factory):
- """A Spoolman blip must read as "nothing to verify", never as an empty
- AMS — the modal would otherwise warn on every slot while it's down."""
- from unittest.mock import AsyncMock
- from backend.app.models.spoolman_slot_assignment import SpoolmanSlotAssignment
- from backend.app.services.filament_deficit import build_slot_materials
- printer = await printer_factory(model="X1C")
- db_session.add(Settings(key="spoolman_enabled", value="true"))
- db_session.add(SpoolmanSlotAssignment(printer_id=printer.id, ams_id=0, tray_id=0, spoolman_spool_id=1))
- await db_session.commit()
- patches = TestFilamentDeficitBackupAware._patch_status(printer_id=printer.id, backup_on=True, model="X1C")
- for p in patches:
- p.start()
- try:
- with patch(
- "backend.app.services.spoolman.get_spoolman_client",
- AsyncMock(return_value=None),
- ):
- slots = await build_slot_materials(db_session, printer.id)
- finally:
- for p in patches:
- p.stop()
- assert slots == []
|