test_virtual_printer.py 73 KB

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