Merge pull request openshift#455 from mjlshen/OSD-19092-complete

Use built-in functions to generate osdctl completion for bash, zsh, and fish

Author: openshift-ci[bot]

cmd/cmd.go

@@ -86,6 +86,7 @@ func NewCmdRoot(streams genericclioptions.IOStreams) *cobra.Command {
 	rootCmd.AddCommand(account.NewCmdAccount(streams, kubeFlags, kubeClient, globalOpts))
 	rootCmd.AddCommand(cluster.NewCmdCluster(streams, kubeFlags, kubeClient, globalOpts))
 	rootCmd.AddCommand(clusterdeployment.NewCmdClusterDeployment(streams, kubeFlags, kubeClient))
+	rootCmd.AddCommand(newCmdCompletion())
 	rootCmd.AddCommand(env.NewCmdEnv(streams, kubeFlags))
 	rootCmd.AddCommand(federatedrole.NewCmdFederatedRole(streams, kubeFlags, kubeClient))
 	rootCmd.AddCommand(jumphost.NewCmdJumphost())
@@ -96,9 +97,6 @@ func NewCmdRoot(streams genericclioptions.IOStreams) *cobra.Command {
 	rootCmd.AddCommand(promote.NewCmdPromote(kubeFlags, globalOpts))
 	rootCmd.AddCommand(jira.Cmd)
 
-	// add completion command
-	rootCmd.AddCommand(newCmdCompletion(streams))
-
 	// add options command to list global flags
 	rootCmd.AddCommand(newCmdOptions(streams))
 

cmd/completion.go

@@ -1,12 +1,7 @@
 package cmd
 
 import (
-	"bytes"
-	"io"
-
 	"github.com/spf13/cobra"
-
-	"k8s.io/cli-runtime/pkg/genericclioptions"
 	cmdutil "k8s.io/kubectl/pkg/cmd/util"
 	"k8s.io/kubectl/pkg/util/templates"
 )
@@ -41,183 +36,27 @@ var (
 )
 
 // newCmdCompletion creates the `completion` command
-func newCmdCompletion(streams genericclioptions.IOStreams) *cobra.Command {
-	ops := newCompletionOptions(streams)
+func newCmdCompletion() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:                   "completion SHELL",
-		Short:                 "Output shell completion code for the specified shell (bash or zsh)",
-		Example:               completionExample,
-		DisableAutoGenTag:     true,
-		DisableFlagsInUseLine: true,
-		Run: func(cmd *cobra.Command, args []string) {
-			cmdutil.CheckErr(ops.run(cmd, args))
+		Use:               "completion SHELL",
+		Short:             "Output shell completion code for the specified shell (bash or zsh)",
+		Example:           completionExample,
+		DisableAutoGenTag: true,
+		Args:              cobra.MatchAll(cobra.ExactArgs(1), cobra.OnlyValidArgs),
+		ValidArgs:         []string{"bash", "zsh", "fish"},
+		RunE: func(cmd *cobra.Command, args []string) error {
+			switch args[0] {
+			case "bash":
+				return cmd.Parent().GenBashCompletion(cmd.OutOrStdout())
+			case "zsh":
+				return cmd.Root().GenZshCompletion(cmd.OutOrStdout())
+			case "fish":
+				return cmd.Root().GenFishCompletion(cmd.OutOrStdout(), true)
+			default:
+				return cmdutil.UsageErrorf(cmd, "Unsupported shell type %q.", args[0])
+			}
 		},
 	}
 
 	return cmd
 }
-
-type completionOptions struct {
-	supportedShells []string
-
-	genericclioptions.IOStreams
-}
-
-func newCompletionOptions(streams genericclioptions.IOStreams) *completionOptions {
-	return &completionOptions{
-		IOStreams: streams,
-	}
-}
-
-func (o *completionOptions) run(cmd *cobra.Command, args []string) error {
-	if len(args) == 0 {
-		return cmdutil.UsageErrorf(cmd, "Shell not specified.")
-	}
-	if len(args) > 1 {
-		return cmdutil.UsageErrorf(cmd, "Too many arguments. Expected only the shell type.")
-	}
-	switch args[0] {
-	case "bash":
-		return cmd.Parent().GenBashCompletion(o.Out)
-	case "zsh":
-		return genCompletionZsh(o.Out, cmd.Parent())
-	default:
-		return cmdutil.UsageErrorf(cmd, "Unsupported shell type %q.", args[0])
-	}
-}
-
-// Followed the trick https://github.com/kubernetes/kubectl/blob/master/pkg/cmd/completion/completion.go#L145.
-func genCompletionZsh(out io.Writer, osdctl *cobra.Command) error {
-	zshHead := "#compdef osdctl\n"
-	_, err := out.Write([]byte(zshHead))
-	if err != nil {
-		return err
-	}
-
-	zshInitialization := `
-__osdctl_bash_source() {
-	alias shopt=':'
-	emulate -L sh
-	setopt kshglob noshglob braceexpand
-
-	source "$@"
-}
-
-__osdctl_type() {
-	# -t is not supported by zsh
-	if [ "$1" == "-t" ]; then
-		shift
-
-		# fake Bash 4 to disable "complete -o nospace". Instead
-		# "compopt +-o nospace" is used in the code to toggle trailing
-		# spaces. We don't support that, but leave trailing spaces on
-		# all the time
-		if [ "$1" = "__osdctl_compopt" ]; then
-			echo builtin
-			return 0
-		fi
-	fi
-	type "$@"
-}
-
-__osdctl_compgen() {
-	local completions w
-	completions=( $(compgen "$@") ) || return $?
-
-	# filter by given word as prefix
-	while [[ "$1" = -* && "$1" != -- ]]; do
-		shift
-		shift
-	done
-	if [[ "$1" == -- ]]; then
-		shift
-	fi
-	for w in "${completions[@]}"; do
-		if [[ "${w}" = "$1"* ]]; then
-			echo "${w}"
-		fi
-	done
-}
-
-__osdctl_compopt() {
-	true # don't do anything. Not supported by bashcompinit in zsh
-}
-
-__osdctl_ltrim_colon_completions()
-{
-	if [[ "$1" == *:* && "$COMP_WORDBREAKS" == *:* ]]; then
-		# Remove colon-word prefix from COMPREPLY items
-		local colon_word=${1%${1##*:}}
-		local i=${#COMPREPLY[*]}
-		while [[ $((--i)) -ge 0 ]]; do
-			COMPREPLY[$i]=${COMPREPLY[$i]#"$colon_word"}
-		done
-	fi
-}
-
-__osdctl_get_comp_words_by_ref() {
-	cur="${COMP_WORDS[COMP_CWORD]}"
-	prev="${COMP_WORDS[${COMP_CWORD}-1]}"
-	words=("${COMP_WORDS[@]}")
-	cword=("${COMP_CWORD[@]}")
-}
-
-__osdctl_filedir() {
-	# Don't need to do anything here.
-	# Otherwise we will get trailing space without "compopt -o nospace"
-	true
-}
-
-autoload -U +X bashcompinit && bashcompinit
-
-# use word boundary patterns for BSD or GNU sed
-LWORD='[[:<:]]'
-RWORD='[[:>:]]'
-if sed --help 2>&1 | grep -q 'GNU\|BusyBox'; then
-	LWORD='\<'
-	RWORD='\>'
-fi
-
-__osdctl_convert_bash_to_zsh() {
-	sed \
-	-e 's/declare -F/whence -w/' \
-	-e 's/_get_comp_words_by_ref "\$@"/_get_comp_words_by_ref "\$*"/' \
-	-e 's/local \([a-zA-Z0-9_]*\)=/local \1; \1=/' \
-	-e 's/flags+=("\(--.*\)=")/flags+=("\1"); two_word_flags+=("\1")/' \
-	-e 's/must_have_one_flag+=("\(--.*\)=")/must_have_one_flag+=("\1")/' \
-	-e "s/${LWORD}_filedir${RWORD}/__osdctl_filedir/g" \
-	-e "s/${LWORD}_get_comp_words_by_ref${RWORD}/__osdctl_get_comp_words_by_ref/g" \
-	-e "s/${LWORD}__ltrim_colon_completions${RWORD}/__osdctl_ltrim_colon_completions/g" \
-	-e "s/${LWORD}compgen${RWORD}/__osdctl_compgen/g" \
-	-e "s/${LWORD}compopt${RWORD}/__osdctl_compopt/g" \
-	-e "s/${LWORD}declare${RWORD}/builtin declare/g" \
-	-e "s/\\\$(type${RWORD}/\$(__osdctl_type/g" \
-	<<'BASH_COMPLETION_EOF'
-`
-	_, err = out.Write([]byte(zshInitialization))
-	if err != nil {
-		return err
-	}
-
-	buf := new(bytes.Buffer)
-	err = osdctl.GenBashCompletion(buf)
-	if err != nil {
-		return err
-	}
-	_, err = out.Write(buf.Bytes())
-	if err != nil {
-		return err
-	}
-
-	zshTail := `
-BASH_COMPLETION_EOF
-}
-
-__osdctl_bash_source <(__osdctl_convert_bash_to_zsh)
-`
-	_, err = out.Write([]byte(zshTail))
-	if err != nil {
-		return err
-	}
-	return nil
-}