test_virtual_printer.py 82 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220
  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_archive_file_skips_non_3mf(self, instance):
  143. """Verify non-3MF files are skipped and cleaned up."""
  144. instance._session_factory = MagicMock()
  145. instance._pending_files["verify_job"] = Path("/tmp/verify_job") # nosec B108
  146. with patch("pathlib.Path.unlink"):
  147. await instance._archive_file(Path("/tmp/verify_job"), "192.168.1.100") # nosec B108
  148. assert "verify_job" not in instance._pending_files
  149. # ========================================================================
  150. # Tests for auto_dispatch
  151. # ========================================================================
  152. def test_auto_dispatch_defaults_to_true(self, tmp_path):
  153. """Verify auto_dispatch defaults to True when not specified."""
  154. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  155. inst = VirtualPrinterInstance(
  156. vp_id=10,
  157. name="DefaultDispatch",
  158. mode="print_queue",
  159. model="C11",
  160. access_code="12345678",
  161. serial_suffix="391800010",
  162. base_dir=tmp_path,
  163. )
  164. assert inst.auto_dispatch is True
  165. @pytest.mark.asyncio
  166. async def test_add_to_print_queue_with_auto_dispatch_on(self, tmp_path):
  167. """Verify queue items have manual_start=False when auto_dispatch=True."""
  168. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  169. mock_db = AsyncMock()
  170. added_items = []
  171. def capture_add(item):
  172. added_items.append(item)
  173. mock_db.add = MagicMock(side_effect=capture_add)
  174. mock_db.commit = AsyncMock()
  175. mock_session_factory = MagicMock()
  176. mock_session_ctx = AsyncMock()
  177. mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
  178. mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
  179. mock_session_factory.return_value = mock_session_ctx
  180. inst = VirtualPrinterInstance(
  181. vp_id=11,
  182. name="AutoDispatchOn",
  183. mode="print_queue",
  184. model="C11",
  185. access_code="12345678",
  186. serial_suffix="391800011",
  187. auto_dispatch=True,
  188. base_dir=tmp_path,
  189. session_factory=mock_session_factory,
  190. )
  191. # Create a temp 3mf file
  192. file_path = tmp_path / "test.3mf"
  193. file_path.write_bytes(b"fake3mf")
  194. mock_archive = MagicMock()
  195. mock_archive.id = 1
  196. mock_archive.print_name = "test"
  197. with (
  198. patch(
  199. "backend.app.api.routes.settings.get_setting",
  200. new_callable=AsyncMock,
  201. return_value=None,
  202. ),
  203. patch(
  204. "backend.app.services.archive.ArchiveService.archive_print",
  205. new_callable=AsyncMock,
  206. return_value=mock_archive,
  207. ),
  208. ):
  209. await inst._add_to_print_queue(file_path, "192.168.1.100")
  210. assert len(added_items) == 1
  211. queue_item = added_items[0]
  212. assert queue_item.manual_start is False
  213. @pytest.mark.asyncio
  214. async def test_add_to_print_queue_with_auto_dispatch_off(self, tmp_path):
  215. """Verify queue items have manual_start=True when auto_dispatch=False."""
  216. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  217. mock_db = AsyncMock()
  218. added_items = []
  219. def capture_add(item):
  220. added_items.append(item)
  221. mock_db.add = MagicMock(side_effect=capture_add)
  222. mock_db.commit = AsyncMock()
  223. mock_session_factory = MagicMock()
  224. mock_session_ctx = AsyncMock()
  225. mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
  226. mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
  227. mock_session_factory.return_value = mock_session_ctx
  228. inst = VirtualPrinterInstance(
  229. vp_id=12,
  230. name="AutoDispatchOff",
  231. mode="print_queue",
  232. model="C11",
  233. access_code="12345678",
  234. serial_suffix="391800012",
  235. auto_dispatch=False,
  236. base_dir=tmp_path,
  237. session_factory=mock_session_factory,
  238. )
  239. # Create a temp 3mf file
  240. file_path = tmp_path / "test.3mf"
  241. file_path.write_bytes(b"fake3mf")
  242. mock_archive = MagicMock()
  243. mock_archive.id = 1
  244. mock_archive.print_name = "test"
  245. with (
  246. patch(
  247. "backend.app.api.routes.settings.get_setting",
  248. new_callable=AsyncMock,
  249. return_value=None,
  250. ),
  251. patch(
  252. "backend.app.services.archive.ArchiveService.archive_print",
  253. new_callable=AsyncMock,
  254. return_value=mock_archive,
  255. ),
  256. ):
  257. await inst._add_to_print_queue(file_path, "192.168.1.100")
  258. assert len(added_items) == 1
  259. queue_item = added_items[0]
  260. assert queue_item.manual_start is True
  261. @pytest.mark.asyncio
  262. async def test_add_to_print_queue_populates_required_filament_types(self, tmp_path):
  263. """#1188: VP queue-mode used to create PrintQueueItems with no
  264. filament fields, so the scheduler fell through to model-only matching
  265. and dispatched onto whatever printer was free regardless of loaded
  266. colour. ``required_filament_types`` is populated unconditionally
  267. (cheap, helps the scheduler validate type even without
  268. ``force_color_match``) — pin that contract here."""
  269. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  270. added_items = []
  271. mock_db = AsyncMock()
  272. mock_db.add = MagicMock(side_effect=added_items.append)
  273. mock_db.commit = AsyncMock()
  274. mock_session_factory = MagicMock()
  275. mock_session_ctx = AsyncMock()
  276. mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
  277. mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
  278. mock_session_factory.return_value = mock_session_ctx
  279. inst = VirtualPrinterInstance(
  280. vp_id=21,
  281. name="Reqs",
  282. mode="print_queue",
  283. model="C12",
  284. access_code="12345678",
  285. serial_suffix="391800021",
  286. auto_dispatch=True,
  287. queue_force_color_match=False, # off → only required_filament_types
  288. base_dir=tmp_path,
  289. session_factory=mock_session_factory,
  290. )
  291. file_path = tmp_path / "multi.3mf"
  292. _write_3mf_with_filaments(
  293. file_path,
  294. [
  295. {"id": "1", "type": "PLA", "color": "#FFFFFF", "used_g": "12.3"},
  296. {"id": "2", "type": "PETG", "color": "#000000", "used_g": "4.5"},
  297. # used_g=0 → not actually consumed by this plate, must be ignored
  298. {"id": "3", "type": "ABS", "color": "#FF0000", "used_g": "0"},
  299. ],
  300. plate_index=1,
  301. )
  302. mock_archive = MagicMock()
  303. mock_archive.id = 1
  304. mock_archive.print_name = "multi"
  305. with (
  306. patch(
  307. "backend.app.api.routes.settings.get_setting",
  308. new_callable=AsyncMock,
  309. return_value=None,
  310. ),
  311. patch(
  312. "backend.app.services.archive.ArchiveService.archive_print",
  313. new_callable=AsyncMock,
  314. return_value=mock_archive,
  315. ),
  316. ):
  317. await inst._add_to_print_queue(file_path, "192.168.1.100")
  318. assert len(added_items) == 1
  319. queue_item = added_items[0]
  320. # Type-only fallback always populated. Sorted, deduped, no zero-use ABS.
  321. assert queue_item.required_filament_types is not None
  322. assert json.loads(queue_item.required_filament_types) == ["PETG", "PLA"]
  323. # Setting off → no force_color_match overrides leaked.
  324. assert queue_item.filament_overrides is None
  325. @pytest.mark.asyncio
  326. async def test_add_to_print_queue_force_color_match_writes_overrides(self, tmp_path):
  327. """#1188 core fix: when the per-VP ``queue_force_color_match`` toggle
  328. is on, every consumed slot lands as a ``filament_overrides`` entry
  329. with ``force_color_match: true``. This is the field the scheduler
  330. keys on (``print_scheduler.py:512``) — without it, slot-by-slot
  331. type+color matching never runs."""
  332. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  333. added_items = []
  334. mock_db = AsyncMock()
  335. mock_db.add = MagicMock(side_effect=added_items.append)
  336. mock_db.commit = AsyncMock()
  337. mock_session_factory = MagicMock()
  338. mock_session_ctx = AsyncMock()
  339. mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
  340. mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
  341. mock_session_factory.return_value = mock_session_ctx
  342. inst = VirtualPrinterInstance(
  343. vp_id=22,
  344. name="ForceColor",
  345. mode="print_queue",
  346. model="C12",
  347. access_code="12345678",
  348. serial_suffix="391800022",
  349. auto_dispatch=True,
  350. queue_force_color_match=True, # on
  351. base_dir=tmp_path,
  352. session_factory=mock_session_factory,
  353. )
  354. file_path = tmp_path / "forced.3mf"
  355. _write_3mf_with_filaments(
  356. file_path,
  357. [
  358. {"id": "1", "type": "PLA", "color": "#FFFFFF", "used_g": "10.0"},
  359. {"id": "2", "type": "PLA", "color": "#FF00FF", "used_g": "5.0"},
  360. ],
  361. plate_index=1,
  362. )
  363. mock_archive = MagicMock()
  364. mock_archive.id = 1
  365. mock_archive.print_name = "forced"
  366. with (
  367. patch(
  368. "backend.app.api.routes.settings.get_setting",
  369. new_callable=AsyncMock,
  370. return_value=None,
  371. ),
  372. patch(
  373. "backend.app.services.archive.ArchiveService.archive_print",
  374. new_callable=AsyncMock,
  375. return_value=mock_archive,
  376. ),
  377. ):
  378. await inst._add_to_print_queue(file_path, "192.168.1.100")
  379. assert len(added_items) == 1
  380. queue_item = added_items[0]
  381. assert queue_item.filament_overrides is not None
  382. overrides = json.loads(queue_item.filament_overrides)
  383. assert overrides == [
  384. {"slot_id": 1, "type": "PLA", "color": "#FFFFFF", "force_color_match": True},
  385. {"slot_id": 2, "type": "PLA", "color": "#FF00FF", "force_color_match": True},
  386. ]
  387. # required_filament_types still populated alongside overrides.
  388. assert json.loads(queue_item.required_filament_types) == ["PLA"]
  389. @pytest.mark.asyncio
  390. async def test_add_to_print_queue_force_color_match_skips_when_3mf_unparseable(self, tmp_path):
  391. """A malformed or fake-bytes 3MF must not crash the upload path —
  392. we just write the queue item with no filament fields and let the
  393. scheduler fall back to model-only matching (the pre-#1188 default).
  394. Regression guard for the existing fake-bytes happy-path tests."""
  395. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  396. added_items = []
  397. mock_db = AsyncMock()
  398. mock_db.add = MagicMock(side_effect=added_items.append)
  399. mock_db.commit = AsyncMock()
  400. mock_session_factory = MagicMock()
  401. mock_session_ctx = AsyncMock()
  402. mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
  403. mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
  404. mock_session_factory.return_value = mock_session_ctx
  405. inst = VirtualPrinterInstance(
  406. vp_id=23,
  407. name="Unparseable",
  408. mode="print_queue",
  409. model="C12",
  410. access_code="12345678",
  411. serial_suffix="391800023",
  412. auto_dispatch=True,
  413. queue_force_color_match=True,
  414. base_dir=tmp_path,
  415. session_factory=mock_session_factory,
  416. )
  417. file_path = tmp_path / "bad.3mf"
  418. file_path.write_bytes(b"not a real 3mf zip")
  419. mock_archive = MagicMock()
  420. mock_archive.id = 1
  421. mock_archive.print_name = "bad"
  422. with (
  423. patch(
  424. "backend.app.api.routes.settings.get_setting",
  425. new_callable=AsyncMock,
  426. return_value=None,
  427. ),
  428. patch(
  429. "backend.app.services.archive.ArchiveService.archive_print",
  430. new_callable=AsyncMock,
  431. return_value=mock_archive,
  432. ),
  433. ):
  434. await inst._add_to_print_queue(file_path, "192.168.1.100")
  435. assert len(added_items) == 1
  436. queue_item = added_items[0]
  437. # No filament data extractable → both fields stay None (graceful
  438. # fallback to model-only scheduling).
  439. assert queue_item.required_filament_types is None
  440. assert queue_item.filament_overrides is None
  441. # ========================================================================
  442. # Tests for archive_name_source setting (#1152)
  443. # ========================================================================
  444. @pytest.mark.asyncio
  445. @pytest.mark.parametrize(
  446. ("setting_value", "expected_prefer_filename"),
  447. [
  448. ("filename", True),
  449. ("metadata", False),
  450. (None, False), # Default when setting unset
  451. ("", False), # Defensive: empty string is not "filename"
  452. ],
  453. )
  454. async def test_archive_file_passes_prefer_filename_per_setting(
  455. self, tmp_path, setting_value, expected_prefer_filename
  456. ):
  457. """_archive_file reads `virtual_printer_archive_name_source` and forwards
  458. prefer_filename_for_name=True only when it equals 'filename' (#1152)."""
  459. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  460. mock_db = AsyncMock()
  461. mock_session_factory = MagicMock()
  462. mock_session_ctx = AsyncMock()
  463. mock_session_ctx.__aenter__ = AsyncMock(return_value=mock_db)
  464. mock_session_ctx.__aexit__ = AsyncMock(return_value=False)
  465. mock_session_factory.return_value = mock_session_ctx
  466. inst = VirtualPrinterInstance(
  467. vp_id=20,
  468. name="NameSource",
  469. mode="immediate",
  470. model="C11",
  471. access_code="12345678",
  472. serial_suffix="391800020",
  473. base_dir=tmp_path,
  474. session_factory=mock_session_factory,
  475. )
  476. file_path = tmp_path / "user-renamed-job.3mf"
  477. file_path.write_bytes(b"fake3mf")
  478. mock_archive = MagicMock()
  479. mock_archive.id = 1
  480. mock_archive.print_name = "user-renamed-job"
  481. archive_print_mock = AsyncMock(return_value=mock_archive)
  482. with (
  483. patch(
  484. "backend.app.api.routes.settings.get_setting",
  485. new_callable=AsyncMock,
  486. return_value=setting_value,
  487. ),
  488. patch(
  489. "backend.app.services.archive.ArchiveService.archive_print",
  490. archive_print_mock,
  491. ),
  492. ):
  493. await inst._archive_file(file_path, "192.168.1.100")
  494. assert archive_print_mock.await_count == 1
  495. kwargs = archive_print_mock.await_args.kwargs
  496. assert kwargs.get("prefer_filename_for_name") is expected_prefer_filename
  497. class TestVirtualPrinterManager:
  498. """Tests for VirtualPrinterManager orchestrator."""
  499. @pytest.fixture
  500. def manager(self):
  501. """Create a VirtualPrinterManager instance."""
  502. from backend.app.services.virtual_printer.manager import VirtualPrinterManager
  503. return VirtualPrinterManager()
  504. def test_manager_starts_empty(self, manager):
  505. """Verify manager starts with no instances."""
  506. assert len(manager._instances) == 0
  507. assert manager.is_enabled is False
  508. def test_manager_get_status_empty(self, manager):
  509. """Verify get_status returns disabled state when no instances."""
  510. status = manager.get_status()
  511. assert status["enabled"] is False
  512. assert status["running"] is False
  513. assert status["mode"] == "immediate"
  514. def test_manager_is_enabled_with_instance(self, manager, tmp_path):
  515. """Verify is_enabled is True when instances exist."""
  516. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  517. inst = VirtualPrinterInstance(
  518. vp_id=1,
  519. name="Test",
  520. mode="immediate",
  521. model="C11",
  522. access_code="12345678",
  523. serial_suffix="391800001",
  524. base_dir=tmp_path,
  525. )
  526. manager._instances[1] = inst
  527. assert manager.is_enabled is True
  528. @pytest.mark.asyncio
  529. async def test_manager_remove_instance_server(self, manager, tmp_path):
  530. """Verify remove_instance stops and removes a server-mode instance."""
  531. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  532. inst = VirtualPrinterInstance(
  533. vp_id=1,
  534. name="Test",
  535. mode="immediate",
  536. model="C11",
  537. access_code="12345678",
  538. serial_suffix="391800001",
  539. base_dir=tmp_path,
  540. )
  541. inst.stop_server = AsyncMock()
  542. manager._instances[1] = inst
  543. await manager.remove_instance(1)
  544. assert 1 not in manager._instances
  545. inst.stop_server.assert_called_once()
  546. @pytest.mark.asyncio
  547. async def test_manager_remove_instance_proxy(self, manager, tmp_path):
  548. """Verify remove_instance stops proxy-mode instance."""
  549. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  550. inst = VirtualPrinterInstance(
  551. vp_id=2,
  552. name="Proxy",
  553. mode="proxy",
  554. model="C11",
  555. access_code="",
  556. serial_suffix="391800002",
  557. target_printer_ip="192.168.1.100",
  558. base_dir=tmp_path,
  559. )
  560. inst.stop_proxy = AsyncMock()
  561. manager._instances[2] = inst
  562. await manager.remove_instance(2)
  563. assert 2 not in manager._instances
  564. inst.stop_proxy.assert_called_once()
  565. def test_manager_get_status_with_instance(self, manager, tmp_path):
  566. """Verify legacy get_status returns first instance data."""
  567. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  568. inst = VirtualPrinterInstance(
  569. vp_id=1,
  570. name="Bambuddy",
  571. mode="immediate",
  572. model="C11",
  573. access_code="12345678",
  574. serial_suffix="391800001",
  575. base_dir=tmp_path,
  576. )
  577. mock_task = MagicMock(done=MagicMock(return_value=False))
  578. inst._tasks = [mock_task]
  579. inst._pending_files = {"file1.3mf": Path("/tmp/file1.3mf")} # nosec B108
  580. manager._instances[1] = inst
  581. status = manager.get_status()
  582. assert status["enabled"] is True
  583. assert status["running"] is True
  584. assert status["mode"] == "immediate"
  585. assert status["name"] == "Bambuddy"
  586. assert status["serial"] == "01S00A391800001"
  587. assert status["model"] == "C11"
  588. assert status["model_name"] == "P1P"
  589. assert status["pending_files"] == 1
  590. def test_manager_get_all_status(self, manager, tmp_path):
  591. """Verify get_all_status returns status for all instances."""
  592. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  593. for i in range(1, 3):
  594. inst = VirtualPrinterInstance(
  595. vp_id=i,
  596. name=f"VP{i}",
  597. mode="immediate",
  598. model="C11",
  599. access_code="12345678",
  600. serial_suffix=f"39180000{i}",
  601. base_dir=tmp_path,
  602. )
  603. manager._instances[i] = inst
  604. statuses = manager.get_all_status()
  605. assert len(statuses) == 2
  606. assert statuses[0]["name"] == "VP1"
  607. assert statuses[1]["name"] == "VP2"
  608. @pytest.mark.asyncio
  609. async def test_manager_stop_all(self, manager, tmp_path):
  610. """Verify stop_all removes all instances."""
  611. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  612. for i in range(1, 3):
  613. inst = VirtualPrinterInstance(
  614. vp_id=i,
  615. name=f"VP{i}",
  616. mode="immediate",
  617. model="C11",
  618. access_code="12345678",
  619. serial_suffix=f"39180000{i}",
  620. base_dir=tmp_path,
  621. )
  622. inst.stop_server = AsyncMock()
  623. manager._instances[i] = inst
  624. await manager.stop_all()
  625. assert len(manager._instances) == 0
  626. # ========================================================================
  627. # Tests for sync_from_db config change detection
  628. # ========================================================================
  629. def _make_db_vp(self, **overrides):
  630. """Create a mock VirtualPrinter DB object."""
  631. defaults = {
  632. "id": 1,
  633. "name": "TestVP",
  634. "enabled": True,
  635. "mode": "immediate",
  636. "model": "C11",
  637. "access_code": "12345678",
  638. "serial_suffix": "391800001",
  639. "bind_ip": "",
  640. "remote_interface_ip": "",
  641. "target_printer_id": None,
  642. "auto_dispatch": True,
  643. "tailscale_disabled": True, # Opt-in default (#1070 UX fix)
  644. "position": 0,
  645. }
  646. defaults.update(overrides)
  647. vp = MagicMock()
  648. for k, v in defaults.items():
  649. setattr(vp, k, v)
  650. return vp
  651. def _setup_sync_mocks(self, manager, enabled_vps, tmp_path):
  652. """Wire up session_factory mock for sync_from_db."""
  653. mock_result = MagicMock()
  654. mock_result.scalars.return_value.all.return_value = enabled_vps
  655. mock_db = AsyncMock()
  656. mock_db.execute = AsyncMock(return_value=mock_result)
  657. mock_db.__aenter__ = AsyncMock(return_value=mock_db)
  658. mock_db.__aexit__ = AsyncMock(return_value=False)
  659. manager._session_factory = MagicMock(return_value=mock_db)
  660. manager._base_dir = tmp_path
  661. @pytest.mark.asyncio
  662. async def test_sync_from_db_restarts_on_mode_change(self, manager, tmp_path):
  663. """Verify sync_from_db restarts VP when mode changes."""
  664. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  665. inst = VirtualPrinterInstance(
  666. vp_id=1,
  667. name="TestVP",
  668. mode="immediate",
  669. model="C11",
  670. access_code="12345678",
  671. serial_suffix="391800001",
  672. base_dir=tmp_path,
  673. )
  674. inst.stop_server = AsyncMock()
  675. manager._instances[1] = inst
  676. # DB says mode changed to "archive"
  677. db_vp = self._make_db_vp(mode="archive")
  678. self._setup_sync_mocks(manager, [db_vp], tmp_path)
  679. with patch.object(manager, "remove_instance", new_callable=AsyncMock) as mock_remove:
  680. # Patch VirtualPrinterInstance to prevent actual start
  681. with patch("backend.app.services.virtual_printer.manager.VirtualPrinterInstance") as MockInst:
  682. mock_new = MagicMock()
  683. mock_new.start_server = AsyncMock()
  684. MockInst.return_value = mock_new
  685. await manager.sync_from_db()
  686. mock_remove.assert_called_once_with(1)
  687. @pytest.mark.asyncio
  688. async def test_sync_from_db_restarts_on_access_code_change(self, manager, tmp_path):
  689. """Verify sync_from_db restarts VP when access_code changes."""
  690. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  691. inst = VirtualPrinterInstance(
  692. vp_id=1,
  693. name="TestVP",
  694. mode="immediate",
  695. model="C11",
  696. access_code="12345678",
  697. serial_suffix="391800001",
  698. base_dir=tmp_path,
  699. )
  700. inst.stop_server = AsyncMock()
  701. manager._instances[1] = inst
  702. db_vp = self._make_db_vp(access_code="newcode99")
  703. self._setup_sync_mocks(manager, [db_vp], tmp_path)
  704. with patch.object(manager, "remove_instance", new_callable=AsyncMock) as mock_remove:
  705. with patch("backend.app.services.virtual_printer.manager.VirtualPrinterInstance") as MockInst:
  706. mock_new = MagicMock()
  707. mock_new.start_server = AsyncMock()
  708. MockInst.return_value = mock_new
  709. await manager.sync_from_db()
  710. mock_remove.assert_called_once_with(1)
  711. @pytest.mark.asyncio
  712. async def test_sync_from_db_skips_unchanged_instance(self, manager, tmp_path):
  713. """Verify sync_from_db does NOT restart when config is identical."""
  714. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  715. inst = VirtualPrinterInstance(
  716. vp_id=1,
  717. name="TestVP",
  718. mode="immediate",
  719. model="C11",
  720. access_code="12345678",
  721. serial_suffix="391800001",
  722. base_dir=tmp_path,
  723. )
  724. manager._instances[1] = inst
  725. # DB matches running config exactly
  726. db_vp = self._make_db_vp()
  727. self._setup_sync_mocks(manager, [db_vp], tmp_path)
  728. with patch.object(manager, "remove_instance", new_callable=AsyncMock) as mock_remove:
  729. await manager.sync_from_db()
  730. mock_remove.assert_not_called()
  731. @pytest.mark.asyncio
  732. async def test_sync_from_db_restarts_on_bind_ip_change(self, manager, tmp_path):
  733. """Verify sync_from_db restarts VP when bind_ip changes."""
  734. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  735. inst = VirtualPrinterInstance(
  736. vp_id=1,
  737. name="TestVP",
  738. mode="immediate",
  739. model="C11",
  740. access_code="12345678",
  741. serial_suffix="391800001",
  742. bind_ip="192.168.1.10",
  743. base_dir=tmp_path,
  744. )
  745. inst.stop_server = AsyncMock()
  746. manager._instances[1] = inst
  747. db_vp = self._make_db_vp(bind_ip="192.168.1.20")
  748. self._setup_sync_mocks(manager, [db_vp], tmp_path)
  749. with patch.object(manager, "remove_instance", new_callable=AsyncMock) as mock_remove:
  750. with patch("backend.app.services.virtual_printer.manager.VirtualPrinterInstance") as MockInst:
  751. mock_new = MagicMock()
  752. mock_new.start_server = AsyncMock()
  753. MockInst.return_value = mock_new
  754. await manager.sync_from_db()
  755. mock_remove.assert_called_once_with(1)
  756. @pytest.mark.asyncio
  757. async def test_sync_from_db_restarts_on_model_change(self, manager, tmp_path):
  758. """Verify sync_from_db restarts VP when model changes."""
  759. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  760. inst = VirtualPrinterInstance(
  761. vp_id=1,
  762. name="TestVP",
  763. mode="immediate",
  764. model="C11",
  765. access_code="12345678",
  766. serial_suffix="391800001",
  767. base_dir=tmp_path,
  768. )
  769. inst.stop_server = AsyncMock()
  770. manager._instances[1] = inst
  771. db_vp = self._make_db_vp(model="C12")
  772. self._setup_sync_mocks(manager, [db_vp], tmp_path)
  773. with patch.object(manager, "remove_instance", new_callable=AsyncMock) as mock_remove:
  774. with patch("backend.app.services.virtual_printer.manager.VirtualPrinterInstance") as MockInst:
  775. mock_new = MagicMock()
  776. mock_new.start_server = AsyncMock()
  777. MockInst.return_value = mock_new
  778. await manager.sync_from_db()
  779. mock_remove.assert_called_once_with(1)
  780. @pytest.mark.asyncio
  781. async def test_sync_from_db_restarts_on_tailscale_disabled_change(self, manager, tmp_path):
  782. """VP restarts when tailscale_disabled flips from False to True."""
  783. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  784. inst = VirtualPrinterInstance(
  785. vp_id=1,
  786. name="TestVP",
  787. mode="immediate",
  788. model="C11",
  789. access_code="12345678",
  790. serial_suffix="391800001",
  791. tailscale_disabled=False,
  792. base_dir=tmp_path,
  793. )
  794. inst.stop_server = AsyncMock()
  795. manager._instances[1] = inst
  796. db_vp = self._make_db_vp(tailscale_disabled=True)
  797. self._setup_sync_mocks(manager, [db_vp], tmp_path)
  798. with patch.object(manager, "remove_instance", new_callable=AsyncMock) as mock_remove:
  799. with patch("backend.app.services.virtual_printer.manager.VirtualPrinterInstance") as MockInst:
  800. mock_new = MagicMock()
  801. mock_new.start_server = AsyncMock()
  802. MockInst.return_value = mock_new
  803. await manager.sync_from_db()
  804. mock_remove.assert_called_once_with(1)
  805. class TestFTPSession:
  806. """Tests for FTP session handling."""
  807. @pytest.fixture
  808. def mock_reader(self):
  809. """Create a mock StreamReader."""
  810. reader = AsyncMock()
  811. return reader
  812. @pytest.fixture
  813. def mock_writer(self):
  814. """Create a mock StreamWriter."""
  815. writer = MagicMock()
  816. writer.get_extra_info = MagicMock(return_value=("192.168.1.100", 12345))
  817. writer.write = MagicMock()
  818. writer.drain = AsyncMock()
  819. writer.close = MagicMock()
  820. writer.wait_closed = AsyncMock()
  821. writer.is_closing = MagicMock(return_value=False)
  822. return writer
  823. @pytest.fixture
  824. def ssl_context(self):
  825. """Create a mock SSL context."""
  826. return MagicMock()
  827. @pytest.fixture
  828. def session(self, mock_reader, mock_writer, ssl_context, tmp_path):
  829. """Create an FTPSession instance."""
  830. from backend.app.services.virtual_printer.ftp_server import FTPSession
  831. return FTPSession(
  832. reader=mock_reader,
  833. writer=mock_writer,
  834. upload_dir=tmp_path,
  835. access_code="12345678",
  836. ssl_context=ssl_context,
  837. on_file_received=None,
  838. )
  839. # ========================================================================
  840. # Tests for authentication
  841. # ========================================================================
  842. @pytest.mark.asyncio
  843. async def test_user_command_accepts_bblp(self, session):
  844. """Verify USER command accepts bblp user."""
  845. await session.cmd_USER("bblp")
  846. assert session.username == "bblp"
  847. @pytest.mark.asyncio
  848. async def test_pass_command_authenticates(self, session):
  849. """Verify PASS command authenticates with correct code."""
  850. session.username = "bblp"
  851. await session.cmd_PASS("12345678")
  852. assert session.authenticated is True
  853. @pytest.mark.asyncio
  854. async def test_pass_command_rejects_wrong_code(self, session):
  855. """Verify PASS command rejects wrong access code."""
  856. session.username = "bblp"
  857. await session.cmd_PASS("wrongcode")
  858. assert session.authenticated is False
  859. # ========================================================================
  860. # Tests for FTP commands
  861. # ========================================================================
  862. @pytest.mark.asyncio
  863. async def test_syst_command(self, session):
  864. """Verify SYST returns UNIX type."""
  865. await session.cmd_SYST("")
  866. session.writer.write.assert_called()
  867. call_args = session.writer.write.call_args[0][0].decode()
  868. assert "215" in call_args
  869. assert "UNIX" in call_args
  870. @pytest.mark.asyncio
  871. async def test_pwd_command_requires_auth(self, session):
  872. """Verify PWD requires authentication."""
  873. session.authenticated = False
  874. await session.cmd_PWD("")
  875. call_args = session.writer.write.call_args[0][0].decode()
  876. assert "530" in call_args
  877. @pytest.mark.asyncio
  878. async def test_pwd_command_when_authenticated(self, session):
  879. """Verify PWD returns root directory when authenticated."""
  880. session.authenticated = True
  881. await session.cmd_PWD("")
  882. call_args = session.writer.write.call_args[0][0].decode()
  883. assert "257" in call_args
  884. @pytest.mark.asyncio
  885. async def test_type_command_sets_binary(self, session):
  886. """Verify TYPE I sets binary mode."""
  887. session.authenticated = True
  888. await session.cmd_TYPE("I")
  889. assert session.transfer_type == "I"
  890. @pytest.mark.asyncio
  891. async def test_pbsz_command(self, session):
  892. """Verify PBSZ returns success."""
  893. await session.cmd_PBSZ("0")
  894. call_args = session.writer.write.call_args[0][0].decode()
  895. assert "200" in call_args
  896. @pytest.mark.asyncio
  897. async def test_prot_command_accepts_p(self, session):
  898. """Verify PROT P is accepted."""
  899. await session.cmd_PROT("P")
  900. call_args = session.writer.write.call_args[0][0].decode()
  901. assert "200" in call_args
  902. @pytest.mark.asyncio
  903. async def test_quit_command(self, session):
  904. """Verify QUIT sends goodbye and raises CancelledError."""
  905. with pytest.raises(asyncio.CancelledError):
  906. await session.cmd_QUIT("")
  907. class TestSSDPServer:
  908. """Tests for Virtual Printer SSDP server."""
  909. @pytest.fixture
  910. def ssdp_server(self):
  911. """Create a VirtualPrinterSSDPServer instance."""
  912. from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
  913. return VirtualPrinterSSDPServer(
  914. serial="TEST123",
  915. name="TestPrinter",
  916. model="BL-P001",
  917. )
  918. # ========================================================================
  919. # Tests for SSDP response
  920. # ========================================================================
  921. def test_build_notify_message(self, ssdp_server):
  922. """Verify NOTIFY packet contains required headers."""
  923. # Set a known IP for testing
  924. ssdp_server._local_ip = "192.168.1.100"
  925. message = ssdp_server._build_notify_message()
  926. assert b"NOTIFY" in message
  927. assert b"DevName.bambu.com: TestPrinter" in message
  928. assert b"USN: TEST123" in message
  929. def test_build_response_message(self, ssdp_server):
  930. """Verify response packet contains required headers."""
  931. # Set a known IP for testing
  932. ssdp_server._local_ip = "192.168.1.100"
  933. message = ssdp_server._build_response_message()
  934. assert b"HTTP/1.1 200 OK" in message
  935. assert b"DevName.bambu.com: TestPrinter" in message
  936. assert b"USN: TEST123" in message
  937. def test_ssdp_server_uses_correct_model(self, ssdp_server):
  938. """Verify SSDP server uses the provided model."""
  939. ssdp_server._local_ip = "192.168.1.100"
  940. message = ssdp_server._build_notify_message()
  941. assert b"DevModel.bambu.com: BL-P001" in message
  942. # ========================================================================
  943. # Tests for advertise_ip parameter
  944. # ========================================================================
  945. def test_advertise_ip_sets_local_ip(self):
  946. """Verify advertise_ip overrides auto-detection."""
  947. from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
  948. server = VirtualPrinterSSDPServer(
  949. serial="TEST123",
  950. name="TestPrinter",
  951. model="BL-P001",
  952. advertise_ip="10.0.0.50",
  953. )
  954. assert server._local_ip == "10.0.0.50"
  955. def test_advertise_ip_empty_string_uses_auto_detect(self):
  956. """Verify empty advertise_ip falls back to auto-detection."""
  957. from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
  958. server = VirtualPrinterSSDPServer(
  959. serial="TEST123",
  960. name="TestPrinter",
  961. model="BL-P001",
  962. advertise_ip="",
  963. )
  964. assert server._local_ip is None
  965. def test_advertise_ip_in_notify_message(self):
  966. """Verify NOTIFY message uses the advertise_ip."""
  967. from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
  968. server = VirtualPrinterSSDPServer(
  969. serial="TEST123",
  970. name="TestPrinter",
  971. model="BL-P001",
  972. advertise_ip="10.0.0.50",
  973. )
  974. message = server._build_notify_message()
  975. assert b"Location: 10.0.0.50" in message
  976. def test_advertise_ip_in_response_message(self):
  977. """Verify M-SEARCH response uses the advertise_ip."""
  978. from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
  979. server = VirtualPrinterSSDPServer(
  980. serial="TEST123",
  981. name="TestPrinter",
  982. model="BL-P001",
  983. advertise_ip="10.0.0.50",
  984. )
  985. message = server._build_response_message()
  986. assert b"Location: 10.0.0.50" in message
  987. def test_default_no_advertise_ip(self):
  988. """Verify default constructor has None local_ip (auto-detect)."""
  989. from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
  990. server = VirtualPrinterSSDPServer()
  991. assert server._local_ip is None
  992. class TestCertificateService:
  993. """Tests for TLS certificate generation."""
  994. @pytest.fixture
  995. def cert_service(self, tmp_path):
  996. """Create a CertificateService instance."""
  997. from backend.app.services.virtual_printer.certificate import CertificateService
  998. return CertificateService(cert_dir=tmp_path, serial="TEST123")
  999. def test_generate_certificates(self, cert_service, tmp_path):
  1000. """Verify certificates are generated correctly."""
  1001. cert_path, key_path = cert_service.generate_certificates()
  1002. assert cert_path.exists()
  1003. assert key_path.exists()
  1004. # Verify certificate content
  1005. cert_content = cert_path.read_text()
  1006. assert "BEGIN CERTIFICATE" in cert_content
  1007. key_content = key_path.read_text()
  1008. assert "BEGIN" in key_content and "KEY" in key_content
  1009. def test_certificates_reused_if_exist(self, cert_service):
  1010. """Verify existing certificates are reused."""
  1011. # First generation
  1012. cert_path1, key_path1 = cert_service.generate_certificates()
  1013. mtime1 = cert_path1.stat().st_mtime
  1014. # Second call should reuse (via ensure_certificates)
  1015. cert_path2, key_path2 = cert_service.ensure_certificates()
  1016. mtime2 = cert_path2.stat().st_mtime
  1017. assert mtime1 == mtime2 # File wasn't regenerated
  1018. def test_delete_certificates(self, cert_service):
  1019. """Verify certificates can be deleted."""
  1020. cert_service.generate_certificates()
  1021. assert cert_service.cert_path.exists()
  1022. assert cert_service.key_path.exists()
  1023. cert_service.delete_certificates()
  1024. assert not cert_service.cert_path.exists()
  1025. assert not cert_service.key_path.exists()
  1026. def test_ensure_creates_if_not_exist(self, cert_service):
  1027. """Verify ensure_certificates generates if not existing."""
  1028. assert not cert_service.cert_path.exists()
  1029. cert_path, key_path = cert_service.ensure_certificates()
  1030. assert cert_path.exists()
  1031. assert key_path.exists()
  1032. class TestBindServer:
  1033. """Tests for BindServer (port 3002 bind/detect protocol)."""
  1034. @pytest.fixture
  1035. def bind_server(self):
  1036. """Create a BindServer instance."""
  1037. from backend.app.services.virtual_printer.bind_server import BindServer
  1038. return BindServer(
  1039. serial="09400A391800001",
  1040. model="O1D",
  1041. name="Bambuddy",
  1042. )
  1043. def test_build_frame(self, bind_server):
  1044. """Verify frame building produces correct format."""
  1045. payload = {"login": {"command": "detect"}}
  1046. frame = bind_server._build_frame(payload)
  1047. # Header: 0xA5A5
  1048. assert frame[:2] == b"\xa5\xa5"
  1049. # Trailer: 0xA7A7
  1050. assert frame[-2:] == b"\xa7\xa7"
  1051. # Length field is total message size (LE uint16)
  1052. import struct
  1053. total_len = struct.unpack_from("<H", frame, 2)[0]
  1054. assert total_len == len(frame)
  1055. # JSON payload is between header and trailer
  1056. import json
  1057. json_bytes = frame[4:-2]
  1058. parsed = json.loads(json_bytes)
  1059. assert parsed == payload
  1060. def test_parse_frame_valid(self, bind_server):
  1061. """Verify valid frame parsing extracts JSON correctly."""
  1062. import json
  1063. import struct
  1064. payload = {"login": {"command": "detect", "sequence_id": "20000"}}
  1065. json_bytes = json.dumps(payload, separators=(",", ":")).encode()
  1066. total_len = 4 + len(json_bytes) + 2
  1067. frame = b"\xa5\xa5" + struct.pack("<H", total_len) + json_bytes + b"\xa7\xa7"
  1068. result = bind_server._parse_frame(frame)
  1069. assert result is not None
  1070. assert result["login"]["command"] == "detect"
  1071. assert result["login"]["sequence_id"] == "20000"
  1072. def test_parse_frame_invalid_header(self, bind_server):
  1073. """Verify invalid header returns None."""
  1074. result = bind_server._parse_frame(b"\xbb\xbb\x06\x00{}\xa7\xa7")
  1075. assert result is None
  1076. def test_parse_frame_invalid_trailer(self, bind_server):
  1077. """Verify invalid trailer returns None."""
  1078. result = bind_server._parse_frame(b"\xa5\xa5\x06\x00{}\xbb\xbb")
  1079. assert result is None
  1080. def test_parse_frame_too_short(self, bind_server):
  1081. """Verify short data returns None."""
  1082. result = bind_server._parse_frame(b"\xa5\xa5\x00")
  1083. assert result is None
  1084. def test_parse_frame_invalid_json(self, bind_server):
  1085. """Verify invalid JSON returns None."""
  1086. import struct
  1087. bad_json = b"not json"
  1088. total_len = 4 + len(bad_json) + 2
  1089. frame = b"\xa5\xa5" + struct.pack("<H", total_len) + bad_json + b"\xa7\xa7"
  1090. result = bind_server._parse_frame(frame)
  1091. assert result is None
  1092. def test_build_frame_roundtrip(self, bind_server):
  1093. """Verify build_frame output can be parsed back."""
  1094. payload = {
  1095. "login": {
  1096. "bind": "free",
  1097. "command": "detect",
  1098. "connect": "lan",
  1099. "dev_cap": 1,
  1100. "id": "09400A391800001",
  1101. "model": "O1D",
  1102. "name": "Bambuddy",
  1103. "sequence_id": 3021,
  1104. "version": "01.00.00.00",
  1105. }
  1106. }
  1107. frame = bind_server._build_frame(payload)
  1108. parsed = bind_server._parse_frame(frame)
  1109. assert parsed is not None
  1110. assert parsed["login"]["id"] == "09400A391800001"
  1111. assert parsed["login"]["model"] == "O1D"
  1112. assert parsed["login"]["name"] == "Bambuddy"
  1113. assert parsed["login"]["bind"] == "free"
  1114. def test_bind_server_stores_config(self, bind_server):
  1115. """Verify bind server stores serial, model, name."""
  1116. assert bind_server.serial == "09400A391800001"
  1117. assert bind_server.model == "O1D"
  1118. assert bind_server.name == "Bambuddy"
  1119. assert bind_server.version == "01.00.00.00"
  1120. def test_bind_server_custom_version(self):
  1121. """Verify custom firmware version is stored."""
  1122. from backend.app.services.virtual_printer.bind_server import BindServer
  1123. server = BindServer(
  1124. serial="TEST123",
  1125. model="C13",
  1126. name="Test",
  1127. version="02.03.04.05",
  1128. )
  1129. assert server.version == "02.03.04.05"
  1130. def test_bind_ports_constant(self):
  1131. """Verify BIND_PORTS includes both 3000 and 3002 for slicer compatibility."""
  1132. from backend.app.services.virtual_printer.bind_server import BIND_PORTS
  1133. assert 3000 in BIND_PORTS
  1134. assert 3002 in BIND_PORTS
  1135. def test_bind_server_initializes_empty_servers_list(self, bind_server):
  1136. """Verify bind server starts with empty servers list."""
  1137. assert bind_server._servers == []
  1138. assert bind_server._running is False
  1139. class TestSlicerProxyManager:
  1140. """Tests for SlicerProxyManager (proxy mode)."""
  1141. @pytest.fixture
  1142. def proxy_manager(self, tmp_path):
  1143. """Create a SlicerProxyManager instance."""
  1144. from backend.app.services.virtual_printer.tcp_proxy import SlicerProxyManager
  1145. # Create dummy cert files
  1146. cert_path = tmp_path / "cert.pem"
  1147. key_path = tmp_path / "key.pem"
  1148. cert_path.write_text("-----BEGIN CERTIFICATE-----\ntest\n-----END CERTIFICATE-----")
  1149. # Split string to avoid pre-commit hook false positive on test data
  1150. key_path.write_text("-----BEGIN " + "PRIVATE KEY-----\ntest\n-----END " + "PRIVATE KEY-----")
  1151. return SlicerProxyManager(
  1152. target_host="192.168.1.100",
  1153. cert_path=cert_path,
  1154. key_path=key_path,
  1155. )
  1156. def test_proxy_manager_initializes_ports(self, proxy_manager):
  1157. """Verify proxy manager has correct port constants."""
  1158. # FTP proxy uses privileged port 990 to match what Bambu Studio expects
  1159. assert proxy_manager.LOCAL_FTP_PORT == 990
  1160. assert proxy_manager.LOCAL_MQTT_PORT == 8883
  1161. assert proxy_manager.PRINTER_FTP_PORT == 990
  1162. assert proxy_manager.PRINTER_MQTT_PORT == 8883
  1163. assert proxy_manager.PRINTER_FILE_TRANSFER_PORT == 6000
  1164. assert proxy_manager.PRINTER_RTSP_PORT == 322
  1165. # Auxiliary ports: undocumented proprietary ports for A1/P1S etc.
  1166. assert proxy_manager.PRINTER_AUX_PORTS == [2024, 2025, 2026]
  1167. # Bind ports: both 3000 and 3002 for slicer compatibility
  1168. assert proxy_manager.PRINTER_BIND_PORTS == [3000, 3002]
  1169. # FTP data port range for transparent EPSV proxying
  1170. assert proxy_manager.FTP_DATA_PORT_MIN == 50000
  1171. assert proxy_manager.FTP_DATA_PORT_MAX == 50100
  1172. def test_proxy_manager_stores_target_host(self, proxy_manager):
  1173. """Verify proxy manager stores target host."""
  1174. assert proxy_manager.target_host == "192.168.1.100"
  1175. def test_get_status_before_start(self, proxy_manager):
  1176. """Verify get_status returns zeros before start."""
  1177. status = proxy_manager.get_status()
  1178. assert status["running"] is False
  1179. assert status["ftp_connections"] == 0
  1180. assert status["mqtt_connections"] == 0
  1181. @pytest.mark.asyncio
  1182. async def test_proxy_start_creates_transparent_proxies(self, tmp_path):
  1183. """Verify start() uses TCPProxy for FTP/FileTransfer/RTSP and TLSProxy only for MQTT.
  1184. The transparent proxy architecture preserves end-to-end TLS between
  1185. slicer and printer for all protocols except MQTT, which must be
  1186. TLS-terminated to rewrite the printer's IP in MQTT payloads.
  1187. """
  1188. from unittest.mock import AsyncMock, patch
  1189. from backend.app.services.virtual_printer.tcp_proxy import (
  1190. SlicerProxyManager,
  1191. TCPProxy,
  1192. TLSProxy,
  1193. )
  1194. cert_path = tmp_path / "cert.pem"
  1195. key_path = tmp_path / "key.pem"
  1196. cert_path.write_text("-----BEGIN CERTIFICATE-----\ntest\n-----END CERTIFICATE-----")
  1197. key_path.write_text("-----BEGIN " + "PRIVATE KEY-----\ntest\n-----END " + "PRIVATE KEY-----")
  1198. mgr = SlicerProxyManager(
  1199. target_host="192.168.1.100",
  1200. cert_path=cert_path,
  1201. key_path=key_path,
  1202. bind_address="10.0.0.1",
  1203. )
  1204. # Mock asyncio.create_task and asyncio.gather to prevent actual server start
  1205. with (
  1206. patch("asyncio.create_task") as mock_create_task,
  1207. patch("asyncio.gather", new_callable=AsyncMock),
  1208. patch.object(SlicerProxyManager, "_log_activity"),
  1209. ):
  1210. mock_create_task.return_value = MagicMock()
  1211. # start() will create proxies then try to gather tasks — we just
  1212. # need to verify the proxy types after creation.
  1213. # Trigger start but let gather return immediately.
  1214. await mgr.start()
  1215. # FTP, FileTransfer, RTSP should be TCPProxy (transparent)
  1216. assert isinstance(mgr._ftp_proxy, TCPProxy), "FTP should be TCPProxy (transparent)"
  1217. assert isinstance(mgr._file_transfer_proxy, TCPProxy), "FileTransfer should be TCPProxy"
  1218. assert isinstance(mgr._rtsp_proxy, TCPProxy), "RTSP should be TCPProxy"
  1219. # MQTT should be TLSProxy (TLS-terminated for IP rewriting)
  1220. assert isinstance(mgr._mqtt_proxy, TLSProxy), "MQTT should be TLSProxy (TLS-terminated)"
  1221. # Auxiliary ports (2024-2026) should be TCPProxy (transparent)
  1222. assert len(mgr._aux_proxies) == 3, "Should have 3 aux port proxies"
  1223. for ap in mgr._aux_proxies:
  1224. assert isinstance(ap, TCPProxy), "Aux proxies should be TCPProxy"
  1225. assert mgr._aux_proxies[0].listen_port == 2024
  1226. assert mgr._aux_proxies[0].target_port == 2024
  1227. assert mgr._aux_proxies[2].listen_port == 2026
  1228. # FTP data ports should be pre-created as TCPProxy instances
  1229. assert len(mgr._ftp_data_proxies) == 101 # 50000-50100 inclusive
  1230. for dp in mgr._ftp_data_proxies:
  1231. assert isinstance(dp, TCPProxy), "FTP data proxies should be TCPProxy"
  1232. # Verify FTP data proxies target the same port on the printer
  1233. first_dp = mgr._ftp_data_proxies[0]
  1234. assert first_dp.listen_port == 50000
  1235. assert first_dp.target_port == 50000
  1236. assert first_dp.target_host == "192.168.1.100"
  1237. last_dp = mgr._ftp_data_proxies[-1]
  1238. assert last_dp.listen_port == 50100
  1239. assert last_dp.target_port == 50100
  1240. def test_proxy_manager_mqtt_has_ip_rewriting(self, tmp_path):
  1241. """Verify MQTT proxy is configured with IP rewriting when bind_address is set."""
  1242. from backend.app.services.virtual_printer.tcp_proxy import SlicerProxyManager
  1243. cert_path = tmp_path / "cert.pem"
  1244. key_path = tmp_path / "key.pem"
  1245. cert_path.write_text("-----BEGIN CERTIFICATE-----\ntest\n-----END CERTIFICATE-----")
  1246. key_path.write_text("-----BEGIN " + "PRIVATE KEY-----\ntest\n-----END " + "PRIVATE KEY-----")
  1247. mgr = SlicerProxyManager(
  1248. target_host="192.168.1.100",
  1249. cert_path=cert_path,
  1250. key_path=key_path,
  1251. bind_address="10.0.0.1",
  1252. )
  1253. # Before start, proxies are None — verify constructor stores rewrite config
  1254. assert mgr.bind_address == "10.0.0.1"
  1255. assert mgr.target_host == "192.168.1.100"
  1256. class TestSSDPProxy:
  1257. """Tests for SSDPProxy (cross-network SSDP relay)."""
  1258. @pytest.fixture
  1259. def ssdp_proxy(self):
  1260. """Create an SSDPProxy instance."""
  1261. from backend.app.services.virtual_printer.ssdp_server import SSDPProxy
  1262. return SSDPProxy(
  1263. local_interface_ip="192.168.1.100",
  1264. remote_interface_ip="10.0.0.100",
  1265. target_printer_ip="192.168.1.50",
  1266. )
  1267. def test_ssdp_proxy_stores_interface_ips(self, ssdp_proxy):
  1268. """Verify SSDPProxy stores interface IPs correctly."""
  1269. assert ssdp_proxy.local_interface_ip == "192.168.1.100"
  1270. assert ssdp_proxy.remote_interface_ip == "10.0.0.100"
  1271. assert ssdp_proxy.target_printer_ip == "192.168.1.50"
  1272. def test_rewrite_ssdp_location(self, ssdp_proxy):
  1273. """Verify SSDP Location header is rewritten to remote interface IP."""
  1274. original_packet = b"NOTIFY * HTTP/1.1\r\nLocation: 192.168.1.50\r\nDevName.bambu.com: TestPrinter\r\n\r\n"
  1275. rewritten = ssdp_proxy._rewrite_ssdp(original_packet)
  1276. # Location should be changed to remote interface IP
  1277. assert b"Location: 10.0.0.100" in rewritten
  1278. assert b"Location: 192.168.1.50" not in rewritten
  1279. # Other headers should be preserved
  1280. assert b"DevName.bambu.com: TestPrinter" in rewritten
  1281. def test_rewrite_ssdp_location_case_insensitive(self, ssdp_proxy):
  1282. """Verify SSDP Location rewrite is case insensitive."""
  1283. original_packet = b"NOTIFY * HTTP/1.1\r\nlocation: 192.168.1.50\r\n\r\n"
  1284. rewritten = ssdp_proxy._rewrite_ssdp(original_packet)
  1285. assert b"10.0.0.100" in rewritten
  1286. def test_rewrite_ssdp_location_no_match(self, ssdp_proxy):
  1287. """Verify packet without Location header is returned unchanged."""
  1288. original_packet = b"NOTIFY * HTTP/1.1\r\nDevName.bambu.com: Test\r\n\r\n"
  1289. rewritten = ssdp_proxy._rewrite_ssdp(original_packet)
  1290. # No Location header, but _rewrite_ssdp logs a warning and returns as-is
  1291. assert b"DevName.bambu.com: Test" in rewritten
  1292. def test_parse_ssdp_message(self, ssdp_proxy):
  1293. """Verify SSDP message parsing extracts headers."""
  1294. packet = (
  1295. b"NOTIFY * HTTP/1.1\r\n"
  1296. b"Location: 192.168.1.50\r\n"
  1297. b"DevName.bambu.com: TestPrinter\r\n"
  1298. b"DevModel.bambu.com: BL-P001\r\n"
  1299. b"\r\n"
  1300. )
  1301. headers = ssdp_proxy._parse_ssdp_message(packet)
  1302. assert headers["location"] == "192.168.1.50"
  1303. assert headers["devname.bambu.com"] == "TestPrinter"
  1304. assert headers["devmodel.bambu.com"] == "BL-P001"
  1305. class TestVirtualPrinterManagerDirectories:
  1306. """Tests for VirtualPrinterManager directory management."""
  1307. def test_ensure_base_directories_creates_subdirs(self, tmp_path):
  1308. """Verify _ensure_base_directories creates required base directories."""
  1309. from backend.app.services.virtual_printer.manager import VirtualPrinterManager
  1310. manager = VirtualPrinterManager()
  1311. manager._base_dir = tmp_path / "virtual_printer"
  1312. manager._ensure_base_directories()
  1313. assert (tmp_path / "virtual_printer").exists()
  1314. assert (tmp_path / "virtual_printer" / "uploads").exists()
  1315. assert (tmp_path / "virtual_printer" / "certs").exists()
  1316. def test_ensure_base_directories_handles_permission_error(self, tmp_path, caplog):
  1317. """Verify _ensure_base_directories logs error on permission failure."""
  1318. import logging
  1319. from backend.app.services.virtual_printer.manager import VirtualPrinterManager
  1320. manager = VirtualPrinterManager()
  1321. vp_dir = tmp_path / "virtual_printer"
  1322. manager._base_dir = vp_dir
  1323. original_mkdir = type(vp_dir).mkdir
  1324. def mock_mkdir(self, *args, **kwargs):
  1325. if "virtual_printer" in str(self):
  1326. raise PermissionError("Permission denied")
  1327. return original_mkdir(self, *args, **kwargs)
  1328. with caplog.at_level(logging.ERROR), patch.object(type(vp_dir), "mkdir", mock_mkdir):
  1329. manager._ensure_base_directories()
  1330. assert "Permission denied" in caplog.text
  1331. def test_instance_creates_per_vp_directories(self, tmp_path):
  1332. """Verify VirtualPrinterInstance creates per-VP upload and cert dirs."""
  1333. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  1334. VirtualPrinterInstance(
  1335. vp_id=42,
  1336. name="Test",
  1337. mode="immediate",
  1338. model="C11",
  1339. access_code="12345678",
  1340. serial_suffix="391800042",
  1341. base_dir=tmp_path,
  1342. )
  1343. assert (tmp_path / "uploads" / "42").exists()
  1344. assert (tmp_path / "uploads" / "42" / "cache").exists()
  1345. assert (tmp_path / "certs" / "42").exists()
  1346. class TestVirtualPrinterInstanceProxyMode:
  1347. """Tests for VirtualPrinterInstance proxy mode."""
  1348. @pytest.fixture
  1349. def proxy_instance(self, tmp_path):
  1350. """Create a proxy-mode VirtualPrinterInstance."""
  1351. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  1352. return VirtualPrinterInstance(
  1353. vp_id=10,
  1354. name="ProxyTest",
  1355. mode="proxy",
  1356. model="C11",
  1357. access_code="",
  1358. serial_suffix="391800010",
  1359. target_printer_ip="192.168.1.100",
  1360. target_printer_serial="01P00A000000001",
  1361. base_dir=tmp_path,
  1362. )
  1363. def test_proxy_instance_properties(self, proxy_instance):
  1364. """Verify proxy instance stores config correctly."""
  1365. assert proxy_instance.is_proxy is True
  1366. assert proxy_instance.mode == "proxy"
  1367. assert proxy_instance.target_printer_ip == "192.168.1.100"
  1368. assert proxy_instance.target_printer_serial == "01P00A000000001"
  1369. def test_proxy_instance_does_not_require_access_code(self, proxy_instance):
  1370. """Verify proxy mode can have empty access code."""
  1371. assert proxy_instance.access_code == ""
  1372. def test_get_status_proxy_includes_proxy_fields(self, proxy_instance):
  1373. """Verify get_status includes proxy fields when proxy is active."""
  1374. mock_proxy = MagicMock()
  1375. mock_proxy.get_status.return_value = {
  1376. "running": True,
  1377. "ftp_port": 990,
  1378. "mqtt_port": 8883,
  1379. "ftp_connections": 1,
  1380. "mqtt_connections": 2,
  1381. "target_host": "192.168.1.100",
  1382. }
  1383. proxy_instance._proxy = mock_proxy
  1384. status = proxy_instance.get_status()
  1385. assert "proxy" in status
  1386. assert status["proxy"]["ftp_port"] == 990
  1387. assert status["proxy"]["mqtt_connections"] == 2
  1388. def test_proxy_instance_stores_remote_interface(self, tmp_path):
  1389. """Verify proxy instance stores remote_interface_ip."""
  1390. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  1391. inst = VirtualPrinterInstance(
  1392. vp_id=11,
  1393. name="Proxy2",
  1394. mode="proxy",
  1395. model="C11",
  1396. access_code="",
  1397. serial_suffix="391800011",
  1398. target_printer_ip="192.168.1.100",
  1399. remote_interface_ip="10.0.0.50",
  1400. base_dir=tmp_path,
  1401. )
  1402. assert inst.remote_interface_ip == "10.0.0.50"
  1403. class TestVirtualPrinterInstanceIPOverride:
  1404. """Tests for remote_interface_ip and bind_ip on VirtualPrinterInstance."""
  1405. @pytest.fixture
  1406. def instance_with_remote_ip(self, tmp_path):
  1407. """Create an instance with remote_interface_ip set."""
  1408. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  1409. return VirtualPrinterInstance(
  1410. vp_id=20,
  1411. name="IPTest",
  1412. mode="immediate",
  1413. model="BL-P001",
  1414. access_code="12345678",
  1415. serial_suffix="391800020",
  1416. bind_ip="192.168.1.50",
  1417. remote_interface_ip="10.0.0.50",
  1418. base_dir=tmp_path,
  1419. )
  1420. def test_instance_stores_bind_ip(self, instance_with_remote_ip):
  1421. """Verify bind_ip is stored."""
  1422. assert instance_with_remote_ip.bind_ip == "192.168.1.50"
  1423. def test_instance_stores_remote_interface_ip(self, instance_with_remote_ip):
  1424. """Verify remote_interface_ip is stored."""
  1425. assert instance_with_remote_ip.remote_interface_ip == "10.0.0.50"
  1426. def test_generate_certificates_includes_remote_and_bind_ip(self, instance_with_remote_ip):
  1427. """Verify generate_certificates passes remote_interface_ip and bind_ip as SANs."""
  1428. with (
  1429. patch.object(instance_with_remote_ip._cert_service, "delete_printer_certificate"),
  1430. patch.object(
  1431. instance_with_remote_ip._cert_service,
  1432. "generate_certificates",
  1433. return_value=(Path("/tmp/cert.pem"), Path("/tmp/key.pem")), # nosec B108
  1434. ) as mock_gen,
  1435. ):
  1436. instance_with_remote_ip.generate_certificates()
  1437. mock_gen.assert_called_once_with(additional_ips=["10.0.0.50", "192.168.1.50"])
  1438. def test_generate_certificates_no_remote_ip(self, tmp_path):
  1439. """Verify generate_certificates passes only bind_ip when no remote_interface_ip."""
  1440. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  1441. inst = VirtualPrinterInstance(
  1442. vp_id=21,
  1443. name="NoRemote",
  1444. mode="immediate",
  1445. model="BL-P001",
  1446. access_code="12345678",
  1447. serial_suffix="391800021",
  1448. bind_ip="192.168.1.50",
  1449. base_dir=tmp_path,
  1450. )
  1451. with (
  1452. patch.object(inst._cert_service, "delete_printer_certificate"),
  1453. patch.object(
  1454. inst._cert_service,
  1455. "generate_certificates",
  1456. return_value=(Path("/tmp/cert.pem"), Path("/tmp/key.pem")), # nosec B108
  1457. ) as mock_gen,
  1458. ):
  1459. inst.generate_certificates()
  1460. mock_gen.assert_called_once_with(additional_ips=["192.168.1.50"])
  1461. def test_generate_certificates_no_ips(self, tmp_path):
  1462. """Verify generate_certificates passes None when no IPs configured."""
  1463. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  1464. inst = VirtualPrinterInstance(
  1465. vp_id=22,
  1466. name="NoIPs",
  1467. mode="immediate",
  1468. model="BL-P001",
  1469. access_code="12345678",
  1470. serial_suffix="391800022",
  1471. base_dir=tmp_path,
  1472. )
  1473. with (
  1474. patch.object(inst._cert_service, "delete_printer_certificate"),
  1475. patch.object(
  1476. inst._cert_service,
  1477. "generate_certificates",
  1478. return_value=(Path("/tmp/cert.pem"), Path("/tmp/key.pem")), # nosec B108
  1479. ) as mock_gen,
  1480. ):
  1481. inst.generate_certificates()
  1482. mock_gen.assert_called_once_with(additional_ips=None)
  1483. class TestBindServer:
  1484. """Tests for the BindServer (port 3002 bind/detect protocol)."""
  1485. @pytest.fixture
  1486. def bind_server(self):
  1487. """Create a BindServer instance."""
  1488. from backend.app.services.virtual_printer.bind_server import BindServer
  1489. return BindServer(
  1490. serial="01S00C000000001",
  1491. model="BL-P001",
  1492. name="Bambuddy",
  1493. )
  1494. def test_build_frame(self, bind_server):
  1495. """Verify frame format: 0xA5A5 + len(u16le) + JSON + 0xA7A7."""
  1496. payload = {"login": {"command": "detect"}}
  1497. frame = bind_server._build_frame(payload)
  1498. assert frame[:2] == b"\xa5\xa5"
  1499. assert frame[-2:] == b"\xa7\xa7"
  1500. # Length field is total message size
  1501. import struct
  1502. total_len = struct.unpack_from("<H", frame, 2)[0]
  1503. assert total_len == len(frame)
  1504. # JSON payload is between header and trailer
  1505. import json
  1506. json_bytes = frame[4:-2]
  1507. parsed = json.loads(json_bytes)
  1508. assert parsed == payload
  1509. def test_parse_frame_valid(self, bind_server):
  1510. """Verify valid frame parsing."""
  1511. frame = bind_server._build_frame({"login": {"command": "detect", "sequence_id": "20000"}})
  1512. result = bind_server._parse_frame(frame)
  1513. assert result is not None
  1514. assert result["login"]["command"] == "detect"
  1515. assert result["login"]["sequence_id"] == "20000"
  1516. def test_parse_frame_invalid_header(self, bind_server):
  1517. """Verify invalid header returns None."""
  1518. frame = b"\xb5\xb5\x10\x00" + b'{"login":{}}' + b"\xa7\xa7"
  1519. assert bind_server._parse_frame(frame) is None
  1520. def test_parse_frame_invalid_trailer(self, bind_server):
  1521. """Verify invalid trailer returns None."""
  1522. frame = b"\xa5\xa5\x10\x00" + b'{"login":{}}' + b"\xb7\xb7"
  1523. assert bind_server._parse_frame(frame) is None
  1524. def test_parse_frame_too_short(self, bind_server):
  1525. """Verify short data returns None."""
  1526. assert bind_server._parse_frame(b"\xa5\xa5\x00") is None
  1527. assert bind_server._parse_frame(b"") is None
  1528. def test_parse_frame_invalid_json(self, bind_server):
  1529. """Verify invalid JSON returns None."""
  1530. import struct
  1531. bad_json = b"not json"
  1532. total_len = 4 + len(bad_json) + 2
  1533. frame = b"\xa5\xa5" + struct.pack("<H", total_len) + bad_json + b"\xa7\xa7"
  1534. assert bind_server._parse_frame(frame) is None
  1535. def test_build_frame_roundtrip(self, bind_server):
  1536. """Verify build then parse roundtrip."""
  1537. original = {"login": {"bind": "free", "command": "detect", "id": "01S00C000000001"}}
  1538. frame = bind_server._build_frame(original)
  1539. parsed = bind_server._parse_frame(frame)
  1540. assert parsed == original
  1541. def test_bind_server_stores_config(self, bind_server):
  1542. """Verify config is stored correctly."""
  1543. assert bind_server.serial == "01S00C000000001"
  1544. assert bind_server.model == "BL-P001"
  1545. assert bind_server.name == "Bambuddy"
  1546. assert bind_server.version == "01.00.00.00"
  1547. def test_bind_server_custom_version(self):
  1548. """Verify custom firmware version is stored."""
  1549. from backend.app.services.virtual_printer.bind_server import BindServer
  1550. server = BindServer(
  1551. serial="01S00C000000001",
  1552. model="BL-P001",
  1553. name="Bambuddy",
  1554. version="01.09.00.10",
  1555. )
  1556. assert server.version == "01.09.00.10"
  1557. def test_bind_ports_includes_both(self):
  1558. """Verify BIND_PORTS includes both 3000 and 3002 for slicer compatibility."""
  1559. from backend.app.services.virtual_printer.bind_server import BIND_PORTS
  1560. assert 3000 in BIND_PORTS
  1561. assert 3002 in BIND_PORTS
  1562. def test_bind_server_initializes_empty_servers_list(self, bind_server):
  1563. """Verify bind server starts with empty servers list."""
  1564. assert bind_server._servers == []
  1565. assert bind_server._running is False
  1566. @pytest.mark.asyncio
  1567. async def test_start_server_creates_bind_server(self, tmp_path):
  1568. """Verify start_server creates BindServer with correct params."""
  1569. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  1570. inst = VirtualPrinterInstance(
  1571. vp_id=99,
  1572. name="Bambuddy",
  1573. mode="immediate",
  1574. model="BL-P001",
  1575. access_code="12345678",
  1576. serial_suffix="391800099",
  1577. bind_ip="192.168.1.50",
  1578. base_dir=tmp_path,
  1579. )
  1580. with (
  1581. patch("backend.app.services.virtual_printer.manager.VirtualPrinterSSDPServer"),
  1582. patch("backend.app.services.virtual_printer.manager.VirtualPrinterFTPServer"),
  1583. patch("backend.app.services.virtual_printer.manager.SimpleMQTTServer"),
  1584. patch("backend.app.services.virtual_printer.manager.BindServer") as mock_bind_cls,
  1585. patch.object(inst._cert_service, "delete_printer_certificate"),
  1586. patch.object(
  1587. inst._cert_service,
  1588. "generate_certificates",
  1589. return_value=(Path("/tmp/cert.pem"), Path("/tmp/key.pem")), # nosec B108
  1590. ),
  1591. ):
  1592. await inst.start_server()
  1593. mock_bind_cls.assert_called_once_with(
  1594. serial=inst.serial,
  1595. model="BL-P001",
  1596. name="Bambuddy",
  1597. bind_address="192.168.1.50",
  1598. cert_path=Path("/tmp/cert.pem"), # nosec B108
  1599. key_path=Path("/tmp/key.pem"), # nosec B108
  1600. )
  1601. class TestResolveModelCodes:
  1602. """Tests for model code resolution (display name → SSDP code)."""
  1603. def test_display_name_to_model_code_maps_all_models(self):
  1604. """Verify reverse mapping covers all VIRTUAL_PRINTER_MODELS entries."""
  1605. from backend.app.services.virtual_printer.manager import DISPLAY_NAME_TO_MODEL_CODE, VIRTUAL_PRINTER_MODELS
  1606. for _code, display_name in VIRTUAL_PRINTER_MODELS.items():
  1607. assert display_name in DISPLAY_NAME_TO_MODEL_CODE
  1608. # For non-duplicate display names, should map back to a valid code
  1609. assert DISPLAY_NAME_TO_MODEL_CODE[display_name] in VIRTUAL_PRINTER_MODELS
  1610. def test_resolve_printer_model_with_ssdp_code(self):
  1611. """SSDP codes pass through unchanged."""
  1612. from backend.app.api.routes.virtual_printers import _resolve_printer_model
  1613. assert _resolve_printer_model("BL-P001") == "BL-P001"
  1614. assert _resolve_printer_model("O1D") == "O1D"
  1615. assert _resolve_printer_model("N2S") == "N2S"
  1616. def test_resolve_printer_model_with_display_name(self):
  1617. """Display names resolve to SSDP codes."""
  1618. from backend.app.api.routes.virtual_printers import _resolve_printer_model
  1619. assert _resolve_printer_model("X1C") == "BL-P001"
  1620. assert _resolve_printer_model("H2D") == "O1D"
  1621. assert _resolve_printer_model("A1") == "N2S"
  1622. assert _resolve_printer_model("P1S") == "C12"
  1623. def test_resolve_printer_model_with_none_or_unknown(self):
  1624. """None and unknown values return None."""
  1625. from backend.app.api.routes.virtual_printers import _resolve_printer_model
  1626. assert _resolve_printer_model(None) is None
  1627. assert _resolve_printer_model("UnknownModel") is None
  1628. class TestMqttIpRewrite:
  1629. """Tests for TLSProxy._rewrite_mqtt_ip() MQTT packet IP rewriting."""
  1630. @staticmethod
  1631. def _build_mqtt_publish(topic: str, payload: bytes) -> bytes:
  1632. """Build a minimal MQTT PUBLISH packet."""
  1633. # PUBLISH fixed header: type 3, no flags
  1634. topic_bytes = topic.encode("utf-8")
  1635. # Variable header: topic length (2 bytes) + topic
  1636. var_header = len(topic_bytes).to_bytes(2, "big") + topic_bytes
  1637. body = var_header + payload
  1638. # Encode remaining length
  1639. remaining = len(body)
  1640. header = bytearray([0x30]) # PUBLISH, QoS 0
  1641. while True:
  1642. encoded_byte = remaining % 128
  1643. remaining //= 128
  1644. if remaining > 0:
  1645. encoded_byte |= 0x80
  1646. header.append(encoded_byte)
  1647. if remaining == 0:
  1648. break
  1649. return bytes(header) + body
  1650. @staticmethod
  1651. def _build_mqtt_pingreq() -> bytes:
  1652. """Build an MQTT PINGREQ packet (2 bytes, no payload)."""
  1653. return b"\xc0\x00"
  1654. def test_rewrite_ip_in_publish(self):
  1655. """IP string in PUBLISH payload is rewritten."""
  1656. from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
  1657. payload = b'{"rtsp_url":"rtsps://192.168.1.100:322/live"}'
  1658. packet = self._build_mqtt_publish("device/status", payload)
  1659. result, buf = TLSProxy._rewrite_mqtt_ip(packet, b"192.168.1.100", b"10.0.0.1", bytearray())
  1660. assert b"10.0.0.1" in result
  1661. assert b"192.168.1.100" not in result
  1662. def test_no_rewrite_when_ip_absent(self):
  1663. """Packets without the target IP are passed through unchanged."""
  1664. from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
  1665. payload = b'{"status":"idle"}'
  1666. packet = self._build_mqtt_publish("device/status", payload)
  1667. result, buf = TLSProxy._rewrite_mqtt_ip(packet, b"192.168.1.100", b"10.0.0.1", bytearray())
  1668. assert result == packet
  1669. def test_non_publish_packets_unchanged(self):
  1670. """Non-PUBLISH packets (e.g. PINGREQ) are never rewritten."""
  1671. from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
  1672. pingreq = self._build_mqtt_pingreq()
  1673. result, buf = TLSProxy._rewrite_mqtt_ip(pingreq, b"192.168.1.100", b"10.0.0.1", bytearray())
  1674. assert result == pingreq
  1675. def test_rewrite_preserves_packet_framing(self):
  1676. """Rewritten packet has valid MQTT remaining length."""
  1677. from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
  1678. # Use IPs of different lengths to test length re-encoding
  1679. old_ip = b"192.168.255.133" # 15 bytes
  1680. new_ip = b"10.0.0.1" # 8 bytes
  1681. payload = b'{"ip":"192.168.255.133"}'
  1682. packet = self._build_mqtt_publish("device/status", payload)
  1683. result, buf = TLSProxy._rewrite_mqtt_ip(packet, old_ip, new_ip, bytearray())
  1684. # Parse the result to verify framing
  1685. assert result[0] == 0x30 # PUBLISH header byte
  1686. # Decode remaining length
  1687. pos = 1
  1688. remaining = 0
  1689. multiplier = 1
  1690. while True:
  1691. b = result[pos]
  1692. pos += 1
  1693. remaining += (b & 0x7F) * multiplier
  1694. multiplier *= 128
  1695. if (b & 0x80) == 0:
  1696. break
  1697. # Remaining length should match actual data
  1698. assert pos + remaining == len(result)
  1699. assert new_ip in result
  1700. def test_incomplete_packet_buffered(self):
  1701. """Incomplete packet at end of chunk is buffered for next call."""
  1702. from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
  1703. payload = b'{"ip":"192.168.1.100"}'
  1704. packet = self._build_mqtt_publish("device/status", payload)
  1705. # Split packet in the middle
  1706. half = len(packet) // 2
  1707. chunk1 = packet[:half]
  1708. chunk2 = packet[half:]
  1709. result1, buf = TLSProxy._rewrite_mqtt_ip(chunk1, b"192.168.1.100", b"10.0.0.1", bytearray())
  1710. # First chunk should be buffered (incomplete packet)
  1711. assert len(buf) > 0
  1712. result2, buf = TLSProxy._rewrite_mqtt_ip(chunk2, b"192.168.1.100", b"10.0.0.1", buf)
  1713. # Second chunk completes the packet, IP should be rewritten
  1714. combined = result1 + result2
  1715. assert b"10.0.0.1" in combined
  1716. assert b"192.168.1.100" not in combined
  1717. def test_multiple_packets_in_one_chunk(self):
  1718. """Multiple MQTT packets in a single chunk are all processed."""
  1719. from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
  1720. payload1 = b'{"ip":"192.168.1.100"}'
  1721. payload2 = b'{"other":"data"}'
  1722. packet1 = self._build_mqtt_publish("topic1", payload1)
  1723. packet2 = self._build_mqtt_publish("topic2", payload2)
  1724. combined = packet1 + packet2
  1725. result, buf = TLSProxy._rewrite_mqtt_ip(combined, b"192.168.1.100", b"10.0.0.1", bytearray())
  1726. assert b"10.0.0.1" in result
  1727. assert b"192.168.1.100" not in result
  1728. # Second packet should still be present
  1729. assert b"other" in result
  1730. def test_extra_replacements(self):
  1731. """Extra replacement pairs (e.g. integer IP) are also applied."""
  1732. from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
  1733. payload = b'{"net":{"info":[{"ip":2248124608}]}}'
  1734. packet = self._build_mqtt_publish("device/status", payload)
  1735. result, buf = TLSProxy._rewrite_mqtt_ip(
  1736. packet,
  1737. b"NOMATCH",
  1738. b"NOREPLACE",
  1739. bytearray(),
  1740. extra_replacements=[(b"2248124608", b"285190336")],
  1741. )
  1742. assert b"285190336" in result
  1743. assert b"2248124608" not in result
  1744. class TestIpToLeIntBytes:
  1745. """Tests for TLSProxy._ip_to_le_int_bytes() integer IP conversion."""
  1746. def test_converts_ip_to_le_int(self):
  1747. from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
  1748. assert TLSProxy._ip_to_le_int_bytes("192.168.255.133") == b"2248124608"
  1749. assert TLSProxy._ip_to_le_int_bytes("192.168.255.16") == b"285190336"
  1750. assert TLSProxy._ip_to_le_int_bytes("10.0.0.1") == b"16777226"
  1751. def test_roundtrip(self):
  1752. """Verify the integer converts back to the correct IP."""
  1753. import struct
  1754. from backend.app.services.virtual_printer.tcp_proxy import TLSProxy
  1755. for ip in ["192.168.1.1", "10.0.0.1", "172.16.0.100", "192.168.255.133"]:
  1756. le_int = int(TLSProxy._ip_to_le_int_bytes(ip))
  1757. parts = ip.split(".")
  1758. expected = struct.unpack("<I", bytes(int(p) for p in parts))[0]
  1759. assert le_int == expected
  1760. class TestSSDPProxyName:
  1761. """Tests for SSDPProxy VP name rewriting."""
  1762. @pytest.fixture
  1763. def ssdp_proxy_with_name(self):
  1764. from backend.app.services.virtual_printer.ssdp_server import SSDPProxy
  1765. return SSDPProxy(
  1766. local_interface_ip="192.168.1.100",
  1767. remote_interface_ip="10.0.0.100",
  1768. target_printer_ip="192.168.1.50",
  1769. name="H2D-1 Proxy",
  1770. )
  1771. @pytest.fixture
  1772. def ssdp_proxy_without_name(self):
  1773. from backend.app.services.virtual_printer.ssdp_server import SSDPProxy
  1774. return SSDPProxy(
  1775. local_interface_ip="192.168.1.100",
  1776. remote_interface_ip="10.0.0.100",
  1777. target_printer_ip="192.168.1.50",
  1778. )
  1779. def test_rewrite_uses_configured_name(self, ssdp_proxy_with_name):
  1780. """When name is set, DevName is replaced entirely."""
  1781. 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"
  1782. rewritten = ssdp_proxy_with_name._rewrite_ssdp(packet)
  1783. assert b"DevName.bambu.com: H2D-1 Proxy" in rewritten
  1784. assert b"RealPrinter" not in rewritten
  1785. def test_rewrite_appends_proxy_without_name(self, ssdp_proxy_without_name):
  1786. """When no name is set, ' - Proxy' is appended to the real name."""
  1787. 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"
  1788. rewritten = ssdp_proxy_without_name._rewrite_ssdp(packet)
  1789. assert b"DevName.bambu.com: RealPrinter - Proxy" in rewritten