glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2025-05-05 12:57:22 +00:00
Code Issues Projects Releases Packages Wiki Activity

Have to CalledAs return the name the function was called as.

Browse source 
Currently CalledAs returns the name the command was called only
if it was executed, but parent command don't get executed. This
change allows the child to know how the parent was called as well.

Added new function Called() will let's the user know if the cmd was
called or not.

Updated tests accordingly.
This commit is contained in:
Gautam Dey 2018-11-05 10:59:47 -08:00
parent fe5e611709
commit dacc9a05e3
2 changed files with 56 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
command.go
View file

@ -1157,12 +1157,14 @@ func (c *Command) HasAlias(s string) bool {
}
// CalledAs returns the command name or alias that was used to invoke
// this command or an empty string if the command has not been called.
// this command
func (c *Command) CalledAs() string {
if c.commandCalledAs.called {
return c.commandCalledAs.name
}
return ""
// Called returns weather the command was called or not.
func (c *Command) Called() bool {
return c.commandCalledAs.called
}
// hasNameOrAliasPrefix returns true if the Name or any of aliases start

63
command_test.go
View file

@ -1569,7 +1569,7 @@ func TestUpdateName(t *testing.T) {
type calledAsTestcase struct {
args []string
call string
want string
want []string
epm bool
tc bool
}
@ -1584,11 +1584,14 @@ func (tc *calledAsTestcase) test(t *testing.T) {
parent := &Command{Use: "parent", Run: run}
child1 := &Command{Use: "child1", Run: run, Aliases: []string{"this"}}
child2 := &Command{Use: "child2", Run: run, Aliases: []string{"that"}}
child11 := &Command{Use: "child11", Run: run, Aliases: []string{"foo"}}
parent.AddCommand(child1)
parent.AddCommand(child2)
parent.SetArgs(tc.args)
child1.AddCommand(child11)
output := new(bytes.Buffer)
parent.SetOutput(output)
@ -1603,25 +1606,57 @@ func (tc *calledAsTestcase) test(t *testing.T) {
if called.Name() != tc.call {
t.Errorf("called command == %q; Wanted %q", called.Name(), tc.call)
} else if got := called.CalledAs(); got != tc.want {
return
}
if got := called.CalledAs(); got != tc.want[0] {
t.Errorf("%s.CalledAs() == %q; Wanted: %q", tc.call, got, tc.want)
}
if len(tc.want) > 1 {
// Run through the parents to see they were called with an alias you can
// get the correct names as well.
p := called
for _, want := range tc.want[1:] {
p = p.Parent()
if p == nil {
t.Errorf("did not find expected parent for %v", want)
return
}
if got := p.CalledAs(); got != want {
t.Errorf("%v.CalledAS() == %q; Wanted: %q", p.Name(), got, want)
return
}
}
}
}
func TestCalledAs(t *testing.T) {
tests := map[string]calledAsTestcase{
"find/no-args": {nil, "parent", "parent", false, false},
"find/real-name": {[]string{"child1"}, "child1", "child1", false, false},
"find/full-alias": {[]string{"that"}, "child2", "that", false, false},
"find/part-no-prefix": {[]string{"thi"}, "", "", false, false},
"find/part-alias": {[]string{"thi"}, "child1", "this", true, false},
"find/conflict": {[]string{"th"}, "", "", true, false},
"traverse/no-args": {nil, "parent", "parent", false, true},
"traverse/real-name": {[]string{"child1"}, "child1", "child1", false, true},
"traverse/full-alias": {[]string{"that"}, "child2", "that", false, true},
"traverse/part-no-prefix": {[]string{"thi"}, "", "", false, true},
"traverse/part-alias": {[]string{"thi"}, "child1", "this", true, true},
"traverse/conflict": {[]string{"th"}, "", "", true, true},
"find/no-args": {nil, "parent", []string{"parent"}, false, false},
"find/real-name": {[]string{"child1"}, "child1", []string{"child1"}, false, false},
"find/full-alias": {[]string{"that"}, "child2", []string{"that"}, false, false},
"find/part-no-prefix": {[]string{"thi"}, "", []string{""}, false, false},
"find/part-alias": {[]string{"thi"}, "child1", []string{"this"}, true, false},
"find/conflict": {[]string{"th"}, "", []string{""}, true, false},
"traverse/no-args": {nil, "parent", []string{"parent"}, false, true},
"traverse/real-name": {[]string{"child1"}, "child1", []string{"child1"}, false, true},
"traverse/real-name/traverse/real-name": {[]string{"child1", "child11"}, "child11", []string{"child11"}, false, false},
"traverse/real-name/traverse/full-alias": {[]string{"child1", "foo"}, "child11", []string{"foo", "child1"}, false, false},
"traverse/real-name/traverse/part-alias": {[]string{"child1", "fo"}, "child11", []string{"foo", "child1"}, true, false},
"traverse/full-alias": {[]string{"that"}, "child2", []string{"that"}, false, true},
"traverse/full-alias/traverse/real-name": {[]string{"this", "child11"}, "child11", []string{"child11", "this"}, false, false},
"traverse/full-alias/traverse/full-alias": {[]string{"this", "foo"}, "child11", []string{"foo", "this"}, false, false},
"traverse/full-alias/traverse/part-alias": {[]string{"this", "fo"}, "child11", []string{"foo", "this"}, true, false},
"traverse/part-no-prefix": {[]string{"thi"}, "", []string{""}, false, true},
"traverse/part-alias": {[]string{"thi"}, "child1", []string{"this"}, true, true},
"traverse/part-alias/traverse/real-name": {[]string{"thi", "child11"}, "child11", []string{"child11", "this"}, true, false},
"traverse/part-alias/traverse/full-alias": {[]string{"thi", "foo"}, "child11", []string{"foo", "this"}, true, false},
"traverse/part-alias/traverse/part-alias": {[]string{"thi", "fo"}, "child11", []string{"foo", "this"}, true, false},
"traverse/conflict": {[]string{"th"}, "", []string{""}, true, true},
}
for name, tc := range tests {