test_printers_api.py 221 KB

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