test_printers_api.py 219 KB

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