test_porcelain.py 256 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065
  1. # test_porcelain.py -- porcelain tests
  2. # Copyright (C) 2013 Jelmer Vernooij <jelmer@jelmer.uk>
  3. #
  4. # SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
  5. # Dulwich is dual-licensed under the Apache License, Version 2.0 and the GNU
  6. # General Public License as public by the Free Software Foundation; version 2.0
  7. # or (at your option) any later version. You can redistribute it and/or
  8. # modify it under the terms of either of these two licenses.
  9. #
  10. # Unless required by applicable law or agreed to in writing, software
  11. # distributed under the License is distributed on an "AS IS" BASIS,
  12. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. # See the License for the specific language governing permissions and
  14. # limitations under the License.
  15. #
  16. # You should have received a copy of the licenses; if not, see
  17. # <http://www.gnu.org/licenses/> for a copy of the GNU General Public License
  18. # and <http://www.apache.org/licenses/LICENSE-2.0> for a copy of the Apache
  19. # License, Version 2.0.
  20. #
  21. """Tests for dulwich.porcelain."""
  22. import contextlib
  23. import os
  24. import platform
  25. import re
  26. import shutil
  27. import stat
  28. import subprocess
  29. import sys
  30. import tarfile
  31. import tempfile
  32. import threading
  33. import time
  34. from io import BytesIO, StringIO
  35. from unittest import skipIf
  36. from dulwich import porcelain
  37. from dulwich.client import SendPackResult
  38. from dulwich.diff_tree import tree_changes
  39. from dulwich.errors import CommitError
  40. from dulwich.object_store import DEFAULT_TEMPFILE_GRACE_PERIOD
  41. from dulwich.objects import ZERO_SHA, Blob, Tag, Tree
  42. from dulwich.porcelain import (
  43. CheckoutError, # Hypothetical or real error class
  44. CountObjectsResult,
  45. add,
  46. commit,
  47. )
  48. from dulwich.repo import NoIndexPresent, Repo
  49. from dulwich.server import DictBackend
  50. from dulwich.tests.utils import build_commit_graph, make_commit, make_object
  51. from dulwich.web import make_server, make_wsgi_chain
  52. from . import TestCase
  53. try:
  54. import gpg
  55. except ImportError:
  56. gpg = None
  57. def flat_walk_dir(dir_to_walk):
  58. for dirpath, _, filenames in os.walk(dir_to_walk):
  59. rel_dirpath = os.path.relpath(dirpath, dir_to_walk)
  60. if not dirpath == dir_to_walk:
  61. yield rel_dirpath
  62. for filename in filenames:
  63. if dirpath == dir_to_walk:
  64. yield filename
  65. else:
  66. yield os.path.join(rel_dirpath, filename)
  67. class PorcelainTestCase(TestCase):
  68. def setUp(self) -> None:
  69. super().setUp()
  70. self.test_dir = tempfile.mkdtemp()
  71. self.addCleanup(shutil.rmtree, self.test_dir)
  72. self.repo_path = os.path.join(self.test_dir, "repo")
  73. self.repo = Repo.init(self.repo_path, mkdir=True)
  74. self.addCleanup(self.repo.close)
  75. def assertRecentTimestamp(self, ts) -> None:
  76. # On some slow CIs it does actually take more than 5 seconds to go from
  77. # creating the tag to here.
  78. self.assertLess(time.time() - ts, 50)
  79. @skipIf(gpg is None, "gpg is not available")
  80. class PorcelainGpgTestCase(PorcelainTestCase):
  81. DEFAULT_KEY = """
  82. -----BEGIN PGP PRIVATE KEY BLOCK-----
  83. lQVYBGBjIyIBDADAwydvMPQqeEiK54FG1DHwT5sQejAaJOb+PsOhVa4fLcKsrO3F
  84. g5CxO+/9BHCXAr8xQAtp/gOhDN05fyK3MFyGlL9s+Cd8xf34S3R4rN/qbF0oZmaa
  85. FW0MuGnniq54HINs8KshadVn1Dhi/GYSJ588qNFRl/qxFTYAk+zaGsgX/QgFfy0f
  86. djWXJLypZXu9D6DlyJ0cPSzUlfBkI2Ytx6grzIquRjY0FbkjK3l+iGsQ+ebRMdcP
  87. Sqd5iTN9XuzIUVoBFAZBRjibKV3N2wxlnCbfLlzCyDp7rktzSThzjJ2pVDuLrMAx
  88. 6/L9hIhwmFwdtY4FBFGvMR0b0Ugh3kCsRWr8sgj9I7dUoLHid6ObYhJFhnD3GzRc
  89. U+xX1uy3iTCqJDsG334aQIhC5Giuxln4SUZna2MNbq65ksh38N1aM/t3+Dc/TKVB
  90. rb5KWicRPCQ4DIQkHMDCSPyj+dvRLCPzIaPvHD7IrCfHYHOWuvvPGCpwjo0As3iP
  91. IecoMeguPLVaqgcAEQEAAQAL/i5/pQaUd4G7LDydpbixPS6r9UrfPrU/y5zvBP/p
  92. DCynPDutJ1oq539pZvXQ2VwEJJy7x0UVKkjyMndJLNWly9wHC7o8jkHx/NalVP47
  93. LXR+GWbCdOOcYYbdAWcCNB3zOtzPnWhdAEagkc2G9xRQDIB0dLHLCIUpCbLP/CWM
  94. qlHnDsVMrVTWjgzcpsnyGgw8NeLYJtYGB8dsN+XgCCjo7a9LEvUBKNgdmWBbf14/
  95. iBw7PCugazFcH9QYfZwzhsi3nqRRagTXHbxFRG0LD9Ro9qCEutHYGP2PJ59Nj8+M
  96. zaVkJj/OxWxVOGvn2q16mQBCjKpbWfqXZVVl+G5DGOmiSTZqXy+3j6JCKdOMy6Qd
  97. JBHOHhFZXYmWYaaPzoc33T/C3QhMfY5sOtUDLJmV05Wi4dyBeNBEslYgUuTk/jXb
  98. 5ZAie25eDdrsoqkcnSs2ZguMF7AXhe6il2zVhUUMs/6UZgd6I7I4Is0HXT/pnxEp
  99. uiTRFu4v8E+u+5a8O3pffe5boQYA3TsIxceen20qY+kRaTOkURHMZLn/y6KLW8bZ
  100. rNJyXWS9hBAcbbSGhfOwYfzbDCM17yPQO3E2zo8lcGdRklUdIIaCxQwtu36N5dfx
  101. OLCCQc5LmYdl/EAm91iAhrr7dNntZ18MU09gdzUu+ONZwu4CP3cJT83+qYZULso8
  102. 4Fvd/X8IEfGZ7kM+ylrdqBwtlrn8yYXtom+ows2M2UuNR53B+BUOd73kVLTkTCjE
  103. JH63+nE8BqG7tDLCMws+23SAA3xxBgDfDrr0x7zCozQKVQEqBzQr9Uoo/c/ZjAfi
  104. syzNSrDz+g5gqJYtuL9XpPJVWf6V1GXVyJlSbxR9CjTkBxmlPxpvV25IsbVSsh0o
  105. aqkf2eWpbCL6Qb2E0jd1rvf8sGeTTohzYfiSVVsC2t9ngRO/CmetizwQBvRzLGMZ
  106. 4mtAPiy7ZEDc2dFrPp7zlKISYmJZUx/DJVuZWuOrVMpBP+bSgJXoMTlICxZUqUnE
  107. 2VKVStb/L+Tl8XCwIWdrZb9BaDnHqfcGAM2B4HNPxP88Yj1tEDly/vqeb3vVMhj+
  108. S1lunnLdgxp46YyuTMYAzj88eCGurRtzBsdxxlGAsioEnZGebEqAHQbieKq/DO6I
  109. MOMZHMSVBDqyyIx3assGlxSX8BSFW0lhKyT7i0XqnAgCJ9f/5oq0SbFGq+01VQb7
  110. jIx9PbcYJORxsE0JG/CXXPv27bRtQXsudkWGSYvC0NLOgk4z8+kQpQtyFh16lujq
  111. WRwMeriu0qNDjCa1/eHIKDovhAZ3GyO5/9m1tBlUZXN0IFVzZXIgPHRlc3RAdGVz
  112. dC5jb20+iQHOBBMBCAA4AhsDBQsJCAcCBhUKCQgLAgQWAgMBAh4BAheAFiEEjrR8
  113. MQ4fJK44PYMvfN2AClLmXiYFAmDcEZEACgkQfN2AClLmXibZzgv/ZfeTpTuqQE1W
  114. C1jT5KpQExnt0BizTX0U7BvSn8Fr6VXTyol6kYc3u71GLUuJyawCLtIzOXqOXJvz
  115. bjcZqymcMADuftKcfMy513FhbF6MhdVd6QoeBP6+7/xXOFJCi+QVYF7SQ2h7K1Qm
  116. +yXOiAMgSxhCZQGPBNJLlDUOd47nSIMANvlumFtmLY/1FD7RpG7WQWjeX1mnxNTw
  117. hUU+Yv7GuFc/JprXCIYqHbhWfvXyVtae2ZK4xuVi5eqwA2RfggOVM7drb+CgPhG0
  118. +9aEDDLOZqVi65wK7J73Puo3rFTbPQMljxw5s27rWqF+vB6hhVdJOPNomWy3naPi
  119. k5MW0mhsacASz1WYndpZz+XaQTq/wJF5HUyyeUWJ0vlOEdwx021PHcqSTyfNnkjD
  120. KncrE21t2sxWRsgGDETxIwkd2b2HNGAvveUD0ffFK/oJHGSXjAERFGc3wuiDj3mQ
  121. BvKm4wt4QF9ZMrCdhMAA6ax5kfEUqQR4ntmrJk/khp/mV7TILaI4nQVYBGBjIyIB
  122. DADghIo9wXnRxzfdDTvwnP8dHpLAIaPokgdpyLswqUCixJWiW2xcV6weUjEWwH6n
  123. eN/t1uZYVehbrotxVPla+MPvzhxp6/cmG+2lhzEBOp6zRwnL1wIB6HoKJfpREhyM
  124. c8rLR0zMso1L1bJTyydvnu07a7BWo3VWKjilb0rEZZUSD/2hidx5HxMOJSoidLWe
  125. d/PPuv6yht3NtA4UThlcfldm9G6PbqCdm1kMEKAkq0wVJvhPJ6gEFRNJimgygfUw
  126. MDFXEIhQtxjgdV5Uoz3O5452VLoRsDlgpi3E0WDGj7WXDaO5uSU0T5aJgVgHCP/f
  127. xZhHuQFk2YYIl5nCBpOZyWWI0IKmscTuEwzpkhICQDQFvcMZ5ibsl7wA2P7YTrQf
  128. FDMjjzuaK80GYPfxDFlyKUyLqFt8w/QzsZLDLX7+jxIEpbRAaMw/JsWqm5BMxxbS
  129. 3CIQiS5S3oSKDsNINelqWFfwvLhvlQra8gIxyNTlek25OdgG66BiiX+seH8A/ql+
  130. F+MAEQEAAQAL/1jrNSLjMt9pwo6qFKClVQZP2vf7+sH7v7LeHIDXr3EnYUnVYnOq
  131. B1FU5PspTp/+J9W25DB9CZLx7Gj8qeslFdiuLSOoIBB4RCToB3kAoeTH0DHqW/Gs
  132. hFTrmJkuDp9zpo/ek6SIXJx5rHAyR9KVw0fizQprH2f6PcgLbTWeM61dJuqowmg3
  133. 7eCOyIKv7VQvFqEhYokLD+JNmrvg+Htg0DXGvdjRjAwPf/NezEXpj67a6cHTp1/C
  134. hwp7pevG+3fTxaCJFesl5/TxxtnaBLE8m2uo/S6Hxgn9l0edonroe1QlTjEqGLy2
  135. 7qi2z5Rem+v6GWNDRgvAWur13v8FNdyduHlioG/NgRsU9mE2MYeFsfi3cfNpJQp/
  136. wC9PSCIXrb/45mkS8KyjZpCrIPB9RV/m0MREq01TPom7rstZc4A1pD0Ot7AtUYS3
  137. e95zLyEmeLziPJ9fV4fgPmEudDr1uItnmV0LOskKlpg5sc0hhdrwYoobfkKt2dx6
  138. DqfMlcM1ZkUbLQYA4jwfpFJG4HmYvjL2xCJxM0ycjvMbqFN+4UjgYWVlRfOrm1V4
  139. Op86FjbRbV6OOCNhznotAg7mul4xtzrrTkK8o3YLBeJseDgl4AWuzXtNa9hE0XpK
  140. 9gJoEHUuBOOsamVh2HpXESFyE5CclOV7JSh541TlZKfnqfZYCg4JSbp0UijkawCL
  141. 5bJJUiGGMD9rZUxIAKQO1DvUEzptS7Jl6S3y5sbIIhilp4KfYWbSk3PPu9CnZD5b
  142. LhEQp0elxnb/IL8PBgD+DpTeC8unkGKXUpbe9x0ISI6V1D6FmJq/FxNg7fMa3QCh
  143. fGiAyoTm80ZETynj+blRaDO3gY4lTLa3Opubof1EqK2QmwXmpyvXEZNYcQfQ2CCS
  144. GOWUCK8jEQamUPf1PWndZXJUmROI1WukhlL71V/ir6zQeVCv1wcwPwclJPnAe87u
  145. pEklnCYpvsEldwHUX9u0BWzoULIEsi+ddtHmT0KTeF/DHRy0W15jIHbjFqhqckj1
  146. /6fmr7l7kIi/kN4vWe0F/0Q8IXX+cVMgbl3aIuaGcvENLGcoAsAtPGx88SfRgmfu
  147. HK64Y7hx1m+Bo215rxJzZRjqHTBPp0BmCi+JKkaavIBrYRbsx20gveI4dzhLcUhB
  148. kiT4Q7oz0/VbGHS1CEf9KFeS/YOGj57s4yHauSVI0XdP9kBRTWmXvBkzsooB2cKH
  149. hwhUN7iiT1k717CiTNUT6Q/pcPFCyNuMoBBGQTU206JEgIjQvI3f8xMUMGmGVVQz
  150. 9/k716ycnhb2JZ/Q/AyQIeHJiQG2BBgBCAAgAhsMFiEEjrR8MQ4fJK44PYMvfN2A
  151. ClLmXiYFAmDcEa4ACgkQfN2AClLmXiZxxQv/XaMN0hPCygtrQMbCsTNb34JbvJzh
  152. hngPuUAfTbRHrR3YeATyQofNbL0DD3fvfzeFF8qESqvzCSZxS6dYsXPd4MCJTzlp
  153. zYBZ2X0sOrgDqZvqCZKN72RKgdk0KvthdzAxsIm2dfcQOxxowXMxhJEXZmsFpusx
  154. jKJxOcrfVRjXJnh9isY0NpCoqMQ+3k3wDJ3VGEHV7G+A+vFkWfbLJF5huQ96uaH9
  155. Uc+jUsREUH9G82ZBqpoioEN8Ith4VXpYnKdTMonK/+ZcyeraJZhXrvbjnEomKdzU
  156. 0pu4bt1HlLR3dcnpjN7b009MBf2xLgEfQk2nPZ4zzY+tDkxygtPllaB4dldFjBpT
  157. j7Q+t49sWMjmlJUbLlHfuJ7nUUK5+cGjBsWVObAEcyfemHWCTVFnEa2BJslGC08X
  158. rFcjRRcMEr9ct4551QFBHsv3O/Wp3/wqczYgE9itSnGT05w+4vLt4smG+dnEHjRJ
  159. brMb2upTHa+kjktjdO96/BgSnKYqmNmPB/qB
  160. =ivA/
  161. -----END PGP PRIVATE KEY BLOCK-----
  162. """
  163. DEFAULT_KEY_ID = "8EB47C310E1F24AE383D832F7CDD800A52E65E26"
  164. NON_DEFAULT_KEY = """
  165. -----BEGIN PGP PRIVATE KEY BLOCK-----
  166. lQVYBGBjI0ABDADGWBRp+t02emfzUlhrc1psqIhhecFm6Em0Kv33cfDpnfoMF1tK
  167. Yy/4eLYIR7FmpdbFPcDThFNHbXJzBi00L1mp0XQE2l50h/2bDAAgREdZ+NVo5a7/
  168. RSZjauNU1PxW6pnXMehEh1tyIQmV78jAukaakwaicrpIenMiFUN3fAKHnLuFffA6
  169. t0f3LqJvTDhUw/o2vPgw5e6UDQhA1C+KTv1KXVrhJNo88a3hZqCZ76z3drKR411Q
  170. zYgT4DUb8lfnbN+z2wfqT9oM5cegh2k86/mxAA3BYOeQrhmQo/7uhezcgbxtdGZr
  171. YlbuaNDTSBrn10ZoaxLPo2dJe2zWxgD6MpvsGU1w3tcRW508qo/+xoWp2/pDzmok
  172. +uhOh1NAj9zB05VWBz1r7oBgCOIKpkD/LD4VKq59etsZ/UnrYDwKdXWZp7uhshkU
  173. M7N35lUJcR76a852dlMdrgpmY18+BP7+o7M+5ElHTiqQbMuE1nHTg8RgVpdV+tUx
  174. dg6GWY/XHf5asm8AEQEAAQAL/A85epOp+GnymmEQfI3+5D178D//Lwu9n86vECB6
  175. xAHCqQtdjZnXpDp/1YUsL59P8nzgYRk7SoMskQDoQ/cB/XFuDOhEdMSgHaTVlnrj
  176. ktCCq6rqGnUosyolbb64vIfVaSqd/5SnCStpAsnaBoBYrAu4ZmV4xfjDQWwn0q5s
  177. u+r56mD0SkjPgbwk/b3qTVagVmf2OFzUgWwm1e/X+bA1oPag1NV8VS4hZPXswT4f
  178. qhiyqUFOgP6vUBcqehkjkIDIl/54xII7/P5tp3LIZawvIXqHKNTqYPCqaCqCj+SL
  179. vMYDIb6acjescfZoM71eAeHAANeFZzr/rwfBT+dEP6qKmPXNcvgE11X44ZCr04nT
  180. zOV/uDUifEvKT5qgtyJpSFEVr7EXubJPKoNNhoYqq9z1pYU7IedX5BloiVXKOKTY
  181. 0pk7JkLqf3g5fYtXh/wol1owemITJy5V5PgaqZvk491LkI6S+kWC7ANYUg+TDPIW
  182. afxW3E5N1CYV6XDAl0ZihbLcoQYAy0Ky/p/wayWKePyuPBLwx9O89GSONK2pQljZ
  183. yaAgxPQ5/i1vx6LIMg7k/722bXR9W3zOjWOin4eatPM3d2hkG96HFvnBqXSmXOPV
  184. 03Xqy1/B5Tj8E9naLKUHE/OBQEc363DgLLG9db5HfPlpAngeppYPdyWkhzXyzkgS
  185. PylaE5eW3zkdjEbYJ6RBTecTZEgBaMvJNPdWbn//frpP7kGvyiCg5Es+WjLInUZ6
  186. 0sdifcNTCewzLXK80v/y5mVOdJhPBgD5zs9cYdyiQJayqAuOr+He1eMHMVUbm9as
  187. qBmPrst398eBW9ZYF7eBfTSlUf6B+WnvyLKEGsUf/7IK0EWDlzoBuWzWiHjUAY1g
  188. m9eTV2MnvCCCefqCErWwfFo2nWOasAZA9sKD+ICIBY4tbtvSl4yfLBzTMwSvs9ZS
  189. K1ocPSYUnhm2miSWZ8RLZPH7roHQasNHpyq/AX7DahFf2S/bJ+46ZGZ8Pigr7hA+
  190. MjmpQ4qVdb5SaViPmZhAKO+PjuCHm+EF/2H0Y3Sl4eXgxZWoQVOUeXdWg9eMfYrj
  191. XDtUMIFppV/QxbeztZKvJdfk64vt/crvLsOp0hOky9cKwY89r4QaHfexU3qR+qDq
  192. UlMvR1rHk7dS5HZAtw0xKsFJNkuDxvBkMqv8Los8zp3nUl+U99dfZOArzNkW38wx
  193. FPa0ixkC9za2BkDrWEA8vTnxw0A2upIFegDUhwOByrSyfPPnG3tKGeqt3Izb/kDk
  194. Q9vmo+HgxBOguMIvlzbBfQZwtbd/gXzlvPqCtCJBbm90aGVyIFRlc3QgVXNlciA8
  195. dGVzdDJAdGVzdC5jb20+iQHOBBMBCAA4AhsDBQsJCAcCBhUKCQgLAgQWAgMBAh4B
  196. AheAFiEEapM5P1DF5qzT1vtFuTYhLttOFMAFAmDcEeEACgkQuTYhLttOFMDe0Qv/
  197. Qx/bzXztJ3BCc+CYAVDx7Kr37S68etwwLgcWzhG+CDeMB5F/QE+upKgxy2iaqQFR
  198. mxfOMgf/TIQkUfkbaASzK1LpnesYO85pk7XYjoN1bYEHiXTkeW+bgB6aJIxrRmO2
  199. SrWasdBC/DsI3Mrya8YMt/TiHC6VpRJVxCe5vv7/kZC4CXrgTBnZocXx/YXimbke
  200. poPMVdbvhYh6N0aGeS38jRKgyN10KXmhDTAQDwseVFavBWAjVfx3DEwjtK2Z2GbA
  201. aL8JvAwRtqiPFkDMIKPL4UwxtXFws8SpMt6juroUkNyf6+BxNWYqmwXHPy8zCJAb
  202. xkxIJMlEc+s7qQsP3fILOo8Xn+dVzJ5sa5AoARoXm1GMjsdqaKAzq99Dic/dHnaQ
  203. Civev1PQsdwlYW2C2wNXNeIrxMndbDMFfNuZ6BnGHWJ/wjcp/pFs4YkyyZN8JH7L
  204. hP2FO4Jgham3AuP13kC3Ivea7V6hR8QNcDZRwFPOMIX4tXwQv1T72+7DZGaA25O7
  205. nQVXBGBjI0ABDADJMBYIcG0Yil9YxFs7aYzNbd7alUAr89VbY8eIGPHP3INFPM1w
  206. lBQCu+4j6xdEbhMpppLBZ9A5TEylP4C6qLtPa+oLtPeuSw8gHDE10XE4lbgPs376
  207. rL60XdImSOHhiduACUefYjqpcmFH9Bim1CC+koArYrSQJQx1Jri+OpnTaL/8UID0
  208. KzD/kEgMVGlHIVj9oJmb4+j9pW8I/g0wDSnIaEKFMxqu6SIVJ1GWj+MUMvZigjLC
  209. sNCZd7PnbOC5VeU3SsXj6he74Jx0AmGMPWIHi9M0DjHO5d1cCbXTnud8xxM1bOh4
  210. 7aCTnMK5cVyIr+adihgJpVVhrndSM8aklBPRgtozrGNCgF2CkYU2P1blxfloNr/8
  211. UZpM83o+s1aObBszzRNLxnpNORqoLqjfPtLEPQnagxE+4EapCq0NZ/x6yO5VTwwp
  212. NljdFAEk40uGuKyn1QA3uNMHy5DlpLl+tU7t1KEovdZ+OVYsYKZhVzw0MTpKogk9
  213. JI7AN0q62ronPskAEQEAAQAL+O8BUSt1ZCVjPSIXIsrR+ZOSkszZwgJ1CWIoh0IH
  214. YD2vmcMHGIhFYgBdgerpvhptKhaw7GcXDScEnYkyh5s4GE2hxclik1tbj/x1gYCN
  215. 8BNoyeDdPFxQG73qN12D99QYEctpOsz9xPLIDwmL0j1ehAfhwqHIAPm9Ca+i8JYM
  216. x/F+35S/jnKDXRI+NVlwbiEyXKXxxIqNlpy9i8sDBGexO5H5Sg0zSN/B1duLekGD
  217. biDw6gLc6bCgnS+0JOUpU07Z2fccMOY9ncjKGD2uIb/ePPUaek92GCQyq0eorCIV
  218. brcQsRc5sSsNtnRKQTQtxioROeDg7kf2oWySeHTswlXW/219ihrSXgteHJd+rPm7
  219. DYLEeGLRny8bRKv8rQdAtApHaJE4dAATXeY4RYo4NlXHYaztGYtU6kiM/3zCfWAe
  220. 9Nn+Wh9jMTZrjefUCagS5r6ZqAh7veNo/vgIGaCLh0a1Ypa0Yk9KFrn3LYEM3zgk
  221. 3m3bn+7qgy5cUYXoJ3DGJJEhBgDPonpW0WElqLs5ZMem1ha85SC38F0IkAaSuzuz
  222. v3eORiKWuyJGF32Q2XHa1RHQs1JtUKd8rxFer3b8Oq71zLz6JtVc9dmRudvgcJYX
  223. 0PC11F6WGjZFSSp39dajFp0A5DKUs39F3w7J1yuDM56TDIN810ywufGAHARY1pZb
  224. UJAy/dTqjFnCbNjpAakor3hVzqxcmUG+7Y2X9c2AGncT1MqAQC3M8JZcuZvkK8A9
  225. cMk8B914ryYE7VsZMdMhyTwHmykGAPgNLLa3RDETeGeGCKWI+ZPOoU0ib5JtJZ1d
  226. P3tNwfZKuZBZXKW9gqYqyBa/qhMip84SP30pr/TvulcdAFC759HK8sQZyJ6Vw24P
  227. c+5ssRxrQUEw1rvJPWhmQCmCOZHBMQl5T6eaTOpR5u3aUKTMlxPKhK9eC1dCSTnI
  228. /nyL8An3VKnLy+K/LI42YGphBVLLJmBewuTVDIJviWRdntiG8dElyEJMOywUltk3
  229. 2CEmqgsD9tPO8rXZjnMrMn3gfsiaoQYA6/6/e2utkHr7gAoWBgrBBdqVHsvqh5Ro
  230. 2DjLAOpZItO/EdCJfDAmbTYOa04535sBDP2tcH/vipPOPpbr1Y9Y/mNsKCulNxed
  231. yqAmEkKOcerLUP5UHju0AB6VBjHJFdU2mqT+UjPyBk7WeKXgFomyoYMv3KpNOFWR
  232. xi0Xji4kKHbttA6Hy3UcGPr9acyUAlDYeKmxbSUYIPhw32bbGrX9+F5YriTufRsG
  233. 3jftQVo9zqdcQSD/5pUTMn3EYbEcohYB2YWJAbYEGAEIACACGwwWIQRqkzk/UMXm
  234. rNPW+0W5NiEu204UwAUCYNwR6wAKCRC5NiEu204UwOPnC/92PgB1c3h9FBXH1maz
  235. g29fndHIHH65VLgqMiQ7HAMojwRlT5Xnj5tdkCBmszRkv5vMvdJRa3ZY8Ed/Inqr
  236. hxBFNzpjqX4oj/RYIQLKXWWfkTKYVLJFZFPCSo00jesw2gieu3Ke/Yy4gwhtNodA
  237. v+s6QNMvffTW/K3XNrWDB0E7/LXbdidzhm+MBu8ov2tuC3tp9liLICiE1jv/2xT4
  238. CNSO6yphmk1/1zEYHS/mN9qJ2csBmte2cdmGyOcuVEHk3pyINNMDOamaURBJGRwF
  239. XB5V7gTKUFU4jCp3chywKrBHJHxGGDUmPBmZtDtfWAOgL32drK7/KUyzZL/WO7Fj
  240. akOI0hRDFOcqTYWL20H7+hAiX3oHMP7eou3L5C7wJ9+JMcACklN/WMjG9a536DFJ
  241. 4UgZ6HyKPP+wy837Hbe8b25kNMBwFgiaLR0lcgzxj7NyQWjVCMOEN+M55tRCjvL6
  242. ya6JVZCRbMXfdCy8lVPgtNQ6VlHaj8Wvnn2FLbWWO2n2r3s=
  243. =9zU5
  244. -----END PGP PRIVATE KEY BLOCK-----
  245. """
  246. NON_DEFAULT_KEY_ID = "6A93393F50C5E6ACD3D6FB45B936212EDB4E14C0"
  247. def setUp(self) -> None:
  248. super().setUp()
  249. self.gpg_dir = os.path.join(self.test_dir, "gpg")
  250. os.mkdir(self.gpg_dir, mode=0o700)
  251. # Ignore errors when deleting GNUPGHOME, because of race conditions
  252. # (e.g. the gpg-agent socket having been deleted). See
  253. # https://github.com/jelmer/dulwich/issues/1000
  254. self.addCleanup(shutil.rmtree, self.gpg_dir, ignore_errors=True)
  255. self.overrideEnv("GNUPGHOME", self.gpg_dir)
  256. def import_default_key(self) -> None:
  257. subprocess.run(
  258. ["gpg", "--import"],
  259. stdout=subprocess.DEVNULL,
  260. stderr=subprocess.DEVNULL,
  261. input=PorcelainGpgTestCase.DEFAULT_KEY,
  262. text=True,
  263. )
  264. def import_non_default_key(self) -> None:
  265. subprocess.run(
  266. ["gpg", "--import"],
  267. stdout=subprocess.DEVNULL,
  268. stderr=subprocess.DEVNULL,
  269. input=PorcelainGpgTestCase.NON_DEFAULT_KEY,
  270. text=True,
  271. )
  272. class ArchiveTests(PorcelainTestCase):
  273. """Tests for the archive command."""
  274. def test_simple(self) -> None:
  275. c1, c2, c3 = build_commit_graph(
  276. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  277. )
  278. self.repo.refs[b"refs/heads/master"] = c3.id
  279. out = BytesIO()
  280. err = BytesIO()
  281. porcelain.archive(
  282. self.repo.path, b"refs/heads/master", outstream=out, errstream=err
  283. )
  284. self.assertEqual(b"", err.getvalue())
  285. tf = tarfile.TarFile(fileobj=out)
  286. self.addCleanup(tf.close)
  287. self.assertEqual([], tf.getnames())
  288. class UpdateServerInfoTests(PorcelainTestCase):
  289. def test_simple(self) -> None:
  290. c1, c2, c3 = build_commit_graph(
  291. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  292. )
  293. self.repo.refs[b"refs/heads/foo"] = c3.id
  294. porcelain.update_server_info(self.repo.path)
  295. self.assertTrue(
  296. os.path.exists(os.path.join(self.repo.controldir(), "info", "refs"))
  297. )
  298. class CommitTests(PorcelainTestCase):
  299. def test_custom_author(self) -> None:
  300. c1, c2, c3 = build_commit_graph(
  301. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  302. )
  303. self.repo.refs[b"refs/heads/foo"] = c3.id
  304. sha = porcelain.commit(
  305. self.repo.path,
  306. message=b"Some message",
  307. author=b"Joe <joe@example.com>",
  308. committer=b"Bob <bob@example.com>",
  309. )
  310. self.assertIsInstance(sha, bytes)
  311. self.assertEqual(len(sha), 40)
  312. def test_unicode(self) -> None:
  313. c1, c2, c3 = build_commit_graph(
  314. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  315. )
  316. self.repo.refs[b"refs/heads/foo"] = c3.id
  317. sha = porcelain.commit(
  318. self.repo.path,
  319. message="Some message",
  320. author="Joe <joe@example.com>",
  321. committer="Bob <bob@example.com>",
  322. )
  323. self.assertIsInstance(sha, bytes)
  324. self.assertEqual(len(sha), 40)
  325. def test_no_verify(self) -> None:
  326. if os.name != "posix":
  327. self.skipTest("shell hook tests requires POSIX shell")
  328. self.assertTrue(os.path.exists("/bin/sh"))
  329. hooks_dir = os.path.join(self.repo.controldir(), "hooks")
  330. os.makedirs(hooks_dir, exist_ok=True)
  331. self.addCleanup(shutil.rmtree, hooks_dir)
  332. c1, c2, c3 = build_commit_graph(
  333. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  334. )
  335. hook_fail = "#!/bin/sh\nexit 1"
  336. # hooks are executed in pre-commit, commit-msg order
  337. # test commit-msg failure first, then pre-commit failure, then
  338. # no_verify to skip both hooks
  339. commit_msg = os.path.join(hooks_dir, "commit-msg")
  340. with open(commit_msg, "w") as f:
  341. f.write(hook_fail)
  342. os.chmod(commit_msg, stat.S_IREAD | stat.S_IWRITE | stat.S_IEXEC)
  343. with self.assertRaises(CommitError):
  344. porcelain.commit(
  345. self.repo.path,
  346. message="Some message",
  347. author="Joe <joe@example.com>",
  348. committer="Bob <bob@example.com>",
  349. )
  350. pre_commit = os.path.join(hooks_dir, "pre-commit")
  351. with open(pre_commit, "w") as f:
  352. f.write(hook_fail)
  353. os.chmod(pre_commit, stat.S_IREAD | stat.S_IWRITE | stat.S_IEXEC)
  354. with self.assertRaises(CommitError):
  355. porcelain.commit(
  356. self.repo.path,
  357. message="Some message",
  358. author="Joe <joe@example.com>",
  359. committer="Bob <bob@example.com>",
  360. )
  361. sha = porcelain.commit(
  362. self.repo.path,
  363. message="Some message",
  364. author="Joe <joe@example.com>",
  365. committer="Bob <bob@example.com>",
  366. no_verify=True,
  367. )
  368. self.assertIsInstance(sha, bytes)
  369. self.assertEqual(len(sha), 40)
  370. def test_timezone(self) -> None:
  371. c1, c2, c3 = build_commit_graph(
  372. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  373. )
  374. self.repo.refs[b"refs/heads/foo"] = c3.id
  375. sha = porcelain.commit(
  376. self.repo.path,
  377. message="Some message",
  378. author="Joe <joe@example.com>",
  379. author_timezone=18000,
  380. committer="Bob <bob@example.com>",
  381. commit_timezone=18000,
  382. )
  383. self.assertIsInstance(sha, bytes)
  384. self.assertEqual(len(sha), 40)
  385. commit = self.repo.get_object(sha)
  386. self.assertEqual(commit._author_timezone, 18000)
  387. self.assertEqual(commit._commit_timezone, 18000)
  388. self.overrideEnv("GIT_AUTHOR_DATE", "1995-11-20T19:12:08-0501")
  389. self.overrideEnv("GIT_COMMITTER_DATE", "1995-11-20T19:12:08-0501")
  390. sha = porcelain.commit(
  391. self.repo.path,
  392. message="Some message",
  393. author="Joe <joe@example.com>",
  394. committer="Bob <bob@example.com>",
  395. )
  396. self.assertIsInstance(sha, bytes)
  397. self.assertEqual(len(sha), 40)
  398. commit = self.repo.get_object(sha)
  399. self.assertEqual(commit._author_timezone, -18060)
  400. self.assertEqual(commit._commit_timezone, -18060)
  401. self.overrideEnv("GIT_AUTHOR_DATE", None)
  402. self.overrideEnv("GIT_COMMITTER_DATE", None)
  403. local_timezone = time.localtime().tm_gmtoff
  404. sha = porcelain.commit(
  405. self.repo.path,
  406. message="Some message",
  407. author="Joe <joe@example.com>",
  408. committer="Bob <bob@example.com>",
  409. )
  410. self.assertIsInstance(sha, bytes)
  411. self.assertEqual(len(sha), 40)
  412. commit = self.repo.get_object(sha)
  413. self.assertEqual(commit._author_timezone, local_timezone)
  414. self.assertEqual(commit._commit_timezone, local_timezone)
  415. @skipIf(
  416. platform.python_implementation() == "PyPy" or sys.platform == "win32",
  417. "gpgme not easily available or supported on Windows and PyPy",
  418. )
  419. class CommitSignTests(PorcelainGpgTestCase):
  420. def test_default_key(self) -> None:
  421. c1, c2, c3 = build_commit_graph(
  422. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  423. )
  424. self.repo.refs[b"HEAD"] = c3.id
  425. cfg = self.repo.get_config()
  426. cfg.set(("user",), "signingKey", PorcelainGpgTestCase.DEFAULT_KEY_ID)
  427. self.import_default_key()
  428. sha = porcelain.commit(
  429. self.repo.path,
  430. message="Some message",
  431. author="Joe <joe@example.com>",
  432. committer="Bob <bob@example.com>",
  433. signoff=True,
  434. )
  435. self.assertIsInstance(sha, bytes)
  436. self.assertEqual(len(sha), 40)
  437. commit = self.repo.get_object(sha)
  438. # GPG Signatures aren't deterministic, so we can't do a static assertion.
  439. commit.verify()
  440. commit.verify(keyids=[PorcelainGpgTestCase.DEFAULT_KEY_ID])
  441. self.import_non_default_key()
  442. self.assertRaises(
  443. gpg.errors.MissingSignatures,
  444. commit.verify,
  445. keyids=[PorcelainGpgTestCase.NON_DEFAULT_KEY_ID],
  446. )
  447. commit.committer = b"Alice <alice@example.com>"
  448. self.assertRaises(
  449. gpg.errors.BadSignatures,
  450. commit.verify,
  451. )
  452. def test_non_default_key(self) -> None:
  453. c1, c2, c3 = build_commit_graph(
  454. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  455. )
  456. self.repo.refs[b"HEAD"] = c3.id
  457. cfg = self.repo.get_config()
  458. cfg.set(("user",), "signingKey", PorcelainGpgTestCase.DEFAULT_KEY_ID)
  459. self.import_non_default_key()
  460. sha = porcelain.commit(
  461. self.repo.path,
  462. message="Some message",
  463. author="Joe <joe@example.com>",
  464. committer="Bob <bob@example.com>",
  465. signoff=PorcelainGpgTestCase.NON_DEFAULT_KEY_ID,
  466. )
  467. self.assertIsInstance(sha, bytes)
  468. self.assertEqual(len(sha), 40)
  469. commit = self.repo.get_object(sha)
  470. # GPG Signatures aren't deterministic, so we can't do a static assertion.
  471. commit.verify()
  472. def test_sign_uses_config_signingkey(self) -> None:
  473. """Test that sign=True uses user.signingKey from config."""
  474. c1, c2, c3 = build_commit_graph(
  475. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  476. )
  477. self.repo.refs[b"HEAD"] = c3.id
  478. # Set up user.signingKey in config
  479. cfg = self.repo.get_config()
  480. cfg.set(("user",), "signingKey", PorcelainGpgTestCase.DEFAULT_KEY_ID)
  481. cfg.write_to_path()
  482. self.import_default_key()
  483. # Create commit with sign=True (should use signingKey from config)
  484. sha = porcelain.commit(
  485. self.repo.path,
  486. message="Signed with configured key",
  487. author="Joe <joe@example.com>",
  488. committer="Bob <bob@example.com>",
  489. signoff=True, # This should read user.signingKey from config
  490. )
  491. self.assertIsInstance(sha, bytes)
  492. self.assertEqual(len(sha), 40)
  493. commit = self.repo.get_object(sha)
  494. # Verify the commit is signed with the configured key
  495. commit.verify()
  496. commit.verify(keyids=[PorcelainGpgTestCase.DEFAULT_KEY_ID])
  497. def test_commit_gpg_sign_config_enabled(self) -> None:
  498. """Test that commit.gpgSign=true automatically signs commits."""
  499. c1, c2, c3 = build_commit_graph(
  500. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  501. )
  502. self.repo.refs[b"HEAD"] = c3.id
  503. # Set up user.signingKey and commit.gpgSign in config
  504. cfg = self.repo.get_config()
  505. cfg.set(("user",), "signingKey", PorcelainGpgTestCase.DEFAULT_KEY_ID)
  506. cfg.set(("commit",), "gpgSign", True)
  507. cfg.write_to_path()
  508. self.import_default_key()
  509. # Create commit without explicit signoff parameter (should auto-sign due to config)
  510. sha = porcelain.commit(
  511. self.repo.path,
  512. message="Auto-signed commit",
  513. author="Joe <joe@example.com>",
  514. committer="Bob <bob@example.com>",
  515. # No signoff parameter - should use commit.gpgSign config
  516. )
  517. self.assertIsInstance(sha, bytes)
  518. self.assertEqual(len(sha), 40)
  519. commit = self.repo.get_object(sha)
  520. # Verify the commit is signed due to config
  521. commit.verify()
  522. commit.verify(keyids=[PorcelainGpgTestCase.DEFAULT_KEY_ID])
  523. def test_commit_gpg_sign_config_disabled(self) -> None:
  524. """Test that commit.gpgSign=false does not sign commits."""
  525. c1, c2, c3 = build_commit_graph(
  526. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  527. )
  528. self.repo.refs[b"HEAD"] = c3.id
  529. # Set up user.signingKey and commit.gpgSign=false in config
  530. cfg = self.repo.get_config()
  531. cfg.set(("user",), "signingKey", PorcelainGpgTestCase.DEFAULT_KEY_ID)
  532. cfg.set(("commit",), "gpgSign", False)
  533. cfg.write_to_path()
  534. self.import_default_key()
  535. # Create commit without explicit signoff parameter (should not sign)
  536. sha = porcelain.commit(
  537. self.repo.path,
  538. message="Unsigned commit",
  539. author="Joe <joe@example.com>",
  540. committer="Bob <bob@example.com>",
  541. # No signoff parameter - should use commit.gpgSign=false config
  542. )
  543. self.assertIsInstance(sha, bytes)
  544. self.assertEqual(len(sha), 40)
  545. commit = self.repo.get_object(sha)
  546. # Verify the commit is not signed
  547. self.assertIsNone(commit._gpgsig)
  548. def test_commit_gpg_sign_config_no_signing_key(self) -> None:
  549. """Test that commit.gpgSign=true works without user.signingKey (uses default)."""
  550. c1, c2, c3 = build_commit_graph(
  551. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  552. )
  553. self.repo.refs[b"HEAD"] = c3.id
  554. # Set up commit.gpgSign but no user.signingKey
  555. cfg = self.repo.get_config()
  556. cfg.set(("commit",), "gpgSign", True)
  557. cfg.write_to_path()
  558. self.import_default_key()
  559. # Create commit without explicit signoff parameter (should auto-sign with default key)
  560. sha = porcelain.commit(
  561. self.repo.path,
  562. message="Default signed commit",
  563. author="Joe <joe@example.com>",
  564. committer="Bob <bob@example.com>",
  565. # No signoff parameter - should use commit.gpgSign config with default key
  566. )
  567. self.assertIsInstance(sha, bytes)
  568. self.assertEqual(len(sha), 40)
  569. commit = self.repo.get_object(sha)
  570. # Verify the commit is signed with default key
  571. commit.verify()
  572. def test_explicit_signoff_overrides_config(self) -> None:
  573. """Test that explicit signoff parameter overrides commit.gpgSign config."""
  574. c1, c2, c3 = build_commit_graph(
  575. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  576. )
  577. self.repo.refs[b"HEAD"] = c3.id
  578. # Set up commit.gpgSign=false but explicitly pass signoff=True
  579. cfg = self.repo.get_config()
  580. cfg.set(("user",), "signingKey", PorcelainGpgTestCase.DEFAULT_KEY_ID)
  581. cfg.set(("commit",), "gpgSign", False)
  582. cfg.write_to_path()
  583. self.import_default_key()
  584. # Create commit with explicit signoff=True (should override config)
  585. sha = porcelain.commit(
  586. self.repo.path,
  587. message="Explicitly signed commit",
  588. author="Joe <joe@example.com>",
  589. committer="Bob <bob@example.com>",
  590. signoff=True, # This should override commit.gpgSign=false
  591. )
  592. self.assertIsInstance(sha, bytes)
  593. self.assertEqual(len(sha), 40)
  594. commit = self.repo.get_object(sha)
  595. # Verify the commit is signed despite config=false
  596. commit.verify()
  597. commit.verify(keyids=[PorcelainGpgTestCase.DEFAULT_KEY_ID])
  598. def test_explicit_false_disables_signing(self) -> None:
  599. """Test that explicit signoff=False disables signing even with config=true."""
  600. c1, c2, c3 = build_commit_graph(
  601. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  602. )
  603. self.repo.refs[b"HEAD"] = c3.id
  604. # Set up commit.gpgSign=true but explicitly pass signoff=False
  605. cfg = self.repo.get_config()
  606. cfg.set(("user",), "signingKey", PorcelainGpgTestCase.DEFAULT_KEY_ID)
  607. cfg.set(("commit",), "gpgSign", True)
  608. cfg.write_to_path()
  609. self.import_default_key()
  610. # Create commit with explicit signoff=False (should disable signing)
  611. sha = porcelain.commit(
  612. self.repo.path,
  613. message="Explicitly unsigned commit",
  614. author="Joe <joe@example.com>",
  615. committer="Bob <bob@example.com>",
  616. signoff=False, # This should override commit.gpgSign=true
  617. )
  618. self.assertIsInstance(sha, bytes)
  619. self.assertEqual(len(sha), 40)
  620. commit = self.repo.get_object(sha)
  621. # Verify the commit is NOT signed despite config=true
  622. self.assertIsNone(commit._gpgsig)
  623. class TimezoneTests(PorcelainTestCase):
  624. def put_envs(self, value) -> None:
  625. self.overrideEnv("GIT_AUTHOR_DATE", value)
  626. self.overrideEnv("GIT_COMMITTER_DATE", value)
  627. def fallback(self, value) -> None:
  628. self.put_envs(value)
  629. self.assertRaises(porcelain.TimezoneFormatError, porcelain.get_user_timezones)
  630. def test_internal_format(self) -> None:
  631. self.put_envs("0 +0500")
  632. self.assertTupleEqual((18000, 18000), porcelain.get_user_timezones())
  633. def test_rfc_2822(self) -> None:
  634. self.put_envs("Mon, 20 Nov 1995 19:12:08 -0500")
  635. self.assertTupleEqual((-18000, -18000), porcelain.get_user_timezones())
  636. self.put_envs("Mon, 20 Nov 1995 19:12:08")
  637. self.assertTupleEqual((0, 0), porcelain.get_user_timezones())
  638. def test_iso8601(self) -> None:
  639. self.put_envs("1995-11-20T19:12:08-0501")
  640. self.assertTupleEqual((-18060, -18060), porcelain.get_user_timezones())
  641. self.put_envs("1995-11-20T19:12:08+0501")
  642. self.assertTupleEqual((18060, 18060), porcelain.get_user_timezones())
  643. self.put_envs("1995-11-20T19:12:08-05:01")
  644. self.assertTupleEqual((-18060, -18060), porcelain.get_user_timezones())
  645. self.put_envs("1995-11-20 19:12:08-05")
  646. self.assertTupleEqual((-18000, -18000), porcelain.get_user_timezones())
  647. # https://github.com/git/git/blob/96b2d4fa927c5055adc5b1d08f10a5d7352e2989/t/t6300-for-each-ref.sh#L128
  648. self.put_envs("2006-07-03 17:18:44 +0200")
  649. self.assertTupleEqual((7200, 7200), porcelain.get_user_timezones())
  650. def test_missing_or_malformed(self) -> None:
  651. # TODO: add more here
  652. self.fallback("0 + 0500")
  653. self.fallback("a +0500")
  654. self.fallback("1995-11-20T19:12:08")
  655. self.fallback("1995-11-20T19:12:08-05:")
  656. self.fallback("1995.11.20")
  657. self.fallback("11/20/1995")
  658. self.fallback("20.11.1995")
  659. def test_different_envs(self) -> None:
  660. self.overrideEnv("GIT_AUTHOR_DATE", "0 +0500")
  661. self.overrideEnv("GIT_COMMITTER_DATE", "0 +0501")
  662. self.assertTupleEqual((18000, 18060), porcelain.get_user_timezones())
  663. def test_no_envs(self) -> None:
  664. local_timezone = time.localtime().tm_gmtoff
  665. self.put_envs("0 +0500")
  666. self.assertTupleEqual((18000, 18000), porcelain.get_user_timezones())
  667. self.overrideEnv("GIT_COMMITTER_DATE", None)
  668. self.assertTupleEqual((18000, local_timezone), porcelain.get_user_timezones())
  669. self.put_envs("0 +0500")
  670. self.overrideEnv("GIT_AUTHOR_DATE", None)
  671. self.assertTupleEqual((local_timezone, 18000), porcelain.get_user_timezones())
  672. self.put_envs("0 +0500")
  673. self.overrideEnv("GIT_AUTHOR_DATE", None)
  674. self.overrideEnv("GIT_COMMITTER_DATE", None)
  675. self.assertTupleEqual(
  676. (local_timezone, local_timezone), porcelain.get_user_timezones()
  677. )
  678. class CleanTests(PorcelainTestCase):
  679. def put_files(self, tracked, ignored, untracked, empty_dirs) -> None:
  680. """Put the described files in the wd."""
  681. all_files = tracked | ignored | untracked
  682. for file_path in all_files:
  683. abs_path = os.path.join(self.repo.path, file_path)
  684. # File may need to be written in a dir that doesn't exist yet, so
  685. # create the parent dir(s) as necessary
  686. parent_dir = os.path.dirname(abs_path)
  687. try:
  688. os.makedirs(parent_dir)
  689. except FileExistsError:
  690. pass
  691. with open(abs_path, "w") as f:
  692. f.write("")
  693. with open(os.path.join(self.repo.path, ".gitignore"), "w") as f:
  694. f.writelines(ignored)
  695. for dir_path in empty_dirs:
  696. os.mkdir(os.path.join(self.repo.path, "empty_dir"))
  697. files_to_add = [os.path.join(self.repo.path, t) for t in tracked]
  698. porcelain.add(repo=self.repo.path, paths=files_to_add)
  699. porcelain.commit(repo=self.repo.path, message="init commit")
  700. def assert_wd(self, expected_paths) -> None:
  701. """Assert paths of files and dirs in wd are same as expected_paths."""
  702. control_dir_rel = os.path.relpath(self.repo._controldir, self.repo.path)
  703. # normalize paths to simplify comparison across platforms
  704. found_paths = {
  705. os.path.normpath(p)
  706. for p in flat_walk_dir(self.repo.path)
  707. if not p.split(os.sep)[0] == control_dir_rel
  708. }
  709. norm_expected_paths = {os.path.normpath(p) for p in expected_paths}
  710. self.assertEqual(found_paths, norm_expected_paths)
  711. def test_from_root(self) -> None:
  712. self.put_files(
  713. tracked={"tracked_file", "tracked_dir/tracked_file", ".gitignore"},
  714. ignored={"ignored_file"},
  715. untracked={
  716. "untracked_file",
  717. "tracked_dir/untracked_dir/untracked_file",
  718. "untracked_dir/untracked_dir/untracked_file",
  719. },
  720. empty_dirs={"empty_dir"},
  721. )
  722. porcelain.clean(repo=self.repo.path, target_dir=self.repo.path)
  723. self.assert_wd(
  724. {
  725. "tracked_file",
  726. "tracked_dir/tracked_file",
  727. ".gitignore",
  728. "ignored_file",
  729. "tracked_dir",
  730. }
  731. )
  732. def test_from_subdir(self) -> None:
  733. self.put_files(
  734. tracked={"tracked_file", "tracked_dir/tracked_file", ".gitignore"},
  735. ignored={"ignored_file"},
  736. untracked={
  737. "untracked_file",
  738. "tracked_dir/untracked_dir/untracked_file",
  739. "untracked_dir/untracked_dir/untracked_file",
  740. },
  741. empty_dirs={"empty_dir"},
  742. )
  743. porcelain.clean(
  744. repo=self.repo,
  745. target_dir=os.path.join(self.repo.path, "untracked_dir"),
  746. )
  747. self.assert_wd(
  748. {
  749. "tracked_file",
  750. "tracked_dir/tracked_file",
  751. ".gitignore",
  752. "ignored_file",
  753. "untracked_file",
  754. "tracked_dir/untracked_dir/untracked_file",
  755. "empty_dir",
  756. "untracked_dir",
  757. "tracked_dir",
  758. "tracked_dir/untracked_dir",
  759. }
  760. )
  761. class CloneTests(PorcelainTestCase):
  762. def test_simple_local(self) -> None:
  763. f1_1 = make_object(Blob, data=b"f1")
  764. commit_spec = [[1], [2, 1], [3, 1, 2]]
  765. trees = {
  766. 1: [(b"f1", f1_1), (b"f2", f1_1)],
  767. 2: [(b"f1", f1_1), (b"f2", f1_1)],
  768. 3: [(b"f1", f1_1), (b"f2", f1_1)],
  769. }
  770. c1, c2, c3 = build_commit_graph(self.repo.object_store, commit_spec, trees)
  771. self.repo.refs[b"refs/heads/master"] = c3.id
  772. self.repo.refs[b"refs/tags/foo"] = c3.id
  773. target_path = tempfile.mkdtemp()
  774. errstream = BytesIO()
  775. self.addCleanup(shutil.rmtree, target_path)
  776. r = porcelain.clone(
  777. self.repo.path, target_path, checkout=False, errstream=errstream
  778. )
  779. self.addCleanup(r.close)
  780. self.assertEqual(r.path, target_path)
  781. target_repo = Repo(target_path)
  782. self.assertEqual(0, len(target_repo.open_index()))
  783. self.assertEqual(c3.id, target_repo.refs[b"refs/tags/foo"])
  784. self.assertNotIn(b"f1", os.listdir(target_path))
  785. self.assertNotIn(b"f2", os.listdir(target_path))
  786. c = r.get_config()
  787. encoded_path = self.repo.path
  788. if not isinstance(encoded_path, bytes):
  789. encoded_path = encoded_path.encode("utf-8")
  790. self.assertEqual(encoded_path, c.get((b"remote", b"origin"), b"url"))
  791. self.assertEqual(
  792. b"+refs/heads/*:refs/remotes/origin/*",
  793. c.get((b"remote", b"origin"), b"fetch"),
  794. )
  795. def test_simple_local_with_checkout(self) -> None:
  796. f1_1 = make_object(Blob, data=b"f1")
  797. commit_spec = [[1], [2, 1], [3, 1, 2]]
  798. trees = {
  799. 1: [(b"f1", f1_1), (b"f2", f1_1)],
  800. 2: [(b"f1", f1_1), (b"f2", f1_1)],
  801. 3: [(b"f1", f1_1), (b"f2", f1_1)],
  802. }
  803. c1, c2, c3 = build_commit_graph(self.repo.object_store, commit_spec, trees)
  804. self.repo.refs[b"refs/heads/master"] = c3.id
  805. target_path = tempfile.mkdtemp()
  806. errstream = BytesIO()
  807. self.addCleanup(shutil.rmtree, target_path)
  808. with porcelain.clone(
  809. self.repo.path, target_path, checkout=True, errstream=errstream
  810. ) as r:
  811. self.assertEqual(r.path, target_path)
  812. with Repo(target_path) as r:
  813. self.assertEqual(r.head(), c3.id)
  814. self.assertIn("f1", os.listdir(target_path))
  815. self.assertIn("f2", os.listdir(target_path))
  816. def test_bare_local_with_checkout(self) -> None:
  817. f1_1 = make_object(Blob, data=b"f1")
  818. commit_spec = [[1], [2, 1], [3, 1, 2]]
  819. trees = {
  820. 1: [(b"f1", f1_1), (b"f2", f1_1)],
  821. 2: [(b"f1", f1_1), (b"f2", f1_1)],
  822. 3: [(b"f1", f1_1), (b"f2", f1_1)],
  823. }
  824. c1, c2, c3 = build_commit_graph(self.repo.object_store, commit_spec, trees)
  825. self.repo.refs[b"refs/heads/master"] = c3.id
  826. target_path = tempfile.mkdtemp()
  827. errstream = BytesIO()
  828. self.addCleanup(shutil.rmtree, target_path)
  829. with porcelain.clone(
  830. self.repo.path, target_path, bare=True, errstream=errstream
  831. ) as r:
  832. self.assertEqual(r.path, target_path)
  833. with Repo(target_path) as r:
  834. r.head()
  835. self.assertRaises(NoIndexPresent, r.open_index)
  836. self.assertNotIn(b"f1", os.listdir(target_path))
  837. self.assertNotIn(b"f2", os.listdir(target_path))
  838. def test_no_checkout_with_bare(self) -> None:
  839. f1_1 = make_object(Blob, data=b"f1")
  840. commit_spec = [[1]]
  841. trees = {1: [(b"f1", f1_1), (b"f2", f1_1)]}
  842. (c1,) = build_commit_graph(self.repo.object_store, commit_spec, trees)
  843. self.repo.refs[b"refs/heads/master"] = c1.id
  844. self.repo.refs[b"HEAD"] = c1.id
  845. target_path = tempfile.mkdtemp()
  846. errstream = BytesIO()
  847. self.addCleanup(shutil.rmtree, target_path)
  848. self.assertRaises(
  849. porcelain.Error,
  850. porcelain.clone,
  851. self.repo.path,
  852. target_path,
  853. checkout=True,
  854. bare=True,
  855. errstream=errstream,
  856. )
  857. def test_no_head_no_checkout(self) -> None:
  858. f1_1 = make_object(Blob, data=b"f1")
  859. commit_spec = [[1]]
  860. trees = {1: [(b"f1", f1_1), (b"f2", f1_1)]}
  861. (c1,) = build_commit_graph(self.repo.object_store, commit_spec, trees)
  862. self.repo.refs[b"refs/heads/master"] = c1.id
  863. target_path = tempfile.mkdtemp()
  864. self.addCleanup(shutil.rmtree, target_path)
  865. errstream = BytesIO()
  866. r = porcelain.clone(
  867. self.repo.path, target_path, checkout=True, errstream=errstream
  868. )
  869. r.close()
  870. def test_no_head_no_checkout_outstream_errstream_autofallback(self) -> None:
  871. f1_1 = make_object(Blob, data=b"f1")
  872. commit_spec = [[1]]
  873. trees = {1: [(b"f1", f1_1), (b"f2", f1_1)]}
  874. (c1,) = build_commit_graph(self.repo.object_store, commit_spec, trees)
  875. self.repo.refs[b"refs/heads/master"] = c1.id
  876. target_path = tempfile.mkdtemp()
  877. self.addCleanup(shutil.rmtree, target_path)
  878. errstream = porcelain.NoneStream()
  879. r = porcelain.clone(
  880. self.repo.path, target_path, checkout=True, errstream=errstream
  881. )
  882. r.close()
  883. def test_source_broken(self) -> None:
  884. with tempfile.TemporaryDirectory() as parent:
  885. target_path = os.path.join(parent, "target")
  886. self.assertRaises(
  887. Exception, porcelain.clone, "/nonexistent/repo", target_path
  888. )
  889. self.assertFalse(os.path.exists(target_path))
  890. def test_fetch_symref(self) -> None:
  891. f1_1 = make_object(Blob, data=b"f1")
  892. trees = {1: [(b"f1", f1_1), (b"f2", f1_1)]}
  893. [c1] = build_commit_graph(self.repo.object_store, [[1]], trees)
  894. self.repo.refs.set_symbolic_ref(b"HEAD", b"refs/heads/else")
  895. self.repo.refs[b"refs/heads/else"] = c1.id
  896. target_path = tempfile.mkdtemp()
  897. errstream = BytesIO()
  898. self.addCleanup(shutil.rmtree, target_path)
  899. r = porcelain.clone(
  900. self.repo.path, target_path, checkout=False, errstream=errstream
  901. )
  902. self.addCleanup(r.close)
  903. self.assertEqual(r.path, target_path)
  904. target_repo = Repo(target_path)
  905. self.assertEqual(0, len(target_repo.open_index()))
  906. self.assertEqual(c1.id, target_repo.refs[b"refs/heads/else"])
  907. self.assertEqual(c1.id, target_repo.refs[b"HEAD"])
  908. self.assertEqual(
  909. {
  910. b"HEAD": b"refs/heads/else",
  911. b"refs/remotes/origin/HEAD": b"refs/remotes/origin/else",
  912. },
  913. target_repo.refs.get_symrefs(),
  914. )
  915. def test_detached_head(self) -> None:
  916. f1_1 = make_object(Blob, data=b"f1")
  917. commit_spec = [[1], [2, 1], [3, 1, 2]]
  918. trees = {
  919. 1: [(b"f1", f1_1), (b"f2", f1_1)],
  920. 2: [(b"f1", f1_1), (b"f2", f1_1)],
  921. 3: [(b"f1", f1_1), (b"f2", f1_1)],
  922. }
  923. c1, c2, c3 = build_commit_graph(self.repo.object_store, commit_spec, trees)
  924. self.repo.refs[b"refs/heads/master"] = c2.id
  925. self.repo.refs.remove_if_equals(b"HEAD", None)
  926. self.repo.refs[b"HEAD"] = c3.id
  927. target_path = tempfile.mkdtemp()
  928. self.addCleanup(shutil.rmtree, target_path)
  929. errstream = porcelain.NoneStream()
  930. with porcelain.clone(
  931. self.repo.path, target_path, checkout=True, errstream=errstream
  932. ) as r:
  933. self.assertEqual(c3.id, r.refs[b"HEAD"])
  934. def test_clone_pathlib(self) -> None:
  935. from pathlib import Path
  936. f1_1 = make_object(Blob, data=b"f1")
  937. commit_spec = [[1]]
  938. trees = {1: [(b"f1", f1_1)]}
  939. c1 = build_commit_graph(self.repo.object_store, commit_spec, trees)[0]
  940. self.repo.refs[b"refs/heads/master"] = c1.id
  941. target_dir = tempfile.mkdtemp()
  942. self.addCleanup(shutil.rmtree, target_dir)
  943. target_path = Path(target_dir) / "clone_repo"
  944. errstream = BytesIO()
  945. r = porcelain.clone(
  946. self.repo.path, target_path, checkout=False, errstream=errstream
  947. )
  948. self.addCleanup(r.close)
  949. self.assertEqual(r.path, str(target_path))
  950. self.assertTrue(os.path.exists(str(target_path)))
  951. def test_clone_with_recurse_submodules(self) -> None:
  952. # Create a submodule repository
  953. sub_repo_path = tempfile.mkdtemp()
  954. self.addCleanup(shutil.rmtree, sub_repo_path)
  955. sub_repo = Repo.init(sub_repo_path)
  956. self.addCleanup(sub_repo.close)
  957. # Add a file to the submodule repo
  958. sub_file = os.path.join(sub_repo_path, "subfile.txt")
  959. with open(sub_file, "w") as f:
  960. f.write("submodule content")
  961. porcelain.add(sub_repo, paths=[sub_file])
  962. sub_commit = porcelain.commit(
  963. sub_repo,
  964. message=b"Initial submodule commit",
  965. author=b"Test Author <test@example.com>",
  966. committer=b"Test Committer <test@example.com>",
  967. )
  968. # Create main repository with submodule
  969. main_file = os.path.join(self.repo.path, "main.txt")
  970. with open(main_file, "w") as f:
  971. f.write("main content")
  972. porcelain.add(self.repo, paths=[main_file])
  973. porcelain.submodule_add(self.repo, sub_repo_path, "sub")
  974. # Manually add the submodule to the index since submodule_add doesn't do it
  975. # when the repository is local (to maintain backward compatibility)
  976. from dulwich.index import IndexEntry
  977. from dulwich.objects import S_IFGITLINK
  978. index = self.repo.open_index()
  979. index[b"sub"] = IndexEntry(
  980. ctime=0,
  981. mtime=0,
  982. dev=0,
  983. ino=0,
  984. mode=S_IFGITLINK,
  985. uid=0,
  986. gid=0,
  987. size=0,
  988. sha=sub_commit,
  989. flags=0,
  990. )
  991. index.write()
  992. porcelain.add(self.repo, paths=[".gitmodules"])
  993. porcelain.commit(
  994. self.repo,
  995. message=b"Add submodule",
  996. author=b"Test Author <test@example.com>",
  997. committer=b"Test Committer <test@example.com>",
  998. )
  999. # Clone with recurse_submodules
  1000. target_path = tempfile.mkdtemp()
  1001. self.addCleanup(shutil.rmtree, target_path)
  1002. cloned = porcelain.clone(
  1003. self.repo.path,
  1004. target_path,
  1005. recurse_submodules=True,
  1006. )
  1007. self.addCleanup(cloned.close)
  1008. # Check main file exists
  1009. cloned_main = os.path.join(target_path, "main.txt")
  1010. self.assertTrue(os.path.exists(cloned_main))
  1011. with open(cloned_main) as f:
  1012. self.assertEqual(f.read(), "main content")
  1013. # Check submodule file exists
  1014. cloned_sub_file = os.path.join(target_path, "sub", "subfile.txt")
  1015. self.assertTrue(os.path.exists(cloned_sub_file))
  1016. with open(cloned_sub_file) as f:
  1017. self.assertEqual(f.read(), "submodule content")
  1018. class InitTests(TestCase):
  1019. def test_non_bare(self) -> None:
  1020. repo_dir = tempfile.mkdtemp()
  1021. self.addCleanup(shutil.rmtree, repo_dir)
  1022. porcelain.init(repo_dir)
  1023. def test_bare(self) -> None:
  1024. repo_dir = tempfile.mkdtemp()
  1025. self.addCleanup(shutil.rmtree, repo_dir)
  1026. porcelain.init(repo_dir, bare=True)
  1027. def test_init_pathlib(self) -> None:
  1028. from pathlib import Path
  1029. repo_dir = tempfile.mkdtemp()
  1030. self.addCleanup(shutil.rmtree, repo_dir)
  1031. repo_path = Path(repo_dir)
  1032. # Test non-bare repo with pathlib
  1033. repo = porcelain.init(repo_path)
  1034. self.assertTrue(os.path.exists(os.path.join(repo_dir, ".git")))
  1035. repo.close()
  1036. def test_init_bare_pathlib(self) -> None:
  1037. from pathlib import Path
  1038. repo_dir = tempfile.mkdtemp()
  1039. self.addCleanup(shutil.rmtree, repo_dir)
  1040. repo_path = Path(repo_dir)
  1041. # Test bare repo with pathlib
  1042. repo = porcelain.init(repo_path, bare=True)
  1043. self.assertTrue(os.path.exists(os.path.join(repo_dir, "refs")))
  1044. repo.close()
  1045. class AddTests(PorcelainTestCase):
  1046. def test_add_default_paths(self) -> None:
  1047. # create a file for initial commit
  1048. fullpath = os.path.join(self.repo.path, "blah")
  1049. with open(fullpath, "w") as f:
  1050. f.write("\n")
  1051. porcelain.add(repo=self.repo.path, paths=[fullpath])
  1052. porcelain.commit(
  1053. repo=self.repo.path,
  1054. message=b"test",
  1055. author=b"test <email>",
  1056. committer=b"test <email>",
  1057. )
  1058. # Add a second test file and a file in a directory
  1059. with open(os.path.join(self.repo.path, "foo"), "w") as f:
  1060. f.write("\n")
  1061. os.mkdir(os.path.join(self.repo.path, "adir"))
  1062. with open(os.path.join(self.repo.path, "adir", "afile"), "w") as f:
  1063. f.write("\n")
  1064. cwd = os.getcwd()
  1065. try:
  1066. os.chdir(self.repo.path)
  1067. self.assertEqual({"foo", "blah", "adir", ".git"}, set(os.listdir(".")))
  1068. added, ignored = porcelain.add(self.repo.path)
  1069. # Normalize paths to use forward slashes for comparison
  1070. added_normalized = [path.replace(os.sep, "/") for path in added]
  1071. self.assertEqual(
  1072. (added_normalized, ignored),
  1073. (["foo", "adir/afile"], set()),
  1074. )
  1075. finally:
  1076. os.chdir(cwd)
  1077. # Check that foo was added and nothing in .git was modified
  1078. index = self.repo.open_index()
  1079. self.assertEqual(sorted(index), [b"adir/afile", b"blah", b"foo"])
  1080. def test_add_default_paths_subdir(self) -> None:
  1081. os.mkdir(os.path.join(self.repo.path, "foo"))
  1082. with open(os.path.join(self.repo.path, "blah"), "w") as f:
  1083. f.write("\n")
  1084. with open(os.path.join(self.repo.path, "foo", "blie"), "w") as f:
  1085. f.write("\n")
  1086. cwd = os.getcwd()
  1087. try:
  1088. os.chdir(os.path.join(self.repo.path, "foo"))
  1089. porcelain.add(repo=self.repo.path)
  1090. porcelain.commit(
  1091. repo=self.repo.path,
  1092. message=b"test",
  1093. author=b"test <email>",
  1094. committer=b"test <email>",
  1095. )
  1096. finally:
  1097. os.chdir(cwd)
  1098. index = self.repo.open_index()
  1099. # After fix: add() with no paths should behave like git add -A (add everything)
  1100. self.assertEqual(sorted(index), [b"blah", b"foo/blie"])
  1101. def test_add_file(self) -> None:
  1102. fullpath = os.path.join(self.repo.path, "foo")
  1103. with open(fullpath, "w") as f:
  1104. f.write("BAR")
  1105. porcelain.add(self.repo.path, paths=[fullpath])
  1106. self.assertIn(b"foo", self.repo.open_index())
  1107. def test_add_ignored(self) -> None:
  1108. with open(os.path.join(self.repo.path, ".gitignore"), "w") as f:
  1109. f.write("foo\nsubdir/")
  1110. with open(os.path.join(self.repo.path, "foo"), "w") as f:
  1111. f.write("BAR")
  1112. with open(os.path.join(self.repo.path, "bar"), "w") as f:
  1113. f.write("BAR")
  1114. os.mkdir(os.path.join(self.repo.path, "subdir"))
  1115. with open(os.path.join(self.repo.path, "subdir", "baz"), "w") as f:
  1116. f.write("BAZ")
  1117. (added, ignored) = porcelain.add(
  1118. self.repo.path,
  1119. paths=[
  1120. os.path.join(self.repo.path, "foo"),
  1121. os.path.join(self.repo.path, "bar"),
  1122. os.path.join(self.repo.path, "subdir"),
  1123. ],
  1124. )
  1125. self.assertIn(b"bar", self.repo.open_index())
  1126. self.assertEqual({"bar"}, set(added))
  1127. self.assertEqual({"foo", "subdir/"}, ignored)
  1128. def test_add_file_absolute_path(self) -> None:
  1129. # Absolute paths are (not yet) supported
  1130. with open(os.path.join(self.repo.path, "foo"), "w") as f:
  1131. f.write("BAR")
  1132. porcelain.add(self.repo, paths=[os.path.join(self.repo.path, "foo")])
  1133. self.assertIn(b"foo", self.repo.open_index())
  1134. def test_add_not_in_repo(self) -> None:
  1135. with open(os.path.join(self.test_dir, "foo"), "w") as f:
  1136. f.write("BAR")
  1137. self.assertRaises(
  1138. ValueError,
  1139. porcelain.add,
  1140. self.repo,
  1141. paths=[os.path.join(self.test_dir, "foo")],
  1142. )
  1143. self.assertRaises(
  1144. (ValueError, FileNotFoundError),
  1145. porcelain.add,
  1146. self.repo,
  1147. paths=["../foo"],
  1148. )
  1149. self.assertEqual([], list(self.repo.open_index()))
  1150. def test_add_file_clrf_conversion(self) -> None:
  1151. # Set the right configuration to the repo
  1152. c = self.repo.get_config()
  1153. c.set("core", "autocrlf", "input")
  1154. c.write_to_path()
  1155. # Add a file with CRLF line-ending
  1156. fullpath = os.path.join(self.repo.path, "foo")
  1157. with open(fullpath, "wb") as f:
  1158. f.write(b"line1\r\nline2")
  1159. porcelain.add(self.repo.path, paths=[fullpath])
  1160. # The line-endings should have been converted to LF
  1161. index = self.repo.open_index()
  1162. self.assertIn(b"foo", index)
  1163. entry = index[b"foo"]
  1164. blob = self.repo[entry.sha]
  1165. self.assertEqual(blob.data, b"line1\nline2")
  1166. def test_add_symlink_outside_repo(self) -> None:
  1167. """Test adding a symlink that points outside the repository."""
  1168. # Create a symlink pointing outside the repository
  1169. symlink_path = os.path.join(self.repo.path, "symlink_to_nowhere")
  1170. os.symlink("/nonexistent/path", symlink_path)
  1171. # Adding the symlink should succeed (matching Git's behavior)
  1172. added, ignored = porcelain.add(self.repo.path, paths=[symlink_path])
  1173. # Should successfully add the symlink
  1174. self.assertIn("symlink_to_nowhere", added)
  1175. self.assertEqual(len(ignored), 0)
  1176. # Verify symlink is actually staged
  1177. index = self.repo.open_index()
  1178. self.assertIn(b"symlink_to_nowhere", index)
  1179. def test_add_symlink_to_file_inside_repo(self) -> None:
  1180. """Test adding a symlink that points to a file inside the repository."""
  1181. # Create a regular file
  1182. target_file = os.path.join(self.repo.path, "target.txt")
  1183. with open(target_file, "w") as f:
  1184. f.write("target content")
  1185. # Create a symlink to the file
  1186. symlink_path = os.path.join(self.repo.path, "link_to_target")
  1187. os.symlink("target.txt", symlink_path)
  1188. # Add both the target and the symlink
  1189. added, ignored = porcelain.add(
  1190. self.repo.path, paths=[target_file, symlink_path]
  1191. )
  1192. # Both should be added successfully
  1193. self.assertIn("target.txt", added)
  1194. self.assertIn("link_to_target", added)
  1195. self.assertEqual(len(ignored), 0)
  1196. # Verify both are in the index
  1197. index = self.repo.open_index()
  1198. self.assertIn(b"target.txt", index)
  1199. self.assertIn(b"link_to_target", index)
  1200. def test_add_symlink_to_directory_inside_repo(self) -> None:
  1201. """Test adding a symlink that points to a directory inside the repository."""
  1202. # Create a directory with some files
  1203. target_dir = os.path.join(self.repo.path, "target_dir")
  1204. os.mkdir(target_dir)
  1205. with open(os.path.join(target_dir, "file1.txt"), "w") as f:
  1206. f.write("content1")
  1207. with open(os.path.join(target_dir, "file2.txt"), "w") as f:
  1208. f.write("content2")
  1209. # Create a symlink to the directory
  1210. symlink_path = os.path.join(self.repo.path, "link_to_dir")
  1211. os.symlink("target_dir", symlink_path)
  1212. # Add the symlink
  1213. added, ignored = porcelain.add(self.repo.path, paths=[symlink_path])
  1214. # When adding a symlink to a directory, it follows the symlink and adds contents
  1215. self.assertEqual(len(added), 2)
  1216. self.assertIn("link_to_dir/file1.txt", added)
  1217. self.assertIn("link_to_dir/file2.txt", added)
  1218. self.assertEqual(len(ignored), 0)
  1219. # Verify files are added through the symlink path
  1220. index = self.repo.open_index()
  1221. self.assertIn(b"link_to_dir/file1.txt", index)
  1222. self.assertIn(b"link_to_dir/file2.txt", index)
  1223. # The original target directory files are not added
  1224. self.assertNotIn(b"target_dir/file1.txt", index)
  1225. self.assertNotIn(b"target_dir/file2.txt", index)
  1226. def test_add_symlink_chain(self) -> None:
  1227. """Test adding a chain of symlinks (symlink to symlink)."""
  1228. # Create a regular file
  1229. target_file = os.path.join(self.repo.path, "original.txt")
  1230. with open(target_file, "w") as f:
  1231. f.write("original content")
  1232. # Create first symlink
  1233. first_link = os.path.join(self.repo.path, "link1")
  1234. os.symlink("original.txt", first_link)
  1235. # Create second symlink pointing to first
  1236. second_link = os.path.join(self.repo.path, "link2")
  1237. os.symlink("link1", second_link)
  1238. # Add all files
  1239. added, ignored = porcelain.add(
  1240. self.repo.path, paths=[target_file, first_link, second_link]
  1241. )
  1242. # All should be added
  1243. self.assertEqual(len(added), 3)
  1244. self.assertIn("original.txt", added)
  1245. self.assertIn("link1", added)
  1246. self.assertIn("link2", added)
  1247. # Verify all are in the index
  1248. index = self.repo.open_index()
  1249. self.assertIn(b"original.txt", index)
  1250. self.assertIn(b"link1", index)
  1251. self.assertIn(b"link2", index)
  1252. def test_add_broken_symlink(self) -> None:
  1253. """Test adding a broken symlink (points to non-existent target)."""
  1254. # Create a symlink to a non-existent file
  1255. broken_link = os.path.join(self.repo.path, "broken_link")
  1256. os.symlink("does_not_exist.txt", broken_link)
  1257. # Add the broken symlink
  1258. added, ignored = porcelain.add(self.repo.path, paths=[broken_link])
  1259. # Should be added successfully (Git tracks the symlink, not its target)
  1260. self.assertIn("broken_link", added)
  1261. self.assertEqual(len(ignored), 0)
  1262. # Verify it's in the index
  1263. index = self.repo.open_index()
  1264. self.assertIn(b"broken_link", index)
  1265. def test_add_symlink_relative_outside_repo(self) -> None:
  1266. """Test adding a symlink that uses '..' to point outside the repository."""
  1267. # Create a file outside the repo
  1268. outside_file = os.path.join(self.test_dir, "outside.txt")
  1269. with open(outside_file, "w") as f:
  1270. f.write("outside content")
  1271. # Create a symlink using relative path to go outside
  1272. symlink_path = os.path.join(self.repo.path, "link_outside")
  1273. os.symlink("../outside.txt", symlink_path)
  1274. # Add the symlink
  1275. added, ignored = porcelain.add(self.repo.path, paths=[symlink_path])
  1276. # Should be added successfully
  1277. self.assertIn("link_outside", added)
  1278. self.assertEqual(len(ignored), 0)
  1279. # Verify it's in the index
  1280. index = self.repo.open_index()
  1281. self.assertIn(b"link_outside", index)
  1282. def test_add_symlink_absolute_to_system(self) -> None:
  1283. """Test adding a symlink with absolute path to system directory."""
  1284. # Create a symlink to a system directory
  1285. symlink_path = os.path.join(self.repo.path, "link_to_tmp")
  1286. if os.name == "nt":
  1287. # On Windows, use a system directory like TEMP
  1288. symlink_target = os.environ["TEMP"]
  1289. else:
  1290. # On Unix-like systems, use /tmp
  1291. symlink_target = "/tmp"
  1292. os.symlink(symlink_target, symlink_path)
  1293. # Adding a symlink to a directory outside the repo should raise ValueError
  1294. with self.assertRaises(ValueError) as cm:
  1295. porcelain.add(self.repo.path, paths=[symlink_path])
  1296. # Check that the error indicates the path is outside the repository
  1297. self.assertIn("is not in the subpath of", str(cm.exception))
  1298. def test_add_file_through_symlink(self) -> None:
  1299. """Test adding a file through a symlinked directory."""
  1300. # Create a directory with a file
  1301. real_dir = os.path.join(self.repo.path, "real_dir")
  1302. os.mkdir(real_dir)
  1303. real_file = os.path.join(real_dir, "file.txt")
  1304. with open(real_file, "w") as f:
  1305. f.write("content")
  1306. # Create a symlink to the directory
  1307. link_dir = os.path.join(self.repo.path, "link_dir")
  1308. os.symlink("real_dir", link_dir)
  1309. # Try to add the file through the symlink path
  1310. symlink_file_path = os.path.join(link_dir, "file.txt")
  1311. # This should add the real file, not create a new entry
  1312. added, ignored = porcelain.add(self.repo.path, paths=[symlink_file_path])
  1313. # The real file should be added
  1314. self.assertIn("real_dir/file.txt", added)
  1315. self.assertEqual(len(added), 1)
  1316. # Verify correct path in index
  1317. index = self.repo.open_index()
  1318. self.assertIn(b"real_dir/file.txt", index)
  1319. # Should not create a separate entry for the symlink path
  1320. self.assertNotIn(b"link_dir/file.txt", index)
  1321. def test_add_repo_path(self) -> None:
  1322. """Test adding the repository path itself should add all untracked files."""
  1323. # Create some untracked files
  1324. with open(os.path.join(self.repo.path, "file1.txt"), "w") as f:
  1325. f.write("content1")
  1326. with open(os.path.join(self.repo.path, "file2.txt"), "w") as f:
  1327. f.write("content2")
  1328. # Add the repository path itself
  1329. added, ignored = porcelain.add(self.repo.path, paths=[self.repo.path])
  1330. # Should add all untracked files, not stage './'
  1331. self.assertIn("file1.txt", added)
  1332. self.assertIn("file2.txt", added)
  1333. self.assertNotIn("./", added)
  1334. # Verify files are actually staged
  1335. index = self.repo.open_index()
  1336. self.assertIn(b"file1.txt", index)
  1337. self.assertIn(b"file2.txt", index)
  1338. def test_add_directory_contents(self) -> None:
  1339. """Test adding a directory adds all files within it."""
  1340. # Create a subdirectory with multiple files
  1341. subdir = os.path.join(self.repo.path, "subdir")
  1342. os.mkdir(subdir)
  1343. with open(os.path.join(subdir, "file1.txt"), "w") as f:
  1344. f.write("content1")
  1345. with open(os.path.join(subdir, "file2.txt"), "w") as f:
  1346. f.write("content2")
  1347. with open(os.path.join(subdir, "file3.txt"), "w") as f:
  1348. f.write("content3")
  1349. # Add the directory
  1350. added, ignored = porcelain.add(self.repo.path, paths=["subdir"])
  1351. # Should add all files in the directory
  1352. self.assertEqual(len(added), 3)
  1353. # Normalize paths to use forward slashes for comparison
  1354. added_normalized = [path.replace(os.sep, "/") for path in added]
  1355. self.assertIn("subdir/file1.txt", added_normalized)
  1356. self.assertIn("subdir/file2.txt", added_normalized)
  1357. self.assertIn("subdir/file3.txt", added_normalized)
  1358. # Verify files are actually staged
  1359. index = self.repo.open_index()
  1360. self.assertIn(b"subdir/file1.txt", index)
  1361. self.assertIn(b"subdir/file2.txt", index)
  1362. self.assertIn(b"subdir/file3.txt", index)
  1363. def test_add_nested_directories(self) -> None:
  1364. """Test adding a directory with nested subdirectories."""
  1365. # Create nested directory structure
  1366. dir1 = os.path.join(self.repo.path, "dir1")
  1367. dir2 = os.path.join(dir1, "dir2")
  1368. dir3 = os.path.join(dir2, "dir3")
  1369. os.makedirs(dir3)
  1370. # Add files at each level
  1371. with open(os.path.join(dir1, "file1.txt"), "w") as f:
  1372. f.write("level1")
  1373. with open(os.path.join(dir2, "file2.txt"), "w") as f:
  1374. f.write("level2")
  1375. with open(os.path.join(dir3, "file3.txt"), "w") as f:
  1376. f.write("level3")
  1377. # Add the top-level directory
  1378. added, ignored = porcelain.add(self.repo.path, paths=["dir1"])
  1379. # Should add all files recursively
  1380. self.assertEqual(len(added), 3)
  1381. # Normalize paths to use forward slashes for comparison
  1382. added_normalized = [path.replace(os.sep, "/") for path in added]
  1383. self.assertIn("dir1/file1.txt", added_normalized)
  1384. self.assertIn("dir1/dir2/file2.txt", added_normalized)
  1385. self.assertIn("dir1/dir2/dir3/file3.txt", added_normalized)
  1386. # Verify files are actually staged
  1387. index = self.repo.open_index()
  1388. self.assertIn(b"dir1/file1.txt", index)
  1389. self.assertIn(b"dir1/dir2/file2.txt", index)
  1390. self.assertIn(b"dir1/dir2/dir3/file3.txt", index)
  1391. def test_add_directory_with_tracked_files(self) -> None:
  1392. """Test adding a directory with some files already tracked."""
  1393. # Create a subdirectory with files
  1394. subdir = os.path.join(self.repo.path, "mixed")
  1395. os.mkdir(subdir)
  1396. # Create and commit one file
  1397. tracked_file = os.path.join(subdir, "tracked.txt")
  1398. with open(tracked_file, "w") as f:
  1399. f.write("already tracked")
  1400. porcelain.add(self.repo.path, paths=[tracked_file])
  1401. porcelain.commit(
  1402. repo=self.repo.path,
  1403. message=b"Add tracked file",
  1404. author=b"test <email>",
  1405. committer=b"test <email>",
  1406. )
  1407. # Add more untracked files
  1408. with open(os.path.join(subdir, "untracked1.txt"), "w") as f:
  1409. f.write("new file 1")
  1410. with open(os.path.join(subdir, "untracked2.txt"), "w") as f:
  1411. f.write("new file 2")
  1412. # Add the directory
  1413. added, ignored = porcelain.add(self.repo.path, paths=["mixed"])
  1414. # Should only add the untracked files
  1415. self.assertEqual(len(added), 2)
  1416. # Normalize paths to use forward slashes for comparison
  1417. added_normalized = [path.replace(os.sep, "/") for path in added]
  1418. self.assertIn("mixed/untracked1.txt", added_normalized)
  1419. self.assertIn("mixed/untracked2.txt", added_normalized)
  1420. self.assertNotIn("mixed/tracked.txt", added)
  1421. # Verify the index contains all files
  1422. index = self.repo.open_index()
  1423. self.assertIn(b"mixed/tracked.txt", index)
  1424. self.assertIn(b"mixed/untracked1.txt", index)
  1425. self.assertIn(b"mixed/untracked2.txt", index)
  1426. def test_add_directory_with_gitignore(self) -> None:
  1427. """Test adding a directory respects .gitignore patterns."""
  1428. # Create .gitignore
  1429. with open(os.path.join(self.repo.path, ".gitignore"), "w") as f:
  1430. f.write("*.log\n*.tmp\nbuild/\n")
  1431. # Create directory with mixed files
  1432. testdir = os.path.join(self.repo.path, "testdir")
  1433. os.mkdir(testdir)
  1434. # Create various files
  1435. with open(os.path.join(testdir, "important.txt"), "w") as f:
  1436. f.write("keep this")
  1437. with open(os.path.join(testdir, "debug.log"), "w") as f:
  1438. f.write("ignore this")
  1439. with open(os.path.join(testdir, "temp.tmp"), "w") as f:
  1440. f.write("ignore this too")
  1441. with open(os.path.join(testdir, "readme.md"), "w") as f:
  1442. f.write("keep this too")
  1443. # Create a build directory that should be ignored
  1444. builddir = os.path.join(testdir, "build")
  1445. os.mkdir(builddir)
  1446. with open(os.path.join(builddir, "output.txt"), "w") as f:
  1447. f.write("ignore entire directory")
  1448. # Add the directory
  1449. added, ignored = porcelain.add(self.repo.path, paths=["testdir"])
  1450. # Should only add non-ignored files
  1451. # Normalize paths to use forward slashes for comparison
  1452. added_normalized = {path.replace(os.sep, "/") for path in added}
  1453. self.assertEqual(
  1454. added_normalized, {"testdir/important.txt", "testdir/readme.md"}
  1455. )
  1456. # Check ignored files
  1457. # Normalize paths to use forward slashes for comparison
  1458. ignored_normalized = {path.replace(os.sep, "/") for path in ignored}
  1459. self.assertIn("testdir/debug.log", ignored_normalized)
  1460. self.assertIn("testdir/temp.tmp", ignored_normalized)
  1461. self.assertIn("testdir/build/", ignored_normalized)
  1462. def test_add_multiple_directories(self) -> None:
  1463. """Test adding multiple directories in one call."""
  1464. # Create multiple directories
  1465. for dirname in ["dir1", "dir2", "dir3"]:
  1466. dirpath = os.path.join(self.repo.path, dirname)
  1467. os.mkdir(dirpath)
  1468. # Add files to each directory
  1469. for i in range(2):
  1470. with open(os.path.join(dirpath, f"file{i}.txt"), "w") as f:
  1471. f.write(f"content {dirname} {i}")
  1472. # Add all directories at once
  1473. added, ignored = porcelain.add(self.repo.path, paths=["dir1", "dir2", "dir3"])
  1474. # Should add all files from all directories
  1475. self.assertEqual(len(added), 6)
  1476. # Normalize paths to use forward slashes for comparison
  1477. added_normalized = [path.replace(os.sep, "/") for path in added]
  1478. for dirname in ["dir1", "dir2", "dir3"]:
  1479. for i in range(2):
  1480. self.assertIn(f"{dirname}/file{i}.txt", added_normalized)
  1481. # Verify all files are staged
  1482. index = self.repo.open_index()
  1483. self.assertEqual(len(index), 6)
  1484. def test_add_default_paths_includes_modified_files(self) -> None:
  1485. """Test that add() with no paths includes both untracked and modified files."""
  1486. # Create and commit initial file
  1487. initial_file = os.path.join(self.repo.path, "existing.txt")
  1488. with open(initial_file, "w") as f:
  1489. f.write("initial content\n")
  1490. porcelain.add(repo=self.repo.path, paths=[initial_file])
  1491. porcelain.commit(
  1492. repo=self.repo.path,
  1493. message=b"initial commit",
  1494. author=b"test <email>",
  1495. committer=b"test <email>",
  1496. )
  1497. # Modify the existing file (this creates an unstaged change)
  1498. with open(initial_file, "w") as f:
  1499. f.write("modified content\n")
  1500. # Create a new untracked file
  1501. new_file = os.path.join(self.repo.path, "new.txt")
  1502. with open(new_file, "w") as f:
  1503. f.write("new file content\n")
  1504. # Call add() with no paths - should stage both modified and untracked files
  1505. added_files, ignored_files = porcelain.add(repo=self.repo.path)
  1506. # Verify both files were added
  1507. self.assertIn("existing.txt", added_files)
  1508. self.assertIn("new.txt", added_files)
  1509. self.assertEqual(len(ignored_files), 0)
  1510. # Verify both files are now staged
  1511. index = self.repo.open_index()
  1512. self.assertIn(b"existing.txt", index)
  1513. self.assertIn(b"new.txt", index)
  1514. class RemoveTests(PorcelainTestCase):
  1515. def test_remove_file(self) -> None:
  1516. fullpath = os.path.join(self.repo.path, "foo")
  1517. with open(fullpath, "w") as f:
  1518. f.write("BAR")
  1519. porcelain.add(self.repo.path, paths=[fullpath])
  1520. porcelain.commit(
  1521. repo=self.repo,
  1522. message=b"test",
  1523. author=b"test <email>",
  1524. committer=b"test <email>",
  1525. )
  1526. self.assertTrue(os.path.exists(os.path.join(self.repo.path, "foo")))
  1527. cwd = os.getcwd()
  1528. try:
  1529. os.chdir(self.repo.path)
  1530. porcelain.remove(self.repo.path, paths=["foo"])
  1531. finally:
  1532. os.chdir(cwd)
  1533. self.assertFalse(os.path.exists(os.path.join(self.repo.path, "foo")))
  1534. def test_remove_file_staged(self) -> None:
  1535. fullpath = os.path.join(self.repo.path, "foo")
  1536. with open(fullpath, "w") as f:
  1537. f.write("BAR")
  1538. cwd = os.getcwd()
  1539. try:
  1540. os.chdir(self.repo.path)
  1541. porcelain.add(self.repo.path, paths=[fullpath])
  1542. self.assertRaises(Exception, porcelain.rm, self.repo.path, paths=["foo"])
  1543. finally:
  1544. os.chdir(cwd)
  1545. def test_remove_file_removed_on_disk(self) -> None:
  1546. fullpath = os.path.join(self.repo.path, "foo")
  1547. with open(fullpath, "w") as f:
  1548. f.write("BAR")
  1549. porcelain.add(self.repo.path, paths=[fullpath])
  1550. cwd = os.getcwd()
  1551. try:
  1552. os.chdir(self.repo.path)
  1553. os.remove(fullpath)
  1554. porcelain.remove(self.repo.path, paths=["foo"])
  1555. finally:
  1556. os.chdir(cwd)
  1557. self.assertFalse(os.path.exists(os.path.join(self.repo.path, "foo")))
  1558. def test_remove_from_different_directory(self) -> None:
  1559. # Create a subdirectory with a file
  1560. subdir = os.path.join(self.repo.path, "mydir")
  1561. os.makedirs(subdir)
  1562. fullpath = os.path.join(subdir, "myfile")
  1563. with open(fullpath, "w") as f:
  1564. f.write("BAR")
  1565. # Add and commit the file
  1566. porcelain.add(self.repo.path, paths=[fullpath])
  1567. porcelain.commit(
  1568. repo=self.repo,
  1569. message=b"test",
  1570. author=b"test <email>",
  1571. committer=b"test <email>",
  1572. )
  1573. # Change to a different directory
  1574. cwd = os.getcwd()
  1575. tempdir = tempfile.mkdtemp()
  1576. try:
  1577. os.chdir(tempdir)
  1578. # Remove the file using relative path from repository root
  1579. porcelain.remove(self.repo.path, paths=["mydir/myfile"])
  1580. finally:
  1581. os.chdir(cwd)
  1582. os.rmdir(tempdir)
  1583. # Verify file was removed
  1584. self.assertFalse(os.path.exists(fullpath))
  1585. def test_remove_with_absolute_path(self) -> None:
  1586. # Create a file
  1587. fullpath = os.path.join(self.repo.path, "foo")
  1588. with open(fullpath, "w") as f:
  1589. f.write("BAR")
  1590. # Add and commit the file
  1591. porcelain.add(self.repo.path, paths=[fullpath])
  1592. porcelain.commit(
  1593. repo=self.repo,
  1594. message=b"test",
  1595. author=b"test <email>",
  1596. committer=b"test <email>",
  1597. )
  1598. # Change to a different directory
  1599. cwd = os.getcwd()
  1600. tempdir = tempfile.mkdtemp()
  1601. try:
  1602. os.chdir(tempdir)
  1603. # Remove the file using absolute path
  1604. porcelain.remove(self.repo.path, paths=[fullpath])
  1605. finally:
  1606. os.chdir(cwd)
  1607. os.rmdir(tempdir)
  1608. # Verify file was removed
  1609. self.assertFalse(os.path.exists(fullpath))
  1610. def test_remove_with_filter_normalization(self) -> None:
  1611. # Enable autocrlf to normalize line endings
  1612. config = self.repo.get_config()
  1613. config.set(("core",), "autocrlf", b"true")
  1614. config.write_to_path()
  1615. # Create a file with LF line endings (will be stored with LF in index)
  1616. fullpath = os.path.join(self.repo.path, "foo.txt")
  1617. with open(fullpath, "wb") as f:
  1618. f.write(b"line1\nline2\nline3")
  1619. # Add and commit the file (stored with LF in index)
  1620. porcelain.add(self.repo.path, paths=[fullpath])
  1621. porcelain.commit(
  1622. repo=self.repo,
  1623. message=b"Add file with LF",
  1624. author=b"test <email>",
  1625. committer=b"test <email>",
  1626. )
  1627. # Simulate checkout with CRLF conversion (as would happen on Windows)
  1628. with open(fullpath, "wb") as f:
  1629. f.write(b"line1\r\nline2\r\nline3")
  1630. # Verify file exists
  1631. self.assertTrue(os.path.exists(fullpath))
  1632. # Remove the file - this should not fail even though working tree has CRLF
  1633. # and index has LF (thanks to the normalization in the commit)
  1634. cwd = os.getcwd()
  1635. try:
  1636. os.chdir(self.repo.path)
  1637. porcelain.remove(self.repo.path, paths=["foo.txt"])
  1638. finally:
  1639. os.chdir(cwd)
  1640. # Verify file was removed
  1641. self.assertFalse(os.path.exists(fullpath))
  1642. class MvTests(PorcelainTestCase):
  1643. def test_mv_file(self) -> None:
  1644. # Create a file
  1645. fullpath = os.path.join(self.repo.path, "foo")
  1646. with open(fullpath, "w") as f:
  1647. f.write("BAR")
  1648. # Add and commit the file
  1649. porcelain.add(self.repo.path, paths=[fullpath])
  1650. porcelain.commit(
  1651. repo=self.repo,
  1652. message=b"test",
  1653. author=b"test <email>",
  1654. committer=b"test <email>",
  1655. )
  1656. # Move the file
  1657. porcelain.mv(self.repo.path, "foo", "bar")
  1658. # Verify old path doesn't exist and new path does
  1659. self.assertFalse(os.path.exists(os.path.join(self.repo.path, "foo")))
  1660. self.assertTrue(os.path.exists(os.path.join(self.repo.path, "bar")))
  1661. # Verify index was updated
  1662. index = self.repo.open_index()
  1663. self.assertNotIn(b"foo", index)
  1664. self.assertIn(b"bar", index)
  1665. def test_mv_file_to_existing_directory(self) -> None:
  1666. # Create a file and a directory
  1667. fullpath = os.path.join(self.repo.path, "foo")
  1668. with open(fullpath, "w") as f:
  1669. f.write("BAR")
  1670. dirpath = os.path.join(self.repo.path, "mydir")
  1671. os.makedirs(dirpath)
  1672. # Add and commit the file
  1673. porcelain.add(self.repo.path, paths=[fullpath])
  1674. porcelain.commit(
  1675. repo=self.repo,
  1676. message=b"test",
  1677. author=b"test <email>",
  1678. committer=b"test <email>",
  1679. )
  1680. # Move the file into the directory
  1681. porcelain.mv(self.repo.path, "foo", "mydir")
  1682. # Verify file moved into directory
  1683. self.assertFalse(os.path.exists(os.path.join(self.repo.path, "foo")))
  1684. self.assertTrue(os.path.exists(os.path.join(self.repo.path, "mydir", "foo")))
  1685. # Verify index was updated
  1686. index = self.repo.open_index()
  1687. self.assertNotIn(b"foo", index)
  1688. self.assertIn(b"mydir/foo", index)
  1689. def test_mv_file_force_overwrite(self) -> None:
  1690. # Create two files
  1691. fullpath1 = os.path.join(self.repo.path, "foo")
  1692. with open(fullpath1, "w") as f:
  1693. f.write("FOO")
  1694. fullpath2 = os.path.join(self.repo.path, "bar")
  1695. with open(fullpath2, "w") as f:
  1696. f.write("BAR")
  1697. # Add and commit both files
  1698. porcelain.add(self.repo.path, paths=[fullpath1, fullpath2])
  1699. porcelain.commit(
  1700. repo=self.repo,
  1701. message=b"test",
  1702. author=b"test <email>",
  1703. committer=b"test <email>",
  1704. )
  1705. # Try to move without force (should fail)
  1706. self.assertRaises(porcelain.Error, porcelain.mv, self.repo.path, "foo", "bar")
  1707. # Move with force
  1708. porcelain.mv(self.repo.path, "foo", "bar", force=True)
  1709. # Verify foo doesn't exist and bar has foo's content
  1710. self.assertFalse(os.path.exists(os.path.join(self.repo.path, "foo")))
  1711. with open(os.path.join(self.repo.path, "bar")) as f:
  1712. self.assertEqual(f.read(), "FOO")
  1713. def test_mv_file_not_tracked(self) -> None:
  1714. # Create an untracked file
  1715. fullpath = os.path.join(self.repo.path, "untracked")
  1716. with open(fullpath, "w") as f:
  1717. f.write("UNTRACKED")
  1718. # Try to move it (should fail)
  1719. self.assertRaises(
  1720. porcelain.Error, porcelain.mv, self.repo.path, "untracked", "tracked"
  1721. )
  1722. def test_mv_file_not_exists(self) -> None:
  1723. # Try to move a non-existent file
  1724. self.assertRaises(
  1725. porcelain.Error, porcelain.mv, self.repo.path, "nonexistent", "destination"
  1726. )
  1727. def test_mv_absolute_paths(self) -> None:
  1728. # Create a file
  1729. fullpath = os.path.join(self.repo.path, "foo")
  1730. with open(fullpath, "w") as f:
  1731. f.write("BAR")
  1732. # Add and commit the file
  1733. porcelain.add(self.repo.path, paths=[fullpath])
  1734. porcelain.commit(
  1735. repo=self.repo,
  1736. message=b"test",
  1737. author=b"test <email>",
  1738. committer=b"test <email>",
  1739. )
  1740. # Move using absolute paths
  1741. dest_path = os.path.join(self.repo.path, "bar")
  1742. porcelain.mv(self.repo.path, fullpath, dest_path)
  1743. # Verify file moved
  1744. self.assertFalse(os.path.exists(fullpath))
  1745. self.assertTrue(os.path.exists(dest_path))
  1746. def test_mv_from_different_directory(self) -> None:
  1747. # Create a subdirectory with a file
  1748. subdir = os.path.join(self.repo.path, "mydir")
  1749. os.makedirs(subdir)
  1750. fullpath = os.path.join(subdir, "myfile")
  1751. with open(fullpath, "w") as f:
  1752. f.write("BAR")
  1753. # Add and commit the file
  1754. porcelain.add(self.repo.path, paths=[fullpath])
  1755. porcelain.commit(
  1756. repo=self.repo,
  1757. message=b"test",
  1758. author=b"test <email>",
  1759. committer=b"test <email>",
  1760. )
  1761. # Change to a different directory and move the file
  1762. cwd = os.getcwd()
  1763. tempdir = tempfile.mkdtemp()
  1764. try:
  1765. os.chdir(tempdir)
  1766. # Move the file using relative path from repository root
  1767. porcelain.mv(self.repo.path, "mydir/myfile", "renamed")
  1768. finally:
  1769. os.chdir(cwd)
  1770. os.rmdir(tempdir)
  1771. # Verify file was moved
  1772. self.assertFalse(os.path.exists(fullpath))
  1773. self.assertTrue(os.path.exists(os.path.join(self.repo.path, "renamed")))
  1774. class LogTests(PorcelainTestCase):
  1775. def test_simple(self) -> None:
  1776. c1, c2, c3 = build_commit_graph(
  1777. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  1778. )
  1779. self.repo.refs[b"HEAD"] = c3.id
  1780. self.maxDiff = None
  1781. outstream = StringIO()
  1782. porcelain.log(self.repo.path, outstream=outstream)
  1783. self.assertEqual(
  1784. outstream.getvalue(),
  1785. """\
  1786. --------------------------------------------------
  1787. commit: 4a3b887baa9ecb2d054d2469b628aef84e2d74f0
  1788. merge: 7508036b1cfec5aa9cef0d5a7f04abcecfe09112
  1789. Author: Test Author <test@nodomain.com>
  1790. Committer: Test Committer <test@nodomain.com>
  1791. Date: Fri Jan 01 2010 00:00:00 +0000
  1792. Commit 3
  1793. --------------------------------------------------
  1794. commit: 7508036b1cfec5aa9cef0d5a7f04abcecfe09112
  1795. Author: Test Author <test@nodomain.com>
  1796. Committer: Test Committer <test@nodomain.com>
  1797. Date: Fri Jan 01 2010 00:00:00 +0000
  1798. Commit 2
  1799. --------------------------------------------------
  1800. commit: 11d3cf672a19366435c1983c7340b008ec6b8bf3
  1801. Author: Test Author <test@nodomain.com>
  1802. Committer: Test Committer <test@nodomain.com>
  1803. Date: Fri Jan 01 2010 00:00:00 +0000
  1804. Commit 1
  1805. """,
  1806. )
  1807. def test_max_entries(self) -> None:
  1808. c1, c2, c3 = build_commit_graph(
  1809. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  1810. )
  1811. self.repo.refs[b"HEAD"] = c3.id
  1812. outstream = StringIO()
  1813. porcelain.log(self.repo.path, outstream=outstream, max_entries=1)
  1814. self.assertEqual(1, outstream.getvalue().count("-" * 50))
  1815. def test_no_revisions(self) -> None:
  1816. outstream = StringIO()
  1817. porcelain.log(self.repo.path, outstream=outstream)
  1818. self.assertEqual("", outstream.getvalue())
  1819. def test_empty_message(self) -> None:
  1820. c1 = make_commit(message="")
  1821. self.repo.object_store.add_object(c1)
  1822. self.repo.refs[b"HEAD"] = c1.id
  1823. outstream = StringIO()
  1824. porcelain.log(self.repo.path, outstream=outstream)
  1825. self.assertEqual(
  1826. outstream.getvalue(),
  1827. """\
  1828. --------------------------------------------------
  1829. commit: 4a7ad5552fad70647a81fb9a4a923ccefcca4b76
  1830. Author: Test Author <test@nodomain.com>
  1831. Committer: Test Committer <test@nodomain.com>
  1832. Date: Fri Jan 01 2010 00:00:00 +0000
  1833. """,
  1834. )
  1835. class ShowTests(PorcelainTestCase):
  1836. def test_nolist(self) -> None:
  1837. c1, c2, c3 = build_commit_graph(
  1838. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  1839. )
  1840. self.repo.refs[b"HEAD"] = c3.id
  1841. outstream = StringIO()
  1842. porcelain.show(self.repo.path, objects=c3.id, outstream=outstream)
  1843. self.assertTrue(outstream.getvalue().startswith("-" * 50))
  1844. def test_simple(self) -> None:
  1845. c1, c2, c3 = build_commit_graph(
  1846. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  1847. )
  1848. self.repo.refs[b"HEAD"] = c3.id
  1849. outstream = StringIO()
  1850. porcelain.show(self.repo.path, objects=[c3.id], outstream=outstream)
  1851. self.assertTrue(outstream.getvalue().startswith("-" * 50))
  1852. def test_blob(self) -> None:
  1853. b = Blob.from_string(b"The Foo\n")
  1854. self.repo.object_store.add_object(b)
  1855. outstream = StringIO()
  1856. porcelain.show(self.repo.path, objects=[b.id], outstream=outstream)
  1857. self.assertEqual(outstream.getvalue(), "The Foo\n")
  1858. def test_commit_no_parent(self) -> None:
  1859. a = Blob.from_string(b"The Foo\n")
  1860. ta = Tree()
  1861. ta.add(b"somename", 0o100644, a.id)
  1862. ca = make_commit(tree=ta.id)
  1863. self.repo.object_store.add_objects([(a, None), (ta, None), (ca, None)])
  1864. outstream = StringIO()
  1865. porcelain.show(self.repo.path, objects=[ca.id], outstream=outstream)
  1866. self.assertMultiLineEqual(
  1867. outstream.getvalue(),
  1868. """\
  1869. --------------------------------------------------
  1870. commit: 344da06c1bb85901270b3e8875c988a027ec087d
  1871. Author: Test Author <test@nodomain.com>
  1872. Committer: Test Committer <test@nodomain.com>
  1873. Date: Fri Jan 01 2010 00:00:00 +0000
  1874. Test message.
  1875. diff --git a/somename b/somename
  1876. new file mode 100644
  1877. index 0000000..ea5c7bf
  1878. --- /dev/null
  1879. +++ b/somename
  1880. @@ -0,0 +1 @@
  1881. +The Foo
  1882. """,
  1883. )
  1884. def test_tag(self) -> None:
  1885. a = Blob.from_string(b"The Foo\n")
  1886. ta = Tree()
  1887. ta.add(b"somename", 0o100644, a.id)
  1888. ca = make_commit(tree=ta.id)
  1889. self.repo.object_store.add_objects([(a, None), (ta, None), (ca, None)])
  1890. porcelain.tag_create(
  1891. self.repo.path,
  1892. b"tryme",
  1893. b"foo <foo@bar.com>",
  1894. b"bar",
  1895. annotated=True,
  1896. objectish=ca.id,
  1897. tag_time=1552854211,
  1898. tag_timezone=0,
  1899. )
  1900. outstream = StringIO()
  1901. porcelain.show(self.repo, objects=[b"refs/tags/tryme"], outstream=outstream)
  1902. self.maxDiff = None
  1903. self.assertMultiLineEqual(
  1904. outstream.getvalue(),
  1905. """\
  1906. Tagger: foo <foo@bar.com>
  1907. Date: Sun Mar 17 2019 20:23:31 +0000
  1908. bar
  1909. --------------------------------------------------
  1910. commit: 344da06c1bb85901270b3e8875c988a027ec087d
  1911. Author: Test Author <test@nodomain.com>
  1912. Committer: Test Committer <test@nodomain.com>
  1913. Date: Fri Jan 01 2010 00:00:00 +0000
  1914. Test message.
  1915. diff --git a/somename b/somename
  1916. new file mode 100644
  1917. index 0000000..ea5c7bf
  1918. --- /dev/null
  1919. +++ b/somename
  1920. @@ -0,0 +1 @@
  1921. +The Foo
  1922. """,
  1923. )
  1924. def test_tag_unicode(self) -> None:
  1925. a = Blob.from_string(b"The Foo\n")
  1926. ta = Tree()
  1927. ta.add(b"somename", 0o100644, a.id)
  1928. ca = make_commit(tree=ta.id)
  1929. self.repo.object_store.add_objects([(a, None), (ta, None), (ca, None)])
  1930. porcelain.tag_create(
  1931. self.repo.path,
  1932. "tryme",
  1933. "foo <foo@bar.com>",
  1934. "bar",
  1935. annotated=True,
  1936. objectish=ca.id,
  1937. tag_time=1552854211,
  1938. tag_timezone=0,
  1939. )
  1940. outstream = StringIO()
  1941. porcelain.show(self.repo, objects=[b"refs/tags/tryme"], outstream=outstream)
  1942. self.maxDiff = None
  1943. self.assertMultiLineEqual(
  1944. outstream.getvalue(),
  1945. """\
  1946. Tagger: foo <foo@bar.com>
  1947. Date: Sun Mar 17 2019 20:23:31 +0000
  1948. bar
  1949. --------------------------------------------------
  1950. commit: 344da06c1bb85901270b3e8875c988a027ec087d
  1951. Author: Test Author <test@nodomain.com>
  1952. Committer: Test Committer <test@nodomain.com>
  1953. Date: Fri Jan 01 2010 00:00:00 +0000
  1954. Test message.
  1955. diff --git a/somename b/somename
  1956. new file mode 100644
  1957. index 0000000..ea5c7bf
  1958. --- /dev/null
  1959. +++ b/somename
  1960. @@ -0,0 +1 @@
  1961. +The Foo
  1962. """,
  1963. )
  1964. def test_commit_with_change(self) -> None:
  1965. a = Blob.from_string(b"The Foo\n")
  1966. ta = Tree()
  1967. ta.add(b"somename", 0o100644, a.id)
  1968. ca = make_commit(tree=ta.id)
  1969. b = Blob.from_string(b"The Bar\n")
  1970. tb = Tree()
  1971. tb.add(b"somename", 0o100644, b.id)
  1972. cb = make_commit(tree=tb.id, parents=[ca.id])
  1973. self.repo.object_store.add_objects(
  1974. [
  1975. (a, None),
  1976. (b, None),
  1977. (ta, None),
  1978. (tb, None),
  1979. (ca, None),
  1980. (cb, None),
  1981. ]
  1982. )
  1983. outstream = StringIO()
  1984. porcelain.show(self.repo.path, objects=[cb.id], outstream=outstream)
  1985. self.assertMultiLineEqual(
  1986. outstream.getvalue(),
  1987. """\
  1988. --------------------------------------------------
  1989. commit: 2c6b6c9cb72c130956657e1fdae58e5b103744fa
  1990. Author: Test Author <test@nodomain.com>
  1991. Committer: Test Committer <test@nodomain.com>
  1992. Date: Fri Jan 01 2010 00:00:00 +0000
  1993. Test message.
  1994. diff --git a/somename b/somename
  1995. index ea5c7bf..fd38bcb 100644
  1996. --- a/somename
  1997. +++ b/somename
  1998. @@ -1 +1 @@
  1999. -The Foo
  2000. +The Bar
  2001. """,
  2002. )
  2003. class SymbolicRefTests(PorcelainTestCase):
  2004. def test_set_wrong_symbolic_ref(self) -> None:
  2005. c1, c2, c3 = build_commit_graph(
  2006. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  2007. )
  2008. self.repo.refs[b"HEAD"] = c3.id
  2009. self.assertRaises(
  2010. porcelain.Error, porcelain.symbolic_ref, self.repo.path, b"foobar"
  2011. )
  2012. def test_set_force_wrong_symbolic_ref(self) -> None:
  2013. c1, c2, c3 = build_commit_graph(
  2014. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  2015. )
  2016. self.repo.refs[b"HEAD"] = c3.id
  2017. porcelain.symbolic_ref(self.repo.path, b"force_foobar", force=True)
  2018. # test if we actually changed the file
  2019. with self.repo.get_named_file("HEAD") as f:
  2020. new_ref = f.read()
  2021. self.assertEqual(new_ref, b"ref: refs/heads/force_foobar\n")
  2022. def test_set_symbolic_ref(self) -> None:
  2023. c1, c2, c3 = build_commit_graph(
  2024. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  2025. )
  2026. self.repo.refs[b"HEAD"] = c3.id
  2027. porcelain.symbolic_ref(self.repo.path, b"master")
  2028. def test_set_symbolic_ref_other_than_master(self) -> None:
  2029. c1, c2, c3 = build_commit_graph(
  2030. self.repo.object_store,
  2031. [[1], [2, 1], [3, 1, 2]],
  2032. attrs=dict(refs="develop"),
  2033. )
  2034. self.repo.refs[b"HEAD"] = c3.id
  2035. self.repo.refs[b"refs/heads/develop"] = c3.id
  2036. porcelain.symbolic_ref(self.repo.path, b"develop")
  2037. # test if we actually changed the file
  2038. with self.repo.get_named_file("HEAD") as f:
  2039. new_ref = f.read()
  2040. self.assertEqual(new_ref, b"ref: refs/heads/develop\n")
  2041. class DiffTreeTests(PorcelainTestCase):
  2042. def test_empty(self) -> None:
  2043. c1, c2, c3 = build_commit_graph(
  2044. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  2045. )
  2046. self.repo.refs[b"HEAD"] = c3.id
  2047. outstream = BytesIO()
  2048. porcelain.diff_tree(self.repo.path, c2.tree, c3.tree, outstream=outstream)
  2049. self.assertEqual(outstream.getvalue(), b"")
  2050. class CommitTreeTests(PorcelainTestCase):
  2051. def test_simple(self) -> None:
  2052. c1, c2, c3 = build_commit_graph(
  2053. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  2054. )
  2055. b = Blob()
  2056. b.data = b"foo the bar"
  2057. t = Tree()
  2058. t.add(b"somename", 0o100644, b.id)
  2059. self.repo.object_store.add_object(t)
  2060. self.repo.object_store.add_object(b)
  2061. sha = porcelain.commit_tree(
  2062. self.repo.path,
  2063. t.id,
  2064. message=b"Withcommit.",
  2065. author=b"Joe <joe@example.com>",
  2066. committer=b"Jane <jane@example.com>",
  2067. )
  2068. self.assertIsInstance(sha, bytes)
  2069. self.assertEqual(len(sha), 40)
  2070. class RevListTests(PorcelainTestCase):
  2071. def test_simple(self) -> None:
  2072. c1, c2, c3 = build_commit_graph(
  2073. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  2074. )
  2075. outstream = BytesIO()
  2076. porcelain.rev_list(self.repo.path, [c3.id], outstream=outstream)
  2077. self.assertEqual(
  2078. c3.id + b"\n" + c2.id + b"\n" + c1.id + b"\n", outstream.getvalue()
  2079. )
  2080. @skipIf(
  2081. platform.python_implementation() == "PyPy" or sys.platform == "win32",
  2082. "gpgme not easily available or supported on Windows and PyPy",
  2083. )
  2084. class TagCreateSignTests(PorcelainGpgTestCase):
  2085. def test_default_key(self) -> None:
  2086. c1, c2, c3 = build_commit_graph(
  2087. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  2088. )
  2089. self.repo.refs[b"HEAD"] = c3.id
  2090. cfg = self.repo.get_config()
  2091. cfg.set(("user",), "signingKey", PorcelainGpgTestCase.DEFAULT_KEY_ID)
  2092. self.import_default_key()
  2093. porcelain.tag_create(
  2094. self.repo.path,
  2095. b"tryme",
  2096. b"foo <foo@bar.com>",
  2097. b"bar",
  2098. annotated=True,
  2099. sign=True,
  2100. )
  2101. tags = self.repo.refs.as_dict(b"refs/tags")
  2102. self.assertEqual(list(tags.keys()), [b"tryme"])
  2103. tag = self.repo[b"refs/tags/tryme"]
  2104. self.assertIsInstance(tag, Tag)
  2105. self.assertEqual(b"foo <foo@bar.com>", tag.tagger)
  2106. self.assertEqual(b"bar\n", tag.message)
  2107. self.assertRecentTimestamp(tag.tag_time)
  2108. tag = self.repo[b"refs/tags/tryme"]
  2109. # GPG Signatures aren't deterministic, so we can't do a static assertion.
  2110. tag.verify()
  2111. tag.verify(keyids=[PorcelainGpgTestCase.DEFAULT_KEY_ID])
  2112. self.import_non_default_key()
  2113. self.assertRaises(
  2114. gpg.errors.MissingSignatures,
  2115. tag.verify,
  2116. keyids=[PorcelainGpgTestCase.NON_DEFAULT_KEY_ID],
  2117. )
  2118. tag._chunked_text = [b"bad data", tag._signature]
  2119. self.assertRaises(
  2120. gpg.errors.BadSignatures,
  2121. tag.verify,
  2122. )
  2123. def test_non_default_key(self) -> None:
  2124. c1, c2, c3 = build_commit_graph(
  2125. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  2126. )
  2127. self.repo.refs[b"HEAD"] = c3.id
  2128. cfg = self.repo.get_config()
  2129. cfg.set(("user",), "signingKey", PorcelainGpgTestCase.DEFAULT_KEY_ID)
  2130. self.import_non_default_key()
  2131. porcelain.tag_create(
  2132. self.repo.path,
  2133. b"tryme",
  2134. b"foo <foo@bar.com>",
  2135. b"bar",
  2136. annotated=True,
  2137. sign=PorcelainGpgTestCase.NON_DEFAULT_KEY_ID,
  2138. )
  2139. tags = self.repo.refs.as_dict(b"refs/tags")
  2140. self.assertEqual(list(tags.keys()), [b"tryme"])
  2141. tag = self.repo[b"refs/tags/tryme"]
  2142. self.assertIsInstance(tag, Tag)
  2143. self.assertEqual(b"foo <foo@bar.com>", tag.tagger)
  2144. self.assertEqual(b"bar\n", tag.message)
  2145. self.assertRecentTimestamp(tag.tag_time)
  2146. tag = self.repo[b"refs/tags/tryme"]
  2147. # GPG Signatures aren't deterministic, so we can't do a static assertion.
  2148. tag.verify()
  2149. def test_sign_uses_config_signingkey(self) -> None:
  2150. """Test that sign=True uses user.signingKey from config."""
  2151. c1, c2, c3 = build_commit_graph(
  2152. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  2153. )
  2154. self.repo.refs[b"HEAD"] = c3.id
  2155. # Set up user.signingKey in config
  2156. cfg = self.repo.get_config()
  2157. cfg.set(("user",), "signingKey", PorcelainGpgTestCase.DEFAULT_KEY_ID)
  2158. cfg.write_to_path()
  2159. self.import_default_key()
  2160. # Create tag with sign=True (should use signingKey from config)
  2161. porcelain.tag_create(
  2162. self.repo.path,
  2163. b"signed-tag",
  2164. b"foo <foo@bar.com>",
  2165. b"Tag with configured key",
  2166. annotated=True,
  2167. sign=True, # This should read user.signingKey from config
  2168. )
  2169. tags = self.repo.refs.as_dict(b"refs/tags")
  2170. self.assertEqual(list(tags.keys()), [b"signed-tag"])
  2171. tag = self.repo[b"refs/tags/signed-tag"]
  2172. self.assertIsInstance(tag, Tag)
  2173. # Verify the tag is signed with the configured key
  2174. tag.verify()
  2175. tag.verify(keyids=[PorcelainGpgTestCase.DEFAULT_KEY_ID])
  2176. def test_tag_gpg_sign_config_enabled(self) -> None:
  2177. """Test that tag.gpgSign=true automatically signs tags."""
  2178. c1, c2, c3 = build_commit_graph(
  2179. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  2180. )
  2181. self.repo.refs[b"HEAD"] = c3.id
  2182. # Set up user.signingKey and tag.gpgSign in config
  2183. cfg = self.repo.get_config()
  2184. cfg.set(("user",), "signingKey", PorcelainGpgTestCase.DEFAULT_KEY_ID)
  2185. cfg.set(("tag",), "gpgSign", True)
  2186. cfg.write_to_path()
  2187. self.import_default_key()
  2188. # Create tag without explicit sign parameter (should auto-sign due to config)
  2189. porcelain.tag_create(
  2190. self.repo.path,
  2191. b"auto-signed-tag",
  2192. b"foo <foo@bar.com>",
  2193. b"Auto-signed tag",
  2194. annotated=True,
  2195. # No sign parameter - should use tag.gpgSign config
  2196. )
  2197. tags = self.repo.refs.as_dict(b"refs/tags")
  2198. self.assertEqual(list(tags.keys()), [b"auto-signed-tag"])
  2199. tag = self.repo[b"refs/tags/auto-signed-tag"]
  2200. self.assertIsInstance(tag, Tag)
  2201. # Verify the tag is signed due to config
  2202. tag.verify()
  2203. tag.verify(keyids=[PorcelainGpgTestCase.DEFAULT_KEY_ID])
  2204. def test_tag_gpg_sign_config_disabled(self) -> None:
  2205. """Test that tag.gpgSign=false does not sign tags."""
  2206. c1, c2, c3 = build_commit_graph(
  2207. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  2208. )
  2209. self.repo.refs[b"HEAD"] = c3.id
  2210. # Set up user.signingKey and tag.gpgSign=false in config
  2211. cfg = self.repo.get_config()
  2212. cfg.set(("user",), "signingKey", PorcelainGpgTestCase.DEFAULT_KEY_ID)
  2213. cfg.set(("tag",), "gpgSign", False)
  2214. cfg.write_to_path()
  2215. self.import_default_key()
  2216. # Create tag without explicit sign parameter (should not sign)
  2217. porcelain.tag_create(
  2218. self.repo.path,
  2219. b"unsigned-tag",
  2220. b"foo <foo@bar.com>",
  2221. b"Unsigned tag",
  2222. annotated=True,
  2223. # No sign parameter - should use tag.gpgSign=false config
  2224. )
  2225. tags = self.repo.refs.as_dict(b"refs/tags")
  2226. self.assertEqual(list(tags.keys()), [b"unsigned-tag"])
  2227. tag = self.repo[b"refs/tags/unsigned-tag"]
  2228. self.assertIsInstance(tag, Tag)
  2229. # Verify the tag is not signed
  2230. self.assertIsNone(tag._signature)
  2231. def test_tag_gpg_sign_config_no_signing_key(self) -> None:
  2232. """Test that tag.gpgSign=true works without user.signingKey (uses default)."""
  2233. c1, c2, c3 = build_commit_graph(
  2234. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  2235. )
  2236. self.repo.refs[b"HEAD"] = c3.id
  2237. # Set up tag.gpgSign but no user.signingKey
  2238. cfg = self.repo.get_config()
  2239. cfg.set(("tag",), "gpgSign", True)
  2240. cfg.write_to_path()
  2241. self.import_default_key()
  2242. # Create tag without explicit sign parameter (should auto-sign with default key)
  2243. porcelain.tag_create(
  2244. self.repo.path,
  2245. b"default-signed-tag",
  2246. b"foo <foo@bar.com>",
  2247. b"Default signed tag",
  2248. annotated=True,
  2249. # No sign parameter - should use tag.gpgSign config with default key
  2250. )
  2251. tags = self.repo.refs.as_dict(b"refs/tags")
  2252. self.assertEqual(list(tags.keys()), [b"default-signed-tag"])
  2253. tag = self.repo[b"refs/tags/default-signed-tag"]
  2254. self.assertIsInstance(tag, Tag)
  2255. # Verify the tag is signed with default key
  2256. tag.verify()
  2257. def test_explicit_sign_overrides_config(self) -> None:
  2258. """Test that explicit sign parameter overrides tag.gpgSign config."""
  2259. c1, c2, c3 = build_commit_graph(
  2260. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  2261. )
  2262. self.repo.refs[b"HEAD"] = c3.id
  2263. # Set up tag.gpgSign=false but explicitly pass sign=True
  2264. cfg = self.repo.get_config()
  2265. cfg.set(("user",), "signingKey", PorcelainGpgTestCase.DEFAULT_KEY_ID)
  2266. cfg.set(("tag",), "gpgSign", False)
  2267. cfg.write_to_path()
  2268. self.import_default_key()
  2269. # Create tag with explicit sign=True (should override config)
  2270. porcelain.tag_create(
  2271. self.repo.path,
  2272. b"explicit-signed-tag",
  2273. b"foo <foo@bar.com>",
  2274. b"Explicitly signed tag",
  2275. annotated=True,
  2276. sign=True, # This should override tag.gpgSign=false
  2277. )
  2278. tags = self.repo.refs.as_dict(b"refs/tags")
  2279. self.assertEqual(list(tags.keys()), [b"explicit-signed-tag"])
  2280. tag = self.repo[b"refs/tags/explicit-signed-tag"]
  2281. self.assertIsInstance(tag, Tag)
  2282. # Verify the tag is signed despite config=false
  2283. tag.verify()
  2284. tag.verify(keyids=[PorcelainGpgTestCase.DEFAULT_KEY_ID])
  2285. def test_explicit_false_disables_tag_signing(self) -> None:
  2286. """Test that explicit sign=False disables signing even with config=true."""
  2287. c1, c2, c3 = build_commit_graph(
  2288. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  2289. )
  2290. self.repo.refs[b"HEAD"] = c3.id
  2291. # Set up tag.gpgSign=true but explicitly pass sign=False
  2292. cfg = self.repo.get_config()
  2293. cfg.set(("user",), "signingKey", PorcelainGpgTestCase.DEFAULT_KEY_ID)
  2294. cfg.set(("tag",), "gpgSign", True)
  2295. cfg.write_to_path()
  2296. self.import_default_key()
  2297. # Create tag with explicit sign=False (should disable signing)
  2298. porcelain.tag_create(
  2299. self.repo.path,
  2300. b"explicit-unsigned-tag",
  2301. b"foo <foo@bar.com>",
  2302. b"Explicitly unsigned tag",
  2303. annotated=True,
  2304. sign=False, # This should override tag.gpgSign=true
  2305. )
  2306. tags = self.repo.refs.as_dict(b"refs/tags")
  2307. self.assertEqual(list(tags.keys()), [b"explicit-unsigned-tag"])
  2308. tag = self.repo[b"refs/tags/explicit-unsigned-tag"]
  2309. self.assertIsInstance(tag, Tag)
  2310. # Verify the tag is NOT signed despite config=true
  2311. self.assertIsNone(tag._signature)
  2312. class TagCreateTests(PorcelainTestCase):
  2313. def test_annotated(self) -> None:
  2314. c1, c2, c3 = build_commit_graph(
  2315. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  2316. )
  2317. self.repo.refs[b"HEAD"] = c3.id
  2318. porcelain.tag_create(
  2319. self.repo.path,
  2320. b"tryme",
  2321. b"foo <foo@bar.com>",
  2322. b"bar",
  2323. annotated=True,
  2324. )
  2325. tags = self.repo.refs.as_dict(b"refs/tags")
  2326. self.assertEqual(list(tags.keys()), [b"tryme"])
  2327. tag = self.repo[b"refs/tags/tryme"]
  2328. self.assertIsInstance(tag, Tag)
  2329. self.assertEqual(b"foo <foo@bar.com>", tag.tagger)
  2330. self.assertEqual(b"bar\n", tag.message)
  2331. self.assertRecentTimestamp(tag.tag_time)
  2332. def test_unannotated(self) -> None:
  2333. c1, c2, c3 = build_commit_graph(
  2334. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  2335. )
  2336. self.repo.refs[b"HEAD"] = c3.id
  2337. porcelain.tag_create(self.repo.path, b"tryme", annotated=False)
  2338. tags = self.repo.refs.as_dict(b"refs/tags")
  2339. self.assertEqual(list(tags.keys()), [b"tryme"])
  2340. self.repo[b"refs/tags/tryme"]
  2341. self.assertEqual(list(tags.values()), [self.repo.head()])
  2342. def test_unannotated_unicode(self) -> None:
  2343. c1, c2, c3 = build_commit_graph(
  2344. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  2345. )
  2346. self.repo.refs[b"HEAD"] = c3.id
  2347. porcelain.tag_create(self.repo.path, "tryme", annotated=False)
  2348. tags = self.repo.refs.as_dict(b"refs/tags")
  2349. self.assertEqual(list(tags.keys()), [b"tryme"])
  2350. self.repo[b"refs/tags/tryme"]
  2351. self.assertEqual(list(tags.values()), [self.repo.head()])
  2352. class TagListTests(PorcelainTestCase):
  2353. def test_empty(self) -> None:
  2354. tags = porcelain.tag_list(self.repo.path)
  2355. self.assertEqual([], tags)
  2356. def test_simple(self) -> None:
  2357. self.repo.refs[b"refs/tags/foo"] = b"aa" * 20
  2358. self.repo.refs[b"refs/tags/bar/bla"] = b"bb" * 20
  2359. tags = porcelain.tag_list(self.repo.path)
  2360. self.assertEqual([b"bar/bla", b"foo"], tags)
  2361. class TagDeleteTests(PorcelainTestCase):
  2362. def test_simple(self) -> None:
  2363. [c1] = build_commit_graph(self.repo.object_store, [[1]])
  2364. self.repo[b"HEAD"] = c1.id
  2365. porcelain.tag_create(self.repo, b"foo")
  2366. self.assertIn(b"foo", porcelain.tag_list(self.repo))
  2367. porcelain.tag_delete(self.repo, b"foo")
  2368. self.assertNotIn(b"foo", porcelain.tag_list(self.repo))
  2369. class ResetTests(PorcelainTestCase):
  2370. def test_hard_head(self) -> None:
  2371. fullpath = os.path.join(self.repo.path, "foo")
  2372. with open(fullpath, "w") as f:
  2373. f.write("BAR")
  2374. porcelain.add(self.repo.path, paths=[fullpath])
  2375. porcelain.commit(
  2376. self.repo.path,
  2377. message=b"Some message",
  2378. committer=b"Jane <jane@example.com>",
  2379. author=b"John <john@example.com>",
  2380. )
  2381. with open(os.path.join(self.repo.path, "foo"), "wb") as f:
  2382. f.write(b"OOH")
  2383. porcelain.reset(self.repo, "hard", b"HEAD")
  2384. index = self.repo.open_index()
  2385. changes = list(
  2386. tree_changes(
  2387. self.repo,
  2388. index.commit(self.repo.object_store),
  2389. self.repo[b"HEAD"].tree,
  2390. )
  2391. )
  2392. self.assertEqual([], changes)
  2393. def test_hard_commit(self) -> None:
  2394. fullpath = os.path.join(self.repo.path, "foo")
  2395. with open(fullpath, "w") as f:
  2396. f.write("BAR")
  2397. porcelain.add(self.repo.path, paths=[fullpath])
  2398. sha = porcelain.commit(
  2399. self.repo.path,
  2400. message=b"Some message",
  2401. committer=b"Jane <jane@example.com>",
  2402. author=b"John <john@example.com>",
  2403. )
  2404. with open(fullpath, "wb") as f:
  2405. f.write(b"BAZ")
  2406. porcelain.add(self.repo.path, paths=[fullpath])
  2407. porcelain.commit(
  2408. self.repo.path,
  2409. message=b"Some other message",
  2410. committer=b"Jane <jane@example.com>",
  2411. author=b"John <john@example.com>",
  2412. )
  2413. porcelain.reset(self.repo, "hard", sha)
  2414. index = self.repo.open_index()
  2415. changes = list(
  2416. tree_changes(
  2417. self.repo,
  2418. index.commit(self.repo.object_store),
  2419. self.repo[sha].tree,
  2420. )
  2421. )
  2422. self.assertEqual([], changes)
  2423. def test_hard_commit_short_hash(self) -> None:
  2424. fullpath = os.path.join(self.repo.path, "foo")
  2425. with open(fullpath, "w") as f:
  2426. f.write("BAR")
  2427. porcelain.add(self.repo.path, paths=[fullpath])
  2428. sha = porcelain.commit(
  2429. self.repo.path,
  2430. message=b"Some message",
  2431. committer=b"Jane <jane@example.com>",
  2432. author=b"John <john@example.com>",
  2433. )
  2434. with open(fullpath, "wb") as f:
  2435. f.write(b"BAZ")
  2436. porcelain.add(self.repo.path, paths=[fullpath])
  2437. porcelain.commit(
  2438. self.repo.path,
  2439. message=b"Some other message",
  2440. committer=b"Jane <jane@example.com>",
  2441. author=b"John <john@example.com>",
  2442. )
  2443. # Test with short hash (7 characters)
  2444. short_sha = sha[:7].decode("ascii")
  2445. porcelain.reset(self.repo, "hard", short_sha)
  2446. index = self.repo.open_index()
  2447. changes = list(
  2448. tree_changes(
  2449. self.repo,
  2450. index.commit(self.repo.object_store),
  2451. self.repo[sha].tree,
  2452. )
  2453. )
  2454. self.assertEqual([], changes)
  2455. def test_hard_deletes_untracked_files(self) -> None:
  2456. """Test that reset --hard deletes files that don't exist in target tree."""
  2457. # Create and commit a file
  2458. fullpath = os.path.join(self.repo.path, "foo")
  2459. with open(fullpath, "w") as f:
  2460. f.write("BAR")
  2461. porcelain.add(self.repo.path, paths=[fullpath])
  2462. sha1 = porcelain.commit(
  2463. self.repo.path,
  2464. message=b"First commit",
  2465. committer=b"Jane <jane@example.com>",
  2466. author=b"John <john@example.com>",
  2467. )
  2468. # Create another file and commit
  2469. fullpath2 = os.path.join(self.repo.path, "bar")
  2470. with open(fullpath2, "w") as f:
  2471. f.write("BAZ")
  2472. porcelain.add(self.repo.path, paths=[fullpath2])
  2473. porcelain.commit(
  2474. self.repo.path,
  2475. message=b"Second commit",
  2476. committer=b"Jane <jane@example.com>",
  2477. author=b"John <john@example.com>",
  2478. )
  2479. # Reset hard to first commit - this should delete 'bar'
  2480. porcelain.reset(self.repo, "hard", sha1)
  2481. # Check that 'foo' still exists and 'bar' is deleted
  2482. self.assertTrue(os.path.exists(fullpath))
  2483. self.assertFalse(os.path.exists(fullpath2))
  2484. # Check index matches first commit
  2485. index = self.repo.open_index()
  2486. self.assertIn(b"foo", index)
  2487. self.assertNotIn(b"bar", index)
  2488. def test_hard_deletes_files_in_subdirs(self) -> None:
  2489. """Test that reset --hard deletes files in subdirectories."""
  2490. # Create and commit files in subdirectory
  2491. subdir = os.path.join(self.repo.path, "subdir")
  2492. os.makedirs(subdir)
  2493. file1 = os.path.join(subdir, "file1")
  2494. file2 = os.path.join(subdir, "file2")
  2495. with open(file1, "w") as f:
  2496. f.write("content1")
  2497. with open(file2, "w") as f:
  2498. f.write("content2")
  2499. porcelain.add(self.repo.path, paths=[file1, file2])
  2500. porcelain.commit(
  2501. self.repo.path,
  2502. message=b"First commit",
  2503. committer=b"Jane <jane@example.com>",
  2504. author=b"John <john@example.com>",
  2505. )
  2506. # Remove one file from subdirectory and commit
  2507. porcelain.rm(self.repo.path, paths=[file2])
  2508. sha2 = porcelain.commit(
  2509. self.repo.path,
  2510. message=b"Remove file2",
  2511. committer=b"Jane <jane@example.com>",
  2512. author=b"John <john@example.com>",
  2513. )
  2514. # Create file2 again (untracked)
  2515. with open(file2, "w") as f:
  2516. f.write("new content")
  2517. # Reset to commit that has file2 removed - should delete untracked file2
  2518. porcelain.reset(self.repo, "hard", sha2)
  2519. self.assertTrue(os.path.exists(file1))
  2520. self.assertFalse(os.path.exists(file2))
  2521. def test_hard_reset_to_remote_branch(self) -> None:
  2522. """Test reset --hard to remote branch deletes local files not in remote."""
  2523. # Create a file and commit
  2524. file1 = os.path.join(self.repo.path, "file1")
  2525. with open(file1, "w") as f:
  2526. f.write("content1")
  2527. porcelain.add(self.repo.path, paths=[file1])
  2528. sha1 = porcelain.commit(
  2529. self.repo.path,
  2530. message=b"Initial commit",
  2531. committer=b"Jane <jane@example.com>",
  2532. author=b"John <john@example.com>",
  2533. )
  2534. # Create a "remote" ref that doesn't have additional files
  2535. self.repo.refs[b"refs/remotes/origin/master"] = sha1
  2536. # Add another file locally and commit
  2537. file2 = os.path.join(self.repo.path, "file2")
  2538. with open(file2, "w") as f:
  2539. f.write("content2")
  2540. porcelain.add(self.repo.path, paths=[file2])
  2541. porcelain.commit(
  2542. self.repo.path,
  2543. message=b"Add file2",
  2544. committer=b"Jane <jane@example.com>",
  2545. author=b"John <john@example.com>",
  2546. )
  2547. # Both files should exist
  2548. self.assertTrue(os.path.exists(file1))
  2549. self.assertTrue(os.path.exists(file2))
  2550. # Reset to remote branch - should delete file2
  2551. porcelain.reset(self.repo, "hard", b"refs/remotes/origin/master")
  2552. # file1 should exist, file2 should be deleted
  2553. self.assertTrue(os.path.exists(file1))
  2554. self.assertFalse(os.path.exists(file2))
  2555. def test_mixed_reset(self) -> None:
  2556. # Create initial commit
  2557. fullpath = os.path.join(self.repo.path, "foo")
  2558. with open(fullpath, "w") as f:
  2559. f.write("BAR")
  2560. porcelain.add(self.repo.path, paths=[fullpath])
  2561. first_sha = porcelain.commit(
  2562. self.repo.path,
  2563. message=b"First commit",
  2564. committer=b"Jane <jane@example.com>",
  2565. author=b"John <john@example.com>",
  2566. )
  2567. # Make second commit with modified content
  2568. with open(fullpath, "w") as f:
  2569. f.write("BAZ")
  2570. porcelain.add(self.repo.path, paths=[fullpath])
  2571. porcelain.commit(
  2572. self.repo.path,
  2573. message=b"Second commit",
  2574. committer=b"Jane <jane@example.com>",
  2575. author=b"John <john@example.com>",
  2576. )
  2577. # Modify working tree without staging
  2578. with open(fullpath, "w") as f:
  2579. f.write("MODIFIED")
  2580. # Mixed reset to first commit
  2581. porcelain.reset(self.repo, "mixed", first_sha)
  2582. # Check that HEAD points to first commit
  2583. self.assertEqual(self.repo.head(), first_sha)
  2584. # Check that index matches first commit
  2585. index = self.repo.open_index()
  2586. changes = list(
  2587. tree_changes(
  2588. self.repo,
  2589. index.commit(self.repo.object_store),
  2590. self.repo[first_sha].tree,
  2591. )
  2592. )
  2593. self.assertEqual([], changes)
  2594. # Check that working tree is unchanged (still has "MODIFIED")
  2595. with open(fullpath) as f:
  2596. self.assertEqual(f.read(), "MODIFIED")
  2597. def test_soft_reset(self) -> None:
  2598. # Create initial commit
  2599. fullpath = os.path.join(self.repo.path, "foo")
  2600. with open(fullpath, "w") as f:
  2601. f.write("BAR")
  2602. porcelain.add(self.repo.path, paths=[fullpath])
  2603. first_sha = porcelain.commit(
  2604. self.repo.path,
  2605. message=b"First commit",
  2606. committer=b"Jane <jane@example.com>",
  2607. author=b"John <john@example.com>",
  2608. )
  2609. # Make second commit with modified content
  2610. with open(fullpath, "w") as f:
  2611. f.write("BAZ")
  2612. porcelain.add(self.repo.path, paths=[fullpath])
  2613. porcelain.commit(
  2614. self.repo.path,
  2615. message=b"Second commit",
  2616. committer=b"Jane <jane@example.com>",
  2617. author=b"John <john@example.com>",
  2618. )
  2619. # Stage a new change
  2620. with open(fullpath, "w") as f:
  2621. f.write("STAGED")
  2622. porcelain.add(self.repo.path, paths=[fullpath])
  2623. # Soft reset to first commit
  2624. porcelain.reset(self.repo, "soft", first_sha)
  2625. # Check that HEAD points to first commit
  2626. self.assertEqual(self.repo.head(), first_sha)
  2627. # Check that index still has the staged change (not reset)
  2628. index = self.repo.open_index()
  2629. # The index should still contain the staged content, not the first commit's content
  2630. self.assertIn(b"foo", index)
  2631. # Check that working tree is unchanged
  2632. with open(fullpath) as f:
  2633. self.assertEqual(f.read(), "STAGED")
  2634. class ResetFileTests(PorcelainTestCase):
  2635. def test_reset_modify_file_to_commit(self) -> None:
  2636. file = "foo"
  2637. full_path = os.path.join(self.repo.path, file)
  2638. with open(full_path, "w") as f:
  2639. f.write("hello")
  2640. porcelain.add(self.repo, paths=[full_path])
  2641. sha = porcelain.commit(
  2642. self.repo,
  2643. message=b"unitest",
  2644. committer=b"Jane <jane@example.com>",
  2645. author=b"John <john@example.com>",
  2646. )
  2647. with open(full_path, "a") as f:
  2648. f.write("something new")
  2649. porcelain.reset_file(self.repo, file, target=sha)
  2650. with open(full_path) as f:
  2651. self.assertEqual("hello", f.read())
  2652. def test_reset_remove_file_to_commit(self) -> None:
  2653. file = "foo"
  2654. full_path = os.path.join(self.repo.path, file)
  2655. with open(full_path, "w") as f:
  2656. f.write("hello")
  2657. porcelain.add(self.repo, paths=[full_path])
  2658. sha = porcelain.commit(
  2659. self.repo,
  2660. message=b"unitest",
  2661. committer=b"Jane <jane@example.com>",
  2662. author=b"John <john@example.com>",
  2663. )
  2664. os.remove(full_path)
  2665. porcelain.reset_file(self.repo, file, target=sha)
  2666. with open(full_path) as f:
  2667. self.assertEqual("hello", f.read())
  2668. def test_resetfile_with_dir(self) -> None:
  2669. os.mkdir(os.path.join(self.repo.path, "new_dir"))
  2670. full_path = os.path.join(self.repo.path, "new_dir", "foo")
  2671. with open(full_path, "w") as f:
  2672. f.write("hello")
  2673. porcelain.add(self.repo, paths=[full_path])
  2674. sha = porcelain.commit(
  2675. self.repo,
  2676. message=b"unitest",
  2677. committer=b"Jane <jane@example.com>",
  2678. author=b"John <john@example.com>",
  2679. )
  2680. with open(full_path, "a") as f:
  2681. f.write("something new")
  2682. porcelain.commit(
  2683. self.repo,
  2684. message=b"unitest 2",
  2685. committer=b"Jane <jane@example.com>",
  2686. author=b"John <john@example.com>",
  2687. )
  2688. porcelain.reset_file(self.repo, os.path.join("new_dir", "foo"), target=sha)
  2689. with open(full_path) as f:
  2690. self.assertEqual("hello", f.read())
  2691. def _commit_file_with_content(repo, filename, content):
  2692. file_path = os.path.join(repo.path, filename)
  2693. with open(file_path, "w") as f:
  2694. f.write(content)
  2695. porcelain.add(repo, paths=[file_path])
  2696. sha = porcelain.commit(
  2697. repo,
  2698. message=b"add " + filename.encode(),
  2699. committer=b"Jane <jane@example.com>",
  2700. author=b"John <john@example.com>",
  2701. )
  2702. return sha, file_path
  2703. class RevertTests(PorcelainTestCase):
  2704. def test_revert_simple(self) -> None:
  2705. # Create initial commit
  2706. fullpath = os.path.join(self.repo.path, "foo")
  2707. with open(fullpath, "w") as f:
  2708. f.write("initial content\n")
  2709. porcelain.add(self.repo.path, paths=[fullpath])
  2710. porcelain.commit(
  2711. self.repo.path,
  2712. message=b"Initial commit",
  2713. committer=b"Jane <jane@example.com>",
  2714. author=b"John <john@example.com>",
  2715. )
  2716. # Make a change
  2717. with open(fullpath, "w") as f:
  2718. f.write("modified content\n")
  2719. porcelain.add(self.repo.path, paths=[fullpath])
  2720. change_sha = porcelain.commit(
  2721. self.repo.path,
  2722. message=b"Change content",
  2723. committer=b"Jane <jane@example.com>",
  2724. author=b"John <john@example.com>",
  2725. )
  2726. # Revert the change
  2727. revert_sha = porcelain.revert(self.repo.path, commits=[change_sha])
  2728. # Check the file content is back to initial
  2729. with open(fullpath) as f:
  2730. self.assertEqual("initial content\n", f.read())
  2731. # Check the revert commit message
  2732. revert_commit = self.repo[revert_sha]
  2733. self.assertIn(b'Revert "Change content"', revert_commit.message)
  2734. self.assertIn(change_sha[:7], revert_commit.message)
  2735. def test_revert_multiple(self) -> None:
  2736. # Create initial commit
  2737. fullpath = os.path.join(self.repo.path, "foo")
  2738. with open(fullpath, "w") as f:
  2739. f.write("line1\n")
  2740. porcelain.add(self.repo.path, paths=[fullpath])
  2741. porcelain.commit(
  2742. self.repo.path,
  2743. message=b"Initial commit",
  2744. committer=b"Jane <jane@example.com>",
  2745. author=b"John <john@example.com>",
  2746. )
  2747. # Add line2
  2748. with open(fullpath, "a") as f:
  2749. f.write("line2\n")
  2750. porcelain.add(self.repo.path, paths=[fullpath])
  2751. commit1 = porcelain.commit(
  2752. self.repo.path,
  2753. message=b"Add line2",
  2754. committer=b"Jane <jane@example.com>",
  2755. author=b"John <john@example.com>",
  2756. )
  2757. # Add line3
  2758. with open(fullpath, "a") as f:
  2759. f.write("line3\n")
  2760. porcelain.add(self.repo.path, paths=[fullpath])
  2761. commit2 = porcelain.commit(
  2762. self.repo.path,
  2763. message=b"Add line3",
  2764. committer=b"Jane <jane@example.com>",
  2765. author=b"John <john@example.com>",
  2766. )
  2767. # Revert both commits (in reverse order)
  2768. porcelain.revert(self.repo.path, commits=[commit2, commit1])
  2769. # Check file is back to initial state
  2770. with open(fullpath) as f:
  2771. self.assertEqual("line1\n", f.read())
  2772. def test_revert_no_commit(self) -> None:
  2773. # Create initial commit
  2774. fullpath = os.path.join(self.repo.path, "foo")
  2775. with open(fullpath, "w") as f:
  2776. f.write("initial\n")
  2777. porcelain.add(self.repo.path, paths=[fullpath])
  2778. porcelain.commit(
  2779. self.repo.path,
  2780. message=b"Initial",
  2781. committer=b"Jane <jane@example.com>",
  2782. author=b"John <john@example.com>",
  2783. )
  2784. # Make a change
  2785. with open(fullpath, "w") as f:
  2786. f.write("changed\n")
  2787. porcelain.add(self.repo.path, paths=[fullpath])
  2788. change_sha = porcelain.commit(
  2789. self.repo.path,
  2790. message=b"Change",
  2791. committer=b"Jane <jane@example.com>",
  2792. author=b"John <john@example.com>",
  2793. )
  2794. # Revert with no_commit
  2795. result = porcelain.revert(self.repo.path, commits=[change_sha], no_commit=True)
  2796. # Should return None
  2797. self.assertIsNone(result)
  2798. # File should be reverted
  2799. with open(fullpath) as f:
  2800. self.assertEqual("initial\n", f.read())
  2801. # HEAD should still point to the change commit
  2802. self.assertEqual(self.repo.refs[b"HEAD"], change_sha)
  2803. def test_revert_custom_message(self) -> None:
  2804. # Create commits
  2805. fullpath = os.path.join(self.repo.path, "foo")
  2806. with open(fullpath, "w") as f:
  2807. f.write("initial\n")
  2808. porcelain.add(self.repo.path, paths=[fullpath])
  2809. porcelain.commit(
  2810. self.repo.path,
  2811. message=b"Initial",
  2812. committer=b"Jane <jane@example.com>",
  2813. author=b"John <john@example.com>",
  2814. )
  2815. with open(fullpath, "w") as f:
  2816. f.write("changed\n")
  2817. porcelain.add(self.repo.path, paths=[fullpath])
  2818. change_sha = porcelain.commit(
  2819. self.repo.path,
  2820. message=b"Change",
  2821. committer=b"Jane <jane@example.com>",
  2822. author=b"John <john@example.com>",
  2823. )
  2824. # Revert with custom message
  2825. custom_msg = "Custom revert message"
  2826. revert_sha = porcelain.revert(
  2827. self.repo.path, commits=[change_sha], message=custom_msg
  2828. )
  2829. # Check the message
  2830. revert_commit = self.repo[revert_sha]
  2831. self.assertEqual(custom_msg.encode("utf-8"), revert_commit.message)
  2832. def test_revert_no_parent(self) -> None:
  2833. # Try to revert the initial commit (no parent)
  2834. fullpath = os.path.join(self.repo.path, "foo")
  2835. with open(fullpath, "w") as f:
  2836. f.write("content\n")
  2837. porcelain.add(self.repo.path, paths=[fullpath])
  2838. initial_sha = porcelain.commit(
  2839. self.repo.path,
  2840. message=b"Initial",
  2841. committer=b"Jane <jane@example.com>",
  2842. author=b"John <john@example.com>",
  2843. )
  2844. # Should raise an error
  2845. with self.assertRaises(porcelain.Error) as cm:
  2846. porcelain.revert(self.repo.path, commits=[initial_sha])
  2847. self.assertIn("no parents", str(cm.exception))
  2848. class CheckoutTests(PorcelainTestCase):
  2849. def setUp(self) -> None:
  2850. super().setUp()
  2851. self._sha, self._foo_path = _commit_file_with_content(
  2852. self.repo, "foo", "hello\n"
  2853. )
  2854. porcelain.branch_create(self.repo, "uni")
  2855. def test_checkout_to_existing_branch(self) -> None:
  2856. self.assertEqual(b"master", porcelain.active_branch(self.repo))
  2857. porcelain.checkout(self.repo, b"uni")
  2858. self.assertEqual(b"uni", porcelain.active_branch(self.repo))
  2859. def test_checkout_to_non_existing_branch(self) -> None:
  2860. self.assertEqual(b"master", porcelain.active_branch(self.repo))
  2861. with self.assertRaises(KeyError):
  2862. porcelain.checkout(self.repo, b"bob")
  2863. self.assertEqual(b"master", porcelain.active_branch(self.repo))
  2864. def test_checkout_to_branch_with_modified_files(self) -> None:
  2865. with open(self._foo_path, "a") as f:
  2866. f.write("new message\n")
  2867. porcelain.add(self.repo, paths=[self._foo_path])
  2868. status = list(porcelain.status(self.repo))
  2869. self.assertEqual(
  2870. [{"add": [], "delete": [], "modify": [b"foo"]}, [], []], status
  2871. )
  2872. # The new checkout behavior prevents switching with staged changes
  2873. with self.assertRaises(porcelain.CheckoutError):
  2874. porcelain.checkout(self.repo, b"uni")
  2875. # Should still be on master
  2876. self.assertEqual(b"master", porcelain.active_branch(self.repo))
  2877. # Force checkout should work
  2878. porcelain.checkout(self.repo, b"uni", force=True)
  2879. self.assertEqual(b"uni", porcelain.active_branch(self.repo))
  2880. def test_checkout_with_deleted_files(self) -> None:
  2881. porcelain.remove(self.repo.path, [os.path.join(self.repo.path, "foo")])
  2882. status = list(porcelain.status(self.repo))
  2883. self.assertEqual(
  2884. [{"add": [], "delete": [b"foo"], "modify": []}, [], []], status
  2885. )
  2886. # The new checkout behavior prevents switching with staged deletions
  2887. with self.assertRaises(porcelain.CheckoutError):
  2888. porcelain.checkout(self.repo, b"uni")
  2889. # Should still be on master
  2890. self.assertEqual(b"master", porcelain.active_branch(self.repo))
  2891. # Force checkout should work
  2892. porcelain.checkout(self.repo, b"uni", force=True)
  2893. self.assertEqual(b"uni", porcelain.active_branch(self.repo))
  2894. def test_checkout_to_branch_with_added_files(self) -> None:
  2895. file_path = os.path.join(self.repo.path, "bar")
  2896. with open(file_path, "w") as f:
  2897. f.write("bar content\n")
  2898. porcelain.add(self.repo, paths=[file_path])
  2899. status = list(porcelain.status(self.repo))
  2900. self.assertEqual(
  2901. [{"add": [b"bar"], "delete": [], "modify": []}, [], []], status
  2902. )
  2903. # Both branches have file 'foo' checkout should be fine.
  2904. porcelain.checkout(self.repo, b"uni")
  2905. self.assertEqual(b"uni", porcelain.active_branch(self.repo))
  2906. status = list(porcelain.status(self.repo))
  2907. self.assertEqual(
  2908. [{"add": [b"bar"], "delete": [], "modify": []}, [], []], status
  2909. )
  2910. def test_checkout_to_branch_with_modified_file_not_present(self) -> None:
  2911. # Commit a new file that the other branch doesn't have.
  2912. _, nee_path = _commit_file_with_content(self.repo, "nee", "Good content\n")
  2913. # Modify the file the other branch doesn't have.
  2914. with open(nee_path, "a") as f:
  2915. f.write("bar content\n")
  2916. porcelain.add(self.repo, paths=[nee_path])
  2917. status = list(porcelain.status(self.repo))
  2918. self.assertEqual(
  2919. [{"add": [], "delete": [], "modify": [b"nee"]}, [], []], status
  2920. )
  2921. # The new checkout behavior allows switching if the file doesn't exist in target branch
  2922. # (changes can be preserved)
  2923. porcelain.checkout(self.repo, b"uni")
  2924. self.assertEqual(b"uni", porcelain.active_branch(self.repo))
  2925. # The staged changes are lost and the file is removed from working tree
  2926. # because it doesn't exist in the target branch
  2927. status = list(porcelain.status(self.repo))
  2928. # File 'nee' is gone completely
  2929. self.assertEqual([{"add": [], "delete": [], "modify": []}, [], []], status)
  2930. self.assertFalse(os.path.exists(nee_path))
  2931. def test_checkout_to_branch_with_modified_file_not_present_forced(self) -> None:
  2932. # Commit a new file that the other branch doesn't have.
  2933. _, nee_path = _commit_file_with_content(self.repo, "nee", "Good content\n")
  2934. # Modify the file the other branch doesn't have.
  2935. with open(nee_path, "a") as f:
  2936. f.write("bar content\n")
  2937. porcelain.add(self.repo, paths=[nee_path])
  2938. status = list(porcelain.status(self.repo))
  2939. self.assertEqual(
  2940. [{"add": [], "delete": [], "modify": [b"nee"]}, [], []], status
  2941. )
  2942. # 'uni' branch doesn't have 'nee' and it has been modified, but we force to reset the entire index.
  2943. porcelain.checkout(self.repo, b"uni", force=True)
  2944. self.assertEqual(b"uni", porcelain.active_branch(self.repo))
  2945. status = list(porcelain.status(self.repo))
  2946. self.assertEqual([{"add": [], "delete": [], "modify": []}, [], []], status)
  2947. def test_checkout_to_branch_with_unstaged_files(self) -> None:
  2948. # Edit `foo`.
  2949. with open(self._foo_path, "a") as f:
  2950. f.write("new message")
  2951. status = list(porcelain.status(self.repo))
  2952. self.assertEqual(
  2953. [{"add": [], "delete": [], "modify": []}, [b"foo"], []], status
  2954. )
  2955. # The new checkout behavior prevents switching with unstaged changes
  2956. with self.assertRaises(porcelain.CheckoutError):
  2957. porcelain.checkout(self.repo, b"uni")
  2958. # Should still be on master
  2959. self.assertEqual(b"master", porcelain.active_branch(self.repo))
  2960. # Force checkout should work
  2961. porcelain.checkout(self.repo, b"uni", force=True)
  2962. self.assertEqual(b"uni", porcelain.active_branch(self.repo))
  2963. def test_checkout_to_branch_with_untracked_files(self) -> None:
  2964. with open(os.path.join(self.repo.path, "neu"), "a") as f:
  2965. f.write("new message\n")
  2966. status = list(porcelain.status(self.repo))
  2967. self.assertEqual([{"add": [], "delete": [], "modify": []}, [], ["neu"]], status)
  2968. porcelain.checkout(self.repo, b"uni")
  2969. status = list(porcelain.status(self.repo))
  2970. self.assertEqual([{"add": [], "delete": [], "modify": []}, [], ["neu"]], status)
  2971. def test_checkout_to_branch_with_new_files(self) -> None:
  2972. porcelain.checkout(self.repo, b"uni")
  2973. sub_directory = os.path.join(self.repo.path, "sub1")
  2974. os.mkdir(sub_directory)
  2975. for index in range(5):
  2976. _commit_file_with_content(
  2977. self.repo, "new_file_" + str(index + 1), "Some content\n"
  2978. )
  2979. _commit_file_with_content(
  2980. self.repo,
  2981. os.path.join("sub1", "new_file_" + str(index + 10)),
  2982. "Good content\n",
  2983. )
  2984. status = list(porcelain.status(self.repo))
  2985. self.assertEqual([{"add": [], "delete": [], "modify": []}, [], []], status)
  2986. porcelain.checkout(self.repo, b"master")
  2987. self.assertEqual(b"master", porcelain.active_branch(self.repo))
  2988. status = list(porcelain.status(self.repo))
  2989. self.assertEqual([{"add": [], "delete": [], "modify": []}, [], []], status)
  2990. porcelain.checkout(self.repo, b"uni")
  2991. self.assertEqual(b"uni", porcelain.active_branch(self.repo))
  2992. status = list(porcelain.status(self.repo))
  2993. self.assertEqual([{"add": [], "delete": [], "modify": []}, [], []], status)
  2994. def test_checkout_to_branch_with_file_in_sub_directory(self) -> None:
  2995. sub_directory = os.path.join(self.repo.path, "sub1", "sub2")
  2996. os.makedirs(sub_directory)
  2997. sub_directory_file = os.path.join(sub_directory, "neu")
  2998. with open(sub_directory_file, "w") as f:
  2999. f.write("new message\n")
  3000. porcelain.add(self.repo, paths=[sub_directory_file])
  3001. porcelain.commit(
  3002. self.repo,
  3003. message=b"add " + sub_directory_file.encode(),
  3004. committer=b"Jane <jane@example.com>",
  3005. author=b"John <john@example.com>",
  3006. )
  3007. status = list(porcelain.status(self.repo))
  3008. self.assertEqual([{"add": [], "delete": [], "modify": []}, [], []], status)
  3009. self.assertTrue(os.path.isdir(sub_directory))
  3010. self.assertTrue(os.path.isdir(os.path.dirname(sub_directory)))
  3011. porcelain.checkout(self.repo, b"uni")
  3012. status = list(porcelain.status(self.repo))
  3013. self.assertEqual([{"add": [], "delete": [], "modify": []}, [], []], status)
  3014. self.assertFalse(os.path.isdir(sub_directory))
  3015. self.assertFalse(os.path.isdir(os.path.dirname(sub_directory)))
  3016. porcelain.checkout(self.repo, b"master")
  3017. self.assertTrue(os.path.isdir(sub_directory))
  3018. self.assertTrue(os.path.isdir(os.path.dirname(sub_directory)))
  3019. def test_checkout_to_branch_with_multiple_files_in_sub_directory(self) -> None:
  3020. sub_directory = os.path.join(self.repo.path, "sub1", "sub2")
  3021. os.makedirs(sub_directory)
  3022. sub_directory_file_1 = os.path.join(sub_directory, "neu")
  3023. with open(sub_directory_file_1, "w") as f:
  3024. f.write("new message\n")
  3025. sub_directory_file_2 = os.path.join(sub_directory, "gus")
  3026. with open(sub_directory_file_2, "w") as f:
  3027. f.write("alternative message\n")
  3028. porcelain.add(self.repo, paths=[sub_directory_file_1, sub_directory_file_2])
  3029. porcelain.commit(
  3030. self.repo,
  3031. message=b"add files neu and gus.",
  3032. committer=b"Jane <jane@example.com>",
  3033. author=b"John <john@example.com>",
  3034. )
  3035. status = list(porcelain.status(self.repo))
  3036. self.assertEqual([{"add": [], "delete": [], "modify": []}, [], []], status)
  3037. self.assertTrue(os.path.isdir(sub_directory))
  3038. self.assertTrue(os.path.isdir(os.path.dirname(sub_directory)))
  3039. porcelain.checkout(self.repo, b"uni")
  3040. status = list(porcelain.status(self.repo))
  3041. self.assertEqual([{"add": [], "delete": [], "modify": []}, [], []], status)
  3042. self.assertFalse(os.path.isdir(sub_directory))
  3043. self.assertFalse(os.path.isdir(os.path.dirname(sub_directory)))
  3044. def _commit_something_wrong(self):
  3045. with open(self._foo_path, "a") as f:
  3046. f.write("something wrong")
  3047. porcelain.add(self.repo, paths=[self._foo_path])
  3048. return porcelain.commit(
  3049. self.repo,
  3050. message=b"I may added something wrong",
  3051. committer=b"Jane <jane@example.com>",
  3052. author=b"John <john@example.com>",
  3053. )
  3054. def test_checkout_to_commit_sha(self) -> None:
  3055. self._commit_something_wrong()
  3056. porcelain.checkout(self.repo, self._sha)
  3057. self.assertEqual(self._sha, self.repo.head())
  3058. def test_checkout_to_head(self) -> None:
  3059. new_sha = self._commit_something_wrong()
  3060. porcelain.checkout(self.repo, b"HEAD")
  3061. self.assertEqual(new_sha, self.repo.head())
  3062. def _checkout_remote_branch(self):
  3063. errstream = BytesIO()
  3064. outstream = BytesIO()
  3065. porcelain.commit(
  3066. repo=self.repo.path,
  3067. message=b"init",
  3068. author=b"author <email>",
  3069. committer=b"committer <email>",
  3070. )
  3071. # Setup target repo cloned from temp test repo
  3072. clone_path = tempfile.mkdtemp()
  3073. self.addCleanup(shutil.rmtree, clone_path)
  3074. target_repo = porcelain.clone(
  3075. self.repo.path, target=clone_path, errstream=errstream
  3076. )
  3077. try:
  3078. self.assertEqual(target_repo[b"HEAD"], self.repo[b"HEAD"])
  3079. finally:
  3080. target_repo.close()
  3081. # create a second file to be pushed back to origin
  3082. handle, fullpath = tempfile.mkstemp(dir=clone_path)
  3083. os.close(handle)
  3084. porcelain.add(repo=clone_path, paths=[fullpath])
  3085. porcelain.commit(
  3086. repo=clone_path,
  3087. message=b"push",
  3088. author=b"author <email>",
  3089. committer=b"committer <email>",
  3090. )
  3091. # Setup a non-checked out branch in the remote
  3092. refs_path = b"refs/heads/foo"
  3093. new_id = self.repo[b"HEAD"].id
  3094. self.assertNotEqual(new_id, ZERO_SHA)
  3095. self.repo.refs[refs_path] = new_id
  3096. # Push to the remote
  3097. porcelain.push(
  3098. clone_path,
  3099. "origin",
  3100. b"HEAD:" + refs_path,
  3101. outstream=outstream,
  3102. errstream=errstream,
  3103. )
  3104. self.assertEqual(
  3105. target_repo.refs[b"refs/remotes/origin/foo"],
  3106. target_repo.refs[b"HEAD"],
  3107. )
  3108. # The new checkout behavior treats origin/foo as a ref and creates detached HEAD
  3109. porcelain.checkout(target_repo, b"origin/foo")
  3110. original_id = target_repo[b"HEAD"].id
  3111. uni_id = target_repo[b"refs/remotes/origin/uni"].id
  3112. # Should be in detached HEAD state
  3113. with self.assertRaises((ValueError, IndexError)):
  3114. porcelain.active_branch(target_repo)
  3115. expected_refs = {
  3116. b"HEAD": original_id,
  3117. b"refs/heads/master": original_id,
  3118. # No local foo branch is created anymore
  3119. b"refs/remotes/origin/foo": original_id,
  3120. b"refs/remotes/origin/uni": uni_id,
  3121. b"refs/remotes/origin/HEAD": new_id,
  3122. b"refs/remotes/origin/master": new_id,
  3123. }
  3124. self.assertEqual(expected_refs, target_repo.get_refs())
  3125. return target_repo
  3126. def test_checkout_remote_branch(self) -> None:
  3127. repo = self._checkout_remote_branch()
  3128. repo.close()
  3129. def test_checkout_remote_branch_then_master_then_remote_branch_again(self) -> None:
  3130. target_repo = self._checkout_remote_branch()
  3131. # Should be in detached HEAD state
  3132. with self.assertRaises((ValueError, IndexError)):
  3133. porcelain.active_branch(target_repo)
  3134. # Save the commit SHA before adding bar
  3135. detached_commit_sha, _ = _commit_file_with_content(
  3136. target_repo, "bar", "something\n"
  3137. )
  3138. self.assertTrue(os.path.isfile(os.path.join(target_repo.path, "bar")))
  3139. porcelain.checkout(target_repo, b"master")
  3140. self.assertEqual(b"master", porcelain.active_branch(target_repo))
  3141. self.assertFalse(os.path.isfile(os.path.join(target_repo.path, "bar")))
  3142. # Going back to origin/foo won't have bar because the commit was made in detached state
  3143. porcelain.checkout(target_repo, b"origin/foo")
  3144. # Should be in detached HEAD state again
  3145. with self.assertRaises((ValueError, IndexError)):
  3146. porcelain.active_branch(target_repo)
  3147. # bar is NOT there because we're back at the original origin/foo commit
  3148. self.assertFalse(os.path.isfile(os.path.join(target_repo.path, "bar")))
  3149. # But we can checkout the specific commit to get bar back
  3150. porcelain.checkout(target_repo, detached_commit_sha.decode())
  3151. self.assertTrue(os.path.isfile(os.path.join(target_repo.path, "bar")))
  3152. target_repo.close()
  3153. def test_checkout_new_branch_from_remote_sets_tracking(self) -> None:
  3154. # Create a "remote" repository
  3155. remote_path = tempfile.mkdtemp()
  3156. self.addCleanup(shutil.rmtree, remote_path)
  3157. remote_repo = porcelain.init(remote_path)
  3158. # Add a commit to the remote
  3159. remote_sha, _ = _commit_file_with_content(
  3160. remote_repo, "bar", "remote content\n"
  3161. )
  3162. # Clone the remote repository
  3163. target_path = tempfile.mkdtemp()
  3164. self.addCleanup(shutil.rmtree, target_path)
  3165. target_repo = porcelain.clone(remote_path, target_path)
  3166. # Create a remote tracking branch reference
  3167. remote_branch_ref = b"refs/remotes/origin/feature"
  3168. target_repo.refs[remote_branch_ref] = remote_sha
  3169. # Checkout a new branch from the remote branch
  3170. porcelain.checkout(target_repo, remote_branch_ref, new_branch=b"local-feature")
  3171. # Verify the branch was created and is active
  3172. self.assertEqual(b"local-feature", porcelain.active_branch(target_repo))
  3173. # Verify tracking configuration was set
  3174. config = target_repo.get_config()
  3175. self.assertEqual(
  3176. b"origin", config.get((b"branch", b"local-feature"), b"remote")
  3177. )
  3178. self.assertEqual(
  3179. b"refs/heads/feature", config.get((b"branch", b"local-feature"), b"merge")
  3180. )
  3181. target_repo.close()
  3182. remote_repo.close()
  3183. class GeneralCheckoutTests(PorcelainTestCase):
  3184. """Tests for the general checkout function that handles branches, tags, and commits."""
  3185. def setUp(self) -> None:
  3186. super().setUp()
  3187. # Create initial commit
  3188. self._sha1, self._foo_path = _commit_file_with_content(
  3189. self.repo, "foo", "initial content\n"
  3190. )
  3191. # Create a branch
  3192. porcelain.branch_create(self.repo, "feature")
  3193. # Create another commit on master
  3194. self._sha2, self._bar_path = _commit_file_with_content(
  3195. self.repo, "bar", "bar content\n"
  3196. )
  3197. # Create a tag
  3198. porcelain.tag_create(self.repo, "v1.0", objectish=self._sha1)
  3199. def test_checkout_branch(self) -> None:
  3200. """Test checking out a branch."""
  3201. self.assertEqual(b"master", porcelain.active_branch(self.repo))
  3202. # Checkout feature branch
  3203. porcelain.checkout(self.repo, "feature")
  3204. self.assertEqual(b"feature", porcelain.active_branch(self.repo))
  3205. # File 'bar' should not exist in feature branch
  3206. self.assertFalse(os.path.exists(self._bar_path))
  3207. # Go back to master
  3208. porcelain.checkout(self.repo, "master")
  3209. self.assertEqual(b"master", porcelain.active_branch(self.repo))
  3210. # File 'bar' should exist again
  3211. self.assertTrue(os.path.exists(self._bar_path))
  3212. def test_checkout_commit(self) -> None:
  3213. """Test checking out a specific commit (detached HEAD)."""
  3214. # Checkout first commit by SHA
  3215. porcelain.checkout(self.repo, self._sha1.decode("ascii"))
  3216. # Should be in detached HEAD state - active_branch raises IndexError
  3217. with self.assertRaises((ValueError, IndexError)):
  3218. porcelain.active_branch(self.repo)
  3219. # File 'bar' should not exist
  3220. self.assertFalse(os.path.exists(self._bar_path))
  3221. # HEAD should point to the commit
  3222. self.assertEqual(self._sha1, self.repo.refs[b"HEAD"])
  3223. def test_checkout_tag(self) -> None:
  3224. """Test checking out a tag (detached HEAD)."""
  3225. # Checkout tag
  3226. porcelain.checkout(self.repo, "v1.0")
  3227. # Should be in detached HEAD state - active_branch raises IndexError
  3228. with self.assertRaises((ValueError, IndexError)):
  3229. porcelain.active_branch(self.repo)
  3230. # File 'bar' should not exist (tag points to first commit)
  3231. self.assertFalse(os.path.exists(self._bar_path))
  3232. # HEAD should point to the tagged commit
  3233. self.assertEqual(self._sha1, self.repo.refs[b"HEAD"])
  3234. def test_checkout_new_branch(self) -> None:
  3235. """Test creating a new branch during checkout (like git checkout -b)."""
  3236. # Create and checkout new branch from current HEAD
  3237. porcelain.checkout(self.repo, "master", new_branch="new-feature")
  3238. self.assertEqual(b"new-feature", porcelain.active_branch(self.repo))
  3239. self.assertTrue(os.path.exists(self._bar_path))
  3240. # Create and checkout new branch from specific commit
  3241. porcelain.checkout(self.repo, self._sha1.decode("ascii"), new_branch="from-old")
  3242. self.assertEqual(b"from-old", porcelain.active_branch(self.repo))
  3243. self.assertFalse(os.path.exists(self._bar_path))
  3244. def test_checkout_with_uncommitted_changes(self) -> None:
  3245. """Test checkout behavior with uncommitted changes."""
  3246. # Modify a file
  3247. with open(self._foo_path, "w") as f:
  3248. f.write("modified content\n")
  3249. # Should raise error when trying to checkout
  3250. with self.assertRaises(porcelain.CheckoutError) as cm:
  3251. porcelain.checkout(self.repo, "feature")
  3252. self.assertIn("local changes", str(cm.exception))
  3253. self.assertIn("foo", str(cm.exception))
  3254. # Should still be on master
  3255. self.assertEqual(b"master", porcelain.active_branch(self.repo))
  3256. def test_checkout_force(self) -> None:
  3257. """Test forced checkout discards local changes."""
  3258. # Modify a file
  3259. with open(self._foo_path, "w") as f:
  3260. f.write("modified content\n")
  3261. # Force checkout should succeed
  3262. porcelain.checkout(self.repo, "feature", force=True)
  3263. self.assertEqual(b"feature", porcelain.active_branch(self.repo))
  3264. # Local changes should be discarded
  3265. with open(self._foo_path) as f:
  3266. content = f.read()
  3267. self.assertEqual("initial content\n", content)
  3268. def test_checkout_nonexistent_ref(self) -> None:
  3269. """Test checkout of non-existent branch/commit."""
  3270. with self.assertRaises(KeyError):
  3271. porcelain.checkout(self.repo, "nonexistent")
  3272. def test_checkout_partial_sha(self) -> None:
  3273. """Test checkout with partial SHA."""
  3274. # Git typically allows checkout with partial SHA
  3275. partial_sha = self._sha1.decode("ascii")[:7]
  3276. porcelain.checkout(self.repo, partial_sha)
  3277. # Should be in detached HEAD state at the right commit
  3278. self.assertEqual(self._sha1, self.repo.refs[b"HEAD"])
  3279. def test_checkout_preserves_untracked_files(self) -> None:
  3280. """Test that checkout preserves untracked files."""
  3281. # Create an untracked file
  3282. untracked_path = os.path.join(self.repo.path, "untracked.txt")
  3283. with open(untracked_path, "w") as f:
  3284. f.write("untracked content\n")
  3285. # Checkout another branch
  3286. porcelain.checkout(self.repo, "feature")
  3287. # Untracked file should still exist
  3288. self.assertTrue(os.path.exists(untracked_path))
  3289. with open(untracked_path) as f:
  3290. content = f.read()
  3291. self.assertEqual("untracked content\n", content)
  3292. def test_checkout_full_ref_paths(self) -> None:
  3293. """Test checkout with full ref paths."""
  3294. # Test checkout with full branch ref path
  3295. porcelain.checkout(self.repo, "refs/heads/feature")
  3296. self.assertEqual(b"feature", porcelain.active_branch(self.repo))
  3297. # Test checkout with full tag ref path
  3298. porcelain.checkout(self.repo, "refs/tags/v1.0")
  3299. # Should be in detached HEAD state
  3300. with self.assertRaises((ValueError, IndexError)):
  3301. porcelain.active_branch(self.repo)
  3302. self.assertEqual(self._sha1, self.repo.refs[b"HEAD"])
  3303. def test_checkout_bytes_vs_string_target(self) -> None:
  3304. """Test that checkout works with both bytes and string targets."""
  3305. # Test with string target
  3306. porcelain.checkout(self.repo, "feature")
  3307. self.assertEqual(b"feature", porcelain.active_branch(self.repo))
  3308. # Test with bytes target
  3309. porcelain.checkout(self.repo, b"master")
  3310. self.assertEqual(b"master", porcelain.active_branch(self.repo))
  3311. def test_checkout_new_branch_from_commit(self) -> None:
  3312. """Test creating a new branch from a specific commit."""
  3313. # Create new branch from first commit
  3314. porcelain.checkout(self.repo, self._sha1.decode(), new_branch="from-commit")
  3315. self.assertEqual(b"from-commit", porcelain.active_branch(self.repo))
  3316. # Should be at the first commit (no bar file)
  3317. self.assertFalse(os.path.exists(self._bar_path))
  3318. def test_checkout_with_staged_addition(self) -> None:
  3319. """Test checkout behavior with staged file additions."""
  3320. # Create and stage a new file that doesn't exist in target branch
  3321. new_file_path = os.path.join(self.repo.path, "new.txt")
  3322. with open(new_file_path, "w") as f:
  3323. f.write("new file content\n")
  3324. porcelain.add(self.repo, [new_file_path])
  3325. # This should succeed because the file doesn't exist in target branch
  3326. porcelain.checkout(self.repo, "feature")
  3327. # Should be on feature branch
  3328. self.assertEqual(b"feature", porcelain.active_branch(self.repo))
  3329. # The new file should still exist and be staged
  3330. self.assertTrue(os.path.exists(new_file_path))
  3331. status = porcelain.status(self.repo)
  3332. self.assertIn(b"new.txt", status.staged["add"])
  3333. def test_checkout_with_staged_modification_conflict(self) -> None:
  3334. """Test checkout behavior with staged modifications that would conflict."""
  3335. # Stage changes to a file that exists in both branches
  3336. with open(self._foo_path, "w") as f:
  3337. f.write("modified content\n")
  3338. porcelain.add(self.repo, [self._foo_path])
  3339. # Should prevent checkout due to staged changes to existing file
  3340. with self.assertRaises(porcelain.CheckoutError) as cm:
  3341. porcelain.checkout(self.repo, "feature")
  3342. self.assertIn("local changes", str(cm.exception))
  3343. self.assertIn("foo", str(cm.exception))
  3344. def test_checkout_head_reference(self) -> None:
  3345. """Test checkout of HEAD reference."""
  3346. # Move to feature branch first
  3347. porcelain.checkout(self.repo, "feature")
  3348. # Checkout HEAD creates detached HEAD state
  3349. porcelain.checkout(self.repo, "HEAD")
  3350. # Should be in detached HEAD state
  3351. with self.assertRaises((ValueError, IndexError)):
  3352. porcelain.active_branch(self.repo)
  3353. def test_checkout_error_messages(self) -> None:
  3354. """Test that checkout error messages are helpful."""
  3355. # Create uncommitted changes
  3356. with open(self._foo_path, "w") as f:
  3357. f.write("uncommitted changes\n")
  3358. # Try to checkout
  3359. with self.assertRaises(porcelain.CheckoutError) as cm:
  3360. porcelain.checkout(self.repo, "feature")
  3361. error_msg = str(cm.exception)
  3362. self.assertIn("local changes", error_msg)
  3363. self.assertIn("foo", error_msg)
  3364. self.assertIn("overwritten", error_msg)
  3365. self.assertIn("commit or stash", error_msg)
  3366. class SubmoduleTests(PorcelainTestCase):
  3367. def test_empty(self) -> None:
  3368. porcelain.commit(
  3369. repo=self.repo.path,
  3370. message=b"init",
  3371. author=b"author <email>",
  3372. committer=b"committer <email>",
  3373. )
  3374. self.assertEqual([], list(porcelain.submodule_list(self.repo)))
  3375. def test_add(self) -> None:
  3376. porcelain.submodule_add(self.repo, "../bar.git", "bar")
  3377. with open(f"{self.repo.path}/.gitmodules") as f:
  3378. self.assertEqual(
  3379. """\
  3380. [submodule "bar"]
  3381. \turl = ../bar.git
  3382. \tpath = bar
  3383. """,
  3384. f.read(),
  3385. )
  3386. def test_init(self) -> None:
  3387. porcelain.submodule_add(self.repo, "../bar.git", "bar")
  3388. porcelain.submodule_init(self.repo)
  3389. def test_update(self) -> None:
  3390. # Create a submodule repository
  3391. sub_repo_path = tempfile.mkdtemp()
  3392. self.addCleanup(shutil.rmtree, sub_repo_path)
  3393. sub_repo = Repo.init(sub_repo_path)
  3394. self.addCleanup(sub_repo.close)
  3395. # Add a file to the submodule repo
  3396. sub_file = os.path.join(sub_repo_path, "test.txt")
  3397. with open(sub_file, "w") as f:
  3398. f.write("submodule content")
  3399. porcelain.add(sub_repo, paths=[sub_file])
  3400. sub_commit = porcelain.commit(
  3401. sub_repo,
  3402. message=b"Initial submodule commit",
  3403. author=b"Test Author <test@example.com>",
  3404. committer=b"Test Committer <test@example.com>",
  3405. )
  3406. # Add the submodule to the main repository
  3407. porcelain.submodule_add(self.repo, sub_repo_path, "test_submodule")
  3408. # Manually add the submodule to the index
  3409. from dulwich.index import IndexEntry
  3410. from dulwich.objects import S_IFGITLINK
  3411. index = self.repo.open_index()
  3412. index[b"test_submodule"] = IndexEntry(
  3413. ctime=0,
  3414. mtime=0,
  3415. dev=0,
  3416. ino=0,
  3417. mode=S_IFGITLINK,
  3418. uid=0,
  3419. gid=0,
  3420. size=0,
  3421. sha=sub_commit,
  3422. flags=0,
  3423. )
  3424. index.write()
  3425. porcelain.add(self.repo, paths=[".gitmodules"])
  3426. porcelain.commit(
  3427. self.repo,
  3428. message=b"Add submodule",
  3429. author=b"Test Author <test@example.com>",
  3430. committer=b"Test Committer <test@example.com>",
  3431. )
  3432. # Initialize and update the submodule
  3433. porcelain.submodule_init(self.repo)
  3434. porcelain.submodule_update(self.repo)
  3435. # Check that the submodule directory exists
  3436. submodule_path = os.path.join(self.repo.path, "test_submodule")
  3437. self.assertTrue(os.path.exists(submodule_path))
  3438. # Check that the submodule file exists
  3439. submodule_file = os.path.join(submodule_path, "test.txt")
  3440. self.assertTrue(os.path.exists(submodule_file))
  3441. with open(submodule_file) as f:
  3442. self.assertEqual(f.read(), "submodule content")
  3443. class PushTests(PorcelainTestCase):
  3444. def test_simple(self) -> None:
  3445. """Basic test of porcelain push where self.repo is the remote. First
  3446. clone the remote, commit a file to the clone, then push the changes
  3447. back to the remote.
  3448. """
  3449. outstream = BytesIO()
  3450. errstream = BytesIO()
  3451. porcelain.commit(
  3452. repo=self.repo.path,
  3453. message=b"init",
  3454. author=b"author <email>",
  3455. committer=b"committer <email>",
  3456. )
  3457. # Setup target repo cloned from temp test repo
  3458. clone_path = tempfile.mkdtemp()
  3459. self.addCleanup(shutil.rmtree, clone_path)
  3460. target_repo = porcelain.clone(
  3461. self.repo.path, target=clone_path, errstream=errstream
  3462. )
  3463. try:
  3464. self.assertEqual(target_repo[b"HEAD"], self.repo[b"HEAD"])
  3465. finally:
  3466. target_repo.close()
  3467. # create a second file to be pushed back to origin
  3468. handle, fullpath = tempfile.mkstemp(dir=clone_path)
  3469. os.close(handle)
  3470. porcelain.add(repo=clone_path, paths=[fullpath])
  3471. porcelain.commit(
  3472. repo=clone_path,
  3473. message=b"push",
  3474. author=b"author <email>",
  3475. committer=b"committer <email>",
  3476. )
  3477. # Setup a non-checked out branch in the remote
  3478. refs_path = b"refs/heads/foo"
  3479. new_id = self.repo[b"HEAD"].id
  3480. self.assertNotEqual(new_id, ZERO_SHA)
  3481. self.repo.refs[refs_path] = new_id
  3482. # Push to the remote
  3483. porcelain.push(
  3484. clone_path,
  3485. "origin",
  3486. b"HEAD:" + refs_path,
  3487. outstream=outstream,
  3488. errstream=errstream,
  3489. )
  3490. self.assertEqual(
  3491. target_repo.refs[b"refs/remotes/origin/foo"],
  3492. target_repo.refs[b"HEAD"],
  3493. )
  3494. # Check that the target and source
  3495. with Repo(clone_path) as r_clone:
  3496. self.assertEqual(
  3497. {
  3498. b"HEAD": new_id,
  3499. b"refs/heads/foo": r_clone[b"HEAD"].id,
  3500. b"refs/heads/master": new_id,
  3501. },
  3502. self.repo.get_refs(),
  3503. )
  3504. self.assertEqual(r_clone[b"HEAD"].id, self.repo[refs_path].id)
  3505. # Get the change in the target repo corresponding to the add
  3506. # this will be in the foo branch.
  3507. change = next(
  3508. iter(
  3509. tree_changes(
  3510. self.repo,
  3511. self.repo[b"HEAD"].tree,
  3512. self.repo[b"refs/heads/foo"].tree,
  3513. )
  3514. )
  3515. )
  3516. self.assertEqual(
  3517. os.path.basename(fullpath), change.new.path.decode("ascii")
  3518. )
  3519. def test_local_missing(self) -> None:
  3520. """Pushing a new branch."""
  3521. outstream = BytesIO()
  3522. errstream = BytesIO()
  3523. # Setup target repo cloned from temp test repo
  3524. clone_path = tempfile.mkdtemp()
  3525. self.addCleanup(shutil.rmtree, clone_path)
  3526. target_repo = porcelain.init(clone_path)
  3527. target_repo.close()
  3528. self.assertRaises(
  3529. porcelain.Error,
  3530. porcelain.push,
  3531. self.repo,
  3532. clone_path,
  3533. b"HEAD:refs/heads/master",
  3534. outstream=outstream,
  3535. errstream=errstream,
  3536. )
  3537. def test_new(self) -> None:
  3538. """Pushing a new branch."""
  3539. outstream = BytesIO()
  3540. errstream = BytesIO()
  3541. # Setup target repo cloned from temp test repo
  3542. clone_path = tempfile.mkdtemp()
  3543. self.addCleanup(shutil.rmtree, clone_path)
  3544. target_repo = porcelain.init(clone_path)
  3545. target_repo.close()
  3546. # create a second file to be pushed back to origin
  3547. handle, fullpath = tempfile.mkstemp(dir=clone_path)
  3548. os.close(handle)
  3549. porcelain.add(repo=clone_path, paths=[fullpath])
  3550. new_id = porcelain.commit(
  3551. repo=self.repo,
  3552. message=b"push",
  3553. author=b"author <email>",
  3554. committer=b"committer <email>",
  3555. )
  3556. # Push to the remote
  3557. porcelain.push(
  3558. self.repo,
  3559. clone_path,
  3560. b"HEAD:refs/heads/master",
  3561. outstream=outstream,
  3562. errstream=errstream,
  3563. )
  3564. with Repo(clone_path) as r_clone:
  3565. self.assertEqual(
  3566. {
  3567. b"HEAD": new_id,
  3568. b"refs/heads/master": new_id,
  3569. },
  3570. r_clone.get_refs(),
  3571. )
  3572. def test_delete(self) -> None:
  3573. """Basic test of porcelain push, removing a branch."""
  3574. outstream = BytesIO()
  3575. errstream = BytesIO()
  3576. porcelain.commit(
  3577. repo=self.repo.path,
  3578. message=b"init",
  3579. author=b"author <email>",
  3580. committer=b"committer <email>",
  3581. )
  3582. # Setup target repo cloned from temp test repo
  3583. clone_path = tempfile.mkdtemp()
  3584. self.addCleanup(shutil.rmtree, clone_path)
  3585. target_repo = porcelain.clone(
  3586. self.repo.path, target=clone_path, errstream=errstream
  3587. )
  3588. target_repo.close()
  3589. # Setup a non-checked out branch in the remote
  3590. refs_path = b"refs/heads/foo"
  3591. new_id = self.repo[b"HEAD"].id
  3592. self.assertNotEqual(new_id, ZERO_SHA)
  3593. self.repo.refs[refs_path] = new_id
  3594. # Push to the remote
  3595. porcelain.push(
  3596. clone_path,
  3597. self.repo.path,
  3598. b":" + refs_path,
  3599. outstream=outstream,
  3600. errstream=errstream,
  3601. )
  3602. self.assertEqual(
  3603. {
  3604. b"HEAD": new_id,
  3605. b"refs/heads/master": new_id,
  3606. },
  3607. self.repo.get_refs(),
  3608. )
  3609. def test_diverged(self) -> None:
  3610. outstream = BytesIO()
  3611. errstream = BytesIO()
  3612. porcelain.commit(
  3613. repo=self.repo.path,
  3614. message=b"init",
  3615. author=b"author <email>",
  3616. committer=b"committer <email>",
  3617. )
  3618. # Setup target repo cloned from temp test repo
  3619. clone_path = tempfile.mkdtemp()
  3620. self.addCleanup(shutil.rmtree, clone_path)
  3621. target_repo = porcelain.clone(
  3622. self.repo.path, target=clone_path, errstream=errstream
  3623. )
  3624. target_repo.close()
  3625. remote_id = porcelain.commit(
  3626. repo=self.repo.path,
  3627. message=b"remote change",
  3628. author=b"author <email>",
  3629. committer=b"committer <email>",
  3630. )
  3631. local_id = porcelain.commit(
  3632. repo=clone_path,
  3633. message=b"local change",
  3634. author=b"author <email>",
  3635. committer=b"committer <email>",
  3636. )
  3637. outstream = BytesIO()
  3638. errstream = BytesIO()
  3639. # Push to the remote
  3640. self.assertRaises(
  3641. porcelain.DivergedBranches,
  3642. porcelain.push,
  3643. clone_path,
  3644. self.repo.path,
  3645. b"refs/heads/master",
  3646. outstream=outstream,
  3647. errstream=errstream,
  3648. )
  3649. self.assertEqual(
  3650. {
  3651. b"HEAD": remote_id,
  3652. b"refs/heads/master": remote_id,
  3653. },
  3654. self.repo.get_refs(),
  3655. )
  3656. self.assertEqual(b"", outstream.getvalue())
  3657. self.assertEqual(b"", errstream.getvalue())
  3658. outstream = BytesIO()
  3659. errstream = BytesIO()
  3660. # Push to the remote with --force
  3661. porcelain.push(
  3662. clone_path,
  3663. self.repo.path,
  3664. b"refs/heads/master",
  3665. outstream=outstream,
  3666. errstream=errstream,
  3667. force=True,
  3668. )
  3669. self.assertEqual(
  3670. {
  3671. b"HEAD": local_id,
  3672. b"refs/heads/master": local_id,
  3673. },
  3674. self.repo.get_refs(),
  3675. )
  3676. self.assertEqual(b"", outstream.getvalue())
  3677. self.assertTrue(re.match(b"Push to .* successful.\n", errstream.getvalue()))
  3678. def test_push_returns_sendpackresult(self) -> None:
  3679. """Test that push returns a SendPackResult with per-ref information."""
  3680. outstream = BytesIO()
  3681. errstream = BytesIO()
  3682. # Create initial commit
  3683. porcelain.commit(
  3684. repo=self.repo.path,
  3685. message=b"init",
  3686. author=b"author <email>",
  3687. committer=b"committer <email>",
  3688. )
  3689. # Setup target repo cloned from temp test repo
  3690. clone_path = tempfile.mkdtemp()
  3691. self.addCleanup(shutil.rmtree, clone_path)
  3692. target_repo = porcelain.clone(
  3693. self.repo.path, target=clone_path, errstream=errstream
  3694. )
  3695. target_repo.close()
  3696. # Create a commit in the clone
  3697. handle, fullpath = tempfile.mkstemp(dir=clone_path)
  3698. os.close(handle)
  3699. porcelain.add(repo=clone_path, paths=[fullpath])
  3700. porcelain.commit(
  3701. repo=clone_path,
  3702. message=b"push",
  3703. author=b"author <email>",
  3704. committer=b"committer <email>",
  3705. )
  3706. # Push and check the return value
  3707. result = porcelain.push(
  3708. clone_path,
  3709. "origin",
  3710. b"HEAD:refs/heads/new-branch",
  3711. outstream=outstream,
  3712. errstream=errstream,
  3713. )
  3714. # Verify that we get a SendPackResult
  3715. self.assertIsInstance(result, SendPackResult)
  3716. # Verify that it contains refs
  3717. self.assertIsNotNone(result.refs)
  3718. self.assertIn(b"refs/heads/new-branch", result.refs)
  3719. # Verify ref_status - should be None for successful updates
  3720. if result.ref_status:
  3721. self.assertIsNone(result.ref_status.get(b"refs/heads/new-branch"))
  3722. def test_mirror_mode(self) -> None:
  3723. """Test push with remote.<name>.mirror configuration."""
  3724. outstream = BytesIO()
  3725. errstream = BytesIO()
  3726. # Create initial commit
  3727. porcelain.commit(
  3728. repo=self.repo.path,
  3729. message=b"init",
  3730. author=b"author <email>",
  3731. committer=b"committer <email>",
  3732. )
  3733. # Setup target repo cloned from temp test repo
  3734. clone_path = tempfile.mkdtemp()
  3735. self.addCleanup(shutil.rmtree, clone_path)
  3736. target_repo = porcelain.clone(
  3737. self.repo.path, target=clone_path, errstream=errstream
  3738. )
  3739. target_repo.close()
  3740. # Create multiple refs in the clone
  3741. with Repo(clone_path) as r_clone:
  3742. # Create a new branch
  3743. r_clone.refs[b"refs/heads/feature"] = r_clone[b"HEAD"].id
  3744. # Create a tag
  3745. r_clone.refs[b"refs/tags/v1.0"] = r_clone[b"HEAD"].id
  3746. # Create a remote tracking branch
  3747. r_clone.refs[b"refs/remotes/upstream/main"] = r_clone[b"HEAD"].id
  3748. # Create a branch in the remote that doesn't exist in clone
  3749. self.repo.refs[b"refs/heads/to-be-deleted"] = self.repo[b"HEAD"].id
  3750. # Configure mirror mode
  3751. with Repo(clone_path) as r_clone:
  3752. config = r_clone.get_config()
  3753. config.set((b"remote", b"origin"), b"mirror", True)
  3754. config.write_to_path()
  3755. # Push with mirror mode
  3756. porcelain.push(
  3757. clone_path,
  3758. "origin",
  3759. outstream=outstream,
  3760. errstream=errstream,
  3761. )
  3762. # Verify refs were properly mirrored
  3763. with Repo(clone_path) as r_clone:
  3764. # All local branches should be pushed
  3765. self.assertEqual(
  3766. r_clone.refs[b"refs/heads/feature"],
  3767. self.repo.refs[b"refs/heads/feature"],
  3768. )
  3769. # All tags should be pushed
  3770. self.assertEqual(
  3771. r_clone.refs[b"refs/tags/v1.0"], self.repo.refs[b"refs/tags/v1.0"]
  3772. )
  3773. # Remote tracking branches should be pushed
  3774. self.assertEqual(
  3775. r_clone.refs[b"refs/remotes/upstream/main"],
  3776. self.repo.refs[b"refs/remotes/upstream/main"],
  3777. )
  3778. # Verify the extra branch was deleted
  3779. self.assertNotIn(b"refs/heads/to-be-deleted", self.repo.refs)
  3780. def test_mirror_mode_disabled(self) -> None:
  3781. """Test that mirror mode is properly disabled when set to false."""
  3782. outstream = BytesIO()
  3783. errstream = BytesIO()
  3784. # Create initial commit
  3785. porcelain.commit(
  3786. repo=self.repo.path,
  3787. message=b"init",
  3788. author=b"author <email>",
  3789. committer=b"committer <email>",
  3790. )
  3791. # Setup target repo cloned from temp test repo
  3792. clone_path = tempfile.mkdtemp()
  3793. self.addCleanup(shutil.rmtree, clone_path)
  3794. target_repo = porcelain.clone(
  3795. self.repo.path, target=clone_path, errstream=errstream
  3796. )
  3797. target_repo.close()
  3798. # Create a branch in the remote that doesn't exist in clone
  3799. self.repo.refs[b"refs/heads/should-not-be-deleted"] = self.repo[b"HEAD"].id
  3800. # Explicitly set mirror mode to false
  3801. with Repo(clone_path) as r_clone:
  3802. config = r_clone.get_config()
  3803. config.set((b"remote", b"origin"), b"mirror", False)
  3804. config.write_to_path()
  3805. # Push normally (not mirror mode)
  3806. porcelain.push(
  3807. clone_path,
  3808. "origin",
  3809. outstream=outstream,
  3810. errstream=errstream,
  3811. )
  3812. # Verify the extra branch was NOT deleted
  3813. self.assertIn(b"refs/heads/should-not-be-deleted", self.repo.refs)
  3814. class PullTests(PorcelainTestCase):
  3815. def setUp(self) -> None:
  3816. super().setUp()
  3817. # create a file for initial commit
  3818. handle, fullpath = tempfile.mkstemp(dir=self.repo.path)
  3819. os.close(handle)
  3820. porcelain.add(repo=self.repo.path, paths=fullpath)
  3821. porcelain.commit(
  3822. repo=self.repo.path,
  3823. message=b"test",
  3824. author=b"test <email>",
  3825. committer=b"test <email>",
  3826. )
  3827. # Setup target repo
  3828. self.target_path = tempfile.mkdtemp()
  3829. self.addCleanup(shutil.rmtree, self.target_path)
  3830. target_repo = porcelain.clone(
  3831. self.repo.path, target=self.target_path, errstream=BytesIO()
  3832. )
  3833. target_repo.close()
  3834. # create a second file to be pushed
  3835. handle, fullpath = tempfile.mkstemp(dir=self.repo.path)
  3836. os.close(handle)
  3837. porcelain.add(repo=self.repo.path, paths=fullpath)
  3838. porcelain.commit(
  3839. repo=self.repo.path,
  3840. message=b"test2",
  3841. author=b"test2 <email>",
  3842. committer=b"test2 <email>",
  3843. )
  3844. self.assertIn(b"refs/heads/master", self.repo.refs)
  3845. self.assertIn(b"refs/heads/master", target_repo.refs)
  3846. def test_simple(self) -> None:
  3847. outstream = BytesIO()
  3848. errstream = BytesIO()
  3849. # Pull changes into the cloned repo
  3850. porcelain.pull(
  3851. self.target_path,
  3852. self.repo.path,
  3853. b"refs/heads/master",
  3854. outstream=outstream,
  3855. errstream=errstream,
  3856. )
  3857. # Check the target repo for pushed changes
  3858. with Repo(self.target_path) as r:
  3859. self.assertEqual(r[b"HEAD"].id, self.repo[b"HEAD"].id)
  3860. def test_diverged(self) -> None:
  3861. outstream = BytesIO()
  3862. errstream = BytesIO()
  3863. c3a = porcelain.commit(
  3864. repo=self.target_path,
  3865. message=b"test3a",
  3866. author=b"test2 <email>",
  3867. committer=b"test2 <email>",
  3868. )
  3869. porcelain.commit(
  3870. repo=self.repo.path,
  3871. message=b"test3b",
  3872. author=b"test2 <email>",
  3873. committer=b"test2 <email>",
  3874. )
  3875. # Pull changes into the cloned repo
  3876. self.assertRaises(
  3877. porcelain.DivergedBranches,
  3878. porcelain.pull,
  3879. self.target_path,
  3880. self.repo.path,
  3881. b"refs/heads/master",
  3882. outstream=outstream,
  3883. errstream=errstream,
  3884. )
  3885. # Check the target repo for pushed changes
  3886. with Repo(self.target_path) as r:
  3887. self.assertEqual(r[b"refs/heads/master"].id, c3a)
  3888. # Pull with merge should now work
  3889. porcelain.pull(
  3890. self.target_path,
  3891. self.repo.path,
  3892. b"refs/heads/master",
  3893. outstream=outstream,
  3894. errstream=errstream,
  3895. fast_forward=False,
  3896. )
  3897. # Check the target repo for merged changes
  3898. with Repo(self.target_path) as r:
  3899. # HEAD should now be a merge commit
  3900. head = r[b"HEAD"]
  3901. # It should have two parents
  3902. self.assertEqual(len(head.parents), 2)
  3903. # One parent should be the previous HEAD (c3a)
  3904. self.assertIn(c3a, head.parents)
  3905. # The other parent should be from the source repo
  3906. self.assertIn(self.repo[b"HEAD"].id, head.parents)
  3907. def test_no_refspec(self) -> None:
  3908. outstream = BytesIO()
  3909. errstream = BytesIO()
  3910. # Pull changes into the cloned repo
  3911. porcelain.pull(
  3912. self.target_path,
  3913. self.repo.path,
  3914. outstream=outstream,
  3915. errstream=errstream,
  3916. )
  3917. # Check the target repo for pushed changes
  3918. with Repo(self.target_path) as r:
  3919. self.assertEqual(r[b"HEAD"].id, self.repo[b"HEAD"].id)
  3920. def test_no_remote_location(self) -> None:
  3921. outstream = BytesIO()
  3922. errstream = BytesIO()
  3923. # Pull changes into the cloned repo
  3924. porcelain.pull(
  3925. self.target_path,
  3926. refspecs=b"refs/heads/master",
  3927. outstream=outstream,
  3928. errstream=errstream,
  3929. )
  3930. # Check the target repo for pushed changes
  3931. with Repo(self.target_path) as r:
  3932. self.assertEqual(r[b"HEAD"].id, self.repo[b"HEAD"].id)
  3933. def test_pull_updates_working_tree(self) -> None:
  3934. """Test that pull updates the working tree with new files."""
  3935. outstream = BytesIO()
  3936. errstream = BytesIO()
  3937. # Create a new file with content in the source repo
  3938. new_file = os.path.join(self.repo.path, "newfile.txt")
  3939. with open(new_file, "w") as f:
  3940. f.write("This is new content")
  3941. porcelain.add(repo=self.repo.path, paths=[new_file])
  3942. porcelain.commit(
  3943. repo=self.repo.path,
  3944. message=b"Add new file",
  3945. author=b"test <email>",
  3946. committer=b"test <email>",
  3947. )
  3948. # Before pull, the file should not exist in target
  3949. target_file = os.path.join(self.target_path, "newfile.txt")
  3950. self.assertFalse(os.path.exists(target_file))
  3951. # Pull changes into the cloned repo
  3952. porcelain.pull(
  3953. self.target_path,
  3954. self.repo.path,
  3955. b"refs/heads/master",
  3956. outstream=outstream,
  3957. errstream=errstream,
  3958. )
  3959. # After pull, the file should exist with correct content
  3960. self.assertTrue(os.path.exists(target_file))
  3961. with open(target_file) as f:
  3962. self.assertEqual(f.read(), "This is new content")
  3963. # Check the HEAD is updated too
  3964. with Repo(self.target_path) as r:
  3965. self.assertEqual(r[b"HEAD"].id, self.repo[b"HEAD"].id)
  3966. class StatusTests(PorcelainTestCase):
  3967. def test_empty(self) -> None:
  3968. results = porcelain.status(self.repo)
  3969. self.assertEqual({"add": [], "delete": [], "modify": []}, results.staged)
  3970. self.assertEqual([], results.unstaged)
  3971. def test_status_base(self) -> None:
  3972. """Integration test for `status` functionality."""
  3973. # Commit a dummy file then modify it
  3974. fullpath = os.path.join(self.repo.path, "foo")
  3975. with open(fullpath, "w") as f:
  3976. f.write("origstuff")
  3977. porcelain.add(repo=self.repo.path, paths=[fullpath])
  3978. porcelain.commit(
  3979. repo=self.repo.path,
  3980. message=b"test status",
  3981. author=b"author <email>",
  3982. committer=b"committer <email>",
  3983. )
  3984. # modify access and modify time of path
  3985. os.utime(fullpath, (0, 0))
  3986. with open(fullpath, "wb") as f:
  3987. f.write(b"stuff")
  3988. # Make a dummy file and stage it
  3989. filename_add = "bar"
  3990. fullpath = os.path.join(self.repo.path, filename_add)
  3991. with open(fullpath, "w") as f:
  3992. f.write("stuff")
  3993. porcelain.add(repo=self.repo.path, paths=fullpath)
  3994. results = porcelain.status(self.repo)
  3995. self.assertEqual(results.staged["add"][0], filename_add.encode("ascii"))
  3996. self.assertEqual(results.unstaged, [b"foo"])
  3997. def test_status_all(self) -> None:
  3998. del_path = os.path.join(self.repo.path, "foo")
  3999. mod_path = os.path.join(self.repo.path, "bar")
  4000. add_path = os.path.join(self.repo.path, "baz")
  4001. us_path = os.path.join(self.repo.path, "blye")
  4002. ut_path = os.path.join(self.repo.path, "blyat")
  4003. with open(del_path, "w") as f:
  4004. f.write("origstuff")
  4005. with open(mod_path, "w") as f:
  4006. f.write("origstuff")
  4007. with open(us_path, "w") as f:
  4008. f.write("origstuff")
  4009. porcelain.add(repo=self.repo.path, paths=[del_path, mod_path, us_path])
  4010. porcelain.commit(
  4011. repo=self.repo.path,
  4012. message=b"test status",
  4013. author=b"author <email>",
  4014. committer=b"committer <email>",
  4015. )
  4016. porcelain.remove(self.repo.path, [del_path])
  4017. with open(add_path, "w") as f:
  4018. f.write("origstuff")
  4019. with open(mod_path, "w") as f:
  4020. f.write("more_origstuff")
  4021. with open(us_path, "w") as f:
  4022. f.write("more_origstuff")
  4023. porcelain.add(repo=self.repo.path, paths=[add_path, mod_path])
  4024. with open(us_path, "w") as f:
  4025. f.write("\norigstuff")
  4026. with open(ut_path, "w") as f:
  4027. f.write("origstuff")
  4028. results = porcelain.status(self.repo.path)
  4029. self.assertDictEqual(
  4030. {"add": [b"baz"], "delete": [b"foo"], "modify": [b"bar"]},
  4031. results.staged,
  4032. )
  4033. self.assertListEqual(results.unstaged, [b"blye"])
  4034. results_no_untracked = porcelain.status(self.repo.path, untracked_files="no")
  4035. self.assertListEqual(results_no_untracked.untracked, [])
  4036. def test_status_wrong_untracked_files_value(self) -> None:
  4037. with self.assertRaises(ValueError):
  4038. porcelain.status(self.repo.path, untracked_files="antani")
  4039. def test_status_untracked_path(self) -> None:
  4040. untracked_dir = os.path.join(self.repo_path, "untracked_dir")
  4041. os.mkdir(untracked_dir)
  4042. untracked_file = os.path.join(untracked_dir, "untracked_file")
  4043. with open(untracked_file, "w") as fh:
  4044. fh.write("untracked")
  4045. _, _, untracked = porcelain.status(self.repo.path, untracked_files="all")
  4046. self.assertEqual(untracked, ["untracked_dir/untracked_file"])
  4047. def test_status_untracked_path_normal(self) -> None:
  4048. # Create an untracked directory with multiple files
  4049. untracked_dir = os.path.join(self.repo_path, "untracked_dir")
  4050. os.mkdir(untracked_dir)
  4051. untracked_file1 = os.path.join(untracked_dir, "file1")
  4052. untracked_file2 = os.path.join(untracked_dir, "file2")
  4053. with open(untracked_file1, "w") as fh:
  4054. fh.write("untracked1")
  4055. with open(untracked_file2, "w") as fh:
  4056. fh.write("untracked2")
  4057. # Create a nested untracked directory
  4058. nested_dir = os.path.join(untracked_dir, "nested")
  4059. os.mkdir(nested_dir)
  4060. nested_file = os.path.join(nested_dir, "file3")
  4061. with open(nested_file, "w") as fh:
  4062. fh.write("untracked3")
  4063. # Test "normal" mode - should only show the directory, not individual files
  4064. _, _, untracked = porcelain.status(self.repo.path, untracked_files="normal")
  4065. self.assertEqual(untracked, ["untracked_dir/"])
  4066. # Test "all" mode - should show all files
  4067. _, _, untracked_all = porcelain.status(self.repo.path, untracked_files="all")
  4068. self.assertEqual(
  4069. sorted(untracked_all),
  4070. [
  4071. "untracked_dir/file1",
  4072. "untracked_dir/file2",
  4073. "untracked_dir/nested/file3",
  4074. ],
  4075. )
  4076. def test_status_mixed_tracked_untracked(self) -> None:
  4077. # Create a directory with both tracked and untracked files
  4078. mixed_dir = os.path.join(self.repo_path, "mixed_dir")
  4079. os.mkdir(mixed_dir)
  4080. # Add a tracked file
  4081. tracked_file = os.path.join(mixed_dir, "tracked.txt")
  4082. with open(tracked_file, "w") as fh:
  4083. fh.write("tracked content")
  4084. porcelain.add(self.repo.path, paths=[tracked_file])
  4085. porcelain.commit(
  4086. repo=self.repo.path,
  4087. message=b"add tracked file",
  4088. author=b"author <email>",
  4089. committer=b"committer <email>",
  4090. )
  4091. # Add untracked files to the same directory
  4092. untracked_file = os.path.join(mixed_dir, "untracked.txt")
  4093. with open(untracked_file, "w") as fh:
  4094. fh.write("untracked content")
  4095. # In "normal" mode, should show individual untracked files in mixed dirs
  4096. _, _, untracked = porcelain.status(self.repo.path, untracked_files="normal")
  4097. self.assertEqual(untracked, ["mixed_dir/untracked.txt"])
  4098. # In "all" mode, should be the same for mixed directories
  4099. _, _, untracked_all = porcelain.status(self.repo.path, untracked_files="all")
  4100. self.assertEqual(untracked_all, ["mixed_dir/untracked.txt"])
  4101. def test_status_crlf_mismatch(self) -> None:
  4102. # First make a commit as if the file has been added on a Linux system
  4103. # or with core.autocrlf=True
  4104. file_path = os.path.join(self.repo.path, "crlf")
  4105. with open(file_path, "wb") as f:
  4106. f.write(b"line1\nline2")
  4107. porcelain.add(repo=self.repo.path, paths=[file_path])
  4108. porcelain.commit(
  4109. repo=self.repo.path,
  4110. message=b"test status",
  4111. author=b"author <email>",
  4112. committer=b"committer <email>",
  4113. )
  4114. # Then update the file as if it was created by CGit on a Windows
  4115. # system with core.autocrlf=true
  4116. with open(file_path, "wb") as f:
  4117. f.write(b"line1\r\nline2")
  4118. results = porcelain.status(self.repo)
  4119. self.assertDictEqual({"add": [], "delete": [], "modify": []}, results.staged)
  4120. self.assertListEqual(results.unstaged, [b"crlf"])
  4121. self.assertListEqual(results.untracked, [])
  4122. def test_status_autocrlf_true(self) -> None:
  4123. # First make a commit as if the file has been added on a Linux system
  4124. # or with core.autocrlf=True
  4125. file_path = os.path.join(self.repo.path, "crlf")
  4126. with open(file_path, "wb") as f:
  4127. f.write(b"line1\nline2")
  4128. porcelain.add(repo=self.repo.path, paths=[file_path])
  4129. porcelain.commit(
  4130. repo=self.repo.path,
  4131. message=b"test status",
  4132. author=b"author <email>",
  4133. committer=b"committer <email>",
  4134. )
  4135. # Then update the file as if it was created by CGit on a Windows
  4136. # system with core.autocrlf=true
  4137. with open(file_path, "wb") as f:
  4138. f.write(b"line1\r\nline2")
  4139. # TODO: It should be set automatically by looking at the configuration
  4140. c = self.repo.get_config()
  4141. c.set("core", "autocrlf", True)
  4142. c.write_to_path()
  4143. results = porcelain.status(self.repo)
  4144. self.assertDictEqual({"add": [], "delete": [], "modify": []}, results.staged)
  4145. self.assertListEqual(results.unstaged, [])
  4146. self.assertListEqual(results.untracked, [])
  4147. def test_status_autocrlf_input(self) -> None:
  4148. # Commit existing file with CRLF
  4149. file_path = os.path.join(self.repo.path, "crlf-exists")
  4150. with open(file_path, "wb") as f:
  4151. f.write(b"line1\r\nline2")
  4152. porcelain.add(repo=self.repo.path, paths=[file_path])
  4153. porcelain.commit(
  4154. repo=self.repo.path,
  4155. message=b"test status",
  4156. author=b"author <email>",
  4157. committer=b"committer <email>",
  4158. )
  4159. c = self.repo.get_config()
  4160. c.set("core", "autocrlf", "input")
  4161. c.write_to_path()
  4162. # Add new (untracked) file
  4163. file_path = os.path.join(self.repo.path, "crlf-new")
  4164. with open(file_path, "wb") as f:
  4165. f.write(b"line1\r\nline2")
  4166. porcelain.add(repo=self.repo.path, paths=[file_path])
  4167. results = porcelain.status(self.repo)
  4168. self.assertDictEqual(
  4169. {"add": [b"crlf-new"], "delete": [], "modify": []}, results.staged
  4170. )
  4171. self.assertListEqual(results.unstaged, [])
  4172. self.assertListEqual(results.untracked, [])
  4173. def test_get_tree_changes_add(self) -> None:
  4174. """Unit test for get_tree_changes add."""
  4175. # Make a dummy file, stage
  4176. filename = "bar"
  4177. fullpath = os.path.join(self.repo.path, filename)
  4178. with open(fullpath, "w") as f:
  4179. f.write("stuff")
  4180. porcelain.add(repo=self.repo.path, paths=fullpath)
  4181. porcelain.commit(
  4182. repo=self.repo.path,
  4183. message=b"test status",
  4184. author=b"author <email>",
  4185. committer=b"committer <email>",
  4186. )
  4187. filename = "foo"
  4188. fullpath = os.path.join(self.repo.path, filename)
  4189. with open(fullpath, "w") as f:
  4190. f.write("stuff")
  4191. porcelain.add(repo=self.repo.path, paths=fullpath)
  4192. changes = porcelain.get_tree_changes(self.repo.path)
  4193. self.assertEqual(changes["add"][0], filename.encode("ascii"))
  4194. self.assertEqual(len(changes["add"]), 1)
  4195. self.assertEqual(len(changes["modify"]), 0)
  4196. self.assertEqual(len(changes["delete"]), 0)
  4197. def test_get_tree_changes_modify(self) -> None:
  4198. """Unit test for get_tree_changes modify."""
  4199. # Make a dummy file, stage, commit, modify
  4200. filename = "foo"
  4201. fullpath = os.path.join(self.repo.path, filename)
  4202. with open(fullpath, "w") as f:
  4203. f.write("stuff")
  4204. porcelain.add(repo=self.repo.path, paths=fullpath)
  4205. porcelain.commit(
  4206. repo=self.repo.path,
  4207. message=b"test status",
  4208. author=b"author <email>",
  4209. committer=b"committer <email>",
  4210. )
  4211. with open(fullpath, "w") as f:
  4212. f.write("otherstuff")
  4213. porcelain.add(repo=self.repo.path, paths=fullpath)
  4214. changes = porcelain.get_tree_changes(self.repo.path)
  4215. self.assertEqual(changes["modify"][0], filename.encode("ascii"))
  4216. self.assertEqual(len(changes["add"]), 0)
  4217. self.assertEqual(len(changes["modify"]), 1)
  4218. self.assertEqual(len(changes["delete"]), 0)
  4219. def test_get_tree_changes_delete(self) -> None:
  4220. """Unit test for get_tree_changes delete."""
  4221. # Make a dummy file, stage, commit, remove
  4222. filename = "foo"
  4223. fullpath = os.path.join(self.repo.path, filename)
  4224. with open(fullpath, "w") as f:
  4225. f.write("stuff")
  4226. porcelain.add(repo=self.repo.path, paths=fullpath)
  4227. porcelain.commit(
  4228. repo=self.repo.path,
  4229. message=b"test status",
  4230. author=b"author <email>",
  4231. committer=b"committer <email>",
  4232. )
  4233. cwd = os.getcwd()
  4234. try:
  4235. os.chdir(self.repo.path)
  4236. porcelain.remove(repo=self.repo.path, paths=[filename])
  4237. finally:
  4238. os.chdir(cwd)
  4239. changes = porcelain.get_tree_changes(self.repo.path)
  4240. self.assertEqual(changes["delete"][0], filename.encode("ascii"))
  4241. self.assertEqual(len(changes["add"]), 0)
  4242. self.assertEqual(len(changes["modify"]), 0)
  4243. self.assertEqual(len(changes["delete"]), 1)
  4244. def test_get_untracked_paths(self) -> None:
  4245. with open(os.path.join(self.repo.path, ".gitignore"), "w") as f:
  4246. f.write("ignored\n")
  4247. with open(os.path.join(self.repo.path, "ignored"), "w") as f:
  4248. f.write("blah\n")
  4249. with open(os.path.join(self.repo.path, "notignored"), "w") as f:
  4250. f.write("blah\n")
  4251. os.symlink(
  4252. os.path.join(self.repo.path, os.pardir, "external_target"),
  4253. os.path.join(self.repo.path, "link"),
  4254. )
  4255. self.assertEqual(
  4256. {"ignored", "notignored", ".gitignore", "link"},
  4257. set(
  4258. porcelain.get_untracked_paths(
  4259. self.repo.path, self.repo.path, self.repo.open_index()
  4260. )
  4261. ),
  4262. )
  4263. self.assertEqual(
  4264. {".gitignore", "notignored", "link"},
  4265. set(porcelain.status(self.repo).untracked),
  4266. )
  4267. self.assertEqual(
  4268. {".gitignore", "notignored", "ignored", "link"},
  4269. set(porcelain.status(self.repo, ignored=True).untracked),
  4270. )
  4271. def test_get_untracked_paths_subrepo(self) -> None:
  4272. with open(os.path.join(self.repo.path, ".gitignore"), "w") as f:
  4273. f.write("nested/\n")
  4274. with open(os.path.join(self.repo.path, "notignored"), "w") as f:
  4275. f.write("blah\n")
  4276. subrepo = Repo.init(os.path.join(self.repo.path, "nested"), mkdir=True)
  4277. with open(os.path.join(subrepo.path, "ignored"), "w") as f:
  4278. f.write("bleep\n")
  4279. with open(os.path.join(subrepo.path, "with"), "w") as f:
  4280. f.write("bloop\n")
  4281. with open(os.path.join(subrepo.path, "manager"), "w") as f:
  4282. f.write("blop\n")
  4283. self.assertEqual(
  4284. {".gitignore", "notignored", os.path.join("nested", "")},
  4285. set(
  4286. porcelain.get_untracked_paths(
  4287. self.repo.path, self.repo.path, self.repo.open_index()
  4288. )
  4289. ),
  4290. )
  4291. self.assertEqual(
  4292. {".gitignore", "notignored"},
  4293. set(
  4294. porcelain.get_untracked_paths(
  4295. self.repo.path,
  4296. self.repo.path,
  4297. self.repo.open_index(),
  4298. exclude_ignored=True,
  4299. )
  4300. ),
  4301. )
  4302. self.assertEqual(
  4303. {"ignored", "with", "manager"},
  4304. set(
  4305. porcelain.get_untracked_paths(
  4306. subrepo.path, subrepo.path, subrepo.open_index()
  4307. )
  4308. ),
  4309. )
  4310. self.assertEqual(
  4311. set(),
  4312. set(
  4313. porcelain.get_untracked_paths(
  4314. subrepo.path,
  4315. self.repo.path,
  4316. self.repo.open_index(),
  4317. )
  4318. ),
  4319. )
  4320. self.assertEqual(
  4321. {
  4322. os.path.join("nested", "ignored"),
  4323. os.path.join("nested", "with"),
  4324. os.path.join("nested", "manager"),
  4325. },
  4326. set(
  4327. porcelain.get_untracked_paths(
  4328. self.repo.path,
  4329. subrepo.path,
  4330. self.repo.open_index(),
  4331. )
  4332. ),
  4333. )
  4334. def test_get_untracked_paths_subdir(self) -> None:
  4335. with open(os.path.join(self.repo.path, ".gitignore"), "w") as f:
  4336. f.write("subdir/\nignored")
  4337. with open(os.path.join(self.repo.path, "notignored"), "w") as f:
  4338. f.write("blah\n")
  4339. os.mkdir(os.path.join(self.repo.path, "subdir"))
  4340. with open(os.path.join(self.repo.path, "ignored"), "w") as f:
  4341. f.write("foo")
  4342. with open(os.path.join(self.repo.path, "subdir", "ignored"), "w") as f:
  4343. f.write("foo")
  4344. self.assertEqual(
  4345. {
  4346. ".gitignore",
  4347. "notignored",
  4348. "ignored",
  4349. os.path.join("subdir", ""),
  4350. },
  4351. set(
  4352. porcelain.get_untracked_paths(
  4353. self.repo.path,
  4354. self.repo.path,
  4355. self.repo.open_index(),
  4356. )
  4357. ),
  4358. )
  4359. self.assertEqual(
  4360. {".gitignore", "notignored"},
  4361. set(
  4362. porcelain.get_untracked_paths(
  4363. self.repo.path,
  4364. self.repo.path,
  4365. self.repo.open_index(),
  4366. exclude_ignored=True,
  4367. )
  4368. ),
  4369. )
  4370. def test_get_untracked_paths_invalid_untracked_files(self) -> None:
  4371. with self.assertRaises(ValueError):
  4372. list(
  4373. porcelain.get_untracked_paths(
  4374. self.repo.path,
  4375. self.repo.path,
  4376. self.repo.open_index(),
  4377. untracked_files="invalid_value",
  4378. )
  4379. )
  4380. def test_get_untracked_paths_normal(self) -> None:
  4381. # Create an untracked directory with files
  4382. untracked_dir = os.path.join(self.repo.path, "untracked_dir")
  4383. os.mkdir(untracked_dir)
  4384. with open(os.path.join(untracked_dir, "file1.txt"), "w") as f:
  4385. f.write("untracked content")
  4386. with open(os.path.join(untracked_dir, "file2.txt"), "w") as f:
  4387. f.write("more untracked content")
  4388. # Test that "normal" mode works and returns only the directory
  4389. _, _, untracked = porcelain.status(
  4390. repo=self.repo.path, untracked_files="normal"
  4391. )
  4392. self.assertEqual(untracked, ["untracked_dir/"])
  4393. def test_get_untracked_paths_top_level_issue_1247(self) -> None:
  4394. """Test for issue #1247: ensure top-level untracked files are detected."""
  4395. # Create a single top-level untracked file
  4396. with open(os.path.join(self.repo.path, "sample.txt"), "w") as f:
  4397. f.write("test content")
  4398. # Test get_untracked_paths directly
  4399. untracked = list(
  4400. porcelain.get_untracked_paths(
  4401. self.repo.path, self.repo.path, self.repo.open_index()
  4402. )
  4403. )
  4404. self.assertIn(
  4405. "sample.txt",
  4406. untracked,
  4407. "Top-level file 'sample.txt' should be in untracked list",
  4408. )
  4409. # Test via status
  4410. status = porcelain.status(self.repo)
  4411. self.assertIn(
  4412. "sample.txt",
  4413. status.untracked,
  4414. "Top-level file 'sample.txt' should be in status.untracked",
  4415. )
  4416. # TODO(jelmer): Add test for dulwich.porcelain.daemon
  4417. class UploadPackTests(PorcelainTestCase):
  4418. """Tests for upload_pack."""
  4419. def test_upload_pack(self) -> None:
  4420. outf = BytesIO()
  4421. exitcode = porcelain.upload_pack(self.repo.path, BytesIO(b"0000"), outf)
  4422. outlines = outf.getvalue().splitlines()
  4423. self.assertEqual([b"0000"], outlines)
  4424. self.assertEqual(0, exitcode)
  4425. class ReceivePackTests(PorcelainTestCase):
  4426. """Tests for receive_pack."""
  4427. def test_receive_pack(self) -> None:
  4428. filename = "foo"
  4429. fullpath = os.path.join(self.repo.path, filename)
  4430. with open(fullpath, "w") as f:
  4431. f.write("stuff")
  4432. porcelain.add(repo=self.repo.path, paths=fullpath)
  4433. self.repo.do_commit(
  4434. message=b"test status",
  4435. author=b"author <email>",
  4436. committer=b"committer <email>",
  4437. author_timestamp=1402354300,
  4438. commit_timestamp=1402354300,
  4439. author_timezone=0,
  4440. commit_timezone=0,
  4441. )
  4442. outf = BytesIO()
  4443. exitcode = porcelain.receive_pack(self.repo.path, BytesIO(b"0000"), outf)
  4444. outlines = outf.getvalue().splitlines()
  4445. self.assertEqual(
  4446. [
  4447. b"0091319b56ce3aee2d489f759736a79cc552c9bb86d9 HEAD\x00 report-status "
  4448. b"delete-refs quiet ofs-delta side-band-64k "
  4449. b"no-done symref=HEAD:refs/heads/master",
  4450. b"003f319b56ce3aee2d489f759736a79cc552c9bb86d9 refs/heads/master",
  4451. b"0000",
  4452. ],
  4453. outlines,
  4454. )
  4455. self.assertEqual(0, exitcode)
  4456. class BranchListTests(PorcelainTestCase):
  4457. def test_standard(self) -> None:
  4458. self.assertEqual(set(), set(porcelain.branch_list(self.repo)))
  4459. def test_new_branch(self) -> None:
  4460. [c1] = build_commit_graph(self.repo.object_store, [[1]])
  4461. self.repo[b"HEAD"] = c1.id
  4462. porcelain.branch_create(self.repo, b"foo")
  4463. self.assertEqual({b"master", b"foo"}, set(porcelain.branch_list(self.repo)))
  4464. def test_sort_by_refname(self) -> None:
  4465. """Test branch.sort=refname (default alphabetical)."""
  4466. [c1] = build_commit_graph(self.repo.object_store, [[1]])
  4467. self.repo[b"HEAD"] = c1.id
  4468. # Create branches in non-alphabetical order
  4469. porcelain.branch_create(self.repo, b"zebra")
  4470. porcelain.branch_create(self.repo, b"alpha")
  4471. porcelain.branch_create(self.repo, b"beta")
  4472. # Set branch.sort to refname (though it's the default)
  4473. config = self.repo.get_config()
  4474. config.set((b"branch",), b"sort", b"refname")
  4475. config.write_to_path()
  4476. # Should be sorted alphabetically
  4477. branches = porcelain.branch_list(self.repo)
  4478. self.assertEqual([b"alpha", b"beta", b"master", b"zebra"], branches)
  4479. def test_sort_by_refname_reverse(self) -> None:
  4480. """Test branch.sort=-refname (reverse alphabetical)."""
  4481. [c1] = build_commit_graph(self.repo.object_store, [[1]])
  4482. self.repo[b"HEAD"] = c1.id
  4483. # Create branches
  4484. porcelain.branch_create(self.repo, b"zebra")
  4485. porcelain.branch_create(self.repo, b"alpha")
  4486. porcelain.branch_create(self.repo, b"beta")
  4487. # Set branch.sort to -refname
  4488. config = self.repo.get_config()
  4489. config.set((b"branch",), b"sort", b"-refname")
  4490. config.write_to_path()
  4491. # Should be sorted reverse alphabetically
  4492. branches = porcelain.branch_list(self.repo)
  4493. self.assertEqual([b"zebra", b"master", b"beta", b"alpha"], branches)
  4494. def test_sort_by_committerdate(self) -> None:
  4495. """Test branch.sort=committerdate."""
  4496. # Use build_commit_graph to create proper commits with specific times
  4497. c1, c2, c3 = build_commit_graph(
  4498. self.repo.object_store,
  4499. [[1], [2], [3]],
  4500. attrs={
  4501. 1: {"commit_time": 1000}, # oldest
  4502. 2: {"commit_time": 2000}, # newest
  4503. 3: {"commit_time": 1500}, # middle
  4504. },
  4505. )
  4506. self.repo[b"HEAD"] = c1.id
  4507. # Create branches pointing to different commits
  4508. self.repo.refs[b"refs/heads/master"] = c1.id # master points to oldest
  4509. self.repo.refs[b"refs/heads/oldest"] = c1.id
  4510. self.repo.refs[b"refs/heads/newest"] = c2.id
  4511. self.repo.refs[b"refs/heads/middle"] = c3.id
  4512. # Set branch.sort to committerdate
  4513. config = self.repo.get_config()
  4514. config.set((b"branch",), b"sort", b"committerdate")
  4515. config.write_to_path()
  4516. # Should be sorted by commit time (oldest first)
  4517. branches = porcelain.branch_list(self.repo)
  4518. self.assertEqual([b"master", b"oldest", b"middle", b"newest"], branches)
  4519. def test_sort_by_committerdate_reverse(self) -> None:
  4520. """Test branch.sort=-committerdate."""
  4521. # Use build_commit_graph to create proper commits with specific times
  4522. c1, c2, c3 = build_commit_graph(
  4523. self.repo.object_store,
  4524. [[1], [2], [3]],
  4525. attrs={
  4526. 1: {"commit_time": 1000}, # oldest
  4527. 2: {"commit_time": 2000}, # newest
  4528. 3: {"commit_time": 1500}, # middle
  4529. },
  4530. )
  4531. self.repo[b"HEAD"] = c1.id
  4532. # Create branches pointing to different commits
  4533. self.repo.refs[b"refs/heads/master"] = c1.id # master points to oldest
  4534. self.repo.refs[b"refs/heads/oldest"] = c1.id
  4535. self.repo.refs[b"refs/heads/newest"] = c2.id
  4536. self.repo.refs[b"refs/heads/middle"] = c3.id
  4537. # Set branch.sort to -committerdate
  4538. config = self.repo.get_config()
  4539. config.set((b"branch",), b"sort", b"-committerdate")
  4540. config.write_to_path()
  4541. # Should be sorted by commit time (newest first)
  4542. branches = porcelain.branch_list(self.repo)
  4543. self.assertEqual([b"newest", b"middle", b"master", b"oldest"], branches)
  4544. def test_sort_default(self) -> None:
  4545. """Test default sorting (no config)."""
  4546. [c1] = build_commit_graph(self.repo.object_store, [[1]])
  4547. self.repo[b"HEAD"] = c1.id
  4548. # Create branches in non-alphabetical order
  4549. porcelain.branch_create(self.repo, b"zebra")
  4550. porcelain.branch_create(self.repo, b"alpha")
  4551. porcelain.branch_create(self.repo, b"beta")
  4552. # No config set - should default to alphabetical
  4553. branches = porcelain.branch_list(self.repo)
  4554. self.assertEqual([b"alpha", b"beta", b"master", b"zebra"], branches)
  4555. class BranchCreateTests(PorcelainTestCase):
  4556. def test_branch_exists(self) -> None:
  4557. [c1] = build_commit_graph(self.repo.object_store, [[1]])
  4558. self.repo[b"HEAD"] = c1.id
  4559. porcelain.branch_create(self.repo, b"foo")
  4560. self.assertRaises(porcelain.Error, porcelain.branch_create, self.repo, b"foo")
  4561. porcelain.branch_create(self.repo, b"foo", force=True)
  4562. def test_new_branch(self) -> None:
  4563. [c1] = build_commit_graph(self.repo.object_store, [[1]])
  4564. self.repo[b"HEAD"] = c1.id
  4565. porcelain.branch_create(self.repo, b"foo")
  4566. self.assertEqual({b"master", b"foo"}, set(porcelain.branch_list(self.repo)))
  4567. def test_auto_setup_merge_true_from_remote_tracking(self) -> None:
  4568. """Test branch.autoSetupMerge=true sets up tracking from remote-tracking branch."""
  4569. [c1] = build_commit_graph(self.repo.object_store, [[1]])
  4570. self.repo[b"HEAD"] = c1.id
  4571. # Create a remote-tracking branch
  4572. self.repo.refs[b"refs/remotes/origin/feature"] = c1.id
  4573. # Set branch.autoSetupMerge to true (default)
  4574. config = self.repo.get_config()
  4575. config.set((b"branch",), b"autoSetupMerge", b"true")
  4576. config.write_to_path()
  4577. # Create branch from remote-tracking branch
  4578. porcelain.branch_create(self.repo, "myfeature", "origin/feature")
  4579. # Verify tracking was set up
  4580. config = self.repo.get_config()
  4581. self.assertEqual(config.get((b"branch", b"myfeature"), b"remote"), b"origin")
  4582. self.assertEqual(
  4583. config.get((b"branch", b"myfeature"), b"merge"), b"refs/heads/feature"
  4584. )
  4585. def test_auto_setup_merge_false(self) -> None:
  4586. """Test branch.autoSetupMerge=false disables tracking setup."""
  4587. [c1] = build_commit_graph(self.repo.object_store, [[1]])
  4588. self.repo[b"HEAD"] = c1.id
  4589. # Create a remote-tracking branch
  4590. self.repo.refs[b"refs/remotes/origin/feature"] = c1.id
  4591. # Set branch.autoSetupMerge to false
  4592. config = self.repo.get_config()
  4593. config.set((b"branch",), b"autoSetupMerge", b"false")
  4594. config.write_to_path()
  4595. # Create branch from remote-tracking branch
  4596. porcelain.branch_create(self.repo, "myfeature", "origin/feature")
  4597. # Verify tracking was NOT set up
  4598. config = self.repo.get_config()
  4599. self.assertRaises(KeyError, config.get, (b"branch", b"myfeature"), b"remote")
  4600. self.assertRaises(KeyError, config.get, (b"branch", b"myfeature"), b"merge")
  4601. def test_auto_setup_merge_always(self) -> None:
  4602. """Test branch.autoSetupMerge=always sets up tracking even from local branches."""
  4603. [c1] = build_commit_graph(self.repo.object_store, [[1]])
  4604. self.repo[b"HEAD"] = c1.id
  4605. self.repo.refs[b"refs/heads/main"] = c1.id
  4606. # Set branch.autoSetupMerge to always
  4607. config = self.repo.get_config()
  4608. config.set((b"branch",), b"autoSetupMerge", b"always")
  4609. config.write_to_path()
  4610. # Create branch from local branch - normally wouldn't set up tracking
  4611. porcelain.branch_create(self.repo, "feature", "main")
  4612. # With always, tracking should NOT be set up from local branches
  4613. # (Git only sets up tracking from remote-tracking branches even with always)
  4614. config = self.repo.get_config()
  4615. self.assertRaises(KeyError, config.get, (b"branch", b"feature"), b"remote")
  4616. self.assertRaises(KeyError, config.get, (b"branch", b"feature"), b"merge")
  4617. def test_auto_setup_merge_always_from_remote(self) -> None:
  4618. """Test branch.autoSetupMerge=always still sets up tracking from remote branches."""
  4619. [c1] = build_commit_graph(self.repo.object_store, [[1]])
  4620. self.repo[b"HEAD"] = c1.id
  4621. # Create a remote-tracking branch
  4622. self.repo.refs[b"refs/remotes/origin/feature"] = c1.id
  4623. # Set branch.autoSetupMerge to always
  4624. config = self.repo.get_config()
  4625. config.set((b"branch",), b"autoSetupMerge", b"always")
  4626. config.write_to_path()
  4627. # Create branch from remote-tracking branch
  4628. porcelain.branch_create(self.repo, "myfeature", "origin/feature")
  4629. # Verify tracking was set up
  4630. config = self.repo.get_config()
  4631. self.assertEqual(config.get((b"branch", b"myfeature"), b"remote"), b"origin")
  4632. self.assertEqual(
  4633. config.get((b"branch", b"myfeature"), b"merge"), b"refs/heads/feature"
  4634. )
  4635. def test_auto_setup_merge_default(self) -> None:
  4636. """Test default behavior (no config) is same as true."""
  4637. [c1] = build_commit_graph(self.repo.object_store, [[1]])
  4638. self.repo[b"HEAD"] = c1.id
  4639. # Create a remote-tracking branch
  4640. self.repo.refs[b"refs/remotes/origin/feature"] = c1.id
  4641. # Don't set any config - should default to true
  4642. # Create branch from remote-tracking branch
  4643. porcelain.branch_create(self.repo, "myfeature", "origin/feature")
  4644. # Verify tracking was set up
  4645. config = self.repo.get_config()
  4646. self.assertEqual(config.get((b"branch", b"myfeature"), b"remote"), b"origin")
  4647. self.assertEqual(
  4648. config.get((b"branch", b"myfeature"), b"merge"), b"refs/heads/feature"
  4649. )
  4650. class BranchDeleteTests(PorcelainTestCase):
  4651. def test_simple(self) -> None:
  4652. [c1] = build_commit_graph(self.repo.object_store, [[1]])
  4653. self.repo[b"HEAD"] = c1.id
  4654. porcelain.branch_create(self.repo, b"foo")
  4655. self.assertIn(b"foo", porcelain.branch_list(self.repo))
  4656. porcelain.branch_delete(self.repo, b"foo")
  4657. self.assertNotIn(b"foo", porcelain.branch_list(self.repo))
  4658. def test_simple_unicode(self) -> None:
  4659. [c1] = build_commit_graph(self.repo.object_store, [[1]])
  4660. self.repo[b"HEAD"] = c1.id
  4661. porcelain.branch_create(self.repo, "foo")
  4662. self.assertIn(b"foo", porcelain.branch_list(self.repo))
  4663. porcelain.branch_delete(self.repo, "foo")
  4664. self.assertNotIn(b"foo", porcelain.branch_list(self.repo))
  4665. class FetchTests(PorcelainTestCase):
  4666. def test_simple(self) -> None:
  4667. outstream = BytesIO()
  4668. errstream = BytesIO()
  4669. # create a file for initial commit
  4670. handle, fullpath = tempfile.mkstemp(dir=self.repo.path)
  4671. os.close(handle)
  4672. porcelain.add(repo=self.repo.path, paths=fullpath)
  4673. porcelain.commit(
  4674. repo=self.repo.path,
  4675. message=b"test",
  4676. author=b"test <email>",
  4677. committer=b"test <email>",
  4678. )
  4679. # Setup target repo
  4680. target_path = tempfile.mkdtemp()
  4681. self.addCleanup(shutil.rmtree, target_path)
  4682. target_repo = porcelain.clone(
  4683. self.repo.path, target=target_path, errstream=errstream
  4684. )
  4685. # create a second file to be pushed
  4686. handle, fullpath = tempfile.mkstemp(dir=self.repo.path)
  4687. os.close(handle)
  4688. porcelain.add(repo=self.repo.path, paths=fullpath)
  4689. porcelain.commit(
  4690. repo=self.repo.path,
  4691. message=b"test2",
  4692. author=b"test2 <email>",
  4693. committer=b"test2 <email>",
  4694. )
  4695. self.assertNotIn(self.repo[b"HEAD"].id, target_repo)
  4696. target_repo.close()
  4697. # Fetch changes into the cloned repo
  4698. porcelain.fetch(target_path, "origin", outstream=outstream, errstream=errstream)
  4699. # Assert that fetch updated the local image of the remote
  4700. self.assert_correct_remote_refs(target_repo.get_refs(), self.repo.get_refs())
  4701. # Check the target repo for pushed changes
  4702. with Repo(target_path) as r:
  4703. self.assertIn(self.repo[b"HEAD"].id, r)
  4704. def test_with_remote_name(self) -> None:
  4705. remote_name = "origin"
  4706. outstream = BytesIO()
  4707. errstream = BytesIO()
  4708. # create a file for initial commit
  4709. handle, fullpath = tempfile.mkstemp(dir=self.repo.path)
  4710. os.close(handle)
  4711. porcelain.add(repo=self.repo.path, paths=fullpath)
  4712. porcelain.commit(
  4713. repo=self.repo.path,
  4714. message=b"test",
  4715. author=b"test <email>",
  4716. committer=b"test <email>",
  4717. )
  4718. # Setup target repo
  4719. target_path = tempfile.mkdtemp()
  4720. self.addCleanup(shutil.rmtree, target_path)
  4721. target_repo = porcelain.clone(
  4722. self.repo.path, target=target_path, errstream=errstream
  4723. )
  4724. # Capture current refs
  4725. target_refs = target_repo.get_refs()
  4726. # create a second file to be pushed
  4727. handle, fullpath = tempfile.mkstemp(dir=self.repo.path)
  4728. os.close(handle)
  4729. porcelain.add(repo=self.repo.path, paths=fullpath)
  4730. porcelain.commit(
  4731. repo=self.repo.path,
  4732. message=b"test2",
  4733. author=b"test2 <email>",
  4734. committer=b"test2 <email>",
  4735. )
  4736. self.assertNotIn(self.repo[b"HEAD"].id, target_repo)
  4737. target_config = target_repo.get_config()
  4738. target_config.set(
  4739. (b"remote", remote_name.encode()), b"url", self.repo.path.encode()
  4740. )
  4741. target_repo.close()
  4742. # Fetch changes into the cloned repo
  4743. porcelain.fetch(
  4744. target_path, remote_name, outstream=outstream, errstream=errstream
  4745. )
  4746. # Assert that fetch updated the local image of the remote
  4747. self.assert_correct_remote_refs(target_repo.get_refs(), self.repo.get_refs())
  4748. # Check the target repo for pushed changes, as well as updates
  4749. # for the refs
  4750. with Repo(target_path) as r:
  4751. self.assertIn(self.repo[b"HEAD"].id, r)
  4752. self.assertNotEqual(self.repo.get_refs(), target_refs)
  4753. def assert_correct_remote_refs(
  4754. self, local_refs, remote_refs, remote_name=b"origin"
  4755. ) -> None:
  4756. """Assert that known remote refs corresponds to actual remote refs."""
  4757. local_ref_prefix = b"refs/heads"
  4758. remote_ref_prefix = b"refs/remotes/" + remote_name
  4759. locally_known_remote_refs = {
  4760. k[len(remote_ref_prefix) + 1 :]: v
  4761. for k, v in local_refs.items()
  4762. if k.startswith(remote_ref_prefix)
  4763. }
  4764. normalized_remote_refs = {
  4765. k[len(local_ref_prefix) + 1 :]: v
  4766. for k, v in remote_refs.items()
  4767. if k.startswith(local_ref_prefix)
  4768. }
  4769. if b"HEAD" in locally_known_remote_refs and b"HEAD" in remote_refs:
  4770. normalized_remote_refs[b"HEAD"] = remote_refs[b"HEAD"]
  4771. self.assertEqual(locally_known_remote_refs, normalized_remote_refs)
  4772. class RepackTests(PorcelainTestCase):
  4773. def test_empty(self) -> None:
  4774. porcelain.repack(self.repo)
  4775. def test_simple(self) -> None:
  4776. handle, fullpath = tempfile.mkstemp(dir=self.repo.path)
  4777. os.close(handle)
  4778. porcelain.add(repo=self.repo.path, paths=fullpath)
  4779. porcelain.repack(self.repo)
  4780. class LsTreeTests(PorcelainTestCase):
  4781. def test_empty(self) -> None:
  4782. porcelain.commit(
  4783. repo=self.repo.path,
  4784. message=b"test status",
  4785. author=b"author <email>",
  4786. committer=b"committer <email>",
  4787. )
  4788. f = StringIO()
  4789. porcelain.ls_tree(self.repo, b"HEAD", outstream=f)
  4790. self.assertEqual(f.getvalue(), "")
  4791. def test_simple(self) -> None:
  4792. # Commit a dummy file then modify it
  4793. fullpath = os.path.join(self.repo.path, "foo")
  4794. with open(fullpath, "w") as f:
  4795. f.write("origstuff")
  4796. porcelain.add(repo=self.repo.path, paths=[fullpath])
  4797. porcelain.commit(
  4798. repo=self.repo.path,
  4799. message=b"test status",
  4800. author=b"author <email>",
  4801. committer=b"committer <email>",
  4802. )
  4803. f = StringIO()
  4804. porcelain.ls_tree(self.repo, b"HEAD", outstream=f)
  4805. self.assertEqual(
  4806. f.getvalue(),
  4807. "100644 blob 8b82634d7eae019850bb883f06abf428c58bc9aa\tfoo\n",
  4808. )
  4809. def test_recursive(self) -> None:
  4810. # Create a directory then write a dummy file in it
  4811. dirpath = os.path.join(self.repo.path, "adir")
  4812. filepath = os.path.join(dirpath, "afile")
  4813. os.mkdir(dirpath)
  4814. with open(filepath, "w") as f:
  4815. f.write("origstuff")
  4816. porcelain.add(repo=self.repo.path, paths=[filepath])
  4817. porcelain.commit(
  4818. repo=self.repo.path,
  4819. message=b"test status",
  4820. author=b"author <email>",
  4821. committer=b"committer <email>",
  4822. )
  4823. f = StringIO()
  4824. porcelain.ls_tree(self.repo, b"HEAD", outstream=f)
  4825. self.assertEqual(
  4826. f.getvalue(),
  4827. "40000 tree b145cc69a5e17693e24d8a7be0016ed8075de66d\tadir\n",
  4828. )
  4829. f = StringIO()
  4830. porcelain.ls_tree(self.repo, b"HEAD", outstream=f, recursive=True)
  4831. self.assertEqual(
  4832. f.getvalue(),
  4833. "40000 tree b145cc69a5e17693e24d8a7be0016ed8075de66d\tadir\n"
  4834. "100644 blob 8b82634d7eae019850bb883f06abf428c58bc9aa\tadir"
  4835. "/afile\n",
  4836. )
  4837. class LsRemoteTests(PorcelainTestCase):
  4838. def test_empty(self) -> None:
  4839. result = porcelain.ls_remote(self.repo.path)
  4840. self.assertEqual({}, result.refs)
  4841. self.assertEqual({}, result.symrefs)
  4842. def test_some(self) -> None:
  4843. cid = porcelain.commit(
  4844. repo=self.repo.path,
  4845. message=b"test status",
  4846. author=b"author <email>",
  4847. committer=b"committer <email>",
  4848. )
  4849. result = porcelain.ls_remote(self.repo.path)
  4850. self.assertEqual(
  4851. {b"refs/heads/master": cid, b"HEAD": cid},
  4852. result.refs,
  4853. )
  4854. # HEAD should be a symref to refs/heads/master
  4855. self.assertEqual({b"HEAD": b"refs/heads/master"}, result.symrefs)
  4856. class LsFilesTests(PorcelainTestCase):
  4857. def test_empty(self) -> None:
  4858. self.assertEqual([], list(porcelain.ls_files(self.repo)))
  4859. def test_simple(self) -> None:
  4860. # Commit a dummy file then modify it
  4861. fullpath = os.path.join(self.repo.path, "foo")
  4862. with open(fullpath, "w") as f:
  4863. f.write("origstuff")
  4864. porcelain.add(repo=self.repo.path, paths=[fullpath])
  4865. self.assertEqual([b"foo"], list(porcelain.ls_files(self.repo)))
  4866. class RemoteAddTests(PorcelainTestCase):
  4867. def test_new(self) -> None:
  4868. porcelain.remote_add(self.repo, "jelmer", "git://jelmer.uk/code/dulwich")
  4869. c = self.repo.get_config()
  4870. self.assertEqual(
  4871. c.get((b"remote", b"jelmer"), b"url"),
  4872. b"git://jelmer.uk/code/dulwich",
  4873. )
  4874. def test_exists(self) -> None:
  4875. porcelain.remote_add(self.repo, "jelmer", "git://jelmer.uk/code/dulwich")
  4876. self.assertRaises(
  4877. porcelain.RemoteExists,
  4878. porcelain.remote_add,
  4879. self.repo,
  4880. "jelmer",
  4881. "git://jelmer.uk/code/dulwich",
  4882. )
  4883. class RemoteRemoveTests(PorcelainTestCase):
  4884. def test_remove(self) -> None:
  4885. porcelain.remote_add(self.repo, "jelmer", "git://jelmer.uk/code/dulwich")
  4886. c = self.repo.get_config()
  4887. self.assertEqual(
  4888. c.get((b"remote", b"jelmer"), b"url"),
  4889. b"git://jelmer.uk/code/dulwich",
  4890. )
  4891. porcelain.remote_remove(self.repo, "jelmer")
  4892. self.assertRaises(KeyError, porcelain.remote_remove, self.repo, "jelmer")
  4893. c = self.repo.get_config()
  4894. self.assertRaises(KeyError, c.get, (b"remote", b"jelmer"), b"url")
  4895. class CheckIgnoreTests(PorcelainTestCase):
  4896. def test_check_ignored(self) -> None:
  4897. with open(os.path.join(self.repo.path, ".gitignore"), "w") as f:
  4898. f.write("foo")
  4899. foo_path = os.path.join(self.repo.path, "foo")
  4900. with open(foo_path, "w") as f:
  4901. f.write("BAR")
  4902. bar_path = os.path.join(self.repo.path, "bar")
  4903. with open(bar_path, "w") as f:
  4904. f.write("BAR")
  4905. self.assertEqual(["foo"], list(porcelain.check_ignore(self.repo, [foo_path])))
  4906. self.assertEqual([], list(porcelain.check_ignore(self.repo, [bar_path])))
  4907. def test_check_added_abs(self) -> None:
  4908. path = os.path.join(self.repo.path, "foo")
  4909. with open(path, "w") as f:
  4910. f.write("BAR")
  4911. self.repo.stage(["foo"])
  4912. with open(os.path.join(self.repo.path, ".gitignore"), "w") as f:
  4913. f.write("foo\n")
  4914. self.assertEqual([], list(porcelain.check_ignore(self.repo, [path])))
  4915. self.assertEqual(
  4916. ["foo"],
  4917. list(porcelain.check_ignore(self.repo, [path], no_index=True)),
  4918. )
  4919. def test_check_added_rel(self) -> None:
  4920. with open(os.path.join(self.repo.path, "foo"), "w") as f:
  4921. f.write("BAR")
  4922. self.repo.stage(["foo"])
  4923. with open(os.path.join(self.repo.path, ".gitignore"), "w") as f:
  4924. f.write("foo\n")
  4925. cwd = os.getcwd()
  4926. os.mkdir(os.path.join(self.repo.path, "bar"))
  4927. os.chdir(os.path.join(self.repo.path, "bar"))
  4928. try:
  4929. self.assertEqual(list(porcelain.check_ignore(self.repo, ["../foo"])), [])
  4930. self.assertEqual(
  4931. ["../foo"],
  4932. list(porcelain.check_ignore(self.repo, ["../foo"], no_index=True)),
  4933. )
  4934. finally:
  4935. os.chdir(cwd)
  4936. class UpdateHeadTests(PorcelainTestCase):
  4937. def test_set_to_branch(self) -> None:
  4938. [c1] = build_commit_graph(self.repo.object_store, [[1]])
  4939. self.repo.refs[b"refs/heads/blah"] = c1.id
  4940. porcelain.update_head(self.repo, "blah")
  4941. self.assertEqual(c1.id, self.repo.head())
  4942. self.assertEqual(b"ref: refs/heads/blah", self.repo.refs.read_ref(b"HEAD"))
  4943. def test_set_to_branch_detached(self) -> None:
  4944. [c1] = build_commit_graph(self.repo.object_store, [[1]])
  4945. self.repo.refs[b"refs/heads/blah"] = c1.id
  4946. porcelain.update_head(self.repo, "blah", detached=True)
  4947. self.assertEqual(c1.id, self.repo.head())
  4948. self.assertEqual(c1.id, self.repo.refs.read_ref(b"HEAD"))
  4949. def test_set_to_commit_detached(self) -> None:
  4950. [c1] = build_commit_graph(self.repo.object_store, [[1]])
  4951. self.repo.refs[b"refs/heads/blah"] = c1.id
  4952. porcelain.update_head(self.repo, c1.id, detached=True)
  4953. self.assertEqual(c1.id, self.repo.head())
  4954. self.assertEqual(c1.id, self.repo.refs.read_ref(b"HEAD"))
  4955. def test_set_new_branch(self) -> None:
  4956. [c1] = build_commit_graph(self.repo.object_store, [[1]])
  4957. self.repo.refs[b"refs/heads/blah"] = c1.id
  4958. porcelain.update_head(self.repo, "blah", new_branch="bar")
  4959. self.assertEqual(c1.id, self.repo.head())
  4960. self.assertEqual(b"ref: refs/heads/bar", self.repo.refs.read_ref(b"HEAD"))
  4961. class MailmapTests(PorcelainTestCase):
  4962. def test_no_mailmap(self) -> None:
  4963. self.assertEqual(
  4964. b"Jelmer Vernooij <jelmer@samba.org>",
  4965. porcelain.check_mailmap(self.repo, b"Jelmer Vernooij <jelmer@samba.org>"),
  4966. )
  4967. def test_mailmap_lookup(self) -> None:
  4968. with open(os.path.join(self.repo.path, ".mailmap"), "wb") as f:
  4969. f.write(
  4970. b"""\
  4971. Jelmer Vernooij <jelmer@debian.org>
  4972. """
  4973. )
  4974. self.assertEqual(
  4975. b"Jelmer Vernooij <jelmer@debian.org>",
  4976. porcelain.check_mailmap(self.repo, b"Jelmer Vernooij <jelmer@samba.org>"),
  4977. )
  4978. class FsckTests(PorcelainTestCase):
  4979. def test_none(self) -> None:
  4980. self.assertEqual([], list(porcelain.fsck(self.repo)))
  4981. def test_git_dir(self) -> None:
  4982. obj = Tree()
  4983. a = Blob()
  4984. a.data = b"foo"
  4985. obj.add(b".git", 0o100644, a.id)
  4986. self.repo.object_store.add_objects([(a, None), (obj, None)])
  4987. self.assertEqual(
  4988. [(obj.id, "invalid name .git")],
  4989. [(sha, str(e)) for (sha, e) in porcelain.fsck(self.repo)],
  4990. )
  4991. class DescribeTests(PorcelainTestCase):
  4992. def test_no_commits(self) -> None:
  4993. self.assertRaises(KeyError, porcelain.describe, self.repo.path)
  4994. def test_single_commit(self) -> None:
  4995. fullpath = os.path.join(self.repo.path, "foo")
  4996. with open(fullpath, "w") as f:
  4997. f.write("BAR")
  4998. porcelain.add(repo=self.repo.path, paths=[fullpath])
  4999. sha = porcelain.commit(
  5000. self.repo.path,
  5001. message=b"Some message",
  5002. author=b"Joe <joe@example.com>",
  5003. committer=b"Bob <bob@example.com>",
  5004. )
  5005. self.assertEqual(
  5006. "g{}".format(sha[:7].decode("ascii")),
  5007. porcelain.describe(self.repo.path),
  5008. )
  5009. def test_tag(self) -> None:
  5010. fullpath = os.path.join(self.repo.path, "foo")
  5011. with open(fullpath, "w") as f:
  5012. f.write("BAR")
  5013. porcelain.add(repo=self.repo.path, paths=[fullpath])
  5014. porcelain.commit(
  5015. self.repo.path,
  5016. message=b"Some message",
  5017. author=b"Joe <joe@example.com>",
  5018. committer=b"Bob <bob@example.com>",
  5019. )
  5020. porcelain.tag_create(
  5021. self.repo.path,
  5022. b"tryme",
  5023. b"foo <foo@bar.com>",
  5024. b"bar",
  5025. annotated=True,
  5026. )
  5027. self.assertEqual("tryme", porcelain.describe(self.repo.path))
  5028. def test_tag_and_commit(self) -> None:
  5029. fullpath = os.path.join(self.repo.path, "foo")
  5030. with open(fullpath, "w") as f:
  5031. f.write("BAR")
  5032. porcelain.add(repo=self.repo.path, paths=[fullpath])
  5033. porcelain.commit(
  5034. self.repo.path,
  5035. message=b"Some message",
  5036. author=b"Joe <joe@example.com>",
  5037. committer=b"Bob <bob@example.com>",
  5038. )
  5039. porcelain.tag_create(
  5040. self.repo.path,
  5041. b"tryme",
  5042. b"foo <foo@bar.com>",
  5043. b"bar",
  5044. annotated=True,
  5045. )
  5046. with open(fullpath, "w") as f:
  5047. f.write("BAR2")
  5048. porcelain.add(repo=self.repo.path, paths=[fullpath])
  5049. sha = porcelain.commit(
  5050. self.repo.path,
  5051. message=b"Some message",
  5052. author=b"Joe <joe@example.com>",
  5053. committer=b"Bob <bob@example.com>",
  5054. )
  5055. self.assertEqual(
  5056. "tryme-1-g{}".format(sha[:7].decode("ascii")),
  5057. porcelain.describe(self.repo.path),
  5058. )
  5059. def test_tag_and_commit_full(self) -> None:
  5060. fullpath = os.path.join(self.repo.path, "foo")
  5061. with open(fullpath, "w") as f:
  5062. f.write("BAR")
  5063. porcelain.add(repo=self.repo.path, paths=[fullpath])
  5064. porcelain.commit(
  5065. self.repo.path,
  5066. message=b"Some message",
  5067. author=b"Joe <joe@example.com>",
  5068. committer=b"Bob <bob@example.com>",
  5069. )
  5070. porcelain.tag_create(
  5071. self.repo.path,
  5072. b"tryme",
  5073. b"foo <foo@bar.com>",
  5074. b"bar",
  5075. annotated=True,
  5076. )
  5077. with open(fullpath, "w") as f:
  5078. f.write("BAR2")
  5079. porcelain.add(repo=self.repo.path, paths=[fullpath])
  5080. sha = porcelain.commit(
  5081. self.repo.path,
  5082. message=b"Some message",
  5083. author=b"Joe <joe@example.com>",
  5084. committer=b"Bob <bob@example.com>",
  5085. )
  5086. self.assertEqual(
  5087. "tryme-1-g{}".format(sha.decode("ascii")),
  5088. porcelain.describe(self.repo.path, abbrev=40),
  5089. )
  5090. def test_untagged_commit_abbreviation(self) -> None:
  5091. _, _, c3 = build_commit_graph(self.repo.object_store, [[1], [2, 1], [3, 1, 2]])
  5092. self.repo.refs[b"HEAD"] = c3.id
  5093. brief_description, complete_description = (
  5094. porcelain.describe(self.repo),
  5095. porcelain.describe(self.repo, abbrev=40),
  5096. )
  5097. self.assertTrue(complete_description.startswith(brief_description))
  5098. self.assertEqual(
  5099. "g{}".format(c3.id.decode("ascii")),
  5100. complete_description,
  5101. )
  5102. class PathToTreeTests(PorcelainTestCase):
  5103. def setUp(self) -> None:
  5104. super().setUp()
  5105. self.fp = os.path.join(self.test_dir, "bar")
  5106. with open(self.fp, "w") as f:
  5107. f.write("something")
  5108. oldcwd = os.getcwd()
  5109. self.addCleanup(os.chdir, oldcwd)
  5110. os.chdir(self.test_dir)
  5111. def test_path_to_tree_path_base(self) -> None:
  5112. self.assertEqual(b"bar", porcelain.path_to_tree_path(self.test_dir, self.fp))
  5113. self.assertEqual(b"bar", porcelain.path_to_tree_path(".", "./bar"))
  5114. self.assertEqual(b"bar", porcelain.path_to_tree_path(".", "bar"))
  5115. cwd = os.getcwd()
  5116. self.assertEqual(
  5117. b"bar", porcelain.path_to_tree_path(".", os.path.join(cwd, "bar"))
  5118. )
  5119. self.assertEqual(b"bar", porcelain.path_to_tree_path(cwd, "bar"))
  5120. def test_path_to_tree_path_syntax(self) -> None:
  5121. self.assertEqual(b"bar", porcelain.path_to_tree_path(".", "./bar"))
  5122. def test_path_to_tree_path_error(self) -> None:
  5123. with self.assertRaises(ValueError):
  5124. with tempfile.TemporaryDirectory() as od:
  5125. porcelain.path_to_tree_path(od, self.fp)
  5126. def test_path_to_tree_path_rel(self) -> None:
  5127. cwd = os.getcwd()
  5128. os.mkdir(os.path.join(self.repo.path, "foo"))
  5129. os.mkdir(os.path.join(self.repo.path, "foo/bar"))
  5130. try:
  5131. os.chdir(os.path.join(self.repo.path, "foo/bar"))
  5132. with open("baz", "w") as f:
  5133. f.write("contents")
  5134. self.assertEqual(b"bar/baz", porcelain.path_to_tree_path("..", "baz"))
  5135. self.assertEqual(
  5136. b"bar/baz",
  5137. porcelain.path_to_tree_path(
  5138. os.path.join(os.getcwd(), ".."),
  5139. os.path.join(os.getcwd(), "baz"),
  5140. ),
  5141. )
  5142. self.assertEqual(
  5143. b"bar/baz",
  5144. porcelain.path_to_tree_path("..", os.path.join(os.getcwd(), "baz")),
  5145. )
  5146. self.assertEqual(
  5147. b"bar/baz",
  5148. porcelain.path_to_tree_path(os.path.join(os.getcwd(), ".."), "baz"),
  5149. )
  5150. finally:
  5151. os.chdir(cwd)
  5152. class GetObjectByPathTests(PorcelainTestCase):
  5153. def test_simple(self) -> None:
  5154. fullpath = os.path.join(self.repo.path, "foo")
  5155. with open(fullpath, "w") as f:
  5156. f.write("BAR")
  5157. porcelain.add(repo=self.repo.path, paths=[fullpath])
  5158. porcelain.commit(
  5159. self.repo.path,
  5160. message=b"Some message",
  5161. author=b"Joe <joe@example.com>",
  5162. committer=b"Bob <bob@example.com>",
  5163. )
  5164. self.assertEqual(b"BAR", porcelain.get_object_by_path(self.repo, "foo").data)
  5165. self.assertEqual(b"BAR", porcelain.get_object_by_path(self.repo, b"foo").data)
  5166. def test_encoding(self) -> None:
  5167. fullpath = os.path.join(self.repo.path, "foo")
  5168. with open(fullpath, "w") as f:
  5169. f.write("BAR")
  5170. porcelain.add(repo=self.repo.path, paths=[fullpath])
  5171. porcelain.commit(
  5172. self.repo.path,
  5173. message=b"Some message",
  5174. author=b"Joe <joe@example.com>",
  5175. committer=b"Bob <bob@example.com>",
  5176. encoding=b"utf-8",
  5177. )
  5178. self.assertEqual(b"BAR", porcelain.get_object_by_path(self.repo, "foo").data)
  5179. self.assertEqual(b"BAR", porcelain.get_object_by_path(self.repo, b"foo").data)
  5180. def test_missing(self) -> None:
  5181. self.assertRaises(KeyError, porcelain.get_object_by_path, self.repo, "foo")
  5182. class WriteTreeTests(PorcelainTestCase):
  5183. def test_simple(self) -> None:
  5184. fullpath = os.path.join(self.repo.path, "foo")
  5185. with open(fullpath, "w") as f:
  5186. f.write("BAR")
  5187. porcelain.add(repo=self.repo.path, paths=[fullpath])
  5188. self.assertEqual(
  5189. b"d2092c8a9f311f0311083bf8d177f2ca0ab5b241",
  5190. porcelain.write_tree(self.repo),
  5191. )
  5192. class ActiveBranchTests(PorcelainTestCase):
  5193. def test_simple(self) -> None:
  5194. self.assertEqual(b"master", porcelain.active_branch(self.repo))
  5195. class BranchTrackingTests(PorcelainTestCase):
  5196. def test_get_branch_merge(self) -> None:
  5197. # Set up branch tracking configuration
  5198. config = self.repo.get_config()
  5199. config.set((b"branch", b"master"), b"remote", b"origin")
  5200. config.set((b"branch", b"master"), b"merge", b"refs/heads/main")
  5201. config.write_to_path()
  5202. # Test getting merge ref for current branch
  5203. merge_ref = porcelain.get_branch_merge(self.repo)
  5204. self.assertEqual(b"refs/heads/main", merge_ref)
  5205. # Test getting merge ref for specific branch
  5206. merge_ref = porcelain.get_branch_merge(self.repo, b"master")
  5207. self.assertEqual(b"refs/heads/main", merge_ref)
  5208. # Test branch without merge config
  5209. with self.assertRaises(KeyError):
  5210. porcelain.get_branch_merge(self.repo, b"nonexistent")
  5211. def test_set_branch_tracking(self) -> None:
  5212. # Create a new branch
  5213. sha, _ = _commit_file_with_content(self.repo, "foo", "content\n")
  5214. porcelain.branch_create(self.repo, "feature")
  5215. # Set up tracking
  5216. porcelain.set_branch_tracking(
  5217. self.repo, b"feature", b"upstream", b"refs/heads/main"
  5218. )
  5219. # Verify configuration was written
  5220. config = self.repo.get_config()
  5221. self.assertEqual(b"upstream", config.get((b"branch", b"feature"), b"remote"))
  5222. self.assertEqual(
  5223. b"refs/heads/main", config.get((b"branch", b"feature"), b"merge")
  5224. )
  5225. class FindUniqueAbbrevTests(PorcelainTestCase):
  5226. def test_simple(self) -> None:
  5227. c1, c2, c3 = build_commit_graph(
  5228. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  5229. )
  5230. self.repo.refs[b"HEAD"] = c3.id
  5231. self.assertEqual(
  5232. c1.id.decode("ascii")[:7],
  5233. porcelain.find_unique_abbrev(self.repo.object_store, c1.id),
  5234. )
  5235. class PackRefsTests(PorcelainTestCase):
  5236. def test_all(self) -> None:
  5237. c1, c2, c3 = build_commit_graph(
  5238. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  5239. )
  5240. self.repo.refs[b"HEAD"] = c3.id
  5241. self.repo.refs[b"refs/heads/master"] = c2.id
  5242. self.repo.refs[b"refs/tags/foo"] = c1.id
  5243. porcelain.pack_refs(self.repo, all=True)
  5244. self.assertEqual(
  5245. self.repo.refs.get_packed_refs(),
  5246. {
  5247. b"refs/heads/master": c2.id,
  5248. b"refs/tags/foo": c1.id,
  5249. },
  5250. )
  5251. def test_not_all(self) -> None:
  5252. c1, c2, c3 = build_commit_graph(
  5253. self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
  5254. )
  5255. self.repo.refs[b"HEAD"] = c3.id
  5256. self.repo.refs[b"refs/heads/master"] = c2.id
  5257. self.repo.refs[b"refs/tags/foo"] = c1.id
  5258. porcelain.pack_refs(self.repo)
  5259. self.assertEqual(
  5260. self.repo.refs.get_packed_refs(),
  5261. {
  5262. b"refs/tags/foo": c1.id,
  5263. },
  5264. )
  5265. class ServerTests(PorcelainTestCase):
  5266. @contextlib.contextmanager
  5267. def _serving(self):
  5268. with make_server("localhost", 0, self.app) as server:
  5269. thread = threading.Thread(target=server.serve_forever, daemon=True)
  5270. thread.start()
  5271. try:
  5272. yield f"http://localhost:{server.server_port}"
  5273. finally:
  5274. server.shutdown()
  5275. thread.join(10)
  5276. def setUp(self) -> None:
  5277. super().setUp()
  5278. self.served_repo_path = os.path.join(self.test_dir, "served_repo.git")
  5279. self.served_repo = Repo.init_bare(self.served_repo_path, mkdir=True)
  5280. self.addCleanup(self.served_repo.close)
  5281. backend = DictBackend({"/": self.served_repo})
  5282. self.app = make_wsgi_chain(backend)
  5283. def test_pull(self) -> None:
  5284. (c1,) = build_commit_graph(self.served_repo.object_store, [[1]])
  5285. self.served_repo.refs[b"refs/heads/master"] = c1.id
  5286. with self._serving() as url:
  5287. porcelain.pull(self.repo, url, "master")
  5288. def test_push(self) -> None:
  5289. (c1,) = build_commit_graph(self.repo.object_store, [[1]])
  5290. self.repo.refs[b"refs/heads/master"] = c1.id
  5291. with self._serving() as url:
  5292. porcelain.push(self.repo, url, "master")
  5293. class ForEachTests(PorcelainTestCase):
  5294. def setUp(self) -> None:
  5295. super().setUp()
  5296. c1, c2, c3, c4 = build_commit_graph(
  5297. self.repo.object_store, [[1], [2, 1], [3, 1, 2], [4]]
  5298. )
  5299. porcelain.tag_create(
  5300. self.repo.path,
  5301. b"v0.1",
  5302. objectish=c1.id,
  5303. annotated=True,
  5304. message=b"0.1",
  5305. )
  5306. porcelain.tag_create(
  5307. self.repo.path,
  5308. b"v1.0",
  5309. objectish=c2.id,
  5310. annotated=True,
  5311. message=b"1.0",
  5312. )
  5313. porcelain.tag_create(self.repo.path, b"simple-tag", objectish=c3.id)
  5314. porcelain.tag_create(
  5315. self.repo.path,
  5316. b"v1.1",
  5317. objectish=c4.id,
  5318. annotated=True,
  5319. message=b"1.1",
  5320. )
  5321. porcelain.branch_create(
  5322. self.repo.path, b"feat", objectish=c2.id.decode("ascii")
  5323. )
  5324. self.repo.refs[b"HEAD"] = c4.id
  5325. def test_for_each_ref(self) -> None:
  5326. refs = porcelain.for_each_ref(self.repo)
  5327. self.assertEqual(
  5328. [(object_type, tag) for _, object_type, tag in refs],
  5329. [
  5330. (b"commit", b"refs/heads/feat"),
  5331. (b"commit", b"refs/heads/master"),
  5332. (b"commit", b"refs/tags/simple-tag"),
  5333. (b"tag", b"refs/tags/v0.1"),
  5334. (b"tag", b"refs/tags/v1.0"),
  5335. (b"tag", b"refs/tags/v1.1"),
  5336. ],
  5337. )
  5338. def test_for_each_ref_pattern(self) -> None:
  5339. versions = porcelain.for_each_ref(self.repo, pattern="refs/tags/v*")
  5340. self.assertEqual(
  5341. [(object_type, tag) for _, object_type, tag in versions],
  5342. [
  5343. (b"tag", b"refs/tags/v0.1"),
  5344. (b"tag", b"refs/tags/v1.0"),
  5345. (b"tag", b"refs/tags/v1.1"),
  5346. ],
  5347. )
  5348. versions = porcelain.for_each_ref(self.repo, pattern="refs/tags/v1.?")
  5349. self.assertEqual(
  5350. [(object_type, tag) for _, object_type, tag in versions],
  5351. [
  5352. (b"tag", b"refs/tags/v1.0"),
  5353. (b"tag", b"refs/tags/v1.1"),
  5354. ],
  5355. )
  5356. class SparseCheckoutTests(PorcelainTestCase):
  5357. """Integration tests for Dulwich's sparse checkout feature."""
  5358. # NOTE: We do NOT override `setUp()` here because the parent class
  5359. # (PorcelainTestCase) already:
  5360. # 1) Creates self.test_dir = a unique temp dir
  5361. # 2) Creates a subdir named "repo"
  5362. # 3) Calls Repo.init() on that path
  5363. # Re-initializing again caused FileExistsError.
  5364. #
  5365. # Utility/Placeholder
  5366. #
  5367. def sparse_checkout(self, repo, patterns, force=False):
  5368. """Wrapper around the actual porcelain.sparse_checkout function
  5369. to handle any test-specific setup or logging.
  5370. """
  5371. return porcelain.sparse_checkout(repo, patterns, force=force)
  5372. def _write_file(self, rel_path, content):
  5373. """Helper to write a file in the repository working tree."""
  5374. abs_path = os.path.join(self.repo_path, rel_path)
  5375. os.makedirs(os.path.dirname(abs_path), exist_ok=True)
  5376. with open(abs_path, "w") as f:
  5377. f.write(content)
  5378. return abs_path
  5379. def _commit_file(self, rel_path, content):
  5380. """Helper to write, add, and commit a file."""
  5381. abs_path = self._write_file(rel_path, content)
  5382. add(self.repo_path, paths=[abs_path])
  5383. commit(self.repo_path, message=b"Added " + rel_path.encode("utf-8"))
  5384. def _list_wtree_files(self):
  5385. """Return a set of all files (not dirs) present
  5386. in the working tree, ignoring .git/.
  5387. """
  5388. found_files = set()
  5389. for root, dirs, files in os.walk(self.repo_path):
  5390. # Skip .git in the walk
  5391. if ".git" in dirs:
  5392. dirs.remove(".git")
  5393. for filename in files:
  5394. file_rel = os.path.relpath(os.path.join(root, filename), self.repo_path)
  5395. found_files.add(file_rel)
  5396. return found_files
  5397. def test_only_included_paths_appear_in_wtree(self):
  5398. """Only included paths remain in the working tree, excluded paths are removed.
  5399. Commits two files, "keep_me.txt" and "exclude_me.txt". Then applies a
  5400. sparse-checkout pattern containing only "keep_me.txt". Ensures that
  5401. the latter remains in the working tree, while "exclude_me.txt" is
  5402. removed. This verifies correct application of sparse-checkout patterns
  5403. to remove files not listed.
  5404. """
  5405. self._commit_file("keep_me.txt", "I'll stay\n")
  5406. self._commit_file("exclude_me.txt", "I'll be excluded\n")
  5407. patterns = ["keep_me.txt"]
  5408. self.sparse_checkout(self.repo, patterns)
  5409. actual_files = self._list_wtree_files()
  5410. expected_files = {"keep_me.txt"}
  5411. self.assertEqual(
  5412. expected_files,
  5413. actual_files,
  5414. f"Expected only {expected_files}, but found {actual_files}",
  5415. )
  5416. def test_previously_included_paths_become_excluded(self):
  5417. """Previously included files become excluded after pattern changes.
  5418. Verifies that files initially brought into the working tree (e.g.,
  5419. by including `data/`) can later be excluded by narrowing the
  5420. sparse-checkout pattern to just `data/included_1.txt`. Confirms that
  5421. the file `data/included_2.txt` remains in the index with
  5422. skip-worktree set (rather than being removed entirely), ensuring
  5423. data is not lost and Dulwich correctly updates the index flags.
  5424. """
  5425. self._commit_file("data/included_1.txt", "some content\n")
  5426. self._commit_file("data/included_2.txt", "other content\n")
  5427. initial_patterns = ["data/"]
  5428. self.sparse_checkout(self.repo, initial_patterns)
  5429. updated_patterns = ["data/included_1.txt"]
  5430. self.sparse_checkout(self.repo, updated_patterns)
  5431. actual_files = self._list_wtree_files()
  5432. expected_files = {os.path.join("data", "included_1.txt")}
  5433. self.assertEqual(expected_files, actual_files)
  5434. idx = self.repo.open_index()
  5435. self.assertIn(b"data/included_2.txt", idx)
  5436. entry = idx[b"data/included_2.txt"]
  5437. self.assertTrue(entry.skip_worktree)
  5438. def test_force_removes_local_changes_for_excluded_paths(self):
  5439. """Forced sparse checkout removes local modifications for newly excluded paths.
  5440. Verifies that specifying force=True allows destructive operations
  5441. which discard uncommitted changes. First, we commit "file1.txt" and
  5442. then modify it. Next, we apply a pattern that excludes the file,
  5443. using force=True. The local modifications (and the file) should
  5444. be removed, leaving the working tree empty.
  5445. """
  5446. self._commit_file("file1.txt", "original content\n")
  5447. file1_path = os.path.join(self.repo_path, "file1.txt")
  5448. with open(file1_path, "a") as f:
  5449. f.write("local changes!\n")
  5450. new_patterns = ["some_other_file.txt"]
  5451. self.sparse_checkout(self.repo, new_patterns, force=True)
  5452. actual_files = self._list_wtree_files()
  5453. self.assertEqual(
  5454. set(),
  5455. actual_files,
  5456. "Force-sparse-checkout did not remove file with local changes.",
  5457. )
  5458. def test_destructive_refuse_uncommitted_changes_without_force(self):
  5459. """Fail on uncommitted changes for newly excluded paths without force.
  5460. Ensures that a sparse checkout is blocked if it would remove local
  5461. modifications from the working tree. We commit 'config.yaml', then
  5462. modify it, and finally attempt to exclude it via new patterns without
  5463. using force=True. This should raise a CheckoutError rather than
  5464. discarding the local changes.
  5465. """
  5466. self._commit_file("config.yaml", "initial\n")
  5467. cfg_path = os.path.join(self.repo_path, "config.yaml")
  5468. with open(cfg_path, "a") as f:
  5469. f.write("local modifications\n")
  5470. exclude_patterns = ["docs/"]
  5471. with self.assertRaises(CheckoutError):
  5472. self.sparse_checkout(self.repo, exclude_patterns, force=False)
  5473. def test_fnmatch_gitignore_pattern_expansion(self):
  5474. """Reading/writing patterns align with gitignore/fnmatch expansions.
  5475. Ensures that `sparse_checkout` interprets wildcard patterns (like `*.py`)
  5476. in the same way Git's sparse-checkout would. Multiple files are committed
  5477. to `src/` (e.g. `foo.py`, `foo_test.py`, `foo_helper.py`) and to `docs/`.
  5478. Then the pattern `src/foo*.py` is applied, confirming that only the
  5479. matching Python files remain in the working tree while the Markdown file
  5480. under `docs/` is excluded.
  5481. Finally, verifies that the `.git/info/sparse-checkout` file contains the
  5482. specified wildcard pattern (`src/foo*.py`), ensuring correct round-trip
  5483. of user-supplied patterns.
  5484. """
  5485. self._commit_file("src/foo.py", "print('hello')\n")
  5486. self._commit_file("src/foo_test.py", "print('test')\n")
  5487. self._commit_file("docs/readme.md", "# docs\n")
  5488. self._commit_file("src/foo_helper.py", "print('helper')\n")
  5489. patterns = ["src/foo*.py"]
  5490. self.sparse_checkout(self.repo, patterns)
  5491. actual_files = self._list_wtree_files()
  5492. expected_files = {
  5493. os.path.join("src", "foo.py"),
  5494. os.path.join("src", "foo_test.py"),
  5495. os.path.join("src", "foo_helper.py"),
  5496. }
  5497. self.assertEqual(
  5498. expected_files,
  5499. actual_files,
  5500. "Wildcard pattern not matched as expected. Either too strict or too broad.",
  5501. )
  5502. sc_file = os.path.join(self.repo_path, ".git", "info", "sparse-checkout")
  5503. self.assertTrue(os.path.isfile(sc_file))
  5504. with open(sc_file) as f:
  5505. lines = f.read().strip().split()
  5506. self.assertIn("src/foo*.py", lines)
  5507. class ConeModeTests(PorcelainTestCase):
  5508. """Provide integration tests for Dulwich's cone mode sparse checkout.
  5509. This test suite verifies the expected behavior for:
  5510. * cone_mode_init
  5511. * cone_mode_set
  5512. * cone_mode_add
  5513. Although Dulwich does not yet implement cone mode, these tests are
  5514. prepared in advance to guide future development.
  5515. """
  5516. def setUp(self):
  5517. """Set up a fresh repository for each test.
  5518. This method creates a new empty repo_path and Repo object
  5519. as provided by the PorcelainTestCase base class.
  5520. """
  5521. super().setUp()
  5522. def _commit_file(self, rel_path, content=b"contents"):
  5523. """Add a file at the given relative path and commit it.
  5524. Creates necessary directories, writes the file content,
  5525. stages, and commits. The commit message and author/committer
  5526. are also provided.
  5527. """
  5528. full_path = os.path.join(self.repo_path, rel_path)
  5529. os.makedirs(os.path.dirname(full_path), exist_ok=True)
  5530. with open(full_path, "wb") as f:
  5531. f.write(content)
  5532. porcelain.add(self.repo_path, paths=[full_path])
  5533. porcelain.commit(
  5534. self.repo_path,
  5535. message=b"Adding " + rel_path.encode("utf-8"),
  5536. author=b"Test Author <author@example.com>",
  5537. committer=b"Test Committer <committer@example.com>",
  5538. )
  5539. def _list_wtree_files(self):
  5540. """Return a set of all file paths relative to the repository root.
  5541. Walks the working tree, skipping the .git directory.
  5542. """
  5543. found_files = set()
  5544. for root, dirs, files in os.walk(self.repo_path):
  5545. if ".git" in dirs:
  5546. dirs.remove(".git")
  5547. for fn in files:
  5548. relp = os.path.relpath(os.path.join(root, fn), self.repo_path)
  5549. found_files.add(relp)
  5550. return found_files
  5551. def test_init_excludes_everything(self):
  5552. """Verify that cone_mode_init writes minimal patterns and empties the working tree.
  5553. Make some dummy files, commit them, then call cone_mode_init. Confirm
  5554. that the working tree is empty, the sparse-checkout file has the
  5555. minimal patterns (/*, !/*/), and the relevant config values are set.
  5556. """
  5557. self._commit_file("docs/readme.md", b"# doc\n")
  5558. self._commit_file("src/main.py", b"print('hello')\n")
  5559. porcelain.cone_mode_init(self.repo)
  5560. actual_files = self._list_wtree_files()
  5561. self.assertEqual(
  5562. set(),
  5563. actual_files,
  5564. "cone_mode_init did not exclude all files from the working tree.",
  5565. )
  5566. sp_path = os.path.join(self.repo_path, ".git", "info", "sparse-checkout")
  5567. with open(sp_path) as f:
  5568. lines = [ln.strip() for ln in f if ln.strip()]
  5569. self.assertIn("/*", lines)
  5570. self.assertIn("!/*/", lines)
  5571. config = self.repo.get_config()
  5572. self.assertEqual(config.get((b"core",), b"sparseCheckout"), b"true")
  5573. self.assertEqual(config.get((b"core",), b"sparseCheckoutCone"), b"true")
  5574. def test_set_specific_dirs(self):
  5575. """Verify that cone_mode_set overwrites the included directories to only the specified ones.
  5576. Initializes cone mode, commits some files, then calls cone_mode_set with
  5577. a list of directories. Expects that only those directories remain in the
  5578. working tree.
  5579. """
  5580. porcelain.cone_mode_init(self.repo)
  5581. self._commit_file("docs/readme.md", b"# doc\n")
  5582. self._commit_file("src/main.py", b"print('hello')\n")
  5583. self._commit_file("tests/test_foo.py", b"# tests\n")
  5584. # Everything is still excluded initially by init.
  5585. porcelain.cone_mode_set(self.repo, dirs=["docs", "src"])
  5586. actual_files = self._list_wtree_files()
  5587. expected_files = {
  5588. os.path.join("docs", "readme.md"),
  5589. os.path.join("src", "main.py"),
  5590. }
  5591. self.assertEqual(
  5592. expected_files,
  5593. actual_files,
  5594. "Did not see only the 'docs/' and 'src/' dirs in the working tree.",
  5595. )
  5596. sp_path = os.path.join(self.repo_path, ".git", "info", "sparse-checkout")
  5597. with open(sp_path) as f:
  5598. lines = [ln.strip() for ln in f if ln.strip()]
  5599. # For standard cone mode, we'd expect lines like:
  5600. # /* (include top-level files)
  5601. # !/*/ (exclude subdirectories)
  5602. # !/docs/ (re-include docs)
  5603. # !/src/ (re-include src)
  5604. # Instead of the wildcard-based lines the old test used.
  5605. self.assertIn("/*", lines)
  5606. self.assertIn("!/*/", lines)
  5607. self.assertIn("/docs/", lines)
  5608. self.assertIn("/src/", lines)
  5609. self.assertNotIn("/tests/", lines)
  5610. def test_set_overwrites_old_dirs(self):
  5611. """Ensure that calling cone_mode_set again overwrites old includes.
  5612. Initializes cone mode, includes two directories, then calls
  5613. cone_mode_set again with a different directory to confirm the
  5614. new set of includes replaces the old.
  5615. """
  5616. porcelain.cone_mode_init(self.repo)
  5617. self._commit_file("docs/readme.md")
  5618. self._commit_file("src/main.py")
  5619. self._commit_file("tests/test_bar.py")
  5620. porcelain.cone_mode_set(self.repo, dirs=["docs", "src"])
  5621. self.assertEqual(
  5622. {os.path.join("docs", "readme.md"), os.path.join("src", "main.py")},
  5623. self._list_wtree_files(),
  5624. )
  5625. # Overwrite includes, now only 'tests'
  5626. porcelain.cone_mode_set(self.repo, dirs=["tests"], force=True)
  5627. actual_files = self._list_wtree_files()
  5628. expected_files = {os.path.join("tests", "test_bar.py")}
  5629. self.assertEqual(expected_files, actual_files)
  5630. def test_force_removal_of_local_mods(self):
  5631. """Confirm that force=True removes local changes in excluded paths.
  5632. cone_mode_init and cone_mode_set are called, a file is locally modified,
  5633. and then cone_mode_set is called again with force=True to exclude that path.
  5634. The excluded file should be removed with no CheckoutError.
  5635. """
  5636. porcelain.cone_mode_init(self.repo)
  5637. porcelain.cone_mode_set(self.repo, dirs=["docs"])
  5638. self._commit_file("docs/readme.md", b"Docs stuff\n")
  5639. self._commit_file("src/main.py", b"print('hello')\n")
  5640. # Modify src/main.py
  5641. with open(os.path.join(self.repo_path, "src/main.py"), "ab") as f:
  5642. f.write(b"extra line\n")
  5643. # Exclude src/ with force=True
  5644. porcelain.cone_mode_set(self.repo, dirs=["docs"], force=True)
  5645. actual_files = self._list_wtree_files()
  5646. expected_files = {os.path.join("docs", "readme.md")}
  5647. self.assertEqual(expected_files, actual_files)
  5648. def test_add_and_merge_dirs(self):
  5649. """Verify that cone_mode_add merges new directories instead of overwriting them.
  5650. After initializing cone mode and including a single directory, call
  5651. cone_mode_add with a new directory. Confirm that both directories
  5652. remain included. Repeat for an additional directory to ensure it
  5653. is merged, not overwritten.
  5654. """
  5655. porcelain.cone_mode_init(self.repo)
  5656. self._commit_file("docs/readme.md", b"# doc\n")
  5657. self._commit_file("src/main.py", b"print('hello')\n")
  5658. self._commit_file("tests/test_bar.py", b"# tests\n")
  5659. # Include "docs" only
  5660. porcelain.cone_mode_set(self.repo, dirs=["docs"])
  5661. self.assertEqual({os.path.join("docs", "readme.md")}, self._list_wtree_files())
  5662. # Add "src"
  5663. porcelain.cone_mode_add(self.repo, dirs=["src"])
  5664. actual_files = self._list_wtree_files()
  5665. self.assertEqual(
  5666. {os.path.join("docs", "readme.md"), os.path.join("src", "main.py")},
  5667. actual_files,
  5668. )
  5669. # Add "tests" as well
  5670. porcelain.cone_mode_add(self.repo, dirs=["tests"])
  5671. actual_files = self._list_wtree_files()
  5672. expected_files = {
  5673. os.path.join("docs", "readme.md"),
  5674. os.path.join("src", "main.py"),
  5675. os.path.join("tests", "test_bar.py"),
  5676. }
  5677. self.assertEqual(expected_files, actual_files)
  5678. # Check .git/info/sparse-checkout
  5679. sp_path = os.path.join(self.repo_path, ".git", "info", "sparse-checkout")
  5680. with open(sp_path) as f:
  5681. lines = [ln.strip() for ln in f if ln.strip()]
  5682. # Standard cone mode lines:
  5683. # "/*" -> include top-level
  5684. # "!/*/" -> exclude subdirectories
  5685. # "!/docs/", "!/src/", "!/tests/" -> re-include the directories we added
  5686. self.assertIn("/*", lines)
  5687. self.assertIn("!/*/", lines)
  5688. self.assertIn("/docs/", lines)
  5689. self.assertIn("/src/", lines)
  5690. self.assertIn("/tests/", lines)
  5691. class UnpackObjectsTest(PorcelainTestCase):
  5692. def test_unpack_objects(self):
  5693. """Test unpacking objects from a pack file."""
  5694. # Create a test repository with some objects
  5695. b1 = Blob()
  5696. b1.data = b"test content 1"
  5697. b2 = Blob()
  5698. b2.data = b"test content 2"
  5699. # Add objects to the repo
  5700. self.repo.object_store.add_object(b1)
  5701. self.repo.object_store.add_object(b2)
  5702. # Create a pack file with these objects
  5703. pack_path = os.path.join(self.test_dir, "test_pack")
  5704. with (
  5705. open(pack_path + ".pack", "wb") as pack_f,
  5706. open(pack_path + ".idx", "wb") as idx_f,
  5707. ):
  5708. porcelain.pack_objects(
  5709. self.repo,
  5710. [b1.id, b2.id],
  5711. pack_f,
  5712. idx_f,
  5713. )
  5714. # Create a new repository to unpack into
  5715. target_repo_path = os.path.join(self.test_dir, "target_repo")
  5716. target_repo = Repo.init(target_repo_path, mkdir=True)
  5717. self.addCleanup(target_repo.close)
  5718. # Unpack the objects
  5719. count = porcelain.unpack_objects(pack_path + ".pack", target_repo_path)
  5720. # Verify the objects were unpacked
  5721. self.assertEqual(2, count)
  5722. self.assertIn(b1.id, target_repo.object_store)
  5723. self.assertIn(b2.id, target_repo.object_store)
  5724. # Verify the content is correct
  5725. unpacked_b1 = target_repo.object_store[b1.id]
  5726. unpacked_b2 = target_repo.object_store[b2.id]
  5727. self.assertEqual(b1.data, unpacked_b1.data)
  5728. self.assertEqual(b2.data, unpacked_b2.data)
  5729. class CountObjectsTests(PorcelainTestCase):
  5730. def test_count_objects_empty_repo(self):
  5731. """Test counting objects in an empty repository."""
  5732. stats = porcelain.count_objects(self.repo)
  5733. self.assertEqual(0, stats.count)
  5734. self.assertEqual(0, stats.size)
  5735. def test_count_objects_verbose_empty_repo(self):
  5736. """Test verbose counting in an empty repository."""
  5737. stats = porcelain.count_objects(self.repo, verbose=True)
  5738. self.assertEqual(0, stats.count)
  5739. self.assertEqual(0, stats.size)
  5740. self.assertEqual(0, stats.in_pack)
  5741. self.assertEqual(0, stats.packs)
  5742. self.assertEqual(0, stats.size_pack)
  5743. def test_count_objects_with_loose_objects(self):
  5744. """Test counting loose objects."""
  5745. # Create some loose objects
  5746. blob1 = make_object(Blob, data=b"data1")
  5747. blob2 = make_object(Blob, data=b"data2")
  5748. self.repo.object_store.add_object(blob1)
  5749. self.repo.object_store.add_object(blob2)
  5750. stats = porcelain.count_objects(self.repo)
  5751. self.assertEqual(2, stats.count)
  5752. self.assertGreater(stats.size, 0)
  5753. def test_count_objects_verbose_with_objects(self):
  5754. """Test verbose counting with both loose and packed objects."""
  5755. # Add some loose objects
  5756. for i in range(3):
  5757. blob = make_object(Blob, data=f"data{i}".encode())
  5758. self.repo.object_store.add_object(blob)
  5759. # Create a simple commit to have some objects in a pack
  5760. tree = Tree()
  5761. c1 = make_commit(tree=tree.id, message=b"Test commit")
  5762. self.repo.object_store.add_objects([(tree, None), (c1, None)])
  5763. self.repo.refs[b"HEAD"] = c1.id
  5764. # Repack to create a pack file
  5765. porcelain.repack(self.repo)
  5766. stats = porcelain.count_objects(self.repo, verbose=True)
  5767. # After repacking, loose objects might be cleaned up
  5768. self.assertIsInstance(stats.count, int)
  5769. self.assertIsInstance(stats.size, int)
  5770. self.assertGreater(stats.in_pack, 0) # Should have packed objects
  5771. self.assertGreater(stats.packs, 0) # Should have at least one pack
  5772. self.assertGreater(stats.size_pack, 0) # Pack should have size
  5773. # Verify it's the correct dataclass type
  5774. self.assertIsInstance(stats, CountObjectsResult)
  5775. class PruneTests(PorcelainTestCase):
  5776. def test_prune_removes_old_tempfiles(self):
  5777. """Test that prune removes old temporary files."""
  5778. # Create an old temporary file in the objects directory
  5779. objects_dir = os.path.join(self.repo.path, ".git", "objects")
  5780. tmp_pack_path = os.path.join(objects_dir, "tmp_pack_test")
  5781. with open(tmp_pack_path, "wb") as f:
  5782. f.write(b"old temporary data")
  5783. # Make it old
  5784. old_time = time.time() - (DEFAULT_TEMPFILE_GRACE_PERIOD + 3600)
  5785. os.utime(tmp_pack_path, (old_time, old_time))
  5786. # Run prune
  5787. porcelain.prune(self.repo.path)
  5788. # Verify the file was removed
  5789. self.assertFalse(os.path.exists(tmp_pack_path))
  5790. def test_prune_keeps_recent_tempfiles(self):
  5791. """Test that prune keeps recent temporary files."""
  5792. # Create a recent temporary file
  5793. objects_dir = os.path.join(self.repo.path, ".git", "objects")
  5794. tmp_pack_path = os.path.join(objects_dir, "tmp_pack_recent")
  5795. with open(tmp_pack_path, "wb") as f:
  5796. f.write(b"recent temporary data")
  5797. self.addCleanup(os.remove, tmp_pack_path)
  5798. # Run prune
  5799. porcelain.prune(self.repo.path)
  5800. # Verify the file was NOT removed
  5801. self.assertTrue(os.path.exists(tmp_pack_path))
  5802. def test_prune_with_custom_grace_period(self):
  5803. """Test prune with custom grace period."""
  5804. # Create a 1-hour-old temporary file
  5805. objects_dir = os.path.join(self.repo.path, ".git", "objects")
  5806. tmp_pack_path = os.path.join(objects_dir, "tmp_pack_1hour")
  5807. with open(tmp_pack_path, "wb") as f:
  5808. f.write(b"1 hour old data")
  5809. # Make it 1 hour old
  5810. old_time = time.time() - 3600
  5811. os.utime(tmp_pack_path, (old_time, old_time))
  5812. # Prune with 30-minute grace period should remove it
  5813. porcelain.prune(self.repo.path, grace_period=1800)
  5814. # Verify the file was removed
  5815. self.assertFalse(os.path.exists(tmp_pack_path))
  5816. def test_prune_dry_run(self):
  5817. """Test prune in dry-run mode."""
  5818. # Create an old temporary file
  5819. objects_dir = os.path.join(self.repo.path, ".git", "objects")
  5820. tmp_pack_path = os.path.join(objects_dir, "tmp_pack_dryrun")
  5821. with open(tmp_pack_path, "wb") as f:
  5822. f.write(b"old temporary data")
  5823. self.addCleanup(os.remove, tmp_pack_path)
  5824. # Make it old
  5825. old_time = time.time() - (DEFAULT_TEMPFILE_GRACE_PERIOD + 3600)
  5826. os.utime(tmp_pack_path, (old_time, old_time))
  5827. # Run prune in dry-run mode
  5828. porcelain.prune(self.repo.path, dry_run=True)
  5829. # Verify the file was NOT removed (dry run)
  5830. self.assertTrue(os.path.exists(tmp_pack_path))
  5831. class FilterBranchTests(PorcelainTestCase):
  5832. def setUp(self):
  5833. super().setUp()
  5834. # Create initial commits with different authors
  5835. from dulwich.objects import Commit, Tree
  5836. # Create actual tree and blob objects
  5837. tree = Tree()
  5838. self.repo.object_store.add_object(tree)
  5839. c1 = Commit()
  5840. c1.tree = tree.id
  5841. c1.parents = []
  5842. c1.author = b"Old Author <old@example.com>"
  5843. c1.author_time = 1000
  5844. c1.author_timezone = 0
  5845. c1.committer = b"Old Committer <old@example.com>"
  5846. c1.commit_time = 1000
  5847. c1.commit_timezone = 0
  5848. c1.message = b"Initial commit"
  5849. self.repo.object_store.add_object(c1)
  5850. c2 = Commit()
  5851. c2.tree = tree.id
  5852. c2.parents = [c1.id]
  5853. c2.author = b"Another Author <another@example.com>"
  5854. c2.author_time = 2000
  5855. c2.author_timezone = 0
  5856. c2.committer = b"Another Committer <another@example.com>"
  5857. c2.commit_time = 2000
  5858. c2.commit_timezone = 0
  5859. c2.message = b"Second commit\n\nWith body"
  5860. self.repo.object_store.add_object(c2)
  5861. c3 = Commit()
  5862. c3.tree = tree.id
  5863. c3.parents = [c2.id]
  5864. c3.author = b"Third Author <third@example.com>"
  5865. c3.author_time = 3000
  5866. c3.author_timezone = 0
  5867. c3.committer = b"Third Committer <third@example.com>"
  5868. c3.commit_time = 3000
  5869. c3.commit_timezone = 0
  5870. c3.message = b"Third commit"
  5871. self.repo.object_store.add_object(c3)
  5872. self.repo.refs[b"refs/heads/master"] = c3.id
  5873. self.repo.refs.set_symbolic_ref(b"HEAD", b"refs/heads/master")
  5874. # Store IDs for test assertions
  5875. self.c1_id = c1.id
  5876. self.c2_id = c2.id
  5877. self.c3_id = c3.id
  5878. def test_filter_branch_author(self):
  5879. """Test filtering branch with author changes."""
  5880. def filter_author(author):
  5881. # Change all authors to "New Author"
  5882. return b"New Author <new@example.com>"
  5883. result = porcelain.filter_branch(
  5884. self.repo_path, "master", filter_author=filter_author
  5885. )
  5886. # Check that we have mappings for all commits
  5887. self.assertEqual(len(result), 3)
  5888. # Verify the branch ref was updated
  5889. new_head = self.repo.refs[b"refs/heads/master"]
  5890. self.assertNotEqual(new_head, self.c3_id)
  5891. # Verify the original ref was saved
  5892. original_ref = self.repo.refs[b"refs/original/refs/heads/master"]
  5893. self.assertEqual(original_ref, self.c3_id)
  5894. # Check that authors were updated
  5895. new_commit = self.repo[new_head]
  5896. self.assertEqual(new_commit.author, b"New Author <new@example.com>")
  5897. # Check parent chain
  5898. parent = self.repo[new_commit.parents[0]]
  5899. self.assertEqual(parent.author, b"New Author <new@example.com>")
  5900. def test_filter_branch_message(self):
  5901. """Test filtering branch with message changes."""
  5902. def filter_message(message):
  5903. # Add prefix to all messages
  5904. return b"[FILTERED] " + message
  5905. porcelain.filter_branch(self.repo_path, "master", filter_message=filter_message)
  5906. # Verify messages were updated
  5907. new_head = self.repo.refs[b"refs/heads/master"]
  5908. new_commit = self.repo[new_head]
  5909. self.assertTrue(new_commit.message.startswith(b"[FILTERED] "))
  5910. def test_filter_branch_custom_filter(self):
  5911. """Test filtering branch with custom filter function."""
  5912. def custom_filter(commit):
  5913. # Change both author and message
  5914. return {
  5915. "author": b"Custom Author <custom@example.com>",
  5916. "message": b"Custom: " + commit.message,
  5917. }
  5918. porcelain.filter_branch(self.repo_path, "master", filter_fn=custom_filter)
  5919. # Verify custom filter was applied
  5920. new_head = self.repo.refs[b"refs/heads/master"]
  5921. new_commit = self.repo[new_head]
  5922. self.assertEqual(new_commit.author, b"Custom Author <custom@example.com>")
  5923. self.assertTrue(new_commit.message.startswith(b"Custom: "))
  5924. def test_filter_branch_no_changes(self):
  5925. """Test filtering branch with no changes."""
  5926. result = porcelain.filter_branch(self.repo_path, "master")
  5927. # All commits should map to themselves
  5928. for old_sha, new_sha in result.items():
  5929. self.assertEqual(old_sha, new_sha)
  5930. # HEAD should be unchanged
  5931. self.assertEqual(self.repo.refs[b"refs/heads/master"], self.c3_id)
  5932. def test_filter_branch_force(self):
  5933. """Test force filtering a previously filtered branch."""
  5934. # First filter
  5935. porcelain.filter_branch(
  5936. self.repo_path, "master", filter_message=lambda m: b"First: " + m
  5937. )
  5938. # Try again without force - should fail
  5939. with self.assertRaises(porcelain.Error):
  5940. porcelain.filter_branch(
  5941. self.repo_path, "master", filter_message=lambda m: b"Second: " + m
  5942. )
  5943. # Try again with force - should succeed
  5944. porcelain.filter_branch(
  5945. self.repo_path,
  5946. "master",
  5947. filter_message=lambda m: b"Second: " + m,
  5948. force=True,
  5949. )
  5950. # Verify second filter was applied
  5951. new_head = self.repo.refs[b"refs/heads/master"]
  5952. new_commit = self.repo[new_head]
  5953. self.assertTrue(new_commit.message.startswith(b"Second: First: "))