test_printers_api.py 224 KB

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