Add tests for command.VisibleFlagCategory

This commit is contained in:
Naveen Gogineni 2022-10-07 11:06:34 -05:00
parent e62a087117
commit 8227be1fe9
3 changed files with 65 additions and 5 deletions

4
app.go
View File

@ -229,7 +229,9 @@ func (a *App) Setup() {
a.flagCategories = newFlagCategories() a.flagCategories = newFlagCategories()
for _, fl := range a.Flags { for _, fl := range a.Flags {
if cf, ok := fl.(CategorizableFlag); ok { if cf, ok := fl.(CategorizableFlag); ok {
a.flagCategories.AddFlag(cf.GetCategory(), cf) if cf.GetCategory() != "" {
a.flagCategories.AddFlag(cf.GetCategory(), cf)
}
} }
} }

View File

@ -144,8 +144,8 @@ func ExampleApp_Run_appHelp() {
// help, h Shows a list of commands or help for one command // help, h Shows a list of commands or help for one command
// //
// GLOBAL OPTIONS: // GLOBAL OPTIONS:
// --help, -h show help (default: false)
// --name value a name to say (default: "bob") // --name value a name to say (default: "bob")
// --help, -h show help (default: false)
// --version, -v print the version (default: false) // --version, -v print the version (default: false)
} }
@ -2242,10 +2242,33 @@ func TestApp_VisibleCategories(t *testing.T) {
} }
func TestApp_VisibleFlagCategories(t *testing.T) { func TestApp_VisibleFlagCategories(t *testing.T) {
app := &App{} app := &App{
Flags: []Flag{
&StringFlag{
Name: "strd", // no category set
},
&Int64Flag{
Name: "intd",
Aliases: []string{"altd1", "altd2"},
Category: "cat1",
},
},
}
app.Setup()
vfc := app.VisibleFlagCategories() vfc := app.VisibleFlagCategories()
if len(vfc) != 0 { if len(vfc) != 1 {
t.Errorf("unexpected visible flag categories %+v", vfc) t.Fatalf("unexpected visible flag categories %+v", vfc)
}
if vfc[0].Name() != "cat1" {
t.Errorf("expected category name cat1 got %s", vfc[0].Name())
}
if len(vfc[0].Flags()) != 1 {
t.Fatalf("expected flag category to have just one flag got %+v", vfc[0].Flags())
}
fl := vfc[0].Flags()[0]
if !reflect.DeepEqual(fl.Names(), []string{"intd", "altd1", "altd2"}) {
t.Errorf("unexpected flag %+v", fl.Names())
} }
} }

View File

@ -6,6 +6,7 @@ import (
"flag" "flag"
"fmt" "fmt"
"io/ioutil" "io/ioutil"
"reflect"
"strings" "strings"
"testing" "testing"
) )
@ -449,3 +450,37 @@ func TestCommand_VisibleSubcCommands(t *testing.T) {
expect(t, c.VisibleCommands(), []*Command{subc1, subc3}) expect(t, c.VisibleCommands(), []*Command{subc1, subc3})
} }
func TestCommand_VisibleFlagCategories(t *testing.T) {
c := &Command{
Name: "bar",
Usage: "this is for testing",
Flags: []Flag{
&StringFlag{
Name: "strd", // no category set
},
&Int64Flag{
Name: "intd",
Aliases: []string{"altd1", "altd2"},
Category: "cat1",
},
},
}
vfc := c.VisibleFlagCategories()
if len(vfc) != 1 {
t.Fatalf("unexpected visible flag categories %+v", vfc)
}
if vfc[0].Name() != "cat1" {
t.Errorf("expected category name cat1 got %s", vfc[0].Name())
}
if len(vfc[0].Flags()) != 1 {
t.Fatalf("expected flag category to have just one flag got %+v", vfc[0].Flags())
}
fl := vfc[0].Flags()[0]
if !reflect.DeepEqual(fl.Names(), []string{"intd", "altd1", "altd2"}) {
t.Errorf("unexpected flag %+v", fl.Names())
}
}