123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274 |
- /*
- Copyright 2014 The Kubernetes Authors.
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- */
- package cmd
- import (
- "bytes"
- "io"
- "github.com/spf13/cobra"
- cmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util"
- )
- const (
- completion_long = `Output shell completion code for the given shell (bash or zsh).
- This command prints shell code which must be evaluation to provide interactive
- completion of kubectl commands.
- `
- completion_example = `
- $ source <(kubectl completion bash)
- will load the kubectl completion code for bash. Note that this depends on the
- bash-completion framework. It must be sourced before sourcing the kubectl
- completion, e.g. on the Mac:
- $ brew install bash-completion
- $ source $(brew --prefix)/etc/bash_completion
- $ source <(kubectl completion bash)
- If you use zsh*, the following will load kubectl zsh completion:
- $ source <(kubectl completion zsh)
- * zsh completions are only supported in versions of zsh >= 5.2`
- )
- var (
- completion_shells = map[string]func(out io.Writer, cmd *cobra.Command) error{
- "bash": runCompletionBash,
- "zsh": runCompletionZsh,
- }
- )
- func NewCmdCompletion(f *cmdutil.Factory, out io.Writer) *cobra.Command {
- shells := []string{}
- for s := range completion_shells {
- shells = append(shells, s)
- }
- cmd := &cobra.Command{
- Use: "completion SHELL",
- Short: "Output shell completion code for the given shell (bash or zsh)",
- Long: completion_long,
- Example: completion_example,
- Run: func(cmd *cobra.Command, args []string) {
- err := RunCompletion(f, out, cmd, args)
- cmdutil.CheckErr(err)
- },
- ValidArgs: shells,
- }
- return cmd
- }
- func RunCompletion(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string) error {
- if len(args) == 0 {
- return cmdutil.UsageError(cmd, "Shell not specified.")
- }
- if len(args) > 1 {
- return cmdutil.UsageError(cmd, "Too many arguments. Expected only the shell type.")
- }
- run, found := completion_shells[args[0]]
- if !found {
- return cmdutil.UsageError(cmd, "Unsupported shell type %q.", args[0])
- }
- return run(out, cmd.Parent())
- }
- func runCompletionBash(out io.Writer, kubectl *cobra.Command) error {
- return kubectl.GenBashCompletion(out)
- }
- func runCompletionZsh(out io.Writer, kubectl *cobra.Command) error {
- zsh_initialilzation := `# Copyright 2016 The Kubernetes Authors.
- #
- # Licensed under the Apache License, Version 2.0 (the "License");
- # you may not use this file except in compliance with the License.
- # You may obtain a copy of the License at
- #
- # http://www.apache.org/licenses/LICENSE-2.0
- #
- # Unless required by applicable law or agreed to in writing, software
- # distributed under the License is distributed on an "AS IS" BASIS,
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- # See the License for the specific language governing permissions and
- # limitations under the License.
- __kubectl_bash_source() {
- alias shopt=':'
- alias _expand=_bash_expand
- alias _complete=_bash_comp
- emulate -L sh
- setopt kshglob noshglob braceexpand
- source "$@"
- }
- __kubectl_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" = "__kubectl_compopt" ]; then
- echo builtin
- return 0
- fi
- fi
- type "$@"
- }
- __kubectl_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
- }
- __kubectl_compopt() {
- true # don't do anything. Not supported by bashcompinit in zsh
- }
- __kubectl_declare() {
- if [ "$1" == "-F" ]; then
- whence -w "$@"
- else
- builtin declare "$@"
- fi
- }
- __kubectl_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
- }
- __kubectl_get_comp_words_by_ref() {
- cur="${COMP_WORDS[COMP_CWORD]}"
- prev="${COMP_WORDS[${COMP_CWORD}-1]}"
- words=("${COMP_WORDS[@]}")
- cword=("${COMP_CWORD[@]}")
- }
- __kubectl_filedir() {
- local RET OLD_IFS w qw
- __debug "_filedir $@ cur=$cur"
- if [[ "$1" = \~* ]]; then
- # somehow does not work. Maybe, zsh does not call this at all
- eval echo "$1"
- return 0
- fi
- OLD_IFS="$IFS"
- IFS=$'\n'
- if [ "$1" = "-d" ]; then
- shift
- RET=( $(compgen -d) )
- else
- RET=( $(compgen -f) )
- fi
- IFS="$OLD_IFS"
- IFS="," __debug "RET=${RET[@]} len=${#RET[@]}"
- for w in ${RET[@]}; do
- if [[ ! "${w}" = "${cur}"* ]]; then
- continue
- fi
- if eval "[[ \"\${w}\" = *.$1 || -d \"\${w}\" ]]"; then
- qw="$(__kubectl_quote "${w}")"
- if [ -d "${w}" ]; then
- COMPREPLY+=("${qw}/")
- else
- COMPREPLY+=("${qw}")
- fi
- fi
- done
- }
- __kubectl_quote() {
- if [[ $1 == \'* || $1 == \"* ]]; then
- # Leave out first character
- printf %q "${1:1}"
- else
- printf %q "$1"
- fi
- }
- autoload -U +X compinit && compinit
- autoload -U +X bashcompinit && bashcompinit
- # use word boundary patterns for BSD or GNU sed
- LWORD='[[:<:]]'
- RWORD='[[:>:]]'
- if sed --help 2>&1 | grep -q GNU; then
- LWORD='\<'
- RWORD='\>'
- fi
- __kubectl_bash_source <(sed \
- -e 's/declare -F/whence -w/' \
- -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}/__kubectl_filedir/g" \
- -e "s/${LWORD}_get_comp_words_by_ref${RWORD}/__kubectl_get_comp_words_by_ref/g" \
- -e "s/${LWORD}__ltrim_colon_completions${RWORD}/__kubectl_ltrim_colon_completions/g" \
- -e "s/${LWORD}compgen${RWORD}/__kubectl_compgen/g" \
- -e "s/${LWORD}compopt${RWORD}/__kubectl_compopt/g" \
- -e "s/${LWORD}declare${RWORD}/__kubectl_declare/g" \
- -e "s/\\\$(type${RWORD}/\$(__kubectl_type/g" \
- <<'BASH_COMPLETION_EOF'
- `
- out.Write([]byte(zsh_initialilzation))
- buf := new(bytes.Buffer)
- kubectl.GenBashCompletion(buf)
- out.Write(buf.Bytes())
- zsh_tail := `
- BASH_COMPLETION_EOF
- )
- `
- out.Write([]byte(zsh_tail))
- return nil
- }
|