test_printers_api.py 220 KB

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