Something went wrong. Try again.
Simple, intuitive CLI framework for Go pkg.go.dev/go.followtheprocess.codes/cli
Something went wrong. Try again.
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651package flag_test
import ( "iter" "maps" "net" "slices" "testing" "time"
publicflag "go.followtheprocess.codes/cli/flag" "go.followtheprocess.codes/cli/internal/flag" "go.followtheprocess.codes/cli/internal/format" "go.followtheprocess.codes/test")
func TestParse(t *testing.T) { tests := []struct { name string // The name of the test case errMsg string // If we did get an error, what should it say newSet func(t *testing.T) *flag.Set // Function to create a set for testing test func(t *testing.T, set *flag.Set) // Function to invoke to test the set's functionality args []string // The arguments provided to parse wantErr bool // Whether we want a parse error }{ { name: "empty set no args", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("something") test.False(t, exists) test.Equal(t, f, nil)
test.EqualFunc(t, set.Args(), nil, slices.Equal) }, args: []string{}, wantErr: false, }, { name: "empty set args no flags", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("something") test.False(t, exists) test.Equal(t, f, nil)
test.EqualFunc(t, set.Args(), []string{"some", "args", "here", "no", "flags"}, slices.Equal) }, args: []string{"some", "args", "here", "no", "flags"}, wantErr: false, }, { name: "empty set args with terminator", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("something") test.False(t, exists) test.Equal(t, f, nil)
test.EqualFunc( t, set.Args(), []string{"some", "args", "here", "no", "flags", "extra", "args"}, slices.Equal, ) test.EqualFunc(t, set.ExtraArgs(), []string{"extra", "args"}, slices.Equal) }, args: []string{"some", "args", "here", "no", "flags", "--", "extra", "args"}, wantErr: false, }, { name: "empty set with flags", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("flag") test.False(t, exists) test.Equal(t, f, nil)
test.EqualFunc(t, set.Args(), []string{"some", "args", "here"}, slices.Equal) }, args: []string{"some", "args", "here", "--flag", "-s"}, wantErr: true, errMsg: "unrecognised flag: --flag", }, { name: "undefined flag long", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, args: []string{"--unknown"}, wantErr: true, errMsg: "unrecognised flag: --unknown", }, { name: "undefined flag short", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, args: []string{"-u"}, wantErr: true, errMsg: `unrecognised shorthand flag: "u" in -u`, }, { name: "undefined flag long with value", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, args: []string{"--unknown", "value"}, wantErr: true, errMsg: "unrecognised flag: --unknown", }, { name: "undefined flag short with value", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, args: []string{"-u", "value"}, wantErr: true, errMsg: `unrecognised shorthand flag: "u" in -u`, }, { name: "undefined flag long equals value", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, args: []string{"--unknown=value"}, wantErr: true, errMsg: "unrecognised flag: --unknown", }, { name: "undefined flag short equals value", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, args: []string{"-u=value"}, wantErr: true, errMsg: `unrecognised shorthand flag: "u" in -u=value`, }, { name: "undefined flag shortvalue", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, args: []string{"-uvalue"}, wantErr: true, errMsg: `unrecognised shorthand flag: "u" in -uvalue`, }, { name: "bad syntax short empty name", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, args: []string{"-"}, wantErr: true, errMsg: `invalid flag name "": must not be empty`, }, { name: "bad syntax short more than 1 char equals", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, args: []string{"-dfv=something"}, wantErr: true, errMsg: `unrecognised shorthand flag: "d" in -dfv=something`, }, { name: "valid long", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(bool), "delete", 'd', "Delete something", flag.Config[bool]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { flag, exists := set.Get("delete") test.True(t, exists)
test.Equal(t, flag.Type(), "bool") test.Equal(t, flag.String(), format.True)
test.EqualFunc(t, set.Args(), nil, slices.Equal) }, args: []string{"--delete"}, wantErr: false, }, { name: "valid long with args", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(bool), "delete", 'd', "Delete something", flag.Config[bool]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { flag, exists := set.Get("delete") test.True(t, exists)
test.Equal(t, flag.Type(), "bool") test.Equal(t, flag.String(), format.True)
test.EqualFunc(t, set.Args(), []string{"some", "subcommand", "extra", "args"}, slices.Equal) test.EqualFunc(t, set.ExtraArgs(), []string{"extra", "args"}, slices.Equal) }, args: []string{"some", "subcommand", "--delete", "--", "extra", "args"}, wantErr: false, }, { name: "valid short", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(bool), "delete", 'd', "Delete something", flag.Config[bool]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { // Get by name flag, exists := set.Get("delete") test.True(t, exists)
test.Equal(t, flag.Type(), "bool") test.Equal(t, flag.String(), format.True)
// Get by short flag, exists = set.GetShort('d') test.True(t, exists)
test.Equal(t, flag.Type(), "bool") test.Equal(t, flag.String(), format.True)
test.EqualFunc(t, set.Args(), nil, slices.Equal) }, args: []string{"-d"}, wantErr: false, }, { name: "valid shortvalue", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int), "number", 'n', "Number of something", flag.Config[int]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { // Get by name flag, exists := set.Get("number") test.True(t, exists)
test.Equal(t, flag.Type(), "int") test.Equal(t, flag.String(), "42")
// Get by short flag, exists = set.GetShort('n') test.True(t, exists)
test.Equal(t, flag.Type(), "int") test.Equal(t, flag.String(), "42") }, args: []string{"-n42"}, wantErr: false, }, { name: "valid short with args", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(bool), "delete", 'd', "Delete something", flag.Config[bool]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { // Get by name flag, exists := set.Get("delete") test.True(t, exists)
test.Equal(t, flag.Type(), "bool") test.Equal(t, flag.String(), format.True)
// Get by short flag, exists = set.Get("delete") test.True(t, exists)
test.Equal(t, flag.Type(), "bool") test.Equal(t, flag.String(), format.True)
test.EqualFunc(t, set.Args(), []string{"some", "arg"}, slices.Equal) }, args: []string{"some", "arg", "-d"}, wantErr: false, }, { name: "valid long value", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int), "count", 'c', "Count something", flag.Config[int]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { flag, exists := set.Get("count") test.True(t, exists)
test.Equal(t, flag.Type(), "int") test.Equal(t, flag.String(), "1")
test.EqualFunc(t, set.Args(), nil, slices.Equal) }, args: []string{"--count", "1"}, wantErr: false, }, { name: "valid long missing value", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int), "count", 'c', "Count something", flag.Config[int]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { flag, exists := set.Get("count") test.True(t, exists)
test.Equal(t, flag.Type(), "int") test.Equal(t, flag.String(), "0")
test.EqualFunc(t, set.Args(), nil, slices.Equal) }, args: []string{"--count"}, // Count needs an argument wantErr: true, errMsg: "flag --count requires an argument", }, { name: "valid short missing value", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int), "count", 'c', "Count something", flag.Config[int]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { flag, exists := set.Get("count") test.True(t, exists)
test.Equal(t, flag.Type(), "int") test.Equal(t, flag.String(), "0")
test.EqualFunc(t, set.Args(), nil, slices.Equal) }, args: []string{"-c"}, // Count needs an argument wantErr: true, errMsg: `flag count needs an argument: "c" in -c`, }, { name: "valid long value with args", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int), "count", 'c', "Count something", flag.Config[int]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { flag, exists := set.Get("count") test.True(t, exists)
test.Equal(t, flag.Type(), "int") test.Equal(t, flag.String(), "1")
test.EqualFunc(t, set.Args(), []string{"some", "arg", "more", "args"}, slices.Equal) }, args: []string{"some", "arg", "--count", "1", "more", "args"}, wantErr: false, }, { name: "invalid long value", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(uint), "number", 'n', "Uint", flag.Config[uint]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { flag, exists := set.Get("number") test.True(t, exists)
test.Equal(t, flag.Type(), "uint") test.Equal(t, flag.String(), "0") // Shouldn't have been set }, args: []string{"--number", "-8"}, // Trying to set a uint flag to negative number wantErr: true, errMsg: `parse error: flag "number" received invalid value "-8" (expected uint): strconv.ParseUint: parsing "-8": invalid syntax`, }, { name: "valid short value", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int), "count", 'c', "Count something", flag.Config[int]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { // Get by name flag, exists := set.Get("count") test.True(t, exists)
test.Equal(t, flag.Type(), "int") test.Equal(t, flag.String(), "1")
// Get by short flag, exists = set.GetShort('c') test.True(t, exists)
test.Equal(t, flag.Type(), "int") test.Equal(t, flag.String(), "1")
test.EqualFunc(t, set.Args(), nil, slices.Equal) }, args: []string{"-c", "1"}, wantErr: false, }, { name: "valid short value with args", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int), "count", 'c', "Count something", flag.Config[int]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { // Get by name flag, exists := set.Get("count") test.True(t, exists)
test.Equal(t, flag.Type(), "int") test.Equal(t, flag.String(), "1")
// Get by short flag, exists = set.GetShort('c') test.True(t, exists)
test.Equal(t, flag.Type(), "int") test.Equal(t, flag.String(), "1")
test.EqualFunc(t, set.Args(), []string{"args", "more", "args"}, slices.Equal) }, args: []string{"args", "-c", "1", "more", "args"}, wantErr: false, }, { name: "invalid short value", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(uint), "number", 'n', "Uint", flag.Config[uint]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { flag, exists := set.Get("number") test.True(t, exists)
test.Equal(t, flag.Type(), "uint") test.Equal(t, flag.String(), "0") // Shouldn't have been set }, args: []string{"-n", "-8"}, // Trying to set a uint flag to negative number wantErr: true, errMsg: `parse error: flag "number" received invalid value "-8" (expected uint): strconv.ParseUint: parsing "-8": invalid syntax`, }, { name: "valid long equals value", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int), "count", 'c', "Count something", flag.Config[int]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { flag, exists := set.Get("count") test.True(t, exists)
test.Equal(t, flag.Type(), "int") test.Equal(t, flag.String(), "1") }, args: []string{"--count=1"}, wantErr: false, }, { name: "valid long equals value with args", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int), "count", 'c', "Count something", flag.Config[int]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { flag, exists := set.Get("count") test.True(t, exists)
test.Equal(t, flag.Type(), "int") test.Equal(t, flag.String(), "1")
test.EqualFunc(t, set.Args(), []string{"args", "more", "args"}, slices.Equal) }, args: []string{"args", "--count=1", "more", "args"}, wantErr: false, }, { name: "invalid long equals value", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(uint), "number", 'n', "Uint", flag.Config[uint]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { flag, exists := set.Get("number") test.True(t, exists)
test.Equal(t, flag.Type(), "uint") test.Equal(t, flag.String(), "0") // Shouldn't have been set }, args: []string{"--number=-8"}, // Trying to set a uint flag to negative number wantErr: true, errMsg: `parse error: flag "number" received invalid value "-8" (expected uint): strconv.ParseUint: parsing "-8": invalid syntax`, }, { name: "valid short equals value", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int), "count", 'c', "Count something", flag.Config[int]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { // Get by name flag, exists := set.Get("count") test.True(t, exists)
test.Equal(t, flag.Type(), "int") test.Equal(t, flag.String(), "1")
// Get by short flag, exists = set.GetShort('c') test.True(t, exists)
test.Equal(t, flag.Type(), "int") test.Equal(t, flag.String(), "1") }, args: []string{"-c=1"}, wantErr: false, }, { name: "valid short equals value with args", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int), "count", 'c', "Count something", flag.Config[int]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { // Get by name flag, exists := set.Get("count") test.True(t, exists)
test.Equal(t, flag.Type(), "int") test.Equal(t, flag.String(), "1")
// Get by short flag, exists = set.GetShort('c') test.True(t, exists)
test.Equal(t, flag.Type(), "int") test.Equal(t, flag.String(), "1")
test.EqualFunc(t, set.Args(), []string{"args", "more", "args"}, slices.Equal) }, args: []string{"args", "-c=1", "more", "args"}, wantErr: false, }, { name: "no shorthand use long", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int), "count", publicflag.NoShortHand, "Count something", flag.Config[int]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { // Get by name flag, exists := set.Get("count") test.True(t, exists)
test.Equal(t, flag.Type(), "int") test.Equal(t, flag.String(), "1")
// Get by short flag, exists = set.GetShort('c') test.False(t, exists) // Short shouldn't exist test.Equal(t, flag, nil) }, args: []string{"--count", "1"}, wantErr: false, }, { name: "no shorthand use short", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int), "count", publicflag.NoShortHand, "Count something", flag.Config[int]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { // Get by name flag, exists := set.Get("count") test.True(t, exists)
test.Equal(t, flag.Type(), "int") test.Equal(t, flag.String(), "0")
// Get by short flag, exists = set.GetShort('c') test.False(t, exists) // Short shouldn't exist test.Equal(t, flag, nil) }, args: []string{"-c", "1"}, wantErr: true, errMsg: `unrecognised shorthand flag: "c" in -c`, }, { name: "valid count long", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New( new(publicflag.Count), "count", 'c', "Count something", flag.Config[publicflag.Count]{}, ) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { flag, exists := set.Get("count") test.True(t, exists)
test.Equal(t, flag.Type(), "count") test.Equal(t, flag.String(), "2") // Should be incremented by 2 }, args: []string{"--count", "--count"}, wantErr: false, }, { name: "valid count short", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New( new(publicflag.Count), "count", 'c', "Count something", flag.Config[publicflag.Count]{}, ) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { flag, exists := set.Get("count") test.True(t, exists)
test.Equal(t, flag.Type(), "count") test.Equal(t, flag.String(), "2") // Should be incremented by 2 }, args: []string{"-c", "-c"}, wantErr: false, }, { name: "valid count super short", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New( new(publicflag.Count), "count", 'c', "Count something", flag.Config[publicflag.Count]{}, ) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { flag, exists := set.Get("count") test.True(t, exists)
test.Equal(t, flag.Type(), "count") test.Equal(t, flag.String(), "3") // Should be incremented by 3 }, args: []string{"-ccc"}, wantErr: false, }, { name: "env var applied when flag not set on CLI", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_DELETE", "true")
var val bool
f, err := flag.New(&val, "delete", 'd', "Delete something", flag.Config[bool]{EnvVar: "MYTOOL_DELETE"}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("delete") test.True(t, exists) test.Equal(t, f.String(), format.True) }, args: []string{}, wantErr: false, }, { name: "CLI long flag overrides env var", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_DELETE", "true")
var val bool
f, err := flag.New(&val, "delete", 'd', "Delete something", flag.Config[bool]{EnvVar: "MYTOOL_DELETE"}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("delete") test.True(t, exists) test.Equal(t, f.String(), "false") }, args: []string{"--delete=false"}, wantErr: false, }, { name: "CLI short flag overrides env var", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_DELETE", "true")
var val bool
f, err := flag.New(&val, "delete", 'd', "Delete something", flag.Config[bool]{EnvVar: "MYTOOL_DELETE"}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("delete") test.True(t, exists) test.Equal(t, f.String(), "false") }, args: []string{"-d=false"}, wantErr: false, }, { name: "invalid env var value returns error", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_COUNT", "notanumber")
var val int
f, err := flag.New(&val, "count", 'c', "Count", flag.Config[int]{EnvVar: "MYTOOL_COUNT"}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, args: []string{}, wantErr: true, errMsg: `could not set flag from env: env var MYTOOL_COUNT: parse error: flag "count" received invalid value "notanumber" (expected int): strconv.ParseInt: parsing "notanumber": invalid syntax`, }, { name: "env var not set leaves flag at default", newSet: func(t *testing.T) *flag.Set { // MYTOOL_DELETE is deliberately NOT set in the environment var val bool
f, err := flag.New(&val, "delete", 'd', "Delete something", flag.Config[bool]{EnvVar: "MYTOOL_DELETE"}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("delete") test.True(t, exists) test.Equal(t, f.String(), "false") }, args: []string{}, wantErr: false, }, { name: "env var applied when terminator present", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_DELETE", "true")
var val bool
f, err := flag.New(&val, "delete", 'd', "Delete something", flag.Config[bool]{EnvVar: "MYTOOL_DELETE"}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("delete") test.True(t, exists) test.Equal(t, f.String(), format.True) test.EqualFunc(t, set.ExtraArgs(), []string{"extra"}, slices.Equal) }, args: []string{"--", "extra"}, wantErr: false, }, { name: "flag without env var configured is unaffected by environment", newSet: func(t *testing.T) *flag.Set { // Env var is set in the OS but NOT wired to this flag t.Setenv("MYTOOL_DELETE", "true")
var val bool
f, err := flag.New(&val, "delete", 'd', "Delete something", flag.Config[bool]{}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("delete") test.True(t, exists) test.Equal(t, f.String(), "false") }, args: []string{}, wantErr: false, }, { name: "slice flag set via comma-separated env var", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_ITEMS", "one,two,three")
var val []string
f, err := flag.New(&val, "item", 'i', "Add item", flag.Config[[]string]{EnvVar: "MYTOOL_ITEMS"}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("item") test.True(t, exists) test.Equal(t, f.String(), `["one", "two", "three"]`) }, args: []string{}, wantErr: false, }, { name: "count env var and CLI flags both accumulate", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_VERBOSITY", "2")
var val publicflag.Count
f, err := flag.New( &val, "verbosity", 'v', "Increase verbosity", flag.Config[publicflag.Count]{EnvVar: "MYTOOL_VERBOSITY"}, ) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("verbosity") test.True(t, exists) // Env var contributes 2, CLI contributes 1 more, total 3 test.Equal(t, f.String(), "3") }, args: []string{"--verbosity"}, wantErr: false, }, { name: "slice env var and CLI flags both accumulate", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_ITEMS", "one,two")
var val []string
f, err := flag.New(&val, "item", 'i', "Add item", flag.Config[[]string]{EnvVar: "MYTOOL_ITEMS"}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("item") test.True(t, exists) test.Equal(t, f.String(), `["one", "two", "three"]`) }, args: []string{"--item", "three"}, wantErr: false, }, { name: "net.IP flag set via env var", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_HOST", "192.168.1.1")
var val net.IP
f, err := flag.New(&val, "host", 'h', "Host IP address", flag.Config[net.IP]{EnvVar: "MYTOOL_HOST"}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("host") test.True(t, exists) test.Equal(t, f.String(), "192.168.1.1") }, args: []string{}, wantErr: false, }, { name: "net.IP flag env var is overridden by CLI", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_HOST", "192.168.1.1")
var val net.IP
f, err := flag.New(&val, "host", 'h', "Host IP address", flag.Config[net.IP]{EnvVar: "MYTOOL_HOST"}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("host") test.True(t, exists) test.Equal(t, f.String(), "10.0.0.1") }, args: []string{"--host", "10.0.0.1"}, wantErr: false, }, { name: "invalid net.IP env var returns error", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_HOST", "notanip")
var val net.IP
f, err := flag.New(&val, "host", 'h', "Host IP address", flag.Config[net.IP]{EnvVar: "MYTOOL_HOST"}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, args: []string{}, wantErr: true, errMsg: `could not set flag from env: env var MYTOOL_HOST: parse error: flag "host" received invalid value "notanip" (expected net.IP): invalid IP address`, }, { name: "time.Duration flag set via env var", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_TIMEOUT", "30s")
var val time.Duration
f, err := flag.New( &val, "timeout", 't', "Request timeout", flag.Config[time.Duration]{EnvVar: "MYTOOL_TIMEOUT"}, ) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("timeout") test.True(t, exists) test.Equal(t, f.String(), "30s") }, args: []string{}, wantErr: false, }, { name: "time.Duration flag env var is overridden by CLI", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_TIMEOUT", "30s")
var val time.Duration
f, err := flag.New( &val, "timeout", 't', "Request timeout", flag.Config[time.Duration]{EnvVar: "MYTOOL_TIMEOUT"}, ) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("timeout") test.True(t, exists) test.Equal(t, f.String(), "1m0s") }, args: []string{"--timeout", "1m"}, wantErr: false, }, { name: "invalid time.Duration env var returns error", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_TIMEOUT", "notaduration")
var val time.Duration
f, err := flag.New( &val, "timeout", 't', "Request timeout", flag.Config[time.Duration]{EnvVar: "MYTOOL_TIMEOUT"}, ) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, args: []string{}, wantErr: true, errMsg: `could not set flag from env: env var MYTOOL_TIMEOUT: parse error: flag "timeout" received invalid value "notaduration" (expected time.Duration): time: invalid duration "notaduration"`, }, { name: "time.Time flag set via env var", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_SINCE", "2024-08-17T10:37:30Z")
var val time.Time
f, err := flag.New( &val, "since", publicflag.NoShortHand, "Start time (RFC3339)", flag.Config[time.Time]{EnvVar: "MYTOOL_SINCE"}, ) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("since") test.True(t, exists) test.Equal(t, f.String(), "2024-08-17T10:37:30Z") }, args: []string{}, wantErr: false, }, { name: "invalid time.Time env var returns error", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_SINCE", "not-a-time")
var val time.Time
f, err := flag.New( &val, "since", publicflag.NoShortHand, "Start time (RFC3339)", flag.Config[time.Time]{EnvVar: "MYTOOL_SINCE"}, ) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, args: []string{}, wantErr: true, errMsg: `could not set flag from env: env var MYTOOL_SINCE: parse error: flag "since" received invalid value "not-a-time" (expected time.Time): parsing time "not-a-time" as "2006-01-02T15:04:05Z07:00": cannot parse "not-a-time" as "2006"`, }, { name: "[]int flag set via comma-separated env var", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_PORTS", "8080,8081,8082")
var val []int
f, err := flag.New(&val, "port", 'p', "Port numbers", flag.Config[[]int]{EnvVar: "MYTOOL_PORTS"}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("port") test.True(t, exists) test.Equal(t, f.String(), "[8080, 8081, 8082]") }, args: []string{}, wantErr: false, }, { name: "invalid value in []int comma-separated env var returns error", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_PORTS", "8080,notaport,8082")
var val []int
f, err := flag.New(&val, "port", 'p', "Port numbers", flag.Config[[]int]{EnvVar: "MYTOOL_PORTS"}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, args: []string{}, wantErr: true, errMsg: `could not set flag from env: env var MYTOOL_PORTS: parse error: flag "port" (type []int) cannot append element "notaport": strconv.ParseInt: parsing "notaport": invalid syntax`, }, { name: "bytes flag env var is parsed atomically, not split on comma", newSet: func(t *testing.T) *flag.Set { // A hex string that contains a comma should be parsed as-is, not split t.Setenv("MYTOOL_DATA", "deadbeef")
var val []byte
f, err := flag.New(&val, "data", 'd', "Raw bytes", flag.Config[[]byte]{EnvVar: "MYTOOL_DATA"}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("data") test.True(t, exists) test.Equal(t, f.String(), "deadbeef") }, args: []string{}, wantErr: false, }, { name: "int accepts negative value via long space form", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int), "count", 'c', "Count", flag.Config[int]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("count") test.True(t, exists) test.Equal(t, f.String(), "-42") }, args: []string{"--count", "-42"}, wantErr: false, }, { name: "int accepts negative value via long equals form", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int), "count", 'c', "Count", flag.Config[int]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("count") test.True(t, exists) test.Equal(t, f.String(), "-42") }, args: []string{"--count=-42"}, wantErr: false, }, { name: "int accepts negative value via short space form", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int), "count", 'c', "Count", flag.Config[int]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("count") test.True(t, exists) test.Equal(t, f.String(), "-42") }, args: []string{"-c", "-42"}, wantErr: false, }, { name: "int accepts negative value via short equals form", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int), "count", 'c', "Count", flag.Config[int]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("count") test.True(t, exists) test.Equal(t, f.String(), "-42") }, args: []string{"-c=-42"}, wantErr: false, }, { name: "int accepts negative value via short attached form", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int), "count", 'c', "Count", flag.Config[int]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("count") test.True(t, exists) test.Equal(t, f.String(), "-42") }, args: []string{"-c-42"}, wantErr: false, }, { name: "int8 accepts negative value", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int8), "count", 'c', "Count", flag.Config[int8]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("count") test.True(t, exists) test.Equal(t, f.String(), "-128") }, args: []string{"--count", "-128"}, wantErr: false, }, { name: "int16 accepts negative value", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int16), "count", 'c', "Count", flag.Config[int16]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("count") test.True(t, exists) test.Equal(t, f.String(), "-32768") }, args: []string{"--count", "-32768"}, wantErr: false, }, { name: "int32 accepts negative value", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int32), "count", 'c', "Count", flag.Config[int32]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("count") test.True(t, exists) test.Equal(t, f.String(), "-2147483648") }, args: []string{"--count=-2147483648"}, wantErr: false, }, { name: "int64 accepts negative value", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(int64), "count", 'c', "Count", flag.Config[int64]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("count") test.True(t, exists) test.Equal(t, f.String(), "-9223372036854775808") }, args: []string{"-c", "-9223372036854775808"}, wantErr: false, }, { name: "float accepts negative value", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(float64), "ratio", 'r', "Ratio", flag.Config[float64]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("ratio") test.True(t, exists) test.Equal(t, f.String(), "-3.14") }, args: []string{"--ratio", "-3.14"}, wantErr: false, }, { name: "string accepts empty value via long space form", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(string), "name", 'n', "Name", flag.Config[string]{DefaultValue: "placeholder"}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("name") test.True(t, exists) // Default was "placeholder"; confirm it's been overwritten to empty test.Equal(t, f.String(), "") }, args: []string{"--name", ""}, wantErr: false, }, { name: "string accepts empty value via long equals form", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(string), "name", 'n', "Name", flag.Config[string]{DefaultValue: "placeholder"}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("name") test.True(t, exists) test.Equal(t, f.String(), "") }, args: []string{"--name="}, wantErr: false, }, { name: "string accepts empty value via short space form", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(string), "name", 'n', "Name", flag.Config[string]{DefaultValue: "placeholder"}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("name") test.True(t, exists) test.Equal(t, f.String(), "") }, args: []string{"-n", ""}, wantErr: false, }, { name: "string accepts empty value via short equals form", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet() f, err := flag.New(new(string), "name", 'n', "Name", flag.Config[string]{DefaultValue: "placeholder"}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("name") test.True(t, exists) // -n= should be symmetric with --name= (both set to empty string), // matching Go stdlib flag, argparse, clap, urfave, etc. test.Equal(t, f.String(), "") }, args: []string{"-n="}, wantErr: false, }, { name: "slice env var of only commas yields empty slice", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_ITEMS", ",")
var val []string
f, err := flag.New(&val, "item", 'i', "Add item", flag.Config[[]string]{EnvVar: "MYTOOL_ITEMS"}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("item") test.True(t, exists) test.Equal(t, f.String(), "[]") }, args: []string{}, wantErr: false, }, { name: "slice env var empty string yields empty slice", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_ITEMS", "")
var val []string
f, err := flag.New(&val, "item", 'i', "Add item", flag.Config[[]string]{EnvVar: "MYTOOL_ITEMS"}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("item") test.True(t, exists) test.Equal(t, f.String(), "[]") }, args: []string{}, wantErr: false, }, { name: "slice env var skips empty and whitespace-only items", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_ITEMS", "a,, ,b")
var val []string
f, err := flag.New(&val, "item", 'i', "Add item", flag.Config[[]string]{EnvVar: "MYTOOL_ITEMS"}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("item") test.True(t, exists) test.Equal(t, f.String(), `["a", "b"]`) }, args: []string{}, wantErr: false, }, { name: "slice env var splits on every comma (no escape mechanism)", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_ITEMS", "a,b,c")
var val []string
f, err := flag.New(&val, "item", 'i', "Add item", flag.Config[[]string]{EnvVar: "MYTOOL_ITEMS"}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("item") test.True(t, exists) test.Equal(t, f.String(), `["a", "b", "c"]`) }, args: []string{}, wantErr: false, }, { name: "slice env var trims surrounding whitespace from items", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_ITEMS", " a , b , c ")
var val []string
f, err := flag.New(&val, "item", 'i', "Add item", flag.Config[[]string]{EnvVar: "MYTOOL_ITEMS"}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("item") test.True(t, exists) test.Equal(t, f.String(), `["a", "b", "c"]`) }, args: []string{}, wantErr: false, }, { name: "combined short flags with equals value", newSet: func(t *testing.T) *flag.Set { // -abc=x → a and b are bool and get implied true, c gets "x" set := flag.NewSet()
a, err := flag.New(new(bool), "alpha", 'a', "Alpha", flag.Config[bool]{}) test.Ok(t, err) b, err := flag.New(new(bool), "beta", 'b', "Beta", flag.Config[bool]{}) test.Ok(t, err) c, err := flag.New(new(string), "charlie", 'c', "Charlie", flag.Config[string]{}) test.Ok(t, err)
test.Ok(t, flag.AddToSet(set, a)) test.Ok(t, flag.AddToSet(set, b)) test.Ok(t, flag.AddToSet(set, c))
return set }, test: func(t *testing.T, set *flag.Set) { a, ok := set.Get("alpha") test.True(t, ok) test.Equal(t, a.String(), format.True)
b, ok := set.Get("beta") test.True(t, ok) test.Equal(t, b.String(), format.True)
c, ok := set.Get("charlie") test.True(t, ok) test.Equal(t, c.String(), "x") }, args: []string{"-abc=x"}, wantErr: false, }, { name: "combined short flags with space separated value", newSet: func(t *testing.T) *flag.Set { // -abc x → a, b bool; c consumes next arg as value set := flag.NewSet()
a, err := flag.New(new(bool), "alpha", 'a', "Alpha", flag.Config[bool]{}) test.Ok(t, err) b, err := flag.New(new(bool), "beta", 'b', "Beta", flag.Config[bool]{}) test.Ok(t, err) c, err := flag.New(new(string), "charlie", 'c', "Charlie", flag.Config[string]{}) test.Ok(t, err)
test.Ok(t, flag.AddToSet(set, a)) test.Ok(t, flag.AddToSet(set, b)) test.Ok(t, flag.AddToSet(set, c))
return set }, test: func(t *testing.T, set *flag.Set) { a, ok := set.Get("alpha") test.True(t, ok) test.Equal(t, a.String(), format.True)
b, ok := set.Get("beta") test.True(t, ok) test.Equal(t, b.String(), format.True)
c, ok := set.Get("charlie") test.True(t, ok) test.Equal(t, c.String(), "x") }, args: []string{"-abc", "x"}, wantErr: false, }, { name: "combined short flags with multiple bools and trailing equals value", newSet: func(t *testing.T) *flag.Set { // -abcf=value → a, b, c bool; f non-bool gets "value" set := flag.NewSet()
a, err := flag.New(new(bool), "alpha", 'a', "Alpha", flag.Config[bool]{}) test.Ok(t, err) b, err := flag.New(new(bool), "beta", 'b', "Beta", flag.Config[bool]{}) test.Ok(t, err) c, err := flag.New(new(bool), "charlie", 'c', "Charlie", flag.Config[bool]{}) test.Ok(t, err) fl, err := flag.New(new(string), "file", 'f', "File", flag.Config[string]{}) test.Ok(t, err)
test.Ok(t, flag.AddToSet(set, a)) test.Ok(t, flag.AddToSet(set, b)) test.Ok(t, flag.AddToSet(set, c)) test.Ok(t, flag.AddToSet(set, fl))
return set }, test: func(t *testing.T, set *flag.Set) { a, ok := set.Get("alpha") test.True(t, ok) test.Equal(t, a.String(), format.True)
b, ok := set.Get("beta") test.True(t, ok) test.Equal(t, b.String(), format.True)
c, ok := set.Get("charlie") test.True(t, ok) test.Equal(t, c.String(), format.True)
fl, ok := set.Get("file") test.True(t, ok) test.Equal(t, fl.String(), "value") }, args: []string{"-abcf=value"}, wantErr: false, }, { name: "bool explicit equals false beats env var true", newSet: func(t *testing.T) *flag.Set { // Env var pre-sets to true; CLI --verbose=false must win. t.Setenv("MYTOOL_VERBOSE", "true")
var val bool
f, err := flag.New(&val, "verbose", 'v', "Verbose", flag.Config[bool]{EnvVar: "MYTOOL_VERBOSE"}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("verbose") test.True(t, exists) test.Equal(t, f.String(), "false") }, args: []string{"--verbose=false"}, wantErr: false, }, { name: "bool short equals false beats env var true", newSet: func(t *testing.T) *flag.Set { t.Setenv("MYTOOL_VERBOSE", "true")
var val bool
f, err := flag.New(&val, "verbose", 'v', "Verbose", flag.Config[bool]{EnvVar: "MYTOOL_VERBOSE"}) test.Ok(t, err)
set := flag.NewSet() err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("verbose") test.True(t, exists) test.Equal(t, f.String(), "false") }, args: []string{"-v=false"}, wantErr: false, }, { name: "combined short flags where early flag needs value captures rest", newSet: func(t *testing.T) *flag.Set { // -fgh. f is non-bool so consumes the rest of the cluster as its value // i.e. f gets "gh", and g/h are not parsed as flags. set := flag.NewSet()
fl, err := flag.New(new(string), "file", 'f', "File", flag.Config[string]{}) test.Ok(t, err) g, err := flag.New(new(bool), "gamma", 'g', "Gamma", flag.Config[bool]{}) test.Ok(t, err) h, err := flag.New(new(bool), "hotel", 'h', "Hotel", flag.Config[bool]{}) test.Ok(t, err)
test.Ok(t, flag.AddToSet(set, fl)) test.Ok(t, flag.AddToSet(set, g)) test.Ok(t, flag.AddToSet(set, h))
return set }, test: func(t *testing.T, set *flag.Set) { fl, ok := set.Get("file") test.True(t, ok) test.Equal(t, fl.String(), "gh")
g, ok := set.Get("gamma") test.True(t, ok) test.Equal(t, g.String(), "false")
h, ok := set.Get("hotel") test.True(t, ok) test.Equal(t, h.String(), "false") }, args: []string{"-fgh"}, wantErr: false, }, }
for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { set := tt.newSet(t) err := set.Parse(tt.args) test.WantErr(t, err, tt.wantErr)
if err != nil { test.Equal(t, err.Error(), tt.errMsg) }
if tt.test != nil { tt.test(t, set) } }) }}
func TestParseResetsState(t *testing.T) { t.Run("positional args do not accumulate", func(t *testing.T) { set := flag.NewSet()
f, err := flag.New(new(bool), "delete", 'd', "Delete something", flag.Config[bool]{}) test.Ok(t, err) test.Ok(t, flag.AddToSet(set, f))
args := []string{"one", "two", "--delete"}
test.Ok(t, set.Parse(args)) test.EqualFunc(t, set.Args(), []string{"one", "two"}, slices.Equal)
test.Ok(t, set.Parse(args)) test.EqualFunc(t, set.Args(), []string{"one", "two"}, slices.Equal) })
t.Run("extra args do not accumulate", func(t *testing.T) { set := flag.NewSet()
args := []string{"pos", "--", "extra", "more"}
test.Ok(t, set.Parse(args)) test.EqualFunc(t, set.ExtraArgs(), []string{"extra", "more"}, slices.Equal)
test.Ok(t, set.Parse(args)) test.EqualFunc(t, set.ExtraArgs(), []string{"extra", "more"}, slices.Equal) })
t.Run("previous extras cleared when next call has none", func(t *testing.T) { set := flag.NewSet()
test.Ok(t, set.Parse([]string{"a", "--", "x"})) test.EqualFunc(t, set.ExtraArgs(), []string{"x"}, slices.Equal)
test.Ok(t, set.Parse([]string{"a", "b"})) test.Equal(t, len(set.ExtraArgs()), 0) })}
func TestFlagSet(t *testing.T) { tests := []struct { newSet func(t *testing.T) *flag.Set // Function to build the flag set under test test func(t *testing.T, set *flag.Set) // Function to test the set name string // Name of the test case }{ { name: "empty", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("missing") test.False(t, exists) test.Equal(t, f, nil) }, }, { name: "empty short", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, test: func(t *testing.T, set *flag.Set) { f, exists := set.GetShort('d') test.False(t, exists) test.Equal(t, f, nil) }, }, { name: "nil safe get", newSet: func(t *testing.T) *flag.Set { return nil // uh oh }, test: func(t *testing.T, set *flag.Set) { f, exists := set.Get("missing") test.False(t, exists) test.Equal(t, f, nil) }, }, { name: "nil safe get short", newSet: func(t *testing.T) *flag.Set { return nil // uh oh }, test: func(t *testing.T, set *flag.Set) { f, exists := set.GetShort('m') test.False(t, exists) test.Equal(t, f, nil) }, }, { name: "nil safe add", newSet: func(t *testing.T) *flag.Set { return nil // uh oh }, test: func(t *testing.T, set *flag.Set) { f, err := flag.New(new(bool), "force", 'f', "Force something", flag.Config[bool]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Err(t, err)
if err != nil { test.Equal(t, err.Error(), "cannot add flag to a nil set") } }, }, { name: "nil safe parse", newSet: func(t *testing.T) *flag.Set { return nil // uh oh }, test: func(t *testing.T, set *flag.Set) { err := set.Parse([]string{"args", "here", "doesn't", "matter"}) test.Err(t, err)
if err != nil { test.Equal(t, err.Error(), "Parse called on a nil set") } }, }, { name: "nil safe args", newSet: func(t *testing.T) *flag.Set { return nil // uh oh }, test: func(t *testing.T, set *flag.Set) { test.EqualFunc(t, set.Args(), nil, slices.Equal) }, }, { name: "duplicate flag added", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, test: func(t *testing.T, set *flag.Set) { f, err := flag.New(new(int), "count", 'c', "Count something", flag.Config[int]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
// Add the same flag again err = flag.AddToSet(set, f) test.Err(t, err)
if err != nil { test.Equal(t, err.Error(), `flag "count" already defined`) } }, }, { name: "different flag same name added", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, test: func(t *testing.T, set *flag.Set) { f, err := flag.New(new(int), "count", 'c', "Count something", flag.Config[int]{}) test.Ok(t, err)
f2, err := flag.New(new(uint), "count", 'c', "Count something 2", flag.Config[uint]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
// Add the different flag with the same na,e err = flag.AddToSet(set, f2) test.Err(t, err)
if err != nil { test.Equal(t, err.Error(), `flag "count" already defined`) } }, }, { name: "different flag same short added", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, test: func(t *testing.T, set *flag.Set) { f, err := flag.New(new(int), "count", 'c', "Count something", flag.Config[int]{}) test.Ok(t, err)
f2, err := flag.New(new(string), "config", 'c', "Choose a config file", flag.Config[string]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
// Add the different flag with the same na,e err = flag.AddToSet(set, f2) test.Err(t, err)
if err != nil { test.Equal(t, err.Error(), `shorthand "c" already in use for flag "count"`) } }, }, }
for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { set := tt.newSet(t) tt.test(t, set) }) }}
func TestHelpVersion(t *testing.T) { tests := []struct { newSet func(t *testing.T) *flag.Set // Function to build the flag set under test test func(t *testing.T, set *flag.Set) // Function to test the set name string // Name of the test case }{ { name: "empty help", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, test: func(t *testing.T, set *flag.Set) { help, ok := set.Help() test.False(t, help) test.False(t, ok) }, }, { name: "empty version", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, test: func(t *testing.T, set *flag.Set) { version, ok := set.Version() test.False(t, version) test.False(t, ok) }, }, { name: "help false", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet()
f, err := flag.New(new(bool), "help", 'h', "Show help", flag.Config[bool]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { help, ok := set.Help() test.True(t, ok) // It should exist test.False(t, help) // But not true }, }, { name: "help non bool", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet()
f, err := flag.New(new(int), "help", 'h', "Show help", flag.Config[int]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { help, ok := set.Help() test.False(t, ok) // It should not exist test.False(t, help) // And be false because it's not a bool }, }, { name: "help true", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet()
f, err := flag.New(new(bool), "help", 'h', "Show help", flag.Config[bool]{DefaultValue: true}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { help, ok := set.Help() test.True(t, ok) // It should exist test.True(t, help) // And be true }, }, { name: "version false", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet()
f, err := flag.New(new(bool), "version", 'v', "Show version", flag.Config[bool]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { version, ok := set.Version() test.True(t, ok) // It should exist test.False(t, version) // But not true }, }, { name: "version non bool", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet()
f, err := flag.New(new(int), "version", 'v', "Show version", flag.Config[int]{}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { version, ok := set.Version() test.False(t, ok) // It should not exist test.False(t, version) // And be false because it's not a bool }, }, { name: "version true", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet()
f, err := flag.New(new(bool), "version", 'v', "Show version", flag.Config[bool]{DefaultValue: true}) test.Ok(t, err)
err = flag.AddToSet(set, f) test.Ok(t, err)
return set }, test: func(t *testing.T, set *flag.Set) { version, ok := set.Version() test.True(t, ok) // It should exist test.True(t, version) // And be true }, }, }
for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { set := tt.newSet(t) tt.test(t, set) }) }}
func TestSorted(t *testing.T) { tests := []struct { newSet func(t *testing.T) *flag.Set test func(t *testing.T, set *flag.Set) name string }{ { name: "empty", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, test: func(t *testing.T, set *flag.Set) { // Iterator should yield no values got := maps.Collect(set.Sorted()) test.Equal(t, len(got), 0) }, }, { name: "full", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet()
verbose, err := flag.New(new(bool), "verbose", 'v', "Show verbose info", flag.Config[bool]{}) test.Ok(t, err)
debug, err := flag.New(new(bool), "debug", 'd', "Show debug info", flag.Config[bool]{}) test.Ok(t, err)
thing, err := flag.New(new(string), "thing", 't', "A thing", flag.Config[string]{}) test.Ok(t, err)
number, err := flag.New(new(int), "number", 'n', "Number of times", flag.Config[int]{}) test.Ok(t, err)
duration, err := flag.New( new(time.Duration), "duration", 'D', "The time to do something for", flag.Config[time.Duration]{}, ) test.Ok(t, err)
test.Ok(t, flag.AddToSet(set, verbose)) test.Ok(t, flag.AddToSet(set, debug)) test.Ok(t, flag.AddToSet(set, thing)) test.Ok(t, flag.AddToSet(set, number)) test.Ok(t, flag.AddToSet(set, duration))
return set }, test: func(t *testing.T, set *flag.Set) { next, stop := iter.Pull2(set.Sorted()) defer stop()
// Should now be in alphabetical order name, fl, ok := next() test.True(t, ok) test.Equal(t, name, "debug") test.Equal(t, fl.Name(), "debug")
name, fl, ok = next() test.True(t, ok) test.Equal(t, name, "duration") test.Equal(t, fl.Name(), "duration")
name, fl, ok = next() test.True(t, ok) test.Equal(t, name, "number") test.Equal(t, fl.Name(), "number")
name, fl, ok = next() test.True(t, ok) test.Equal(t, name, "thing") test.Equal(t, fl.Name(), "thing")
name, fl, ok = next() test.True(t, ok) test.Equal(t, name, "verbose") test.Equal(t, fl.Name(), "verbose")
// Thats it name, fl, ok = next() test.False(t, ok) test.Equal(t, name, "") test.Equal(t, fl, nil) }, }, }
for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { set := tt.newSet(t) tt.test(t, set) }) }}
func TestAll(t *testing.T) { tests := []struct { newSet func(t *testing.T) *flag.Set test func(t *testing.T, set *flag.Set) name string }{ { name: "empty", newSet: func(t *testing.T) *flag.Set { return flag.NewSet() }, test: func(t *testing.T, set *flag.Set) { // Iterator should yield no values got := maps.Collect(set.All()) test.Equal(t, len(got), 0) }, }, { name: "full", newSet: func(t *testing.T) *flag.Set { set := flag.NewSet()
verbose, err := flag.New(new(bool), "verbose", 'v', "Show verbose info", flag.Config[bool]{}) test.Ok(t, err)
debug, err := flag.New(new(bool), "debug", 'd', "Show debug info", flag.Config[bool]{}) test.Ok(t, err)
thing, err := flag.New(new(string), "thing", 't', "A thing", flag.Config[string]{}) test.Ok(t, err)
number, err := flag.New(new(int), "number", 'n', "Number of times", flag.Config[int]{}) test.Ok(t, err)
duration, err := flag.New( new(time.Duration), "duration", 'D', "The time to do something for", flag.Config[time.Duration]{}, ) test.Ok(t, err)
test.Ok(t, flag.AddToSet(set, verbose)) test.Ok(t, flag.AddToSet(set, debug)) test.Ok(t, flag.AddToSet(set, thing)) test.Ok(t, flag.AddToSet(set, number)) test.Ok(t, flag.AddToSet(set, duration))
return set }, test: func(t *testing.T, set *flag.Set) { // Should get everything back, but order is not deterministic all := maps.Collect(set.All())
want := []string{"verbose", "debug", "thing", "number", "duration"} slices.Sort(want)
got := slices.Collect(maps.Keys(all)) slices.Sort(got)
test.EqualFunc(t, got, want, slices.Equal) }, }, }
for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { set := tt.newSet(t) tt.test(t, set) }) }}
func BenchmarkParse(b *testing.B) { set := flag.NewSet() f, err := flag.New(new(int), "count", 'c', "Count something", flag.Config[int]{}) test.Ok(b, err)
f2, err := flag.New(new(bool), "delete", 'd', "Delete something", flag.Config[bool]{}) test.Ok(b, err)
f3, err := flag.New(new(string), "name", 'n', "Name something", flag.Config[string]{}) test.Ok(b, err)
err = flag.AddToSet(set, f) test.Ok(b, err)
err = flag.AddToSet(set, f2) test.Ok(b, err)
err = flag.AddToSet(set, f3) test.Ok(b, err)
args := []string{"some", "args", "here", "--delete", "--count", "10", "--name", "John"}
for b.Loop() { err := set.Parse(args) if err != nil { b.Fatalf("Parse returned an error: %v", err) } }}
// Benchmarks Parse on a flag set invoked exclusively via shorthand flags.func BenchmarkParseShort(b *testing.B) { set := flag.NewSet() f, err := flag.New(new(int), "count", 'c', "Count something", flag.Config[int]{}) test.Ok(b, err)
f2, err := flag.New(new(bool), "delete", 'd', "Delete something", flag.Config[bool]{}) test.Ok(b, err)
f3, err := flag.New(new(string), "name", 'n', "Name something", flag.Config[string]{}) test.Ok(b, err)
test.Ok(b, flag.AddToSet(set, f)) test.Ok(b, flag.AddToSet(set, f2)) test.Ok(b, flag.AddToSet(set, f3))
args := []string{"some", "args", "here", "-d", "-c", "10", "-n", "John"}
for b.Loop() { err := set.Parse(args) if err != nil { b.Fatalf("Parse returned an error: %v", err) } }}
// Benchmarks Parse with a mix of long and short flags, representative of how// users typically invoke a real CLI.func BenchmarkParseMixed(b *testing.B) { set := flag.NewSet() f, err := flag.New(new(int), "count", 'c', "Count something", flag.Config[int]{}) test.Ok(b, err)
f2, err := flag.New(new(bool), "delete", 'd', "Delete something", flag.Config[bool]{}) test.Ok(b, err)
f3, err := flag.New(new(string), "name", 'n', "Name something", flag.Config[string]{}) test.Ok(b, err)
f4, err := flag.New(new(bool), "verbose", 'v', "Verbose output", flag.Config[bool]{}) test.Ok(b, err)
test.Ok(b, flag.AddToSet(set, f)) test.Ok(b, flag.AddToSet(set, f2)) test.Ok(b, flag.AddToSet(set, f3)) test.Ok(b, flag.AddToSet(set, f4))
args := []string{"some", "args", "here", "-d", "--count", "10", "-n", "John", "--verbose"}
for b.Loop() { err := set.Parse(args) if err != nil { b.Fatalf("Parse returned an error: %v", err) } }}
// Benchmarks Parse when flags have environment variables attached, so include// the cost of the Getenv syscall.func BenchmarkParseWithEnv(b *testing.B) { build := func(b *testing.B) (*flag.Set, []string) { b.Helper()
set := flag.NewSet()
f, err := flag.New( new(int), "count", 'c', "Count something", flag.Config[int]{EnvVar: "BENCH_PARSE_COUNT"}, ) test.Ok(b, err)
f2, err := flag.New( new(string), "name", 'n', "Name something", flag.Config[string]{EnvVar: "BENCH_PARSE_NAME"}, ) test.Ok(b, err)
f3, err := flag.New( new(bool), "force", 'f', "Force something", flag.Config[bool]{EnvVar: "BENCH_PARSE_FORCE"}, ) test.Ok(b, err)
test.Ok(b, flag.AddToSet(set, f)) test.Ok(b, flag.AddToSet(set, f2)) test.Ok(b, flag.AddToSet(set, f3))
return set, []string{"positional"} }
b.Run("unset", func(b *testing.B) { set, args := build(b)
for b.Loop() { err := set.Parse(args) if err != nil { b.Fatalf("Parse returned an error: %v", err) } } })
b.Run("set", func(b *testing.B) { b.Setenv("BENCH_PARSE_COUNT", "10") b.Setenv("BENCH_PARSE_NAME", "John") b.Setenv("BENCH_PARSE_FORCE", "true")
set, args := build(b)
for b.Loop() { err := set.Parse(args) if err != nil { b.Fatalf("Parse returned an error: %v", err) } } })}
// Benchmarks Parse on a slice flag multiple times. A slice flag is a// read/write operation.func BenchmarkParseSliceFlag(b *testing.B) { var items []string
set := flag.NewSet() f, err := flag.New(&items, "item", 'i', "An item", flag.Config[[]string]{}) test.Ok(b, err)
test.Ok(b, flag.AddToSet(set, f))
args := []string{"--item", "one", "--item", "two", "--item", "three", "--item", "four"}
for b.Loop() { // Reset between iterations so the slice doesn't grow forever items = items[:0]
err := set.Parse(args) if err != nil { b.Fatalf("Parse returned an error: %v", err) } }}