| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137 |
- """Unit tests for Virtual Printer services.
- Tests the virtual printer manager, FTP server, and SSDP server components.
- """
- import asyncio
- import json
- import zipfile
- from pathlib import Path
- from unittest.mock import AsyncMock, MagicMock, patch
- import pytest
- def _write_3mf_with_filaments(file_path: Path, filaments: list[dict], plate_index: int = 1) -> None:
- """Build a minimal 3MF zip with `Metadata/slice_info.config` carrying the
- given per-slot filament entries. Each `filaments` dict needs `id`, `type`,
- `color`, `used_g`. Used by the #1188 VP queue-mode tests below."""
- filament_xml = "".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 = (
- '<?xml version="1.0" encoding="utf-8"?>'
- "<config>"
- f'<plate><metadata key="index" value="{plate_index}"/>'
- f"{filament_xml}"
- "</plate>"
- "</config>"
- )
- with zipfile.ZipFile(file_path, "w") as zf:
- zf.writestr("Metadata/slice_info.config", config)
- # Plate gcode is referenced for plate-id detection in the VP path —
- # presence is enough; contents don't matter.
- zf.writestr(f"Metadata/plate_{plate_index}.gcode", "; gcode\n")
- class TestVirtualPrinterInstance:
- """Tests for VirtualPrinterInstance class."""
- @pytest.fixture
- def instance(self, tmp_path):
- """Create a VirtualPrinterInstance with test defaults."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- return VirtualPrinterInstance(
- vp_id=1,
- name="TestPrinter",
- mode="archive",
- model="C11",
- access_code="12345678",
- serial_suffix="391800001",
- base_dir=tmp_path,
- )
- # ========================================================================
- # Tests for instance properties
- # ========================================================================
- def test_instance_stores_parameters(self, instance):
- """Verify constructor stores parameters correctly."""
- assert instance.id == 1
- assert instance.name == "TestPrinter"
- assert instance.mode == "archive"
- assert instance.model == "C11"
- assert instance.access_code == "12345678"
- assert instance.serial_suffix == "391800001"
- def test_instance_serial_property(self, instance):
- """Verify serial is generated from model prefix + suffix."""
- # C11 = P1P, prefix = 01S00A
- assert instance.serial == "01S00A391800001"
- def test_instance_serial_x1c(self, tmp_path):
- """Verify X1C serial uses correct prefix."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- inst = VirtualPrinterInstance(
- vp_id=2,
- name="X1C",
- mode="archive",
- model="BL-P001",
- access_code="12345678",
- serial_suffix="391800002",
- base_dir=tmp_path,
- )
- assert inst.serial == "00M00A391800002"
- def test_instance_is_proxy_false(self, instance):
- """Verify is_proxy is False for non-proxy mode."""
- assert instance.is_proxy is False
- def test_instance_is_proxy_true(self, tmp_path):
- """Verify is_proxy is True for proxy mode."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- inst = VirtualPrinterInstance(
- vp_id=3,
- name="Proxy",
- mode="proxy",
- model="C11",
- access_code="",
- serial_suffix="391800003",
- target_printer_ip="192.168.1.100",
- base_dir=tmp_path,
- )
- assert inst.is_proxy is True
- def test_instance_is_running_with_active_tasks(self, instance):
- """Verify is_running is True when tasks are active."""
- mock_task = MagicMock()
- mock_task.done.return_value = False
- instance._tasks = [mock_task]
- assert instance.is_running is True
- def test_instance_is_running_with_no_tasks(self, instance):
- """Verify is_running is False when no tasks."""
- assert instance.is_running is False
- def test_instance_creates_directories(self, instance, tmp_path):
- """Verify instance creates upload and cert directories."""
- assert (tmp_path / "uploads" / "1").exists()
- assert (tmp_path / "uploads" / "1" / "cache").exists()
- assert (tmp_path / "certs" / "1").exists()
- # ========================================================================
- # Tests for status
- # ========================================================================
- def test_get_status_returns_correct_format(self, instance):
- """Verify get_status returns expected fields."""
- instance._pending_files = {"file1.3mf": Path("/tmp/file1.3mf")} # nosec B108
- mock_task = MagicMock(done=MagicMock(return_value=False))
- instance._tasks = [mock_task]
- status = instance.get_status()
- assert status["running"] is True
- assert status["pending_files"] == 1
- def test_get_status_not_running(self, instance):
- """Verify get_status when no tasks."""
- status = instance.get_status()
- assert status["running"] is False
- assert status["pending_files"] == 0
- # ========================================================================
- # Tests for file handling
- # ========================================================================
- @pytest.mark.asyncio
- async def test_on_file_received_adds_to_pending(self, instance):
- """Verify received file is added to pending list in review mode."""
- instance.mode = "review"
- file_path = Path("/tmp/test.3mf") # nosec B108
- with patch.object(instance, "_queue_file", new_callable=AsyncMock) as mock_queue:
- await instance.on_file_received(file_path, "192.168.1.100")
- assert "test.3mf" in instance._pending_files
- mock_queue.assert_called_once()
- @pytest.mark.asyncio
- async def test_on_file_received_archives_immediately(self, instance):
- """Verify file is archived in immediate mode."""
- file_path = Path("/tmp/test.3mf") # nosec B108
- with patch.object(instance, "_archive_file", new_callable=AsyncMock) as mock_archive:
- await instance.on_file_received(file_path, "192.168.1.100")
- mock_archive.assert_called_once_with(file_path, "192.168.1.100")
- @pytest.mark.asyncio
- async def test_on_file_received_signals_FINISH_to_slicer(self, instance):
- """Regression #1280: when a slicer's Print flow uploads to a non-proxy VP,
- the VP must transition gcode_state PREPARE → FINISH so the slicer's
- in-flight-job lock releases. Going PREPARE → IDLE wedges Orca at
- "Downloading...(0%)" and blocks the next dispatch with "busy with
- another print job".
- Send-flow slicers don't watch the post-upload state, so this is a
- no-op behavior change for them.
- """
- instance.mode = "archive"
- instance._mqtt = MagicMock()
- instance._mqtt.set_gcode_state = MagicMock()
- file_path = Path("/tmp/test.3mf") # nosec B108
- with patch.object(instance, "_archive_file", new_callable=AsyncMock):
- await instance.on_file_received(file_path, "192.168.1.100")
- instance._mqtt.set_gcode_state.assert_called_once_with("FINISH", filename="test.3mf", prepare_percent="100")
- @pytest.mark.asyncio
- async def test_on_file_received_non_3mf_does_not_touch_state(self, instance):
- """Non-3MF uploads (e.g., a job's auxiliary files) must not transition
- the visible state — the slicer is only tracking the .3mf upload."""
- instance.mode = "archive"
- instance._mqtt = MagicMock()
- instance._mqtt.set_gcode_state = MagicMock()
- file_path = Path("/tmp/test.gcode") # nosec B108
- with patch.object(instance, "_archive_file", new_callable=AsyncMock):
- await instance.on_file_received(file_path, "192.168.1.100")
- instance._mqtt.set_gcode_state.assert_not_called()
- @pytest.mark.asyncio
- async def test_on_print_command_schedules_finish_release_non_proxy(self, instance):
- """#1658: Bambu Studio 2.7.x flipped the slicer's Send flow to
- FTP → FTP → MQTT project_file. Under that order the synthetic
- project_file ack overwrites the FINISH set by #1280 in
- ``on_file_received`` back to PREPARE, leaving the slicer's
- "Downloading" modal stuck forever. Re-firing FINISH a moment after
- the ack releases the modal.
- """
- instance.mode = "archive"
- instance._mqtt = MagicMock()
- instance._mqtt.set_gcode_state = MagicMock()
- with patch.object(instance, "_delayed_finish_release", new_callable=AsyncMock) as mock_delayed:
- await instance.on_print_command("test.3mf", {"command": "project_file"})
- mock_delayed.assert_called_once()
- # First positional arg should be the filename; second is the delay seconds.
- args = mock_delayed.call_args.args
- assert args[0] == "test.3mf"
- assert isinstance(args[1], int | float)
- @pytest.mark.asyncio
- async def test_on_print_command_proxy_mode_does_not_reschedule_finish(self, instance):
- """Proxy mode hands push_status straight from the real printer through
- the bridge. Re-firing a synthetic FINISH would clobber a real
- PREPARE / RUNNING transition coming back from the printer, so the
- scheduler is exempt for proxy mode."""
- instance.mode = "proxy"
- instance._mqtt = MagicMock()
- with patch.object(instance, "_delayed_finish_release", new_callable=AsyncMock) as mock_delayed:
- await instance.on_print_command("test.3mf", {"command": "project_file"})
- mock_delayed.assert_not_called()
- @pytest.mark.asyncio
- async def test_on_print_command_no_mqtt_does_not_schedule(self, instance):
- """If the MQTT server isn't running yet (transient race during boot),
- the scheduler must skip silently — no AttributeError, no orphan task."""
- instance.mode = "queue"
- instance._mqtt = None
- # Should not raise.
- await instance.on_print_command("test.3mf", {"command": "project_file"})
- assert instance._finish_release_task is None
- @pytest.mark.asyncio
- async def test_schedule_finish_release_cancels_previous_timer(self, instance):
- """A slicer that fires project_file twice (e.g. retry after a transient
- FTP hiccup) must only result in one FINISH transition — the earlier
- in-flight timer is cancelled when the next one is scheduled."""
- instance.mode = "queue"
- instance._mqtt = MagicMock()
- instance._schedule_finish_release("first.3mf", delay=10.0)
- first_task = instance._finish_release_task
- assert first_task is not None
- instance._schedule_finish_release("second.3mf", delay=10.0)
- second_task = instance._finish_release_task
- assert second_task is not first_task
- # Give the loop one tick so the cancelled task settles.
- await asyncio.sleep(0)
- assert first_task.cancelled() or first_task.done()
- # Clean up the still-pending second task so the test doesn't leak it.
- second_task.cancel()
- try:
- await second_task
- except asyncio.CancelledError:
- pass
- @pytest.mark.asyncio
- async def test_delayed_finish_release_sets_finish_state(self, instance):
- """End-to-end: after the delay elapses, set_gcode_state is called with
- FINISH and prepare_percent=100, matching the wire-format the slicer's
- Print flow consumes to release "Downloading"."""
- instance._mqtt = MagicMock()
- instance._mqtt.set_gcode_state = MagicMock()
- await instance._delayed_finish_release("queued.3mf", delay=0.0)
- instance._mqtt.set_gcode_state.assert_called_once_with("FINISH", filename="queued.3mf", prepare_percent="100")
- @pytest.mark.asyncio
- async def test_on_print_command_no_filename_does_not_schedule(self, instance):
- """A project_file command without a subtask_name (defensive — real
- slicers always send one) must not schedule a no-op FINISH that would
- carry an empty filename on the next 1 Hz push."""
- instance.mode = "queue"
- instance._mqtt = MagicMock()
- with patch.object(instance, "_delayed_finish_release", new_callable=AsyncMock) as mock_delayed:
- await instance.on_print_command("", {"command": "project_file"})
- mock_delayed.assert_not_called()
- @pytest.mark.asyncio
- async def test_archive_file_skips_non_3mf(self, instance):
- """Verify non-3MF files are skipped and cleaned up."""
- instance._session_factory = MagicMock()
- instance._pending_files["verify_job"] = Path("/tmp/verify_job") # nosec B108
- with patch("pathlib.Path.unlink"):
- await instance._archive_file(Path("/tmp/verify_job"), "192.168.1.100") # nosec B108
- assert "verify_job" not in instance._pending_files
- @pytest.mark.asyncio
- async def test_archive_file_broadcasts_archive_created(self, tmp_path):
- """#1282: VP immediate-mode archives must broadcast archive_created so
- the Archives page refreshes without a tab switch. Real-printer prints
- get this via main.py's MQTT print_start handler; the VP path used to
- skip the broadcast entirely."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- mock_db = AsyncMock()
- mock_db.commit = AsyncMock()
- mock_session_factory = MagicMock()
- mock_session_ctx = AsyncMock()
- mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
- mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
- mock_session_factory.return_value = mock_session_ctx
- inst = VirtualPrinterInstance(
- vp_id=30,
- name="ImmediateBroadcast",
- mode="archive",
- model="C12",
- access_code="12345678",
- serial_suffix="391800030",
- base_dir=tmp_path,
- session_factory=mock_session_factory,
- )
- file_path = tmp_path / "test.3mf"
- file_path.write_bytes(b"fake3mf")
- mock_archive = MagicMock()
- mock_archive.id = 99
- mock_archive.printer_id = None
- mock_archive.filename = "test.3mf"
- mock_archive.print_name = "test"
- mock_archive.status = "archived"
- with (
- patch(
- "backend.app.api.routes.settings.get_setting",
- new_callable=AsyncMock,
- return_value=None,
- ),
- patch(
- "backend.app.services.archive.ArchiveService.archive_print",
- new_callable=AsyncMock,
- return_value=mock_archive,
- ),
- patch(
- "backend.app.core.websocket.ws_manager.send_archive_created",
- new_callable=AsyncMock,
- ) as mock_broadcast,
- ):
- await inst._archive_file(file_path, "192.168.1.100")
- mock_broadcast.assert_awaited_once()
- payload = mock_broadcast.await_args.args[0]
- assert payload["id"] == 99
- assert payload["filename"] == "test.3mf"
- assert payload["status"] == "archived"
- # ========================================================================
- # Tests for auto_dispatch
- # ========================================================================
- def test_auto_dispatch_defaults_to_true(self, tmp_path):
- """Verify auto_dispatch defaults to True when not specified."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- inst = VirtualPrinterInstance(
- vp_id=10,
- name="DefaultDispatch",
- mode="queue",
- model="C11",
- access_code="12345678",
- serial_suffix="391800010",
- base_dir=tmp_path,
- )
- assert inst.auto_dispatch is True
- @pytest.mark.asyncio
- async def test_add_to_print_queue_with_auto_dispatch_on(self, tmp_path):
- """Verify queue items have manual_start=False when auto_dispatch=True."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- mock_db = AsyncMock()
- added_items = []
- def capture_add(item):
- added_items.append(item)
- mock_db.add = MagicMock(side_effect=capture_add)
- mock_db.commit = AsyncMock()
- mock_session_factory = MagicMock()
- mock_session_ctx = AsyncMock()
- mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
- mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
- mock_session_factory.return_value = mock_session_ctx
- inst = VirtualPrinterInstance(
- vp_id=11,
- name="AutoDispatchOn",
- mode="queue",
- model="C11",
- access_code="12345678",
- serial_suffix="391800011",
- auto_dispatch=True,
- base_dir=tmp_path,
- session_factory=mock_session_factory,
- )
- # Create a temp 3mf file
- file_path = tmp_path / "test.3mf"
- file_path.write_bytes(b"fake3mf")
- mock_archive = MagicMock()
- mock_archive.id = 1
- mock_archive.print_name = "test"
- with (
- patch(
- "backend.app.api.routes.settings.get_setting",
- new_callable=AsyncMock,
- return_value=None,
- ),
- patch(
- "backend.app.services.archive.ArchiveService.archive_print",
- new_callable=AsyncMock,
- return_value=mock_archive,
- ),
- ):
- await inst._add_to_print_queue(file_path, "192.168.1.100")
- assert len(added_items) == 1
- queue_item = added_items[0]
- assert queue_item.manual_start is False
- @pytest.mark.asyncio
- async def test_add_to_print_queue_broadcasts_archive_created(self, tmp_path):
- """#1282: VP queue-mode uploads must broadcast archive_created so the
- Archives page picks up the new entry live. Pre-fix the page only
- refreshed when the user manually switched tabs."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- mock_db = AsyncMock()
- mock_db.add = MagicMock()
- mock_db.commit = AsyncMock()
- mock_session_factory = MagicMock()
- mock_session_ctx = AsyncMock()
- mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
- mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
- mock_session_factory.return_value = mock_session_ctx
- inst = VirtualPrinterInstance(
- vp_id=31,
- name="QueueBroadcast",
- mode="queue",
- model="C12",
- access_code="12345678",
- serial_suffix="391800031",
- auto_dispatch=True,
- base_dir=tmp_path,
- session_factory=mock_session_factory,
- )
- file_path = tmp_path / "test.3mf"
- file_path.write_bytes(b"fake3mf")
- mock_archive = MagicMock()
- mock_archive.id = 77
- mock_archive.printer_id = None
- mock_archive.filename = "test.3mf"
- mock_archive.print_name = "test"
- mock_archive.status = "archived"
- with (
- patch(
- "backend.app.api.routes.settings.get_setting",
- new_callable=AsyncMock,
- return_value=None,
- ),
- patch(
- "backend.app.services.archive.ArchiveService.archive_print",
- new_callable=AsyncMock,
- return_value=mock_archive,
- ),
- patch(
- "backend.app.core.websocket.ws_manager.send_archive_created",
- new_callable=AsyncMock,
- ) as mock_broadcast,
- ):
- await inst._add_to_print_queue(file_path, "192.168.1.100")
- mock_broadcast.assert_awaited_once()
- payload = mock_broadcast.await_args.args[0]
- assert payload["id"] == 77
- assert payload["print_name"] == "test"
- assert payload["status"] == "archived"
- @pytest.mark.asyncio
- async def test_add_to_print_queue_with_auto_dispatch_off(self, tmp_path):
- """Verify queue items have manual_start=True when auto_dispatch=False."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- mock_db = AsyncMock()
- added_items = []
- def capture_add(item):
- added_items.append(item)
- mock_db.add = MagicMock(side_effect=capture_add)
- mock_db.commit = AsyncMock()
- mock_session_factory = MagicMock()
- mock_session_ctx = AsyncMock()
- mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
- mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
- mock_session_factory.return_value = mock_session_ctx
- inst = VirtualPrinterInstance(
- vp_id=12,
- name="AutoDispatchOff",
- mode="queue",
- model="C11",
- access_code="12345678",
- serial_suffix="391800012",
- auto_dispatch=False,
- base_dir=tmp_path,
- session_factory=mock_session_factory,
- )
- # Create a temp 3mf file
- file_path = tmp_path / "test.3mf"
- file_path.write_bytes(b"fake3mf")
- mock_archive = MagicMock()
- mock_archive.id = 1
- mock_archive.print_name = "test"
- with (
- patch(
- "backend.app.api.routes.settings.get_setting",
- new_callable=AsyncMock,
- return_value=None,
- ),
- patch(
- "backend.app.services.archive.ArchiveService.archive_print",
- new_callable=AsyncMock,
- return_value=mock_archive,
- ),
- ):
- await inst._add_to_print_queue(file_path, "192.168.1.100")
- assert len(added_items) == 1
- queue_item = added_items[0]
- assert queue_item.manual_start is True
- @pytest.mark.asyncio
- async def test_add_to_print_queue_uses_workflow_defaults_from_settings(self, tmp_path):
- """#1235: VP queue-mode constructed PrintQueueItem without specifying
- bed_levelling / flow_cali / vibration_cali / layer_inspect / timelapse,
- so SQLAlchemy applied the column-level defaults and ignored the user's
- workflow preferences entirely. Every print sent from the slicer to the
- VP came through with the OPPOSITE of what the workflow page said,
- forcing the user to edit each queue item by hand.
- """
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- added_items = []
- mock_db = AsyncMock()
- mock_db.add = MagicMock(side_effect=added_items.append)
- mock_db.commit = AsyncMock()
- mock_session_factory = MagicMock()
- mock_session_ctx = AsyncMock()
- mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
- mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
- mock_session_factory.return_value = mock_session_ctx
- inst = VirtualPrinterInstance(
- vp_id=22,
- name="DefaultsTest",
- mode="queue",
- model="C12",
- access_code="12345678",
- serial_suffix="391800022",
- auto_dispatch=True,
- base_dir=tmp_path,
- session_factory=mock_session_factory,
- )
- file_path = tmp_path / "test.3mf"
- file_path.write_bytes(b"fake3mf")
- # The reporter set every workflow default to the OPPOSITE of the model's
- # column default. Pre-fix the column defaults won; with the fix the
- # settings values must flow through to the queue item exactly as stored.
- settings_map = {
- "virtual_printer_archive_name_source": None,
- "default_bed_levelling": "false", # model default: True
- "default_flow_cali": "true", # model default: False
- "default_vibration_cali": "false", # model default: True
- "default_layer_inspect": "true", # model default: False
- "default_timelapse": "true", # model default: False
- }
- async def fake_get_setting(_db, key):
- return settings_map.get(key)
- mock_archive = MagicMock()
- mock_archive.id = 1
- mock_archive.print_name = "test"
- with (
- patch(
- "backend.app.api.routes.settings.get_setting",
- new=fake_get_setting,
- ),
- patch(
- "backend.app.services.archive.ArchiveService.archive_print",
- new_callable=AsyncMock,
- return_value=mock_archive,
- ),
- ):
- await inst._add_to_print_queue(file_path, "192.168.1.100")
- assert len(added_items) == 1
- queue_item = added_items[0]
- assert queue_item.bed_levelling is False, "default_bed_levelling=false must flow through"
- assert queue_item.flow_cali is True, "default_flow_cali=true must flow through"
- assert queue_item.vibration_cali is False, "default_vibration_cali=false must flow through"
- assert queue_item.layer_inspect is True, "default_layer_inspect=true must flow through"
- assert queue_item.timelapse is True, "default_timelapse=true must flow through"
- @pytest.mark.asyncio
- async def test_add_to_print_queue_falls_back_to_schema_defaults_when_unset(self, tmp_path):
- """#1235 fallback: when no workflow setting is in the DB, the queue
- item should use the AppSettings (Pydantic) defaults — same values
- the user sees in the workflow page on a fresh install.
- """
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- added_items = []
- mock_db = AsyncMock()
- mock_db.add = MagicMock(side_effect=added_items.append)
- mock_db.commit = AsyncMock()
- mock_session_factory = MagicMock()
- mock_session_ctx = AsyncMock()
- mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
- mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
- mock_session_factory.return_value = mock_session_ctx
- inst = VirtualPrinterInstance(
- vp_id=23,
- name="FreshInstallDefaults",
- mode="queue",
- model="C12",
- access_code="12345678",
- serial_suffix="391800023",
- auto_dispatch=True,
- base_dir=tmp_path,
- session_factory=mock_session_factory,
- )
- file_path = tmp_path / "test.3mf"
- file_path.write_bytes(b"fake3mf")
- mock_archive = MagicMock()
- mock_archive.id = 1
- mock_archive.print_name = "test"
- with (
- patch(
- "backend.app.api.routes.settings.get_setting",
- new_callable=AsyncMock,
- return_value=None, # No settings → fall back to schema defaults
- ),
- patch(
- "backend.app.services.archive.ArchiveService.archive_print",
- new_callable=AsyncMock,
- return_value=mock_archive,
- ),
- ):
- await inst._add_to_print_queue(file_path, "192.168.1.100")
- assert len(added_items) == 1
- queue_item = added_items[0]
- # These must match the AppSettings (Pydantic) defaults in schemas/settings.py
- assert queue_item.bed_levelling is True
- assert queue_item.flow_cali is False
- assert queue_item.vibration_cali is True
- assert queue_item.layer_inspect is False
- assert queue_item.timelapse is False
- @pytest.mark.asyncio
- async def test_add_to_print_queue_inherits_slicer_print_options(self, tmp_path):
- """#1403: VP-queue items used to fall back to `default_timelapse` even
- though the slicer's MQTT `project_file` command carries the user's
- actual choice. Capture-via-`on_print_command` flow lets the user's
- slicer toggle reach the queue item.
- Settings here have timelapse OFF; the slicer's MQTT capture has it ON.
- After the fix the queue item must reflect the slicer's choice.
- """
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- added_items = []
- mock_db = AsyncMock()
- mock_db.add = MagicMock(side_effect=added_items.append)
- mock_db.commit = AsyncMock()
- mock_session_factory = MagicMock()
- mock_session_ctx = AsyncMock()
- mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
- mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
- mock_session_factory.return_value = mock_session_ctx
- inst = VirtualPrinterInstance(
- vp_id=24,
- name="SlicerInherits",
- mode="queue",
- model="C12",
- access_code="12345678",
- serial_suffix="391800024",
- auto_dispatch=True,
- base_dir=tmp_path,
- session_factory=mock_session_factory,
- )
- file_path = tmp_path / "test.3mf"
- file_path.write_bytes(b"fake3mf")
- # Pre-populate the capture as if MQTT `project_file` arrived already.
- # Settings (below) deliberately have timelapse OFF — only the slicer
- # capture should drive the resulting queue item.
- await inst.on_print_command(
- file_path.name,
- {
- "command": "project_file",
- "timelapse": True,
- "bed_leveling": False, # Note: MQTT field is single-L `bed_leveling`
- "flow_cali": True,
- "vibration_cali": False,
- "layer_inspect": True,
- },
- )
- settings_map = {
- "virtual_printer_archive_name_source": None,
- "default_bed_levelling": "true",
- "default_flow_cali": "false",
- "default_vibration_cali": "true",
- "default_layer_inspect": "false",
- "default_timelapse": "false",
- }
- async def fake_get_setting(_db, key):
- return settings_map.get(key)
- mock_archive = MagicMock()
- mock_archive.id = 1
- mock_archive.print_name = "test"
- with (
- patch(
- "backend.app.api.routes.settings.get_setting",
- new=fake_get_setting,
- ),
- patch(
- "backend.app.services.archive.ArchiveService.archive_print",
- new_callable=AsyncMock,
- return_value=mock_archive,
- ),
- ):
- await inst._add_to_print_queue(file_path, "192.168.1.100")
- assert len(added_items) == 1
- queue_item = added_items[0]
- assert queue_item.timelapse is True, "Slicer's timelapse=True must override settings.default_timelapse=False"
- assert queue_item.bed_levelling is False, "Slicer's bed_leveling=False must override default_bed_levelling=True"
- assert queue_item.flow_cali is True
- assert queue_item.vibration_cali is False
- assert queue_item.layer_inspect is True
- # Capture is consumed — no lingering state for the next print of the same name.
- assert file_path.name not in inst._slicer_print_options
- @pytest.mark.asyncio
- async def test_add_to_print_queue_coerces_slicer_integer_zero_one(self, tmp_path):
- """#1403: H-family firmwares carry calibration flags as integers
- (0/1) rather than booleans. The capture must coerce both shapes so
- H-family-sliced jobs through the VP queue work the same as P1/X1.
- """
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- added_items = []
- mock_db = AsyncMock()
- mock_db.add = MagicMock(side_effect=added_items.append)
- mock_db.commit = AsyncMock()
- mock_session_factory = MagicMock()
- mock_session_ctx = AsyncMock()
- mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
- mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
- mock_session_factory.return_value = mock_session_ctx
- inst = VirtualPrinterInstance(
- vp_id=25,
- name="SlicerIntegers",
- mode="queue",
- model="C12",
- access_code="12345678",
- serial_suffix="391800025",
- auto_dispatch=True,
- base_dir=tmp_path,
- session_factory=mock_session_factory,
- )
- file_path = tmp_path / "test.3mf"
- file_path.write_bytes(b"fake3mf")
- await inst.on_print_command(
- file_path.name,
- {"command": "project_file", "timelapse": 1, "bed_leveling": 0, "flow_cali": 1},
- )
- mock_archive = MagicMock()
- mock_archive.id = 1
- mock_archive.print_name = "test"
- with (
- patch(
- "backend.app.api.routes.settings.get_setting",
- new_callable=AsyncMock,
- return_value=None,
- ),
- patch(
- "backend.app.services.archive.ArchiveService.archive_print",
- new_callable=AsyncMock,
- return_value=mock_archive,
- ),
- ):
- await inst._add_to_print_queue(file_path, "192.168.1.100")
- assert len(added_items) == 1
- queue_item = added_items[0]
- assert queue_item.timelapse is True, "integer 1 must coerce to True"
- assert queue_item.bed_levelling is False, "integer 0 must coerce to False"
- assert queue_item.flow_cali is True
- @pytest.mark.asyncio
- async def test_add_to_print_queue_populates_required_filament_types(self, tmp_path):
- """#1188: VP queue-mode used to create PrintQueueItems with no
- filament fields, so the scheduler fell through to model-only matching
- and dispatched onto whatever printer was free regardless of loaded
- colour. ``required_filament_types`` is populated unconditionally
- (cheap, helps the scheduler validate type even without
- ``force_color_match``) — pin that contract here."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- added_items = []
- mock_db = AsyncMock()
- mock_db.add = MagicMock(side_effect=added_items.append)
- mock_db.commit = AsyncMock()
- mock_session_factory = MagicMock()
- mock_session_ctx = AsyncMock()
- mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
- mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
- mock_session_factory.return_value = mock_session_ctx
- inst = VirtualPrinterInstance(
- vp_id=21,
- name="Reqs",
- mode="queue",
- model="C12",
- access_code="12345678",
- serial_suffix="391800021",
- auto_dispatch=True,
- queue_force_color_match=False, # off → only required_filament_types
- base_dir=tmp_path,
- session_factory=mock_session_factory,
- )
- file_path = tmp_path / "multi.3mf"
- _write_3mf_with_filaments(
- file_path,
- [
- {"id": "1", "type": "PLA", "color": "#FFFFFF", "used_g": "12.3"},
- {"id": "2", "type": "PETG", "color": "#000000", "used_g": "4.5"},
- # used_g=0 → not actually consumed by this plate, must be ignored
- {"id": "3", "type": "ABS", "color": "#FF0000", "used_g": "0"},
- ],
- plate_index=1,
- )
- mock_archive = MagicMock()
- mock_archive.id = 1
- mock_archive.print_name = "multi"
- with (
- patch(
- "backend.app.api.routes.settings.get_setting",
- new_callable=AsyncMock,
- return_value=None,
- ),
- patch(
- "backend.app.services.archive.ArchiveService.archive_print",
- new_callable=AsyncMock,
- return_value=mock_archive,
- ),
- ):
- await inst._add_to_print_queue(file_path, "192.168.1.100")
- assert len(added_items) == 1
- queue_item = added_items[0]
- # Type-only fallback always populated. Sorted, deduped, no zero-use ABS.
- assert queue_item.required_filament_types is not None
- assert json.loads(queue_item.required_filament_types) == ["PETG", "PLA"]
- # Setting off → no force_color_match overrides leaked.
- assert queue_item.filament_overrides is None
- @pytest.mark.asyncio
- async def test_add_to_print_queue_force_color_match_writes_overrides(self, tmp_path):
- """#1188 core fix: when the per-VP ``queue_force_color_match`` toggle
- is on, every consumed slot lands as a ``filament_overrides`` entry
- with ``force_color_match: true``. This is the field the scheduler
- keys on (``print_scheduler.py:512``) — without it, slot-by-slot
- type+color matching never runs."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- added_items = []
- mock_db = AsyncMock()
- mock_db.add = MagicMock(side_effect=added_items.append)
- mock_db.commit = AsyncMock()
- mock_session_factory = MagicMock()
- mock_session_ctx = AsyncMock()
- mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
- mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
- mock_session_factory.return_value = mock_session_ctx
- inst = VirtualPrinterInstance(
- vp_id=22,
- name="ForceColor",
- mode="queue",
- model="C12",
- access_code="12345678",
- serial_suffix="391800022",
- auto_dispatch=True,
- queue_force_color_match=True, # on
- base_dir=tmp_path,
- session_factory=mock_session_factory,
- )
- file_path = tmp_path / "forced.3mf"
- _write_3mf_with_filaments(
- file_path,
- [
- {"id": "1", "type": "PLA", "color": "#FFFFFF", "used_g": "10.0"},
- {"id": "2", "type": "PLA", "color": "#FF00FF", "used_g": "5.0"},
- ],
- plate_index=1,
- )
- mock_archive = MagicMock()
- mock_archive.id = 1
- mock_archive.print_name = "forced"
- with (
- patch(
- "backend.app.api.routes.settings.get_setting",
- new_callable=AsyncMock,
- return_value=None,
- ),
- patch(
- "backend.app.services.archive.ArchiveService.archive_print",
- new_callable=AsyncMock,
- return_value=mock_archive,
- ),
- ):
- await inst._add_to_print_queue(file_path, "192.168.1.100")
- assert len(added_items) == 1
- queue_item = added_items[0]
- assert queue_item.filament_overrides is not None
- overrides = json.loads(queue_item.filament_overrides)
- assert overrides == [
- {"slot_id": 1, "type": "PLA", "color": "#FFFFFF", "force_color_match": True},
- {"slot_id": 2, "type": "PLA", "color": "#FF00FF", "force_color_match": True},
- ]
- # required_filament_types still populated alongside overrides.
- assert json.loads(queue_item.required_filament_types) == ["PLA"]
- @pytest.mark.asyncio
- async def test_add_to_print_queue_force_color_match_skips_when_3mf_unparseable(self, tmp_path):
- """A malformed or fake-bytes 3MF must not crash the upload path —
- we just write the queue item with no filament fields and let the
- scheduler fall back to model-only matching (the pre-#1188 default).
- Regression guard for the existing fake-bytes happy-path tests."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- added_items = []
- mock_db = AsyncMock()
- mock_db.add = MagicMock(side_effect=added_items.append)
- mock_db.commit = AsyncMock()
- mock_session_factory = MagicMock()
- mock_session_ctx = AsyncMock()
- mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
- mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
- mock_session_factory.return_value = mock_session_ctx
- inst = VirtualPrinterInstance(
- vp_id=23,
- name="Unparseable",
- mode="queue",
- model="C12",
- access_code="12345678",
- serial_suffix="391800023",
- auto_dispatch=True,
- queue_force_color_match=True,
- base_dir=tmp_path,
- session_factory=mock_session_factory,
- )
- file_path = tmp_path / "bad.3mf"
- file_path.write_bytes(b"not a real 3mf zip")
- mock_archive = MagicMock()
- mock_archive.id = 1
- mock_archive.print_name = "bad"
- with (
- patch(
- "backend.app.api.routes.settings.get_setting",
- new_callable=AsyncMock,
- return_value=None,
- ),
- patch(
- "backend.app.services.archive.ArchiveService.archive_print",
- new_callable=AsyncMock,
- return_value=mock_archive,
- ),
- ):
- await inst._add_to_print_queue(file_path, "192.168.1.100")
- assert len(added_items) == 1
- queue_item = added_items[0]
- # No filament data extractable → both fields stay None (graceful
- # fallback to model-only scheduling).
- assert queue_item.required_filament_types is None
- assert queue_item.filament_overrides is None
- # ========================================================================
- # Tests for archive_name_source setting (#1152)
- # ========================================================================
- @pytest.mark.asyncio
- @pytest.mark.parametrize(
- ("setting_value", "expected_prefer_filename"),
- [
- ("filename", True),
- ("metadata", False),
- (None, False), # Default when setting unset
- ("", False), # Defensive: empty string is not "filename"
- ],
- )
- async def test_archive_file_passes_prefer_filename_per_setting(
- self, tmp_path, setting_value, expected_prefer_filename
- ):
- """_archive_file reads `virtual_printer_archive_name_source` and forwards
- prefer_filename_for_name=True only when it equals 'filename' (#1152)."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- mock_db = AsyncMock()
- mock_session_factory = MagicMock()
- mock_session_ctx = AsyncMock()
- mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
- mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
- mock_session_factory.return_value = mock_session_ctx
- inst = VirtualPrinterInstance(
- vp_id=20,
- name="NameSource",
- mode="archive",
- model="C11",
- access_code="12345678",
- serial_suffix="391800020",
- base_dir=tmp_path,
- session_factory=mock_session_factory,
- )
- file_path = tmp_path / "user-renamed-job.3mf"
- file_path.write_bytes(b"fake3mf")
- mock_archive = MagicMock()
- mock_archive.id = 1
- mock_archive.print_name = "user-renamed-job"
- archive_print_mock = AsyncMock(return_value=mock_archive)
- with (
- patch(
- "backend.app.api.routes.settings.get_setting",
- new_callable=AsyncMock,
- return_value=setting_value,
- ),
- patch(
- "backend.app.services.archive.ArchiveService.archive_print",
- archive_print_mock,
- ),
- ):
- await inst._archive_file(file_path, "192.168.1.100")
- assert archive_print_mock.await_count == 1
- kwargs = archive_print_mock.await_args.kwargs
- assert kwargs.get("prefer_filename_for_name") is expected_prefer_filename
- # ========================================================================
- # Tests for failure-path cleanup (#audit-R2-1)
- # ========================================================================
- #
- # All three file handlers (_archive_file, _queue_file, _add_to_print_queue)
- # previously only popped _pending_files and unlinked the temp file on the
- # success branch. Failure paths leaked the marker (blocking same-name
- # retries via the FTP layer) and the temp file on disk. The cleanup must
- # ALWAYS run, even when archival / queue insert raises.
- @pytest.mark.asyncio
- async def test_archive_file_failure_path_pops_pending_and_unlinks(self, tmp_path):
- """When the archive layer raises, `_pending_files[filename]` must still
- be popped and the temp file must be unlinked. Otherwise the FTP layer's
- same-name retry guard would silently reject the slicer's next attempt
- and the upload_dir would accumulate ghost files."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- mock_db = AsyncMock()
- mock_session_factory = MagicMock()
- mock_session_ctx = AsyncMock()
- mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
- mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
- mock_session_factory.return_value = mock_session_ctx
- inst = VirtualPrinterInstance(
- vp_id=40,
- name="ArchiveFailCleanup",
- mode="archive",
- model="C12",
- access_code="12345678",
- serial_suffix="391800040",
- base_dir=tmp_path,
- session_factory=mock_session_factory,
- )
- file_path = tmp_path / "cleanup-archive.3mf"
- file_path.write_bytes(b"fake3mf")
- inst._pending_files[file_path.name] = file_path
- with (
- patch(
- "backend.app.api.routes.settings.get_setting",
- new_callable=AsyncMock,
- return_value=None,
- ),
- patch(
- "backend.app.services.archive.ArchiveService.archive_print",
- new_callable=AsyncMock,
- side_effect=RuntimeError("archive blew up"),
- ),
- ):
- await inst._archive_file(file_path, "192.168.1.100")
- assert file_path.name not in inst._pending_files
- assert not file_path.exists()
- @pytest.mark.asyncio
- async def test_queue_file_failure_path_pops_pending_and_unlinks(self, tmp_path):
- """Same invariant for _queue_file: a DB error during PendingUpload
- insert must not leak the in-flight marker or the temp file."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- mock_db = AsyncMock()
- # Commit raises — emulating a DB connectivity error.
- mock_db.add = MagicMock()
- mock_db.commit = AsyncMock(side_effect=RuntimeError("db unreachable"))
- mock_session_factory = MagicMock()
- mock_session_ctx = AsyncMock()
- mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
- mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
- mock_session_factory.return_value = mock_session_ctx
- inst = VirtualPrinterInstance(
- vp_id=41,
- name="QueueFailCleanup",
- mode="review",
- model="C12",
- access_code="12345678",
- serial_suffix="391800041",
- base_dir=tmp_path,
- session_factory=mock_session_factory,
- )
- file_path = tmp_path / "cleanup-queue.3mf"
- file_path.write_bytes(b"fake3mf")
- inst._pending_files[file_path.name] = file_path
- await inst._queue_file(file_path, "192.168.1.100")
- assert file_path.name not in inst._pending_files
- assert not file_path.exists()
- @pytest.mark.asyncio
- async def test_add_to_print_queue_failure_path_pops_pending_and_unlinks(self, tmp_path):
- """Same invariant for _add_to_print_queue: a DB error or archive
- failure must not leak the in-flight marker or the temp file."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- mock_db = AsyncMock()
- mock_db.add = MagicMock()
- mock_db.commit = AsyncMock()
- mock_db.execute = AsyncMock(side_effect=RuntimeError("queue insert blew up"))
- mock_session_factory = MagicMock()
- mock_session_ctx = AsyncMock()
- mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
- mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
- mock_session_factory.return_value = mock_session_ctx
- inst = VirtualPrinterInstance(
- vp_id=42,
- name="DispatchFailCleanup",
- mode="queue",
- model="C12",
- access_code="12345678",
- serial_suffix="391800042",
- auto_dispatch=True,
- base_dir=tmp_path,
- session_factory=mock_session_factory,
- )
- file_path = tmp_path / "cleanup-dispatch.3mf"
- file_path.write_bytes(b"fake3mf")
- inst._pending_files[file_path.name] = file_path
- with patch(
- "backend.app.api.routes.settings.get_setting",
- new_callable=AsyncMock,
- return_value=None,
- ):
- await inst._add_to_print_queue(file_path, "192.168.1.100")
- assert file_path.name not in inst._pending_files
- assert not file_path.exists()
- # ========================================================================
- # Test for position=MAX+1 (audit-R2)
- # ========================================================================
- @pytest.mark.asyncio
- async def test_add_to_print_queue_position_picks_max_plus_one(self, tmp_path):
- """VP-queue items previously got hardcoded `position=1`, colliding
- with existing items at position 1 and producing non-deterministic
- execution order. Now the position is chosen by `MAX(position)+1`
- against the target queue, matching the canonical `POST /print-queue/`
- path."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- # Capture the inserted PrintQueueItem so we can assert on .position.
- added_items: list = []
- class _RecordingDb:
- def __init__(self):
- self.add = lambda item: added_items.append(item)
- self.commit = AsyncMock()
- async def execute(self, query): # noqa: ARG002
- """Return a stub result whose `.scalar()` reports the existing
- MAX(position) for the target. Returning 7 means the new item
- should land at 8."""
- result = MagicMock()
- result.scalar = MagicMock(return_value=7)
- return result
- mock_db = _RecordingDb()
- mock_session_factory = MagicMock()
- mock_session_ctx = AsyncMock()
- mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
- mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
- mock_session_factory.return_value = mock_session_ctx
- inst = VirtualPrinterInstance(
- vp_id=43,
- name="PositionMaxPlusOne",
- mode="queue",
- model="C12",
- access_code="12345678",
- serial_suffix="391800043",
- target_printer_id=99,
- auto_dispatch=True,
- base_dir=tmp_path,
- session_factory=mock_session_factory,
- )
- file_path = tmp_path / "next-position.3mf"
- file_path.write_bytes(b"fake3mf")
- mock_archive = MagicMock()
- mock_archive.id = 555
- mock_archive.printer_id = None
- mock_archive.filename = "next-position.3mf"
- mock_archive.print_name = "next-position"
- mock_archive.status = "archived"
- with (
- patch(
- "backend.app.api.routes.settings.get_setting",
- new_callable=AsyncMock,
- return_value=None,
- ),
- patch(
- "backend.app.services.archive.ArchiveService.archive_print",
- new_callable=AsyncMock,
- return_value=mock_archive,
- ),
- patch(
- "backend.app.core.websocket.ws_manager.send_archive_created",
- new_callable=AsyncMock,
- ),
- ):
- await inst._add_to_print_queue(file_path, "192.168.1.100")
- # One queue item was added.
- assert len(added_items) == 1
- queue_item = added_items[0]
- # Position = max(7) + 1 = 8 — NOT the legacy hardcoded 1.
- assert queue_item.position == 8
- @pytest.mark.asyncio
- async def test_add_to_print_queue_multi_plate_send_all_enqueues_one_per_plate(self, tmp_path):
- """#1733: BambuStudio / OrcaSlicer "Send All" of a multi-plate project
- uploads ONE 3MF containing every plate. Pre-fix only the first plate
- index was extracted and one queue item was created; plates 2..N were
- silently dropped. Post-fix every `<plate>` block in `slice_info.config`
- produces its own PrintQueueItem with the correct ``plate_id``, sharing
- the same backing archive, with consecutive positions for plate-order
- execution.
- """
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- added_items: list = []
- class _RecordingDb:
- def __init__(self):
- # Capture inserted items as they're added; assign a fake .id
- # on flush so the manager's logger doesn't see None.
- self._next_id = 1000
- def _add(item):
- added_items.append(item)
- self.add = _add
- self.commit = AsyncMock()
- async def execute(self, query): # noqa: ARG002
- """Return MAX(position) = 0 so plate items land at 1, 2, 3."""
- result = MagicMock()
- result.scalar = MagicMock(return_value=0)
- return result
- async def flush(self):
- # Mimic the FK populate so queue_item.id is available after add().
- for item in added_items:
- if getattr(item, "id", None) is None:
- item.id = self._next_id
- self._next_id += 1
- mock_db = _RecordingDb()
- mock_session_factory = MagicMock()
- mock_session_ctx = AsyncMock()
- mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
- mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
- mock_session_factory.return_value = mock_session_ctx
- inst = VirtualPrinterInstance(
- vp_id=44,
- name="MultiPlateSendAll",
- mode="queue",
- model="O1D", # H2D — matches the live VP H2D-1 Proxy in #1733
- access_code="12345678",
- serial_suffix="391800044",
- target_printer_id=1,
- auto_dispatch=False, # manual_start, mirrors the live VP
- base_dir=tmp_path,
- session_factory=mock_session_factory,
- )
- # Build a 3MF with three plates baked into slice_info.config —
- # mirrors what BambuStudio / OrcaSlicer's "Send All" puts on the wire.
- file_path = tmp_path / "Cube.gcode.3mf"
- _write_3mf_with_filaments(
- file_path, [{"id": 1, "type": "PLA", "color": "#000000", "used_g": "15.61"}], plate_index=1
- )
- # Append plate 2 and 3 blocks to slice_info.config to mimic Send All.
- with zipfile.ZipFile(file_path, "r") as zf:
- existing = zf.read("Metadata/slice_info.config").decode()
- # Inject two additional <plate> blocks (indices 2 and 3) inside <config>.
- multi_plate_config = existing.replace(
- "</config>",
- (
- '<plate><metadata key="index" value="2"/>'
- '<filament id="2" type="PETG" color="#FB0207" used_g="14.45"/>'
- "</plate>"
- '<plate><metadata key="index" value="3"/>'
- '<filament id="3" type="PLA" color="#FFFFFF" used_g="12.10"/>'
- "</plate>"
- "</config>"
- ),
- )
- # Repack the zip with the expanded slice_info.config.
- import io as _io
- buf = _io.BytesIO()
- with zipfile.ZipFile(file_path, "r") as src, zipfile.ZipFile(buf, "w") as dst:
- for name in src.namelist():
- if name == "Metadata/slice_info.config":
- dst.writestr(name, multi_plate_config)
- else:
- dst.writestr(name, src.read(name))
- # Plate-2 and plate-3 gcode payloads so `extract_filament_requirements`
- # has something to read for each — contents irrelevant, presence matters.
- dst.writestr("Metadata/plate_2.gcode", "; plate 2 gcode\n")
- dst.writestr("Metadata/plate_3.gcode", "; plate 3 gcode\n")
- file_path.write_bytes(buf.getvalue())
- mock_archive = MagicMock()
- mock_archive.id = 999
- mock_archive.printer_id = None
- mock_archive.filename = "Cube.gcode.3mf"
- mock_archive.print_name = "Cube"
- mock_archive.status = "archived"
- with (
- patch(
- "backend.app.api.routes.settings.get_setting",
- new_callable=AsyncMock,
- return_value=None,
- ),
- patch(
- "backend.app.services.archive.ArchiveService.archive_print",
- new_callable=AsyncMock,
- return_value=mock_archive,
- ),
- patch(
- "backend.app.core.websocket.ws_manager.send_archive_created",
- new_callable=AsyncMock,
- ),
- ):
- await inst._add_to_print_queue(file_path, "192.168.1.100")
- # Three queue items, one per plate, with the correct plate_id and
- # consecutive positions starting at MAX(position)+1 = 1.
- assert len(added_items) == 3, f"Expected 3 queue items for 3-plate Send All, got {len(added_items)}"
- plate_ids = [q.plate_id for q in added_items]
- assert plate_ids == [1, 2, 3], f"plate_ids should preserve slice_info order, got {plate_ids}"
- positions = [q.position for q in added_items]
- assert positions == [1, 2, 3], f"positions should be consecutive, got {positions}"
- archive_ids = {q.archive_id for q in added_items}
- assert archive_ids == {999}, f"All queue items must share the single backing archive, got {archive_ids}"
- # auto_dispatch=False on the VP → every item is manual_start.
- assert all(q.manual_start for q in added_items)
- class TestVirtualPrinterManager:
- """Tests for VirtualPrinterManager orchestrator."""
- @pytest.fixture
- def manager(self):
- """Create a VirtualPrinterManager instance."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterManager
- return VirtualPrinterManager()
- def test_manager_starts_empty(self, manager):
- """Verify manager starts with no instances."""
- assert len(manager._instances) == 0
- assert manager.is_enabled is False
- def test_manager_get_status_empty(self, manager):
- """Verify get_status returns disabled state when no instances."""
- status = manager.get_status()
- assert status["enabled"] is False
- assert status["running"] is False
- assert status["mode"] == "archive"
- def test_manager_is_enabled_with_instance(self, manager, tmp_path):
- """Verify is_enabled is True when instances exist."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- inst = VirtualPrinterInstance(
- vp_id=1,
- name="Test",
- mode="archive",
- model="C11",
- access_code="12345678",
- serial_suffix="391800001",
- base_dir=tmp_path,
- )
- manager._instances[1] = inst
- assert manager.is_enabled is True
- @pytest.mark.asyncio
- async def test_manager_remove_instance_server(self, manager, tmp_path):
- """Verify remove_instance stops and removes a server-mode instance."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- inst = VirtualPrinterInstance(
- vp_id=1,
- name="Test",
- mode="archive",
- model="C11",
- access_code="12345678",
- serial_suffix="391800001",
- base_dir=tmp_path,
- )
- inst.stop_server = AsyncMock()
- manager._instances[1] = inst
- await manager.remove_instance(1)
- assert 1 not in manager._instances
- inst.stop_server.assert_called_once()
- @pytest.mark.asyncio
- async def test_manager_remove_instance_proxy(self, manager, tmp_path):
- """Verify remove_instance stops proxy-mode instance."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- inst = VirtualPrinterInstance(
- vp_id=2,
- name="Proxy",
- mode="proxy",
- model="C11",
- access_code="",
- serial_suffix="391800002",
- target_printer_ip="192.168.1.100",
- base_dir=tmp_path,
- )
- inst.stop_proxy = AsyncMock()
- manager._instances[2] = inst
- await manager.remove_instance(2)
- assert 2 not in manager._instances
- inst.stop_proxy.assert_called_once()
- def test_manager_get_status_with_instance(self, manager, tmp_path):
- """Verify legacy get_status returns first instance data."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- inst = VirtualPrinterInstance(
- vp_id=1,
- name="Bambuddy",
- mode="archive",
- model="C11",
- access_code="12345678",
- serial_suffix="391800001",
- base_dir=tmp_path,
- )
- mock_task = MagicMock(done=MagicMock(return_value=False))
- inst._tasks = [mock_task]
- inst._pending_files = {"file1.3mf": Path("/tmp/file1.3mf")} # nosec B108
- manager._instances[1] = inst
- status = manager.get_status()
- assert status["enabled"] is True
- assert status["running"] is True
- assert status["mode"] == "archive"
- assert status["name"] == "Bambuddy"
- assert status["serial"] == "01S00A391800001"
- assert status["model"] == "C11"
- assert status["model_name"] == "P1P"
- assert status["pending_files"] == 1
- def test_manager_get_all_status(self, manager, tmp_path):
- """Verify get_all_status returns status for all instances."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- for i in range(1, 3):
- inst = VirtualPrinterInstance(
- vp_id=i,
- name=f"VP{i}",
- mode="archive",
- model="C11",
- access_code="12345678",
- serial_suffix=f"39180000{i}",
- base_dir=tmp_path,
- )
- manager._instances[i] = inst
- statuses = manager.get_all_status()
- assert len(statuses) == 2
- assert statuses[0]["name"] == "VP1"
- assert statuses[1]["name"] == "VP2"
- @pytest.mark.asyncio
- async def test_manager_stop_all(self, manager, tmp_path):
- """Verify stop_all removes all instances."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- for i in range(1, 3):
- inst = VirtualPrinterInstance(
- vp_id=i,
- name=f"VP{i}",
- mode="archive",
- model="C11",
- access_code="12345678",
- serial_suffix=f"39180000{i}",
- base_dir=tmp_path,
- )
- inst.stop_server = AsyncMock()
- manager._instances[i] = inst
- await manager.stop_all()
- assert len(manager._instances) == 0
- # ========================================================================
- # Tests for sync_from_db config change detection
- # ========================================================================
- def _make_db_vp(self, **overrides):
- """Create a mock VirtualPrinter DB object."""
- defaults = {
- "id": 1,
- "name": "TestVP",
- "enabled": True,
- "mode": "archive",
- "model": "C11",
- "access_code": "12345678",
- "serial_suffix": "391800001",
- "bind_ip": "",
- "remote_interface_ip": "",
- "target_printer_id": None,
- "auto_dispatch": True,
- "tailscale_disabled": True, # Opt-in default (#1070 UX fix)
- "queue_force_color_match": False, # default — must be explicit so MagicMock truthiness doesn't trip the change detector
- "position": 0,
- }
- defaults.update(overrides)
- vp = MagicMock()
- for k, v in defaults.items():
- setattr(vp, k, v)
- return vp
- def _setup_sync_mocks(self, manager, enabled_vps, tmp_path):
- """Wire up session_factory mock for sync_from_db."""
- mock_result = MagicMock()
- mock_result.scalars.return_value.all.return_value = enabled_vps
- mock_db = AsyncMock()
- mock_db.execute = AsyncMock(return_value=mock_result)
- mock_db.__aenter__ = AsyncMock(return_value=mock_db)
- mock_db.__aexit__ = AsyncMock(return_value=False)
- manager._session_factory = MagicMock(return_value=mock_db)
- manager._base_dir = tmp_path
- @pytest.mark.asyncio
- async def test_sync_from_db_restarts_on_mode_change(self, manager, tmp_path):
- """Verify sync_from_db restarts VP when mode changes."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- inst = VirtualPrinterInstance(
- vp_id=1,
- name="TestVP",
- mode="archive",
- model="C11",
- access_code="12345678",
- serial_suffix="391800001",
- base_dir=tmp_path,
- )
- inst.stop_server = AsyncMock()
- manager._instances[1] = inst
- # DB says mode changed to "review"
- db_vp = self._make_db_vp(mode="review")
- self._setup_sync_mocks(manager, [db_vp], tmp_path)
- with patch.object(manager, "remove_instance", new_callable=AsyncMock) as mock_remove:
- # Patch VirtualPrinterInstance to prevent actual start
- with patch("backend.app.services.virtual_printer.manager.VirtualPrinterInstance") as MockInst:
- mock_new = MagicMock()
- mock_new.start_server = AsyncMock()
- MockInst.return_value = mock_new
- await manager.sync_from_db()
- mock_remove.assert_called_once_with(1)
- @pytest.mark.asyncio
- async def test_sync_from_db_restarts_on_access_code_change(self, manager, tmp_path):
- """Verify sync_from_db restarts VP when access_code changes."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- inst = VirtualPrinterInstance(
- vp_id=1,
- name="TestVP",
- mode="archive",
- model="C11",
- access_code="12345678",
- serial_suffix="391800001",
- base_dir=tmp_path,
- )
- inst.stop_server = AsyncMock()
- manager._instances[1] = inst
- db_vp = self._make_db_vp(access_code="newcode99")
- self._setup_sync_mocks(manager, [db_vp], tmp_path)
- with patch.object(manager, "remove_instance", new_callable=AsyncMock) as mock_remove:
- with patch("backend.app.services.virtual_printer.manager.VirtualPrinterInstance") as MockInst:
- mock_new = MagicMock()
- mock_new.start_server = AsyncMock()
- MockInst.return_value = mock_new
- await manager.sync_from_db()
- mock_remove.assert_called_once_with(1)
- @pytest.mark.asyncio
- async def test_sync_from_db_skips_unchanged_instance(self, manager, tmp_path):
- """Verify sync_from_db does NOT restart when config is identical."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- inst = VirtualPrinterInstance(
- vp_id=1,
- name="TestVP",
- mode="archive",
- model="C11",
- access_code="12345678",
- serial_suffix="391800001",
- base_dir=tmp_path,
- )
- manager._instances[1] = inst
- # DB matches running config exactly
- db_vp = self._make_db_vp()
- self._setup_sync_mocks(manager, [db_vp], tmp_path)
- with patch.object(manager, "remove_instance", new_callable=AsyncMock) as mock_remove:
- await manager.sync_from_db()
- mock_remove.assert_not_called()
- @pytest.mark.asyncio
- async def test_sync_from_db_restarts_on_bind_ip_change(self, manager, tmp_path):
- """Verify sync_from_db restarts VP when bind_ip changes."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- inst = VirtualPrinterInstance(
- vp_id=1,
- name="TestVP",
- mode="archive",
- model="C11",
- access_code="12345678",
- serial_suffix="391800001",
- bind_ip="192.168.1.10",
- base_dir=tmp_path,
- )
- inst.stop_server = AsyncMock()
- manager._instances[1] = inst
- db_vp = self._make_db_vp(bind_ip="192.168.1.20")
- self._setup_sync_mocks(manager, [db_vp], tmp_path)
- with patch.object(manager, "remove_instance", new_callable=AsyncMock) as mock_remove:
- with patch("backend.app.services.virtual_printer.manager.VirtualPrinterInstance") as MockInst:
- mock_new = MagicMock()
- mock_new.start_server = AsyncMock()
- MockInst.return_value = mock_new
- await manager.sync_from_db()
- mock_remove.assert_called_once_with(1)
- @pytest.mark.asyncio
- async def test_sync_from_db_restarts_on_model_change(self, manager, tmp_path):
- """Verify sync_from_db restarts VP when model changes."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- inst = VirtualPrinterInstance(
- vp_id=1,
- name="TestVP",
- mode="archive",
- model="C11",
- access_code="12345678",
- serial_suffix="391800001",
- base_dir=tmp_path,
- )
- inst.stop_server = AsyncMock()
- manager._instances[1] = inst
- db_vp = self._make_db_vp(model="C12")
- self._setup_sync_mocks(manager, [db_vp], tmp_path)
- with patch.object(manager, "remove_instance", new_callable=AsyncMock) as mock_remove:
- with patch("backend.app.services.virtual_printer.manager.VirtualPrinterInstance") as MockInst:
- mock_new = MagicMock()
- mock_new.start_server = AsyncMock()
- MockInst.return_value = mock_new
- await manager.sync_from_db()
- mock_remove.assert_called_once_with(1)
- @pytest.mark.asyncio
- async def test_sync_from_db_does_not_restart_on_tailscale_toggle(self, manager, tmp_path):
- """Flipping tailscale_disabled is purely informational — must NOT trigger a restart.
- Cert provisioning was removed; the toggle only governs whether the VP card surfaces
- the host's Tailscale IP/FQDN to the user. No service needs to reload, so changing
- it through sync_from_db should leave any running instance untouched.
- """
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- inst = VirtualPrinterInstance(
- vp_id=1,
- name="TestVP",
- mode="archive",
- model="C11",
- access_code="12345678",
- serial_suffix="391800001",
- tailscale_disabled=False,
- base_dir=tmp_path,
- )
- inst.stop_server = AsyncMock()
- manager._instances[1] = inst
- db_vp = self._make_db_vp(tailscale_disabled=True)
- self._setup_sync_mocks(manager, [db_vp], tmp_path)
- with patch.object(manager, "remove_instance", new_callable=AsyncMock) as mock_remove:
- await manager.sync_from_db()
- mock_remove.assert_not_called()
- class TestFTPSession:
- """Tests for FTP session handling."""
- @pytest.fixture
- def mock_reader(self):
- """Create a mock StreamReader."""
- reader = AsyncMock()
- return reader
- @pytest.fixture
- def mock_writer(self):
- """Create a mock StreamWriter."""
- writer = MagicMock()
- writer.get_extra_info = MagicMock(return_value=("192.168.1.100", 12345))
- writer.write = MagicMock()
- writer.drain = AsyncMock()
- writer.close = MagicMock()
- writer.wait_closed = AsyncMock()
- writer.is_closing = MagicMock(return_value=False)
- return writer
- @pytest.fixture
- def ssl_context(self):
- """Create a mock SSL context."""
- return MagicMock()
- @pytest.fixture
- def session(self, mock_reader, mock_writer, ssl_context, tmp_path):
- """Create an FTPSession instance."""
- from backend.app.services.virtual_printer.ftp_server import FTPSession
- return FTPSession(
- reader=mock_reader,
- writer=mock_writer,
- upload_dir=tmp_path,
- access_code="12345678",
- ssl_context=ssl_context,
- on_file_received=None,
- )
- # ========================================================================
- # Tests for authentication
- # ========================================================================
- @pytest.mark.asyncio
- async def test_user_command_accepts_bblp(self, session):
- """Verify USER command accepts bblp user."""
- await session.cmd_USER("bblp")
- assert session.username == "bblp"
- @pytest.mark.asyncio
- async def test_pass_command_authenticates(self, session):
- """Verify PASS command authenticates with correct code."""
- session.username = "bblp"
- await session.cmd_PASS("12345678")
- assert session.authenticated is True
- @pytest.mark.asyncio
- async def test_pass_command_rejects_wrong_code(self, session):
- """Verify PASS command rejects wrong access code."""
- session.username = "bblp"
- await session.cmd_PASS("wrongcode")
- assert session.authenticated is False
- # ========================================================================
- # Tests for FTP commands
- # ========================================================================
- @pytest.mark.asyncio
- async def test_syst_command(self, session):
- """Verify SYST returns UNIX type."""
- await session.cmd_SYST("")
- session.writer.write.assert_called()
- call_args = session.writer.write.call_args[0][0].decode()
- assert "215" in call_args
- assert "UNIX" in call_args
- @pytest.mark.asyncio
- async def test_pwd_command_requires_auth(self, session):
- """Verify PWD requires authentication."""
- session.authenticated = False
- await session.cmd_PWD("")
- call_args = session.writer.write.call_args[0][0].decode()
- assert "530" in call_args
- @pytest.mark.asyncio
- async def test_pwd_command_when_authenticated(self, session):
- """Verify PWD returns root directory when authenticated."""
- session.authenticated = True
- await session.cmd_PWD("")
- call_args = session.writer.write.call_args[0][0].decode()
- assert "257" in call_args
- @pytest.mark.asyncio
- async def test_type_command_sets_binary(self, session):
- """Verify TYPE I sets binary mode."""
- session.authenticated = True
- await session.cmd_TYPE("I")
- assert session.transfer_type == "I"
- @pytest.mark.asyncio
- async def test_pbsz_command(self, session):
- """Verify PBSZ returns success."""
- await session.cmd_PBSZ("0")
- call_args = session.writer.write.call_args[0][0].decode()
- assert "200" in call_args
- @pytest.mark.asyncio
- async def test_prot_command_accepts_p(self, session):
- """Verify PROT P is accepted."""
- await session.cmd_PROT("P")
- call_args = session.writer.write.call_args[0][0].decode()
- assert "200" in call_args
- @pytest.mark.asyncio
- async def test_quit_command(self, session):
- """Verify QUIT sends goodbye and raises CancelledError."""
- with pytest.raises(asyncio.CancelledError):
- await session.cmd_QUIT("")
- class TestSSDPServer:
- """Tests for Virtual Printer SSDP server."""
- @pytest.fixture
- def ssdp_server(self):
- """Create a VirtualPrinterSSDPServer instance."""
- from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
- return VirtualPrinterSSDPServer(
- serial="TEST123",
- name="TestPrinter",
- model="BL-P001",
- )
- # ========================================================================
- # Tests for SSDP response
- # ========================================================================
- def test_build_notify_message(self, ssdp_server):
- """Verify NOTIFY packet contains required headers."""
- # Set a known IP for testing
- ssdp_server._local_ip = "192.168.1.100"
- message = ssdp_server._build_notify_message()
- assert b"NOTIFY" in message
- assert b"DevName.bambu.com: TestPrinter" in message
- assert b"USN: TEST123" in message
- def test_build_response_message(self, ssdp_server):
- """Verify response packet contains required headers."""
- # Set a known IP for testing
- ssdp_server._local_ip = "192.168.1.100"
- message = ssdp_server._build_response_message()
- assert b"HTTP/1.1 200 OK" in message
- assert b"DevName.bambu.com: TestPrinter" in message
- assert b"USN: TEST123" in message
- def test_ssdp_server_uses_correct_model(self, ssdp_server):
- """Verify SSDP server uses the provided model."""
- ssdp_server._local_ip = "192.168.1.100"
- message = ssdp_server._build_notify_message()
- assert b"DevModel.bambu.com: BL-P001" in message
- # ========================================================================
- # Tests for advertise_ip parameter
- # ========================================================================
- def test_advertise_ip_sets_local_ip(self):
- """Verify advertise_ip overrides auto-detection."""
- from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
- server = VirtualPrinterSSDPServer(
- serial="TEST123",
- name="TestPrinter",
- model="BL-P001",
- advertise_ip="10.0.0.50",
- )
- assert server._local_ip == "10.0.0.50"
- def test_advertise_ip_empty_string_uses_auto_detect(self):
- """Verify empty advertise_ip falls back to auto-detection."""
- from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
- server = VirtualPrinterSSDPServer(
- serial="TEST123",
- name="TestPrinter",
- model="BL-P001",
- advertise_ip="",
- )
- assert server._local_ip is None
- def test_advertise_ip_in_notify_message(self):
- """Verify NOTIFY message uses the advertise_ip."""
- from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
- server = VirtualPrinterSSDPServer(
- serial="TEST123",
- name="TestPrinter",
- model="BL-P001",
- advertise_ip="10.0.0.50",
- )
- message = server._build_notify_message()
- assert b"Location: 10.0.0.50" in message
- def test_advertise_ip_in_response_message(self):
- """Verify M-SEARCH response uses the advertise_ip."""
- from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
- server = VirtualPrinterSSDPServer(
- serial="TEST123",
- name="TestPrinter",
- model="BL-P001",
- advertise_ip="10.0.0.50",
- )
- message = server._build_response_message()
- assert b"Location: 10.0.0.50" in message
- def test_default_no_advertise_ip(self):
- """Verify default constructor has None local_ip (auto-detect)."""
- from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
- server = VirtualPrinterSSDPServer()
- assert server._local_ip is None
- class TestCertificateService:
- """Tests for TLS certificate generation."""
- @pytest.fixture
- def cert_service(self, tmp_path):
- """Create a CertificateService instance."""
- from backend.app.services.virtual_printer.certificate import CertificateService
- return CertificateService(cert_dir=tmp_path, serial="TEST123")
- def test_generate_certificates(self, cert_service, tmp_path):
- """Verify certificates are generated correctly."""
- cert_path, key_path = cert_service.generate_certificates()
- assert cert_path.exists()
- assert key_path.exists()
- # Verify certificate content
- cert_content = cert_path.read_text()
- assert "BEGIN CERTIFICATE" in cert_content
- key_content = key_path.read_text()
- assert "BEGIN" in key_content and "KEY" in key_content
- def test_certificates_reused_if_exist(self, cert_service):
- """Verify existing certificates are reused."""
- # First generation
- cert_path1, key_path1 = cert_service.generate_certificates()
- mtime1 = cert_path1.stat().st_mtime
- # Second call should reuse (via ensure_certificates)
- cert_path2, key_path2 = cert_service.ensure_certificates()
- mtime2 = cert_path2.stat().st_mtime
- assert mtime1 == mtime2 # File wasn't regenerated
- def test_delete_certificates(self, cert_service):
- """Verify certificates can be deleted."""
- cert_service.generate_certificates()
- assert cert_service.cert_path.exists()
- assert cert_service.key_path.exists()
- cert_service.delete_certificates()
- assert not cert_service.cert_path.exists()
- assert not cert_service.key_path.exists()
- def test_ensure_creates_if_not_exist(self, cert_service):
- """Verify ensure_certificates generates if not existing."""
- assert not cert_service.cert_path.exists()
- cert_path, key_path = cert_service.ensure_certificates()
- assert cert_path.exists()
- assert key_path.exists()
- class TestBindServer:
- """Tests for BindServer (port 3002 bind/detect protocol)."""
- @pytest.fixture
- def bind_server(self):
- """Create a BindServer instance."""
- from backend.app.services.virtual_printer.bind_server import BindServer
- return BindServer(
- serial="09400A391800001",
- model="O1D",
- name="Bambuddy",
- )
- def test_build_frame(self, bind_server):
- """Verify frame building produces correct format."""
- payload = {"login": {"command": "detect"}}
- frame = bind_server._build_frame(payload)
- # Header: 0xA5A5
- assert frame[:2] == b"\xa5\xa5"
- # Trailer: 0xA7A7
- assert frame[-2:] == b"\xa7\xa7"
- # Length field is total message size (LE uint16)
- import struct
- total_len = struct.unpack_from("<H", frame, 2)[0]
- assert total_len == len(frame)
- # JSON payload is between header and trailer
- import json
- json_bytes = frame[4:-2]
- parsed = json.loads(json_bytes)
- assert parsed == payload
- def test_parse_frame_valid(self, bind_server):
- """Verify valid frame parsing extracts JSON correctly."""
- import json
- import struct
- payload = {"login": {"command": "detect", "sequence_id": "20000"}}
- json_bytes = json.dumps(payload, separators=(",", ":")).encode()
- total_len = 4 + len(json_bytes) + 2
- frame = b"\xa5\xa5" + struct.pack("<H", total_len) + json_bytes + b"\xa7\xa7"
- result = bind_server._parse_frame(frame)
- assert result is not None
- assert result["login"]["command"] == "detect"
- assert result["login"]["sequence_id"] == "20000"
- def test_parse_frame_invalid_header(self, bind_server):
- """Verify invalid header returns None."""
- result = bind_server._parse_frame(b"\xbb\xbb\x06\x00{}\xa7\xa7")
- assert result is None
- def test_parse_frame_invalid_trailer(self, bind_server):
- """Verify invalid trailer returns None."""
- result = bind_server._parse_frame(b"\xa5\xa5\x06\x00{}\xbb\xbb")
- assert result is None
- def test_parse_frame_too_short(self, bind_server):
- """Verify short data returns None."""
- result = bind_server._parse_frame(b"\xa5\xa5\x00")
- assert result is None
- def test_parse_frame_invalid_json(self, bind_server):
- """Verify invalid JSON returns None."""
- import struct
- bad_json = b"not json"
- total_len = 4 + len(bad_json) + 2
- frame = b"\xa5\xa5" + struct.pack("<H", total_len) + bad_json + b"\xa7\xa7"
- result = bind_server._parse_frame(frame)
- assert result is None
- def test_build_frame_roundtrip(self, bind_server):
- """Verify build_frame output can be parsed back."""
- payload = {
- "login": {
- "bind": "free",
- "command": "detect",
- "connect": "lan",
- "dev_cap": 1,
- "id": "09400A391800001",
- "model": "O1D",
- "name": "Bambuddy",
- "sequence_id": 3021,
- "version": "01.00.00.00",
- }
- }
- frame = bind_server._build_frame(payload)
- parsed = bind_server._parse_frame(frame)
- assert parsed is not None
- assert parsed["login"]["id"] == "09400A391800001"
- assert parsed["login"]["model"] == "O1D"
- assert parsed["login"]["name"] == "Bambuddy"
- assert parsed["login"]["bind"] == "free"
- def test_bind_server_stores_config(self, bind_server):
- """Verify bind server stores serial, model, name."""
- assert bind_server.serial == "09400A391800001"
- assert bind_server.model == "O1D"
- assert bind_server.name == "Bambuddy"
- assert bind_server.version == "01.00.00.00"
- def test_bind_server_custom_version(self):
- """Verify custom firmware version is stored."""
- from backend.app.services.virtual_printer.bind_server import BindServer
- server = BindServer(
- serial="TEST123",
- model="C13",
- name="Test",
- version="02.03.04.05",
- )
- assert server.version == "02.03.04.05"
- def test_bind_ports_constant(self):
- """Verify BIND_PORTS includes both 3000 and 3002 for slicer compatibility."""
- from backend.app.services.virtual_printer.bind_server import BIND_PORTS
- assert 3000 in BIND_PORTS
- assert 3002 in BIND_PORTS
- def test_bind_server_initializes_empty_servers_list(self, bind_server):
- """Verify bind server starts with empty servers list."""
- assert bind_server._servers == []
- assert bind_server._running is False
- class TestSlicerProxyManager:
- """Tests for SlicerProxyManager (proxy mode)."""
- @pytest.fixture
- def proxy_manager(self, tmp_path):
- """Create a SlicerProxyManager instance."""
- from backend.app.services.virtual_printer.tcp_proxy import SlicerProxyManager
- # Create dummy cert files
- cert_path = tmp_path / "cert.pem"
- key_path = tmp_path / "key.pem"
- cert_path.write_text("-----BEGIN CERTIFICATE-----\ntest\n-----END CERTIFICATE-----")
- # Split string to avoid pre-commit hook false positive on test data
- key_path.write_text("-----BEGIN " + "PRIVATE KEY-----\ntest\n-----END " + "PRIVATE KEY-----")
- return SlicerProxyManager(
- target_host="192.168.1.100",
- cert_path=cert_path,
- key_path=key_path,
- )
- def test_proxy_manager_initializes_ports(self, proxy_manager):
- """Verify proxy manager has correct port constants."""
- # FTP proxy uses privileged port 990 to match what Bambu Studio expects
- assert proxy_manager.LOCAL_FTP_PORT == 990
- assert proxy_manager.LOCAL_MQTT_PORT == 8883
- assert proxy_manager.PRINTER_FTP_PORT == 990
- assert proxy_manager.PRINTER_MQTT_PORT == 8883
- assert proxy_manager.PRINTER_FILE_TRANSFER_PORT == 6000
- assert proxy_manager.PRINTER_RTSP_PORT == 322
- # Auxiliary ports: undocumented proprietary ports for A1/P1S etc.
- assert proxy_manager.PRINTER_AUX_PORTS == [2024, 2025, 2026]
- # Bind ports: both 3000 and 3002 for slicer compatibility
- assert proxy_manager.PRINTER_BIND_PORTS == [3000, 3002]
- # FTP data port range for transparent EPSV proxying
- assert proxy_manager.FTP_DATA_PORT_MIN == 50000
- assert proxy_manager.FTP_DATA_PORT_MAX == 50100
- def test_proxy_manager_stores_target_host(self, proxy_manager):
- """Verify proxy manager stores target host."""
- assert proxy_manager.target_host == "192.168.1.100"
- def test_get_status_before_start(self, proxy_manager):
- """Verify get_status returns zeros before start."""
- status = proxy_manager.get_status()
- assert status["running"] is False
- assert status["ftp_connections"] == 0
- assert status["mqtt_connections"] == 0
- @pytest.mark.asyncio
- async def test_proxy_start_creates_transparent_proxies(self, tmp_path):
- """Verify start() uses TCPProxy for FTP/FileTransfer/RTSP and TLSProxy only for MQTT.
- The transparent proxy architecture preserves end-to-end TLS between
- slicer and printer for all protocols except MQTT, which must be
- TLS-terminated to rewrite the printer's IP in MQTT payloads.
- """
- from unittest.mock import AsyncMock, patch
- from backend.app.services.virtual_printer.tcp_proxy import (
- SlicerProxyManager,
- TCPProxy,
- TLSProxy,
- )
- cert_path = tmp_path / "cert.pem"
- key_path = tmp_path / "key.pem"
- cert_path.write_text("-----BEGIN CERTIFICATE-----\ntest\n-----END CERTIFICATE-----")
- key_path.write_text("-----BEGIN " + "PRIVATE KEY-----\ntest\n-----END " + "PRIVATE KEY-----")
- mgr = SlicerProxyManager(
- target_host="192.168.1.100",
- cert_path=cert_path,
- key_path=key_path,
- bind_address="10.0.0.1",
- )
- # Mock asyncio.create_task and asyncio.gather to prevent actual server start
- with (
- patch("asyncio.create_task") as mock_create_task,
- patch("asyncio.gather", new_callable=AsyncMock),
- patch.object(SlicerProxyManager, "_log_activity"),
- ):
- mock_create_task.return_value = MagicMock()
- # start() will create proxies then try to gather tasks — we just
- # need to verify the proxy types after creation.
- # Trigger start but let gather return immediately.
- await mgr.start()
- # FTP, FileTransfer, RTSP should be TCPProxy (transparent)
- assert isinstance(mgr._ftp_proxy, TCPProxy), "FTP should be TCPProxy (transparent)"
- assert isinstance(mgr._file_transfer_proxy, TCPProxy), "FileTransfer should be TCPProxy"
- assert isinstance(mgr._rtsp_proxy, TCPProxy), "RTSP should be TCPProxy"
- # MQTT should be TLSProxy (TLS-terminated for IP rewriting)
- assert isinstance(mgr._mqtt_proxy, TLSProxy), "MQTT should be TLSProxy (TLS-terminated)"
- # Auxiliary ports (2024-2026) should be TCPProxy (transparent)
- assert len(mgr._aux_proxies) == 3, "Should have 3 aux port proxies"
- for ap in mgr._aux_proxies:
- assert isinstance(ap, TCPProxy), "Aux proxies should be TCPProxy"
- assert mgr._aux_proxies[0].listen_port == 2024
- assert mgr._aux_proxies[0].target_port == 2024
- assert mgr._aux_proxies[2].listen_port == 2026
- # FTP data ports should be pre-created as TCPProxy instances
- assert len(mgr._ftp_data_proxies) == 101 # 50000-50100 inclusive
- for dp in mgr._ftp_data_proxies:
- assert isinstance(dp, TCPProxy), "FTP data proxies should be TCPProxy"
- # Verify FTP data proxies target the same port on the printer
- first_dp = mgr._ftp_data_proxies[0]
- assert first_dp.listen_port == 50000
- assert first_dp.target_port == 50000
- assert first_dp.target_host == "192.168.1.100"
- last_dp = mgr._ftp_data_proxies[-1]
- assert last_dp.listen_port == 50100
- assert last_dp.target_port == 50100
- def test_proxy_manager_mqtt_has_ip_rewriting(self, tmp_path):
- """Verify MQTT proxy is configured with IP rewriting when bind_address is set."""
- from backend.app.services.virtual_printer.tcp_proxy import SlicerProxyManager
- cert_path = tmp_path / "cert.pem"
- key_path = tmp_path / "key.pem"
- cert_path.write_text("-----BEGIN CERTIFICATE-----\ntest\n-----END CERTIFICATE-----")
- key_path.write_text("-----BEGIN " + "PRIVATE KEY-----\ntest\n-----END " + "PRIVATE KEY-----")
- mgr = SlicerProxyManager(
- target_host="192.168.1.100",
- cert_path=cert_path,
- key_path=key_path,
- bind_address="10.0.0.1",
- )
- # Before start, proxies are None — verify constructor stores rewrite config
- assert mgr.bind_address == "10.0.0.1"
- assert mgr.target_host == "192.168.1.100"
- class TestSSDPProxy:
- """Tests for SSDPProxy (cross-network SSDP relay)."""
- @pytest.fixture
- def ssdp_proxy(self):
- """Create an SSDPProxy instance."""
- from backend.app.services.virtual_printer.ssdp_server import SSDPProxy
- return SSDPProxy(
- local_interface_ip="192.168.1.100",
- remote_interface_ip="10.0.0.100",
- target_printer_ip="192.168.1.50",
- )
- def test_ssdp_proxy_stores_interface_ips(self, ssdp_proxy):
- """Verify SSDPProxy stores interface IPs correctly."""
- assert ssdp_proxy.local_interface_ip == "192.168.1.100"
- assert ssdp_proxy.remote_interface_ip == "10.0.0.100"
- assert ssdp_proxy.target_printer_ip == "192.168.1.50"
- def test_rewrite_ssdp_location(self, ssdp_proxy):
- """Verify SSDP Location header is rewritten to remote interface IP."""
- original_packet = b"NOTIFY * HTTP/1.1\r\nLocation: 192.168.1.50\r\nDevName.bambu.com: TestPrinter\r\n\r\n"
- rewritten = ssdp_proxy._rewrite_ssdp(original_packet)
- # Location should be changed to remote interface IP
- assert b"Location: 10.0.0.100" in rewritten
- assert b"Location: 192.168.1.50" not in rewritten
- # Other headers should be preserved
- assert b"DevName.bambu.com: TestPrinter" in rewritten
- def test_rewrite_ssdp_location_case_insensitive(self, ssdp_proxy):
- """Verify SSDP Location rewrite is case insensitive."""
- original_packet = b"NOTIFY * HTTP/1.1\r\nlocation: 192.168.1.50\r\n\r\n"
- rewritten = ssdp_proxy._rewrite_ssdp(original_packet)
- assert b"10.0.0.100" in rewritten
- def test_rewrite_ssdp_location_no_match(self, ssdp_proxy):
- """Verify packet without Location header is returned unchanged."""
- original_packet = b"NOTIFY * HTTP/1.1\r\nDevName.bambu.com: Test\r\n\r\n"
- rewritten = ssdp_proxy._rewrite_ssdp(original_packet)
- # No Location header, but _rewrite_ssdp logs a warning and returns as-is
- assert b"DevName.bambu.com: Test" in rewritten
- def test_parse_ssdp_message(self, ssdp_proxy):
- """Verify SSDP message parsing extracts headers."""
- packet = (
- b"NOTIFY * HTTP/1.1\r\n"
- b"Location: 192.168.1.50\r\n"
- b"DevName.bambu.com: TestPrinter\r\n"
- b"DevModel.bambu.com: BL-P001\r\n"
- b"\r\n"
- )
- headers = ssdp_proxy._parse_ssdp_message(packet)
- assert headers["location"] == "192.168.1.50"
- assert headers["devname.bambu.com"] == "TestPrinter"
- assert headers["devmodel.bambu.com"] == "BL-P001"
- class TestVirtualPrinterManagerDirectories:
- """Tests for VirtualPrinterManager directory management."""
- def test_ensure_base_directories_creates_subdirs(self, tmp_path):
- """Verify _ensure_base_directories creates required base directories."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterManager
- manager = VirtualPrinterManager()
- manager._base_dir = tmp_path / "virtual_printer"
- manager._ensure_base_directories()
- assert (tmp_path / "virtual_printer").exists()
- assert (tmp_path / "virtual_printer" / "uploads").exists()
- assert (tmp_path / "virtual_printer" / "certs").exists()
- def test_ensure_base_directories_handles_permission_error(self, tmp_path, caplog):
- """Verify _ensure_base_directories logs error on permission failure."""
- import logging
- from backend.app.services.virtual_printer.manager import VirtualPrinterManager
- manager = VirtualPrinterManager()
- vp_dir = tmp_path / "virtual_printer"
- manager._base_dir = vp_dir
- original_mkdir = type(vp_dir).mkdir
- def mock_mkdir(self, *args, **kwargs):
- if "virtual_printer" in str(self):
- raise PermissionError("Permission denied")
- return original_mkdir(self, *args, **kwargs)
- with caplog.at_level(logging.ERROR), patch.object(type(vp_dir), "mkdir", mock_mkdir):
- manager._ensure_base_directories()
- assert "Permission denied" in caplog.text
- def test_instance_creates_per_vp_directories(self, tmp_path):
- """Verify VirtualPrinterInstance creates per-VP upload and cert dirs."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- VirtualPrinterInstance(
- vp_id=42,
- name="Test",
- mode="archive",
- model="C11",
- access_code="12345678",
- serial_suffix="391800042",
- base_dir=tmp_path,
- )
- assert (tmp_path / "uploads" / "42").exists()
- assert (tmp_path / "uploads" / "42" / "cache").exists()
- assert (tmp_path / "certs" / "42").exists()
- class TestVirtualPrinterInstanceProxyMode:
- """Tests for VirtualPrinterInstance proxy mode."""
- @pytest.fixture
- def proxy_instance(self, tmp_path):
- """Create a proxy-mode VirtualPrinterInstance."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- return VirtualPrinterInstance(
- vp_id=10,
- name="ProxyTest",
- mode="proxy",
- model="C11",
- access_code="",
- serial_suffix="391800010",
- target_printer_ip="192.168.1.100",
- target_printer_serial="01P00A000000001",
- base_dir=tmp_path,
- )
- def test_proxy_instance_properties(self, proxy_instance):
- """Verify proxy instance stores config correctly."""
- assert proxy_instance.is_proxy is True
- assert proxy_instance.mode == "proxy"
- assert proxy_instance.target_printer_ip == "192.168.1.100"
- assert proxy_instance.target_printer_serial == "01P00A000000001"
- def test_proxy_instance_does_not_require_access_code(self, proxy_instance):
- """Verify proxy mode can have empty access code."""
- assert proxy_instance.access_code == ""
- def test_get_status_proxy_includes_proxy_fields(self, proxy_instance):
- """Verify get_status includes proxy fields when proxy is active."""
- mock_proxy = MagicMock()
- mock_proxy.get_status.return_value = {
- "running": True,
- "ftp_port": 990,
- "mqtt_port": 8883,
- "ftp_connections": 1,
- "mqtt_connections": 2,
- "target_host": "192.168.1.100",
- }
- proxy_instance._proxy = mock_proxy
- status = proxy_instance.get_status()
- assert "proxy" in status
- assert status["proxy"]["ftp_port"] == 990
- assert status["proxy"]["mqtt_connections"] == 2
- def test_proxy_instance_stores_remote_interface(self, tmp_path):
- """Verify proxy instance stores remote_interface_ip."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- inst = VirtualPrinterInstance(
- vp_id=11,
- name="Proxy2",
- mode="proxy",
- model="C11",
- access_code="",
- serial_suffix="391800011",
- target_printer_ip="192.168.1.100",
- remote_interface_ip="10.0.0.50",
- base_dir=tmp_path,
- )
- assert inst.remote_interface_ip == "10.0.0.50"
- class TestVirtualPrinterInstanceIPOverride:
- """Tests for remote_interface_ip and bind_ip on VirtualPrinterInstance."""
- @pytest.fixture
- def instance_with_remote_ip(self, tmp_path):
- """Create an instance with remote_interface_ip set."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- return VirtualPrinterInstance(
- vp_id=20,
- name="IPTest",
- mode="archive",
- model="BL-P001",
- access_code="12345678",
- serial_suffix="391800020",
- bind_ip="192.168.1.50",
- remote_interface_ip="10.0.0.50",
- base_dir=tmp_path,
- )
- def test_instance_stores_bind_ip(self, instance_with_remote_ip):
- """Verify bind_ip is stored."""
- assert instance_with_remote_ip.bind_ip == "192.168.1.50"
- def test_instance_stores_remote_interface_ip(self, instance_with_remote_ip):
- """Verify remote_interface_ip is stored."""
- assert instance_with_remote_ip.remote_interface_ip == "10.0.0.50"
- def test_generate_certificates_includes_remote_and_bind_ip(self, instance_with_remote_ip):
- """Verify generate_certificates passes remote_interface_ip and bind_ip as SANs."""
- with (
- patch.object(instance_with_remote_ip._cert_service, "delete_printer_certificate"),
- patch.object(
- instance_with_remote_ip._cert_service,
- "generate_certificates",
- return_value=(Path("/tmp/cert.pem"), Path("/tmp/key.pem")), # nosec B108
- ) as mock_gen,
- ):
- instance_with_remote_ip.generate_certificates()
- mock_gen.assert_called_once_with(additional_ips=["10.0.0.50", "192.168.1.50"])
- def test_generate_certificates_no_remote_ip(self, tmp_path):
- """Verify generate_certificates passes only bind_ip when no remote_interface_ip."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- inst = VirtualPrinterInstance(
- vp_id=21,
- name="NoRemote",
- mode="archive",
- model="BL-P001",
- access_code="12345678",
- serial_suffix="391800021",
- bind_ip="192.168.1.50",
- base_dir=tmp_path,
- )
- with (
- patch.object(inst._cert_service, "delete_printer_certificate"),
- patch.object(
- inst._cert_service,
- "generate_certificates",
- return_value=(Path("/tmp/cert.pem"), Path("/tmp/key.pem")), # nosec B108
- ) as mock_gen,
- ):
- inst.generate_certificates()
- mock_gen.assert_called_once_with(additional_ips=["192.168.1.50"])
- def test_generate_certificates_no_ips(self, tmp_path):
- """Verify generate_certificates passes None when no IPs configured."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- inst = VirtualPrinterInstance(
- vp_id=22,
- name="NoIPs",
- mode="archive",
- model="BL-P001",
- access_code="12345678",
- serial_suffix="391800022",
- base_dir=tmp_path,
- )
- with (
- patch.object(inst._cert_service, "delete_printer_certificate"),
- patch.object(
- inst._cert_service,
- "generate_certificates",
- return_value=(Path("/tmp/cert.pem"), Path("/tmp/key.pem")), # nosec B108
- ) as mock_gen,
- ):
- inst.generate_certificates()
- mock_gen.assert_called_once_with(additional_ips=None)
- class TestBindServer:
- """Tests for the BindServer (port 3002 bind/detect protocol)."""
- @pytest.fixture
- def bind_server(self):
- """Create a BindServer instance."""
- from backend.app.services.virtual_printer.bind_server import BindServer
- return BindServer(
- serial="01S00C000000001",
- model="BL-P001",
- name="Bambuddy",
- )
- def test_build_frame(self, bind_server):
- """Verify frame format: 0xA5A5 + len(u16le) + JSON + 0xA7A7."""
- payload = {"login": {"command": "detect"}}
- frame = bind_server._build_frame(payload)
- assert frame[:2] == b"\xa5\xa5"
- assert frame[-2:] == b"\xa7\xa7"
- # Length field is total message size
- import struct
- total_len = struct.unpack_from("<H", frame, 2)[0]
- assert total_len == len(frame)
- # JSON payload is between header and trailer
- import json
- json_bytes = frame[4:-2]
- parsed = json.loads(json_bytes)
- assert parsed == payload
- def test_parse_frame_valid(self, bind_server):
- """Verify valid frame parsing."""
- frame = bind_server._build_frame({"login": {"command": "detect", "sequence_id": "20000"}})
- result = bind_server._parse_frame(frame)
- assert result is not None
- assert result["login"]["command"] == "detect"
- assert result["login"]["sequence_id"] == "20000"
- def test_parse_frame_invalid_header(self, bind_server):
- """Verify invalid header returns None."""
- frame = b"\xb5\xb5\x10\x00" + b'{"login":{}}' + b"\xa7\xa7"
- assert bind_server._parse_frame(frame) is None
- def test_parse_frame_invalid_trailer(self, bind_server):
- """Verify invalid trailer returns None."""
- frame = b"\xa5\xa5\x10\x00" + b'{"login":{}}' + b"\xb7\xb7"
- assert bind_server._parse_frame(frame) is None
- def test_parse_frame_too_short(self, bind_server):
- """Verify short data returns None."""
- assert bind_server._parse_frame(b"\xa5\xa5\x00") is None
- assert bind_server._parse_frame(b"") is None
- def test_parse_frame_invalid_json(self, bind_server):
- """Verify invalid JSON returns None."""
- import struct
- bad_json = b"not json"
- total_len = 4 + len(bad_json) + 2
- frame = b"\xa5\xa5" + struct.pack("<H", total_len) + bad_json + b"\xa7\xa7"
- assert bind_server._parse_frame(frame) is None
- def test_build_frame_roundtrip(self, bind_server):
- """Verify build then parse roundtrip."""
- original = {"login": {"bind": "free", "command": "detect", "id": "01S00C000000001"}}
- frame = bind_server._build_frame(original)
- parsed = bind_server._parse_frame(frame)
- assert parsed == original
- def test_bind_server_stores_config(self, bind_server):
- """Verify config is stored correctly."""
- assert bind_server.serial == "01S00C000000001"
- assert bind_server.model == "BL-P001"
- assert bind_server.name == "Bambuddy"
- assert bind_server.version == "01.00.00.00"
- def test_bind_server_custom_version(self):
- """Verify custom firmware version is stored."""
- from backend.app.services.virtual_printer.bind_server import BindServer
- server = BindServer(
- serial="01S00C000000001",
- model="BL-P001",
- name="Bambuddy",
- version="01.09.00.10",
- )
- assert server.version == "01.09.00.10"
- def test_bind_ports_includes_both(self):
- """Verify BIND_PORTS includes both 3000 and 3002 for slicer compatibility."""
- from backend.app.services.virtual_printer.bind_server import BIND_PORTS
- assert 3000 in BIND_PORTS
- assert 3002 in BIND_PORTS
- def test_bind_server_initializes_empty_servers_list(self, bind_server):
- """Verify bind server starts with empty servers list."""
- assert bind_server._servers == []
- assert bind_server._running is False
- @pytest.mark.asyncio
- async def test_start_server_creates_bind_server(self, tmp_path):
- """Verify start_server creates BindServer with correct params."""
- from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
- inst = VirtualPrinterInstance(
- vp_id=99,
- name="Bambuddy",
- mode="archive",
- model="BL-P001",
- access_code="12345678",
- serial_suffix="391800099",
- bind_ip="192.168.1.50",
- base_dir=tmp_path,
- )
- # Each mocked child service exposes a real asyncio.Event for the
- # readiness barrier added in start_server (set on instantiation so
- # the barrier returns immediately in tests).
- ready_event = asyncio.Event()
- ready_event.set()
- def with_ready(*_args, **_kwargs):
- child = MagicMock()
- child.ready = ready_event
- return child
- with (
- patch(
- "backend.app.services.virtual_printer.manager.VirtualPrinterSSDPServer",
- side_effect=with_ready,
- ),
- patch(
- "backend.app.services.virtual_printer.manager.VirtualPrinterFTPServer",
- side_effect=with_ready,
- ),
- patch(
- "backend.app.services.virtual_printer.manager.SimpleMQTTServer",
- side_effect=with_ready,
- ),
- patch(
- "backend.app.services.virtual_printer.manager.BindServer",
- side_effect=with_ready,
- ) as mock_bind_cls,
- patch.object(inst._cert_service, "delete_printer_certificate"),
- patch.object(
- inst._cert_service,
- "generate_certificates",
- return_value=(Path("/tmp/cert.pem"), Path("/tmp/key.pem")), # nosec B108
- ),
- ):
- await inst.start_server()
- mock_bind_cls.assert_called_once_with(
- serial=inst.serial,
- model="BL-P001",
- name="Bambuddy",
- bind_address="192.168.1.50",
- cert_path=Path("/tmp/cert.pem"), # nosec B108
- key_path=Path("/tmp/key.pem"), # nosec B108
- )
- class TestResolveModelCodes:
- """Tests for model code resolution (display name → SSDP code)."""
- def test_display_name_to_model_code_maps_all_models(self):
- """Verify reverse mapping covers all VIRTUAL_PRINTER_MODELS entries."""
- from backend.app.services.virtual_printer.manager import DISPLAY_NAME_TO_MODEL_CODE, VIRTUAL_PRINTER_MODELS
- for _code, display_name in VIRTUAL_PRINTER_MODELS.items():
- assert display_name in DISPLAY_NAME_TO_MODEL_CODE
- # For non-duplicate display names, should map back to a valid code
- assert DISPLAY_NAME_TO_MODEL_CODE[display_name] in VIRTUAL_PRINTER_MODELS
- def test_resolve_printer_model_with_ssdp_code(self):
- """SSDP codes pass through unchanged."""
- from backend.app.api.routes.virtual_printers import _resolve_printer_model
- assert _resolve_printer_model("BL-P001") == "BL-P001"
- assert _resolve_printer_model("O1D") == "O1D"
- assert _resolve_printer_model("N2S") == "N2S"
- def test_resolve_printer_model_with_display_name(self):
- """Display names resolve to SSDP codes."""
- from backend.app.api.routes.virtual_printers import _resolve_printer_model
- assert _resolve_printer_model("X1C") == "BL-P001"
- assert _resolve_printer_model("H2D") == "O1D"
- assert _resolve_printer_model("A1") == "N2S"
- assert _resolve_printer_model("P1S") == "C12"
- def test_resolve_printer_model_with_none_or_unknown(self):
- """None and unknown values return None."""
- from backend.app.api.routes.virtual_printers import _resolve_printer_model
- assert _resolve_printer_model(None) is None
- assert _resolve_printer_model("UnknownModel") is None
- class TestMqttIpRewrite:
- """Tests for TLSProxy._rewrite_mqtt_ip() MQTT packet IP rewriting."""
- @staticmethod
- def _build_mqtt_publish(topic: str, payload: bytes) -> bytes:
- """Build a minimal MQTT PUBLISH packet."""
- # PUBLISH fixed header: type 3, no flags
- topic_bytes = topic.encode("utf-8")
- # Variable header: topic length (2 bytes) + topic
- var_header = len(topic_bytes).to_bytes(2, "big") + topic_bytes
- body = var_header + payload
- # Encode remaining length
- remaining = len(body)
- header = bytearray([0x30]) # PUBLISH, QoS 0
- while True:
- encoded_byte = remaining % 128
- remaining //= 128
- if remaining > 0:
- encoded_byte |= 0x80
- header.append(encoded_byte)
- if remaining == 0:
- break
- return bytes(header) + body
- @staticmethod
- def _build_mqtt_pingreq() -> bytes:
- """Build an MQTT PINGREQ packet (2 bytes, no payload)."""
- return b"\xc0\x00"
- def test_rewrite_ip_in_publish(self):
- """IP string in PUBLISH payload is rewritten."""
- from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
- payload = b'{"rtsp_url":"rtsps://192.168.1.100:322/live"}'
- packet = self._build_mqtt_publish("device/status", payload)
- result, buf = TLSProxy._rewrite_mqtt_ip(packet, b"192.168.1.100", b"10.0.0.1", bytearray())
- assert b"10.0.0.1" in result
- assert b"192.168.1.100" not in result
- def test_no_rewrite_when_ip_absent(self):
- """Packets without the target IP are passed through unchanged."""
- from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
- payload = b'{"status":"idle"}'
- packet = self._build_mqtt_publish("device/status", payload)
- result, buf = TLSProxy._rewrite_mqtt_ip(packet, b"192.168.1.100", b"10.0.0.1", bytearray())
- assert result == packet
- def test_non_publish_packets_unchanged(self):
- """Non-PUBLISH packets (e.g. PINGREQ) are never rewritten."""
- from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
- pingreq = self._build_mqtt_pingreq()
- result, buf = TLSProxy._rewrite_mqtt_ip(pingreq, b"192.168.1.100", b"10.0.0.1", bytearray())
- assert result == pingreq
- def test_rewrite_preserves_packet_framing(self):
- """Rewritten packet has valid MQTT remaining length."""
- from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
- # Use IPs of different lengths to test length re-encoding
- old_ip = b"192.168.255.133" # 15 bytes
- new_ip = b"10.0.0.1" # 8 bytes
- payload = b'{"ip":"192.168.255.133"}'
- packet = self._build_mqtt_publish("device/status", payload)
- result, buf = TLSProxy._rewrite_mqtt_ip(packet, old_ip, new_ip, bytearray())
- # Parse the result to verify framing
- assert result[0] == 0x30 # PUBLISH header byte
- # Decode remaining length
- pos = 1
- remaining = 0
- multiplier = 1
- while True:
- b = result[pos]
- pos += 1
- remaining += (b & 0x7F) * multiplier
- multiplier *= 128
- if (b & 0x80) == 0:
- break
- # Remaining length should match actual data
- assert pos + remaining == len(result)
- assert new_ip in result
- def test_incomplete_packet_buffered(self):
- """Incomplete packet at end of chunk is buffered for next call."""
- from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
- payload = b'{"ip":"192.168.1.100"}'
- packet = self._build_mqtt_publish("device/status", payload)
- # Split packet in the middle
- half = len(packet) // 2
- chunk1 = packet[:half]
- chunk2 = packet[half:]
- result1, buf = TLSProxy._rewrite_mqtt_ip(chunk1, b"192.168.1.100", b"10.0.0.1", bytearray())
- # First chunk should be buffered (incomplete packet)
- assert len(buf) > 0
- result2, buf = TLSProxy._rewrite_mqtt_ip(chunk2, b"192.168.1.100", b"10.0.0.1", buf)
- # Second chunk completes the packet, IP should be rewritten
- combined = result1 + result2
- assert b"10.0.0.1" in combined
- assert b"192.168.1.100" not in combined
- def test_multiple_packets_in_one_chunk(self):
- """Multiple MQTT packets in a single chunk are all processed."""
- from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
- payload1 = b'{"ip":"192.168.1.100"}'
- payload2 = b'{"other":"data"}'
- packet1 = self._build_mqtt_publish("topic1", payload1)
- packet2 = self._build_mqtt_publish("topic2", payload2)
- combined = packet1 + packet2
- result, buf = TLSProxy._rewrite_mqtt_ip(combined, b"192.168.1.100", b"10.0.0.1", bytearray())
- assert b"10.0.0.1" in result
- assert b"192.168.1.100" not in result
- # Second packet should still be present
- assert b"other" in result
- def test_extra_replacements(self):
- """Extra replacement pairs (e.g. integer IP) are also applied."""
- from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
- payload = b'{"net":{"info":[{"ip":2248124608}]}}'
- packet = self._build_mqtt_publish("device/status", payload)
- result, buf = TLSProxy._rewrite_mqtt_ip(
- packet,
- b"NOMATCH",
- b"NOREPLACE",
- bytearray(),
- extra_replacements=[(b"2248124608", b"285190336")],
- )
- assert b"285190336" in result
- assert b"2248124608" not in result
- class TestIpToLeIntBytes:
- """Tests for TLSProxy._ip_to_le_int_bytes() integer IP conversion."""
- def test_converts_ip_to_le_int(self):
- from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
- assert TLSProxy._ip_to_le_int_bytes("192.168.255.133") == b"2248124608"
- assert TLSProxy._ip_to_le_int_bytes("192.168.255.16") == b"285190336"
- assert TLSProxy._ip_to_le_int_bytes("10.0.0.1") == b"16777226"
- def test_roundtrip(self):
- """Verify the integer converts back to the correct IP."""
- import struct
- from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
- for ip in ["192.168.1.1", "10.0.0.1", "172.16.0.100", "192.168.255.133"]:
- le_int = int(TLSProxy._ip_to_le_int_bytes(ip))
- parts = ip.split(".")
- expected = struct.unpack("<I", bytes(int(p) for p in parts))[0]
- assert le_int == expected
- class TestSSDPProxyName:
- """Tests for SSDPProxy VP name rewriting."""
- @pytest.fixture
- def ssdp_proxy_with_name(self):
- from backend.app.services.virtual_printer.ssdp_server import SSDPProxy
- return SSDPProxy(
- local_interface_ip="192.168.1.100",
- remote_interface_ip="10.0.0.100",
- target_printer_ip="192.168.1.50",
- name="H2D-1 Proxy",
- )
- @pytest.fixture
- def ssdp_proxy_without_name(self):
- from backend.app.services.virtual_printer.ssdp_server import SSDPProxy
- return SSDPProxy(
- local_interface_ip="192.168.1.100",
- remote_interface_ip="10.0.0.100",
- target_printer_ip="192.168.1.50",
- )
- def test_rewrite_uses_configured_name(self, ssdp_proxy_with_name):
- """When name is set, DevName is replaced entirely."""
- packet = b"NOTIFY * HTTP/1.1\r\nLocation: 192.168.1.50\r\nDevName.bambu.com: RealPrinter\r\nDevBind.bambu.com: cloud\r\n\r\n"
- rewritten = ssdp_proxy_with_name._rewrite_ssdp(packet)
- assert b"DevName.bambu.com: H2D-1 Proxy" in rewritten
- assert b"RealPrinter" not in rewritten
- def test_rewrite_appends_proxy_without_name(self, ssdp_proxy_without_name):
- """When no name is set, ' - Proxy' is appended to the real name."""
- packet = b"NOTIFY * HTTP/1.1\r\nLocation: 192.168.1.50\r\nDevName.bambu.com: RealPrinter\r\nDevBind.bambu.com: cloud\r\n\r\n"
- rewritten = ssdp_proxy_without_name._rewrite_ssdp(packet)
- assert b"DevName.bambu.com: RealPrinter - Proxy" in rewritten
|