| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882 |
- """Unit tests for Virtual Printer services.
- Tests the virtual printer manager, FTP server, and SSDP server components.
- """
- import asyncio
- from pathlib import Path
- from unittest.mock import AsyncMock, MagicMock, patch
- import pytest
- 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="immediate",
- 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 == "immediate"
- 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="immediate",
- 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_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
- # ========================================================================
- # 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="print_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="print_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.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_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="print_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.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
- 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"] == "immediate"
- 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="immediate",
- 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="immediate",
- 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="immediate",
- 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"] == "immediate"
- 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="immediate",
- 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="immediate",
- 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": "immediate",
- "model": "C11",
- "access_code": "12345678",
- "serial_suffix": "391800001",
- "bind_ip": "",
- "remote_interface_ip": "",
- "target_printer_id": None,
- "auto_dispatch": True,
- "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="immediate",
- 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 "archive"
- db_vp = self._make_db_vp(mode="archive")
- 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="immediate",
- 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="immediate",
- 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="immediate",
- 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="immediate",
- 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)
- 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="immediate",
- 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="immediate",
- 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="immediate",
- 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="immediate",
- 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="immediate",
- model="BL-P001",
- access_code="12345678",
- serial_suffix="391800099",
- bind_ip="192.168.1.50",
- base_dir=tmp_path,
- )
- with (
- patch("backend.app.services.virtual_printer.manager.VirtualPrinterSSDPServer"),
- patch("backend.app.services.virtual_printer.manager.VirtualPrinterFTPServer"),
- patch("backend.app.services.virtual_printer.manager.SimpleMQTTServer"),
- patch("backend.app.services.virtual_printer.manager.BindServer") 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
|