141 lines
3.9 KiB
Go
141 lines
3.9 KiB
Go
package cobra
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"os"
|
|
"os/exec"
|
|
"strings"
|
|
"testing"
|
|
)
|
|
|
|
var _ = fmt.Println
|
|
var _ = os.Stderr
|
|
|
|
func checkOmit(t *testing.T, found, unexpected string) {
|
|
if strings.Contains(found, unexpected) {
|
|
t.Errorf("Unexpected response.\nGot: %q\nBut should not have!\n", unexpected)
|
|
}
|
|
}
|
|
|
|
func check(t *testing.T, found, expected string) {
|
|
if !strings.Contains(found, expected) {
|
|
t.Errorf("Unexpected response.\nExpecting to contain: \n %q\nGot:\n %q\n", expected, found)
|
|
}
|
|
}
|
|
|
|
func runShellCheck(s string) error {
|
|
excluded := []string{
|
|
"SC2034", // PREFIX appears unused. Verify it or export it.
|
|
}
|
|
cmd := exec.Command("shellcheck", "-s", "bash", "-", "-e", strings.Join(excluded, ","))
|
|
cmd.Stderr = os.Stderr
|
|
cmd.Stdout = os.Stdout
|
|
|
|
stdin, err := cmd.StdinPipe()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
go func() {
|
|
defer stdin.Close()
|
|
stdin.Write([]byte(s))
|
|
}()
|
|
|
|
return cmd.Run()
|
|
}
|
|
|
|
// World worst custom function, just keep telling you to enter hello!
|
|
const (
|
|
bashCompletionFunc = `__custom_func() {
|
|
COMPREPLY=( "hello" )
|
|
}
|
|
`
|
|
)
|
|
|
|
func TestBashCompletions(t *testing.T) {
|
|
c := initializeWithRootCmd()
|
|
cmdEcho.AddCommand(cmdTimes)
|
|
c.AddCommand(cmdEcho, cmdPrint, cmdDeprecated, cmdColon)
|
|
|
|
// custom completion function
|
|
c.BashCompletionFunction = bashCompletionFunc
|
|
|
|
// required flag
|
|
c.MarkFlagRequired("introot")
|
|
|
|
// valid nouns
|
|
validArgs := []string{"pod", "node", "service", "replicationcontroller"}
|
|
c.ValidArgs = validArgs
|
|
|
|
// noun aliases
|
|
argAliases := []string{"pods", "nodes", "services", "replicationcontrollers", "po", "no", "svc", "rc"}
|
|
c.ArgAliases = argAliases
|
|
|
|
// filename
|
|
var flagval string
|
|
c.Flags().StringVar(&flagval, "filename", "", "Enter a filename")
|
|
c.MarkFlagFilename("filename", "json", "yaml", "yml")
|
|
|
|
// persistent filename
|
|
var flagvalPersistent string
|
|
c.PersistentFlags().StringVar(&flagvalPersistent, "persistent-filename", "", "Enter a filename")
|
|
c.MarkPersistentFlagFilename("persistent-filename")
|
|
c.MarkPersistentFlagRequired("persistent-filename")
|
|
|
|
// filename extensions
|
|
var flagvalExt string
|
|
c.Flags().StringVar(&flagvalExt, "filename-ext", "", "Enter a filename (extension limited)")
|
|
c.MarkFlagFilename("filename-ext")
|
|
|
|
// filename extensions
|
|
var flagvalCustom string
|
|
c.Flags().StringVar(&flagvalCustom, "custom", "", "Enter a filename (extension limited)")
|
|
c.MarkFlagCustom("custom", "__complete_custom")
|
|
|
|
// subdirectories in a given directory
|
|
var flagvalTheme string
|
|
c.Flags().StringVar(&flagvalTheme, "theme", "", "theme to use (located in /themes/THEMENAME/)")
|
|
c.Flags().SetAnnotation("theme", BashCompSubdirsInDir, []string{"themes"})
|
|
|
|
out := new(bytes.Buffer)
|
|
c.GenBashCompletion(out)
|
|
str := out.String()
|
|
|
|
check(t, str, "_cobra-test")
|
|
check(t, str, "_cobra-test_echo")
|
|
check(t, str, "_cobra-test_echo_times")
|
|
check(t, str, "_cobra-test_print")
|
|
check(t, str, "_cobra-test_cmd__colon")
|
|
|
|
// check for required flags
|
|
check(t, str, `must_have_one_flag+=("--introot=")`)
|
|
check(t, str, `must_have_one_flag+=("--persistent-filename=")`)
|
|
// check for custom completion function
|
|
check(t, str, `COMPREPLY=( "hello" )`)
|
|
// check for required nouns
|
|
check(t, str, `must_have_one_noun+=("pod")`)
|
|
// check for noun aliases
|
|
check(t, str, `noun_aliases+=("pods")`)
|
|
check(t, str, `noun_aliases+=("rc")`)
|
|
checkOmit(t, str, `must_have_one_noun+=("pods")`)
|
|
// check for filename extension flags
|
|
check(t, str, `flags_completion+=("_filedir")`)
|
|
// check for filename extension flags
|
|
check(t, str, `flags_completion+=("__handle_filename_extension_flag json|yaml|yml")`)
|
|
// check for custom flags
|
|
check(t, str, `flags_completion+=("__complete_custom")`)
|
|
// check for subdirs_in_dir flags
|
|
check(t, str, `flags_completion+=("__handle_subdirs_in_dir_flag themes")`)
|
|
|
|
checkOmit(t, str, cmdDeprecated.Name())
|
|
|
|
// if available, run shellcheck against the script
|
|
if err := exec.Command("which", "shellcheck").Run(); err != nil {
|
|
return
|
|
}
|
|
err := runShellCheck(str)
|
|
if err != nil {
|
|
t.Fatalf("shellcheck failed: %v", err)
|
|
}
|
|
}
|