test_virtual_printer.py 44 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222
  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="3DPrinter-X1-Carbon",
  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. class TestVirtualPrinterManager:
  126. """Tests for VirtualPrinterManager orchestrator."""
  127. @pytest.fixture
  128. def manager(self):
  129. """Create a VirtualPrinterManager instance."""
  130. from backend.app.services.virtual_printer.manager import VirtualPrinterManager
  131. return VirtualPrinterManager()
  132. def test_manager_starts_empty(self, manager):
  133. """Verify manager starts with no instances."""
  134. assert len(manager._instances) == 0
  135. assert manager.is_enabled is False
  136. def test_manager_get_status_empty(self, manager):
  137. """Verify get_status returns disabled state when no instances."""
  138. status = manager.get_status()
  139. assert status["enabled"] is False
  140. assert status["running"] is False
  141. assert status["mode"] == "immediate"
  142. def test_manager_is_enabled_with_instance(self, manager, tmp_path):
  143. """Verify is_enabled is True when instances exist."""
  144. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  145. inst = VirtualPrinterInstance(
  146. vp_id=1,
  147. name="Test",
  148. mode="immediate",
  149. model="C11",
  150. access_code="12345678",
  151. serial_suffix="391800001",
  152. base_dir=tmp_path,
  153. )
  154. manager._instances[1] = inst
  155. assert manager.is_enabled is True
  156. @pytest.mark.asyncio
  157. async def test_manager_remove_instance_server(self, manager, tmp_path):
  158. """Verify remove_instance stops and removes a server-mode instance."""
  159. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  160. inst = VirtualPrinterInstance(
  161. vp_id=1,
  162. name="Test",
  163. mode="immediate",
  164. model="C11",
  165. access_code="12345678",
  166. serial_suffix="391800001",
  167. base_dir=tmp_path,
  168. )
  169. inst.stop_server = AsyncMock()
  170. manager._instances[1] = inst
  171. await manager.remove_instance(1)
  172. assert 1 not in manager._instances
  173. inst.stop_server.assert_called_once()
  174. @pytest.mark.asyncio
  175. async def test_manager_remove_instance_proxy(self, manager, tmp_path):
  176. """Verify remove_instance stops proxy-mode instance."""
  177. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  178. inst = VirtualPrinterInstance(
  179. vp_id=2,
  180. name="Proxy",
  181. mode="proxy",
  182. model="C11",
  183. access_code="",
  184. serial_suffix="391800002",
  185. target_printer_ip="192.168.1.100",
  186. base_dir=tmp_path,
  187. )
  188. inst.stop_proxy = AsyncMock()
  189. manager._instances[2] = inst
  190. await manager.remove_instance(2)
  191. assert 2 not in manager._instances
  192. inst.stop_proxy.assert_called_once()
  193. def test_manager_get_status_with_instance(self, manager, tmp_path):
  194. """Verify legacy get_status returns first instance data."""
  195. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  196. inst = VirtualPrinterInstance(
  197. vp_id=1,
  198. name="Bambuddy",
  199. mode="immediate",
  200. model="C11",
  201. access_code="12345678",
  202. serial_suffix="391800001",
  203. base_dir=tmp_path,
  204. )
  205. mock_task = MagicMock(done=MagicMock(return_value=False))
  206. inst._tasks = [mock_task]
  207. inst._pending_files = {"file1.3mf": Path("/tmp/file1.3mf")} # nosec B108
  208. manager._instances[1] = inst
  209. status = manager.get_status()
  210. assert status["enabled"] is True
  211. assert status["running"] is True
  212. assert status["mode"] == "immediate"
  213. assert status["name"] == "Bambuddy"
  214. assert status["serial"] == "01S00A391800001"
  215. assert status["model"] == "C11"
  216. assert status["model_name"] == "P1P"
  217. assert status["pending_files"] == 1
  218. def test_manager_get_all_status(self, manager, tmp_path):
  219. """Verify get_all_status returns status for all instances."""
  220. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  221. for i in range(1, 3):
  222. inst = VirtualPrinterInstance(
  223. vp_id=i,
  224. name=f"VP{i}",
  225. mode="immediate",
  226. model="C11",
  227. access_code="12345678",
  228. serial_suffix=f"39180000{i}",
  229. base_dir=tmp_path,
  230. )
  231. manager._instances[i] = inst
  232. statuses = manager.get_all_status()
  233. assert len(statuses) == 2
  234. assert statuses[0]["name"] == "VP1"
  235. assert statuses[1]["name"] == "VP2"
  236. @pytest.mark.asyncio
  237. async def test_manager_stop_all(self, manager, tmp_path):
  238. """Verify stop_all removes all instances."""
  239. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  240. for i in range(1, 3):
  241. inst = VirtualPrinterInstance(
  242. vp_id=i,
  243. name=f"VP{i}",
  244. mode="immediate",
  245. model="C11",
  246. access_code="12345678",
  247. serial_suffix=f"39180000{i}",
  248. base_dir=tmp_path,
  249. )
  250. inst.stop_server = AsyncMock()
  251. manager._instances[i] = inst
  252. await manager.stop_all()
  253. assert len(manager._instances) == 0
  254. class TestFTPSession:
  255. """Tests for FTP session handling."""
  256. @pytest.fixture
  257. def mock_reader(self):
  258. """Create a mock StreamReader."""
  259. reader = AsyncMock()
  260. return reader
  261. @pytest.fixture
  262. def mock_writer(self):
  263. """Create a mock StreamWriter."""
  264. writer = MagicMock()
  265. writer.get_extra_info = MagicMock(return_value=("192.168.1.100", 12345))
  266. writer.write = MagicMock()
  267. writer.drain = AsyncMock()
  268. writer.close = MagicMock()
  269. writer.wait_closed = AsyncMock()
  270. writer.is_closing = MagicMock(return_value=False)
  271. return writer
  272. @pytest.fixture
  273. def ssl_context(self):
  274. """Create a mock SSL context."""
  275. return MagicMock()
  276. @pytest.fixture
  277. def session(self, mock_reader, mock_writer, ssl_context, tmp_path):
  278. """Create an FTPSession instance."""
  279. from backend.app.services.virtual_printer.ftp_server import FTPSession
  280. return FTPSession(
  281. reader=mock_reader,
  282. writer=mock_writer,
  283. upload_dir=tmp_path,
  284. access_code="12345678",
  285. ssl_context=ssl_context,
  286. on_file_received=None,
  287. )
  288. # ========================================================================
  289. # Tests for authentication
  290. # ========================================================================
  291. @pytest.mark.asyncio
  292. async def test_user_command_accepts_bblp(self, session):
  293. """Verify USER command accepts bblp user."""
  294. await session.cmd_USER("bblp")
  295. assert session.username == "bblp"
  296. @pytest.mark.asyncio
  297. async def test_pass_command_authenticates(self, session):
  298. """Verify PASS command authenticates with correct code."""
  299. session.username = "bblp"
  300. await session.cmd_PASS("12345678")
  301. assert session.authenticated is True
  302. @pytest.mark.asyncio
  303. async def test_pass_command_rejects_wrong_code(self, session):
  304. """Verify PASS command rejects wrong access code."""
  305. session.username = "bblp"
  306. await session.cmd_PASS("wrongcode")
  307. assert session.authenticated is False
  308. # ========================================================================
  309. # Tests for FTP commands
  310. # ========================================================================
  311. @pytest.mark.asyncio
  312. async def test_syst_command(self, session):
  313. """Verify SYST returns UNIX type."""
  314. await session.cmd_SYST("")
  315. session.writer.write.assert_called()
  316. call_args = session.writer.write.call_args[0][0].decode()
  317. assert "215" in call_args
  318. assert "UNIX" in call_args
  319. @pytest.mark.asyncio
  320. async def test_pwd_command_requires_auth(self, session):
  321. """Verify PWD requires authentication."""
  322. session.authenticated = False
  323. await session.cmd_PWD("")
  324. call_args = session.writer.write.call_args[0][0].decode()
  325. assert "530" in call_args
  326. @pytest.mark.asyncio
  327. async def test_pwd_command_when_authenticated(self, session):
  328. """Verify PWD returns root directory when authenticated."""
  329. session.authenticated = True
  330. await session.cmd_PWD("")
  331. call_args = session.writer.write.call_args[0][0].decode()
  332. assert "257" in call_args
  333. @pytest.mark.asyncio
  334. async def test_type_command_sets_binary(self, session):
  335. """Verify TYPE I sets binary mode."""
  336. session.authenticated = True
  337. await session.cmd_TYPE("I")
  338. assert session.transfer_type == "I"
  339. @pytest.mark.asyncio
  340. async def test_pbsz_command(self, session):
  341. """Verify PBSZ returns success."""
  342. await session.cmd_PBSZ("0")
  343. call_args = session.writer.write.call_args[0][0].decode()
  344. assert "200" in call_args
  345. @pytest.mark.asyncio
  346. async def test_prot_command_accepts_p(self, session):
  347. """Verify PROT P is accepted."""
  348. await session.cmd_PROT("P")
  349. call_args = session.writer.write.call_args[0][0].decode()
  350. assert "200" in call_args
  351. @pytest.mark.asyncio
  352. async def test_quit_command(self, session):
  353. """Verify QUIT sends goodbye and raises CancelledError."""
  354. with pytest.raises(asyncio.CancelledError):
  355. await session.cmd_QUIT("")
  356. class TestSSDPServer:
  357. """Tests for Virtual Printer SSDP server."""
  358. @pytest.fixture
  359. def ssdp_server(self):
  360. """Create a VirtualPrinterSSDPServer instance."""
  361. from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
  362. return VirtualPrinterSSDPServer(
  363. serial="TEST123",
  364. name="TestPrinter",
  365. model="BL-P001",
  366. )
  367. # ========================================================================
  368. # Tests for SSDP response
  369. # ========================================================================
  370. def test_build_notify_message(self, ssdp_server):
  371. """Verify NOTIFY packet contains required headers."""
  372. # Set a known IP for testing
  373. ssdp_server._local_ip = "192.168.1.100"
  374. message = ssdp_server._build_notify_message()
  375. assert b"NOTIFY" in message
  376. assert b"DevName.bambu.com: TestPrinter" in message
  377. assert b"USN: TEST123" in message
  378. def test_build_response_message(self, ssdp_server):
  379. """Verify response packet contains required headers."""
  380. # Set a known IP for testing
  381. ssdp_server._local_ip = "192.168.1.100"
  382. message = ssdp_server._build_response_message()
  383. assert b"HTTP/1.1 200 OK" in message
  384. assert b"DevName.bambu.com: TestPrinter" in message
  385. assert b"USN: TEST123" in message
  386. def test_ssdp_server_uses_correct_model(self, ssdp_server):
  387. """Verify SSDP server uses the provided model."""
  388. ssdp_server._local_ip = "192.168.1.100"
  389. message = ssdp_server._build_notify_message()
  390. assert b"DevModel.bambu.com: BL-P001" in message
  391. # ========================================================================
  392. # Tests for advertise_ip parameter
  393. # ========================================================================
  394. def test_advertise_ip_sets_local_ip(self):
  395. """Verify advertise_ip overrides auto-detection."""
  396. from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
  397. server = VirtualPrinterSSDPServer(
  398. serial="TEST123",
  399. name="TestPrinter",
  400. model="BL-P001",
  401. advertise_ip="10.0.0.50",
  402. )
  403. assert server._local_ip == "10.0.0.50"
  404. def test_advertise_ip_empty_string_uses_auto_detect(self):
  405. """Verify empty advertise_ip falls back to auto-detection."""
  406. from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
  407. server = VirtualPrinterSSDPServer(
  408. serial="TEST123",
  409. name="TestPrinter",
  410. model="BL-P001",
  411. advertise_ip="",
  412. )
  413. assert server._local_ip is None
  414. def test_advertise_ip_in_notify_message(self):
  415. """Verify NOTIFY message uses the advertise_ip."""
  416. from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
  417. server = VirtualPrinterSSDPServer(
  418. serial="TEST123",
  419. name="TestPrinter",
  420. model="BL-P001",
  421. advertise_ip="10.0.0.50",
  422. )
  423. message = server._build_notify_message()
  424. assert b"Location: 10.0.0.50" in message
  425. def test_advertise_ip_in_response_message(self):
  426. """Verify M-SEARCH response uses the advertise_ip."""
  427. from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
  428. server = VirtualPrinterSSDPServer(
  429. serial="TEST123",
  430. name="TestPrinter",
  431. model="BL-P001",
  432. advertise_ip="10.0.0.50",
  433. )
  434. message = server._build_response_message()
  435. assert b"Location: 10.0.0.50" in message
  436. def test_default_no_advertise_ip(self):
  437. """Verify default constructor has None local_ip (auto-detect)."""
  438. from backend.app.services.virtual_printer.ssdp_server import VirtualPrinterSSDPServer
  439. server = VirtualPrinterSSDPServer()
  440. assert server._local_ip is None
  441. class TestCertificateService:
  442. """Tests for TLS certificate generation."""
  443. @pytest.fixture
  444. def cert_service(self, tmp_path):
  445. """Create a CertificateService instance."""
  446. from backend.app.services.virtual_printer.certificate import CertificateService
  447. return CertificateService(cert_dir=tmp_path, serial="TEST123")
  448. def test_generate_certificates(self, cert_service, tmp_path):
  449. """Verify certificates are generated correctly."""
  450. cert_path, key_path = cert_service.generate_certificates()
  451. assert cert_path.exists()
  452. assert key_path.exists()
  453. # Verify certificate content
  454. cert_content = cert_path.read_text()
  455. assert "BEGIN CERTIFICATE" in cert_content
  456. key_content = key_path.read_text()
  457. assert "BEGIN" in key_content and "KEY" in key_content
  458. def test_certificates_reused_if_exist(self, cert_service):
  459. """Verify existing certificates are reused."""
  460. # First generation
  461. cert_path1, key_path1 = cert_service.generate_certificates()
  462. mtime1 = cert_path1.stat().st_mtime
  463. # Second call should reuse (via ensure_certificates)
  464. cert_path2, key_path2 = cert_service.ensure_certificates()
  465. mtime2 = cert_path2.stat().st_mtime
  466. assert mtime1 == mtime2 # File wasn't regenerated
  467. def test_delete_certificates(self, cert_service):
  468. """Verify certificates can be deleted."""
  469. cert_service.generate_certificates()
  470. assert cert_service.cert_path.exists()
  471. assert cert_service.key_path.exists()
  472. cert_service.delete_certificates()
  473. assert not cert_service.cert_path.exists()
  474. assert not cert_service.key_path.exists()
  475. def test_ensure_creates_if_not_exist(self, cert_service):
  476. """Verify ensure_certificates generates if not existing."""
  477. assert not cert_service.cert_path.exists()
  478. cert_path, key_path = cert_service.ensure_certificates()
  479. assert cert_path.exists()
  480. assert key_path.exists()
  481. class TestBindServer:
  482. """Tests for BindServer (port 3002 bind/detect protocol)."""
  483. @pytest.fixture
  484. def bind_server(self):
  485. """Create a BindServer instance."""
  486. from backend.app.services.virtual_printer.bind_server import BindServer
  487. return BindServer(
  488. serial="09400A391800001",
  489. model="O1D",
  490. name="Bambuddy",
  491. )
  492. def test_build_frame(self, bind_server):
  493. """Verify frame building produces correct format."""
  494. payload = {"login": {"command": "detect"}}
  495. frame = bind_server._build_frame(payload)
  496. # Header: 0xA5A5
  497. assert frame[:2] == b"\xa5\xa5"
  498. # Trailer: 0xA7A7
  499. assert frame[-2:] == b"\xa7\xa7"
  500. # Length field is total message size (LE uint16)
  501. import struct
  502. total_len = struct.unpack_from("<H", frame, 2)[0]
  503. assert total_len == len(frame)
  504. # JSON payload is between header and trailer
  505. import json
  506. json_bytes = frame[4:-2]
  507. parsed = json.loads(json_bytes)
  508. assert parsed == payload
  509. def test_parse_frame_valid(self, bind_server):
  510. """Verify valid frame parsing extracts JSON correctly."""
  511. import json
  512. import struct
  513. payload = {"login": {"command": "detect", "sequence_id": "20000"}}
  514. json_bytes = json.dumps(payload, separators=(",", ":")).encode()
  515. total_len = 4 + len(json_bytes) + 2
  516. frame = b"\xa5\xa5" + struct.pack("<H", total_len) + json_bytes + b"\xa7\xa7"
  517. result = bind_server._parse_frame(frame)
  518. assert result is not None
  519. assert result["login"]["command"] == "detect"
  520. assert result["login"]["sequence_id"] == "20000"
  521. def test_parse_frame_invalid_header(self, bind_server):
  522. """Verify invalid header returns None."""
  523. result = bind_server._parse_frame(b"\xbb\xbb\x06\x00{}\xa7\xa7")
  524. assert result is None
  525. def test_parse_frame_invalid_trailer(self, bind_server):
  526. """Verify invalid trailer returns None."""
  527. result = bind_server._parse_frame(b"\xa5\xa5\x06\x00{}\xbb\xbb")
  528. assert result is None
  529. def test_parse_frame_too_short(self, bind_server):
  530. """Verify short data returns None."""
  531. result = bind_server._parse_frame(b"\xa5\xa5\x00")
  532. assert result is None
  533. def test_parse_frame_invalid_json(self, bind_server):
  534. """Verify invalid JSON returns None."""
  535. import struct
  536. bad_json = b"not json"
  537. total_len = 4 + len(bad_json) + 2
  538. frame = b"\xa5\xa5" + struct.pack("<H", total_len) + bad_json + b"\xa7\xa7"
  539. result = bind_server._parse_frame(frame)
  540. assert result is None
  541. def test_build_frame_roundtrip(self, bind_server):
  542. """Verify build_frame output can be parsed back."""
  543. payload = {
  544. "login": {
  545. "bind": "free",
  546. "command": "detect",
  547. "connect": "lan",
  548. "dev_cap": 1,
  549. "id": "09400A391800001",
  550. "model": "O1D",
  551. "name": "Bambuddy",
  552. "sequence_id": 3021,
  553. "version": "01.00.00.00",
  554. }
  555. }
  556. frame = bind_server._build_frame(payload)
  557. parsed = bind_server._parse_frame(frame)
  558. assert parsed is not None
  559. assert parsed["login"]["id"] == "09400A391800001"
  560. assert parsed["login"]["model"] == "O1D"
  561. assert parsed["login"]["name"] == "Bambuddy"
  562. assert parsed["login"]["bind"] == "free"
  563. def test_bind_server_stores_config(self, bind_server):
  564. """Verify bind server stores serial, model, name."""
  565. assert bind_server.serial == "09400A391800001"
  566. assert bind_server.model == "O1D"
  567. assert bind_server.name == "Bambuddy"
  568. assert bind_server.version == "01.00.00.00"
  569. def test_bind_server_custom_version(self):
  570. """Verify custom firmware version is stored."""
  571. from backend.app.services.virtual_printer.bind_server import BindServer
  572. server = BindServer(
  573. serial="TEST123",
  574. model="C13",
  575. name="Test",
  576. version="02.03.04.05",
  577. )
  578. assert server.version == "02.03.04.05"
  579. def test_bind_ports_constant(self):
  580. """Verify BIND_PORTS includes both 3000 and 3002 for slicer compatibility."""
  581. from backend.app.services.virtual_printer.bind_server import BIND_PORTS
  582. assert 3000 in BIND_PORTS
  583. assert 3002 in BIND_PORTS
  584. def test_bind_server_initializes_empty_servers_list(self, bind_server):
  585. """Verify bind server starts with empty servers list."""
  586. assert bind_server._servers == []
  587. assert bind_server._running is False
  588. class TestSlicerProxyManager:
  589. """Tests for SlicerProxyManager (proxy mode)."""
  590. @pytest.fixture
  591. def proxy_manager(self, tmp_path):
  592. """Create a SlicerProxyManager instance."""
  593. from backend.app.services.virtual_printer.tcp_proxy import SlicerProxyManager
  594. # Create dummy cert files
  595. cert_path = tmp_path / "cert.pem"
  596. key_path = tmp_path / "key.pem"
  597. cert_path.write_text("-----BEGIN CERTIFICATE-----\ntest\n-----END CERTIFICATE-----")
  598. # Split string to avoid pre-commit hook false positive on test data
  599. key_path.write_text("-----BEGIN " + "PRIVATE KEY-----\ntest\n-----END " + "PRIVATE KEY-----")
  600. return SlicerProxyManager(
  601. target_host="192.168.1.100",
  602. cert_path=cert_path,
  603. key_path=key_path,
  604. )
  605. def test_proxy_manager_initializes_ports(self, proxy_manager):
  606. """Verify proxy manager has correct port constants."""
  607. # FTP proxy uses privileged port 990 to match what Bambu Studio expects
  608. assert proxy_manager.LOCAL_FTP_PORT == 990
  609. assert proxy_manager.LOCAL_MQTT_PORT == 8883
  610. assert proxy_manager.PRINTER_FTP_PORT == 990
  611. assert proxy_manager.PRINTER_MQTT_PORT == 8883
  612. # Bind ports: both 3000 and 3002 for slicer compatibility
  613. assert proxy_manager.PRINTER_BIND_PORTS == [3000, 3002]
  614. def test_proxy_manager_stores_target_host(self, proxy_manager):
  615. """Verify proxy manager stores target host."""
  616. assert proxy_manager.target_host == "192.168.1.100"
  617. def test_get_status_before_start(self, proxy_manager):
  618. """Verify get_status returns zeros before start."""
  619. status = proxy_manager.get_status()
  620. assert status["running"] is False
  621. assert status["ftp_connections"] == 0
  622. assert status["mqtt_connections"] == 0
  623. class TestSSDPProxy:
  624. """Tests for SSDPProxy (cross-network SSDP relay)."""
  625. @pytest.fixture
  626. def ssdp_proxy(self):
  627. """Create an SSDPProxy instance."""
  628. from backend.app.services.virtual_printer.ssdp_server import SSDPProxy
  629. return SSDPProxy(
  630. local_interface_ip="192.168.1.100",
  631. remote_interface_ip="10.0.0.100",
  632. target_printer_ip="192.168.1.50",
  633. )
  634. def test_ssdp_proxy_stores_interface_ips(self, ssdp_proxy):
  635. """Verify SSDPProxy stores interface IPs correctly."""
  636. assert ssdp_proxy.local_interface_ip == "192.168.1.100"
  637. assert ssdp_proxy.remote_interface_ip == "10.0.0.100"
  638. assert ssdp_proxy.target_printer_ip == "192.168.1.50"
  639. def test_rewrite_ssdp_location(self, ssdp_proxy):
  640. """Verify SSDP Location header is rewritten to remote interface IP."""
  641. original_packet = b"NOTIFY * HTTP/1.1\r\nLocation: 192.168.1.50\r\nDevName.bambu.com: TestPrinter\r\n\r\n"
  642. rewritten = ssdp_proxy._rewrite_ssdp(original_packet)
  643. # Location should be changed to remote interface IP
  644. assert b"Location: 10.0.0.100" in rewritten
  645. assert b"Location: 192.168.1.50" not in rewritten
  646. # Other headers should be preserved
  647. assert b"DevName.bambu.com: TestPrinter" in rewritten
  648. def test_rewrite_ssdp_location_case_insensitive(self, ssdp_proxy):
  649. """Verify SSDP Location rewrite is case insensitive."""
  650. original_packet = b"NOTIFY * HTTP/1.1\r\nlocation: 192.168.1.50\r\n\r\n"
  651. rewritten = ssdp_proxy._rewrite_ssdp(original_packet)
  652. assert b"10.0.0.100" in rewritten
  653. def test_rewrite_ssdp_location_no_match(self, ssdp_proxy):
  654. """Verify packet without Location header is returned unchanged."""
  655. original_packet = b"NOTIFY * HTTP/1.1\r\nDevName.bambu.com: Test\r\n\r\n"
  656. rewritten = ssdp_proxy._rewrite_ssdp(original_packet)
  657. # No Location header, but _rewrite_ssdp logs a warning and returns as-is
  658. assert b"DevName.bambu.com: Test" in rewritten
  659. def test_parse_ssdp_message(self, ssdp_proxy):
  660. """Verify SSDP message parsing extracts headers."""
  661. packet = (
  662. b"NOTIFY * HTTP/1.1\r\n"
  663. b"Location: 192.168.1.50\r\n"
  664. b"DevName.bambu.com: TestPrinter\r\n"
  665. b"DevModel.bambu.com: BL-P001\r\n"
  666. b"\r\n"
  667. )
  668. headers = ssdp_proxy._parse_ssdp_message(packet)
  669. assert headers["location"] == "192.168.1.50"
  670. assert headers["devname.bambu.com"] == "TestPrinter"
  671. assert headers["devmodel.bambu.com"] == "BL-P001"
  672. class TestVirtualPrinterManagerDirectories:
  673. """Tests for VirtualPrinterManager directory management."""
  674. def test_ensure_base_directories_creates_subdirs(self, tmp_path):
  675. """Verify _ensure_base_directories creates required base directories."""
  676. from backend.app.services.virtual_printer.manager import VirtualPrinterManager
  677. manager = VirtualPrinterManager()
  678. manager._base_dir = tmp_path / "virtual_printer"
  679. manager._ensure_base_directories()
  680. assert (tmp_path / "virtual_printer").exists()
  681. assert (tmp_path / "virtual_printer" / "uploads").exists()
  682. assert (tmp_path / "virtual_printer" / "certs").exists()
  683. def test_ensure_base_directories_handles_permission_error(self, tmp_path, caplog):
  684. """Verify _ensure_base_directories logs error on permission failure."""
  685. import logging
  686. from backend.app.services.virtual_printer.manager import VirtualPrinterManager
  687. manager = VirtualPrinterManager()
  688. vp_dir = tmp_path / "virtual_printer"
  689. manager._base_dir = vp_dir
  690. original_mkdir = type(vp_dir).mkdir
  691. def mock_mkdir(self, *args, **kwargs):
  692. if "virtual_printer" in str(self):
  693. raise PermissionError("Permission denied")
  694. return original_mkdir(self, *args, **kwargs)
  695. with caplog.at_level(logging.ERROR), patch.object(type(vp_dir), "mkdir", mock_mkdir):
  696. manager._ensure_base_directories()
  697. assert "Permission denied" in caplog.text
  698. def test_instance_creates_per_vp_directories(self, tmp_path):
  699. """Verify VirtualPrinterInstance creates per-VP upload and cert dirs."""
  700. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  701. VirtualPrinterInstance(
  702. vp_id=42,
  703. name="Test",
  704. mode="immediate",
  705. model="C11",
  706. access_code="12345678",
  707. serial_suffix="391800042",
  708. base_dir=tmp_path,
  709. )
  710. assert (tmp_path / "uploads" / "42").exists()
  711. assert (tmp_path / "uploads" / "42" / "cache").exists()
  712. assert (tmp_path / "certs" / "42").exists()
  713. class TestVirtualPrinterInstanceProxyMode:
  714. """Tests for VirtualPrinterInstance proxy mode."""
  715. @pytest.fixture
  716. def proxy_instance(self, tmp_path):
  717. """Create a proxy-mode VirtualPrinterInstance."""
  718. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  719. return VirtualPrinterInstance(
  720. vp_id=10,
  721. name="ProxyTest",
  722. mode="proxy",
  723. model="C11",
  724. access_code="",
  725. serial_suffix="391800010",
  726. target_printer_ip="192.168.1.100",
  727. target_printer_serial="01P00A000000001",
  728. base_dir=tmp_path,
  729. )
  730. def test_proxy_instance_properties(self, proxy_instance):
  731. """Verify proxy instance stores config correctly."""
  732. assert proxy_instance.is_proxy is True
  733. assert proxy_instance.mode == "proxy"
  734. assert proxy_instance.target_printer_ip == "192.168.1.100"
  735. assert proxy_instance.target_printer_serial == "01P00A000000001"
  736. def test_proxy_instance_does_not_require_access_code(self, proxy_instance):
  737. """Verify proxy mode can have empty access code."""
  738. assert proxy_instance.access_code == ""
  739. def test_get_status_proxy_includes_proxy_fields(self, proxy_instance):
  740. """Verify get_status includes proxy fields when proxy is active."""
  741. mock_proxy = MagicMock()
  742. mock_proxy.get_status.return_value = {
  743. "running": True,
  744. "ftp_port": 990,
  745. "mqtt_port": 8883,
  746. "ftp_connections": 1,
  747. "mqtt_connections": 2,
  748. "target_host": "192.168.1.100",
  749. }
  750. proxy_instance._proxy = mock_proxy
  751. status = proxy_instance.get_status()
  752. assert "proxy" in status
  753. assert status["proxy"]["ftp_port"] == 990
  754. assert status["proxy"]["mqtt_connections"] == 2
  755. def test_proxy_instance_stores_remote_interface(self, tmp_path):
  756. """Verify proxy instance stores remote_interface_ip."""
  757. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  758. inst = VirtualPrinterInstance(
  759. vp_id=11,
  760. name="Proxy2",
  761. mode="proxy",
  762. model="C11",
  763. access_code="",
  764. serial_suffix="391800011",
  765. target_printer_ip="192.168.1.100",
  766. remote_interface_ip="10.0.0.50",
  767. base_dir=tmp_path,
  768. )
  769. assert inst.remote_interface_ip == "10.0.0.50"
  770. class TestVirtualPrinterInstanceIPOverride:
  771. """Tests for remote_interface_ip and bind_ip on VirtualPrinterInstance."""
  772. @pytest.fixture
  773. def instance_with_remote_ip(self, tmp_path):
  774. """Create an instance with remote_interface_ip set."""
  775. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  776. return VirtualPrinterInstance(
  777. vp_id=20,
  778. name="IPTest",
  779. mode="immediate",
  780. model="3DPrinter-X1-Carbon",
  781. access_code="12345678",
  782. serial_suffix="391800020",
  783. bind_ip="192.168.1.50",
  784. remote_interface_ip="10.0.0.50",
  785. base_dir=tmp_path,
  786. )
  787. def test_instance_stores_bind_ip(self, instance_with_remote_ip):
  788. """Verify bind_ip is stored."""
  789. assert instance_with_remote_ip.bind_ip == "192.168.1.50"
  790. def test_instance_stores_remote_interface_ip(self, instance_with_remote_ip):
  791. """Verify remote_interface_ip is stored."""
  792. assert instance_with_remote_ip.remote_interface_ip == "10.0.0.50"
  793. def test_generate_certificates_includes_remote_and_bind_ip(self, instance_with_remote_ip):
  794. """Verify generate_certificates passes remote_interface_ip and bind_ip as SANs."""
  795. with (
  796. patch.object(instance_with_remote_ip._cert_service, "delete_printer_certificate"),
  797. patch.object(
  798. instance_with_remote_ip._cert_service,
  799. "generate_certificates",
  800. return_value=(Path("/tmp/cert.pem"), Path("/tmp/key.pem")), # nosec B108
  801. ) as mock_gen,
  802. ):
  803. instance_with_remote_ip.generate_certificates()
  804. mock_gen.assert_called_once_with(additional_ips=["10.0.0.50", "192.168.1.50"])
  805. def test_generate_certificates_no_remote_ip(self, tmp_path):
  806. """Verify generate_certificates passes only bind_ip when no remote_interface_ip."""
  807. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  808. inst = VirtualPrinterInstance(
  809. vp_id=21,
  810. name="NoRemote",
  811. mode="immediate",
  812. model="3DPrinter-X1-Carbon",
  813. access_code="12345678",
  814. serial_suffix="391800021",
  815. bind_ip="192.168.1.50",
  816. base_dir=tmp_path,
  817. )
  818. with (
  819. patch.object(inst._cert_service, "delete_printer_certificate"),
  820. patch.object(
  821. inst._cert_service,
  822. "generate_certificates",
  823. return_value=(Path("/tmp/cert.pem"), Path("/tmp/key.pem")), # nosec B108
  824. ) as mock_gen,
  825. ):
  826. inst.generate_certificates()
  827. mock_gen.assert_called_once_with(additional_ips=["192.168.1.50"])
  828. def test_generate_certificates_no_ips(self, tmp_path):
  829. """Verify generate_certificates passes None when no IPs configured."""
  830. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  831. inst = VirtualPrinterInstance(
  832. vp_id=22,
  833. name="NoIPs",
  834. mode="immediate",
  835. model="3DPrinter-X1-Carbon",
  836. access_code="12345678",
  837. serial_suffix="391800022",
  838. base_dir=tmp_path,
  839. )
  840. with (
  841. patch.object(inst._cert_service, "delete_printer_certificate"),
  842. patch.object(
  843. inst._cert_service,
  844. "generate_certificates",
  845. return_value=(Path("/tmp/cert.pem"), Path("/tmp/key.pem")), # nosec B108
  846. ) as mock_gen,
  847. ):
  848. inst.generate_certificates()
  849. mock_gen.assert_called_once_with(additional_ips=None)
  850. class TestBindServer:
  851. """Tests for the BindServer (port 3002 bind/detect protocol)."""
  852. @pytest.fixture
  853. def bind_server(self):
  854. """Create a BindServer instance."""
  855. from backend.app.services.virtual_printer.bind_server import BindServer
  856. return BindServer(
  857. serial="01S00C000000001",
  858. model="3DPrinter-X1-Carbon",
  859. name="Bambuddy",
  860. )
  861. def test_build_frame(self, bind_server):
  862. """Verify frame format: 0xA5A5 + len(u16le) + JSON + 0xA7A7."""
  863. payload = {"login": {"command": "detect"}}
  864. frame = bind_server._build_frame(payload)
  865. assert frame[:2] == b"\xa5\xa5"
  866. assert frame[-2:] == b"\xa7\xa7"
  867. # Length field is total message size
  868. import struct
  869. total_len = struct.unpack_from("<H", frame, 2)[0]
  870. assert total_len == len(frame)
  871. # JSON payload is between header and trailer
  872. import json
  873. json_bytes = frame[4:-2]
  874. parsed = json.loads(json_bytes)
  875. assert parsed == payload
  876. def test_parse_frame_valid(self, bind_server):
  877. """Verify valid frame parsing."""
  878. frame = bind_server._build_frame({"login": {"command": "detect", "sequence_id": "20000"}})
  879. result = bind_server._parse_frame(frame)
  880. assert result is not None
  881. assert result["login"]["command"] == "detect"
  882. assert result["login"]["sequence_id"] == "20000"
  883. def test_parse_frame_invalid_header(self, bind_server):
  884. """Verify invalid header returns None."""
  885. frame = b"\xb5\xb5\x10\x00" + b'{"login":{}}' + b"\xa7\xa7"
  886. assert bind_server._parse_frame(frame) is None
  887. def test_parse_frame_invalid_trailer(self, bind_server):
  888. """Verify invalid trailer returns None."""
  889. frame = b"\xa5\xa5\x10\x00" + b'{"login":{}}' + b"\xb7\xb7"
  890. assert bind_server._parse_frame(frame) is None
  891. def test_parse_frame_too_short(self, bind_server):
  892. """Verify short data returns None."""
  893. assert bind_server._parse_frame(b"\xa5\xa5\x00") is None
  894. assert bind_server._parse_frame(b"") is None
  895. def test_parse_frame_invalid_json(self, bind_server):
  896. """Verify invalid JSON returns None."""
  897. import struct
  898. bad_json = b"not json"
  899. total_len = 4 + len(bad_json) + 2
  900. frame = b"\xa5\xa5" + struct.pack("<H", total_len) + bad_json + b"\xa7\xa7"
  901. assert bind_server._parse_frame(frame) is None
  902. def test_build_frame_roundtrip(self, bind_server):
  903. """Verify build then parse roundtrip."""
  904. original = {"login": {"bind": "free", "command": "detect", "id": "01S00C000000001"}}
  905. frame = bind_server._build_frame(original)
  906. parsed = bind_server._parse_frame(frame)
  907. assert parsed == original
  908. def test_bind_server_stores_config(self, bind_server):
  909. """Verify config is stored correctly."""
  910. assert bind_server.serial == "01S00C000000001"
  911. assert bind_server.model == "3DPrinter-X1-Carbon"
  912. assert bind_server.name == "Bambuddy"
  913. assert bind_server.version == "01.00.00.00"
  914. def test_bind_server_custom_version(self):
  915. """Verify custom firmware version is stored."""
  916. from backend.app.services.virtual_printer.bind_server import BindServer
  917. server = BindServer(
  918. serial="01S00C000000001",
  919. model="3DPrinter-X1-Carbon",
  920. name="Bambuddy",
  921. version="01.09.00.10",
  922. )
  923. assert server.version == "01.09.00.10"
  924. def test_bind_ports_includes_both(self):
  925. """Verify BIND_PORTS includes both 3000 and 3002 for slicer compatibility."""
  926. from backend.app.services.virtual_printer.bind_server import BIND_PORTS
  927. assert 3000 in BIND_PORTS
  928. assert 3002 in BIND_PORTS
  929. def test_bind_server_initializes_empty_servers_list(self, bind_server):
  930. """Verify bind server starts with empty servers list."""
  931. assert bind_server._servers == []
  932. assert bind_server._running is False
  933. @pytest.mark.asyncio
  934. async def test_start_server_creates_bind_server(self, tmp_path):
  935. """Verify start_server creates BindServer with correct params."""
  936. from backend.app.services.virtual_printer.manager import VirtualPrinterInstance
  937. inst = VirtualPrinterInstance(
  938. vp_id=99,
  939. name="Bambuddy",
  940. mode="immediate",
  941. model="3DPrinter-X1-Carbon",
  942. access_code="12345678",
  943. serial_suffix="391800099",
  944. bind_ip="192.168.1.50",
  945. base_dir=tmp_path,
  946. )
  947. with (
  948. patch("backend.app.services.virtual_printer.manager.VirtualPrinterSSDPServer"),
  949. patch("backend.app.services.virtual_printer.manager.VirtualPrinterFTPServer"),
  950. patch("backend.app.services.virtual_printer.manager.SimpleMQTTServer"),
  951. patch("backend.app.services.virtual_printer.manager.BindServer") as mock_bind_cls,
  952. patch.object(inst._cert_service, "delete_printer_certificate"),
  953. patch.object(
  954. inst._cert_service,
  955. "generate_certificates",
  956. return_value=(Path("/tmp/cert.pem"), Path("/tmp/key.pem")), # nosec B108
  957. ),
  958. ):
  959. await inst.start_server()
  960. mock_bind_cls.assert_called_once_with(
  961. serial=inst.serial,
  962. model="3DPrinter-X1-Carbon",
  963. name="Bambuddy",
  964. bind_address="192.168.1.50",
  965. )