Qualify custom bash func name (#730)

* Qualify custom bash func name

 - fixes issue where multiple cobra apps using custom bash completion
 would have their __custom_func collide
 - support fallback to plain __custom_func to maintain compatibility

#694

* Improve tests for bash completion __custom_func

 - check for the correct number of occurrences of function name

#694
This commit is contained in:
Paul
2018-08-21 11:12:02 -05:00
committed by Eric Paris
parent ff0d02e855
commit 6fd8e29b07
3 changed files with 21 additions and 5 deletions

View File

@ -22,6 +22,13 @@ func check(t *testing.T, found, expected string) {
}
}
func checkNumOccurrences(t *testing.T, found, expected string, expectedOccurrences int) {
numOccurrences := strings.Count(found, expected)
if numOccurrences != expectedOccurrences {
t.Errorf("Expecting to contain %d occurrences of: \n %q\nGot %d:\n %q\n", expectedOccurrences, expected, numOccurrences, found)
}
}
func checkRegex(t *testing.T, found, pattern string) {
matched, err := regexp.MatchString(pattern, found)
if err != nil {
@ -53,7 +60,7 @@ func runShellCheck(s string) error {
}
// World worst custom function, just keep telling you to enter hello!
const bashCompletionFunc = `__custom_func() {
const bashCompletionFunc = `__root_custom_func() {
COMPREPLY=( "hello" )
}
`
@ -150,7 +157,10 @@ func TestBashCompletions(t *testing.T) {
// check for required flags
check(t, output, `must_have_one_flag+=("--introot=")`)
check(t, output, `must_have_one_flag+=("--persistent-filename=")`)
// check for custom completion function
// check for custom completion function with both qualified and unqualified name
checkNumOccurrences(t, output, `__custom_func`, 2) // 1. check existence, 2. invoke
checkNumOccurrences(t, output, `__root_custom_func`, 3) // 1. check existence, 2. invoke, 3. actual definition
// check for custom completion function body
check(t, output, `COMPREPLY=( "hello" )`)
// check for required nouns
check(t, output, `must_have_one_noun+=("pod")`)