test_printers_api.py 219 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158
  1. """Integration tests for Printers API endpoints.
  2. Tests the full request/response cycle for /api/v1/printers/ endpoints.
  3. """
  4. from unittest.mock import AsyncMock, MagicMock, patch
  5. from urllib.parse import unquote
  6. import pytest
  7. from httpx import AsyncClient
  8. from sqlalchemy import select
  9. from backend.app.core.config import settings
  10. from backend.app.services.printer_media import PrinterFilesJobStatus, PrinterFilesZipResult
  11. @pytest.fixture(autouse=True)
  12. def _mock_printer_test_connection():
  13. """Default mock: connection test returns success.
  14. POST /printers/ now refuses to persist a printer when the MQTT
  15. connection probe fails (would otherwise leave an empty card in the
  16. dashboard for a mistyped access code). Existing tests assume the
  17. save succeeds, so we mock the probe green by default; the failure
  18. branch is exercised by a dedicated test below.
  19. """
  20. with patch(
  21. "backend.app.services.printer_manager.printer_manager.test_connection",
  22. new=AsyncMock(return_value={"success": True, "state": "IDLE", "model": "X1C"}),
  23. ) as m:
  24. yield m
  25. class TestPrintersAPI:
  26. """Integration tests for /api/v1/printers/ endpoints."""
  27. # ========================================================================
  28. # List endpoints
  29. # ========================================================================
  30. @pytest.mark.asyncio
  31. @pytest.mark.integration
  32. async def test_list_printers_empty(self, async_client: AsyncClient):
  33. """Verify empty list is returned when no printers exist."""
  34. response = await async_client.get("/api/v1/printers/")
  35. assert response.status_code == 200
  36. assert response.json() == []
  37. @pytest.mark.asyncio
  38. @pytest.mark.integration
  39. async def test_list_printers_with_data(self, async_client: AsyncClient, printer_factory, db_session):
  40. """Verify list returns existing printers."""
  41. await printer_factory(name="Test Printer")
  42. response = await async_client.get("/api/v1/printers/")
  43. assert response.status_code == 200
  44. data = response.json()
  45. assert len(data) >= 1
  46. assert any(p["name"] == "Test Printer" for p in data)
  47. # ========================================================================
  48. # Create endpoints
  49. # ========================================================================
  50. @pytest.mark.asyncio
  51. @pytest.mark.integration
  52. async def test_create_printer(self, async_client: AsyncClient):
  53. """Verify printer can be created."""
  54. data = {
  55. "name": "New Printer",
  56. "serial_number": "00M09A111111111",
  57. "ip_address": "192.168.1.100",
  58. "access_code": "12345678",
  59. "is_active": True,
  60. "model": "X1C",
  61. }
  62. response = await async_client.post("/api/v1/printers/", json=data)
  63. assert response.status_code == 200
  64. result = response.json()
  65. assert result["name"] == "New Printer"
  66. assert result["serial_number"] == "00M09A111111111"
  67. assert result["model"] == "X1C"
  68. @pytest.mark.asyncio
  69. @pytest.mark.integration
  70. async def test_create_printer_with_hostname(self, async_client: AsyncClient):
  71. """Verify printer can be created with a hostname instead of IP address."""
  72. data = {
  73. "name": "DNS Printer",
  74. "serial_number": "00M09A555555555",
  75. "ip_address": "printer.local",
  76. "access_code": "12345678",
  77. "model": "P1S",
  78. }
  79. response = await async_client.post("/api/v1/printers/", json=data)
  80. assert response.status_code == 200
  81. result = response.json()
  82. assert result["name"] == "DNS Printer"
  83. assert result["ip_address"] == "printer.local"
  84. @pytest.mark.asyncio
  85. @pytest.mark.integration
  86. async def test_create_printer_with_fqdn(self, async_client: AsyncClient):
  87. """Verify printer can be created with a fully qualified domain name."""
  88. data = {
  89. "name": "FQDN Printer",
  90. "serial_number": "00M09A666666666",
  91. "ip_address": "my-printer.home.lan",
  92. "access_code": "12345678",
  93. "model": "X1C",
  94. }
  95. response = await async_client.post("/api/v1/printers/", json=data)
  96. assert response.status_code == 200
  97. result = response.json()
  98. assert result["ip_address"] == "my-printer.home.lan"
  99. @pytest.mark.asyncio
  100. @pytest.mark.integration
  101. async def test_create_printer_invalid_hostname(self, async_client: AsyncClient):
  102. """Verify invalid hostnames are rejected."""
  103. data = {
  104. "name": "Bad Printer",
  105. "serial_number": "00M09A777777777",
  106. "ip_address": "-invalid",
  107. "access_code": "12345678",
  108. }
  109. response = await async_client.post("/api/v1/printers/", json=data)
  110. assert response.status_code == 422
  111. @pytest.mark.asyncio
  112. @pytest.mark.integration
  113. async def test_create_printer_duplicate_serial(self, async_client: AsyncClient, printer_factory, db_session):
  114. """Verify duplicate serial number is rejected."""
  115. await printer_factory(serial_number="00M09A222222222")
  116. data = {
  117. "name": "Duplicate Printer",
  118. "serial_number": "00M09A222222222",
  119. "ip_address": "192.168.1.101",
  120. "access_code": "12345678",
  121. }
  122. response = await async_client.post("/api/v1/printers/", json=data)
  123. # Should fail due to duplicate serial
  124. assert response.status_code in [400, 409, 422, 500]
  125. @pytest.mark.asyncio
  126. @pytest.mark.integration
  127. async def test_create_printer_rejects_when_mqtt_probe_fails(self, async_client: AsyncClient, db_session):
  128. """Wrong access code / unreachable IP must NOT persist the printer.
  129. Regression: users were reporting empty / never-connecting printer
  130. cards that traced back to a mistyped access code. The create route
  131. now runs an MQTT probe up front and returns 400 if it fails — the
  132. row is never written.
  133. """
  134. data = {
  135. "name": "Bad Code Printer",
  136. "serial_number": "00M09A999999999",
  137. "ip_address": "192.168.1.250",
  138. "access_code": "WRONG-CODE",
  139. "is_active": True,
  140. "model": "X1C",
  141. }
  142. with patch(
  143. "backend.app.services.printer_manager.printer_manager.test_connection",
  144. new=AsyncMock(return_value={"success": False, "state": None, "model": None}),
  145. ):
  146. response = await async_client.post("/api/v1/printers/", json=data)
  147. assert response.status_code == 400
  148. detail = response.json()["detail"]
  149. # Backend returns a stable code for the frontend i18n layer to map;
  150. # the message field is an English fallback for non-UI clients.
  151. assert detail["code"] == "printer_connection_failed"
  152. assert "connect" in detail["message"].lower()
  153. # And critically: the printer row was never persisted.
  154. from backend.app.models.printer import Printer
  155. result = await db_session.execute(select(Printer).where(Printer.serial_number == "00M09A999999999"))
  156. assert result.scalar_one_or_none() is None, "Failed-probe printer must not be persisted"
  157. # ========================================================================
  158. # Get single endpoint
  159. # ========================================================================
  160. @pytest.mark.asyncio
  161. @pytest.mark.integration
  162. async def test_get_printer(self, async_client: AsyncClient, printer_factory, db_session):
  163. """Verify single printer can be retrieved."""
  164. printer = await printer_factory(name="Get Test Printer")
  165. response = await async_client.get(f"/api/v1/printers/{printer.id}")
  166. assert response.status_code == 200
  167. result = response.json()
  168. assert result["id"] == printer.id
  169. assert result["name"] == "Get Test Printer"
  170. @pytest.mark.asyncio
  171. @pytest.mark.integration
  172. async def test_get_printer_not_found(self, async_client: AsyncClient):
  173. """Verify 404 for non-existent printer."""
  174. response = await async_client.get("/api/v1/printers/9999")
  175. assert response.status_code == 404
  176. # ========================================================================
  177. # Update endpoints
  178. # ========================================================================
  179. @pytest.mark.asyncio
  180. @pytest.mark.integration
  181. async def test_update_printer_name(self, async_client: AsyncClient, printer_factory, db_session):
  182. """Verify printer name can be updated."""
  183. printer = await printer_factory(name="Original Name")
  184. response = await async_client.patch(f"/api/v1/printers/{printer.id}", json={"name": "Updated Name"})
  185. assert response.status_code == 200
  186. assert response.json()["name"] == "Updated Name"
  187. @pytest.mark.asyncio
  188. @pytest.mark.integration
  189. async def test_update_printer_active_status(self, async_client: AsyncClient, printer_factory, db_session):
  190. """Verify printer active status can be updated."""
  191. printer = await printer_factory(is_active=True)
  192. response = await async_client.patch(f"/api/v1/printers/{printer.id}", json={"is_active": False})
  193. assert response.status_code == 200
  194. assert response.json()["is_active"] is False
  195. @pytest.mark.asyncio
  196. @pytest.mark.integration
  197. async def test_update_printer_auto_archive(self, async_client: AsyncClient, printer_factory, db_session):
  198. """Verify auto_archive setting can be updated."""
  199. printer = await printer_factory(auto_archive=True)
  200. response = await async_client.patch(f"/api/v1/printers/{printer.id}", json={"auto_archive": False})
  201. assert response.status_code == 200
  202. assert response.json()["auto_archive"] is False
  203. @pytest.mark.asyncio
  204. @pytest.mark.integration
  205. async def test_update_nonexistent_printer(self, async_client: AsyncClient):
  206. """Verify updating non-existent printer returns 404."""
  207. response = await async_client.patch("/api/v1/printers/9999", json={"name": "New Name"})
  208. assert response.status_code == 404
  209. # ========================================================================
  210. # Delete endpoints
  211. # ========================================================================
  212. @pytest.mark.asyncio
  213. @pytest.mark.integration
  214. async def test_delete_printer(self, async_client: AsyncClient, printer_factory, db_session):
  215. """Verify printer can be deleted."""
  216. printer = await printer_factory()
  217. printer_id = printer.id
  218. response = await async_client.delete(f"/api/v1/printers/{printer_id}")
  219. assert response.status_code == 200
  220. # Verify deleted
  221. response = await async_client.get(f"/api/v1/printers/{printer_id}")
  222. assert response.status_code == 404
  223. @pytest.mark.asyncio
  224. @pytest.mark.integration
  225. async def test_delete_printer_removes_scheduled_dryings(
  226. self, async_client: AsyncClient, printer_factory, db_session
  227. ):
  228. """Deleting a printer must also delete its scheduled_dryings rows, since
  229. SQLite doesn't enforce FK cascades (#2638).
  230. """
  231. from backend.app.models.scheduled_drying import ScheduledDrying
  232. printer = await printer_factory()
  233. printer_id = printer.id
  234. row = ScheduledDrying(printer_id=printer_id, ams_id=0, temp=55, duration_hours=8)
  235. db_session.add(row)
  236. await db_session.commit()
  237. row_id = row.id
  238. response = await async_client.delete(f"/api/v1/printers/{printer_id}")
  239. assert response.status_code == 200
  240. result = await db_session.execute(select(ScheduledDrying).where(ScheduledDrying.id == row_id))
  241. assert result.scalar_one_or_none() is None
  242. @pytest.mark.asyncio
  243. @pytest.mark.integration
  244. async def test_delete_nonexistent_printer(self, async_client: AsyncClient):
  245. """Verify deleting non-existent printer returns 404."""
  246. response = await async_client.delete("/api/v1/printers/9999")
  247. assert response.status_code == 404
  248. # ========================================================================
  249. # File download endpoint — non-ASCII filename regression (#1245)
  250. # ========================================================================
  251. @pytest.mark.asyncio
  252. @pytest.mark.integration
  253. @pytest.mark.parametrize(
  254. ("filename", "ascii_fallback"),
  255. [
  256. ("龙泡泡石墩子_p2s_ok.gcode.3mf", "p2s_ok.gcode.3mf"),
  257. ("こんにちは.gcode.3mf", "gcode.3mf"),
  258. ("résumé.gcode.3mf", "rsum.gcode.3mf"),
  259. ("مرحبا.gcode.3mf", "gcode.3mf"),
  260. ("文件.3mf", "3mf"),
  261. ("hello.3mf", "hello.3mf"),
  262. ],
  263. )
  264. async def test_download_printer_file_non_ascii_filename(
  265. self,
  266. async_client: AsyncClient,
  267. printer_factory,
  268. filename: str,
  269. ascii_fallback: str,
  270. db_session,
  271. tmp_path,
  272. ):
  273. """Non-ASCII filenames must not crash header encoding (issue #1245)."""
  274. printer = await printer_factory()
  275. file_bytes = b"fake 3mf content"
  276. staged = tmp_path / "single" / "printer-file"
  277. staged.parent.mkdir()
  278. staged.write_bytes(file_bytes)
  279. with patch(
  280. "backend.app.api.routes.printers.build_printer_file",
  281. new=AsyncMock(
  282. return_value=PrinterFilesZipResult(
  283. path=staged,
  284. requested=1,
  285. successful=1,
  286. failed_paths=(),
  287. total_bytes=len(file_bytes),
  288. )
  289. ),
  290. ):
  291. response = await async_client.get(
  292. f"/api/v1/printers/{printer.id}/files/download",
  293. params={"path": f"/cache/{filename}"},
  294. )
  295. assert response.status_code == 200
  296. assert response.content == file_bytes
  297. content_disposition = response.headers["content-disposition"]
  298. assert f'filename="{ascii_fallback}"' in content_disposition
  299. assert "filename*=UTF-8''" in content_disposition
  300. encoded_name = content_disposition.split("filename*=UTF-8''", 1)[1]
  301. assert unquote(encoded_name) == filename
  302. @pytest.mark.asyncio
  303. @pytest.mark.integration
  304. async def test_download_job_returns_immediately_and_prepared_token_streams_file_response(
  305. self,
  306. async_client: AsyncClient,
  307. printer_factory,
  308. tmp_path,
  309. monkeypatch,
  310. ):
  311. """The browser polls a short job request, then uses a native GET."""
  312. from backend.app.core.auth import create_slicer_download_token
  313. printer = await printer_factory()
  314. monkeypatch.setattr(settings, "archive_dir", tmp_path / "archive")
  315. token = await create_slicer_download_token("printer-files", printer.id)
  316. bundle_dir = settings.archive_dir / "temp" / "printer-file-downloads" / f"{printer.id}-{token}"
  317. bundle_dir.mkdir(parents=True)
  318. zip_path = bundle_dir / "printer-files.zip"
  319. zip_path.write_bytes(b"disk-backed zip")
  320. with patch(
  321. "backend.app.api.routes.printers.start_printer_files_job",
  322. new=AsyncMock(
  323. return_value=PrinterFilesJobStatus(
  324. job_id="job-id",
  325. printer_id=printer.id,
  326. state="queued",
  327. requested=2,
  328. filename="Test Printer videos.zip",
  329. )
  330. ),
  331. ):
  332. job_response = await async_client.post(
  333. f"/api/v1/printers/{printer.id}/files/download-job",
  334. json={
  335. "paths": ["/ipcam/one.mp4", "/ipcam/two.mp4"],
  336. "sizes": {"/ipcam/one.mp4": 7, "/ipcam/two.mp4": 8},
  337. "filename": "Test Printer videos.zip",
  338. "as_zip": True,
  339. },
  340. )
  341. assert job_response.status_code == 200
  342. assert job_response.json() == {
  343. "job_id": "job-id",
  344. "printer_id": printer.id,
  345. "state": "queued",
  346. "requested": 2,
  347. "successful": 0,
  348. "failed": 0,
  349. "token": None,
  350. "filename": "Test Printer videos.zip",
  351. "message": None,
  352. }
  353. response = await async_client.get(
  354. f"/api/v1/printers/{printer.id}/files/dl/{token}/Test%20Printer%20videos.zip",
  355. )
  356. assert response.status_code == 200
  357. assert response.content == b"disk-backed zip"
  358. assert 'filename="Test Printer videos.zip"' in response.headers["content-disposition"]
  359. # Tokens are single-use, including after a successful large download.
  360. replay = await async_client.get(
  361. f"/api/v1/printers/{printer.id}/files/dl/{token}/Test%20Printer%20videos.zip",
  362. )
  363. assert replay.status_code == 403
  364. # The browser reaches this URL through an <a download> click and saves
  365. # whatever comes back under the name it was going to use, so a refusal
  366. # has to arrive as a legible file rather than as a JSON body landing on
  367. # the user's disk named .zip.
  368. assert replay.headers["content-type"].startswith("text/plain")
  369. assert 'filename="download-failed.txt"' in replay.headers["content-disposition"]
  370. assert b"expired" in replay.content
  371. @pytest.mark.asyncio
  372. @pytest.mark.integration
  373. async def test_bulk_download_token_rejects_another_printer_without_consuming_it(
  374. self,
  375. async_client: AsyncClient,
  376. printer_factory,
  377. tmp_path,
  378. monkeypatch,
  379. ):
  380. """A printer-A token cannot download through printer B and survives that attempt."""
  381. printer_a = await printer_factory(name="Printer A", serial_number="TOKENBINDINGA01")
  382. printer_b = await printer_factory(name="Printer B", serial_number="TOKENBINDINGB01")
  383. monkeypatch.setattr(settings, "archive_dir", tmp_path / "archive")
  384. from backend.app.core.auth import create_slicer_download_token
  385. token = await create_slicer_download_token("printer-files", printer_a.id)
  386. bundle_dir = settings.archive_dir / "temp" / "printer-file-downloads" / f"{printer_a.id}-{token}"
  387. bundle_dir.mkdir(parents=True)
  388. zip_path = bundle_dir / "printer-files.zip"
  389. zip_path.write_bytes(b"bound zip")
  390. wrong_printer = await async_client.get(
  391. f"/api/v1/printers/{printer_b.id}/files/dl/{token}/printer-files.zip",
  392. )
  393. assert wrong_printer.status_code == 403
  394. correct_printer = await async_client.get(
  395. f"/api/v1/printers/{printer_a.id}/files/dl/{token}/printer-files.zip",
  396. )
  397. assert correct_printer.status_code == 200
  398. assert correct_printer.content == b"bound zip"
  399. @pytest.mark.asyncio
  400. @pytest.mark.integration
  401. async def test_legacy_bulk_download_accepts_paths_without_sizes(
  402. self,
  403. async_client: AsyncClient,
  404. printer_factory,
  405. tmp_path,
  406. ):
  407. """Existing API clients may omit the newer preflight size hints."""
  408. printer = await printer_factory()
  409. bundle_dir = tmp_path / "legacy-bundle"
  410. bundle_dir.mkdir()
  411. zip_path = bundle_dir / "printer-files.zip"
  412. zip_path.write_bytes(b"legacy zip")
  413. build_zip = AsyncMock(
  414. return_value=PrinterFilesZipResult(
  415. path=zip_path,
  416. requested=2,
  417. successful=2,
  418. failed_paths=(),
  419. total_bytes=10,
  420. )
  421. )
  422. with patch("backend.app.api.routes.printers.build_printer_files_zip", new=build_zip):
  423. response = await async_client.post(
  424. f"/api/v1/printers/{printer.id}/files/download-zip",
  425. json={"paths": ["model.gcode", "model.gcode"]},
  426. )
  427. assert response.status_code == 200
  428. assert response.content == b"legacy zip"
  429. assert build_zip.await_args.args[1:] == (["/model.gcode", "/model.gcode"], {})
  430. assert build_zip.await_args.kwargs == {"preserve_paths": False, "allow_empty": True}
  431. @pytest.mark.asyncio
  432. @pytest.mark.integration
  433. async def test_legacy_bulk_download_empty_selection_keeps_400_contract(
  434. self,
  435. async_client: AsyncClient,
  436. printer_factory,
  437. ):
  438. printer = await printer_factory()
  439. response = await async_client.post(
  440. f"/api/v1/printers/{printer.id}/files/download-zip",
  441. json={"paths": []},
  442. )
  443. assert response.status_code == 400
  444. @pytest.mark.asyncio
  445. @pytest.mark.integration
  446. @pytest.mark.parametrize("transport", ["header", "bearer"])
  447. async def test_printer_file_routes_enforce_api_key_printer_scope(
  448. self,
  449. async_client: AsyncClient,
  450. printer_factory,
  451. db_session,
  452. transport: str,
  453. ):
  454. """A key restricted to printer A must not list printer B's storage."""
  455. from backend.app.core.auth import generate_api_key
  456. from backend.app.models.api_key import APIKey
  457. from backend.app.services.bambu_ftp import FileListResult
  458. printer_a = await printer_factory(name="Scoped A", serial_number="SCOPEA000000001")
  459. printer_b = await printer_factory(name="Scoped B", serial_number="SCOPEB000000001")
  460. setup = await async_client.post(
  461. "/api/v1/auth/setup",
  462. json={
  463. "auth_enabled": True,
  464. "admin_username": "scopeadmin",
  465. "admin_password": "AdminPass1!",
  466. },
  467. )
  468. assert setup.status_code == 200, setup.text
  469. full_key, key_hash, key_prefix = generate_api_key()
  470. db_session.add(
  471. APIKey(
  472. name=f"printer-scope-{transport}",
  473. key_hash=key_hash,
  474. key_prefix=key_prefix,
  475. can_control_printer=True,
  476. printer_ids=[printer_a.id],
  477. enabled=True,
  478. )
  479. )
  480. await db_session.commit()
  481. headers = {"X-API-Key": full_key} if transport == "header" else {"Authorization": f"Bearer {full_key}"}
  482. listing = AsyncMock(return_value=FileListResult(files=[], available=True))
  483. with patch("backend.app.api.routes.printers.list_files_result_async", new=listing):
  484. denied = await async_client.get(
  485. f"/api/v1/printers/{printer_b.id}/files",
  486. headers=headers,
  487. )
  488. allowed = await async_client.get(
  489. f"/api/v1/printers/{printer_a.id}/files",
  490. headers=headers,
  491. )
  492. # Out of scope reads as missing, so the id isn't confirmed (#1727)
  493. assert denied.status_code == 404
  494. assert allowed.status_code == 200
  495. listing.assert_awaited_once()
  496. # ========================================================================
  497. # Status endpoint
  498. # ========================================================================
  499. @pytest.mark.asyncio
  500. @pytest.mark.integration
  501. async def test_get_printer_status(
  502. self, async_client: AsyncClient, printer_factory, mock_printer_manager, db_session
  503. ):
  504. """Verify printer status can be retrieved."""
  505. printer = await printer_factory()
  506. response = await async_client.get(f"/api/v1/printers/{printer.id}/status")
  507. assert response.status_code == 200
  508. result = response.json()
  509. assert "connected" in result
  510. assert "state" in result
  511. @pytest.mark.asyncio
  512. @pytest.mark.integration
  513. async def test_get_printer_status_not_found(self, async_client: AsyncClient):
  514. """Verify 404 for status of non-existent printer."""
  515. response = await async_client.get("/api/v1/printers/9999/status")
  516. assert response.status_code == 404
  517. @pytest.mark.asyncio
  518. @pytest.mark.integration
  519. async def test_get_printer_status_includes_fila_switch_when_installed(
  520. self, async_client: AsyncClient, printer_factory, db_session
  521. ):
  522. """When the FTS accessory is installed, the status response must include
  523. the fila_switch object with the routing arrays. See #1162.
  524. The accessory is detected from print.device.fila_switch in MQTT;
  525. we feed a PrinterState with FilaSwitchState(installed=True, ...) and
  526. confirm it survives the schema serialization round-trip.
  527. """
  528. from unittest.mock import MagicMock, patch
  529. from backend.app.services.bambu_mqtt import FilaSwitchState, PrinterState
  530. printer = await printer_factory()
  531. state = PrinterState()
  532. state.connected = True
  533. state.state = "IDLE"
  534. state.fila_switch = FilaSwitchState(
  535. installed=True,
  536. in_slots=[-1, 2],
  537. out_extruders=[0, 1],
  538. stat=0,
  539. info=2,
  540. )
  541. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  542. mock_pm.get_status = MagicMock(return_value=state)
  543. mock_pm.is_awaiting_plate_clear = MagicMock(return_value=False)
  544. response = await async_client.get(f"/api/v1/printers/{printer.id}/status")
  545. assert response.status_code == 200
  546. result = response.json()
  547. assert result["fila_switch"] is not None
  548. assert result["fila_switch"]["installed"] is True
  549. assert result["fila_switch"]["in_slots"] == [-1, 2]
  550. assert result["fila_switch"]["out_extruders"] == [0, 1]
  551. assert result["fila_switch"]["stat"] == 0
  552. assert result["fila_switch"]["info"] == 2
  553. @pytest.mark.asyncio
  554. @pytest.mark.integration
  555. async def test_status_reports_switch_readiness_on_the_first_load(self, async_client: AsyncClient, printer_factory):
  556. """``ready`` has to be computed by the REST route, not just the WebSocket.
  557. This response is what the page has before any push arrives. Leaving the
  558. field at its default would tell a correctly set-up machine that its
  559. switch is not set up, and the AMS menu refuses Load on that.
  560. """
  561. from unittest.mock import MagicMock, patch
  562. from backend.app.services.bambu_mqtt import FilaSwitchState, PrinterState
  563. printer = await printer_factory()
  564. state = PrinterState()
  565. state.connected = True
  566. state.state = "IDLE"
  567. state.fila_switch = FilaSwitchState(installed=True)
  568. state.raw_data = {"ams": [{"id": "0", "tray": []}, {"id": "1", "tray": []}]}
  569. state.ams_switch_inlet = {"0": "A"}
  570. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  571. mock_pm.get_status = MagicMock(return_value=state)
  572. mock_pm.is_awaiting_plate_clear = MagicMock(return_value=False)
  573. unbound = await async_client.get(f"/api/v1/printers/{printer.id}/status")
  574. state.ams_switch_inlet = {"0": "A", "1": "B"}
  575. bound = await async_client.get(f"/api/v1/printers/{printer.id}/status")
  576. assert unbound.json()["fila_switch"]["ready"] is False
  577. assert bound.json()["fila_switch"]["ready"] is True
  578. @pytest.mark.asyncio
  579. @pytest.mark.integration
  580. async def test_status_reports_which_hotend_holds_which_slot(self, async_client: AsyncClient, printer_factory):
  581. """Also needed on the first load: it decides which hotend Load may offer."""
  582. from unittest.mock import MagicMock, patch
  583. from backend.app.services.bambu_mqtt import ExtruderSlot, PrinterState
  584. printer = await printer_factory()
  585. state = PrinterState()
  586. state.connected = True
  587. state.state = "IDLE"
  588. state.extruder_slots = {
  589. 0: ExtruderSlot(ams_id=0, slot_id=2, has_filament=True),
  590. 1: ExtruderSlot(),
  591. }
  592. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  593. mock_pm.get_status = MagicMock(return_value=state)
  594. mock_pm.is_awaiting_plate_clear = MagicMock(return_value=False)
  595. response = await async_client.get(f"/api/v1/printers/{printer.id}/status")
  596. assert response.json()["extruder_slots"] == {
  597. "0": {"ams_id": 0, "slot_id": 2, "has_filament": True},
  598. "1": {"ams_id": None, "slot_id": None, "has_filament": False},
  599. }
  600. @pytest.mark.asyncio
  601. @pytest.mark.integration
  602. async def test_cover_uses_dispatched_plate_when_gcode_file_lacks_path(
  603. self, async_client: AsyncClient, printer_factory, db_session, tmp_path
  604. ):
  605. """When firmware drops the plate path from gcode_file (e.g. P1S
  606. 01.10.00.00, #1166), the dispatched-plate record must take precedence
  607. and serve plate 4's thumbnail instead of falling back to plate_1.png."""
  608. import io
  609. import zipfile
  610. from unittest.mock import MagicMock, patch
  611. from backend.app.services.bambu_ftp import cache_3mf_download
  612. from backend.app.services.bambu_mqtt import PrinterState
  613. printer = await printer_factory()
  614. # Build a 3MF that mimics a "true" multi-plate archive: thumbnails
  615. # for plates 1..4 are all present, gcode files for plates 1..4 are
  616. # all present. Without the dispatch record we'd default to plate_1.png.
  617. threemf_path = tmp_path / "MyModel.3mf"
  618. with zipfile.ZipFile(threemf_path, "w") as zf:
  619. for plate in range(1, 5):
  620. zf.writestr(f"Metadata/plate_{plate}.png", f"PLATE_{plate}_PNG".encode())
  621. zf.writestr(f"Metadata/plate_{plate}.gcode", f"; plate {plate} gcode\n")
  622. cache_3mf_download(printer.id, "MyModel.3mf", threemf_path)
  623. state = PrinterState()
  624. state.connected = True
  625. state.state = "RUNNING"
  626. state.subtask_name = "MyModel"
  627. state.gcode_file = "MyModel.3mf" # firmware drops plate path
  628. state.dispatched_plate_id = 4
  629. state.dispatched_subtask = "MyModel"
  630. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  631. mock_pm.get_status = MagicMock(return_value=state)
  632. mock_pm.is_awaiting_plate_clear = MagicMock(return_value=False)
  633. response = await async_client.get(f"/api/v1/printers/{printer.id}/cover")
  634. assert response.status_code == 200
  635. assert response.content == b"PLATE_4_PNG"
  636. @pytest.mark.asyncio
  637. @pytest.mark.integration
  638. async def test_cover_pick_view_serves_active_plate_object_mask(
  639. self, async_client: AsyncClient, printer_factory, db_session, tmp_path
  640. ):
  641. """The skip-items UI needs the slicer's exact object-ID mask, not an
  642. inferred bounding box, so a plate click resolves to the firmware ID."""
  643. import zipfile
  644. from unittest.mock import MagicMock, patch
  645. from backend.app.services.bambu_ftp import cache_3mf_download
  646. from backend.app.services.bambu_mqtt import PrinterState
  647. printer = await printer_factory()
  648. threemf_path = tmp_path / "PickMask.3mf"
  649. with zipfile.ZipFile(threemf_path, "w") as zf:
  650. zf.writestr("Metadata/pick_1.png", b"PICK_ONE")
  651. zf.writestr("Metadata/pick_3.png", b"PICK_THREE")
  652. zf.writestr("Metadata/plate_3.gcode", "; active plate\n")
  653. cache_3mf_download(printer.id, "PickMask.3mf", threemf_path)
  654. state = PrinterState()
  655. state.connected = True
  656. state.state = "RUNNING"
  657. state.subtask_name = "PickMask"
  658. state.gcode_file = "PickMask.3mf"
  659. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  660. mock_pm.get_status = MagicMock(return_value=state)
  661. response = await async_client.get(f"/api/v1/printers/{printer.id}/cover?view=pick")
  662. assert response.status_code == 200
  663. assert response.content == b"PICK_THREE"
  664. @pytest.mark.asyncio
  665. @pytest.mark.integration
  666. async def test_cover_pick_view_404s_rather_than_serving_a_render(
  667. self, async_client: AsyncClient, printer_factory, db_session, tmp_path
  668. ):
  669. """A mask is coordinates, not decoration. Archives without pick_N.png
  670. (Handy jobs, older slicers) must 404 so the UI drops to the checklist —
  671. every other view's fallback to a rendered thumbnail would be decoded as
  672. object IDs here, and a click would skip an arbitrary object."""
  673. import zipfile
  674. from unittest.mock import MagicMock, patch
  675. from backend.app.services.bambu_ftp import cache_3mf_download
  676. from backend.app.services.bambu_mqtt import PrinterState
  677. printer = await printer_factory()
  678. threemf_path = tmp_path / "NoMask.3mf"
  679. with zipfile.ZipFile(threemf_path, "w") as zf:
  680. zf.writestr("Metadata/top_1.png", b"TOP_RENDER")
  681. zf.writestr("Metadata/plate_1.png", b"PLATE_RENDER")
  682. zf.writestr("Metadata/plate_1.gcode", "; active plate\n")
  683. cache_3mf_download(printer.id, "NoMask.3mf", threemf_path)
  684. state = PrinterState()
  685. state.connected = True
  686. state.state = "RUNNING"
  687. state.subtask_name = "NoMask"
  688. state.gcode_file = "NoMask.3mf"
  689. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  690. mock_pm.get_status = MagicMock(return_value=state)
  691. response = await async_client.get(f"/api/v1/printers/{printer.id}/cover?view=pick")
  692. assert response.status_code == 404
  693. assert b"RENDER" not in response.content
  694. @pytest.mark.asyncio
  695. @pytest.mark.integration
  696. async def test_cover_pick_view_does_not_borrow_another_plates_mask(
  697. self, async_client: AsyncClient, printer_factory, db_session, tmp_path
  698. ):
  699. """Plate 1's mask over plate 3's layout resolves clicks to whatever
  700. occupied that pixel on a different plate, so the active plate's mask is
  701. the only acceptable answer."""
  702. import zipfile
  703. from unittest.mock import MagicMock, patch
  704. from backend.app.services.bambu_ftp import cache_3mf_download
  705. from backend.app.services.bambu_mqtt import PrinterState
  706. printer = await printer_factory()
  707. threemf_path = tmp_path / "OtherPlate.3mf"
  708. with zipfile.ZipFile(threemf_path, "w") as zf:
  709. zf.writestr("Metadata/pick_1.png", b"PICK_ONE")
  710. zf.writestr("Metadata/top_3.png", b"TOP_THREE")
  711. zf.writestr("Metadata/plate_3.gcode", "; active plate\n")
  712. cache_3mf_download(printer.id, "OtherPlate.3mf", threemf_path)
  713. state = PrinterState()
  714. state.connected = True
  715. state.state = "RUNNING"
  716. state.subtask_name = "OtherPlate"
  717. state.gcode_file = "OtherPlate.3mf"
  718. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  719. mock_pm.get_status = MagicMock(return_value=state)
  720. response = await async_client.get(f"/api/v1/printers/{printer.id}/cover?view=pick")
  721. assert response.status_code == 404
  722. assert response.content != b"PICK_ONE"
  723. @pytest.mark.asyncio
  724. @pytest.mark.integration
  725. async def test_cover_3mf_scan_fallback_for_per_plate_archive(
  726. self, async_client: AsyncClient, printer_factory, db_session, tmp_path
  727. ):
  728. """Per-plate archives sliced separately in Bambu Studio contain a
  729. single Metadata/plate_N.gcode (the active plate) but bundle thumbnails
  730. for every plate. With no dispatch record (e.g. dispatched via Studio
  731. directly) and no plate path in gcode_file, the route must scan the
  732. 3MF and pick plate N's thumbnail. See #1166 option 4."""
  733. import zipfile
  734. from unittest.mock import MagicMock, patch
  735. from backend.app.services.bambu_ftp import cache_3mf_download
  736. from backend.app.services.bambu_mqtt import PrinterState
  737. printer = await printer_factory()
  738. # Per-plate archive: thumbnails for all plates, gcode for plate 3 only.
  739. threemf_path = tmp_path / "PerPlate.3mf"
  740. with zipfile.ZipFile(threemf_path, "w") as zf:
  741. for plate in range(1, 5):
  742. zf.writestr(f"Metadata/plate_{plate}.png", f"PLATE_{plate}_PNG".encode())
  743. zf.writestr("Metadata/plate_3.gcode", "; only plate 3 has gcode\n")
  744. cache_3mf_download(printer.id, "PerPlate.3mf", threemf_path)
  745. state = PrinterState()
  746. state.connected = True
  747. state.state = "RUNNING"
  748. state.subtask_name = "PerPlate"
  749. state.gcode_file = "PerPlate.3mf"
  750. # No dispatch record (Studio-direct dispatch).
  751. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  752. mock_pm.get_status = MagicMock(return_value=state)
  753. mock_pm.is_awaiting_plate_clear = MagicMock(return_value=False)
  754. response = await async_client.get(f"/api/v1/printers/{printer.id}/cover")
  755. assert response.status_code == 200
  756. assert response.content == b"PLATE_3_PNG"
  757. @pytest.mark.asyncio
  758. @pytest.mark.integration
  759. async def test_cover_negative_cache_skips_repeat_ftp_fanout(
  760. self, async_client: AsyncClient, printer_factory, db_session
  761. ):
  762. """#1420: when every FTP path returns 550 for the current subtask, the
  763. next request for the same subtask must short-circuit to 404 instead of
  764. replaying the 8-path FTP fan-out (which starves the printer's single
  765. FTP socket and flooded the user's logs)."""
  766. from unittest.mock import AsyncMock, MagicMock, patch
  767. from backend.app.api.routes.printers import _cover_404_cache, _cover_cache
  768. from backend.app.services.bambu_mqtt import PrinterState
  769. printer = await printer_factory()
  770. _cover_cache.pop(printer.id, None)
  771. _cover_404_cache.pop(printer.id, None)
  772. state = PrinterState()
  773. state.connected = True
  774. state.state = "RUNNING"
  775. state.subtask_name = "OrphanPrint"
  776. state.gcode_file = "OrphanPrint.3mf"
  777. ftp_mock = AsyncMock(return_value=False)
  778. with (
  779. patch("backend.app.api.routes.printers.printer_manager") as mock_pm,
  780. patch("backend.app.api.routes.printers.download_file_try_paths_async", ftp_mock),
  781. ):
  782. mock_pm.get_status = MagicMock(return_value=state)
  783. mock_pm.is_awaiting_plate_clear = MagicMock(return_value=False)
  784. r1 = await async_client.get(f"/api/v1/printers/{printer.id}/cover")
  785. r2 = await async_client.get(f"/api/v1/printers/{printer.id}/cover")
  786. assert r1.status_code == 404
  787. assert r2.status_code == 404
  788. # First call retries internally; second call must short-circuit before FTP.
  789. first_call_count = ftp_mock.await_count
  790. assert first_call_count >= 1
  791. # Second request didn't add to the count: the negative cache held.
  792. assert ftp_mock.await_count == first_call_count
  793. @pytest.mark.asyncio
  794. @pytest.mark.integration
  795. async def test_get_printer_status_omits_fila_switch_when_not_installed(
  796. self, async_client: AsyncClient, printer_factory, db_session
  797. ):
  798. """Without the FTS accessory, fila_switch must be null so the frontend
  799. keeps applying the per-extruder filter on regular dual-nozzle printers."""
  800. from unittest.mock import MagicMock, patch
  801. from backend.app.services.bambu_mqtt import PrinterState
  802. printer = await printer_factory()
  803. state = PrinterState()
  804. state.connected = True
  805. state.state = "IDLE"
  806. # default fila_switch — installed = False
  807. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  808. mock_pm.get_status = MagicMock(return_value=state)
  809. mock_pm.is_awaiting_plate_clear = MagicMock(return_value=False)
  810. response = await async_client.get(f"/api/v1/printers/{printer.id}/status")
  811. assert response.status_code == 200
  812. result = response.json()
  813. assert result["fila_switch"] is None
  814. # ========================================================================
  815. # Test connection endpoint
  816. # ========================================================================
  817. class TestCoverPoolHygiene:
  818. """Regression guard for the /cover DB-connection leak (issue #2572)."""
  819. def test_cover_does_not_hold_a_get_db_session(self):
  820. """The cover endpoint must NOT take a ``Depends(get_db)`` session.
  821. ``get_db`` is a ``yield`` dependency, so its session stays open for the
  822. whole request — including the 3MF cover download (up to 8 remote paths ×
  823. retries with backoff, minutes under FTP contention), pinning one pooled
  824. DB connection ``idle in transaction`` the entire time. The endpoint
  825. fetches the printer in a short-lived ``async with async_session()`` and
  826. releases the connection before the FTP work. If someone re-adds a
  827. ``Depends(get_db)`` param, this fails.
  828. """
  829. import inspect
  830. from backend.app.api.routes.printers import get_db, get_printer_cover
  831. for name, param in inspect.signature(get_printer_cover).parameters.items():
  832. dependency = getattr(param.default, "dependency", None)
  833. assert dependency is not get_db, (
  834. f"get_printer_cover re-introduced a get_db-held session via parameter {name!r} — "
  835. "it would stay open for the entire FTP cover download (issue #2572)"
  836. )
  837. class TestPrinterDataIntegrity:
  838. """Tests for printer data integrity."""
  839. @pytest.mark.asyncio
  840. @pytest.mark.integration
  841. async def test_printer_stores_all_fields(self, async_client: AsyncClient, printer_factory, db_session):
  842. """Verify printer stores all fields correctly."""
  843. printer = await printer_factory(
  844. name="Full Test Printer",
  845. serial_number="00M09A444444444",
  846. ip_address="192.168.1.150",
  847. model="P1S",
  848. is_active=True,
  849. auto_archive=False,
  850. )
  851. response = await async_client.get(f"/api/v1/printers/{printer.id}")
  852. assert response.status_code == 200
  853. result = response.json()
  854. assert result["name"] == "Full Test Printer"
  855. assert result["serial_number"] == "00M09A444444444"
  856. assert result["ip_address"] == "192.168.1.150"
  857. assert result["model"] == "P1S"
  858. assert result["is_active"] is True
  859. assert result["auto_archive"] is False
  860. @pytest.mark.asyncio
  861. @pytest.mark.integration
  862. async def test_printer_update_persists(self, async_client: AsyncClient, printer_factory, db_session):
  863. """CRITICAL: Verify printer updates persist."""
  864. printer = await printer_factory(name="Original", is_active=True)
  865. # Update
  866. await async_client.patch(f"/api/v1/printers/{printer.id}", json={"name": "Updated", "is_active": False})
  867. # Verify persistence
  868. response = await async_client.get(f"/api/v1/printers/{printer.id}")
  869. result = response.json()
  870. assert result["name"] == "Updated"
  871. assert result["is_active"] is False
  872. # ========================================================================
  873. # Refresh status endpoint
  874. # ========================================================================
  875. @pytest.mark.asyncio
  876. @pytest.mark.integration
  877. async def test_refresh_status_not_found(self, async_client: AsyncClient):
  878. """Verify 404 for non-existent printer."""
  879. response = await async_client.post("/api/v1/printers/99999/refresh-status")
  880. assert response.status_code == 404
  881. @pytest.mark.asyncio
  882. @pytest.mark.integration
  883. async def test_refresh_status_not_connected(self, async_client: AsyncClient, printer_factory):
  884. """Verify 400 when printer is not connected."""
  885. printer = await printer_factory(name="Disconnected Printer")
  886. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  887. mock_pm.request_status_update.return_value = False
  888. response = await async_client.post(f"/api/v1/printers/{printer.id}/refresh-status")
  889. assert response.status_code == 400
  890. assert "not connected" in response.json()["detail"].lower()
  891. @pytest.mark.asyncio
  892. @pytest.mark.integration
  893. async def test_refresh_status_success(self, async_client: AsyncClient, printer_factory):
  894. """Verify successful refresh request."""
  895. printer = await printer_factory(name="Connected Printer")
  896. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  897. mock_pm.request_status_update.return_value = True
  898. response = await async_client.post(f"/api/v1/printers/{printer.id}/refresh-status")
  899. assert response.status_code == 200
  900. assert response.json()["status"] == "refresh_requested"
  901. mock_pm.request_status_update.assert_called_once_with(printer.id)
  902. # ========================================================================
  903. # Current print user endpoint (Issue #206)
  904. # ========================================================================
  905. @pytest.mark.asyncio
  906. @pytest.mark.integration
  907. async def test_get_current_print_user_not_found(self, async_client: AsyncClient):
  908. """Verify 404 for non-existent printer."""
  909. response = await async_client.get("/api/v1/printers/99999/current-print-user")
  910. assert response.status_code == 404
  911. @pytest.mark.asyncio
  912. @pytest.mark.integration
  913. async def test_get_current_print_user_returns_empty_when_no_user(self, async_client: AsyncClient, printer_factory):
  914. """Verify empty object returned when no user is tracked."""
  915. printer = await printer_factory(name="Test Printer")
  916. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  917. mock_pm.get_current_print_user.return_value = None
  918. response = await async_client.get(f"/api/v1/printers/{printer.id}/current-print-user")
  919. assert response.status_code == 200
  920. assert response.json() == {}
  921. @pytest.mark.asyncio
  922. @pytest.mark.integration
  923. async def test_get_current_print_user_returns_user_info(self, async_client: AsyncClient, printer_factory):
  924. """Verify user info is returned when tracked."""
  925. printer = await printer_factory(name="Test Printer")
  926. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  927. mock_pm.get_current_print_user.return_value = {"user_id": 42, "username": "testuser"}
  928. response = await async_client.get(f"/api/v1/printers/{printer.id}/current-print-user")
  929. assert response.status_code == 200
  930. result = response.json()
  931. assert result["user_id"] == 42
  932. assert result["username"] == "testuser"
  933. class TestPrintControlAPI:
  934. """Integration tests for print control endpoints (stop, pause, resume)."""
  935. # ========================================================================
  936. # Stop print endpoint
  937. # ========================================================================
  938. @pytest.mark.asyncio
  939. @pytest.mark.integration
  940. async def test_stop_print_not_found(self, async_client: AsyncClient):
  941. """Verify 404 for non-existent printer."""
  942. response = await async_client.post("/api/v1/printers/99999/print/stop")
  943. assert response.status_code == 404
  944. @pytest.mark.asyncio
  945. @pytest.mark.integration
  946. async def test_stop_print_not_connected(self, async_client: AsyncClient, printer_factory):
  947. """Verify error when printer is not connected."""
  948. printer = await printer_factory(name="Disconnected Printer")
  949. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  950. mock_pm.get_client.return_value = None
  951. response = await async_client.post(f"/api/v1/printers/{printer.id}/print/stop")
  952. assert response.status_code == 400
  953. assert "not connected" in response.json()["detail"].lower()
  954. @pytest.mark.asyncio
  955. @pytest.mark.integration
  956. async def test_stop_print_success(self, async_client: AsyncClient, printer_factory):
  957. """Verify successful stop print request."""
  958. printer = await printer_factory(name="Printing Printer")
  959. mock_client = MagicMock()
  960. mock_client.stop_print.return_value = True
  961. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  962. mock_pm.get_client.return_value = mock_client
  963. response = await async_client.post(f"/api/v1/printers/{printer.id}/print/stop")
  964. assert response.status_code == 200
  965. assert response.json()["success"] is True
  966. mock_client.stop_print.assert_called_once()
  967. # ========================================================================
  968. # Pause print endpoint
  969. # ========================================================================
  970. @pytest.mark.asyncio
  971. @pytest.mark.integration
  972. async def test_pause_print_not_found(self, async_client: AsyncClient):
  973. """Verify 404 for non-existent printer."""
  974. response = await async_client.post("/api/v1/printers/99999/print/pause")
  975. assert response.status_code == 404
  976. @pytest.mark.asyncio
  977. @pytest.mark.integration
  978. async def test_pause_print_not_connected(self, async_client: AsyncClient, printer_factory):
  979. """Verify error when printer is not connected."""
  980. printer = await printer_factory(name="Disconnected Printer")
  981. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  982. mock_pm.get_client.return_value = None
  983. response = await async_client.post(f"/api/v1/printers/{printer.id}/print/pause")
  984. assert response.status_code == 400
  985. assert "not connected" in response.json()["detail"].lower()
  986. @pytest.mark.asyncio
  987. @pytest.mark.integration
  988. async def test_pause_print_success(self, async_client: AsyncClient, printer_factory):
  989. """Verify successful pause print request."""
  990. printer = await printer_factory(name="Printing Printer")
  991. mock_client = MagicMock()
  992. mock_client.pause_print.return_value = True
  993. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  994. mock_pm.get_client.return_value = mock_client
  995. response = await async_client.post(f"/api/v1/printers/{printer.id}/print/pause")
  996. assert response.status_code == 200
  997. assert response.json()["success"] is True
  998. mock_client.pause_print.assert_called_once()
  999. # ========================================================================
  1000. # Resume print endpoint
  1001. # ========================================================================
  1002. @pytest.mark.asyncio
  1003. @pytest.mark.integration
  1004. async def test_resume_print_not_found(self, async_client: AsyncClient):
  1005. """Verify 404 for non-existent printer."""
  1006. response = await async_client.post("/api/v1/printers/99999/print/resume")
  1007. assert response.status_code == 404
  1008. @pytest.mark.asyncio
  1009. @pytest.mark.integration
  1010. async def test_resume_print_not_connected(self, async_client: AsyncClient, printer_factory):
  1011. """Verify error when printer is not connected."""
  1012. printer = await printer_factory(name="Disconnected Printer")
  1013. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1014. mock_pm.get_client.return_value = None
  1015. response = await async_client.post(f"/api/v1/printers/{printer.id}/print/resume")
  1016. assert response.status_code == 400
  1017. assert "not connected" in response.json()["detail"].lower()
  1018. @pytest.mark.asyncio
  1019. @pytest.mark.integration
  1020. async def test_resume_print_success(self, async_client: AsyncClient, printer_factory):
  1021. """Verify successful resume print request."""
  1022. printer = await printer_factory(name="Paused Printer")
  1023. mock_client = MagicMock()
  1024. mock_client.resume_print.return_value = True
  1025. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1026. mock_pm.get_client.return_value = mock_client
  1027. response = await async_client.post(f"/api/v1/printers/{printer.id}/print/resume")
  1028. assert response.status_code == 200
  1029. assert response.json()["success"] is True
  1030. mock_client.resume_print.assert_called_once()
  1031. class TestAMSRefreshAPI:
  1032. """Integration tests for AMS slot refresh endpoint."""
  1033. @pytest.mark.asyncio
  1034. @pytest.mark.integration
  1035. async def test_ams_refresh_not_found(self, async_client: AsyncClient):
  1036. """Verify 404 for non-existent printer."""
  1037. response = await async_client.post("/api/v1/printers/99999/ams/0/slot/0/refresh")
  1038. assert response.status_code == 404
  1039. @pytest.mark.asyncio
  1040. @pytest.mark.integration
  1041. async def test_ams_refresh_not_connected(self, async_client: AsyncClient, printer_factory):
  1042. """Verify error when printer is not connected."""
  1043. printer = await printer_factory(name="Disconnected Printer")
  1044. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1045. mock_pm.get_client.return_value = None
  1046. response = await async_client.post(f"/api/v1/printers/{printer.id}/ams/0/slot/0/refresh")
  1047. assert response.status_code == 400
  1048. assert "not connected" in response.json()["detail"].lower()
  1049. @pytest.mark.asyncio
  1050. @pytest.mark.integration
  1051. async def test_ams_refresh_success(self, async_client: AsyncClient, printer_factory):
  1052. """Verify successful AMS refresh request."""
  1053. printer = await printer_factory(name="Printer with AMS")
  1054. mock_client = MagicMock()
  1055. mock_client.ams_refresh_tray = AsyncMock(return_value=(True, "Refreshing AMS 0 tray 1"))
  1056. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1057. mock_pm.get_client.return_value = mock_client
  1058. response = await async_client.post(f"/api/v1/printers/{printer.id}/ams/0/slot/1/refresh")
  1059. assert response.status_code == 200
  1060. result = response.json()
  1061. assert result["success"] is True
  1062. mock_client.ams_refresh_tray.assert_called_once_with(0, 1)
  1063. @pytest.mark.asyncio
  1064. @pytest.mark.integration
  1065. async def test_ams_refresh_filament_loaded(self, async_client: AsyncClient, printer_factory):
  1066. """Verify error when filament is loaded (can't refresh while loaded)."""
  1067. printer = await printer_factory(name="Printer with AMS")
  1068. mock_client = MagicMock()
  1069. mock_client.ams_refresh_tray = AsyncMock(return_value=(False, "Please unload filament first"))
  1070. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1071. mock_pm.get_client.return_value = mock_client
  1072. response = await async_client.post(f"/api/v1/printers/{printer.id}/ams/0/slot/0/refresh")
  1073. assert response.status_code == 400
  1074. assert "unload" in response.json()["detail"].lower()
  1075. class TestAMSLoadUnloadAPI:
  1076. """Integration tests for AMS load / unload endpoints (#891)."""
  1077. # ── load ─────────────────────────────────────────────────────────────────
  1078. @pytest.mark.asyncio
  1079. @pytest.mark.integration
  1080. async def test_load_invalid_tray_id(self, async_client: AsyncClient, printer_factory):
  1081. """tray_id outside {0..15, 254, 255} is rejected."""
  1082. printer = await printer_factory(name="P")
  1083. response = await async_client.post(f"/api/v1/printers/{printer.id}/ams/load?tray_id=99")
  1084. assert response.status_code == 400
  1085. @pytest.mark.asyncio
  1086. @pytest.mark.integration
  1087. async def test_load_not_found(self, async_client: AsyncClient):
  1088. response = await async_client.post("/api/v1/printers/99999/ams/load?tray_id=0")
  1089. assert response.status_code == 404
  1090. @pytest.mark.asyncio
  1091. @pytest.mark.integration
  1092. async def test_load_not_connected(self, async_client: AsyncClient, printer_factory):
  1093. printer = await printer_factory(name="Disconnected")
  1094. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1095. mock_pm.get_client.return_value = None
  1096. response = await async_client.post(f"/api/v1/printers/{printer.id}/ams/load?tray_id=0")
  1097. assert response.status_code == 400
  1098. assert "not connected" in response.json()["detail"].lower()
  1099. @pytest.mark.asyncio
  1100. @pytest.mark.integration
  1101. async def test_load_ams_slot_success(self, async_client: AsyncClient, printer_factory):
  1102. """tray_id=5 → AMS 1 slot 2 (1-indexed in the message)."""
  1103. printer = await printer_factory(name="P")
  1104. mock_client = MagicMock()
  1105. mock_client.ams_load_filament.return_value = True
  1106. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1107. mock_pm.get_client.return_value = mock_client
  1108. response = await async_client.post(f"/api/v1/printers/{printer.id}/ams/load?tray_id=5")
  1109. assert response.status_code == 200
  1110. mock_client.ams_load_filament.assert_called_once_with(5, extruder_id=None)
  1111. assert "AMS 1" in response.json()["message"]
  1112. @pytest.mark.asyncio
  1113. @pytest.mark.integration
  1114. async def test_load_external_left_success(self, async_client: AsyncClient, printer_factory):
  1115. """tray_id=254 → external spool / Ext-L."""
  1116. printer = await printer_factory(name="P")
  1117. mock_client = MagicMock()
  1118. mock_client.ams_load_filament.return_value = True
  1119. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1120. mock_pm.get_client.return_value = mock_client
  1121. response = await async_client.post(f"/api/v1/printers/{printer.id}/ams/load?tray_id=254")
  1122. assert response.status_code == 200
  1123. mock_client.ams_load_filament.assert_called_once_with(254, extruder_id=None)
  1124. assert "external" in response.json()["message"].lower()
  1125. @pytest.mark.asyncio
  1126. @pytest.mark.integration
  1127. async def test_load_external_right_success(self, async_client: AsyncClient, printer_factory):
  1128. """tray_id=255 → Ext-R on dual-nozzle H2D."""
  1129. printer = await printer_factory(name="H2D")
  1130. mock_client = MagicMock()
  1131. mock_client.ams_load_filament.return_value = True
  1132. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1133. mock_pm.get_client.return_value = mock_client
  1134. response = await async_client.post(f"/api/v1/printers/{printer.id}/ams/load?tray_id=255")
  1135. assert response.status_code == 200
  1136. mock_client.ams_load_filament.assert_called_once_with(255, extruder_id=None)
  1137. assert "Ext-R" in response.json()["message"]
  1138. @pytest.mark.asyncio
  1139. @pytest.mark.integration
  1140. async def test_load_mqtt_failure_returns_500(self, async_client: AsyncClient, printer_factory):
  1141. printer = await printer_factory(name="P")
  1142. mock_client = MagicMock()
  1143. mock_client.ams_load_filament.return_value = False
  1144. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1145. mock_pm.get_client.return_value = mock_client
  1146. response = await async_client.post(f"/api/v1/printers/{printer.id}/ams/load?tray_id=0")
  1147. assert response.status_code == 500
  1148. assert "failed" in response.json()["detail"].lower()
  1149. @pytest.mark.asyncio
  1150. @pytest.mark.integration
  1151. async def test_load_forwards_the_chosen_hotend(self, async_client: AsyncClient, printer_factory):
  1152. """A printer with a Filament Track Switch has to name the hotend to feed."""
  1153. printer = await printer_factory(name="P")
  1154. mock_client = MagicMock()
  1155. mock_client.ams_load_filament.return_value = True
  1156. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1157. mock_pm.get_client.return_value = mock_client
  1158. response = await async_client.post(f"/api/v1/printers/{printer.id}/ams/load?tray_id=5&extruder_id=1")
  1159. assert response.status_code == 200
  1160. mock_client.ams_load_filament.assert_called_once_with(5, extruder_id=1)
  1161. @pytest.mark.asyncio
  1162. @pytest.mark.integration
  1163. async def test_load_rejects_a_hotend_that_does_not_exist(self, async_client: AsyncClient, printer_factory):
  1164. """Only 0 and 1 are real hotends; anything else is a client bug."""
  1165. printer = await printer_factory(name="P")
  1166. response = await async_client.post(f"/api/v1/printers/{printer.id}/ams/load?tray_id=5&extruder_id=2")
  1167. assert response.status_code == 422
  1168. # ── unload ───────────────────────────────────────────────────────────────
  1169. @pytest.mark.asyncio
  1170. @pytest.mark.integration
  1171. async def test_unload_not_found(self, async_client: AsyncClient):
  1172. response = await async_client.post("/api/v1/printers/99999/ams/unload")
  1173. assert response.status_code == 404
  1174. @pytest.mark.asyncio
  1175. @pytest.mark.integration
  1176. async def test_unload_not_connected(self, async_client: AsyncClient, printer_factory):
  1177. printer = await printer_factory(name="Disconnected")
  1178. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1179. mock_pm.get_client.return_value = None
  1180. response = await async_client.post(f"/api/v1/printers/{printer.id}/ams/unload")
  1181. assert response.status_code == 400
  1182. assert "not connected" in response.json()["detail"].lower()
  1183. @pytest.mark.asyncio
  1184. @pytest.mark.integration
  1185. async def test_unload_success(self, async_client: AsyncClient, printer_factory):
  1186. printer = await printer_factory(name="P")
  1187. mock_client = MagicMock()
  1188. mock_client.ams_unload_filament.return_value = True
  1189. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1190. mock_pm.get_client.return_value = mock_client
  1191. response = await async_client.post(f"/api/v1/printers/{printer.id}/ams/unload")
  1192. assert response.status_code == 200
  1193. mock_client.ams_unload_filament.assert_called_once_with(None)
  1194. assert response.json()["success"] is True
  1195. @pytest.mark.asyncio
  1196. @pytest.mark.integration
  1197. async def test_unload_forwards_the_slot(self, async_client: AsyncClient, printer_factory):
  1198. """The slot is what tells a dual-nozzle printer which hotend to unload."""
  1199. printer = await printer_factory(name="P")
  1200. mock_client = MagicMock()
  1201. mock_client.ams_unload_filament.return_value = True
  1202. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1203. mock_pm.get_client.return_value = mock_client
  1204. response = await async_client.post(f"/api/v1/printers/{printer.id}/ams/unload?tray_id=2")
  1205. assert response.status_code == 200
  1206. mock_client.ams_unload_filament.assert_called_once_with(2)
  1207. @pytest.mark.asyncio
  1208. @pytest.mark.integration
  1209. async def test_unload_of_an_unloaded_slot_is_a_conflict_not_a_fault(
  1210. self, async_client: AsyncClient, printer_factory
  1211. ):
  1212. """Clicking Unload on an idle slot is a no-op the operator can understand.
  1213. A 500 would read as a broken printer; the menu is per-slot and picking a
  1214. slot no hotend is fed from is an ordinary mistake.
  1215. """
  1216. printer = await printer_factory(name="P")
  1217. mock_client = MagicMock()
  1218. mock_client.ams_unload_filament.return_value = False
  1219. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1220. mock_pm.get_client.return_value = mock_client
  1221. response = await async_client.post(f"/api/v1/printers/{printer.id}/ams/unload?tray_id=2")
  1222. assert response.status_code == 409
  1223. @pytest.mark.asyncio
  1224. @pytest.mark.integration
  1225. async def test_unload_rejects_an_invalid_slot(self, async_client: AsyncClient, printer_factory):
  1226. printer = await printer_factory(name="P")
  1227. response = await async_client.post(f"/api/v1/printers/{printer.id}/ams/unload?tray_id=99")
  1228. assert response.status_code == 400
  1229. @pytest.mark.asyncio
  1230. @pytest.mark.integration
  1231. async def test_unload_mqtt_failure_returns_500(self, async_client: AsyncClient, printer_factory):
  1232. printer = await printer_factory(name="P")
  1233. mock_client = MagicMock()
  1234. mock_client.ams_unload_filament.return_value = False
  1235. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1236. mock_pm.get_client.return_value = mock_client
  1237. response = await async_client.post(f"/api/v1/printers/{printer.id}/ams/unload")
  1238. assert response.status_code == 500
  1239. assert "failed" in response.json()["detail"].lower()
  1240. class TestConfigureAMSSlotAPI:
  1241. """Integration tests for AMS slot configure endpoint — tray_info_idx resolution."""
  1242. @pytest.mark.asyncio
  1243. @pytest.mark.integration
  1244. async def test_configure_not_connected(self, async_client: AsyncClient, printer_factory):
  1245. """Verify error when printer is not connected."""
  1246. printer = await printer_factory(name="Disconnected")
  1247. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1248. mock_pm.get_client.return_value = None
  1249. response = await async_client.post(
  1250. f"/api/v1/printers/{printer.id}/slots/0/0/configure",
  1251. params={
  1252. "tray_info_idx": "GFL99",
  1253. "tray_type": "PLA",
  1254. "tray_sub_brands": "PLA Basic",
  1255. "tray_color": "FF0000FF",
  1256. "nozzle_temp_min": 190,
  1257. "nozzle_temp_max": 230,
  1258. },
  1259. )
  1260. assert response.status_code == 400
  1261. assert "not connected" in response.json()["detail"].lower()
  1262. @pytest.mark.asyncio
  1263. @pytest.mark.integration
  1264. async def test_configure_with_gf_id_keeps_it(self, async_client: AsyncClient, printer_factory):
  1265. """Standard Bambu GF* filament IDs are sent as-is."""
  1266. printer = await printer_factory(name="H2D")
  1267. mock_client = MagicMock()
  1268. mock_client.ams_set_filament_setting.return_value = True
  1269. mock_client.extrusion_cali_sel.return_value = True
  1270. mock_client.request_status_update.return_value = True
  1271. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1272. mock_pm.get_client.return_value = mock_client
  1273. mock_pm.get_status.return_value = None # No existing state
  1274. response = await async_client.post(
  1275. f"/api/v1/printers/{printer.id}/slots/2/3/configure",
  1276. params={
  1277. "tray_info_idx": "GFL05",
  1278. "tray_type": "PLA",
  1279. "tray_sub_brands": "PLA Basic",
  1280. "tray_color": "FFFFFFFF",
  1281. "nozzle_temp_min": 190,
  1282. "nozzle_temp_max": 230,
  1283. },
  1284. )
  1285. assert response.status_code == 200
  1286. call_kwargs = mock_client.ams_set_filament_setting.call_args
  1287. assert call_kwargs.kwargs["tray_info_idx"] == "GFL05"
  1288. @pytest.mark.asyncio
  1289. @pytest.mark.integration
  1290. async def test_configure_builtin_empty_setting_id_is_derived(self, async_client: AsyncClient, printer_factory):
  1291. """A built-in preset (GF* tray_info_idx, empty setting_id) gets a derived GFS* setting_id (#2604).
  1292. The Configure AMS Slot modal sends built-in / local / Orca-generic presets with an
  1293. empty setting_id. Publishing a filament-id-without-setting-id slot makes the printer
  1294. treat it as half configured and revert to its previous profile, so the route must
  1295. back-fill setting_id from the resolved tray_info_idx.
  1296. """
  1297. printer = await printer_factory(name="X1C")
  1298. mock_client = MagicMock()
  1299. mock_client.ams_set_filament_setting.return_value = True
  1300. mock_client.extrusion_cali_sel.return_value = True
  1301. mock_client.request_status_update.return_value = True
  1302. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1303. mock_pm.get_client.return_value = mock_client
  1304. mock_pm.get_status.return_value = None
  1305. response = await async_client.post(
  1306. f"/api/v1/printers/{printer.id}/slots/0/1/configure",
  1307. params={
  1308. "tray_info_idx": "GFB99", # Generic ABS, built-in
  1309. "tray_type": "ABS",
  1310. "tray_sub_brands": "Generic ABS",
  1311. "tray_color": "000000FF",
  1312. "nozzle_temp_min": 240,
  1313. "nozzle_temp_max": 280,
  1314. # setting_id intentionally omitted (empty) — as the modal sends it
  1315. },
  1316. )
  1317. assert response.status_code == 200
  1318. call_kwargs = mock_client.ams_set_filament_setting.call_args
  1319. assert call_kwargs.kwargs["tray_info_idx"] == "GFB99"
  1320. assert call_kwargs.kwargs["setting_id"] == "GFSB99"
  1321. @pytest.mark.asyncio
  1322. @pytest.mark.integration
  1323. async def test_configure_generic_material_fallback_derives_setting_id(
  1324. self, async_client: AsyncClient, printer_factory
  1325. ):
  1326. """When only a material is given, the generic tray_info_idx fallback still yields a setting_id (#2604)."""
  1327. printer = await printer_factory(name="X1C")
  1328. mock_client = MagicMock()
  1329. mock_client.ams_set_filament_setting.return_value = True
  1330. mock_client.extrusion_cali_sel.return_value = True
  1331. mock_client.request_status_update.return_value = True
  1332. mock_status = MagicMock()
  1333. mock_status.raw_data = {"ams": {"ams": []}} # No existing tray to reuse
  1334. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1335. mock_pm.get_client.return_value = mock_client
  1336. mock_pm.get_status.return_value = mock_status
  1337. response = await async_client.post(
  1338. f"/api/v1/printers/{printer.id}/slots/0/1/configure",
  1339. params={
  1340. "tray_info_idx": "", # No preset id — route derives generic from material
  1341. "tray_type": "ABS",
  1342. "tray_sub_brands": "Generic ABS",
  1343. "tray_color": "000000FF",
  1344. "nozzle_temp_min": 240,
  1345. "nozzle_temp_max": 280,
  1346. },
  1347. )
  1348. assert response.status_code == 200
  1349. call_kwargs = mock_client.ams_set_filament_setting.call_args
  1350. assert call_kwargs.kwargs["tray_info_idx"] == "GFB99"
  1351. assert call_kwargs.kwargs["setting_id"] == "GFSB99"
  1352. @pytest.mark.asyncio
  1353. @pytest.mark.integration
  1354. async def test_configure_pfus_never_reaches_tray_info_idx(self, async_client: AsyncClient, printer_factory):
  1355. """A PFUS* cloud setting_id is refused as tray_info_idx (#3003).
  1356. The printer's tray_info_idx field is 8 characters. An 18-character PFUS
  1357. is stored truncated and acknowledged as a success -- measured on the A1
  1358. in the #3003 bundle, which sent PFUS9ddc938fe3ab8f and read back
  1359. PFUS9DDC. That leaves the slot holding an id nothing resolves, so the
  1360. slicer shows "Generic" and the calibration table loses the slot too.
  1361. A generic for the material is strictly better, and the preset reference
  1362. survives in setting_id, which does accept a PFUS.
  1363. Reverses the contract #1053 pinned; see the route's own comment.
  1364. """
  1365. printer = await printer_factory(name="H2D")
  1366. mock_client = MagicMock()
  1367. mock_client.ams_set_filament_setting.return_value = True
  1368. mock_client.extrusion_cali_sel.return_value = True
  1369. mock_client.request_status_update.return_value = True
  1370. mock_status = MagicMock()
  1371. mock_status.raw_data = {"ams": {"ams": []}} # No existing tray data
  1372. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1373. mock_pm.get_client.return_value = mock_client
  1374. mock_pm.get_status.return_value = mock_status
  1375. response = await async_client.post(
  1376. f"/api/v1/printers/{printer.id}/slots/2/3/configure",
  1377. params={
  1378. "tray_info_idx": "PFUS9ac902733670a9",
  1379. "tray_type": "PLA",
  1380. "tray_sub_brands": "Devil Design PLA",
  1381. "tray_color": "FF0000FF",
  1382. "nozzle_temp_min": 190,
  1383. "nozzle_temp_max": 230,
  1384. },
  1385. )
  1386. assert response.status_code == 200
  1387. call_kwargs = mock_client.ams_set_filament_setting.call_args
  1388. # No tray to reuse -> generic for the material, never the raw PFUS.
  1389. assert call_kwargs.kwargs["tray_info_idx"] == "GFL99"
  1390. # The preset reference is not lost: it moves to the field that holds it.
  1391. assert call_kwargs.kwargs["setting_id"] == "PFUS9ac902733670a9"
  1392. @pytest.mark.asyncio
  1393. @pytest.mark.integration
  1394. async def test_configure_pfus_falls_back_to_slot_preset(self, async_client: AsyncClient, printer_factory):
  1395. """With a PFUS refused, the slot's own resolvable preset is reused (#3003).
  1396. The slot already carries P4d64437 -- a local preset id, 8 characters, so
  1397. the printer can actually store it -- for the same material. That beats a
  1398. generic, and it is what the slot's calibration is keyed by.
  1399. """
  1400. printer = await printer_factory(name="H2D")
  1401. mock_client = MagicMock()
  1402. mock_client.ams_set_filament_setting.return_value = True
  1403. mock_client.extrusion_cali_sel.return_value = True
  1404. mock_client.request_status_update.return_value = True
  1405. # Simulate slot already configured by slicer with cloud-synced preset
  1406. mock_status = MagicMock()
  1407. mock_status.raw_data = {
  1408. "ams": {
  1409. "ams": [
  1410. {
  1411. "id": 2,
  1412. "tray": [
  1413. {
  1414. "id": 3,
  1415. "tray_info_idx": "P4d64437",
  1416. "tray_type": "PLA",
  1417. "tray_color": "FF0000FF",
  1418. }
  1419. ],
  1420. }
  1421. ]
  1422. }
  1423. }
  1424. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1425. mock_pm.get_client.return_value = mock_client
  1426. mock_pm.get_status.return_value = mock_status
  1427. response = await async_client.post(
  1428. f"/api/v1/printers/{printer.id}/slots/2/3/configure",
  1429. params={
  1430. "tray_info_idx": "PFUS9ac902733670a9",
  1431. "tray_type": "PLA",
  1432. "tray_sub_brands": "Devil Design PLA",
  1433. "tray_color": "FF0000FF",
  1434. "nozzle_temp_min": 190,
  1435. "nozzle_temp_max": 230,
  1436. },
  1437. )
  1438. assert response.status_code == 200
  1439. call_kwargs = mock_client.ams_set_filament_setting.call_args
  1440. # Slot's own storable preset wins over both the PFUS and a generic.
  1441. assert call_kwargs.kwargs["tray_info_idx"] == "P4d64437"
  1442. assert call_kwargs.kwargs["setting_id"] == "PFUS9ac902733670a9"
  1443. @pytest.mark.asyncio
  1444. @pytest.mark.integration
  1445. async def test_configure_pfus_generic_when_slot_material_differs(self, async_client: AsyncClient, printer_factory):
  1446. """A slot holding a different material is not reused (#3003).
  1447. Slot has generic PETG, the user is configuring PLA. Neither the refused
  1448. PFUS nor the mismatched slot can supply a filament id, so the generic
  1449. for the requested material does.
  1450. """
  1451. printer = await printer_factory(name="H2D")
  1452. mock_client = MagicMock()
  1453. mock_client.ams_set_filament_setting.return_value = True
  1454. mock_client.extrusion_cali_sel.return_value = True
  1455. mock_client.request_status_update.return_value = True
  1456. # Slot currently has PETG but user is configuring PLA
  1457. mock_status = MagicMock()
  1458. mock_status.raw_data = {
  1459. "ams": {
  1460. "ams": [
  1461. {
  1462. "id": 2,
  1463. "tray": [{"id": 3, "tray_info_idx": "GFG99", "tray_type": "PETG", "tray_color": "FFFFFFFF"}],
  1464. }
  1465. ]
  1466. }
  1467. }
  1468. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1469. mock_pm.get_client.return_value = mock_client
  1470. mock_pm.get_status.return_value = mock_status
  1471. response = await async_client.post(
  1472. f"/api/v1/printers/{printer.id}/slots/2/3/configure",
  1473. params={
  1474. "tray_info_idx": "PFUS9ac902733670a9",
  1475. "tray_type": "PLA",
  1476. "tray_sub_brands": "Devil Design PLA",
  1477. "tray_color": "FF0000FF",
  1478. "nozzle_temp_min": 190,
  1479. "nozzle_temp_max": 230,
  1480. },
  1481. )
  1482. assert response.status_code == 200
  1483. call_kwargs = mock_client.ams_set_filament_setting.call_args
  1484. assert call_kwargs.kwargs["tray_info_idx"] == "GFL99"
  1485. assert call_kwargs.kwargs["setting_id"] == "PFUS9ac902733670a9"
  1486. @pytest.mark.asyncio
  1487. @pytest.mark.integration
  1488. async def test_configure_empty_id_uses_generic(self, async_client: AsyncClient, printer_factory):
  1489. """Empty tray_info_idx (local preset) is replaced with generic."""
  1490. printer = await printer_factory(name="H2D")
  1491. mock_client = MagicMock()
  1492. mock_client.ams_set_filament_setting.return_value = True
  1493. mock_client.extrusion_cali_sel.return_value = True
  1494. mock_client.request_status_update.return_value = True
  1495. mock_status = MagicMock()
  1496. mock_status.raw_data = {"ams": {"ams": []}}
  1497. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1498. mock_pm.get_client.return_value = mock_client
  1499. mock_pm.get_status.return_value = mock_status
  1500. response = await async_client.post(
  1501. f"/api/v1/printers/{printer.id}/slots/2/3/configure",
  1502. params={
  1503. "tray_info_idx": "",
  1504. "tray_type": "PETG",
  1505. "tray_sub_brands": "PETG Basic",
  1506. "tray_color": "FFFFFFFF",
  1507. "nozzle_temp_min": 220,
  1508. "nozzle_temp_max": 260,
  1509. },
  1510. )
  1511. assert response.status_code == 200
  1512. call_kwargs = mock_client.ams_set_filament_setting.call_args
  1513. assert call_kwargs.kwargs["tray_info_idx"] == "GFG99"
  1514. @pytest.mark.asyncio
  1515. @pytest.mark.integration
  1516. async def test_configure_pfus_pair_splits_into_generic_and_setting_id(
  1517. self, async_client: AsyncClient, printer_factory
  1518. ):
  1519. """A PFUS sent in BOTH fields is kept only in setting_id (#3003).
  1520. This is the shape the frontend produced when a custom cloud preset's
  1521. detail had filament_id=null, and what #1053 pinned. The A1 measurement
  1522. in #3003 showed where it ends up: the printer truncates tray_info_idx
  1523. to 8 characters, so the slot resolves to nothing and the slicer falls
  1524. back to "Generic" anyway -- the very outcome #1053 set out to avoid,
  1525. plus a broken calibration key. Sending the generic deliberately gets
  1526. the same slicer result honestly and keeps the slot calibratable, and
  1527. setting_id still carries the user's preset.
  1528. """
  1529. printer = await printer_factory(name="H2D")
  1530. mock_client = MagicMock()
  1531. mock_client.ams_set_filament_setting.return_value = True
  1532. mock_client.extrusion_cali_sel.return_value = True
  1533. mock_client.request_status_update.return_value = True
  1534. mock_status = MagicMock()
  1535. mock_status.raw_data = {"ams": {"ams": []}}
  1536. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1537. mock_pm.get_client.return_value = mock_client
  1538. mock_pm.get_status.return_value = mock_status
  1539. response = await async_client.post(
  1540. f"/api/v1/printers/{printer.id}/slots/128/0/configure",
  1541. params={
  1542. "tray_info_idx": "PFUSa8fb76f9733e3c",
  1543. "tray_type": "ABS",
  1544. "tray_sub_brands": "Sting3D ABS",
  1545. "tray_color": "000000FF",
  1546. "nozzle_temp_min": 240,
  1547. "nozzle_temp_max": 280,
  1548. "setting_id": "PFUSa8fb76f9733e3c",
  1549. },
  1550. )
  1551. assert response.status_code == 200
  1552. call_kwargs = mock_client.ams_set_filament_setting.call_args
  1553. assert call_kwargs.kwargs["tray_info_idx"] == "GFB99"
  1554. assert call_kwargs.kwargs["setting_id"] == "PFUSa8fb76f9733e3c"
  1555. @pytest.mark.asyncio
  1556. @pytest.mark.integration
  1557. async def test_configure_pfcn_refused_as_tray_info_idx(self, async_client: AsyncClient, printer_factory):
  1558. """PFCN* shared / partner presets are refused the same way (#3003, #1648).
  1559. Same 18-character shape as a PFUS, same truncation. Polymaker's
  1560. "(Custom)" H2D variants are the ones that reach this in the wild.
  1561. """
  1562. printer = await printer_factory(name="H2D")
  1563. mock_client = MagicMock()
  1564. mock_client.ams_set_filament_setting.return_value = True
  1565. mock_client.extrusion_cali_sel.return_value = True
  1566. mock_client.request_status_update.return_value = True
  1567. mock_status = MagicMock()
  1568. mock_status.raw_data = {"ams": {"ams": []}}
  1569. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1570. mock_pm.get_client.return_value = mock_client
  1571. mock_pm.get_status.return_value = mock_status
  1572. response = await async_client.post(
  1573. f"/api/v1/printers/{printer.id}/slots/0/1/configure",
  1574. params={
  1575. "tray_info_idx": "PFCN2a91c7d0e4b118",
  1576. "tray_type": "PETG",
  1577. "tray_sub_brands": "Polymaker PETG (Custom)",
  1578. "tray_color": "0000FFFF",
  1579. "nozzle_temp_min": 220,
  1580. "nozzle_temp_max": 260,
  1581. },
  1582. )
  1583. assert response.status_code == 200
  1584. call_kwargs = mock_client.ams_set_filament_setting.call_args
  1585. assert call_kwargs.kwargs["tray_info_idx"] == "GFG99"
  1586. assert call_kwargs.kwargs["setting_id"] == "PFCN2a91c7d0e4b118"
  1587. class TestSkipObjectsAPI:
  1588. """Integration tests for skip objects endpoints."""
  1589. # ========================================================================
  1590. # Get printable objects endpoint
  1591. # ========================================================================
  1592. @pytest.mark.asyncio
  1593. @pytest.mark.integration
  1594. async def test_get_objects_not_found(self, async_client: AsyncClient):
  1595. """Verify 404 for non-existent printer."""
  1596. response = await async_client.get("/api/v1/printers/99999/print/objects")
  1597. assert response.status_code == 404
  1598. @pytest.mark.asyncio
  1599. @pytest.mark.integration
  1600. async def test_get_objects_not_connected(self, async_client: AsyncClient, printer_factory):
  1601. """Verify error when printer is not connected."""
  1602. printer = await printer_factory(name="Disconnected Printer")
  1603. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1604. mock_pm.get_client.return_value = None
  1605. response = await async_client.get(f"/api/v1/printers/{printer.id}/print/objects")
  1606. assert response.status_code == 400
  1607. assert "not connected" in response.json()["detail"].lower()
  1608. @pytest.mark.asyncio
  1609. @pytest.mark.integration
  1610. async def test_get_objects_empty(self, async_client: AsyncClient, printer_factory):
  1611. """Verify empty objects list when no print is active."""
  1612. printer = await printer_factory(name="Idle Printer")
  1613. mock_client = MagicMock()
  1614. mock_client.state.printable_objects = {}
  1615. mock_client.state.skipped_objects = []
  1616. mock_client.state.state = "IDLE"
  1617. mock_client.state.subtask_name = None # Prevent FTP download attempt
  1618. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1619. mock_pm.get_client.return_value = mock_client
  1620. response = await async_client.get(f"/api/v1/printers/{printer.id}/print/objects")
  1621. assert response.status_code == 200
  1622. result = response.json()
  1623. assert result["objects"] == []
  1624. assert result["total"] == 0
  1625. assert result["skipped_count"] == 0
  1626. assert result["is_printing"] is False
  1627. @pytest.mark.asyncio
  1628. @pytest.mark.integration
  1629. async def test_get_objects_with_data(self, async_client: AsyncClient, printer_factory):
  1630. """Verify objects list when print is active."""
  1631. printer = await printer_factory(name="Printing Printer")
  1632. mock_client = MagicMock()
  1633. mock_client.state.printable_objects = {100: "Part A", 200: "Part B", 300: "Part C"}
  1634. mock_client.state.skipped_objects = [200]
  1635. mock_client.state.state = "RUNNING"
  1636. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1637. mock_pm.get_client.return_value = mock_client
  1638. response = await async_client.get(f"/api/v1/printers/{printer.id}/print/objects")
  1639. assert response.status_code == 200
  1640. result = response.json()
  1641. assert result["total"] == 3
  1642. assert result["skipped_count"] == 1
  1643. assert result["is_printing"] is True
  1644. # Check objects have correct structure
  1645. objects_by_id = {obj["id"]: obj for obj in result["objects"]}
  1646. assert objects_by_id[100]["name"] == "Part A"
  1647. assert objects_by_id[100]["skipped"] is False
  1648. assert objects_by_id[200]["name"] == "Part B"
  1649. assert objects_by_id[200]["skipped"] is True
  1650. assert objects_by_id[300]["name"] == "Part C"
  1651. assert objects_by_id[300]["skipped"] is False
  1652. # ========================================================================
  1653. # Skip objects endpoint
  1654. # ========================================================================
  1655. @pytest.mark.asyncio
  1656. @pytest.mark.integration
  1657. async def test_get_objects_with_positions(self, async_client: AsyncClient, printer_factory):
  1658. """Verify objects list includes position data when available."""
  1659. printer = await printer_factory(name="Printing Printer")
  1660. # New format with position data
  1661. mock_client = MagicMock()
  1662. mock_client.state.printable_objects = {
  1663. 100: {"name": "Part A", "x": 50.0, "y": 100.0},
  1664. 200: {"name": "Part B", "x": 150.0, "y": 100.0},
  1665. }
  1666. mock_client.state.skipped_objects = []
  1667. mock_client.state.state = "RUNNING"
  1668. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1669. mock_pm.get_client.return_value = mock_client
  1670. response = await async_client.get(f"/api/v1/printers/{printer.id}/print/objects")
  1671. assert response.status_code == 200
  1672. result = response.json()
  1673. assert result["total"] == 2
  1674. # Check objects have position data
  1675. objects_by_id = {obj["id"]: obj for obj in result["objects"]}
  1676. assert objects_by_id[100]["name"] == "Part A"
  1677. assert objects_by_id[100]["x"] == 50.0
  1678. assert objects_by_id[100]["y"] == 100.0
  1679. assert objects_by_id[200]["name"] == "Part B"
  1680. assert objects_by_id[200]["x"] == 150.0
  1681. assert objects_by_id[200]["y"] == 100.0
  1682. # ========================================================================
  1683. # Skip objects endpoint
  1684. # ========================================================================
  1685. @pytest.mark.asyncio
  1686. @pytest.mark.integration
  1687. async def test_skip_objects_not_found(self, async_client: AsyncClient):
  1688. """Verify 404 for non-existent printer."""
  1689. response = await async_client.post("/api/v1/printers/99999/print/skip-objects", json=[100])
  1690. assert response.status_code == 404
  1691. @pytest.mark.asyncio
  1692. @pytest.mark.integration
  1693. async def test_skip_objects_not_connected(self, async_client: AsyncClient, printer_factory):
  1694. """Verify error when printer is not connected."""
  1695. printer = await printer_factory(name="Disconnected Printer")
  1696. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1697. mock_pm.get_client.return_value = None
  1698. response = await async_client.post(f"/api/v1/printers/{printer.id}/print/skip-objects", json=[100])
  1699. assert response.status_code == 400
  1700. assert "not connected" in response.json()["detail"].lower()
  1701. @pytest.mark.asyncio
  1702. @pytest.mark.integration
  1703. async def test_skip_objects_empty_list(self, async_client: AsyncClient, printer_factory):
  1704. """Verify error when no object IDs provided."""
  1705. printer = await printer_factory(name="Printing Printer")
  1706. mock_client = MagicMock()
  1707. mock_client.state.printable_objects = {100: "Part A"}
  1708. mock_client.state.skipped_objects = []
  1709. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1710. mock_pm.get_client.return_value = mock_client
  1711. response = await async_client.post(f"/api/v1/printers/{printer.id}/print/skip-objects", json=[])
  1712. assert response.status_code == 400
  1713. assert "no object" in response.json()["detail"].lower()
  1714. @pytest.mark.asyncio
  1715. @pytest.mark.integration
  1716. async def test_skip_objects_invalid_id(self, async_client: AsyncClient, printer_factory):
  1717. """Verify error when object ID doesn't exist."""
  1718. printer = await printer_factory(name="Printing Printer")
  1719. mock_client = MagicMock()
  1720. mock_client.state.printable_objects = {100: "Part A"}
  1721. mock_client.state.skipped_objects = []
  1722. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1723. mock_pm.get_client.return_value = mock_client
  1724. response = await async_client.post(f"/api/v1/printers/{printer.id}/print/skip-objects", json=[999])
  1725. assert response.status_code == 400
  1726. assert "invalid" in response.json()["detail"].lower()
  1727. @pytest.mark.asyncio
  1728. @pytest.mark.integration
  1729. async def test_skip_objects_success(self, async_client: AsyncClient, printer_factory):
  1730. """Verify successful skip objects request."""
  1731. printer = await printer_factory(name="Printing Printer")
  1732. mock_client = MagicMock()
  1733. mock_client.state.printable_objects = {100: "Part A", 200: "Part B"}
  1734. mock_client.state.skipped_objects = []
  1735. mock_client.skip_objects.return_value = True
  1736. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1737. mock_pm.get_client.return_value = mock_client
  1738. response = await async_client.post(f"/api/v1/printers/{printer.id}/print/skip-objects", json=[100])
  1739. assert response.status_code == 200
  1740. result = response.json()
  1741. assert result["success"] is True
  1742. assert 100 in result["skipped_objects"]
  1743. mock_client.skip_objects.assert_called_once_with([100])
  1744. @pytest.mark.asyncio
  1745. @pytest.mark.integration
  1746. async def test_skip_objects_multiple(self, async_client: AsyncClient, printer_factory):
  1747. """Verify skipping multiple objects at once."""
  1748. printer = await printer_factory(name="Printing Printer")
  1749. mock_client = MagicMock()
  1750. mock_client.state.printable_objects = {100: "Part A", 200: "Part B", 300: "Part C"}
  1751. mock_client.state.skipped_objects = []
  1752. mock_client.skip_objects.return_value = True
  1753. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1754. mock_pm.get_client.return_value = mock_client
  1755. response = await async_client.post(f"/api/v1/printers/{printer.id}/print/skip-objects", json=[100, 200])
  1756. assert response.status_code == 200
  1757. result = response.json()
  1758. assert result["success"] is True
  1759. assert 100 in result["skipped_objects"]
  1760. assert 200 in result["skipped_objects"]
  1761. mock_client.skip_objects.assert_called_once_with([100, 200])
  1762. class TestChamberLightAPI:
  1763. """Integration tests for chamber light control endpoint."""
  1764. @pytest.mark.asyncio
  1765. @pytest.mark.integration
  1766. async def test_chamber_light_not_found(self, async_client: AsyncClient):
  1767. """Verify 404 for non-existent printer."""
  1768. response = await async_client.post("/api/v1/printers/99999/chamber-light?on=true")
  1769. assert response.status_code == 404
  1770. @pytest.mark.asyncio
  1771. @pytest.mark.integration
  1772. async def test_chamber_light_not_connected(self, async_client: AsyncClient, printer_factory):
  1773. """Verify error when printer is not connected."""
  1774. printer = await printer_factory(name="Disconnected Printer")
  1775. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1776. mock_pm.get_client.return_value = None
  1777. response = await async_client.post(f"/api/v1/printers/{printer.id}/chamber-light?on=true")
  1778. assert response.status_code == 400
  1779. assert "not connected" in response.json()["detail"].lower()
  1780. @pytest.mark.asyncio
  1781. @pytest.mark.integration
  1782. async def test_chamber_light_on_success(self, async_client: AsyncClient, printer_factory):
  1783. """Verify successful chamber light on request."""
  1784. printer = await printer_factory(name="Test Printer")
  1785. mock_client = MagicMock()
  1786. mock_client.set_chamber_light.return_value = True
  1787. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1788. mock_pm.get_client.return_value = mock_client
  1789. response = await async_client.post(f"/api/v1/printers/{printer.id}/chamber-light?on=true")
  1790. assert response.status_code == 200
  1791. result = response.json()
  1792. assert result["success"] is True
  1793. assert "on" in result["message"].lower()
  1794. mock_client.set_chamber_light.assert_called_once_with(True)
  1795. @pytest.mark.asyncio
  1796. @pytest.mark.integration
  1797. async def test_chamber_light_off_success(self, async_client: AsyncClient, printer_factory):
  1798. """Verify successful chamber light off request."""
  1799. printer = await printer_factory(name="Test Printer")
  1800. mock_client = MagicMock()
  1801. mock_client.set_chamber_light.return_value = True
  1802. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1803. mock_pm.get_client.return_value = mock_client
  1804. response = await async_client.post(f"/api/v1/printers/{printer.id}/chamber-light?on=false")
  1805. assert response.status_code == 200
  1806. result = response.json()
  1807. assert result["success"] is True
  1808. assert "off" in result["message"].lower()
  1809. mock_client.set_chamber_light.assert_called_once_with(False)
  1810. @pytest.mark.asyncio
  1811. @pytest.mark.integration
  1812. async def test_chamber_light_failure(self, async_client: AsyncClient, printer_factory):
  1813. """Verify error handling when chamber light control fails."""
  1814. printer = await printer_factory(name="Test Printer")
  1815. mock_client = MagicMock()
  1816. mock_client.set_chamber_light.return_value = False
  1817. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1818. mock_pm.get_client.return_value = mock_client
  1819. response = await async_client.post(f"/api/v1/printers/{printer.id}/chamber-light?on=true")
  1820. assert response.status_code == 500
  1821. assert "failed" in response.json()["detail"].lower()
  1822. class TestAirductModeAPI:
  1823. """Integration tests for the airduct mode endpoint (P2S/H2*)."""
  1824. @pytest.mark.asyncio
  1825. @pytest.mark.integration
  1826. async def test_invalid_mode_rejected(self, async_client: AsyncClient, printer_factory):
  1827. printer = await printer_factory(name="P", model="P2S")
  1828. response = await async_client.post(f"/api/v1/printers/{printer.id}/airduct-mode?mode=foo")
  1829. assert response.status_code == 400
  1830. @pytest.mark.asyncio
  1831. @pytest.mark.integration
  1832. async def test_not_connected(self, async_client: AsyncClient, printer_factory):
  1833. printer = await printer_factory(name="P", model="P2S")
  1834. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1835. mock_pm.get_client.return_value = None
  1836. response = await async_client.post(f"/api/v1/printers/{printer.id}/airduct-mode?mode=cooling")
  1837. assert response.status_code == 400
  1838. @pytest.mark.asyncio
  1839. @pytest.mark.integration
  1840. async def test_cooling_success(self, async_client: AsyncClient, printer_factory):
  1841. printer = await printer_factory(name="P", model="P2S")
  1842. mock_client = MagicMock()
  1843. mock_client.set_airduct_mode.return_value = True
  1844. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1845. mock_pm.get_client.return_value = mock_client
  1846. response = await async_client.post(f"/api/v1/printers/{printer.id}/airduct-mode?mode=cooling")
  1847. assert response.status_code == 200
  1848. assert response.json()["success"] is True
  1849. mock_client.set_airduct_mode.assert_called_once_with("cooling")
  1850. @pytest.mark.asyncio
  1851. @pytest.mark.integration
  1852. async def test_heating_failure_returns_500(self, async_client: AsyncClient, printer_factory):
  1853. printer = await printer_factory(name="P", model="P2S")
  1854. mock_client = MagicMock()
  1855. mock_client.set_airduct_mode.return_value = False
  1856. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1857. mock_pm.get_client.return_value = mock_client
  1858. response = await async_client.post(f"/api/v1/printers/{printer.id}/airduct-mode?mode=heating")
  1859. assert response.status_code == 500
  1860. class TestClearHMSErrorsAPI:
  1861. """Integration tests for clear HMS errors endpoint."""
  1862. @pytest.mark.asyncio
  1863. @pytest.mark.integration
  1864. async def test_clear_hms_errors_not_found(self, async_client: AsyncClient):
  1865. """Verify 404 for non-existent printer."""
  1866. response = await async_client.post("/api/v1/printers/99999/hms/clear")
  1867. assert response.status_code == 404
  1868. @pytest.mark.asyncio
  1869. @pytest.mark.integration
  1870. async def test_clear_hms_errors_not_connected(self, async_client: AsyncClient, printer_factory):
  1871. """Verify error when printer is not connected."""
  1872. printer = await printer_factory(name="Disconnected Printer")
  1873. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1874. mock_pm.get_client.return_value = None
  1875. response = await async_client.post(f"/api/v1/printers/{printer.id}/hms/clear")
  1876. assert response.status_code == 400
  1877. assert "not connected" in response.json()["detail"].lower()
  1878. @pytest.mark.asyncio
  1879. @pytest.mark.integration
  1880. async def test_clear_hms_errors_success(self, async_client: AsyncClient, printer_factory):
  1881. """Verify successful clear HMS errors request."""
  1882. printer = await printer_factory(name="Test Printer")
  1883. mock_client = MagicMock()
  1884. mock_client.clear_hms_errors.return_value = True
  1885. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1886. mock_pm.get_client.return_value = mock_client
  1887. response = await async_client.post(f"/api/v1/printers/{printer.id}/hms/clear")
  1888. assert response.status_code == 200
  1889. result = response.json()
  1890. assert result["success"] is True
  1891. assert "cleared" in result["message"].lower()
  1892. mock_client.clear_hms_errors.assert_called_once()
  1893. @pytest.mark.asyncio
  1894. @pytest.mark.integration
  1895. async def test_clear_hms_errors_failure(self, async_client: AsyncClient, printer_factory):
  1896. """Verify error handling when clear HMS errors fails."""
  1897. printer = await printer_factory(name="Test Printer")
  1898. mock_client = MagicMock()
  1899. mock_client.clear_hms_errors.return_value = False
  1900. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1901. mock_pm.get_client.return_value = mock_client
  1902. response = await async_client.post(f"/api/v1/printers/{printer.id}/hms/clear")
  1903. assert response.status_code == 500
  1904. assert "failed" in response.json()["detail"].lower()
  1905. class TestExecuteHMSActionAPI:
  1906. """Integration tests for the /hms/execute-action endpoint (#1743).
  1907. Mirrors TestClearHMSErrorsAPI's shape — the two routes share the same
  1908. permission gate, the same DB-lookup + client-existence flow, and the
  1909. same dispatch-then-return-success pattern. The body-validation cases
  1910. add coverage that the bare clear endpoint doesn't need.
  1911. """
  1912. _VALID_BODY = {
  1913. "print_error": "03008070",
  1914. "action": "OK_BUTTON",
  1915. "job_id": None,
  1916. }
  1917. @pytest.mark.asyncio
  1918. @pytest.mark.integration
  1919. async def test_execute_hms_action_not_found(self, async_client: AsyncClient):
  1920. """404 for a printer id that doesn't exist."""
  1921. response = await async_client.post("/api/v1/printers/99999/hms/execute-action", json=self._VALID_BODY)
  1922. assert response.status_code == 404
  1923. @pytest.mark.asyncio
  1924. @pytest.mark.integration
  1925. async def test_execute_hms_action_not_connected(self, async_client: AsyncClient, printer_factory):
  1926. """400 when the printer record exists but the MQTT client is offline."""
  1927. printer = await printer_factory(name="Disconnected Printer")
  1928. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1929. mock_pm.get_client.return_value = None
  1930. response = await async_client.post(
  1931. f"/api/v1/printers/{printer.id}/hms/execute-action", json=self._VALID_BODY
  1932. )
  1933. assert response.status_code == 400
  1934. assert "not connected" in response.json()["detail"].lower()
  1935. @pytest.mark.asyncio
  1936. @pytest.mark.integration
  1937. async def test_execute_hms_action_success(self, async_client: AsyncClient, printer_factory):
  1938. """200 happy path — dispatcher returns True AND the printer pushes at
  1939. least one MQTT message into the ack-wait window. A fresh inbound
  1940. message is the firmware's proof that the command landed (publish
  1941. success is necessary but not sufficient; see #1830 §(3))."""
  1942. printer = await printer_factory(name="Test Printer")
  1943. mock_client = MagicMock()
  1944. # Pre-action state — paused with a fault, last message arrived at t=0.
  1945. mock_client.state.state = "PAUSE"
  1946. mock_client.state.print_error = 0x05008051
  1947. mock_client.state.hms_errors = [object()]
  1948. mock_client._last_message_time = 100.0
  1949. def _act(*_a, **_kw):
  1950. # Simulate the printer pushing a status update within the ack-wait
  1951. # window. The pushall that follows every command is what produces
  1952. # this — the actual state fields don't have to move (#1869: a
  1953. # wrong-plate IGNORE_RESUME re-pauses with the same fault but the
  1954. # printer DID push back).
  1955. mock_client._last_message_time = 100.5
  1956. return True
  1957. mock_client.execute_hms_action.side_effect = _act
  1958. with (
  1959. patch("backend.app.api.routes.printers.printer_manager") as mock_pm,
  1960. patch("backend.app.api.routes.printers.HMS_ACTION_ACK_WAIT_SECONDS", 0.01),
  1961. ):
  1962. mock_pm.get_client.return_value = mock_client
  1963. body = {"print_error": "07008029", "action": "FILAMENT_EXTRUDED", "job_id": "task-7"}
  1964. response = await async_client.post(f"/api/v1/printers/{printer.id}/hms/execute-action", json=body)
  1965. assert response.status_code == 200
  1966. result = response.json()
  1967. assert result["success"] is True
  1968. assert "executed" in result["message"].lower()
  1969. # Body args reach the client method in (print_error, action, job_id) order.
  1970. mock_client.execute_hms_action.assert_called_once_with("07008029", "FILAMENT_EXTRUDED", "task-7")
  1971. @pytest.mark.asyncio
  1972. @pytest.mark.integration
  1973. async def test_execute_hms_action_dispatcher_failure(self, async_client: AsyncClient, printer_factory):
  1974. """400 when the dispatcher returns False (unknown action, mid-flight disconnect)."""
  1975. printer = await printer_factory(name="Test Printer")
  1976. mock_client = MagicMock()
  1977. mock_client.execute_hms_action.return_value = False
  1978. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  1979. mock_pm.get_client.return_value = mock_client
  1980. response = await async_client.post(
  1981. f"/api/v1/printers/{printer.id}/hms/execute-action", json=self._VALID_BODY
  1982. )
  1983. assert response.status_code == 400
  1984. assert "failed" in response.json()["detail"].lower()
  1985. @pytest.mark.asyncio
  1986. @pytest.mark.integration
  1987. async def test_execute_hms_action_no_printer_ack_returns_502(self, async_client: AsyncClient, printer_factory):
  1988. """502 when publish succeeded but no MQTT message arrives back within
  1989. the ack-wait window. This is the silent-rejection failure mode #1830
  1990. identifies: the broker ACKs the publish at QoS 1 but the firmware
  1991. drops the command (err mismatch, wrong shape, state mismatch).
  1992. Surfacing this as 502 instead of 200 stops the UI from claiming
  1993. success while the modal sticks."""
  1994. printer = await printer_factory(name="Test Printer")
  1995. mock_client = MagicMock()
  1996. mock_client.state.state = "PAUSE"
  1997. mock_client.state.print_error = 0x05008051
  1998. mock_client.state.hms_errors = [object()]
  1999. mock_client._last_message_time = 100.0
  2000. mock_client.execute_hms_action.return_value = True # publish "succeeded"
  2001. # Crucially: _last_message_time does NOT advance → no inbound push.
  2002. with (
  2003. patch("backend.app.api.routes.printers.printer_manager") as mock_pm,
  2004. patch("backend.app.api.routes.printers.HMS_ACTION_ACK_WAIT_SECONDS", 0.01),
  2005. ):
  2006. mock_pm.get_client.return_value = mock_client
  2007. response = await async_client.post(
  2008. f"/api/v1/printers/{printer.id}/hms/execute-action", json=self._VALID_BODY
  2009. )
  2010. assert response.status_code == 502
  2011. assert "acknowledge" in response.json()["detail"].lower()
  2012. @pytest.mark.asyncio
  2013. @pytest.mark.integration
  2014. async def test_execute_hms_action_ignore_resume_repauses_within_window_still_acks(
  2015. self, async_client: AsyncClient, printer_factory
  2016. ):
  2017. """200 when the printer ack'd the command but immediately re-paused
  2018. with the same fault — e.g. wrong-plate IGNORE_RESUME (#1869). The
  2019. previous (gcode_state, hms_errors-len) diff produced a false 502
  2020. because both fields round-tripped to their pre-publish values inside
  2021. the ack window. Probing `_last_message_time` survives the round-trip
  2022. because the printer's status push lands regardless of the eventual
  2023. state."""
  2024. printer = await printer_factory(name="Test Printer")
  2025. mock_client = MagicMock()
  2026. mock_client.state.state = "PAUSE"
  2027. mock_client.state.print_error = 0x05008051
  2028. mock_client.state.hms_errors = [object()]
  2029. mock_client._last_message_time = 100.0
  2030. def _act(*_a, **_kw):
  2031. # Printer ack'd, briefly resumed, re-detected the wrong plate, and
  2032. # re-paused with the same fault. Net diff on state fields is zero,
  2033. # but a fresh status push DID arrive.
  2034. mock_client._last_message_time = 100.4
  2035. mock_client.state.state = "PAUSE" # round-tripped
  2036. mock_client.state.hms_errors = [object()] # same length
  2037. return True
  2038. mock_client.execute_hms_action.side_effect = _act
  2039. with (
  2040. patch("backend.app.api.routes.printers.printer_manager") as mock_pm,
  2041. patch("backend.app.api.routes.printers.HMS_ACTION_ACK_WAIT_SECONDS", 0.01),
  2042. ):
  2043. mock_pm.get_client.return_value = mock_client
  2044. body = {"print_error": "05008051", "action": "IGNORE_RESUME", "job_id": None}
  2045. response = await async_client.post(f"/api/v1/printers/{printer.id}/hms/execute-action", json=body)
  2046. assert response.status_code == 200
  2047. assert response.json()["success"] is True
  2048. @pytest.mark.asyncio
  2049. @pytest.mark.integration
  2050. async def test_execute_hms_action_accepts_16_char_full_code(self, async_client: AsyncClient, printer_factory):
  2051. """200 for a 16-char full_code (hms[]-array-sourced fault). The
  2052. schema's relaxed pattern allows both 8-char (print_error) and
  2053. 16-char (hms[]) shapes."""
  2054. printer = await printer_factory(name="Test Printer")
  2055. mock_client = MagicMock()
  2056. mock_client.state.state = "RUNNING"
  2057. mock_client.state.print_error = 0
  2058. mock_client.state.hms_errors = [object()]
  2059. mock_client._last_message_time = 100.0
  2060. def _act(*_a, **_kw):
  2061. mock_client._last_message_time = 100.4
  2062. return True
  2063. mock_client.execute_hms_action.side_effect = _act
  2064. with (
  2065. patch("backend.app.api.routes.printers.printer_manager") as mock_pm,
  2066. patch("backend.app.api.routes.printers.HMS_ACTION_ACK_WAIT_SECONDS", 0.01),
  2067. ):
  2068. mock_pm.get_client.return_value = mock_client
  2069. body = {"print_error": "0C00030000020010", "action": "IGNORE_RESUME"}
  2070. response = await async_client.post(f"/api/v1/printers/{printer.id}/hms/execute-action", json=body)
  2071. assert response.status_code == 200
  2072. mock_client.execute_hms_action.assert_called_once_with("0C00030000020010", "IGNORE_RESUME", None)
  2073. @pytest.mark.asyncio
  2074. @pytest.mark.integration
  2075. async def test_execute_hms_action_rejects_malformed_print_error(self, async_client: AsyncClient, printer_factory):
  2076. """422 when print_error fails the relaxed pattern (8 OR 16 hex chars).
  2077. Lengths in between (9-15) and outside (7, 17+) are invalid; stray
  2078. input can't reach the dispatcher's match statement."""
  2079. printer = await printer_factory(name="Test Printer")
  2080. bad_bodies = [
  2081. {"print_error": "0300_8070", "action": "OK_BUTTON"}, # underscore
  2082. {"print_error": "0300807", "action": "OK_BUTTON"}, # 7 chars (too short)
  2083. {"print_error": "030080700", "action": "OK_BUTTON"}, # 9 chars (between)
  2084. {"print_error": "030080700300807", "action": "OK_BUTTON"}, # 15 chars (between)
  2085. {"print_error": "0300807003008070A", "action": "OK_BUTTON"}, # 17 chars (too long)
  2086. {"print_error": "0300GGGG", "action": "OK_BUTTON"}, # non-hex
  2087. ]
  2088. for body in bad_bodies:
  2089. response = await async_client.post(f"/api/v1/printers/{printer.id}/hms/execute-action", json=body)
  2090. assert response.status_code == 422, body
  2091. def _build_h2d_state(*, ams_id: int = 0, tray_id: int = 2, cali_idx: int = 5):
  2092. """Build a MagicMock PrinterState for an H2D printer with a single BL spool tray.
  2093. Used by both TestApplyPaAfterRefresh (Phase 13 P13-T-BE-1) and the K-profile
  2094. persistence tests below. The tray data passes is_bambu_tag (32-char non-zero
  2095. tray_uuid + non-empty tray_info_idx).
  2096. """
  2097. nozzle = MagicMock(nozzle_diameter="0.4")
  2098. state = MagicMock()
  2099. state.nozzles = [nozzle]
  2100. state.ams_extruder_map = {"0": 0}
  2101. state.raw_data = {
  2102. "ams": [
  2103. {
  2104. "id": ams_id,
  2105. "tray": [
  2106. {
  2107. "id": tray_id,
  2108. "tray_type": "PLA",
  2109. "tag_uid": "AABBCC1122334400",
  2110. "tray_uuid": "11223344556677880011223344556677",
  2111. "tray_info_idx": "GFL05",
  2112. "cali_idx": cali_idx,
  2113. }
  2114. ],
  2115. }
  2116. ]
  2117. }
  2118. return state
  2119. def _patch_async_session_to(db_session):
  2120. """Patch backend.app.core.database.async_session so calls inside the function
  2121. under test reuse the test fixture's db_session.
  2122. `_apply_pa_after_refresh` lazy-imports `from backend.app.core.database import
  2123. async_session` at runtime (line 2849). When we patch the source module
  2124. before the call, the lazy import picks up the patched object.
  2125. Returns the patch context manager; use as `with _patch_async_session_to(db_session):`.
  2126. Pattern verified against test_print_lifecycle.py:38-42.
  2127. """
  2128. cm = AsyncMock()
  2129. cm.__aenter__ = AsyncMock(return_value=db_session)
  2130. cm.__aexit__ = AsyncMock(return_value=None)
  2131. return patch("backend.app.core.database.async_session", return_value=cm)
  2132. class TestApplyPaAfterRefresh:
  2133. """Phase 13 P13-T-BE-1: _apply_pa_after_refresh K-profile cascade.
  2134. Verifies the 3-stage cascade (local SpoolKProfile → Spoolman SpoolmanKProfile
  2135. → live tray.cali_idx fallback) and the Bug A regression (kp.extruder, not
  2136. kp.extruder_id, after the Phase 13 P13-2a fix).
  2137. `_apply_pa_after_refresh` is a free function spawned via asyncio.create_task
  2138. from the /ams-refresh endpoint. Tests call it directly because awaiting the
  2139. spawned task in an HTTP test would require sleeping past the 5-second guard
  2140. that delays MQTT until RFID re-read finishes.
  2141. """
  2142. @pytest.mark.asyncio
  2143. @pytest.mark.integration
  2144. async def test_local_kp_match_sends_stored_cali_idx(self, db_session, printer_factory):
  2145. """Local SpoolAssignment + matching SpoolKProfile → stored cali_idx wins."""
  2146. from backend.app.api.routes.printers import _apply_pa_after_refresh
  2147. from backend.app.models.spool import Spool
  2148. from backend.app.models.spool_assignment import SpoolAssignment
  2149. from backend.app.models.spool_k_profile import SpoolKProfile
  2150. printer = await printer_factory()
  2151. spool = Spool(material="PLA", color_name="Red", rgba="FF0000FF")
  2152. db_session.add(spool)
  2153. await db_session.flush()
  2154. db_session.add(
  2155. SpoolAssignment(
  2156. spool_id=spool.id,
  2157. printer_id=printer.id,
  2158. ams_id=0,
  2159. tray_id=2,
  2160. )
  2161. )
  2162. db_session.add(
  2163. SpoolKProfile(
  2164. spool_id=spool.id,
  2165. printer_id=printer.id,
  2166. extruder=0,
  2167. nozzle_diameter="0.4",
  2168. k_value=0.025,
  2169. cali_idx=42,
  2170. )
  2171. )
  2172. await db_session.commit()
  2173. mock_client = MagicMock()
  2174. mock_client.extrusion_cali_sel = MagicMock(return_value=True)
  2175. state = _build_h2d_state(cali_idx=5)
  2176. with (
  2177. patch("backend.app.api.routes.printers.asyncio.sleep", AsyncMock()),
  2178. patch("backend.app.api.routes.printers.printer_manager") as mock_pm,
  2179. _patch_async_session_to(db_session),
  2180. ):
  2181. mock_pm.get_client.return_value = mock_client
  2182. mock_pm.get_status.return_value = state
  2183. await _apply_pa_after_refresh(printer.id, ams_id=0, slot_id=2)
  2184. mock_client.extrusion_cali_sel.assert_called_once()
  2185. kwargs = mock_client.extrusion_cali_sel.call_args.kwargs
  2186. assert kwargs["cali_idx"] == 42 # stored profile, not 5 (live)
  2187. @pytest.mark.asyncio
  2188. @pytest.mark.integration
  2189. async def test_local_no_kp_uses_live_cali_idx(self, db_session, printer_factory):
  2190. """Local SpoolAssignment but no matching SpoolKProfile → live cali_idx (Stage 3)."""
  2191. from backend.app.api.routes.printers import _apply_pa_after_refresh
  2192. from backend.app.models.spool import Spool
  2193. from backend.app.models.spool_assignment import SpoolAssignment
  2194. printer = await printer_factory()
  2195. spool = Spool(material="PLA")
  2196. db_session.add(spool)
  2197. await db_session.flush()
  2198. db_session.add(
  2199. SpoolAssignment(
  2200. spool_id=spool.id,
  2201. printer_id=printer.id,
  2202. ams_id=0,
  2203. tray_id=2,
  2204. )
  2205. )
  2206. await db_session.commit()
  2207. mock_client = MagicMock()
  2208. mock_client.extrusion_cali_sel = MagicMock(return_value=True)
  2209. state = _build_h2d_state(cali_idx=5)
  2210. with (
  2211. patch("backend.app.api.routes.printers.asyncio.sleep", AsyncMock()),
  2212. patch("backend.app.api.routes.printers.printer_manager") as mock_pm,
  2213. _patch_async_session_to(db_session),
  2214. ):
  2215. mock_pm.get_client.return_value = mock_client
  2216. mock_pm.get_status.return_value = state
  2217. await _apply_pa_after_refresh(printer.id, ams_id=0, slot_id=2)
  2218. mock_client.extrusion_cali_sel.assert_called_once()
  2219. kwargs = mock_client.extrusion_cali_sel.call_args.kwargs
  2220. assert kwargs["cali_idx"] == 5 # live tray.cali_idx fallback
  2221. @pytest.mark.asyncio
  2222. @pytest.mark.integration
  2223. async def test_spoolman_kp_when_no_local(self, db_session, printer_factory):
  2224. """No local assignment + Spoolman SlotAssignment + SpoolmanKProfile → Spoolman cali_idx."""
  2225. from backend.app.api.routes.printers import _apply_pa_after_refresh
  2226. from backend.app.models.settings import Settings
  2227. from backend.app.models.spoolman_k_profile import SpoolmanKProfile
  2228. from backend.app.models.spoolman_slot_assignment import SpoolmanSlotAssignment
  2229. # A spoolman_slot_assignments row only exists in Spoolman mode, and
  2230. # since #2812 the mode is asked for explicitly rather than inferred
  2231. # from which table happens to hold rows.
  2232. db_session.add(Settings(key="spoolman_enabled", value="true"))
  2233. printer = await printer_factory()
  2234. db_session.add(
  2235. SpoolmanSlotAssignment(
  2236. printer_id=printer.id,
  2237. ams_id=0,
  2238. tray_id=2,
  2239. spoolman_spool_id=99,
  2240. )
  2241. )
  2242. db_session.add(
  2243. SpoolmanKProfile(
  2244. spoolman_spool_id=99,
  2245. printer_id=printer.id,
  2246. extruder=0,
  2247. nozzle_diameter="0.4",
  2248. k_value=0.030,
  2249. cali_idx=77,
  2250. )
  2251. )
  2252. await db_session.commit()
  2253. mock_client = MagicMock()
  2254. mock_client.extrusion_cali_sel = MagicMock(return_value=True)
  2255. state = _build_h2d_state(cali_idx=5)
  2256. with (
  2257. patch("backend.app.api.routes.printers.asyncio.sleep", AsyncMock()),
  2258. patch("backend.app.api.routes.printers.printer_manager") as mock_pm,
  2259. _patch_async_session_to(db_session),
  2260. ):
  2261. mock_pm.get_client.return_value = mock_client
  2262. mock_pm.get_status.return_value = state
  2263. await _apply_pa_after_refresh(printer.id, ams_id=0, slot_id=2)
  2264. mock_client.extrusion_cali_sel.assert_called_once()
  2265. kwargs = mock_client.extrusion_cali_sel.call_args.kwargs
  2266. assert kwargs["cali_idx"] == 77 # Spoolman stored profile
  2267. @pytest.mark.asyncio
  2268. @pytest.mark.integration
  2269. async def test_spoolman_no_kp_uses_live(self, db_session, printer_factory):
  2270. """Spoolman SlotAssignment but no SpoolmanKProfile → live cali_idx (Stage 3)."""
  2271. from backend.app.api.routes.printers import _apply_pa_after_refresh
  2272. from backend.app.models.settings import Settings
  2273. from backend.app.models.spoolman_slot_assignment import SpoolmanSlotAssignment
  2274. # A spoolman_slot_assignments row only exists in Spoolman mode, and
  2275. # since #2812 the mode is asked for explicitly rather than inferred
  2276. # from which table happens to hold rows.
  2277. db_session.add(Settings(key="spoolman_enabled", value="true"))
  2278. printer = await printer_factory()
  2279. db_session.add(
  2280. SpoolmanSlotAssignment(
  2281. printer_id=printer.id,
  2282. ams_id=0,
  2283. tray_id=2,
  2284. spoolman_spool_id=99,
  2285. )
  2286. )
  2287. await db_session.commit()
  2288. mock_client = MagicMock()
  2289. mock_client.extrusion_cali_sel = MagicMock(return_value=True)
  2290. state = _build_h2d_state(cali_idx=5)
  2291. with (
  2292. patch("backend.app.api.routes.printers.asyncio.sleep", AsyncMock()),
  2293. patch("backend.app.api.routes.printers.printer_manager") as mock_pm,
  2294. _patch_async_session_to(db_session),
  2295. ):
  2296. mock_pm.get_client.return_value = mock_client
  2297. mock_pm.get_status.return_value = state
  2298. await _apply_pa_after_refresh(printer.id, ams_id=0, slot_id=2)
  2299. mock_client.extrusion_cali_sel.assert_called_once()
  2300. assert mock_client.extrusion_cali_sel.call_args.kwargs["cali_idx"] == 5
  2301. @pytest.mark.asyncio
  2302. @pytest.mark.integration
  2303. async def test_no_assignment_uses_live(self, db_session, printer_factory):
  2304. """No assignment of any kind + live cali_idx >= 0 → live fallback."""
  2305. from backend.app.api.routes.printers import _apply_pa_after_refresh
  2306. printer = await printer_factory()
  2307. mock_client = MagicMock()
  2308. mock_client.extrusion_cali_sel = MagicMock(return_value=True)
  2309. state = _build_h2d_state(cali_idx=5)
  2310. with (
  2311. patch("backend.app.api.routes.printers.asyncio.sleep", AsyncMock()),
  2312. patch("backend.app.api.routes.printers.printer_manager") as mock_pm,
  2313. _patch_async_session_to(db_session),
  2314. ):
  2315. mock_pm.get_client.return_value = mock_client
  2316. mock_pm.get_status.return_value = state
  2317. await _apply_pa_after_refresh(printer.id, ams_id=0, slot_id=2)
  2318. mock_client.extrusion_cali_sel.assert_called_once()
  2319. assert mock_client.extrusion_cali_sel.call_args.kwargs["cali_idx"] == 5
  2320. @pytest.mark.asyncio
  2321. @pytest.mark.integration
  2322. async def test_negative_live_cali_idx_skipped(self, db_session, printer_factory):
  2323. """No assignment + live cali_idx=-1 → no MQTT call (invalid live value)."""
  2324. from backend.app.api.routes.printers import _apply_pa_after_refresh
  2325. printer = await printer_factory()
  2326. mock_client = MagicMock()
  2327. mock_client.extrusion_cali_sel = MagicMock(return_value=True)
  2328. state = _build_h2d_state(cali_idx=-1)
  2329. with (
  2330. patch("backend.app.api.routes.printers.asyncio.sleep", AsyncMock()),
  2331. patch("backend.app.api.routes.printers.printer_manager") as mock_pm,
  2332. _patch_async_session_to(db_session),
  2333. ):
  2334. mock_pm.get_client.return_value = mock_client
  2335. mock_pm.get_status.return_value = state
  2336. await _apply_pa_after_refresh(printer.id, ams_id=0, slot_id=2)
  2337. mock_client.extrusion_cali_sel.assert_not_called()
  2338. @pytest.mark.asyncio
  2339. @pytest.mark.integration
  2340. async def test_no_assignment_no_live_cali_idx_no_call(self, db_session, printer_factory):
  2341. """No assignment of any kind AND no live cali_idx in tray → no MQTT call.
  2342. Distinct from test_negative_live_cali_idx_skipped: that test has
  2343. cali_idx=-1 in raw_data; this one omits the field entirely (returns
  2344. None from .get("cali_idx")). Both must result in no MQTT call.
  2345. """
  2346. from backend.app.api.routes.printers import _apply_pa_after_refresh
  2347. printer = await printer_factory()
  2348. mock_client = MagicMock()
  2349. mock_client.extrusion_cali_sel = MagicMock(return_value=True)
  2350. # State with NO cali_idx field on tray at all
  2351. nozzle = MagicMock(nozzle_diameter="0.4")
  2352. state = MagicMock()
  2353. state.nozzles = [nozzle]
  2354. state.ams_extruder_map = {"0": 0}
  2355. state.raw_data = {
  2356. "ams": [
  2357. {
  2358. "id": 0,
  2359. "tray": [
  2360. {
  2361. "id": 2,
  2362. "tray_type": "PLA",
  2363. "tag_uid": "AABBCC1122334400",
  2364. "tray_uuid": "11223344556677880011223344556677",
  2365. "tray_info_idx": "GFL05",
  2366. # cali_idx field intentionally omitted
  2367. }
  2368. ],
  2369. }
  2370. ]
  2371. }
  2372. with (
  2373. patch("backend.app.api.routes.printers.asyncio.sleep", AsyncMock()),
  2374. patch("backend.app.api.routes.printers.printer_manager") as mock_pm,
  2375. _patch_async_session_to(db_session),
  2376. ):
  2377. mock_pm.get_client.return_value = mock_client
  2378. mock_pm.get_status.return_value = state
  2379. await _apply_pa_after_refresh(printer.id, ams_id=0, slot_id=2)
  2380. mock_client.extrusion_cali_sel.assert_not_called()
  2381. @pytest.mark.asyncio
  2382. @pytest.mark.integration
  2383. async def test_extruder_mismatch_uses_kp_as_fallback(self, db_session, printer_factory):
  2384. """K-profile for extruder=1 but slot is extruder=0 → no exact match,
  2385. but the kp is used as extruder-agnostic fallback rather than dropped.
  2386. Hard-skipping on extruder mismatch was the previous behavior; in
  2387. practice it caused stored K-profiles to be silently ignored whenever
  2388. the AMS-extruder mapping had shifted (or when only one of the two
  2389. extruders was ever calibrated for a given spool). The cascade now
  2390. prefers an exact extruder match but falls back to any matching kp
  2391. for the same printer + nozzle.
  2392. """
  2393. from backend.app.api.routes.printers import _apply_pa_after_refresh
  2394. from backend.app.models.spool import Spool
  2395. from backend.app.models.spool_assignment import SpoolAssignment
  2396. from backend.app.models.spool_k_profile import SpoolKProfile
  2397. printer = await printer_factory()
  2398. spool = Spool(material="PLA")
  2399. db_session.add(spool)
  2400. await db_session.flush()
  2401. db_session.add(
  2402. SpoolAssignment(
  2403. spool_id=spool.id,
  2404. printer_id=printer.id,
  2405. ams_id=0,
  2406. tray_id=2,
  2407. )
  2408. )
  2409. # K-profile is for extruder=1, but slot's ams_extruder_map["0"]=0
  2410. db_session.add(
  2411. SpoolKProfile(
  2412. spool_id=spool.id,
  2413. printer_id=printer.id,
  2414. extruder=1,
  2415. nozzle_diameter="0.4",
  2416. k_value=0.025,
  2417. cali_idx=42,
  2418. )
  2419. )
  2420. await db_session.commit()
  2421. mock_client = MagicMock()
  2422. mock_client.extrusion_cali_sel = MagicMock(return_value=True)
  2423. state = _build_h2d_state(cali_idx=5)
  2424. with (
  2425. patch("backend.app.api.routes.printers.asyncio.sleep", AsyncMock()),
  2426. patch("backend.app.api.routes.printers.printer_manager") as mock_pm,
  2427. _patch_async_session_to(db_session),
  2428. ):
  2429. mock_pm.get_client.return_value = mock_client
  2430. mock_pm.get_status.return_value = state
  2431. await _apply_pa_after_refresh(printer.id, ams_id=0, slot_id=2)
  2432. # No exact extruder match, but the stored kp wins as the
  2433. # extruder-agnostic fallback over live cali_idx=5.
  2434. mock_client.extrusion_cali_sel.assert_called_once()
  2435. assert mock_client.extrusion_cali_sel.call_args.kwargs["cali_idx"] == 42
  2436. @pytest.mark.asyncio
  2437. @pytest.mark.integration
  2438. async def test_extruder_exact_match_preferred_over_fallback(
  2439. self,
  2440. db_session,
  2441. printer_factory,
  2442. ):
  2443. """When two kp rows exist, one with matching extruder and one without,
  2444. the exact-extruder kp wins (extruder-agnostic fallback only fires when
  2445. no exact match exists).
  2446. """
  2447. from backend.app.api.routes.printers import _apply_pa_after_refresh
  2448. from backend.app.models.spool import Spool
  2449. from backend.app.models.spool_assignment import SpoolAssignment
  2450. from backend.app.models.spool_k_profile import SpoolKProfile
  2451. printer = await printer_factory()
  2452. spool = Spool(material="PLA")
  2453. db_session.add(spool)
  2454. await db_session.flush()
  2455. db_session.add(
  2456. SpoolAssignment(
  2457. spool_id=spool.id,
  2458. printer_id=printer.id,
  2459. ams_id=0,
  2460. tray_id=2,
  2461. )
  2462. )
  2463. # Two kp rows: extruder=1 (mismatch w/ slot extruder=0) and extruder=0 (exact)
  2464. db_session.add(
  2465. SpoolKProfile(
  2466. spool_id=spool.id,
  2467. printer_id=printer.id,
  2468. extruder=1,
  2469. nozzle_diameter="0.4",
  2470. k_value=0.030,
  2471. cali_idx=99,
  2472. )
  2473. )
  2474. db_session.add(
  2475. SpoolKProfile(
  2476. spool_id=spool.id,
  2477. printer_id=printer.id,
  2478. extruder=0,
  2479. nozzle_diameter="0.4",
  2480. k_value=0.025,
  2481. cali_idx=42,
  2482. )
  2483. )
  2484. await db_session.commit()
  2485. mock_client = MagicMock()
  2486. mock_client.extrusion_cali_sel = MagicMock(return_value=True)
  2487. state = _build_h2d_state(cali_idx=5)
  2488. with (
  2489. patch("backend.app.api.routes.printers.asyncio.sleep", AsyncMock()),
  2490. patch("backend.app.api.routes.printers.printer_manager") as mock_pm,
  2491. _patch_async_session_to(db_session),
  2492. ):
  2493. mock_pm.get_client.return_value = mock_client
  2494. mock_pm.get_status.return_value = state
  2495. await _apply_pa_after_refresh(printer.id, ams_id=0, slot_id=2)
  2496. # Exact-extruder=0 kp wins (cali_idx=42), not the extruder=1 fallback (99)
  2497. mock_client.extrusion_cali_sel.assert_called_once()
  2498. assert mock_client.extrusion_cali_sel.call_args.kwargs["cali_idx"] == 42
  2499. @pytest.mark.asyncio
  2500. @pytest.mark.integration
  2501. async def test_regression_bug_a_kp_extruder_attr(self, db_session, printer_factory):
  2502. """Regression test for Phase 13 P13-2a Bug A.
  2503. Pre-fix Z.2910 used `kp.extruder_id` (AttributeError on SpoolKProfile,
  2504. silently swallowed by outer try/except). On dual-nozzle printers with
  2505. slot_extruder != None this caused the K-profile match loop to crash.
  2506. After P13-2a the field name is correct: `kp.extruder`.
  2507. """
  2508. from backend.app.api.routes.printers import _apply_pa_after_refresh
  2509. from backend.app.models.spool import Spool
  2510. from backend.app.models.spool_assignment import SpoolAssignment
  2511. from backend.app.models.spool_k_profile import SpoolKProfile
  2512. printer = await printer_factory()
  2513. spool = Spool(material="PLA")
  2514. db_session.add(spool)
  2515. await db_session.flush()
  2516. db_session.add(
  2517. SpoolAssignment(
  2518. spool_id=spool.id,
  2519. printer_id=printer.id,
  2520. ams_id=0,
  2521. tray_id=2,
  2522. )
  2523. )
  2524. # extruder=0 matches slot_extruder=0 (from ams_extruder_map={"0":0})
  2525. db_session.add(
  2526. SpoolKProfile(
  2527. spool_id=spool.id,
  2528. printer_id=printer.id,
  2529. extruder=0,
  2530. nozzle_diameter="0.4",
  2531. k_value=0.025,
  2532. cali_idx=42,
  2533. )
  2534. )
  2535. await db_session.commit()
  2536. mock_client = MagicMock()
  2537. mock_client.extrusion_cali_sel = MagicMock(return_value=True)
  2538. state = _build_h2d_state(cali_idx=5)
  2539. with (
  2540. patch("backend.app.api.routes.printers.asyncio.sleep", AsyncMock()),
  2541. patch("backend.app.api.routes.printers.printer_manager") as mock_pm,
  2542. _patch_async_session_to(db_session),
  2543. ):
  2544. mock_pm.get_client.return_value = mock_client
  2545. mock_pm.get_status.return_value = state
  2546. await _apply_pa_after_refresh(printer.id, ams_id=0, slot_id=2)
  2547. # If Bug A regressed (kp.extruder_id), the loop would AttributeError → silent fail
  2548. # → no extrusion_cali_sel call. Post-fix the loop matches and sends cali_idx=42.
  2549. mock_client.extrusion_cali_sel.assert_called_once()
  2550. assert mock_client.extrusion_cali_sel.call_args.kwargs["cali_idx"] == 42
  2551. @pytest.mark.asyncio
  2552. @pytest.mark.integration
  2553. async def test_tag_fallback_finds_spool_when_assignment_missing(
  2554. self,
  2555. db_session,
  2556. printer_factory,
  2557. ):
  2558. """Stage 1b regression for the maintainer's #2 reproducer on H2D:
  2559. reset slot, trigger re-read → slot ends up on the default K-profile
  2560. instead of the spool's stored profile.
  2561. Setup mirrors the bug:
  2562. - Spool has tray_uuid set (the RFID tag was registered earlier).
  2563. - SpoolKProfile exists for that spool with cali_idx=42.
  2564. - NO SpoolAssignment row — the reset deleted it before the re-read
  2565. triggered _apply_pa_after_refresh, and tag-auto-detect has not
  2566. re-created it yet within the 5 s sleep window.
  2567. - Live tray.cali_idx=5 (firmware-default after the RFID re-read).
  2568. Without Stage 1b the cascade falls through to Stage 3 and re-asserts
  2569. the firmware-default cali_idx=5. With Stage 1b it locates the spool by
  2570. the live tray's tray_uuid and applies the stored cali_idx=42.
  2571. """
  2572. from backend.app.api.routes.printers import _apply_pa_after_refresh
  2573. from backend.app.models.spool import Spool
  2574. from backend.app.models.spool_k_profile import SpoolKProfile
  2575. printer = await printer_factory()
  2576. # Spool with tray_uuid matching the one _build_h2d_state puts on the tray
  2577. spool = Spool(
  2578. material="PLA",
  2579. color_name="Red",
  2580. rgba="FF0000FF",
  2581. tray_uuid="11223344556677880011223344556677",
  2582. tag_uid="AABBCC1122334400",
  2583. )
  2584. db_session.add(spool)
  2585. await db_session.flush()
  2586. # K-profile is bound to the spool, not to a slot
  2587. db_session.add(
  2588. SpoolKProfile(
  2589. spool_id=spool.id,
  2590. printer_id=printer.id,
  2591. extruder=0,
  2592. nozzle_diameter="0.4",
  2593. k_value=0.025,
  2594. cali_idx=42,
  2595. )
  2596. )
  2597. # NOTE: deliberately no SpoolAssignment — that's the bug condition.
  2598. await db_session.commit()
  2599. mock_client = MagicMock()
  2600. mock_client.extrusion_cali_sel = MagicMock(return_value=True)
  2601. state = _build_h2d_state(cali_idx=5)
  2602. with (
  2603. patch("backend.app.api.routes.printers.asyncio.sleep", AsyncMock()),
  2604. patch("backend.app.api.routes.printers.printer_manager") as mock_pm,
  2605. _patch_async_session_to(db_session),
  2606. ):
  2607. mock_pm.get_client.return_value = mock_client
  2608. mock_pm.get_status.return_value = state
  2609. await _apply_pa_after_refresh(printer.id, ams_id=0, slot_id=2)
  2610. # Stage 1b should match the spool by tray_uuid → stored cali_idx=42 wins
  2611. # over live cali_idx=5. Pre-fix this would have been 5 (firmware default).
  2612. mock_client.extrusion_cali_sel.assert_called_once()
  2613. assert mock_client.extrusion_cali_sel.call_args.kwargs["cali_idx"] == 42
  2614. @pytest.mark.asyncio
  2615. @pytest.mark.integration
  2616. async def test_tag_fallback_matches_by_tag_uid_when_uuid_zero(
  2617. self,
  2618. db_session,
  2619. printer_factory,
  2620. ):
  2621. """Stage 1b: when tray_uuid is the zero sentinel but tag_uid is real,
  2622. match by tag_uid. Older firmwares occasionally report a zero tray_uuid
  2623. right after RFID re-read while the tag_uid is already populated."""
  2624. from backend.app.api.routes.printers import _apply_pa_after_refresh
  2625. from backend.app.models.spool import Spool
  2626. from backend.app.models.spool_k_profile import SpoolKProfile
  2627. printer = await printer_factory()
  2628. # Spool indexed by tag_uid, not tray_uuid
  2629. spool = Spool(material="PLA", tag_uid="AABBCC1122334400")
  2630. db_session.add(spool)
  2631. await db_session.flush()
  2632. db_session.add(
  2633. SpoolKProfile(
  2634. spool_id=spool.id,
  2635. printer_id=printer.id,
  2636. extruder=0,
  2637. nozzle_diameter="0.4",
  2638. k_value=0.025,
  2639. cali_idx=99,
  2640. )
  2641. )
  2642. await db_session.commit()
  2643. mock_client = MagicMock()
  2644. mock_client.extrusion_cali_sel = MagicMock(return_value=True)
  2645. # Build a state where the tray reports a real tag_uid but a zero tray_uuid
  2646. # while still passing is_bambu_tag (tag_uid + tray_info_idx is sufficient).
  2647. state = _build_h2d_state(cali_idx=5)
  2648. state.raw_data["ams"][0]["tray"][0]["tray_uuid"] = "00000000000000000000000000000000"
  2649. with (
  2650. patch("backend.app.api.routes.printers.asyncio.sleep", AsyncMock()),
  2651. patch("backend.app.api.routes.printers.printer_manager") as mock_pm,
  2652. _patch_async_session_to(db_session),
  2653. ):
  2654. mock_pm.get_client.return_value = mock_client
  2655. mock_pm.get_status.return_value = state
  2656. await _apply_pa_after_refresh(printer.id, ams_id=0, slot_id=2)
  2657. mock_client.extrusion_cali_sel.assert_called_once()
  2658. assert mock_client.extrusion_cali_sel.call_args.kwargs["cali_idx"] == 99
  2659. @pytest.mark.asyncio
  2660. @pytest.mark.integration
  2661. async def test_tag_fallback_skipped_when_zero_sentinels(
  2662. self,
  2663. db_session,
  2664. printer_factory,
  2665. ):
  2666. """Stage 1b: when both tray_uuid and tag_uid are zero sentinels, the
  2667. fallback must not match any spool (would otherwise pick up an
  2668. unrelated spool created with empty/zero tag fields). Falls through
  2669. to Stage 3 live cali_idx as before.
  2670. """
  2671. from backend.app.api.routes.printers import _apply_pa_after_refresh
  2672. from backend.app.models.spool import Spool
  2673. from backend.app.models.spool_k_profile import SpoolKProfile
  2674. printer = await printer_factory()
  2675. # Decoy spool with no tag info — must NOT match
  2676. spool = Spool(material="PLA")
  2677. db_session.add(spool)
  2678. await db_session.flush()
  2679. db_session.add(
  2680. SpoolKProfile(
  2681. spool_id=spool.id,
  2682. printer_id=printer.id,
  2683. extruder=0,
  2684. nozzle_diameter="0.4",
  2685. k_value=0.025,
  2686. cali_idx=42,
  2687. )
  2688. )
  2689. await db_session.commit()
  2690. mock_client = MagicMock()
  2691. mock_client.extrusion_cali_sel = MagicMock(return_value=True)
  2692. state = _build_h2d_state(cali_idx=7)
  2693. # Force both tag fields to the zero sentinels but keep tray_info_idx
  2694. # so is_bambu_tag still passes (preset present)
  2695. state.raw_data["ams"][0]["tray"][0]["tag_uid"] = "0000000000000000"
  2696. state.raw_data["ams"][0]["tray"][0]["tray_uuid"] = "00000000000000000000000000000000"
  2697. with (
  2698. patch("backend.app.api.routes.printers.asyncio.sleep", AsyncMock()),
  2699. patch("backend.app.api.routes.printers.printer_manager") as mock_pm,
  2700. _patch_async_session_to(db_session),
  2701. ):
  2702. mock_pm.get_client.return_value = mock_client
  2703. mock_pm.get_status.return_value = state
  2704. # is_bambu_tag actually rejects both-zero + only-preset, so the
  2705. # function returns early. We just want to confirm we didn't blow
  2706. # up scanning for a tag-fallback spool.
  2707. await _apply_pa_after_refresh(printer.id, ams_id=0, slot_id=2)
  2708. # is_bambu_tag short-circuits early when both UID and UUID are zero,
  2709. # so no MQTT call should fire and the decoy spool's cali_idx=42 must
  2710. # NOT leak through.
  2711. if mock_client.extrusion_cali_sel.called:
  2712. assert mock_client.extrusion_cali_sel.call_args.kwargs["cali_idx"] != 42
  2713. class TestConfigureAmsSlotPersistsKProfile:
  2714. """Phase 13 P13-T-BE-2: configure_ams_slot persists K-profile to DB.
  2715. Pre-Phase-13 the endpoint sent extrusion_cali_sel via MQTT but never
  2716. recorded the choice in spool_k_profile / spoolman_k_profile, so the next
  2717. RFID re-read had no stored profile to apply.
  2718. """
  2719. @pytest.mark.asyncio
  2720. @pytest.mark.integration
  2721. async def test_writes_spoolman_kprofile_when_spoolman_assigned(
  2722. self,
  2723. async_client: AsyncClient,
  2724. db_session,
  2725. printer_factory,
  2726. ):
  2727. """SpoolmanSlotAssignment present → SpoolmanKProfile row created with cali_idx + k_value + name."""
  2728. from backend.app.models.settings import Settings
  2729. from backend.app.models.spoolman_k_profile import SpoolmanKProfile
  2730. from backend.app.models.spoolman_slot_assignment import SpoolmanSlotAssignment
  2731. # A spoolman_slot_assignments row only exists in Spoolman mode, and
  2732. # since #2812 the mode is asked for explicitly rather than inferred
  2733. # from which table happens to hold rows.
  2734. db_session.add(Settings(key="spoolman_enabled", value="true"))
  2735. printer = await printer_factory(model="H2D")
  2736. db_session.add(
  2737. SpoolmanSlotAssignment(
  2738. printer_id=printer.id,
  2739. ams_id=0,
  2740. tray_id=3,
  2741. spoolman_spool_id=216,
  2742. )
  2743. )
  2744. await db_session.commit()
  2745. mock_client = MagicMock()
  2746. mock_client.ams_set_filament_setting.return_value = True
  2747. mock_client.extrusion_cali_sel.return_value = True
  2748. mock_client.extrusion_cali_set.return_value = True
  2749. mock_client.request_status_update.return_value = True
  2750. mock_state = MagicMock()
  2751. mock_state.ams_extruder_map = {"0": 0}
  2752. mock_state.raw_data = {"ams": {"ams": []}}
  2753. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  2754. mock_pm.get_client.return_value = mock_client
  2755. mock_pm.get_status.return_value = mock_state
  2756. response = await async_client.post(
  2757. f"/api/v1/printers/{printer.id}/slots/0/3/configure",
  2758. params={
  2759. "tray_info_idx": "GFL05",
  2760. "tray_type": "PLA",
  2761. "tray_sub_brands": "Bambu PLA Metal",
  2762. "tray_color": "FF8800FF",
  2763. "nozzle_temp_min": 220,
  2764. "nozzle_temp_max": 240,
  2765. "cali_idx": 5,
  2766. "nozzle_diameter": "0.4",
  2767. "k_value": 0.022,
  2768. },
  2769. )
  2770. assert response.status_code == 200
  2771. kp_result = await db_session.execute(select(SpoolmanKProfile).where(SpoolmanKProfile.spoolman_spool_id == 216))
  2772. kp = kp_result.scalar_one_or_none()
  2773. assert kp is not None
  2774. assert kp.cali_idx == 5
  2775. assert kp.k_value == pytest.approx(0.022)
  2776. assert kp.extruder == 0
  2777. assert kp.nozzle_diameter == "0.4"
  2778. assert kp.name == "Bambu PLA Metal"
  2779. @pytest.mark.asyncio
  2780. @pytest.mark.integration
  2781. async def test_writes_spool_kprofile_when_local_assigned(
  2782. self,
  2783. async_client: AsyncClient,
  2784. db_session,
  2785. printer_factory,
  2786. ):
  2787. """Local SpoolAssignment present → SpoolKProfile row created."""
  2788. from backend.app.models.spool import Spool
  2789. from backend.app.models.spool_assignment import SpoolAssignment
  2790. from backend.app.models.spool_k_profile import SpoolKProfile
  2791. printer = await printer_factory(model="H2D")
  2792. spool = Spool(material="PLA", color_name="Red", rgba="FF0000FF")
  2793. db_session.add(spool)
  2794. await db_session.flush()
  2795. db_session.add(
  2796. SpoolAssignment(
  2797. spool_id=spool.id,
  2798. printer_id=printer.id,
  2799. ams_id=0,
  2800. tray_id=3,
  2801. )
  2802. )
  2803. await db_session.commit()
  2804. spool_id = spool.id
  2805. mock_client = MagicMock()
  2806. mock_client.ams_set_filament_setting.return_value = True
  2807. mock_client.extrusion_cali_sel.return_value = True
  2808. mock_client.extrusion_cali_set.return_value = True
  2809. mock_client.request_status_update.return_value = True
  2810. mock_state = MagicMock()
  2811. mock_state.ams_extruder_map = {"0": 0}
  2812. mock_state.raw_data = {"ams": {"ams": []}}
  2813. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  2814. mock_pm.get_client.return_value = mock_client
  2815. mock_pm.get_status.return_value = mock_state
  2816. response = await async_client.post(
  2817. f"/api/v1/printers/{printer.id}/slots/0/3/configure",
  2818. params={
  2819. "tray_info_idx": "PFUSdev01",
  2820. "tray_type": "PLA",
  2821. "tray_sub_brands": "Devil Design PLA",
  2822. "tray_color": "FF0000FF",
  2823. "nozzle_temp_min": 220,
  2824. "nozzle_temp_max": 240,
  2825. "cali_idx": 7,
  2826. "nozzle_diameter": "0.4",
  2827. "k_value": 0.028,
  2828. },
  2829. )
  2830. assert response.status_code == 200
  2831. kp_result = await db_session.execute(select(SpoolKProfile).where(SpoolKProfile.spool_id == spool_id))
  2832. kp = kp_result.scalar_one_or_none()
  2833. assert kp is not None
  2834. assert kp.cali_idx == 7
  2835. assert kp.k_value == pytest.approx(0.028)
  2836. assert kp.extruder == 0
  2837. assert kp.nozzle_diameter == "0.4"
  2838. assert kp.name == "Devil Design PLA"
  2839. @pytest.mark.asyncio
  2840. @pytest.mark.integration
  2841. async def test_no_assignment_no_persist(
  2842. self,
  2843. async_client: AsyncClient,
  2844. db_session,
  2845. printer_factory,
  2846. ):
  2847. """No SpoolAssignment AND no SpoolmanSlotAssignment → no DB write, MQTT still sent."""
  2848. from backend.app.models.spool_k_profile import SpoolKProfile
  2849. from backend.app.models.spoolman_k_profile import SpoolmanKProfile
  2850. printer = await printer_factory(model="H2D")
  2851. mock_client = MagicMock()
  2852. mock_client.ams_set_filament_setting.return_value = True
  2853. mock_client.extrusion_cali_sel.return_value = True
  2854. mock_client.request_status_update.return_value = True
  2855. mock_state = MagicMock()
  2856. mock_state.ams_extruder_map = {"0": 0}
  2857. mock_state.raw_data = {"ams": {"ams": []}}
  2858. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  2859. mock_pm.get_client.return_value = mock_client
  2860. mock_pm.get_status.return_value = mock_state
  2861. response = await async_client.post(
  2862. f"/api/v1/printers/{printer.id}/slots/0/3/configure",
  2863. params={
  2864. "tray_info_idx": "GFL05",
  2865. "tray_type": "PLA",
  2866. "tray_sub_brands": "PLA Basic",
  2867. "tray_color": "FFFFFFFF",
  2868. "nozzle_temp_min": 190,
  2869. "nozzle_temp_max": 230,
  2870. "cali_idx": 5,
  2871. "k_value": 0.020,
  2872. },
  2873. )
  2874. assert response.status_code == 200
  2875. # MQTT sent (was successful), but no DB writes
  2876. mock_client.extrusion_cali_sel.assert_called_once()
  2877. local_count = (await db_session.execute(select(SpoolKProfile))).scalars().all()
  2878. sm_count = (await db_session.execute(select(SpoolmanKProfile))).scalars().all()
  2879. assert len(local_count) == 0
  2880. assert len(sm_count) == 0
  2881. @pytest.mark.asyncio
  2882. @pytest.mark.integration
  2883. async def test_negative_cali_idx_no_persist(
  2884. self,
  2885. async_client: AsyncClient,
  2886. db_session,
  2887. printer_factory,
  2888. ):
  2889. """cali_idx=-1 (no profile selected) → no DB write even when assignment exists."""
  2890. from backend.app.models.settings import Settings
  2891. from backend.app.models.spoolman_k_profile import SpoolmanKProfile
  2892. from backend.app.models.spoolman_slot_assignment import SpoolmanSlotAssignment
  2893. # A spoolman_slot_assignments row only exists in Spoolman mode, and
  2894. # since #2812 the mode is asked for explicitly rather than inferred
  2895. # from which table happens to hold rows.
  2896. db_session.add(Settings(key="spoolman_enabled", value="true"))
  2897. printer = await printer_factory(model="H2D")
  2898. db_session.add(
  2899. SpoolmanSlotAssignment(
  2900. printer_id=printer.id,
  2901. ams_id=0,
  2902. tray_id=3,
  2903. spoolman_spool_id=216,
  2904. )
  2905. )
  2906. await db_session.commit()
  2907. mock_client = MagicMock()
  2908. mock_client.ams_set_filament_setting.return_value = True
  2909. mock_client.extrusion_cali_sel.return_value = True
  2910. mock_client.extrusion_cali_set.return_value = True
  2911. mock_client.request_status_update.return_value = True
  2912. mock_state = MagicMock()
  2913. mock_state.ams_extruder_map = {"0": 0}
  2914. mock_state.raw_data = {"ams": {"ams": []}}
  2915. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  2916. mock_pm.get_client.return_value = mock_client
  2917. mock_pm.get_status.return_value = mock_state
  2918. response = await async_client.post(
  2919. f"/api/v1/printers/{printer.id}/slots/0/3/configure",
  2920. params={
  2921. "tray_info_idx": "GFL05",
  2922. "tray_type": "PLA",
  2923. "tray_sub_brands": "PLA Basic",
  2924. "tray_color": "FFFFFFFF",
  2925. "nozzle_temp_min": 190,
  2926. "nozzle_temp_max": 230,
  2927. "cali_idx": -1,
  2928. "k_value": 0.0,
  2929. },
  2930. )
  2931. assert response.status_code == 200
  2932. sm_kps = (
  2933. (await db_session.execute(select(SpoolmanKProfile).where(SpoolmanKProfile.spoolman_spool_id == 216)))
  2934. .scalars()
  2935. .all()
  2936. )
  2937. assert len(sm_kps) == 0 # cali_idx=-1 means "no profile" — don't write
  2938. @pytest.mark.asyncio
  2939. @pytest.mark.integration
  2940. async def test_zero_cali_idx_persists(
  2941. self,
  2942. async_client: AsyncClient,
  2943. db_session,
  2944. printer_factory,
  2945. ):
  2946. """cali_idx=0 is the first valid profile slot (NOT a sentinel for missing)."""
  2947. from backend.app.models.settings import Settings
  2948. from backend.app.models.spoolman_k_profile import SpoolmanKProfile
  2949. from backend.app.models.spoolman_slot_assignment import SpoolmanSlotAssignment
  2950. # A spoolman_slot_assignments row only exists in Spoolman mode, and
  2951. # since #2812 the mode is asked for explicitly rather than inferred
  2952. # from which table happens to hold rows.
  2953. db_session.add(Settings(key="spoolman_enabled", value="true"))
  2954. printer = await printer_factory(model="H2D")
  2955. db_session.add(
  2956. SpoolmanSlotAssignment(
  2957. printer_id=printer.id,
  2958. ams_id=0,
  2959. tray_id=3,
  2960. spoolman_spool_id=216,
  2961. )
  2962. )
  2963. await db_session.commit()
  2964. mock_client = MagicMock()
  2965. mock_client.ams_set_filament_setting.return_value = True
  2966. mock_client.extrusion_cali_sel.return_value = True
  2967. mock_client.request_status_update.return_value = True
  2968. mock_state = MagicMock()
  2969. mock_state.ams_extruder_map = {"0": 0}
  2970. mock_state.raw_data = {"ams": {"ams": []}}
  2971. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  2972. mock_pm.get_client.return_value = mock_client
  2973. mock_pm.get_status.return_value = mock_state
  2974. response = await async_client.post(
  2975. f"/api/v1/printers/{printer.id}/slots/0/3/configure",
  2976. params={
  2977. "tray_info_idx": "GFL05",
  2978. "tray_type": "PLA",
  2979. "tray_sub_brands": "PLA Basic",
  2980. "tray_color": "FFFFFFFF",
  2981. "nozzle_temp_min": 190,
  2982. "nozzle_temp_max": 230,
  2983. "cali_idx": 0,
  2984. "k_value": 0.020,
  2985. },
  2986. )
  2987. assert response.status_code == 200
  2988. kp = (
  2989. await db_session.execute(select(SpoolmanKProfile).where(SpoolmanKProfile.spoolman_spool_id == 216))
  2990. ).scalar_one_or_none()
  2991. assert kp is not None
  2992. assert kp.cali_idx == 0 # explicitly testing 0 is valid
  2993. @pytest.mark.asyncio
  2994. @pytest.mark.integration
  2995. async def test_upsert_idempotent(
  2996. self,
  2997. async_client: AsyncClient,
  2998. db_session,
  2999. printer_factory,
  3000. ):
  3001. """Repeated POSTs update the same row (UNIQUE on spool_id+printer+extruder+nozzle_diameter)."""
  3002. from backend.app.models.settings import Settings
  3003. from backend.app.models.spoolman_k_profile import SpoolmanKProfile
  3004. from backend.app.models.spoolman_slot_assignment import SpoolmanSlotAssignment
  3005. # A spoolman_slot_assignments row only exists in Spoolman mode, and
  3006. # since #2812 the mode is asked for explicitly rather than inferred
  3007. # from which table happens to hold rows.
  3008. db_session.add(Settings(key="spoolman_enabled", value="true"))
  3009. printer = await printer_factory(model="H2D")
  3010. db_session.add(
  3011. SpoolmanSlotAssignment(
  3012. printer_id=printer.id,
  3013. ams_id=0,
  3014. tray_id=3,
  3015. spoolman_spool_id=216,
  3016. )
  3017. )
  3018. await db_session.commit()
  3019. mock_client = MagicMock()
  3020. mock_client.ams_set_filament_setting.return_value = True
  3021. mock_client.extrusion_cali_sel.return_value = True
  3022. mock_client.request_status_update.return_value = True
  3023. mock_state = MagicMock()
  3024. mock_state.ams_extruder_map = {"0": 0}
  3025. mock_state.raw_data = {"ams": {"ams": []}}
  3026. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3027. mock_pm.get_client.return_value = mock_client
  3028. mock_pm.get_status.return_value = mock_state
  3029. # First call with cali_idx=5
  3030. await async_client.post(
  3031. f"/api/v1/printers/{printer.id}/slots/0/3/configure",
  3032. params={
  3033. "tray_info_idx": "GFL05",
  3034. "tray_type": "PLA",
  3035. "tray_sub_brands": "PLA Basic",
  3036. "tray_color": "FFFFFFFF",
  3037. "nozzle_temp_min": 190,
  3038. "nozzle_temp_max": 230,
  3039. "cali_idx": 5,
  3040. "k_value": 0.020,
  3041. },
  3042. )
  3043. # Second call with cali_idx=10 (same slot/spool/extruder/nozzle)
  3044. await async_client.post(
  3045. f"/api/v1/printers/{printer.id}/slots/0/3/configure",
  3046. params={
  3047. "tray_info_idx": "GFL05",
  3048. "tray_type": "PLA",
  3049. "tray_sub_brands": "PLA Matte",
  3050. "tray_color": "FFFFFFFF",
  3051. "nozzle_temp_min": 190,
  3052. "nozzle_temp_max": 230,
  3053. "cali_idx": 10,
  3054. "k_value": 0.025,
  3055. },
  3056. )
  3057. # Should be exactly ONE row (updated), not two
  3058. kps = (
  3059. (await db_session.execute(select(SpoolmanKProfile).where(SpoolmanKProfile.spoolman_spool_id == 216)))
  3060. .scalars()
  3061. .all()
  3062. )
  3063. assert len(kps) == 1
  3064. assert kps[0].cali_idx == 10 # updated to most recent
  3065. assert kps[0].name == "PLA Matte"
  3066. @pytest.mark.asyncio
  3067. @pytest.mark.integration
  3068. async def test_external_slot_extruder_inversion(
  3069. self,
  3070. async_client: AsyncClient,
  3071. db_session,
  3072. printer_factory,
  3073. ):
  3074. """ams_id=255 + tray_id=0 → kp.extruder=1 (ext-L); tray_id=1 → extruder=0 (ext-R)."""
  3075. from backend.app.models.spool import Spool
  3076. from backend.app.models.spool_assignment import SpoolAssignment
  3077. from backend.app.models.spool_k_profile import SpoolKProfile
  3078. printer = await printer_factory(model="H2D")
  3079. spool = Spool(material="PLA")
  3080. db_session.add(spool)
  3081. await db_session.flush()
  3082. # Note: SpoolmanSlotAssignment can't store ams_id=255 with tray_id=1
  3083. # under the ck_tray_id_range constraint (0-3 valid). External-slot
  3084. # K-profile persistence is therefore tested via local SpoolAssignment.
  3085. db_session.add(
  3086. SpoolAssignment(
  3087. spool_id=spool.id,
  3088. printer_id=printer.id,
  3089. ams_id=255,
  3090. tray_id=0,
  3091. )
  3092. )
  3093. await db_session.commit()
  3094. spool_id = spool.id
  3095. mock_client = MagicMock()
  3096. mock_client.ams_set_filament_setting.return_value = True
  3097. mock_client.extrusion_cali_sel.return_value = True
  3098. mock_client.request_status_update.return_value = True
  3099. mock_state = MagicMock()
  3100. mock_state.ams_extruder_map = {"0": 0} # truthy so external-inversion path runs
  3101. mock_state.raw_data = {"ams": {"ams": []}}
  3102. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3103. mock_pm.get_client.return_value = mock_client
  3104. mock_pm.get_status.return_value = mock_state
  3105. response = await async_client.post(
  3106. f"/api/v1/printers/{printer.id}/slots/255/0/configure",
  3107. params={
  3108. "tray_info_idx": "GFL05",
  3109. "tray_type": "PLA",
  3110. "tray_sub_brands": "PLA Basic",
  3111. "tray_color": "FFFFFFFF",
  3112. "nozzle_temp_min": 190,
  3113. "nozzle_temp_max": 230,
  3114. "cali_idx": 5,
  3115. "k_value": 0.020,
  3116. },
  3117. )
  3118. assert response.status_code == 200
  3119. kp = (
  3120. await db_session.execute(select(SpoolKProfile).where(SpoolKProfile.spool_id == spool_id))
  3121. ).scalar_one_or_none()
  3122. assert kp is not None
  3123. # tray_id=0 → extruder = 1 - 0 = 1
  3124. assert kp.extruder == 1
  3125. @pytest.mark.asyncio
  3126. @pytest.mark.integration
  3127. async def test_dual_nozzle_extruder_persists(
  3128. self,
  3129. async_client: AsyncClient,
  3130. db_session,
  3131. printer_factory,
  3132. ):
  3133. """ams_extruder_map with extruder=1 → kp.extruder=1 persisted correctly."""
  3134. from backend.app.models.spool import Spool
  3135. from backend.app.models.spool_assignment import SpoolAssignment
  3136. from backend.app.models.spool_k_profile import SpoolKProfile
  3137. printer = await printer_factory(model="H2D")
  3138. spool = Spool(material="PLA")
  3139. db_session.add(spool)
  3140. await db_session.flush()
  3141. db_session.add(
  3142. SpoolAssignment(
  3143. spool_id=spool.id,
  3144. printer_id=printer.id,
  3145. ams_id=2,
  3146. tray_id=3,
  3147. )
  3148. )
  3149. await db_session.commit()
  3150. spool_id = spool.id
  3151. mock_client = MagicMock()
  3152. mock_client.ams_set_filament_setting.return_value = True
  3153. mock_client.extrusion_cali_sel.return_value = True
  3154. mock_client.request_status_update.return_value = True
  3155. mock_state = MagicMock()
  3156. mock_state.ams_extruder_map = {"2": 1} # AMS 2 is on extruder 1
  3157. mock_state.raw_data = {"ams": {"ams": []}}
  3158. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3159. mock_pm.get_client.return_value = mock_client
  3160. mock_pm.get_status.return_value = mock_state
  3161. response = await async_client.post(
  3162. f"/api/v1/printers/{printer.id}/slots/2/3/configure",
  3163. params={
  3164. "tray_info_idx": "GFL05",
  3165. "tray_type": "PLA",
  3166. "tray_sub_brands": "PLA Basic",
  3167. "tray_color": "FFFFFFFF",
  3168. "nozzle_temp_min": 190,
  3169. "nozzle_temp_max": 230,
  3170. "cali_idx": 5,
  3171. "k_value": 0.020,
  3172. },
  3173. )
  3174. assert response.status_code == 200
  3175. kp = (
  3176. await db_session.execute(select(SpoolKProfile).where(SpoolKProfile.spool_id == spool_id))
  3177. ).scalar_one_or_none()
  3178. assert kp is not None
  3179. assert kp.extruder == 1
  3180. @pytest.mark.asyncio
  3181. @pytest.mark.integration
  3182. async def test_db_error_does_not_fail_endpoint(
  3183. self,
  3184. async_client: AsyncClient,
  3185. db_session,
  3186. printer_factory,
  3187. ):
  3188. """DB errors during K-profile persistence are best-effort — endpoint still returns 200.
  3189. Verifies the try/except wrap added in P13-3b: if DB upsert fails (e.g.
  3190. because the schema is out of sync, a constraint violation, or any
  3191. other transient error), the MQTT command was already sent successfully
  3192. so we shouldn't return 500 to the user. The error is logged and the
  3193. endpoint returns success.
  3194. """
  3195. from backend.app.models.settings import Settings
  3196. from backend.app.models.spoolman_slot_assignment import SpoolmanSlotAssignment
  3197. # A spoolman_slot_assignments row only exists in Spoolman mode, and
  3198. # since #2812 the mode is asked for explicitly rather than inferred
  3199. # from which table happens to hold rows.
  3200. db_session.add(Settings(key="spoolman_enabled", value="true"))
  3201. printer = await printer_factory(model="H2D")
  3202. db_session.add(
  3203. SpoolmanSlotAssignment(
  3204. printer_id=printer.id,
  3205. ams_id=0,
  3206. tray_id=3,
  3207. spoolman_spool_id=216,
  3208. )
  3209. )
  3210. await db_session.commit()
  3211. mock_client = MagicMock()
  3212. mock_client.ams_set_filament_setting.return_value = True
  3213. mock_client.extrusion_cali_sel.return_value = True
  3214. mock_client.request_status_update.return_value = True
  3215. mock_state = MagicMock()
  3216. mock_state.ams_extruder_map = {"0": 0}
  3217. mock_state.raw_data = {"ams": {"ams": []}}
  3218. # Force the K-profile persistence path to fail by patching the
  3219. # SpoolmanKProfile model class with a sentinel that raises when
  3220. # instantiated. The MQTT call has already happened by then, so the
  3221. # endpoint must catch and log without returning 500.
  3222. with (
  3223. patch("backend.app.api.routes.printers.printer_manager") as mock_pm,
  3224. patch(
  3225. "backend.app.models.spoolman_k_profile.SpoolmanKProfile",
  3226. side_effect=RuntimeError("Simulated DB error"),
  3227. ),
  3228. ):
  3229. mock_pm.get_client.return_value = mock_client
  3230. mock_pm.get_status.return_value = mock_state
  3231. response = await async_client.post(
  3232. f"/api/v1/printers/{printer.id}/slots/0/3/configure",
  3233. params={
  3234. "tray_info_idx": "GFL05",
  3235. "tray_type": "PLA",
  3236. "tray_sub_brands": "PLA Basic",
  3237. "tray_color": "FFFFFFFF",
  3238. "nozzle_temp_min": 190,
  3239. "nozzle_temp_max": 230,
  3240. "cali_idx": 5,
  3241. "k_value": 0.020,
  3242. },
  3243. )
  3244. # Endpoint returns success — MQTT was sent, K-profile failed silently
  3245. assert response.status_code == 200
  3246. # MQTT was indeed called
  3247. mock_client.extrusion_cali_sel.assert_called_once()
  3248. class TestPrinterAccessCodeVisibility:
  3249. """Regression coverage: GET /printers and GET /printers/{id} must NOT
  3250. return ``access_code`` to callers without PRINTERS_UPDATE authority.
  3251. Holding ``access_code`` lets the caller talk to the printer's MQTT
  3252. directly with serial+code, bypassing every PRINTERS_CONTROL /
  3253. PRINTERS_FILES / PRINTERS_AMS_RFID check Bambuddy enforces.
  3254. Trust matrix encoded here:
  3255. - Auth disabled → access_code visible (single-trust mode)
  3256. - JWT Admin → access_code visible
  3257. - JWT Operator (has *_UPDATE) → access_code visible (VP-card UX)
  3258. - JWT Viewer → access_code STRIPPED
  3259. - API key with can_read_status → access_code STRIPPED
  3260. """
  3261. @pytest.fixture
  3262. async def auth_setup(self, async_client: AsyncClient):
  3263. await async_client.post(
  3264. "/api/v1/auth/setup",
  3265. json={
  3266. "auth_enabled": True,
  3267. "admin_username": "pcadmin",
  3268. "admin_password": "AdminPass1!",
  3269. },
  3270. )
  3271. async def _login(username, password):
  3272. resp = await async_client.post(
  3273. "/api/v1/auth/login",
  3274. json={"username": username, "password": password},
  3275. )
  3276. return resp.json()["access_token"]
  3277. admin_token = await _login("pcadmin", "AdminPass1!")
  3278. groups = (
  3279. await async_client.get(
  3280. "/api/v1/groups/",
  3281. headers={"Authorization": f"Bearer {admin_token}"},
  3282. )
  3283. ).json()
  3284. operators_group = next(g for g in groups if g["name"] == "Operators")
  3285. viewers_group = next(g for g in groups if g["name"] == "Viewers")
  3286. for username, password, group in (
  3287. ("pcoperator", "Operpass1!", operators_group["id"]),
  3288. ("pcviewer", "Viewpass1!", viewers_group["id"]),
  3289. ):
  3290. await async_client.post(
  3291. "/api/v1/users/",
  3292. headers={"Authorization": f"Bearer {admin_token}"},
  3293. json={"username": username, "password": password, "group_ids": [group]},
  3294. )
  3295. operator_token = await _login("pcoperator", "Operpass1!")
  3296. viewer_token = await _login("pcviewer", "Viewpass1!")
  3297. return {
  3298. "admin_token": admin_token,
  3299. "operator_token": operator_token,
  3300. "viewer_token": viewer_token,
  3301. }
  3302. async def _seed_printer_with_known_code(self, async_client: AsyncClient, admin_token: str) -> int:
  3303. resp = await async_client.post(
  3304. "/api/v1/printers/",
  3305. headers={"Authorization": f"Bearer {admin_token}"},
  3306. json={
  3307. "name": "AC-Visibility",
  3308. "serial_number": "00M09AVISIBILITY",
  3309. "ip_address": "192.168.42.42",
  3310. "access_code": "SECRET-CODE",
  3311. "is_active": True,
  3312. "model": "X1C",
  3313. },
  3314. )
  3315. assert resp.status_code == 200, resp.text
  3316. return resp.json()["id"]
  3317. @pytest.mark.asyncio
  3318. @pytest.mark.integration
  3319. async def test_auth_disabled_includes_access_code(self, async_client: AsyncClient, printer_factory):
  3320. """Single-trust mode: behaviour preserved, code is visible."""
  3321. printer = await printer_factory(name="AuthOff", access_code="LOCAL-CODE")
  3322. list_resp = await async_client.get("/api/v1/printers/")
  3323. detail_resp = await async_client.get(f"/api/v1/printers/{printer.id}")
  3324. assert list_resp.status_code == 200
  3325. assert detail_resp.status_code == 200
  3326. match = next(p for p in list_resp.json() if p["id"] == printer.id)
  3327. assert match["access_code"] == "LOCAL-CODE"
  3328. assert detail_resp.json()["access_code"] == "LOCAL-CODE"
  3329. @pytest.mark.asyncio
  3330. @pytest.mark.integration
  3331. async def test_admin_jwt_includes_access_code(self, async_client: AsyncClient, auth_setup):
  3332. printer_id = await self._seed_printer_with_known_code(async_client, auth_setup["admin_token"])
  3333. headers = {"Authorization": f"Bearer {auth_setup['admin_token']}"}
  3334. list_resp = await async_client.get("/api/v1/printers/", headers=headers)
  3335. detail_resp = await async_client.get(f"/api/v1/printers/{printer_id}", headers=headers)
  3336. assert list_resp.status_code == 200
  3337. assert detail_resp.status_code == 200
  3338. match = next(p for p in list_resp.json() if p["id"] == printer_id)
  3339. assert match["access_code"] == "SECRET-CODE"
  3340. assert detail_resp.json()["access_code"] == "SECRET-CODE"
  3341. @pytest.mark.asyncio
  3342. @pytest.mark.integration
  3343. async def test_operator_jwt_includes_access_code(self, async_client: AsyncClient, auth_setup):
  3344. """Operators hold PRINTERS_UPDATE (default role) — the VP-card UX
  3345. surfaces the target printer's access_code so they can configure
  3346. their slicer. The visibility predicate must keep working for them.
  3347. """
  3348. printer_id = await self._seed_printer_with_known_code(async_client, auth_setup["admin_token"])
  3349. headers = {"Authorization": f"Bearer {auth_setup['operator_token']}"}
  3350. list_resp = await async_client.get("/api/v1/printers/", headers=headers)
  3351. detail_resp = await async_client.get(f"/api/v1/printers/{printer_id}", headers=headers)
  3352. assert list_resp.status_code == 200
  3353. assert detail_resp.status_code == 200
  3354. match = next(p for p in list_resp.json() if p["id"] == printer_id)
  3355. assert match["access_code"] == "SECRET-CODE"
  3356. assert detail_resp.json()["access_code"] == "SECRET-CODE"
  3357. @pytest.mark.asyncio
  3358. @pytest.mark.integration
  3359. async def test_viewer_jwt_excludes_access_code(self, async_client: AsyncClient, auth_setup):
  3360. """The fix: Viewers hold PRINTERS_READ but not PRINTERS_UPDATE, and
  3361. must NOT be able to read the printer's secret.
  3362. """
  3363. printer_id = await self._seed_printer_with_known_code(async_client, auth_setup["admin_token"])
  3364. headers = {"Authorization": f"Bearer {auth_setup['viewer_token']}"}
  3365. list_resp = await async_client.get("/api/v1/printers/", headers=headers)
  3366. detail_resp = await async_client.get(f"/api/v1/printers/{printer_id}", headers=headers)
  3367. assert list_resp.status_code == 200
  3368. assert detail_resp.status_code == 200
  3369. match = next(p for p in list_resp.json() if p["id"] == printer_id)
  3370. # Field absent OR null — both are acceptable (no usable secret reaches the wire).
  3371. assert "access_code" not in match or match["access_code"] is None
  3372. body = detail_resp.json()
  3373. assert "access_code" not in body or body["access_code"] is None
  3374. # And the rest of the payload still arrives so the UI keeps working.
  3375. assert match["name"] == "AC-Visibility"
  3376. assert body["name"] == "AC-Visibility"
  3377. @pytest.mark.asyncio
  3378. @pytest.mark.integration
  3379. async def test_api_key_excludes_access_code(self, async_client: AsyncClient, auth_setup, db_session):
  3380. """API keys with can_read_status hold PRINTERS_READ but the predicate
  3381. gates on PRINTERS_UPDATE (admin-only / API-key-unmapped). The key
  3382. must NOT be able to exfiltrate access_code.
  3383. """
  3384. from backend.app.core.auth import generate_api_key
  3385. from backend.app.models.api_key import APIKey
  3386. printer_id = await self._seed_printer_with_known_code(async_client, auth_setup["admin_token"])
  3387. full_key, key_hash, key_prefix = generate_api_key()
  3388. api_key = APIKey(
  3389. name="visibility-key",
  3390. key_hash=key_hash,
  3391. key_prefix=key_prefix,
  3392. can_read_status=True,
  3393. enabled=True,
  3394. )
  3395. db_session.add(api_key)
  3396. await db_session.commit()
  3397. list_resp = await async_client.get("/api/v1/printers/", headers={"X-API-Key": full_key})
  3398. detail_resp = await async_client.get(f"/api/v1/printers/{printer_id}", headers={"X-API-Key": full_key})
  3399. assert list_resp.status_code == 200
  3400. assert detail_resp.status_code == 200
  3401. match = next(p for p in list_resp.json() if p["id"] == printer_id)
  3402. assert "access_code" not in match or match["access_code"] is None
  3403. body = detail_resp.json()
  3404. assert "access_code" not in body or body["access_code"] is None
  3405. class TestSetNozzleTemperatureAPI:
  3406. """Integration tests for POST /printers/{id}/temperature/nozzle (#1661)."""
  3407. @pytest.mark.asyncio
  3408. @pytest.mark.integration
  3409. async def test_not_found(self, async_client: AsyncClient):
  3410. response = await async_client.post("/api/v1/printers/99999/temperature/nozzle?target=220")
  3411. assert response.status_code == 404
  3412. @pytest.mark.asyncio
  3413. @pytest.mark.integration
  3414. async def test_not_connected(self, async_client: AsyncClient, printer_factory):
  3415. printer = await printer_factory(name="P", model="X1C")
  3416. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3417. mock_pm.get_client.return_value = None
  3418. response = await async_client.post(f"/api/v1/printers/{printer.id}/temperature/nozzle?target=220")
  3419. assert response.status_code == 400
  3420. @pytest.mark.asyncio
  3421. @pytest.mark.integration
  3422. async def test_default_nozzle_index(self, async_client: AsyncClient, printer_factory):
  3423. """Omitting nozzle defaults to 0 (right/default)."""
  3424. printer = await printer_factory(name="P", model="X1C")
  3425. mock_client = MagicMock()
  3426. mock_client.set_nozzle_temperature.return_value = True
  3427. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3428. mock_pm.get_client.return_value = mock_client
  3429. response = await async_client.post(f"/api/v1/printers/{printer.id}/temperature/nozzle?target=220")
  3430. assert response.status_code == 200
  3431. mock_client.set_nozzle_temperature.assert_called_once_with(220, 0)
  3432. @pytest.mark.asyncio
  3433. @pytest.mark.integration
  3434. async def test_dual_nozzle_left(self, async_client: AsyncClient, printer_factory):
  3435. """nozzle=1 reaches the client method as the second positional arg."""
  3436. printer = await printer_factory(name="P", model="H2D")
  3437. mock_client = MagicMock()
  3438. mock_client.set_nozzle_temperature.return_value = True
  3439. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3440. mock_pm.get_client.return_value = mock_client
  3441. response = await async_client.post(f"/api/v1/printers/{printer.id}/temperature/nozzle?target=260&nozzle=1")
  3442. assert response.status_code == 200
  3443. mock_client.set_nozzle_temperature.assert_called_once_with(260, 1)
  3444. @pytest.mark.asyncio
  3445. @pytest.mark.integration
  3446. async def test_target_zero_allowed(self, async_client: AsyncClient, printer_factory):
  3447. """target=0 turns the heater off; must NOT be rejected by Query bounds."""
  3448. printer = await printer_factory(name="P", model="X1C")
  3449. mock_client = MagicMock()
  3450. mock_client.set_nozzle_temperature.return_value = True
  3451. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3452. mock_pm.get_client.return_value = mock_client
  3453. response = await async_client.post(f"/api/v1/printers/{printer.id}/temperature/nozzle?target=0")
  3454. assert response.status_code == 200
  3455. mock_client.set_nozzle_temperature.assert_called_once_with(0, 0)
  3456. @pytest.mark.asyncio
  3457. @pytest.mark.integration
  3458. async def test_target_out_of_range_rejected(self, async_client: AsyncClient, printer_factory):
  3459. printer = await printer_factory(name="P", model="X1C")
  3460. response = await async_client.post(f"/api/v1/printers/{printer.id}/temperature/nozzle?target=400")
  3461. assert response.status_code == 422 # FastAPI bounds violation
  3462. @pytest.mark.asyncio
  3463. @pytest.mark.integration
  3464. async def test_nozzle_index_out_of_range_rejected(self, async_client: AsyncClient, printer_factory):
  3465. printer = await printer_factory(name="P", model="H2D")
  3466. response = await async_client.post(f"/api/v1/printers/{printer.id}/temperature/nozzle?target=220&nozzle=2")
  3467. assert response.status_code == 422
  3468. @pytest.mark.asyncio
  3469. @pytest.mark.integration
  3470. async def test_client_failure_returns_500(self, async_client: AsyncClient, printer_factory):
  3471. printer = await printer_factory(name="P", model="X1C")
  3472. mock_client = MagicMock()
  3473. mock_client.set_nozzle_temperature.return_value = False
  3474. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3475. mock_pm.get_client.return_value = mock_client
  3476. response = await async_client.post(f"/api/v1/printers/{printer.id}/temperature/nozzle?target=220")
  3477. assert response.status_code == 500
  3478. class TestSetBedTemperatureAPI:
  3479. """Integration tests for POST /printers/{id}/temperature/bed (#1661)."""
  3480. @pytest.mark.asyncio
  3481. @pytest.mark.integration
  3482. async def test_not_found(self, async_client: AsyncClient):
  3483. response = await async_client.post("/api/v1/printers/99999/temperature/bed?target=60")
  3484. assert response.status_code == 404
  3485. @pytest.mark.asyncio
  3486. @pytest.mark.integration
  3487. async def test_not_connected(self, async_client: AsyncClient, printer_factory):
  3488. printer = await printer_factory(name="P", model="X1C")
  3489. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3490. mock_pm.get_client.return_value = None
  3491. response = await async_client.post(f"/api/v1/printers/{printer.id}/temperature/bed?target=60")
  3492. assert response.status_code == 400
  3493. @pytest.mark.asyncio
  3494. @pytest.mark.integration
  3495. async def test_success(self, async_client: AsyncClient, printer_factory):
  3496. printer = await printer_factory(name="P", model="X1C")
  3497. mock_client = MagicMock()
  3498. mock_client.set_bed_temperature.return_value = True
  3499. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3500. mock_pm.get_client.return_value = mock_client
  3501. response = await async_client.post(f"/api/v1/printers/{printer.id}/temperature/bed?target=60")
  3502. assert response.status_code == 200
  3503. mock_client.set_bed_temperature.assert_called_once_with(60)
  3504. @pytest.mark.asyncio
  3505. @pytest.mark.integration
  3506. async def test_target_zero_allowed(self, async_client: AsyncClient, printer_factory):
  3507. """target=0 turns the bed heater off."""
  3508. printer = await printer_factory(name="P", model="X1C")
  3509. mock_client = MagicMock()
  3510. mock_client.set_bed_temperature.return_value = True
  3511. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3512. mock_pm.get_client.return_value = mock_client
  3513. response = await async_client.post(f"/api/v1/printers/{printer.id}/temperature/bed?target=0")
  3514. assert response.status_code == 200
  3515. mock_client.set_bed_temperature.assert_called_once_with(0)
  3516. @pytest.mark.asyncio
  3517. @pytest.mark.integration
  3518. async def test_target_out_of_range_rejected(self, async_client: AsyncClient, printer_factory):
  3519. printer = await printer_factory(name="P", model="X1C")
  3520. response = await async_client.post(f"/api/v1/printers/{printer.id}/temperature/bed?target=200")
  3521. assert response.status_code == 422
  3522. @pytest.mark.asyncio
  3523. @pytest.mark.integration
  3524. async def test_client_failure_returns_500(self, async_client: AsyncClient, printer_factory):
  3525. printer = await printer_factory(name="P", model="X1C")
  3526. mock_client = MagicMock()
  3527. mock_client.set_bed_temperature.return_value = False
  3528. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3529. mock_pm.get_client.return_value = mock_client
  3530. response = await async_client.post(f"/api/v1/printers/{printer.id}/temperature/bed?target=60")
  3531. assert response.status_code == 500
  3532. class TestSetChamberTemperatureAPI:
  3533. """Integration tests for POST /printers/{id}/temperature/chamber.
  3534. Gated on supports_chamber_heater(model). Sensor-only models that report
  3535. chamber temp but have no heater (X1C, X1E, P2S) get a 400 at the route
  3536. level rather than a silent no-op at the firmware level.
  3537. """
  3538. @pytest.mark.asyncio
  3539. @pytest.mark.integration
  3540. async def test_not_found(self, async_client: AsyncClient):
  3541. response = await async_client.post("/api/v1/printers/99999/temperature/chamber?target=45")
  3542. assert response.status_code == 404
  3543. @pytest.mark.asyncio
  3544. @pytest.mark.integration
  3545. @pytest.mark.parametrize("sensor_only_model", ["X1C", "X1E", "P2S"])
  3546. async def test_sensor_only_model_rejected(self, async_client: AsyncClient, printer_factory, sensor_only_model):
  3547. """Models with sensor but no heater must 400 before any client call."""
  3548. printer = await printer_factory(name="P", model=sensor_only_model)
  3549. mock_client = MagicMock()
  3550. mock_client.set_chamber_temperature.return_value = True
  3551. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3552. mock_pm.get_client.return_value = mock_client
  3553. response = await async_client.post(f"/api/v1/printers/{printer.id}/temperature/chamber?target=45")
  3554. assert response.status_code == 400
  3555. # Client must NOT be called for sensor-only models.
  3556. mock_client.set_chamber_temperature.assert_not_called()
  3557. @pytest.mark.asyncio
  3558. @pytest.mark.integration
  3559. async def test_not_connected(self, async_client: AsyncClient, printer_factory):
  3560. printer = await printer_factory(name="P", model="H2D")
  3561. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3562. mock_pm.get_client.return_value = None
  3563. response = await async_client.post(f"/api/v1/printers/{printer.id}/temperature/chamber?target=45")
  3564. assert response.status_code == 400
  3565. @pytest.mark.asyncio
  3566. @pytest.mark.integration
  3567. @pytest.mark.parametrize("heater_model", ["H2C", "H2D", "H2DPRO", "H2S", "X2D"])
  3568. async def test_success_per_heater_model(self, async_client: AsyncClient, printer_factory, heater_model):
  3569. """All five heater-equipped models accept the command."""
  3570. printer = await printer_factory(name="P", model=heater_model)
  3571. mock_client = MagicMock()
  3572. mock_client.set_chamber_temperature.return_value = True
  3573. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3574. mock_pm.get_client.return_value = mock_client
  3575. response = await async_client.post(f"/api/v1/printers/{printer.id}/temperature/chamber?target=45")
  3576. assert response.status_code == 200
  3577. mock_client.set_chamber_temperature.assert_called_once_with(45)
  3578. @pytest.mark.asyncio
  3579. @pytest.mark.integration
  3580. async def test_target_zero_allowed(self, async_client: AsyncClient, printer_factory):
  3581. """target=0 turns the chamber heater off."""
  3582. printer = await printer_factory(name="P", model="H2D")
  3583. mock_client = MagicMock()
  3584. mock_client.set_chamber_temperature.return_value = True
  3585. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3586. mock_pm.get_client.return_value = mock_client
  3587. response = await async_client.post(f"/api/v1/printers/{printer.id}/temperature/chamber?target=0")
  3588. assert response.status_code == 200
  3589. mock_client.set_chamber_temperature.assert_called_once_with(0)
  3590. @pytest.mark.asyncio
  3591. @pytest.mark.integration
  3592. async def test_target_out_of_range_rejected(self, async_client: AsyncClient, printer_factory):
  3593. printer = await printer_factory(name="P", model="H2D")
  3594. response = await async_client.post(f"/api/v1/printers/{printer.id}/temperature/chamber?target=100")
  3595. assert response.status_code == 422
  3596. @pytest.mark.asyncio
  3597. @pytest.mark.integration
  3598. async def test_ceiling_is_65_not_60(self, async_client: AsyncClient, printer_factory):
  3599. """The H2 series heats the chamber to 65 °C — 65 must be accepted and
  3600. 66 rejected. The route used to cap at 60, which put the top of the H2D
  3601. range out of reach."""
  3602. printer = await printer_factory(name="P", model="H2D")
  3603. mock_client = MagicMock()
  3604. mock_client.set_chamber_temperature.return_value = True
  3605. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3606. mock_pm.get_client.return_value = mock_client
  3607. accepted = await async_client.post(f"/api/v1/printers/{printer.id}/temperature/chamber?target=65")
  3608. assert accepted.status_code == 200
  3609. mock_client.set_chamber_temperature.assert_called_once_with(65)
  3610. rejected = await async_client.post(f"/api/v1/printers/{printer.id}/temperature/chamber?target=66")
  3611. assert rejected.status_code == 422
  3612. @pytest.mark.asyncio
  3613. @pytest.mark.integration
  3614. async def test_client_failure_returns_500(self, async_client: AsyncClient, printer_factory):
  3615. printer = await printer_factory(name="P", model="H2D")
  3616. mock_client = MagicMock()
  3617. mock_client.set_chamber_temperature.return_value = False
  3618. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3619. mock_pm.get_client.return_value = mock_client
  3620. response = await async_client.post(f"/api/v1/printers/{printer.id}/temperature/chamber?target=45")
  3621. assert response.status_code == 500
  3622. class TestSetFanSpeedAPI:
  3623. """Integration tests for POST /printers/{id}/fan-speed (#1661).
  3624. The fan-id mapping (part->1, aux->2, chamber->3, aux2->10) is the
  3625. critical correctness gate — wrong mapping would target the wrong
  3626. physical fan. "aux2" (M106 P10) is the optional left auxiliary part
  3627. cooling fan on P2S/X2D.
  3628. """
  3629. @pytest.mark.asyncio
  3630. @pytest.mark.integration
  3631. async def test_invalid_fan_name_rejected(self, async_client: AsyncClient, printer_factory):
  3632. printer = await printer_factory(name="P", model="X1C")
  3633. response = await async_client.post(f"/api/v1/printers/{printer.id}/fan-speed?fan=foo&speed=50")
  3634. assert response.status_code == 400
  3635. @pytest.mark.asyncio
  3636. @pytest.mark.integration
  3637. async def test_not_connected(self, async_client: AsyncClient, printer_factory):
  3638. printer = await printer_factory(name="P", model="X1C")
  3639. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3640. mock_pm.get_client.return_value = None
  3641. response = await async_client.post(f"/api/v1/printers/{printer.id}/fan-speed?fan=part&speed=50")
  3642. assert response.status_code == 400
  3643. @pytest.mark.asyncio
  3644. @pytest.mark.integration
  3645. @pytest.mark.parametrize(
  3646. "fan_name,expected_fan_id",
  3647. [("part", 1), ("aux", 2), ("chamber", 3), ("aux2", 10)],
  3648. )
  3649. async def test_fan_id_mapping(self, async_client: AsyncClient, printer_factory, fan_name, expected_fan_id):
  3650. """Verify each fan name maps to the correct hardware fan-id."""
  3651. printer = await printer_factory(name="P", model="X1C")
  3652. mock_client = MagicMock()
  3653. mock_client.set_fan_speed.return_value = True
  3654. # aux2 is presence-gated on the printer reporting airduct part 10, so
  3655. # give the mock a reported speed. Set explicitly rather than leaning on
  3656. # MagicMock's auto-attribute, which would satisfy the gate by accident.
  3657. mock_client.state.left_aux_fan_speed = 0
  3658. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3659. mock_pm.get_client.return_value = mock_client
  3660. response = await async_client.post(f"/api/v1/printers/{printer.id}/fan-speed?fan={fan_name}&speed=100")
  3661. assert response.status_code == 200
  3662. called_fan_id, called_pwm = mock_client.set_fan_speed.call_args.args
  3663. assert called_fan_id == expected_fan_id
  3664. @pytest.mark.asyncio
  3665. @pytest.mark.integration
  3666. async def test_aux2_rejected_when_printer_has_no_left_aux_fan(self, async_client: AsyncClient, printer_factory):
  3667. """A printer that never reports airduct part 10 must not be sent M106 P10.
  3668. Without the gate the endpoint accepted aux2 for every model, so a POST
  3669. against an A1 would fire a command for hardware that does not exist.
  3670. """
  3671. printer = await printer_factory(name="P", model="A1")
  3672. mock_client = MagicMock()
  3673. mock_client.set_fan_speed.return_value = True
  3674. mock_client.state.left_aux_fan_speed = None
  3675. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3676. mock_pm.get_client.return_value = mock_client
  3677. response = await async_client.post(f"/api/v1/printers/{printer.id}/fan-speed?fan=aux2&speed=50")
  3678. assert response.status_code == 400
  3679. assert "left auxiliary fan" in response.json()["detail"]
  3680. mock_client.set_fan_speed.assert_not_called()
  3681. @pytest.mark.asyncio
  3682. @pytest.mark.integration
  3683. async def test_other_fans_unaffected_by_the_aux2_gate(self, async_client: AsyncClient, printer_factory):
  3684. """The gate is aux2-only — a base P2S can still drive its built-in fans."""
  3685. printer = await printer_factory(name="P", model="P2S")
  3686. mock_client = MagicMock()
  3687. mock_client.set_fan_speed.return_value = True
  3688. mock_client.state.left_aux_fan_speed = None
  3689. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3690. mock_pm.get_client.return_value = mock_client
  3691. for fan_name in ("part", "aux", "chamber"):
  3692. response = await async_client.post(f"/api/v1/printers/{printer.id}/fan-speed?fan={fan_name}&speed=50")
  3693. assert response.status_code == 200, fan_name
  3694. @pytest.mark.asyncio
  3695. @pytest.mark.integration
  3696. @pytest.mark.parametrize(
  3697. "speed_pct,expected_pwm",
  3698. [(0, 0), (50, 128), (100, 255)],
  3699. )
  3700. async def test_pwm_conversion(self, async_client: AsyncClient, printer_factory, speed_pct, expected_pwm):
  3701. """0-100% must convert to 0-255 PWM (round-to-nearest)."""
  3702. printer = await printer_factory(name="P", model="X1C")
  3703. mock_client = MagicMock()
  3704. mock_client.set_fan_speed.return_value = True
  3705. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3706. mock_pm.get_client.return_value = mock_client
  3707. response = await async_client.post(f"/api/v1/printers/{printer.id}/fan-speed?fan=part&speed={speed_pct}")
  3708. assert response.status_code == 200
  3709. _called_fan_id, called_pwm = mock_client.set_fan_speed.call_args.args
  3710. assert called_pwm == expected_pwm
  3711. @pytest.mark.asyncio
  3712. @pytest.mark.integration
  3713. @pytest.mark.parametrize(
  3714. "model,expected_label",
  3715. [
  3716. ("P2S", "Exhaust fan"),
  3717. ("X2D", "Exhaust fan"),
  3718. ("X1C", "Chamber fan"),
  3719. ("P1S", "Chamber fan"),
  3720. ("H2D", "Chamber fan"),
  3721. ],
  3722. )
  3723. async def test_chamber_fan_message_matches_model_label(
  3724. self, async_client: AsyncClient, printer_factory, model, expected_label
  3725. ):
  3726. """The success toast must use the same name as the printer card badge.
  3727. On P2S/X2D the big_fan2 fan is labelled "Exhaust"; everywhere else it
  3728. stays "Chamber". A mismatch means the user clicks "Exhaust" and gets
  3729. told "Chamber fan set to N%".
  3730. """
  3731. printer = await printer_factory(name="P", model=model)
  3732. mock_client = MagicMock()
  3733. mock_client.set_fan_speed.return_value = True
  3734. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3735. mock_pm.get_client.return_value = mock_client
  3736. response = await async_client.post(f"/api/v1/printers/{printer.id}/fan-speed?fan=chamber&speed=50")
  3737. assert response.status_code == 200
  3738. assert response.json()["message"] == f"{expected_label} set to 50%"
  3739. @pytest.mark.asyncio
  3740. @pytest.mark.integration
  3741. async def test_speed_out_of_range_rejected(self, async_client: AsyncClient, printer_factory):
  3742. printer = await printer_factory(name="P", model="X1C")
  3743. response = await async_client.post(f"/api/v1/printers/{printer.id}/fan-speed?fan=part&speed=150")
  3744. assert response.status_code == 422
  3745. class TestSelectExtruderAPI:
  3746. """Integration tests for POST /printers/{id}/select-extruder (#1661)."""
  3747. @pytest.mark.asyncio
  3748. @pytest.mark.integration
  3749. async def test_not_found(self, async_client: AsyncClient):
  3750. response = await async_client.post("/api/v1/printers/99999/select-extruder?extruder=0")
  3751. assert response.status_code == 404
  3752. @pytest.mark.asyncio
  3753. @pytest.mark.integration
  3754. async def test_not_connected(self, async_client: AsyncClient, printer_factory):
  3755. printer = await printer_factory(name="P", model="H2D")
  3756. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3757. mock_pm.get_client.return_value = None
  3758. response = await async_client.post(f"/api/v1/printers/{printer.id}/select-extruder?extruder=0")
  3759. assert response.status_code == 400
  3760. @pytest.mark.asyncio
  3761. @pytest.mark.integration
  3762. @pytest.mark.parametrize("extruder", [0, 1])
  3763. async def test_select_each_extruder(self, async_client: AsyncClient, printer_factory, extruder):
  3764. printer = await printer_factory(name="P", model="H2D")
  3765. mock_client = MagicMock()
  3766. mock_client.select_extruder.return_value = True
  3767. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3768. mock_pm.get_client.return_value = mock_client
  3769. response = await async_client.post(f"/api/v1/printers/{printer.id}/select-extruder?extruder={extruder}")
  3770. assert response.status_code == 200
  3771. mock_client.select_extruder.assert_called_once_with(extruder)
  3772. @pytest.mark.asyncio
  3773. @pytest.mark.integration
  3774. async def test_extruder_index_out_of_range_rejected(self, async_client: AsyncClient, printer_factory):
  3775. printer = await printer_factory(name="P", model="H2D")
  3776. response = await async_client.post(f"/api/v1/printers/{printer.id}/select-extruder?extruder=2")
  3777. assert response.status_code == 422
  3778. class TestXYJogAPI:
  3779. """Integration tests for POST /printers/{id}/xy-jog (#1661)."""
  3780. @pytest.mark.asyncio
  3781. @pytest.mark.integration
  3782. async def test_zero_movement_rejected(self, async_client: AsyncClient, printer_factory):
  3783. """x=0 AND y=0 (or omitted) must be rejected — no-op jog is a UI bug."""
  3784. printer = await printer_factory(name="P", model="X1C")
  3785. response = await async_client.post(f"/api/v1/printers/{printer.id}/xy-jog")
  3786. assert response.status_code == 400
  3787. @pytest.mark.asyncio
  3788. @pytest.mark.integration
  3789. @pytest.mark.parametrize("x,y", [(201, 0), (0, 201), (-300, 0), (0, -250)])
  3790. async def test_oversize_movement_rejected(self, async_client: AsyncClient, printer_factory, x, y):
  3791. """Per-axis bound is 200mm; over-bound must be rejected."""
  3792. printer = await printer_factory(name="P", model="X1C")
  3793. response = await async_client.post(f"/api/v1/printers/{printer.id}/xy-jog?x={x}&y={y}")
  3794. assert response.status_code == 400
  3795. @pytest.mark.asyncio
  3796. @pytest.mark.integration
  3797. async def test_not_connected(self, async_client: AsyncClient, printer_factory):
  3798. printer = await printer_factory(name="P", model="X1C")
  3799. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3800. mock_pm.get_client.return_value = None
  3801. response = await async_client.post(f"/api/v1/printers/{printer.id}/xy-jog?x=10&y=0")
  3802. assert response.status_code == 400
  3803. @pytest.mark.asyncio
  3804. @pytest.mark.integration
  3805. async def test_success_x_only_emits_relative_gcode(self, async_client: AsyncClient, printer_factory):
  3806. """X-only jog is a bare relative move (no M211), wraps in G91/G90, X only."""
  3807. printer = await printer_factory(name="P", model="X1C")
  3808. mock_client = MagicMock()
  3809. mock_client.send_gcode.return_value = True
  3810. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3811. mock_pm.get_client.return_value = mock_client
  3812. response = await async_client.post(f"/api/v1/printers/{printer.id}/xy-jog?x=10&y=0")
  3813. assert response.status_code == 200
  3814. sent = mock_client.send_gcode.call_args.args[0]
  3815. # Never touch M211 — bare move, exactly like the touchscreen (#2579).
  3816. assert "M211" not in sent
  3817. assert sent.startswith("G91\n")
  3818. assert sent.endswith("\nG90")
  3819. assert "X10.00" in sent
  3820. assert "Y" not in sent # y=0 must NOT be included
  3821. @pytest.mark.asyncio
  3822. @pytest.mark.integration
  3823. async def test_success_both_axes(self, async_client: AsyncClient, printer_factory):
  3824. printer = await printer_factory(name="P", model="X1C")
  3825. mock_client = MagicMock()
  3826. mock_client.send_gcode.return_value = True
  3827. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3828. mock_pm.get_client.return_value = mock_client
  3829. response = await async_client.post(f"/api/v1/printers/{printer.id}/xy-jog?x=-5&y=7")
  3830. assert response.status_code == 200
  3831. sent = mock_client.send_gcode.call_args.args[0]
  3832. assert "X-5.00" in sent and "Y7.00" in sent
  3833. class TestExtruderJogAPI:
  3834. """Integration tests for POST /printers/{id}/extruder-jog (#1661).
  3835. Note: Bambu firmware enforces the cold-extrude guard
  3836. (min-temp refusal) so the route deliberately does not gate on temp.
  3837. """
  3838. @pytest.mark.asyncio
  3839. @pytest.mark.integration
  3840. async def test_zero_distance_rejected(self, async_client: AsyncClient, printer_factory):
  3841. printer = await printer_factory(name="P", model="X1C")
  3842. response = await async_client.post(f"/api/v1/printers/{printer.id}/extruder-jog?distance=0")
  3843. assert response.status_code == 400
  3844. @pytest.mark.asyncio
  3845. @pytest.mark.integration
  3846. @pytest.mark.parametrize("distance", [101, -200])
  3847. async def test_oversize_distance_rejected(self, async_client: AsyncClient, printer_factory, distance):
  3848. """Per-axis bound is 100mm; over-bound must be rejected."""
  3849. printer = await printer_factory(name="P", model="X1C")
  3850. response = await async_client.post(f"/api/v1/printers/{printer.id}/extruder-jog?distance={distance}")
  3851. assert response.status_code == 400
  3852. @pytest.mark.asyncio
  3853. @pytest.mark.integration
  3854. async def test_not_connected(self, async_client: AsyncClient, printer_factory):
  3855. printer = await printer_factory(name="P", model="X1C")
  3856. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3857. mock_pm.get_client.return_value = None
  3858. response = await async_client.post(f"/api/v1/printers/{printer.id}/extruder-jog?distance=5")
  3859. assert response.status_code == 400
  3860. @pytest.mark.asyncio
  3861. @pytest.mark.integration
  3862. async def test_extrude_uses_relative_e_mode(self, async_client: AsyncClient, printer_factory):
  3863. """Extruder jog must wrap with M83 (relative E) and restore M82 (absolute E)."""
  3864. printer = await printer_factory(name="P", model="X1C")
  3865. mock_client = MagicMock()
  3866. mock_client.send_gcode.return_value = True
  3867. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3868. mock_pm.get_client.return_value = mock_client
  3869. response = await async_client.post(f"/api/v1/printers/{printer.id}/extruder-jog?distance=5")
  3870. assert response.status_code == 200
  3871. sent = mock_client.send_gcode.call_args.args[0]
  3872. assert sent.startswith("M83\n")
  3873. assert sent.endswith("\nM82")
  3874. assert "E5.00" in sent
  3875. @pytest.mark.asyncio
  3876. @pytest.mark.integration
  3877. async def test_retract_uses_negative_distance(self, async_client: AsyncClient, printer_factory):
  3878. printer = await printer_factory(name="P", model="X1C")
  3879. mock_client = MagicMock()
  3880. mock_client.send_gcode.return_value = True
  3881. with patch("backend.app.api.routes.printers.printer_manager") as mock_pm:
  3882. mock_pm.get_client.return_value = mock_client
  3883. response = await async_client.post(f"/api/v1/printers/{printer.id}/extruder-jog?distance=-3.5")
  3884. assert response.status_code == 200
  3885. sent = mock_client.send_gcode.call_args.args[0]
  3886. assert "E-3.50" in sent
  3887. class TestCoverWhenFileServiceIsWedged:
  3888. """The cover endpoint must not report a wedged printer as "no cover".
  3889. #2780: once a printer stops completing the FTPS handshake, every cover
  3890. request walked all 16 candidate paths three times over and ended in a 404
  3891. that read as "this print has no thumbnail" — the opposite of the truth.
  3892. """
  3893. @pytest.mark.asyncio
  3894. @pytest.mark.integration
  3895. async def test_returns_503_naming_the_file_service(self, async_client: AsyncClient, printer_factory, db_session):
  3896. printer = await printer_factory(name="Wedged P2S")
  3897. # Spell out the storage fields rather than leaving them to MagicMock:
  3898. # every attribute of a bare mock is truthy, so the storage gate added
  3899. # in #2780 would read this stub as "the print is on internal storage"
  3900. # and answer 404 before the handshake check ever ran. This test is
  3901. # about a printer whose file service stopped answering, so say that
  3902. # its last print went to the card.
  3903. state = MagicMock(
  3904. subtask_name="job",
  3905. state="RUNNING",
  3906. gcode_file=None,
  3907. current_project_url="ftp://job.gcode.3mf",
  3908. sdcard=True,
  3909. sdcard_reported=True,
  3910. )
  3911. with (
  3912. patch("backend.app.api.routes.printers.printer_manager.get_status", return_value=state),
  3913. patch("backend.app.api.routes.printers.resolve_plate_id", return_value=1),
  3914. patch("backend.app.api.routes.printers.get_cached_3mf", return_value=None),
  3915. patch("backend.app.api.routes.printers.ftps_handshake_blocked", return_value=True),
  3916. patch(
  3917. "backend.app.api.routes.printers.download_file_try_paths_async",
  3918. new=AsyncMock(return_value=False),
  3919. ) as mock_download,
  3920. ):
  3921. response = await async_client.get(f"/api/v1/printers/{printer.id}/cover")
  3922. assert response.status_code == 503, response.text
  3923. assert "TLS" in response.json()["detail"]
  3924. # The whole point: no FTP fan-out against a printer that cannot answer.
  3925. mock_download.assert_not_called()
  3926. class TestCoverWhenThePrintIsOnInternalStorage:
  3927. """The cover lives inside the 3MF, so it is only reachable if the 3MF is.
  3928. #2780: on an H2C or P2S the sliced file routinely stays on internal
  3929. storage, which FTPS does not serve. Walking all sixteen candidate paths to
  3930. arrive at a bare 404 spends connections the printer is already short of
  3931. and tells the user "this print has no cover", which is not what happened.
  3932. """
  3933. @pytest.fixture(autouse=True)
  3934. def _clear_404_cache(self):
  3935. """The route remembers 404s per printer+print so repeat requests skip
  3936. the fan-out. It is module-level, printer ids restart at 1 for each
  3937. test, and both tests here use the same subtask name -- so without this
  3938. the second test reads the first one's cached miss and never reaches
  3939. the code it is checking.
  3940. """
  3941. from backend.app.api.routes.printers import _cover_404_cache
  3942. _cover_404_cache.clear()
  3943. yield
  3944. _cover_404_cache.clear()
  3945. @pytest.mark.asyncio
  3946. @pytest.mark.integration
  3947. async def test_probes_the_named_file_instead_of_fanning_out(
  3948. self, async_client: AsyncClient, printer_factory, db_session
  3949. ):
  3950. """#2856 narrowed this from a skip to a bounded look. The dispatch
  3951. names the file, and an H2D with a card in serves that exact name from
  3952. /cache while reporting `brtc://emmc` -- so ask, but ask once: five
  3953. paths for one name, not sixteen, and no retries on top.
  3954. """
  3955. printer = await printer_factory(name="H2D")
  3956. state = MagicMock(
  3957. subtask_name="job",
  3958. state="RUNNING",
  3959. gcode_file=None,
  3960. current_project_url="brtc://emmc/job.gcode.3mf",
  3961. sdcard=True,
  3962. sdcard_reported=True,
  3963. )
  3964. with (
  3965. patch("backend.app.api.routes.printers.printer_manager.get_status", return_value=state),
  3966. patch("backend.app.api.routes.printers.resolve_plate_id", return_value=1),
  3967. patch("backend.app.api.routes.printers.get_cached_3mf", return_value=None),
  3968. patch("backend.app.api.routes.printers.ftps_handshake_blocked", return_value=False),
  3969. patch(
  3970. "backend.app.api.routes.printers.download_file_try_paths_async",
  3971. new=AsyncMock(return_value=False),
  3972. ) as mock_download,
  3973. ):
  3974. response = await async_client.get(f"/api/v1/printers/{printer.id}/cover")
  3975. assert response.status_code == 404, response.text
  3976. # A probe that found nothing leaves the printer's own account standing,
  3977. # so the reason still reaches the caller (#2780).
  3978. assert "internal_storage" in response.json()["detail"]
  3979. assert mock_download.await_count == 1, "the probe is one look, not the retry loop"
  3980. assert mock_download.await_args.args[2] == [
  3981. "/job.gcode.3mf",
  3982. "/cache/job.gcode.3mf",
  3983. "/model/job.gcode.3mf",
  3984. "/data/job.gcode.3mf",
  3985. "/data/Metadata/job.gcode.3mf",
  3986. ]
  3987. @pytest.mark.asyncio
  3988. @pytest.mark.integration
  3989. async def test_skips_the_fan_out_and_says_why_with_nothing_to_probe_for(
  3990. self, async_client: AsyncClient, printer_factory, db_session
  3991. ):
  3992. """No dispatch to name a file and an empty slot: nothing to look for
  3993. and nothing to look on, so the route still short-circuits with the
  3994. reason the frontend explains (#2780)."""
  3995. printer = await printer_factory(name="H2C")
  3996. state = MagicMock(
  3997. subtask_name="job",
  3998. state="RUNNING",
  3999. gcode_file=None,
  4000. current_project_url=None,
  4001. sdcard=False,
  4002. sdcard_reported=True,
  4003. )
  4004. with (
  4005. patch("backend.app.api.routes.printers.printer_manager.get_status", return_value=state),
  4006. patch("backend.app.api.routes.printers.resolve_plate_id", return_value=1),
  4007. patch("backend.app.api.routes.printers.get_cached_3mf", return_value=None),
  4008. patch("backend.app.api.routes.printers.ftps_handshake_blocked", return_value=False),
  4009. patch(
  4010. "backend.app.api.routes.printers.download_file_try_paths_async",
  4011. new=AsyncMock(return_value=False),
  4012. ) as mock_download,
  4013. ):
  4014. response = await async_client.get(f"/api/v1/printers/{printer.id}/cover")
  4015. assert response.status_code == 404, response.text
  4016. assert "no_external_storage" in response.json()["detail"]
  4017. mock_download.assert_not_called()
  4018. @pytest.mark.asyncio
  4019. @pytest.mark.integration
  4020. async def test_a_print_on_external_storage_still_fans_out(
  4021. self, async_client: AsyncClient, printer_factory, db_session
  4022. ):
  4023. """The regression guard. Every install whose covers work today reaches
  4024. the download exactly as before."""
  4025. printer = await printer_factory(name="X1C")
  4026. state = MagicMock(
  4027. subtask_name="job",
  4028. state="RUNNING",
  4029. gcode_file=None,
  4030. current_project_url="ftp://job.gcode.3mf",
  4031. sdcard=True,
  4032. sdcard_reported=True,
  4033. )
  4034. with (
  4035. patch("backend.app.api.routes.printers.printer_manager.get_status", return_value=state),
  4036. patch("backend.app.api.routes.printers.resolve_plate_id", return_value=1),
  4037. patch("backend.app.api.routes.printers.get_cached_3mf", return_value=None),
  4038. patch("backend.app.api.routes.printers.ftps_handshake_blocked", return_value=False),
  4039. patch(
  4040. "backend.app.api.routes.printers.download_file_try_paths_async",
  4041. new=AsyncMock(return_value=False),
  4042. ) as mock_download,
  4043. ):
  4044. await async_client.get(f"/api/v1/printers/{printer.id}/cover")
  4045. mock_download.assert_called()
  4046. class TestClearPlateOnAPoweredDownPrinter:
  4047. """Releasing the plate-clear gate must not require a reachable printer.
  4048. #2864: with Auto Power Off the end-of-print state is a dirty plate on a
  4049. machine Bambuddy has just switched off. The endpoint answered 400 for
  4050. anything not connected, so the operator who physically cleared that plate
  4051. had no way to say so — not from the API, not from the UI — and everything
  4052. gated on the flag stayed stuck until the printer was powered back on by
  4053. hand. Nothing in the clear path talks to the printer: the flag is
  4054. Bambuddy-side and persisted.
  4055. """
  4056. @pytest.mark.asyncio
  4057. @pytest.mark.integration
  4058. async def test_clear_plate_succeeds_while_disconnected(
  4059. self, async_client: AsyncClient, printer_factory, db_session
  4060. ):
  4061. printer = await printer_factory(name="Powered-off X1C")
  4062. # What the smart-plug power-off leaves behind: the client is still
  4063. # registered, but its state is blanked to unknown/disconnected.
  4064. state = MagicMock(state="unknown", connected=False)
  4065. with (
  4066. patch("backend.app.api.routes.printers.printer_manager.is_connected", return_value=False),
  4067. patch("backend.app.api.routes.printers.printer_manager.get_status", return_value=state),
  4068. patch(
  4069. "backend.app.api.routes.printers.printer_manager.is_awaiting_plate_clear",
  4070. return_value=True,
  4071. ),
  4072. patch("backend.app.api.routes.printers.printer_manager.set_awaiting_plate_clear") as mock_set,
  4073. ):
  4074. response = await async_client.post(f"/api/v1/printers/{printer.id}/clear-plate")
  4075. assert response.status_code == 200, response.text
  4076. mock_set.assert_called_once_with(printer.id, False)
  4077. @pytest.mark.asyncio
  4078. @pytest.mark.integration
  4079. async def test_clear_plate_succeeds_with_no_client_state_at_all(
  4080. self, async_client: AsyncClient, printer_factory, db_session
  4081. ):
  4082. """A printer disconnected manually, or never connected since the last
  4083. restart, has no client state — the persisted gate is still releasable."""
  4084. printer = await printer_factory(name="Never connected")
  4085. with (
  4086. patch("backend.app.api.routes.printers.printer_manager.is_connected", return_value=False),
  4087. patch("backend.app.api.routes.printers.printer_manager.get_status", return_value=None),
  4088. patch(
  4089. "backend.app.api.routes.printers.printer_manager.is_awaiting_plate_clear",
  4090. return_value=True,
  4091. ),
  4092. patch("backend.app.api.routes.printers.printer_manager.set_awaiting_plate_clear") as mock_set,
  4093. ):
  4094. response = await async_client.post(f"/api/v1/printers/{printer.id}/clear-plate")
  4095. assert response.status_code == 200, response.text
  4096. mock_set.assert_called_once_with(printer.id, False)
  4097. @pytest.mark.asyncio
  4098. @pytest.mark.integration
  4099. async def test_clear_plate_still_rejects_when_there_is_nothing_to_clear(
  4100. self, async_client: AsyncClient, printer_factory, db_session
  4101. ):
  4102. """Dropping the connection guard must not turn the endpoint into a
  4103. no-op accept: an offline printer with a clean plate is still a 400."""
  4104. printer = await printer_factory(name="Powered-off, clean plate")
  4105. with (
  4106. patch("backend.app.api.routes.printers.printer_manager.is_connected", return_value=False),
  4107. patch("backend.app.api.routes.printers.printer_manager.get_status", return_value=None),
  4108. patch(
  4109. "backend.app.api.routes.printers.printer_manager.is_awaiting_plate_clear",
  4110. return_value=False,
  4111. ),
  4112. patch("backend.app.api.routes.printers.printer_manager.set_awaiting_plate_clear") as mock_set,
  4113. ):
  4114. response = await async_client.post(f"/api/v1/printers/{printer.id}/clear-plate")
  4115. assert response.status_code == 400, response.text
  4116. mock_set.assert_not_called()
  4117. @pytest.mark.asyncio
  4118. @pytest.mark.integration
  4119. async def test_plate_clear_state_still_reaches_mqtt_without_a_client(
  4120. self, async_client: AsyncClient, printer_factory, db_session
  4121. ):
  4122. """Clearing the gate on a printer with no registered client must still
  4123. update the retained MQTT topic (#2525) — otherwise it keeps telling Home
  4124. Assistant the plate is dirty after it was acknowledged."""
  4125. from backend.app.services.printer_manager import printer_manager
  4126. printer = await printer_factory(name="Disconnected P1S")
  4127. info = await printer_manager._printer_info_from_db(printer.id)
  4128. assert info is not None
  4129. assert info.name == "Disconnected P1S"
  4130. assert info.serial_number == printer.serial_number
  4131. @pytest.mark.asyncio
  4132. @pytest.mark.integration
  4133. async def test_status_reports_the_gate_without_client_state(
  4134. self, async_client: AsyncClient, printer_factory, db_session
  4135. ):
  4136. """Without this the schema default reported a clean plate for a printer
  4137. the DB says is still gated, and the UI hid the control that releases it."""
  4138. printer = await printer_factory(name="No client state")
  4139. with (
  4140. patch("backend.app.api.routes.printers.printer_manager.get_status", return_value=None),
  4141. patch(
  4142. "backend.app.api.routes.printers.printer_manager.is_awaiting_plate_clear",
  4143. return_value=True,
  4144. ),
  4145. ):
  4146. response = await async_client.get(f"/api/v1/printers/{printer.id}/status")
  4147. assert response.status_code == 200, response.text
  4148. body = response.json()
  4149. assert body["connected"] is False
  4150. assert body["awaiting_plate_clear"] is True
  4151. class TestPrintableObjectsReload:
  4152. """Rebuilding the object list must ask the disk before the printer.
  4153. The archive of a running print normally holds the very 3MF the printer is
  4154. executing. Pulling it back over FTPS costs a full transfer from a machine
  4155. that is mid-print — 15 MB on the print this was written for — and on a
  4156. printer that kept the file on internal storage it cannot succeed at all.
  4157. """
  4158. @pytest.mark.asyncio
  4159. @pytest.mark.integration
  4160. async def test_the_archive_on_disk_is_used_before_any_ftp(
  4161. self, async_client: AsyncClient, printer_factory, archive_factory, db_session
  4162. ):
  4163. printer = await printer_factory(name="H2C-1")
  4164. await archive_factory(printer.id, status="printing", subtask_id="330151809")
  4165. client = MagicMock()
  4166. client.state = MagicMock(
  4167. printable_objects={},
  4168. skipped_objects=[],
  4169. subtask_id="330151809",
  4170. subtask_name="HULA",
  4171. state="RUNNING",
  4172. gcode_file="/data/Metadata/plate_1.gcode",
  4173. printable_objects_bbox_all=None,
  4174. )
  4175. ftp = AsyncMock(return_value=None)
  4176. with (
  4177. patch("backend.app.api.routes.printers.printer_manager.get_client", return_value=client),
  4178. patch(
  4179. "backend.app.services.archive.extract_printable_objects_from_archive",
  4180. return_value=({101: {"name": "left"}, 102: {"name": "right"}}, None),
  4181. ) as from_disk,
  4182. patch("backend.app.services.bambu_ftp.download_file_try_paths_async", new=ftp),
  4183. ):
  4184. response = await async_client.get(f"/api/v1/printers/{printer.id}/print/objects")
  4185. assert response.status_code == 200, response.text
  4186. assert response.json()["total"] == 2
  4187. from_disk.assert_called_once()
  4188. ftp.assert_not_awaited()
  4189. @pytest.mark.asyncio
  4190. @pytest.mark.integration
  4191. async def test_a_reload_that_the_disk_cannot_answer_still_asks_the_printer(
  4192. self, async_client: AsyncClient, printer_factory, archive_factory, db_session
  4193. ):
  4194. """The fan-out is the fallback, not dead code: a print whose archive has
  4195. no 3MF (or none at all) still has the printer to ask."""
  4196. printer = await printer_factory(name="H2C-1")
  4197. await archive_factory(printer.id, status="printing", subtask_id="330151809")
  4198. client = MagicMock()
  4199. client.state = MagicMock(
  4200. printable_objects={},
  4201. skipped_objects=[],
  4202. subtask_id="330151809",
  4203. subtask_name="HULA",
  4204. state="RUNNING",
  4205. gcode_file="/data/Metadata/plate_1.gcode",
  4206. printable_objects_bbox_all=None,
  4207. )
  4208. ftp = AsyncMock(return_value=None)
  4209. with (
  4210. patch("backend.app.api.routes.printers.printer_manager.get_client", return_value=client),
  4211. patch(
  4212. "backend.app.services.archive.extract_printable_objects_from_archive",
  4213. return_value=({}, None),
  4214. ),
  4215. patch("backend.app.services.bambu_ftp.download_file_try_paths_async", new=ftp),
  4216. ):
  4217. response = await async_client.get(f"/api/v1/printers/{printer.id}/print/objects")
  4218. assert response.status_code == 200, response.text
  4219. ftp.assert_awaited()
  4220. class TestCoverUsesTheRunningPrintsArchive:
  4221. """The cover must not re-fetch a 3MF Bambuddy already has on disk.
  4222. The in-memory download cache dies with the process, so after a restart
  4223. mid-print every cover, top view and skip-objects plate mask went back to the
  4224. printer for the whole file — measured on the maintainer's H2C as three
  4225. concurrent fan-outs, thirteen seconds and a 0-byte read, on a machine that
  4226. was busy printing. The archive of the running print holds that exact file.
  4227. """
  4228. @pytest.mark.asyncio
  4229. @pytest.mark.integration
  4230. async def test_the_archived_3mf_is_preferred_over_ftp(
  4231. self, async_client: AsyncClient, printer_factory, archive_factory, db_session, tmp_path
  4232. ):
  4233. import zipfile
  4234. from backend.app.core.config import settings as app_settings
  4235. printer = await printer_factory(name="H2C-1")
  4236. # A 3MF that is a real zip but carries no cover, so the endpoint reaches
  4237. # its "no cover in this file" answer without any FTP work.
  4238. threemf = tmp_path / "job.3mf"
  4239. with zipfile.ZipFile(threemf, "w") as zf:
  4240. zf.writestr("Metadata/slice_info.config", "<config/>")
  4241. await archive_factory(
  4242. printer.id,
  4243. status="printing",
  4244. subtask_id="330151809",
  4245. file_path=str(threemf.relative_to(tmp_path)),
  4246. )
  4247. state = MagicMock(
  4248. subtask_name="job",
  4249. subtask_id="330151809",
  4250. state="RUNNING",
  4251. gcode_file="/data/Metadata/plate_1.gcode",
  4252. current_project_url="ftp://job.3mf",
  4253. sdcard=True,
  4254. sdcard_reported=True,
  4255. )
  4256. ftp = AsyncMock(return_value=None)
  4257. with (
  4258. patch.object(app_settings, "base_dir", tmp_path),
  4259. patch("backend.app.api.routes.printers.printer_manager.get_status", return_value=state),
  4260. patch("backend.app.api.routes.printers.resolve_plate_id", return_value=1),
  4261. patch("backend.app.api.routes.printers.get_cached_3mf", return_value=None),
  4262. patch("backend.app.api.routes.printers.download_file_try_paths_async", new=ftp),
  4263. ):
  4264. response = await async_client.get(f"/api/v1/printers/{printer.id}/cover")
  4265. # No cover inside this 3MF, so a 404 — but reached from the file on disk.
  4266. assert response.status_code == 404, response.text
  4267. ftp.assert_not_awaited()
  4268. @pytest.mark.asyncio
  4269. @pytest.mark.integration
  4270. async def test_the_archived_file_is_never_deleted_by_the_cover_flow(
  4271. self, async_client: AsyncClient, printer_factory, archive_factory, db_session, tmp_path
  4272. ):
  4273. """The cover flow unlinks the file it downloaded. Handed the archive's
  4274. own copy, that would delete the print's 3MF."""
  4275. import zipfile
  4276. from backend.app.core.config import settings as app_settings
  4277. printer = await printer_factory(name="H2C-1")
  4278. threemf = tmp_path / "job.3mf"
  4279. with zipfile.ZipFile(threemf, "w") as zf:
  4280. zf.writestr("Metadata/slice_info.config", "<config/>")
  4281. await archive_factory(
  4282. printer.id,
  4283. status="printing",
  4284. subtask_id="330151809",
  4285. file_path=str(threemf.relative_to(tmp_path)),
  4286. )
  4287. state = MagicMock(
  4288. subtask_name="job",
  4289. subtask_id="330151809",
  4290. state="RUNNING",
  4291. gcode_file="/data/Metadata/plate_1.gcode",
  4292. current_project_url="ftp://job.3mf",
  4293. sdcard=True,
  4294. sdcard_reported=True,
  4295. )
  4296. with (
  4297. patch.object(app_settings, "base_dir", tmp_path),
  4298. patch("backend.app.api.routes.printers.printer_manager.get_status", return_value=state),
  4299. patch("backend.app.api.routes.printers.resolve_plate_id", return_value=1),
  4300. patch("backend.app.api.routes.printers.get_cached_3mf", return_value=None),
  4301. patch(
  4302. "backend.app.api.routes.printers.download_file_try_paths_async",
  4303. new=AsyncMock(return_value=None),
  4304. ),
  4305. ):
  4306. await async_client.get(f"/api/v1/printers/{printer.id}/cover")
  4307. assert threemf.is_file(), "the cover flow deleted the running print's archived 3MF"