test_virtual_printer.py 100 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667
  1. """Unit tests for Virtual Printer services.
  2. Tests the virtual printer manager, FTP server, and SSDP server components.
  3. """
  4. import asyncio
  5. import json
  6. import zipfile
  7. from pathlib import Path
  8. from unittest.mock import AsyncMock, MagicMock, patch
  9. import pytest
  10. def _write_3mf_with_filaments(file_path: Path, filaments: list[dict], plate_index: int = 1) -> None:
  11. """Build a minimal 3MF zip with `Metadata/slice_info.config` carrying the
  12. given per-slot filament entries. Each `filaments` dict needs `id`, `type`,
  13. `color`, `used_g`. Used by the #1188 VP queue-mode tests below."""
  14. filament_xml = "".join(
  15. f'<filament id="{f["id"]}" type="{f["type"]}" color="{f["color"]}" '
  16. f'used_g="{f["used_g"]}" tray_info_idx="{f.get("tray_info_idx", "")}"/>'
  17. for f in filaments
  18. )
  19. config = (
  20. '<?xml version="1.0" encoding="utf-8"?>'
  21. "<config>"
  22. f'<plate><metadata key="index" value="{plate_index}"/>'
  23. f"{filament_xml}"
  24. "</plate>"
  25. "</config>"
  26. )
  27. with zipfile.ZipFile(file_path, "w") as zf:
  28. zf.writestr("Metadata/slice_info.config", config)
  29. # Plate gcode is referenced for plate-id detection in the VP path —
  30. # presence is enough; contents don't matter.
  31. zf.writestr(f"Metadata/plate_{plate_index}.gcode", "; gcode\n")
  32. class TestVirtualPrinterInstance:
  33. """Tests for VirtualPrinterInstance class."""
  34. @pytest.fixture
  35. def instance(self, tmp_path):
  36. """Create a VirtualPrinterInstance with test defaults."""
  37. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  38. return VirtualPrinterInstance(
  39. vp_id=1,
  40. name="TestPrinter",
  41. mode="immediate",
  42. model="C11",
  43. access_code="12345678",
  44. serial_suffix="391800001",
  45. base_dir=tmp_path,
  46. )
  47. # ========================================================================
  48. # Tests for instance properties
  49. # ========================================================================
  50. def test_instance_stores_parameters(self, instance):
  51. """Verify constructor stores parameters correctly."""
  52. assert instance.id == 1
  53. assert instance.name == "TestPrinter"
  54. assert instance.mode == "immediate"
  55. assert instance.model == "C11"
  56. assert instance.access_code == "12345678"
  57. assert instance.serial_suffix == "391800001"
  58. def test_instance_serial_property(self, instance):
  59. """Verify serial is generated from model prefix + suffix."""
  60. # C11 = P1P, prefix = 01S00A
  61. assert instance.serial == "01S00A391800001"
  62. def test_instance_serial_x1c(self, tmp_path):
  63. """Verify X1C serial uses correct prefix."""
  64. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  65. inst = VirtualPrinterInstance(
  66. vp_id=2,
  67. name="X1C",
  68. mode="immediate",
  69. model="BL-P001",
  70. access_code="12345678",
  71. serial_suffix="391800002",
  72. base_dir=tmp_path,
  73. )
  74. assert inst.serial == "00M00A391800002"
  75. def test_instance_is_proxy_false(self, instance):
  76. """Verify is_proxy is False for non-proxy mode."""
  77. assert instance.is_proxy is False
  78. def test_instance_is_proxy_true(self, tmp_path):
  79. """Verify is_proxy is True for proxy mode."""
  80. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  81. inst = VirtualPrinterInstance(
  82. vp_id=3,
  83. name="Proxy",
  84. mode="proxy",
  85. model="C11",
  86. access_code="",
  87. serial_suffix="391800003",
  88. target_printer_ip="192.168.1.100",
  89. base_dir=tmp_path,
  90. )
  91. assert inst.is_proxy is True
  92. def test_instance_is_running_with_active_tasks(self, instance):
  93. """Verify is_running is True when tasks are active."""
  94. mock_task = MagicMock()
  95. mock_task.done.return_value = False
  96. instance._tasks = [mock_task]
  97. assert instance.is_running is True
  98. def test_instance_is_running_with_no_tasks(self, instance):
  99. """Verify is_running is False when no tasks."""
  100. assert instance.is_running is False
  101. def test_instance_creates_directories(self, instance, tmp_path):
  102. """Verify instance creates upload and cert directories."""
  103. assert (tmp_path / "uploads" / "1").exists()
  104. assert (tmp_path / "uploads" / "1" / "cache").exists()
  105. assert (tmp_path / "certs" / "1").exists()
  106. # ========================================================================
  107. # Tests for status
  108. # ========================================================================
  109. def test_get_status_returns_correct_format(self, instance):
  110. """Verify get_status returns expected fields."""
  111. instance._pending_files = {"file1.3mf": Path("/tmp/file1.3mf")} # nosec B108
  112. mock_task = MagicMock(done=MagicMock(return_value=False))
  113. instance._tasks = [mock_task]
  114. status = instance.get_status()
  115. assert status["running"] is True
  116. assert status["pending_files"] == 1
  117. def test_get_status_not_running(self, instance):
  118. """Verify get_status when no tasks."""
  119. status = instance.get_status()
  120. assert status["running"] is False
  121. assert status["pending_files"] == 0
  122. # ========================================================================
  123. # Tests for file handling
  124. # ========================================================================
  125. @pytest.mark.asyncio
  126. async def test_on_file_received_adds_to_pending(self, instance):
  127. """Verify received file is added to pending list in review mode."""
  128. instance.mode = "review"
  129. file_path = Path("/tmp/test.3mf") # nosec B108
  130. with patch.object(instance, "_queue_file", new_callable=AsyncMock) as mock_queue:
  131. await instance.on_file_received(file_path, "192.168.1.100")
  132. assert "test.3mf" in instance._pending_files
  133. mock_queue.assert_called_once()
  134. @pytest.mark.asyncio
  135. async def test_on_file_received_archives_immediately(self, instance):
  136. """Verify file is archived in immediate mode."""
  137. file_path = Path("/tmp/test.3mf") # nosec B108
  138. with patch.object(instance, "_archive_file", new_callable=AsyncMock) as mock_archive:
  139. await instance.on_file_received(file_path, "192.168.1.100")
  140. mock_archive.assert_called_once_with(file_path, "192.168.1.100")
  141. @pytest.mark.asyncio
  142. async def test_on_file_received_signals_FINISH_to_slicer(self, instance):
  143. """Regression #1280: when a slicer's Print flow uploads to a non-proxy VP,
  144. the VP must transition gcode_state PREPARE → FINISH so the slicer's
  145. in-flight-job lock releases. Going PREPARE → IDLE wedges Orca at
  146. "Downloading...(0%)" and blocks the next dispatch with "busy with
  147. another print job".
  148. Send-flow slicers don't watch the post-upload state, so this is a
  149. no-op behavior change for them.
  150. """
  151. instance.mode = "immediate"
  152. instance._mqtt = MagicMock()
  153. instance._mqtt.set_gcode_state = MagicMock()
  154. file_path = Path("/tmp/test.3mf") # nosec B108
  155. with patch.object(instance, "_archive_file", new_callable=AsyncMock):
  156. await instance.on_file_received(file_path, "192.168.1.100")
  157. instance._mqtt.set_gcode_state.assert_called_once_with("FINISH", filename="test.3mf", prepare_percent="100")
  158. @pytest.mark.asyncio
  159. async def test_on_file_received_non_3mf_does_not_touch_state(self, instance):
  160. """Non-3MF uploads (e.g., a job's auxiliary files) must not transition
  161. the visible state — the slicer is only tracking the .3mf upload."""
  162. instance.mode = "immediate"
  163. instance._mqtt = MagicMock()
  164. instance._mqtt.set_gcode_state = MagicMock()
  165. file_path = Path("/tmp/test.gcode") # nosec B108
  166. with patch.object(instance, "_archive_file", new_callable=AsyncMock):
  167. await instance.on_file_received(file_path, "192.168.1.100")
  168. instance._mqtt.set_gcode_state.assert_not_called()
  169. @pytest.mark.asyncio
  170. async def test_archive_file_skips_non_3mf(self, instance):
  171. """Verify non-3MF files are skipped and cleaned up."""
  172. instance._session_factory = MagicMock()
  173. instance._pending_files["verify_job"] = Path("/tmp/verify_job") # nosec B108
  174. with patch("pathlib.Path.unlink"):
  175. await instance._archive_file(Path("/tmp/verify_job"), "192.168.1.100") # nosec B108
  176. assert "verify_job" not in instance._pending_files
  177. @pytest.mark.asyncio
  178. async def test_archive_file_broadcasts_archive_created(self, tmp_path):
  179. """#1282: VP immediate-mode archives must broadcast archive_created so
  180. the Archives page refreshes without a tab switch. Real-printer prints
  181. get this via main.py's MQTT print_start handler; the VP path used to
  182. skip the broadcast entirely."""
  183. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  184. mock_db = AsyncMock()
  185. mock_db.commit = AsyncMock()
  186. mock_session_factory = MagicMock()
  187. mock_session_ctx = AsyncMock()
  188. mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
  189. mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
  190. mock_session_factory.return_value = mock_session_ctx
  191. inst = VirtualPrinterInstance(
  192. vp_id=30,
  193. name="ImmediateBroadcast",
  194. mode="immediate",
  195. model="C12",
  196. access_code="12345678",
  197. serial_suffix="391800030",
  198. base_dir=tmp_path,
  199. session_factory=mock_session_factory,
  200. )
  201. file_path = tmp_path / "test.3mf"
  202. file_path.write_bytes(b"fake3mf")
  203. mock_archive = MagicMock()
  204. mock_archive.id = 99
  205. mock_archive.printer_id = None
  206. mock_archive.filename = "test.3mf"
  207. mock_archive.print_name = "test"
  208. mock_archive.status = "archived"
  209. with (
  210. patch(
  211. "backend.app.api.routes.settings.get_setting",
  212. new_callable=AsyncMock,
  213. return_value=None,
  214. ),
  215. patch(
  216. "backend.app.services.archive.ArchiveService.archive_print",
  217. new_callable=AsyncMock,
  218. return_value=mock_archive,
  219. ),
  220. patch(
  221. "backend.app.core.websocket.ws_manager.send_archive_created",
  222. new_callable=AsyncMock,
  223. ) as mock_broadcast,
  224. ):
  225. await inst._archive_file(file_path, "192.168.1.100")
  226. mock_broadcast.assert_awaited_once()
  227. payload = mock_broadcast.await_args.args[0]
  228. assert payload["id"] == 99
  229. assert payload["filename"] == "test.3mf"
  230. assert payload["status"] == "archived"
  231. # ========================================================================
  232. # Tests for auto_dispatch
  233. # ========================================================================
  234. def test_auto_dispatch_defaults_to_true(self, tmp_path):
  235. """Verify auto_dispatch defaults to True when not specified."""
  236. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  237. inst = VirtualPrinterInstance(
  238. vp_id=10,
  239. name="DefaultDispatch",
  240. mode="print_queue",
  241. model="C11",
  242. access_code="12345678",
  243. serial_suffix="391800010",
  244. base_dir=tmp_path,
  245. )
  246. assert inst.auto_dispatch is True
  247. @pytest.mark.asyncio
  248. async def test_add_to_print_queue_with_auto_dispatch_on(self, tmp_path):
  249. """Verify queue items have manual_start=False when auto_dispatch=True."""
  250. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  251. mock_db = AsyncMock()
  252. added_items = []
  253. def capture_add(item):
  254. added_items.append(item)
  255. mock_db.add = MagicMock(side_effect=capture_add)
  256. mock_db.commit = AsyncMock()
  257. mock_session_factory = MagicMock()
  258. mock_session_ctx = AsyncMock()
  259. mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
  260. mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
  261. mock_session_factory.return_value = mock_session_ctx
  262. inst = VirtualPrinterInstance(
  263. vp_id=11,
  264. name="AutoDispatchOn",
  265. mode="print_queue",
  266. model="C11",
  267. access_code="12345678",
  268. serial_suffix="391800011",
  269. auto_dispatch=True,
  270. base_dir=tmp_path,
  271. session_factory=mock_session_factory,
  272. )
  273. # Create a temp 3mf file
  274. file_path = tmp_path / "test.3mf"
  275. file_path.write_bytes(b"fake3mf")
  276. mock_archive = MagicMock()
  277. mock_archive.id = 1
  278. mock_archive.print_name = "test"
  279. with (
  280. patch(
  281. "backend.app.api.routes.settings.get_setting",
  282. new_callable=AsyncMock,
  283. return_value=None,
  284. ),
  285. patch(
  286. "backend.app.services.archive.ArchiveService.archive_print",
  287. new_callable=AsyncMock,
  288. return_value=mock_archive,
  289. ),
  290. ):
  291. await inst._add_to_print_queue(file_path, "192.168.1.100")
  292. assert len(added_items) == 1
  293. queue_item = added_items[0]
  294. assert queue_item.manual_start is False
  295. @pytest.mark.asyncio
  296. async def test_add_to_print_queue_broadcasts_archive_created(self, tmp_path):
  297. """#1282: VP queue-mode uploads must broadcast archive_created so the
  298. Archives page picks up the new entry live. Pre-fix the page only
  299. refreshed when the user manually switched tabs."""
  300. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  301. mock_db = AsyncMock()
  302. mock_db.add = MagicMock()
  303. mock_db.commit = AsyncMock()
  304. mock_session_factory = MagicMock()
  305. mock_session_ctx = AsyncMock()
  306. mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
  307. mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
  308. mock_session_factory.return_value = mock_session_ctx
  309. inst = VirtualPrinterInstance(
  310. vp_id=31,
  311. name="QueueBroadcast",
  312. mode="print_queue",
  313. model="C12",
  314. access_code="12345678",
  315. serial_suffix="391800031",
  316. auto_dispatch=True,
  317. base_dir=tmp_path,
  318. session_factory=mock_session_factory,
  319. )
  320. file_path = tmp_path / "test.3mf"
  321. file_path.write_bytes(b"fake3mf")
  322. mock_archive = MagicMock()
  323. mock_archive.id = 77
  324. mock_archive.printer_id = None
  325. mock_archive.filename = "test.3mf"
  326. mock_archive.print_name = "test"
  327. mock_archive.status = "archived"
  328. with (
  329. patch(
  330. "backend.app.api.routes.settings.get_setting",
  331. new_callable=AsyncMock,
  332. return_value=None,
  333. ),
  334. patch(
  335. "backend.app.services.archive.ArchiveService.archive_print",
  336. new_callable=AsyncMock,
  337. return_value=mock_archive,
  338. ),
  339. patch(
  340. "backend.app.core.websocket.ws_manager.send_archive_created",
  341. new_callable=AsyncMock,
  342. ) as mock_broadcast,
  343. ):
  344. await inst._add_to_print_queue(file_path, "192.168.1.100")
  345. mock_broadcast.assert_awaited_once()
  346. payload = mock_broadcast.await_args.args[0]
  347. assert payload["id"] == 77
  348. assert payload["print_name"] == "test"
  349. assert payload["status"] == "archived"
  350. @pytest.mark.asyncio
  351. async def test_add_to_print_queue_with_auto_dispatch_off(self, tmp_path):
  352. """Verify queue items have manual_start=True when auto_dispatch=False."""
  353. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  354. mock_db = AsyncMock()
  355. added_items = []
  356. def capture_add(item):
  357. added_items.append(item)
  358. mock_db.add = MagicMock(side_effect=capture_add)
  359. mock_db.commit = AsyncMock()
  360. mock_session_factory = MagicMock()
  361. mock_session_ctx = AsyncMock()
  362. mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
  363. mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
  364. mock_session_factory.return_value = mock_session_ctx
  365. inst = VirtualPrinterInstance(
  366. vp_id=12,
  367. name="AutoDispatchOff",
  368. mode="print_queue",
  369. model="C11",
  370. access_code="12345678",
  371. serial_suffix="391800012",
  372. auto_dispatch=False,
  373. base_dir=tmp_path,
  374. session_factory=mock_session_factory,
  375. )
  376. # Create a temp 3mf file
  377. file_path = tmp_path / "test.3mf"
  378. file_path.write_bytes(b"fake3mf")
  379. mock_archive = MagicMock()
  380. mock_archive.id = 1
  381. mock_archive.print_name = "test"
  382. with (
  383. patch(
  384. "backend.app.api.routes.settings.get_setting",
  385. new_callable=AsyncMock,
  386. return_value=None,
  387. ),
  388. patch(
  389. "backend.app.services.archive.ArchiveService.archive_print",
  390. new_callable=AsyncMock,
  391. return_value=mock_archive,
  392. ),
  393. ):
  394. await inst._add_to_print_queue(file_path, "192.168.1.100")
  395. assert len(added_items) == 1
  396. queue_item = added_items[0]
  397. assert queue_item.manual_start is True
  398. @pytest.mark.asyncio
  399. async def test_add_to_print_queue_uses_workflow_defaults_from_settings(self, tmp_path):
  400. """#1235: VP queue-mode constructed PrintQueueItem without specifying
  401. bed_levelling / flow_cali / vibration_cali / layer_inspect / timelapse,
  402. so SQLAlchemy applied the column-level defaults and ignored the user's
  403. workflow preferences entirely. Every print sent from the slicer to the
  404. VP came through with the OPPOSITE of what the workflow page said,
  405. forcing the user to edit each queue item by hand.
  406. """
  407. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  408. added_items = []
  409. mock_db = AsyncMock()
  410. mock_db.add = MagicMock(side_effect=added_items.append)
  411. mock_db.commit = AsyncMock()
  412. mock_session_factory = MagicMock()
  413. mock_session_ctx = AsyncMock()
  414. mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
  415. mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
  416. mock_session_factory.return_value = mock_session_ctx
  417. inst = VirtualPrinterInstance(
  418. vp_id=22,
  419. name="DefaultsTest",
  420. mode="print_queue",
  421. model="C12",
  422. access_code="12345678",
  423. serial_suffix="391800022",
  424. auto_dispatch=True,
  425. base_dir=tmp_path,
  426. session_factory=mock_session_factory,
  427. )
  428. file_path = tmp_path / "test.3mf"
  429. file_path.write_bytes(b"fake3mf")
  430. # The reporter set every workflow default to the OPPOSITE of the model's
  431. # column default. Pre-fix the column defaults won; with the fix the
  432. # settings values must flow through to the queue item exactly as stored.
  433. settings_map = {
  434. "virtual_printer_archive_name_source": None,
  435. "default_bed_levelling": "false", # model default: True
  436. "default_flow_cali": "true", # model default: False
  437. "default_vibration_cali": "false", # model default: True
  438. "default_layer_inspect": "true", # model default: False
  439. "default_timelapse": "true", # model default: False
  440. }
  441. async def fake_get_setting(_db, key):
  442. return settings_map.get(key)
  443. mock_archive = MagicMock()
  444. mock_archive.id = 1
  445. mock_archive.print_name = "test"
  446. with (
  447. patch(
  448. "backend.app.api.routes.settings.get_setting",
  449. new=fake_get_setting,
  450. ),
  451. patch(
  452. "backend.app.services.archive.ArchiveService.archive_print",
  453. new_callable=AsyncMock,
  454. return_value=mock_archive,
  455. ),
  456. ):
  457. await inst._add_to_print_queue(file_path, "192.168.1.100")
  458. assert len(added_items) == 1
  459. queue_item = added_items[0]
  460. assert queue_item.bed_levelling is False, "default_bed_levelling=false must flow through"
  461. assert queue_item.flow_cali is True, "default_flow_cali=true must flow through"
  462. assert queue_item.vibration_cali is False, "default_vibration_cali=false must flow through"
  463. assert queue_item.layer_inspect is True, "default_layer_inspect=true must flow through"
  464. assert queue_item.timelapse is True, "default_timelapse=true must flow through"
  465. @pytest.mark.asyncio
  466. async def test_add_to_print_queue_falls_back_to_schema_defaults_when_unset(self, tmp_path):
  467. """#1235 fallback: when no workflow setting is in the DB, the queue
  468. item should use the AppSettings (Pydantic) defaults — same values
  469. the user sees in the workflow page on a fresh install.
  470. """
  471. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  472. added_items = []
  473. mock_db = AsyncMock()
  474. mock_db.add = MagicMock(side_effect=added_items.append)
  475. mock_db.commit = AsyncMock()
  476. mock_session_factory = MagicMock()
  477. mock_session_ctx = AsyncMock()
  478. mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
  479. mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
  480. mock_session_factory.return_value = mock_session_ctx
  481. inst = VirtualPrinterInstance(
  482. vp_id=23,
  483. name="FreshInstallDefaults",
  484. mode="print_queue",
  485. model="C12",
  486. access_code="12345678",
  487. serial_suffix="391800023",
  488. auto_dispatch=True,
  489. base_dir=tmp_path,
  490. session_factory=mock_session_factory,
  491. )
  492. file_path = tmp_path / "test.3mf"
  493. file_path.write_bytes(b"fake3mf")
  494. mock_archive = MagicMock()
  495. mock_archive.id = 1
  496. mock_archive.print_name = "test"
  497. with (
  498. patch(
  499. "backend.app.api.routes.settings.get_setting",
  500. new_callable=AsyncMock,
  501. return_value=None, # No settings → fall back to schema defaults
  502. ),
  503. patch(
  504. "backend.app.services.archive.ArchiveService.archive_print",
  505. new_callable=AsyncMock,
  506. return_value=mock_archive,
  507. ),
  508. ):
  509. await inst._add_to_print_queue(file_path, "192.168.1.100")
  510. assert len(added_items) == 1
  511. queue_item = added_items[0]
  512. # These must match the AppSettings (Pydantic) defaults in schemas/settings.py
  513. assert queue_item.bed_levelling is True
  514. assert queue_item.flow_cali is False
  515. assert queue_item.vibration_cali is True
  516. assert queue_item.layer_inspect is False
  517. assert queue_item.timelapse is False
  518. @pytest.mark.asyncio
  519. async def test_add_to_print_queue_inherits_slicer_print_options(self, tmp_path):
  520. """#1403: VP-queue items used to fall back to `default_timelapse` even
  521. though the slicer's MQTT `project_file` command carries the user's
  522. actual choice. Capture-via-`on_print_command` flow lets the user's
  523. slicer toggle reach the queue item.
  524. Settings here have timelapse OFF; the slicer's MQTT capture has it ON.
  525. After the fix the queue item must reflect the slicer's choice.
  526. """
  527. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  528. added_items = []
  529. mock_db = AsyncMock()
  530. mock_db.add = MagicMock(side_effect=added_items.append)
  531. mock_db.commit = AsyncMock()
  532. mock_session_factory = MagicMock()
  533. mock_session_ctx = AsyncMock()
  534. mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
  535. mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
  536. mock_session_factory.return_value = mock_session_ctx
  537. inst = VirtualPrinterInstance(
  538. vp_id=24,
  539. name="SlicerInherits",
  540. mode="print_queue",
  541. model="C12",
  542. access_code="12345678",
  543. serial_suffix="391800024",
  544. auto_dispatch=True,
  545. base_dir=tmp_path,
  546. session_factory=mock_session_factory,
  547. )
  548. file_path = tmp_path / "test.3mf"
  549. file_path.write_bytes(b"fake3mf")
  550. # Pre-populate the capture as if MQTT `project_file` arrived already.
  551. # Settings (below) deliberately have timelapse OFF — only the slicer
  552. # capture should drive the resulting queue item.
  553. await inst.on_print_command(
  554. file_path.name,
  555. {
  556. "command": "project_file",
  557. "timelapse": True,
  558. "bed_leveling": False, # Note: MQTT field is single-L `bed_leveling`
  559. "flow_cali": True,
  560. "vibration_cali": False,
  561. "layer_inspect": True,
  562. },
  563. )
  564. settings_map = {
  565. "virtual_printer_archive_name_source": None,
  566. "default_bed_levelling": "true",
  567. "default_flow_cali": "false",
  568. "default_vibration_cali": "true",
  569. "default_layer_inspect": "false",
  570. "default_timelapse": "false",
  571. }
  572. async def fake_get_setting(_db, key):
  573. return settings_map.get(key)
  574. mock_archive = MagicMock()
  575. mock_archive.id = 1
  576. mock_archive.print_name = "test"
  577. with (
  578. patch(
  579. "backend.app.api.routes.settings.get_setting",
  580. new=fake_get_setting,
  581. ),
  582. patch(
  583. "backend.app.services.archive.ArchiveService.archive_print",
  584. new_callable=AsyncMock,
  585. return_value=mock_archive,
  586. ),
  587. ):
  588. await inst._add_to_print_queue(file_path, "192.168.1.100")
  589. assert len(added_items) == 1
  590. queue_item = added_items[0]
  591. assert queue_item.timelapse is True, "Slicer's timelapse=True must override settings.default_timelapse=False"
  592. assert queue_item.bed_levelling is False, "Slicer's bed_leveling=False must override default_bed_levelling=True"
  593. assert queue_item.flow_cali is True
  594. assert queue_item.vibration_cali is False
  595. assert queue_item.layer_inspect is True
  596. # Capture is consumed — no lingering state for the next print of the same name.
  597. assert file_path.name not in inst._slicer_print_options
  598. @pytest.mark.asyncio
  599. async def test_add_to_print_queue_coerces_slicer_integer_zero_one(self, tmp_path):
  600. """#1403: H-family firmwares carry calibration flags as integers
  601. (0/1) rather than booleans. The capture must coerce both shapes so
  602. H-family-sliced jobs through the VP queue work the same as P1/X1.
  603. """
  604. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  605. added_items = []
  606. mock_db = AsyncMock()
  607. mock_db.add = MagicMock(side_effect=added_items.append)
  608. mock_db.commit = AsyncMock()
  609. mock_session_factory = MagicMock()
  610. mock_session_ctx = AsyncMock()
  611. mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
  612. mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
  613. mock_session_factory.return_value = mock_session_ctx
  614. inst = VirtualPrinterInstance(
  615. vp_id=25,
  616. name="SlicerIntegers",
  617. mode="print_queue",
  618. model="C12",
  619. access_code="12345678",
  620. serial_suffix="391800025",
  621. auto_dispatch=True,
  622. base_dir=tmp_path,
  623. session_factory=mock_session_factory,
  624. )
  625. file_path = tmp_path / "test.3mf"
  626. file_path.write_bytes(b"fake3mf")
  627. await inst.on_print_command(
  628. file_path.name,
  629. {"command": "project_file", "timelapse": 1, "bed_leveling": 0, "flow_cali": 1},
  630. )
  631. mock_archive = MagicMock()
  632. mock_archive.id = 1
  633. mock_archive.print_name = "test"
  634. with (
  635. patch(
  636. "backend.app.api.routes.settings.get_setting",
  637. new_callable=AsyncMock,
  638. return_value=None,
  639. ),
  640. patch(
  641. "backend.app.services.archive.ArchiveService.archive_print",
  642. new_callable=AsyncMock,
  643. return_value=mock_archive,
  644. ),
  645. ):
  646. await inst._add_to_print_queue(file_path, "192.168.1.100")
  647. assert len(added_items) == 1
  648. queue_item = added_items[0]
  649. assert queue_item.timelapse is True, "integer 1 must coerce to True"
  650. assert queue_item.bed_levelling is False, "integer 0 must coerce to False"
  651. assert queue_item.flow_cali is True
  652. @pytest.mark.asyncio
  653. async def test_add_to_print_queue_populates_required_filament_types(self, tmp_path):
  654. """#1188: VP queue-mode used to create PrintQueueItems with no
  655. filament fields, so the scheduler fell through to model-only matching
  656. and dispatched onto whatever printer was free regardless of loaded
  657. colour. ``required_filament_types`` is populated unconditionally
  658. (cheap, helps the scheduler validate type even without
  659. ``force_color_match``) — pin that contract here."""
  660. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  661. added_items = []
  662. mock_db = AsyncMock()
  663. mock_db.add = MagicMock(side_effect=added_items.append)
  664. mock_db.commit = AsyncMock()
  665. mock_session_factory = MagicMock()
  666. mock_session_ctx = AsyncMock()
  667. mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
  668. mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
  669. mock_session_factory.return_value = mock_session_ctx
  670. inst = VirtualPrinterInstance(
  671. vp_id=21,
  672. name="Reqs",
  673. mode="print_queue",
  674. model="C12",
  675. access_code="12345678",
  676. serial_suffix="391800021",
  677. auto_dispatch=True,
  678. queue_force_color_match=False, # off → only required_filament_types
  679. base_dir=tmp_path,
  680. session_factory=mock_session_factory,
  681. )
  682. file_path = tmp_path / "multi.3mf"
  683. _write_3mf_with_filaments(
  684. file_path,
  685. [
  686. {"id": "1", "type": "PLA", "color": "#FFFFFF", "used_g": "12.3"},
  687. {"id": "2", "type": "PETG", "color": "#000000", "used_g": "4.5"},
  688. # used_g=0 → not actually consumed by this plate, must be ignored
  689. {"id": "3", "type": "ABS", "color": "#FF0000", "used_g": "0"},
  690. ],
  691. plate_index=1,
  692. )
  693. mock_archive = MagicMock()
  694. mock_archive.id = 1
  695. mock_archive.print_name = "multi"
  696. with (
  697. patch(
  698. "backend.app.api.routes.settings.get_setting",
  699. new_callable=AsyncMock,
  700. return_value=None,
  701. ),
  702. patch(
  703. "backend.app.services.archive.ArchiveService.archive_print",
  704. new_callable=AsyncMock,
  705. return_value=mock_archive,
  706. ),
  707. ):
  708. await inst._add_to_print_queue(file_path, "192.168.1.100")
  709. assert len(added_items) == 1
  710. queue_item = added_items[0]
  711. # Type-only fallback always populated. Sorted, deduped, no zero-use ABS.
  712. assert queue_item.required_filament_types is not None
  713. assert json.loads(queue_item.required_filament_types) == ["PETG", "PLA"]
  714. # Setting off → no force_color_match overrides leaked.
  715. assert queue_item.filament_overrides is None
  716. @pytest.mark.asyncio
  717. async def test_add_to_print_queue_force_color_match_writes_overrides(self, tmp_path):
  718. """#1188 core fix: when the per-VP ``queue_force_color_match`` toggle
  719. is on, every consumed slot lands as a ``filament_overrides`` entry
  720. with ``force_color_match: true``. This is the field the scheduler
  721. keys on (``print_scheduler.py:512``) — without it, slot-by-slot
  722. type+color matching never runs."""
  723. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  724. added_items = []
  725. mock_db = AsyncMock()
  726. mock_db.add = MagicMock(side_effect=added_items.append)
  727. mock_db.commit = AsyncMock()
  728. mock_session_factory = MagicMock()
  729. mock_session_ctx = AsyncMock()
  730. mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
  731. mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
  732. mock_session_factory.return_value = mock_session_ctx
  733. inst = VirtualPrinterInstance(
  734. vp_id=22,
  735. name="ForceColor",
  736. mode="print_queue",
  737. model="C12",
  738. access_code="12345678",
  739. serial_suffix="391800022",
  740. auto_dispatch=True,
  741. queue_force_color_match=True, # on
  742. base_dir=tmp_path,
  743. session_factory=mock_session_factory,
  744. )
  745. file_path = tmp_path / "forced.3mf"
  746. _write_3mf_with_filaments(
  747. file_path,
  748. [
  749. {"id": "1", "type": "PLA", "color": "#FFFFFF", "used_g": "10.0"},
  750. {"id": "2", "type": "PLA", "color": "#FF00FF", "used_g": "5.0"},
  751. ],
  752. plate_index=1,
  753. )
  754. mock_archive = MagicMock()
  755. mock_archive.id = 1
  756. mock_archive.print_name = "forced"
  757. with (
  758. patch(
  759. "backend.app.api.routes.settings.get_setting",
  760. new_callable=AsyncMock,
  761. return_value=None,
  762. ),
  763. patch(
  764. "backend.app.services.archive.ArchiveService.archive_print",
  765. new_callable=AsyncMock,
  766. return_value=mock_archive,
  767. ),
  768. ):
  769. await inst._add_to_print_queue(file_path, "192.168.1.100")
  770. assert len(added_items) == 1
  771. queue_item = added_items[0]
  772. assert queue_item.filament_overrides is not None
  773. overrides = json.loads(queue_item.filament_overrides)
  774. assert overrides == [
  775. {"slot_id": 1, "type": "PLA", "color": "#FFFFFF", "force_color_match": True},
  776. {"slot_id": 2, "type": "PLA", "color": "#FF00FF", "force_color_match": True},
  777. ]
  778. # required_filament_types still populated alongside overrides.
  779. assert json.loads(queue_item.required_filament_types) == ["PLA"]
  780. @pytest.mark.asyncio
  781. async def test_add_to_print_queue_force_color_match_skips_when_3mf_unparseable(self, tmp_path):
  782. """A malformed or fake-bytes 3MF must not crash the upload path —
  783. we just write the queue item with no filament fields and let the
  784. scheduler fall back to model-only matching (the pre-#1188 default).
  785. Regression guard for the existing fake-bytes happy-path tests."""
  786. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  787. added_items = []
  788. mock_db = AsyncMock()
  789. mock_db.add = MagicMock(side_effect=added_items.append)
  790. mock_db.commit = AsyncMock()
  791. mock_session_factory = MagicMock()
  792. mock_session_ctx = AsyncMock()
  793. mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
  794. mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
  795. mock_session_factory.return_value = mock_session_ctx
  796. inst = VirtualPrinterInstance(
  797. vp_id=23,
  798. name="Unparseable",
  799. mode="print_queue",
  800. model="C12",
  801. access_code="12345678",
  802. serial_suffix="391800023",
  803. auto_dispatch=True,
  804. queue_force_color_match=True,
  805. base_dir=tmp_path,
  806. session_factory=mock_session_factory,
  807. )
  808. file_path = tmp_path / "bad.3mf"
  809. file_path.write_bytes(b"not a real 3mf zip")
  810. mock_archive = MagicMock()
  811. mock_archive.id = 1
  812. mock_archive.print_name = "bad"
  813. with (
  814. patch(
  815. "backend.app.api.routes.settings.get_setting",
  816. new_callable=AsyncMock,
  817. return_value=None,
  818. ),
  819. patch(
  820. "backend.app.services.archive.ArchiveService.archive_print",
  821. new_callable=AsyncMock,
  822. return_value=mock_archive,
  823. ),
  824. ):
  825. await inst._add_to_print_queue(file_path, "192.168.1.100")
  826. assert len(added_items) == 1
  827. queue_item = added_items[0]
  828. # No filament data extractable → both fields stay None (graceful
  829. # fallback to model-only scheduling).
  830. assert queue_item.required_filament_types is None
  831. assert queue_item.filament_overrides is None
  832. # ========================================================================
  833. # Tests for archive_name_source setting (#1152)
  834. # ========================================================================
  835. @pytest.mark.asyncio
  836. @pytest.mark.parametrize(
  837. ("setting_value", "expected_prefer_filename"),
  838. [
  839. ("filename", True),
  840. ("metadata", False),
  841. (None, False), # Default when setting unset
  842. ("", False), # Defensive: empty string is not "filename"
  843. ],
  844. )
  845. async def test_archive_file_passes_prefer_filename_per_setting(
  846. self, tmp_path, setting_value, expected_prefer_filename
  847. ):
  848. """_archive_file reads `virtual_printer_archive_name_source` and forwards
  849. prefer_filename_for_name=True only when it equals 'filename' (#1152)."""
  850. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  851. mock_db = AsyncMock()
  852. mock_session_factory = MagicMock()
  853. mock_session_ctx = AsyncMock()
  854. mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
  855. mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
  856. mock_session_factory.return_value = mock_session_ctx
  857. inst = VirtualPrinterInstance(
  858. vp_id=20,
  859. name="NameSource",
  860. mode="immediate",
  861. model="C11",
  862. access_code="12345678",
  863. serial_suffix="391800020",
  864. base_dir=tmp_path,
  865. session_factory=mock_session_factory,
  866. )
  867. file_path = tmp_path / "user-renamed-job.3mf"
  868. file_path.write_bytes(b"fake3mf")
  869. mock_archive = MagicMock()
  870. mock_archive.id = 1
  871. mock_archive.print_name = "user-renamed-job"
  872. archive_print_mock = AsyncMock(return_value=mock_archive)
  873. with (
  874. patch(
  875. "backend.app.api.routes.settings.get_setting",
  876. new_callable=AsyncMock,
  877. return_value=setting_value,
  878. ),
  879. patch(
  880. "backend.app.services.archive.ArchiveService.archive_print",
  881. archive_print_mock,
  882. ),
  883. ):
  884. await inst._archive_file(file_path, "192.168.1.100")
  885. assert archive_print_mock.await_count == 1
  886. kwargs = archive_print_mock.await_args.kwargs
  887. assert kwargs.get("prefer_filename_for_name") is expected_prefer_filename
  888. class TestVirtualPrinterManager:
  889. """Tests for VirtualPrinterManager orchestrator."""
  890. @pytest.fixture
  891. def manager(self):
  892. """Create a VirtualPrinterManager instance."""
  893. from backend.app.services.virtual_printer.manager import VirtualPrinterManager
  894. return VirtualPrinterManager()
  895. def test_manager_starts_empty(self, manager):
  896. """Verify manager starts with no instances."""
  897. assert len(manager._instances) == 0
  898. assert manager.is_enabled is False
  899. def test_manager_get_status_empty(self, manager):
  900. """Verify get_status returns disabled state when no instances."""
  901. status = manager.get_status()
  902. assert status["enabled"] is False
  903. assert status["running"] is False
  904. assert status["mode"] == "immediate"
  905. def test_manager_is_enabled_with_instance(self, manager, tmp_path):
  906. """Verify is_enabled is True when instances exist."""
  907. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  908. inst = VirtualPrinterInstance(
  909. vp_id=1,
  910. name="Test",
  911. mode="immediate",
  912. model="C11",
  913. access_code="12345678",
  914. serial_suffix="391800001",
  915. base_dir=tmp_path,
  916. )
  917. manager._instances[1] = inst
  918. assert manager.is_enabled is True
  919. @pytest.mark.asyncio
  920. async def test_manager_remove_instance_server(self, manager, tmp_path):
  921. """Verify remove_instance stops and removes a server-mode instance."""
  922. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  923. inst = VirtualPrinterInstance(
  924. vp_id=1,
  925. name="Test",
  926. mode="immediate",
  927. model="C11",
  928. access_code="12345678",
  929. serial_suffix="391800001",
  930. base_dir=tmp_path,
  931. )
  932. inst.stop_server = AsyncMock()
  933. manager._instances[1] = inst
  934. await manager.remove_instance(1)
  935. assert 1 not in manager._instances
  936. inst.stop_server.assert_called_once()
  937. @pytest.mark.asyncio
  938. async def test_manager_remove_instance_proxy(self, manager, tmp_path):
  939. """Verify remove_instance stops proxy-mode instance."""
  940. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  941. inst = VirtualPrinterInstance(
  942. vp_id=2,
  943. name="Proxy",
  944. mode="proxy",
  945. model="C11",
  946. access_code="",
  947. serial_suffix="391800002",
  948. target_printer_ip="192.168.1.100",
  949. base_dir=tmp_path,
  950. )
  951. inst.stop_proxy = AsyncMock()
  952. manager._instances[2] = inst
  953. await manager.remove_instance(2)
  954. assert 2 not in manager._instances
  955. inst.stop_proxy.assert_called_once()
  956. def test_manager_get_status_with_instance(self, manager, tmp_path):
  957. """Verify legacy get_status returns first instance data."""
  958. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  959. inst = VirtualPrinterInstance(
  960. vp_id=1,
  961. name="Bambuddy",
  962. mode="immediate",
  963. model="C11",
  964. access_code="12345678",
  965. serial_suffix="391800001",
  966. base_dir=tmp_path,
  967. )
  968. mock_task = MagicMock(done=MagicMock(return_value=False))
  969. inst._tasks = [mock_task]
  970. inst._pending_files = {"file1.3mf": Path("/tmp/file1.3mf")} # nosec B108
  971. manager._instances[1] = inst
  972. status = manager.get_status()
  973. assert status["enabled"] is True
  974. assert status["running"] is True
  975. assert status["mode"] == "immediate"
  976. assert status["name"] == "Bambuddy"
  977. assert status["serial"] == "01S00A391800001"
  978. assert status["model"] == "C11"
  979. assert status["model_name"] == "P1P"
  980. assert status["pending_files"] == 1
  981. def test_manager_get_all_status(self, manager, tmp_path):
  982. """Verify get_all_status returns status for all instances."""
  983. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  984. for i in range(1, 3):
  985. inst = VirtualPrinterInstance(
  986. vp_id=i,
  987. name=f"VP{i}",
  988. mode="immediate",
  989. model="C11",
  990. access_code="12345678",
  991. serial_suffix=f"39180000{i}",
  992. base_dir=tmp_path,
  993. )
  994. manager._instances[i] = inst
  995. statuses = manager.get_all_status()
  996. assert len(statuses) == 2
  997. assert statuses[0]["name"] == "VP1"
  998. assert statuses[1]["name"] == "VP2"
  999. @pytest.mark.asyncio
  1000. async def test_manager_stop_all(self, manager, tmp_path):
  1001. """Verify stop_all removes all instances."""
  1002. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  1003. for i in range(1, 3):
  1004. inst = VirtualPrinterInstance(
  1005. vp_id=i,
  1006. name=f"VP{i}",
  1007. mode="immediate",
  1008. model="C11",
  1009. access_code="12345678",
  1010. serial_suffix=f"39180000{i}",
  1011. base_dir=tmp_path,
  1012. )
  1013. inst.stop_server = AsyncMock()
  1014. manager._instances[i] = inst
  1015. await manager.stop_all()
  1016. assert len(manager._instances) == 0
  1017. # ========================================================================
  1018. # Tests for sync_from_db config change detection
  1019. # ========================================================================
  1020. def _make_db_vp(self, **overrides):
  1021. """Create a mock VirtualPrinter DB object."""
  1022. defaults = {
  1023. "id": 1,
  1024. "name": "TestVP",
  1025. "enabled": True,
  1026. "mode": "immediate",
  1027. "model": "C11",
  1028. "access_code": "12345678",
  1029. "serial_suffix": "391800001",
  1030. "bind_ip": "",
  1031. "remote_interface_ip": "",
  1032. "target_printer_id": None,
  1033. "auto_dispatch": True,
  1034. "tailscale_disabled": True, # Opt-in default (#1070 UX fix)
  1035. "position": 0,
  1036. }
  1037. defaults.update(overrides)
  1038. vp = MagicMock()
  1039. for k, v in defaults.items():
  1040. setattr(vp, k, v)
  1041. return vp
  1042. def _setup_sync_mocks(self, manager, enabled_vps, tmp_path):
  1043. """Wire up session_factory mock for sync_from_db."""
  1044. mock_result = MagicMock()
  1045. mock_result.scalars.return_value.all.return_value = enabled_vps
  1046. mock_db = AsyncMock()
  1047. mock_db.execute = AsyncMock(return_value=mock_result)
  1048. mock_db.__aenter__ = AsyncMock(return_value=mock_db)
  1049. mock_db.__aexit__ = AsyncMock(return_value=False)
  1050. manager._session_factory = MagicMock(return_value=mock_db)
  1051. manager._base_dir = tmp_path
  1052. @pytest.mark.asyncio
  1053. async def test_sync_from_db_restarts_on_mode_change(self, manager, tmp_path):
  1054. """Verify sync_from_db restarts VP when mode changes."""
  1055. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  1056. inst = VirtualPrinterInstance(
  1057. vp_id=1,
  1058. name="TestVP",
  1059. mode="immediate",
  1060. model="C11",
  1061. access_code="12345678",
  1062. serial_suffix="391800001",
  1063. base_dir=tmp_path,
  1064. )
  1065. inst.stop_server = AsyncMock()
  1066. manager._instances[1] = inst
  1067. # DB says mode changed to "archive"
  1068. db_vp = self._make_db_vp(mode="archive")
  1069. self._setup_sync_mocks(manager, [db_vp], tmp_path)
  1070. with patch.object(manager, "remove_instance", new_callable=AsyncMock) as mock_remove:
  1071. # Patch VirtualPrinterInstance to prevent actual start
  1072. with patch("backend.app.services.virtual_printer.manager.VirtualPrinterInstance") as MockInst:
  1073. mock_new = MagicMock()
  1074. mock_new.start_server = AsyncMock()
  1075. MockInst.return_value = mock_new
  1076. await manager.sync_from_db()
  1077. mock_remove.assert_called_once_with(1)
  1078. @pytest.mark.asyncio
  1079. async def test_sync_from_db_restarts_on_access_code_change(self, manager, tmp_path):
  1080. """Verify sync_from_db restarts VP when access_code changes."""
  1081. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  1082. inst = VirtualPrinterInstance(
  1083. vp_id=1,
  1084. name="TestVP",
  1085. mode="immediate",
  1086. model="C11",
  1087. access_code="12345678",
  1088. serial_suffix="391800001",
  1089. base_dir=tmp_path,
  1090. )
  1091. inst.stop_server = AsyncMock()
  1092. manager._instances[1] = inst
  1093. db_vp = self._make_db_vp(access_code="newcode99")
  1094. self._setup_sync_mocks(manager, [db_vp], tmp_path)
  1095. with patch.object(manager, "remove_instance", new_callable=AsyncMock) as mock_remove:
  1096. with patch("backend.app.services.virtual_printer.manager.VirtualPrinterInstance") as MockInst:
  1097. mock_new = MagicMock()
  1098. mock_new.start_server = AsyncMock()
  1099. MockInst.return_value = mock_new
  1100. await manager.sync_from_db()
  1101. mock_remove.assert_called_once_with(1)
  1102. @pytest.mark.asyncio
  1103. async def test_sync_from_db_skips_unchanged_instance(self, manager, tmp_path):
  1104. """Verify sync_from_db does NOT restart when config is identical."""
  1105. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  1106. inst = VirtualPrinterInstance(
  1107. vp_id=1,
  1108. name="TestVP",
  1109. mode="immediate",
  1110. model="C11",
  1111. access_code="12345678",
  1112. serial_suffix="391800001",
  1113. base_dir=tmp_path,
  1114. )
  1115. manager._instances[1] = inst
  1116. # DB matches running config exactly
  1117. db_vp = self._make_db_vp()
  1118. self._setup_sync_mocks(manager, [db_vp], tmp_path)
  1119. with patch.object(manager, "remove_instance", new_callable=AsyncMock) as mock_remove:
  1120. await manager.sync_from_db()
  1121. mock_remove.assert_not_called()
  1122. @pytest.mark.asyncio
  1123. async def test_sync_from_db_restarts_on_bind_ip_change(self, manager, tmp_path):
  1124. """Verify sync_from_db restarts VP when bind_ip changes."""
  1125. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  1126. inst = VirtualPrinterInstance(
  1127. vp_id=1,
  1128. name="TestVP",
  1129. mode="immediate",
  1130. model="C11",
  1131. access_code="12345678",
  1132. serial_suffix="391800001",
  1133. bind_ip="192.168.1.10",
  1134. base_dir=tmp_path,
  1135. )
  1136. inst.stop_server = AsyncMock()
  1137. manager._instances[1] = inst
  1138. db_vp = self._make_db_vp(bind_ip="192.168.1.20")
  1139. self._setup_sync_mocks(manager, [db_vp], tmp_path)
  1140. with patch.object(manager, "remove_instance", new_callable=AsyncMock) as mock_remove:
  1141. with patch("backend.app.services.virtual_printer.manager.VirtualPrinterInstance") as MockInst:
  1142. mock_new = MagicMock()
  1143. mock_new.start_server = AsyncMock()
  1144. MockInst.return_value = mock_new
  1145. await manager.sync_from_db()
  1146. mock_remove.assert_called_once_with(1)
  1147. @pytest.mark.asyncio
  1148. async def test_sync_from_db_restarts_on_model_change(self, manager, tmp_path):
  1149. """Verify sync_from_db restarts VP when model changes."""
  1150. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  1151. inst = VirtualPrinterInstance(
  1152. vp_id=1,
  1153. name="TestVP",
  1154. mode="immediate",
  1155. model="C11",
  1156. access_code="12345678",
  1157. serial_suffix="391800001",
  1158. base_dir=tmp_path,
  1159. )
  1160. inst.stop_server = AsyncMock()
  1161. manager._instances[1] = inst
  1162. db_vp = self._make_db_vp(model="C12")
  1163. self._setup_sync_mocks(manager, [db_vp], tmp_path)
  1164. with patch.object(manager, "remove_instance", new_callable=AsyncMock) as mock_remove:
  1165. with patch("backend.app.services.virtual_printer.manager.VirtualPrinterInstance") as MockInst:
  1166. mock_new = MagicMock()
  1167. mock_new.start_server = AsyncMock()
  1168. MockInst.return_value = mock_new
  1169. await manager.sync_from_db()
  1170. mock_remove.assert_called_once_with(1)
  1171. @pytest.mark.asyncio
  1172. async def test_sync_from_db_does_not_restart_on_tailscale_toggle(self, manager, tmp_path):
  1173. """Flipping tailscale_disabled is purely informational — must NOT trigger a restart.
  1174. Cert provisioning was removed; the toggle only governs whether the VP card surfaces
  1175. the host's Tailscale IP/FQDN to the user. No service needs to reload, so changing
  1176. it through sync_from_db should leave any running instance untouched.
  1177. """
  1178. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  1179. inst = VirtualPrinterInstance(
  1180. vp_id=1,
  1181. name="TestVP",
  1182. mode="immediate",
  1183. model="C11",
  1184. access_code="12345678",
  1185. serial_suffix="391800001",
  1186. tailscale_disabled=False,
  1187. base_dir=tmp_path,
  1188. )
  1189. inst.stop_server = AsyncMock()
  1190. manager._instances[1] = inst
  1191. db_vp = self._make_db_vp(tailscale_disabled=True)
  1192. self._setup_sync_mocks(manager, [db_vp], tmp_path)
  1193. with patch.object(manager, "remove_instance", new_callable=AsyncMock) as mock_remove:
  1194. await manager.sync_from_db()
  1195. mock_remove.assert_not_called()
  1196. class TestFTPSession:
  1197. """Tests for FTP session handling."""
  1198. @pytest.fixture
  1199. def mock_reader(self):
  1200. """Create a mock StreamReader."""
  1201. reader = AsyncMock()
  1202. return reader
  1203. @pytest.fixture
  1204. def mock_writer(self):
  1205. """Create a mock StreamWriter."""
  1206. writer = MagicMock()
  1207. writer.get_extra_info = MagicMock(return_value=("192.168.1.100", 12345))
  1208. writer.write = MagicMock()
  1209. writer.drain = AsyncMock()
  1210. writer.close = MagicMock()
  1211. writer.wait_closed = AsyncMock()
  1212. writer.is_closing = MagicMock(return_value=False)
  1213. return writer
  1214. @pytest.fixture
  1215. def ssl_context(self):
  1216. """Create a mock SSL context."""
  1217. return MagicMock()
  1218. @pytest.fixture
  1219. def session(self, mock_reader, mock_writer, ssl_context, tmp_path):
  1220. """Create an FTPSession instance."""
  1221. from backend.app.services.virtual_printer.ftp_server import FTPSession
  1222. return FTPSession(
  1223. reader=mock_reader,
  1224. writer=mock_writer,
  1225. upload_dir=tmp_path,
  1226. access_code="12345678",
  1227. ssl_context=ssl_context,
  1228. on_file_received=None,
  1229. )
  1230. # ========================================================================
  1231. # Tests for authentication
  1232. # ========================================================================
  1233. @pytest.mark.asyncio
  1234. async def test_user_command_accepts_bblp(self, session):
  1235. """Verify USER command accepts bblp user."""
  1236. await session.cmd_USER("bblp")
  1237. assert session.username == "bblp"
  1238. @pytest.mark.asyncio
  1239. async def test_pass_command_authenticates(self, session):
  1240. """Verify PASS command authenticates with correct code."""
  1241. session.username = "bblp"
  1242. await session.cmd_PASS("12345678")
  1243. assert session.authenticated is True
  1244. @pytest.mark.asyncio
  1245. async def test_pass_command_rejects_wrong_code(self, session):
  1246. """Verify PASS command rejects wrong access code."""
  1247. session.username = "bblp"
  1248. await session.cmd_PASS("wrongcode")
  1249. assert session.authenticated is False
  1250. # ========================================================================
  1251. # Tests for FTP commands
  1252. # ========================================================================
  1253. @pytest.mark.asyncio
  1254. async def test_syst_command(self, session):
  1255. """Verify SYST returns UNIX type."""
  1256. await session.cmd_SYST("")
  1257. session.writer.write.assert_called()
  1258. call_args = session.writer.write.call_args[0][0].decode()
  1259. assert "215" in call_args
  1260. assert "UNIX" in call_args
  1261. @pytest.mark.asyncio
  1262. async def test_pwd_command_requires_auth(self, session):
  1263. """Verify PWD requires authentication."""
  1264. session.authenticated = False
  1265. await session.cmd_PWD("")
  1266. call_args = session.writer.write.call_args[0][0].decode()
  1267. assert "530" in call_args
  1268. @pytest.mark.asyncio
  1269. async def test_pwd_command_when_authenticated(self, session):
  1270. """Verify PWD returns root directory when authenticated."""
  1271. session.authenticated = True
  1272. await session.cmd_PWD("")
  1273. call_args = session.writer.write.call_args[0][0].decode()
  1274. assert "257" in call_args
  1275. @pytest.mark.asyncio
  1276. async def test_type_command_sets_binary(self, session):
  1277. """Verify TYPE I sets binary mode."""
  1278. session.authenticated = True
  1279. await session.cmd_TYPE("I")
  1280. assert session.transfer_type == "I"
  1281. @pytest.mark.asyncio
  1282. async def test_pbsz_command(self, session):
  1283. """Verify PBSZ returns success."""
  1284. await session.cmd_PBSZ("0")
  1285. call_args = session.writer.write.call_args[0][0].decode()
  1286. assert "200" in call_args
  1287. @pytest.mark.asyncio
  1288. async def test_prot_command_accepts_p(self, session):
  1289. """Verify PROT P is accepted."""
  1290. await session.cmd_PROT("P")
  1291. call_args = session.writer.write.call_args[0][0].decode()
  1292. assert "200" in call_args
  1293. @pytest.mark.asyncio
  1294. async def test_quit_command(self, session):
  1295. """Verify QUIT sends goodbye and raises CancelledError."""
  1296. with pytest.raises(asyncio.CancelledError):
  1297. await session.cmd_QUIT("")
  1298. class TestSSDPServer:
  1299. """Tests for Virtual Printer SSDP server."""
  1300. @pytest.fixture
  1301. def ssdp_server(self):
  1302. """Create a VirtualPrinterSSDPServer instance."""
  1303. from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
  1304. return VirtualPrinterSSDPServer(
  1305. serial="TEST123",
  1306. name="TestPrinter",
  1307. model="BL-P001",
  1308. )
  1309. # ========================================================================
  1310. # Tests for SSDP response
  1311. # ========================================================================
  1312. def test_build_notify_message(self, ssdp_server):
  1313. """Verify NOTIFY packet contains required headers."""
  1314. # Set a known IP for testing
  1315. ssdp_server._local_ip = "192.168.1.100"
  1316. message = ssdp_server._build_notify_message()
  1317. assert b"NOTIFY" in message
  1318. assert b"DevName.bambu.com: TestPrinter" in message
  1319. assert b"USN: TEST123" in message
  1320. def test_build_response_message(self, ssdp_server):
  1321. """Verify response packet contains required headers."""
  1322. # Set a known IP for testing
  1323. ssdp_server._local_ip = "192.168.1.100"
  1324. message = ssdp_server._build_response_message()
  1325. assert b"HTTP/1.1 200 OK" in message
  1326. assert b"DevName.bambu.com: TestPrinter" in message
  1327. assert b"USN: TEST123" in message
  1328. def test_ssdp_server_uses_correct_model(self, ssdp_server):
  1329. """Verify SSDP server uses the provided model."""
  1330. ssdp_server._local_ip = "192.168.1.100"
  1331. message = ssdp_server._build_notify_message()
  1332. assert b"DevModel.bambu.com: BL-P001" in message
  1333. # ========================================================================
  1334. # Tests for advertise_ip parameter
  1335. # ========================================================================
  1336. def test_advertise_ip_sets_local_ip(self):
  1337. """Verify advertise_ip overrides auto-detection."""
  1338. from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
  1339. server = VirtualPrinterSSDPServer(
  1340. serial="TEST123",
  1341. name="TestPrinter",
  1342. model="BL-P001",
  1343. advertise_ip="10.0.0.50",
  1344. )
  1345. assert server._local_ip == "10.0.0.50"
  1346. def test_advertise_ip_empty_string_uses_auto_detect(self):
  1347. """Verify empty advertise_ip falls back to auto-detection."""
  1348. from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
  1349. server = VirtualPrinterSSDPServer(
  1350. serial="TEST123",
  1351. name="TestPrinter",
  1352. model="BL-P001",
  1353. advertise_ip="",
  1354. )
  1355. assert server._local_ip is None
  1356. def test_advertise_ip_in_notify_message(self):
  1357. """Verify NOTIFY message uses the advertise_ip."""
  1358. from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
  1359. server = VirtualPrinterSSDPServer(
  1360. serial="TEST123",
  1361. name="TestPrinter",
  1362. model="BL-P001",
  1363. advertise_ip="10.0.0.50",
  1364. )
  1365. message = server._build_notify_message()
  1366. assert b"Location: 10.0.0.50" in message
  1367. def test_advertise_ip_in_response_message(self):
  1368. """Verify M-SEARCH response uses the advertise_ip."""
  1369. from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
  1370. server = VirtualPrinterSSDPServer(
  1371. serial="TEST123",
  1372. name="TestPrinter",
  1373. model="BL-P001",
  1374. advertise_ip="10.0.0.50",
  1375. )
  1376. message = server._build_response_message()
  1377. assert b"Location: 10.0.0.50" in message
  1378. def test_default_no_advertise_ip(self):
  1379. """Verify default constructor has None local_ip (auto-detect)."""
  1380. from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
  1381. server = VirtualPrinterSSDPServer()
  1382. assert server._local_ip is None
  1383. class TestCertificateService:
  1384. """Tests for TLS certificate generation."""
  1385. @pytest.fixture
  1386. def cert_service(self, tmp_path):
  1387. """Create a CertificateService instance."""
  1388. from backend.app.services.virtual_printer.certificate import CertificateService
  1389. return CertificateService(cert_dir=tmp_path, serial="TEST123")
  1390. def test_generate_certificates(self, cert_service, tmp_path):
  1391. """Verify certificates are generated correctly."""
  1392. cert_path, key_path = cert_service.generate_certificates()
  1393. assert cert_path.exists()
  1394. assert key_path.exists()
  1395. # Verify certificate content
  1396. cert_content = cert_path.read_text()
  1397. assert "BEGIN CERTIFICATE" in cert_content
  1398. key_content = key_path.read_text()
  1399. assert "BEGIN" in key_content and "KEY" in key_content
  1400. def test_certificates_reused_if_exist(self, cert_service):
  1401. """Verify existing certificates are reused."""
  1402. # First generation
  1403. cert_path1, key_path1 = cert_service.generate_certificates()
  1404. mtime1 = cert_path1.stat().st_mtime
  1405. # Second call should reuse (via ensure_certificates)
  1406. cert_path2, key_path2 = cert_service.ensure_certificates()
  1407. mtime2 = cert_path2.stat().st_mtime
  1408. assert mtime1 == mtime2 # File wasn't regenerated
  1409. def test_delete_certificates(self, cert_service):
  1410. """Verify certificates can be deleted."""
  1411. cert_service.generate_certificates()
  1412. assert cert_service.cert_path.exists()
  1413. assert cert_service.key_path.exists()
  1414. cert_service.delete_certificates()
  1415. assert not cert_service.cert_path.exists()
  1416. assert not cert_service.key_path.exists()
  1417. def test_ensure_creates_if_not_exist(self, cert_service):
  1418. """Verify ensure_certificates generates if not existing."""
  1419. assert not cert_service.cert_path.exists()
  1420. cert_path, key_path = cert_service.ensure_certificates()
  1421. assert cert_path.exists()
  1422. assert key_path.exists()
  1423. class TestBindServer:
  1424. """Tests for BindServer (port 3002 bind/detect protocol)."""
  1425. @pytest.fixture
  1426. def bind_server(self):
  1427. """Create a BindServer instance."""
  1428. from backend.app.services.virtual_printer.bind_server import BindServer
  1429. return BindServer(
  1430. serial="09400A391800001",
  1431. model="O1D",
  1432. name="Bambuddy",
  1433. )
  1434. def test_build_frame(self, bind_server):
  1435. """Verify frame building produces correct format."""
  1436. payload = {"login": {"command": "detect"}}
  1437. frame = bind_server._build_frame(payload)
  1438. # Header: 0xA5A5
  1439. assert frame[:2] == b"\xa5\xa5"
  1440. # Trailer: 0xA7A7
  1441. assert frame[-2:] == b"\xa7\xa7"
  1442. # Length field is total message size (LE uint16)
  1443. import struct
  1444. total_len = struct.unpack_from("<H", frame, 2)[0]
  1445. assert total_len == len(frame)
  1446. # JSON payload is between header and trailer
  1447. import json
  1448. json_bytes = frame[4:-2]
  1449. parsed = json.loads(json_bytes)
  1450. assert parsed == payload
  1451. def test_parse_frame_valid(self, bind_server):
  1452. """Verify valid frame parsing extracts JSON correctly."""
  1453. import json
  1454. import struct
  1455. payload = {"login": {"command": "detect", "sequence_id": "20000"}}
  1456. json_bytes = json.dumps(payload, separators=(",", ":")).encode()
  1457. total_len = 4 + len(json_bytes) + 2
  1458. frame = b"\xa5\xa5" + struct.pack("<H", total_len) + json_bytes + b"\xa7\xa7"
  1459. result = bind_server._parse_frame(frame)
  1460. assert result is not None
  1461. assert result["login"]["command"] == "detect"
  1462. assert result["login"]["sequence_id"] == "20000"
  1463. def test_parse_frame_invalid_header(self, bind_server):
  1464. """Verify invalid header returns None."""
  1465. result = bind_server._parse_frame(b"\xbb\xbb\x06\x00{}\xa7\xa7")
  1466. assert result is None
  1467. def test_parse_frame_invalid_trailer(self, bind_server):
  1468. """Verify invalid trailer returns None."""
  1469. result = bind_server._parse_frame(b"\xa5\xa5\x06\x00{}\xbb\xbb")
  1470. assert result is None
  1471. def test_parse_frame_too_short(self, bind_server):
  1472. """Verify short data returns None."""
  1473. result = bind_server._parse_frame(b"\xa5\xa5\x00")
  1474. assert result is None
  1475. def test_parse_frame_invalid_json(self, bind_server):
  1476. """Verify invalid JSON returns None."""
  1477. import struct
  1478. bad_json = b"not json"
  1479. total_len = 4 + len(bad_json) + 2
  1480. frame = b"\xa5\xa5" + struct.pack("<H", total_len) + bad_json + b"\xa7\xa7"
  1481. result = bind_server._parse_frame(frame)
  1482. assert result is None
  1483. def test_build_frame_roundtrip(self, bind_server):
  1484. """Verify build_frame output can be parsed back."""
  1485. payload = {
  1486. "login": {
  1487. "bind": "free",
  1488. "command": "detect",
  1489. "connect": "lan",
  1490. "dev_cap": 1,
  1491. "id": "09400A391800001",
  1492. "model": "O1D",
  1493. "name": "Bambuddy",
  1494. "sequence_id": 3021,
  1495. "version": "01.00.00.00",
  1496. }
  1497. }
  1498. frame = bind_server._build_frame(payload)
  1499. parsed = bind_server._parse_frame(frame)
  1500. assert parsed is not None
  1501. assert parsed["login"]["id"] == "09400A391800001"
  1502. assert parsed["login"]["model"] == "O1D"
  1503. assert parsed["login"]["name"] == "Bambuddy"
  1504. assert parsed["login"]["bind"] == "free"
  1505. def test_bind_server_stores_config(self, bind_server):
  1506. """Verify bind server stores serial, model, name."""
  1507. assert bind_server.serial == "09400A391800001"
  1508. assert bind_server.model == "O1D"
  1509. assert bind_server.name == "Bambuddy"
  1510. assert bind_server.version == "01.00.00.00"
  1511. def test_bind_server_custom_version(self):
  1512. """Verify custom firmware version is stored."""
  1513. from backend.app.services.virtual_printer.bind_server import BindServer
  1514. server = BindServer(
  1515. serial="TEST123",
  1516. model="C13",
  1517. name="Test",
  1518. version="02.03.04.05",
  1519. )
  1520. assert server.version == "02.03.04.05"
  1521. def test_bind_ports_constant(self):
  1522. """Verify BIND_PORTS includes both 3000 and 3002 for slicer compatibility."""
  1523. from backend.app.services.virtual_printer.bind_server import BIND_PORTS
  1524. assert 3000 in BIND_PORTS
  1525. assert 3002 in BIND_PORTS
  1526. def test_bind_server_initializes_empty_servers_list(self, bind_server):
  1527. """Verify bind server starts with empty servers list."""
  1528. assert bind_server._servers == []
  1529. assert bind_server._running is False
  1530. class TestSlicerProxyManager:
  1531. """Tests for SlicerProxyManager (proxy mode)."""
  1532. @pytest.fixture
  1533. def proxy_manager(self, tmp_path):
  1534. """Create a SlicerProxyManager instance."""
  1535. from backend.app.services.virtual_printer.tcp_proxy import SlicerProxyManager
  1536. # Create dummy cert files
  1537. cert_path = tmp_path / "cert.pem"
  1538. key_path = tmp_path / "key.pem"
  1539. cert_path.write_text("-----BEGIN CERTIFICATE-----\ntest\n-----END CERTIFICATE-----")
  1540. # Split string to avoid pre-commit hook false positive on test data
  1541. key_path.write_text("-----BEGIN " + "PRIVATE KEY-----\ntest\n-----END " + "PRIVATE KEY-----")
  1542. return SlicerProxyManager(
  1543. target_host="192.168.1.100",
  1544. cert_path=cert_path,
  1545. key_path=key_path,
  1546. )
  1547. def test_proxy_manager_initializes_ports(self, proxy_manager):
  1548. """Verify proxy manager has correct port constants."""
  1549. # FTP proxy uses privileged port 990 to match what Bambu Studio expects
  1550. assert proxy_manager.LOCAL_FTP_PORT == 990
  1551. assert proxy_manager.LOCAL_MQTT_PORT == 8883
  1552. assert proxy_manager.PRINTER_FTP_PORT == 990
  1553. assert proxy_manager.PRINTER_MQTT_PORT == 8883
  1554. assert proxy_manager.PRINTER_FILE_TRANSFER_PORT == 6000
  1555. assert proxy_manager.PRINTER_RTSP_PORT == 322
  1556. # Auxiliary ports: undocumented proprietary ports for A1/P1S etc.
  1557. assert proxy_manager.PRINTER_AUX_PORTS == [2024, 2025, 2026]
  1558. # Bind ports: both 3000 and 3002 for slicer compatibility
  1559. assert proxy_manager.PRINTER_BIND_PORTS == [3000, 3002]
  1560. # FTP data port range for transparent EPSV proxying
  1561. assert proxy_manager.FTP_DATA_PORT_MIN == 50000
  1562. assert proxy_manager.FTP_DATA_PORT_MAX == 50100
  1563. def test_proxy_manager_stores_target_host(self, proxy_manager):
  1564. """Verify proxy manager stores target host."""
  1565. assert proxy_manager.target_host == "192.168.1.100"
  1566. def test_get_status_before_start(self, proxy_manager):
  1567. """Verify get_status returns zeros before start."""
  1568. status = proxy_manager.get_status()
  1569. assert status["running"] is False
  1570. assert status["ftp_connections"] == 0
  1571. assert status["mqtt_connections"] == 0
  1572. @pytest.mark.asyncio
  1573. async def test_proxy_start_creates_transparent_proxies(self, tmp_path):
  1574. """Verify start() uses TCPProxy for FTP/FileTransfer/RTSP and TLSProxy only for MQTT.
  1575. The transparent proxy architecture preserves end-to-end TLS between
  1576. slicer and printer for all protocols except MQTT, which must be
  1577. TLS-terminated to rewrite the printer's IP in MQTT payloads.
  1578. """
  1579. from unittest.mock import AsyncMock, patch
  1580. from backend.app.services.virtual_printer.tcp_proxy import (
  1581. SlicerProxyManager,
  1582. TCPProxy,
  1583. TLSProxy,
  1584. )
  1585. cert_path = tmp_path / "cert.pem"
  1586. key_path = tmp_path / "key.pem"
  1587. cert_path.write_text("-----BEGIN CERTIFICATE-----\ntest\n-----END CERTIFICATE-----")
  1588. key_path.write_text("-----BEGIN " + "PRIVATE KEY-----\ntest\n-----END " + "PRIVATE KEY-----")
  1589. mgr = SlicerProxyManager(
  1590. target_host="192.168.1.100",
  1591. cert_path=cert_path,
  1592. key_path=key_path,
  1593. bind_address="10.0.0.1",
  1594. )
  1595. # Mock asyncio.create_task and asyncio.gather to prevent actual server start
  1596. with (
  1597. patch("asyncio.create_task") as mock_create_task,
  1598. patch("asyncio.gather", new_callable=AsyncMock),
  1599. patch.object(SlicerProxyManager, "_log_activity"),
  1600. ):
  1601. mock_create_task.return_value = MagicMock()
  1602. # start() will create proxies then try to gather tasks — we just
  1603. # need to verify the proxy types after creation.
  1604. # Trigger start but let gather return immediately.
  1605. await mgr.start()
  1606. # FTP, FileTransfer, RTSP should be TCPProxy (transparent)
  1607. assert isinstance(mgr._ftp_proxy, TCPProxy), "FTP should be TCPProxy (transparent)"
  1608. assert isinstance(mgr._file_transfer_proxy, TCPProxy), "FileTransfer should be TCPProxy"
  1609. assert isinstance(mgr._rtsp_proxy, TCPProxy), "RTSP should be TCPProxy"
  1610. # MQTT should be TLSProxy (TLS-terminated for IP rewriting)
  1611. assert isinstance(mgr._mqtt_proxy, TLSProxy), "MQTT should be TLSProxy (TLS-terminated)"
  1612. # Auxiliary ports (2024-2026) should be TCPProxy (transparent)
  1613. assert len(mgr._aux_proxies) == 3, "Should have 3 aux port proxies"
  1614. for ap in mgr._aux_proxies:
  1615. assert isinstance(ap, TCPProxy), "Aux proxies should be TCPProxy"
  1616. assert mgr._aux_proxies[0].listen_port == 2024
  1617. assert mgr._aux_proxies[0].target_port == 2024
  1618. assert mgr._aux_proxies[2].listen_port == 2026
  1619. # FTP data ports should be pre-created as TCPProxy instances
  1620. assert len(mgr._ftp_data_proxies) == 101 # 50000-50100 inclusive
  1621. for dp in mgr._ftp_data_proxies:
  1622. assert isinstance(dp, TCPProxy), "FTP data proxies should be TCPProxy"
  1623. # Verify FTP data proxies target the same port on the printer
  1624. first_dp = mgr._ftp_data_proxies[0]
  1625. assert first_dp.listen_port == 50000
  1626. assert first_dp.target_port == 50000
  1627. assert first_dp.target_host == "192.168.1.100"
  1628. last_dp = mgr._ftp_data_proxies[-1]
  1629. assert last_dp.listen_port == 50100
  1630. assert last_dp.target_port == 50100
  1631. def test_proxy_manager_mqtt_has_ip_rewriting(self, tmp_path):
  1632. """Verify MQTT proxy is configured with IP rewriting when bind_address is set."""
  1633. from backend.app.services.virtual_printer.tcp_proxy import SlicerProxyManager
  1634. cert_path = tmp_path / "cert.pem"
  1635. key_path = tmp_path / "key.pem"
  1636. cert_path.write_text("-----BEGIN CERTIFICATE-----\ntest\n-----END CERTIFICATE-----")
  1637. key_path.write_text("-----BEGIN " + "PRIVATE KEY-----\ntest\n-----END " + "PRIVATE KEY-----")
  1638. mgr = SlicerProxyManager(
  1639. target_host="192.168.1.100",
  1640. cert_path=cert_path,
  1641. key_path=key_path,
  1642. bind_address="10.0.0.1",
  1643. )
  1644. # Before start, proxies are None — verify constructor stores rewrite config
  1645. assert mgr.bind_address == "10.0.0.1"
  1646. assert mgr.target_host == "192.168.1.100"
  1647. class TestSSDPProxy:
  1648. """Tests for SSDPProxy (cross-network SSDP relay)."""
  1649. @pytest.fixture
  1650. def ssdp_proxy(self):
  1651. """Create an SSDPProxy instance."""
  1652. from backend.app.services.virtual_printer.ssdp_server import SSDPProxy
  1653. return SSDPProxy(
  1654. local_interface_ip="192.168.1.100",
  1655. remote_interface_ip="10.0.0.100",
  1656. target_printer_ip="192.168.1.50",
  1657. )
  1658. def test_ssdp_proxy_stores_interface_ips(self, ssdp_proxy):
  1659. """Verify SSDPProxy stores interface IPs correctly."""
  1660. assert ssdp_proxy.local_interface_ip == "192.168.1.100"
  1661. assert ssdp_proxy.remote_interface_ip == "10.0.0.100"
  1662. assert ssdp_proxy.target_printer_ip == "192.168.1.50"
  1663. def test_rewrite_ssdp_location(self, ssdp_proxy):
  1664. """Verify SSDP Location header is rewritten to remote interface IP."""
  1665. original_packet = b"NOTIFY * HTTP/1.1\r\nLocation: 192.168.1.50\r\nDevName.bambu.com: TestPrinter\r\n\r\n"
  1666. rewritten = ssdp_proxy._rewrite_ssdp(original_packet)
  1667. # Location should be changed to remote interface IP
  1668. assert b"Location: 10.0.0.100" in rewritten
  1669. assert b"Location: 192.168.1.50" not in rewritten
  1670. # Other headers should be preserved
  1671. assert b"DevName.bambu.com: TestPrinter" in rewritten
  1672. def test_rewrite_ssdp_location_case_insensitive(self, ssdp_proxy):
  1673. """Verify SSDP Location rewrite is case insensitive."""
  1674. original_packet = b"NOTIFY * HTTP/1.1\r\nlocation: 192.168.1.50\r\n\r\n"
  1675. rewritten = ssdp_proxy._rewrite_ssdp(original_packet)
  1676. assert b"10.0.0.100" in rewritten
  1677. def test_rewrite_ssdp_location_no_match(self, ssdp_proxy):
  1678. """Verify packet without Location header is returned unchanged."""
  1679. original_packet = b"NOTIFY * HTTP/1.1\r\nDevName.bambu.com: Test\r\n\r\n"
  1680. rewritten = ssdp_proxy._rewrite_ssdp(original_packet)
  1681. # No Location header, but _rewrite_ssdp logs a warning and returns as-is
  1682. assert b"DevName.bambu.com: Test" in rewritten
  1683. def test_parse_ssdp_message(self, ssdp_proxy):
  1684. """Verify SSDP message parsing extracts headers."""
  1685. packet = (
  1686. b"NOTIFY * HTTP/1.1\r\n"
  1687. b"Location: 192.168.1.50\r\n"
  1688. b"DevName.bambu.com: TestPrinter\r\n"
  1689. b"DevModel.bambu.com: BL-P001\r\n"
  1690. b"\r\n"
  1691. )
  1692. headers = ssdp_proxy._parse_ssdp_message(packet)
  1693. assert headers["location"] == "192.168.1.50"
  1694. assert headers["devname.bambu.com"] == "TestPrinter"
  1695. assert headers["devmodel.bambu.com"] == "BL-P001"
  1696. class TestVirtualPrinterManagerDirectories:
  1697. """Tests for VirtualPrinterManager directory management."""
  1698. def test_ensure_base_directories_creates_subdirs(self, tmp_path):
  1699. """Verify _ensure_base_directories creates required base directories."""
  1700. from backend.app.services.virtual_printer.manager import VirtualPrinterManager
  1701. manager = VirtualPrinterManager()
  1702. manager._base_dir = tmp_path / "virtual_printer"
  1703. manager._ensure_base_directories()
  1704. assert (tmp_path / "virtual_printer").exists()
  1705. assert (tmp_path / "virtual_printer" / "uploads").exists()
  1706. assert (tmp_path / "virtual_printer" / "certs").exists()
  1707. def test_ensure_base_directories_handles_permission_error(self, tmp_path, caplog):
  1708. """Verify _ensure_base_directories logs error on permission failure."""
  1709. import logging
  1710. from backend.app.services.virtual_printer.manager import VirtualPrinterManager
  1711. manager = VirtualPrinterManager()
  1712. vp_dir = tmp_path / "virtual_printer"
  1713. manager._base_dir = vp_dir
  1714. original_mkdir = type(vp_dir).mkdir
  1715. def mock_mkdir(self, *args, **kwargs):
  1716. if "virtual_printer" in str(self):
  1717. raise PermissionError("Permission denied")
  1718. return original_mkdir(self, *args, **kwargs)
  1719. with caplog.at_level(logging.ERROR), patch.object(type(vp_dir), "mkdir", mock_mkdir):
  1720. manager._ensure_base_directories()
  1721. assert "Permission denied" in caplog.text
  1722. def test_instance_creates_per_vp_directories(self, tmp_path):
  1723. """Verify VirtualPrinterInstance creates per-VP upload and cert dirs."""
  1724. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  1725. VirtualPrinterInstance(
  1726. vp_id=42,
  1727. name="Test",
  1728. mode="immediate",
  1729. model="C11",
  1730. access_code="12345678",
  1731. serial_suffix="391800042",
  1732. base_dir=tmp_path,
  1733. )
  1734. assert (tmp_path / "uploads" / "42").exists()
  1735. assert (tmp_path / "uploads" / "42" / "cache").exists()
  1736. assert (tmp_path / "certs" / "42").exists()
  1737. class TestVirtualPrinterInstanceProxyMode:
  1738. """Tests for VirtualPrinterInstance proxy mode."""
  1739. @pytest.fixture
  1740. def proxy_instance(self, tmp_path):
  1741. """Create a proxy-mode VirtualPrinterInstance."""
  1742. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  1743. return VirtualPrinterInstance(
  1744. vp_id=10,
  1745. name="ProxyTest",
  1746. mode="proxy",
  1747. model="C11",
  1748. access_code="",
  1749. serial_suffix="391800010",
  1750. target_printer_ip="192.168.1.100",
  1751. target_printer_serial="01P00A000000001",
  1752. base_dir=tmp_path,
  1753. )
  1754. def test_proxy_instance_properties(self, proxy_instance):
  1755. """Verify proxy instance stores config correctly."""
  1756. assert proxy_instance.is_proxy is True
  1757. assert proxy_instance.mode == "proxy"
  1758. assert proxy_instance.target_printer_ip == "192.168.1.100"
  1759. assert proxy_instance.target_printer_serial == "01P00A000000001"
  1760. def test_proxy_instance_does_not_require_access_code(self, proxy_instance):
  1761. """Verify proxy mode can have empty access code."""
  1762. assert proxy_instance.access_code == ""
  1763. def test_get_status_proxy_includes_proxy_fields(self, proxy_instance):
  1764. """Verify get_status includes proxy fields when proxy is active."""
  1765. mock_proxy = MagicMock()
  1766. mock_proxy.get_status.return_value = {
  1767. "running": True,
  1768. "ftp_port": 990,
  1769. "mqtt_port": 8883,
  1770. "ftp_connections": 1,
  1771. "mqtt_connections": 2,
  1772. "target_host": "192.168.1.100",
  1773. }
  1774. proxy_instance._proxy = mock_proxy
  1775. status = proxy_instance.get_status()
  1776. assert "proxy" in status
  1777. assert status["proxy"]["ftp_port"] == 990
  1778. assert status["proxy"]["mqtt_connections"] == 2
  1779. def test_proxy_instance_stores_remote_interface(self, tmp_path):
  1780. """Verify proxy instance stores remote_interface_ip."""
  1781. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  1782. inst = VirtualPrinterInstance(
  1783. vp_id=11,
  1784. name="Proxy2",
  1785. mode="proxy",
  1786. model="C11",
  1787. access_code="",
  1788. serial_suffix="391800011",
  1789. target_printer_ip="192.168.1.100",
  1790. remote_interface_ip="10.0.0.50",
  1791. base_dir=tmp_path,
  1792. )
  1793. assert inst.remote_interface_ip == "10.0.0.50"
  1794. class TestVirtualPrinterInstanceIPOverride:
  1795. """Tests for remote_interface_ip and bind_ip on VirtualPrinterInstance."""
  1796. @pytest.fixture
  1797. def instance_with_remote_ip(self, tmp_path):
  1798. """Create an instance with remote_interface_ip set."""
  1799. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  1800. return VirtualPrinterInstance(
  1801. vp_id=20,
  1802. name="IPTest",
  1803. mode="immediate",
  1804. model="BL-P001",
  1805. access_code="12345678",
  1806. serial_suffix="391800020",
  1807. bind_ip="192.168.1.50",
  1808. remote_interface_ip="10.0.0.50",
  1809. base_dir=tmp_path,
  1810. )
  1811. def test_instance_stores_bind_ip(self, instance_with_remote_ip):
  1812. """Verify bind_ip is stored."""
  1813. assert instance_with_remote_ip.bind_ip == "192.168.1.50"
  1814. def test_instance_stores_remote_interface_ip(self, instance_with_remote_ip):
  1815. """Verify remote_interface_ip is stored."""
  1816. assert instance_with_remote_ip.remote_interface_ip == "10.0.0.50"
  1817. def test_generate_certificates_includes_remote_and_bind_ip(self, instance_with_remote_ip):
  1818. """Verify generate_certificates passes remote_interface_ip and bind_ip as SANs."""
  1819. with (
  1820. patch.object(instance_with_remote_ip._cert_service, "delete_printer_certificate"),
  1821. patch.object(
  1822. instance_with_remote_ip._cert_service,
  1823. "generate_certificates",
  1824. return_value=(Path("/tmp/cert.pem"), Path("/tmp/key.pem")), # nosec B108
  1825. ) as mock_gen,
  1826. ):
  1827. instance_with_remote_ip.generate_certificates()
  1828. mock_gen.assert_called_once_with(additional_ips=["10.0.0.50", "192.168.1.50"])
  1829. def test_generate_certificates_no_remote_ip(self, tmp_path):
  1830. """Verify generate_certificates passes only bind_ip when no remote_interface_ip."""
  1831. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  1832. inst = VirtualPrinterInstance(
  1833. vp_id=21,
  1834. name="NoRemote",
  1835. mode="immediate",
  1836. model="BL-P001",
  1837. access_code="12345678",
  1838. serial_suffix="391800021",
  1839. bind_ip="192.168.1.50",
  1840. base_dir=tmp_path,
  1841. )
  1842. with (
  1843. patch.object(inst._cert_service, "delete_printer_certificate"),
  1844. patch.object(
  1845. inst._cert_service,
  1846. "generate_certificates",
  1847. return_value=(Path("/tmp/cert.pem"), Path("/tmp/key.pem")), # nosec B108
  1848. ) as mock_gen,
  1849. ):
  1850. inst.generate_certificates()
  1851. mock_gen.assert_called_once_with(additional_ips=["192.168.1.50"])
  1852. def test_generate_certificates_no_ips(self, tmp_path):
  1853. """Verify generate_certificates passes None when no IPs configured."""
  1854. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  1855. inst = VirtualPrinterInstance(
  1856. vp_id=22,
  1857. name="NoIPs",
  1858. mode="immediate",
  1859. model="BL-P001",
  1860. access_code="12345678",
  1861. serial_suffix="391800022",
  1862. base_dir=tmp_path,
  1863. )
  1864. with (
  1865. patch.object(inst._cert_service, "delete_printer_certificate"),
  1866. patch.object(
  1867. inst._cert_service,
  1868. "generate_certificates",
  1869. return_value=(Path("/tmp/cert.pem"), Path("/tmp/key.pem")), # nosec B108
  1870. ) as mock_gen,
  1871. ):
  1872. inst.generate_certificates()
  1873. mock_gen.assert_called_once_with(additional_ips=None)
  1874. class TestBindServer:
  1875. """Tests for the BindServer (port 3002 bind/detect protocol)."""
  1876. @pytest.fixture
  1877. def bind_server(self):
  1878. """Create a BindServer instance."""
  1879. from backend.app.services.virtual_printer.bind_server import BindServer
  1880. return BindServer(
  1881. serial="01S00C000000001",
  1882. model="BL-P001",
  1883. name="Bambuddy",
  1884. )
  1885. def test_build_frame(self, bind_server):
  1886. """Verify frame format: 0xA5A5 + len(u16le) + JSON + 0xA7A7."""
  1887. payload = {"login": {"command": "detect"}}
  1888. frame = bind_server._build_frame(payload)
  1889. assert frame[:2] == b"\xa5\xa5"
  1890. assert frame[-2:] == b"\xa7\xa7"
  1891. # Length field is total message size
  1892. import struct
  1893. total_len = struct.unpack_from("<H", frame, 2)[0]
  1894. assert total_len == len(frame)
  1895. # JSON payload is between header and trailer
  1896. import json
  1897. json_bytes = frame[4:-2]
  1898. parsed = json.loads(json_bytes)
  1899. assert parsed == payload
  1900. def test_parse_frame_valid(self, bind_server):
  1901. """Verify valid frame parsing."""
  1902. frame = bind_server._build_frame({"login": {"command": "detect", "sequence_id": "20000"}})
  1903. result = bind_server._parse_frame(frame)
  1904. assert result is not None
  1905. assert result["login"]["command"] == "detect"
  1906. assert result["login"]["sequence_id"] == "20000"
  1907. def test_parse_frame_invalid_header(self, bind_server):
  1908. """Verify invalid header returns None."""
  1909. frame = b"\xb5\xb5\x10\x00" + b'{"login":{}}' + b"\xa7\xa7"
  1910. assert bind_server._parse_frame(frame) is None
  1911. def test_parse_frame_invalid_trailer(self, bind_server):
  1912. """Verify invalid trailer returns None."""
  1913. frame = b"\xa5\xa5\x10\x00" + b'{"login":{}}' + b"\xb7\xb7"
  1914. assert bind_server._parse_frame(frame) is None
  1915. def test_parse_frame_too_short(self, bind_server):
  1916. """Verify short data returns None."""
  1917. assert bind_server._parse_frame(b"\xa5\xa5\x00") is None
  1918. assert bind_server._parse_frame(b"") is None
  1919. def test_parse_frame_invalid_json(self, bind_server):
  1920. """Verify invalid JSON returns None."""
  1921. import struct
  1922. bad_json = b"not json"
  1923. total_len = 4 + len(bad_json) + 2
  1924. frame = b"\xa5\xa5" + struct.pack("<H", total_len) + bad_json + b"\xa7\xa7"
  1925. assert bind_server._parse_frame(frame) is None
  1926. def test_build_frame_roundtrip(self, bind_server):
  1927. """Verify build then parse roundtrip."""
  1928. original = {"login": {"bind": "free", "command": "detect", "id": "01S00C000000001"}}
  1929. frame = bind_server._build_frame(original)
  1930. parsed = bind_server._parse_frame(frame)
  1931. assert parsed == original
  1932. def test_bind_server_stores_config(self, bind_server):
  1933. """Verify config is stored correctly."""
  1934. assert bind_server.serial == "01S00C000000001"
  1935. assert bind_server.model == "BL-P001"
  1936. assert bind_server.name == "Bambuddy"
  1937. assert bind_server.version == "01.00.00.00"
  1938. def test_bind_server_custom_version(self):
  1939. """Verify custom firmware version is stored."""
  1940. from backend.app.services.virtual_printer.bind_server import BindServer
  1941. server = BindServer(
  1942. serial="01S00C000000001",
  1943. model="BL-P001",
  1944. name="Bambuddy",
  1945. version="01.09.00.10",
  1946. )
  1947. assert server.version == "01.09.00.10"
  1948. def test_bind_ports_includes_both(self):
  1949. """Verify BIND_PORTS includes both 3000 and 3002 for slicer compatibility."""
  1950. from backend.app.services.virtual_printer.bind_server import BIND_PORTS
  1951. assert 3000 in BIND_PORTS
  1952. assert 3002 in BIND_PORTS
  1953. def test_bind_server_initializes_empty_servers_list(self, bind_server):
  1954. """Verify bind server starts with empty servers list."""
  1955. assert bind_server._servers == []
  1956. assert bind_server._running is False
  1957. @pytest.mark.asyncio
  1958. async def test_start_server_creates_bind_server(self, tmp_path):
  1959. """Verify start_server creates BindServer with correct params."""
  1960. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  1961. inst = VirtualPrinterInstance(
  1962. vp_id=99,
  1963. name="Bambuddy",
  1964. mode="immediate",
  1965. model="BL-P001",
  1966. access_code="12345678",
  1967. serial_suffix="391800099",
  1968. bind_ip="192.168.1.50",
  1969. base_dir=tmp_path,
  1970. )
  1971. with (
  1972. patch("backend.app.services.virtual_printer.manager.VirtualPrinterSSDPServer"),
  1973. patch("backend.app.services.virtual_printer.manager.VirtualPrinterFTPServer"),
  1974. patch("backend.app.services.virtual_printer.manager.SimpleMQTTServer"),
  1975. patch("backend.app.services.virtual_printer.manager.BindServer") as mock_bind_cls,
  1976. patch.object(inst._cert_service, "delete_printer_certificate"),
  1977. patch.object(
  1978. inst._cert_service,
  1979. "generate_certificates",
  1980. return_value=(Path("/tmp/cert.pem"), Path("/tmp/key.pem")), # nosec B108
  1981. ),
  1982. ):
  1983. await inst.start_server()
  1984. mock_bind_cls.assert_called_once_with(
  1985. serial=inst.serial,
  1986. model="BL-P001",
  1987. name="Bambuddy",
  1988. bind_address="192.168.1.50",
  1989. cert_path=Path("/tmp/cert.pem"), # nosec B108
  1990. key_path=Path("/tmp/key.pem"), # nosec B108
  1991. )
  1992. class TestResolveModelCodes:
  1993. """Tests for model code resolution (display name → SSDP code)."""
  1994. def test_display_name_to_model_code_maps_all_models(self):
  1995. """Verify reverse mapping covers all VIRTUAL_PRINTER_MODELS entries."""
  1996. from backend.app.services.virtual_printer.manager import DISPLAY_NAME_TO_MODEL_CODE, VIRTUAL_PRINTER_MODELS
  1997. for _code, display_name in VIRTUAL_PRINTER_MODELS.items():
  1998. assert display_name in DISPLAY_NAME_TO_MODEL_CODE
  1999. # For non-duplicate display names, should map back to a valid code
  2000. assert DISPLAY_NAME_TO_MODEL_CODE[display_name] in VIRTUAL_PRINTER_MODELS
  2001. def test_resolve_printer_model_with_ssdp_code(self):
  2002. """SSDP codes pass through unchanged."""
  2003. from backend.app.api.routes.virtual_printers import _resolve_printer_model
  2004. assert _resolve_printer_model("BL-P001") == "BL-P001"
  2005. assert _resolve_printer_model("O1D") == "O1D"
  2006. assert _resolve_printer_model("N2S") == "N2S"
  2007. def test_resolve_printer_model_with_display_name(self):
  2008. """Display names resolve to SSDP codes."""
  2009. from backend.app.api.routes.virtual_printers import _resolve_printer_model
  2010. assert _resolve_printer_model("X1C") == "BL-P001"
  2011. assert _resolve_printer_model("H2D") == "O1D"
  2012. assert _resolve_printer_model("A1") == "N2S"
  2013. assert _resolve_printer_model("P1S") == "C12"
  2014. def test_resolve_printer_model_with_none_or_unknown(self):
  2015. """None and unknown values return None."""
  2016. from backend.app.api.routes.virtual_printers import _resolve_printer_model
  2017. assert _resolve_printer_model(None) is None
  2018. assert _resolve_printer_model("UnknownModel") is None
  2019. class TestMqttIpRewrite:
  2020. """Tests for TLSProxy._rewrite_mqtt_ip() MQTT packet IP rewriting."""
  2021. @staticmethod
  2022. def _build_mqtt_publish(topic: str, payload: bytes) -> bytes:
  2023. """Build a minimal MQTT PUBLISH packet."""
  2024. # PUBLISH fixed header: type 3, no flags
  2025. topic_bytes = topic.encode("utf-8")
  2026. # Variable header: topic length (2 bytes) + topic
  2027. var_header = len(topic_bytes).to_bytes(2, "big") + topic_bytes
  2028. body = var_header + payload
  2029. # Encode remaining length
  2030. remaining = len(body)
  2031. header = bytearray([0x30]) # PUBLISH, QoS 0
  2032. while True:
  2033. encoded_byte = remaining % 128
  2034. remaining //= 128
  2035. if remaining > 0:
  2036. encoded_byte |= 0x80
  2037. header.append(encoded_byte)
  2038. if remaining == 0:
  2039. break
  2040. return bytes(header) + body
  2041. @staticmethod
  2042. def _build_mqtt_pingreq() -> bytes:
  2043. """Build an MQTT PINGREQ packet (2 bytes, no payload)."""
  2044. return b"\xc0\x00"
  2045. def test_rewrite_ip_in_publish(self):
  2046. """IP string in PUBLISH payload is rewritten."""
  2047. from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
  2048. payload = b'{"rtsp_url":"rtsps://192.168.1.100:322/live"}'
  2049. packet = self._build_mqtt_publish("device/status", payload)
  2050. result, buf = TLSProxy._rewrite_mqtt_ip(packet, b"192.168.1.100", b"10.0.0.1", bytearray())
  2051. assert b"10.0.0.1" in result
  2052. assert b"192.168.1.100" not in result
  2053. def test_no_rewrite_when_ip_absent(self):
  2054. """Packets without the target IP are passed through unchanged."""
  2055. from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
  2056. payload = b'{"status":"idle"}'
  2057. packet = self._build_mqtt_publish("device/status", payload)
  2058. result, buf = TLSProxy._rewrite_mqtt_ip(packet, b"192.168.1.100", b"10.0.0.1", bytearray())
  2059. assert result == packet
  2060. def test_non_publish_packets_unchanged(self):
  2061. """Non-PUBLISH packets (e.g. PINGREQ) are never rewritten."""
  2062. from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
  2063. pingreq = self._build_mqtt_pingreq()
  2064. result, buf = TLSProxy._rewrite_mqtt_ip(pingreq, b"192.168.1.100", b"10.0.0.1", bytearray())
  2065. assert result == pingreq
  2066. def test_rewrite_preserves_packet_framing(self):
  2067. """Rewritten packet has valid MQTT remaining length."""
  2068. from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
  2069. # Use IPs of different lengths to test length re-encoding
  2070. old_ip = b"192.168.255.133" # 15 bytes
  2071. new_ip = b"10.0.0.1" # 8 bytes
  2072. payload = b'{"ip":"192.168.255.133"}'
  2073. packet = self._build_mqtt_publish("device/status", payload)
  2074. result, buf = TLSProxy._rewrite_mqtt_ip(packet, old_ip, new_ip, bytearray())
  2075. # Parse the result to verify framing
  2076. assert result[0] == 0x30 # PUBLISH header byte
  2077. # Decode remaining length
  2078. pos = 1
  2079. remaining = 0
  2080. multiplier = 1
  2081. while True:
  2082. b = result[pos]
  2083. pos += 1
  2084. remaining += (b & 0x7F) * multiplier
  2085. multiplier *= 128
  2086. if (b & 0x80) == 0:
  2087. break
  2088. # Remaining length should match actual data
  2089. assert pos + remaining == len(result)
  2090. assert new_ip in result
  2091. def test_incomplete_packet_buffered(self):
  2092. """Incomplete packet at end of chunk is buffered for next call."""
  2093. from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
  2094. payload = b'{"ip":"192.168.1.100"}'
  2095. packet = self._build_mqtt_publish("device/status", payload)
  2096. # Split packet in the middle
  2097. half = len(packet) // 2
  2098. chunk1 = packet[:half]
  2099. chunk2 = packet[half:]
  2100. result1, buf = TLSProxy._rewrite_mqtt_ip(chunk1, b"192.168.1.100", b"10.0.0.1", bytearray())
  2101. # First chunk should be buffered (incomplete packet)
  2102. assert len(buf) > 0
  2103. result2, buf = TLSProxy._rewrite_mqtt_ip(chunk2, b"192.168.1.100", b"10.0.0.1", buf)
  2104. # Second chunk completes the packet, IP should be rewritten
  2105. combined = result1 + result2
  2106. assert b"10.0.0.1" in combined
  2107. assert b"192.168.1.100" not in combined
  2108. def test_multiple_packets_in_one_chunk(self):
  2109. """Multiple MQTT packets in a single chunk are all processed."""
  2110. from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
  2111. payload1 = b'{"ip":"192.168.1.100"}'
  2112. payload2 = b'{"other":"data"}'
  2113. packet1 = self._build_mqtt_publish("topic1", payload1)
  2114. packet2 = self._build_mqtt_publish("topic2", payload2)
  2115. combined = packet1 + packet2
  2116. result, buf = TLSProxy._rewrite_mqtt_ip(combined, b"192.168.1.100", b"10.0.0.1", bytearray())
  2117. assert b"10.0.0.1" in result
  2118. assert b"192.168.1.100" not in result
  2119. # Second packet should still be present
  2120. assert b"other" in result
  2121. def test_extra_replacements(self):
  2122. """Extra replacement pairs (e.g. integer IP) are also applied."""
  2123. from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
  2124. payload = b'{"net":{"info":[{"ip":2248124608}]}}'
  2125. packet = self._build_mqtt_publish("device/status", payload)
  2126. result, buf = TLSProxy._rewrite_mqtt_ip(
  2127. packet,
  2128. b"NOMATCH",
  2129. b"NOREPLACE",
  2130. bytearray(),
  2131. extra_replacements=[(b"2248124608", b"285190336")],
  2132. )
  2133. assert b"285190336" in result
  2134. assert b"2248124608" not in result
  2135. class TestIpToLeIntBytes:
  2136. """Tests for TLSProxy._ip_to_le_int_bytes() integer IP conversion."""
  2137. def test_converts_ip_to_le_int(self):
  2138. from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
  2139. assert TLSProxy._ip_to_le_int_bytes("192.168.255.133") == b"2248124608"
  2140. assert TLSProxy._ip_to_le_int_bytes("192.168.255.16") == b"285190336"
  2141. assert TLSProxy._ip_to_le_int_bytes("10.0.0.1") == b"16777226"
  2142. def test_roundtrip(self):
  2143. """Verify the integer converts back to the correct IP."""
  2144. import struct
  2145. from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
  2146. for ip in ["192.168.1.1", "10.0.0.1", "172.16.0.100", "192.168.255.133"]:
  2147. le_int = int(TLSProxy._ip_to_le_int_bytes(ip))
  2148. parts = ip.split(".")
  2149. expected = struct.unpack("<I", bytes(int(p) for p in parts))[0]
  2150. assert le_int == expected
  2151. class TestSSDPProxyName:
  2152. """Tests for SSDPProxy VP name rewriting."""
  2153. @pytest.fixture
  2154. def ssdp_proxy_with_name(self):
  2155. from backend.app.services.virtual_printer.ssdp_server import SSDPProxy
  2156. return SSDPProxy(
  2157. local_interface_ip="192.168.1.100",
  2158. remote_interface_ip="10.0.0.100",
  2159. target_printer_ip="192.168.1.50",
  2160. name="H2D-1 Proxy",
  2161. )
  2162. @pytest.fixture
  2163. def ssdp_proxy_without_name(self):
  2164. from backend.app.services.virtual_printer.ssdp_server import SSDPProxy
  2165. return SSDPProxy(
  2166. local_interface_ip="192.168.1.100",
  2167. remote_interface_ip="10.0.0.100",
  2168. target_printer_ip="192.168.1.50",
  2169. )
  2170. def test_rewrite_uses_configured_name(self, ssdp_proxy_with_name):
  2171. """When name is set, DevName is replaced entirely."""
  2172. 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"
  2173. rewritten = ssdp_proxy_with_name._rewrite_ssdp(packet)
  2174. assert b"DevName.bambu.com: H2D-1 Proxy" in rewritten
  2175. assert b"RealPrinter" not in rewritten
  2176. def test_rewrite_appends_proxy_without_name(self, ssdp_proxy_without_name):
  2177. """When no name is set, ' - Proxy' is appended to the real name."""
  2178. 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"
  2179. rewritten = ssdp_proxy_without_name._rewrite_ssdp(packet)
  2180. assert b"DevName.bambu.com: RealPrinter - Proxy" in rewritten