test_printers_api.py 221 KB

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