Avoid conflicts with other cobra auto completions #70470

dtaniwaki · 2018-10-31T07:35:36Z

What type of PR is this?

/kind bug

What this PR does / why we need it:

kubectl get -n foo pod [TAB][TAB] ignores the namespace while kubectl get --namespace foo pod [TAB][TAB] and kubectl get --namespace=foo pod [TAB][TAB] don't.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):

N/A

Special notes for your reviewer:

N/A

Does this PR introduce a user-facing change?:

NONE

idealhack · 2018-10-31T07:55:25Z

/ok-to-test

idealhack · 2018-10-31T07:57:55Z

I don't think I can reproduce this bug

Client Version: version.Info{Major:"1", Minor:"12", GitVersion:"v1.12.0", GitCommit:"0ed33881dc4355495f623c6f22e7dd0b7632b7c0", GitTreeState:"clean", BuildDate:"2018-09-28T15:18:13Z", GoVersion:"go1.11", Compiler:"gc", Platform:"darwin/amd64"}

dtaniwaki · 2018-10-31T15:37:10Z

Here's my result without this fix.

$ kubectl version
Client Version: version.Info{Major:"1", Minor:"12", GitVersion:"v1.12.2", GitCommit:"17c77c7898218073f14c8d573582e8d2313dc740", GitTreeState:"clean", BuildDate:"2018-10-30T21:39:38Z", GoVersion:"go1.11.1", Compiler:"gc", Platform:"darwin/amd64"}

$ kubectl get -n kube-system pod
my-pod-1
my-pod-2

$ kubectl get --namespace kube-system pod
coredns-99b9bb8bd-fpwfr
etcd-minikube
kube-addon-manager-minikube
kube-apiserver-minikube
kube-controller-manager-minikube
kube-proxy-mkl4h
kube-scheduler-minikube
kubernetes-dashboard-7db4dc666b-vbnhv
storage-provisioner
tiller-deploy-64c9d747bd-6r7cn

dtaniwaki · 2018-11-17T14:59:25Z

/assign @deads2k

dtaniwaki · 2019-01-05T15:12:28Z

@deads2k Could you review this PR?

idealhack · 2019-01-05T15:25:13Z

cc @kubernetes/sig-cli-pr-reviews

dixudx · 2019-01-06T15:26:13Z

pkg/kubectl/cmd/cmd.go

@@ -84,7 +84,11 @@ __kubectl_override_flags()
    local ${__kubectl_override_flag_list[*]##*-} two_word_of of var
    for w in "${words[@]}"; do
        if [ -n "${two_word_of}" ]; then
-            eval "${two_word_of##*-}=\"${two_word_of}=\${w}\""
+            if [[ "${two_word_of}" == --* ]]; then


If that is a bug, I don't think this pr will actually fix it.

The changes here is only used for bash completion, which will do nothing for parsing arguments.

The bug is in the autocompletion… the suggestions on [tab][tab] do not honor the specified namespace

The bug is in the autocompletion… the suggestions on [tab][tab] do not honor the specified namespace

Yes, that is what I wanted to fix, but it seems I was looking into a wrong place. I'm trying to update reproducible steps and fix the issue.

dtaniwaki · 2019-01-12T16:31:18Z

I added debug logs for auto completion commands and found which patterns don't work correctly.

✅ kubectl get pod -n argo
✅ kubectl get pod --namespace=argo
❌ kubectl get pod --namespace argo
✅ kubectl get -n argo pod
✅ kubectl get --namespace=argo pod
✅ kubectl get --namespace argo pod

I enabled debug logs and got the following.

the completion log

__kubectl_handle_word: c is 0 words[c] is kubectl
__kubectl_handle_command: c is 0 words[c] is kubectl
__kubectl_handle_command: looking for _kubectl_root_command
__kubectl_handle_word: c is 1 words[c] is get
__kubectl_handle_command: c is 1 words[c] is get
__kubectl_handle_command: looking for _kubectl_get
__kubectl_handle_word: c is 2 words[c] is pod
__kubectl_handle_noun: c is 2 words[c] is pod
__kubectl_handle_word: c is 3 words[c] is -n
__kubectl_handle_flag: c is 3 words[c] is -n
__kubectl_handle_flag: looking for -n
__kubectl_handle_flag: found a flag -n, skip the next argument
__kubectl_handle_reply
__kubectl_parse_get: get completion by kubectl get -n=argo -o template --template="{{ range .items  }}{{ .metadata.name }} {{ end }}" "pod"
__kubectl_handle_word: c is 0 words[c] is kubectl
__kubectl_handle_command: c is 0 words[c] is kubectl
__kubectl_handle_command: looking for _kubectl_root_command
__kubectl_handle_word: c is 1 words[c] is get
__kubectl_handle_command: c is 1 words[c] is get
__kubectl_handle_command: looking for _kubectl_get
__kubectl_handle_word: c is 2 words[c] is pod
__kubectl_handle_noun: c is 2 words[c] is pod
__kubectl_handle_word: c is 3 words[c] is -n
__kubectl_handle_flag: c is 3 words[c] is -n
__kubectl_handle_flag: looking for -n
__kubectl_handle_flag: found a flag -n, skip the next argument
__kubectl_handle_reply
__kubectl_parse_get: get completion by kubectl get -n=argo -o template --template="{{ range .items  }}{{ .metadata.name }} {{ end }}" "pod"
__kubectl_handle_word: c is 0 words[c] is kubectl
__kubectl_handle_command: c is 0 words[c] is kubectl
__kubectl_handle_command: looking for _kubectl_root_command
__kubectl_handle_word: c is 1 words[c] is get
__kubectl_handle_command: c is 1 words[c] is get
__kubectl_handle_command: looking for _kubectl_get
__kubectl_handle_word: c is 2 words[c] is pod
__kubectl_handle_noun: c is 2 words[c] is pod
__kubectl_handle_word: c is 3 words[c] is --namespace=argo
__kubectl_handle_flag: c is 3 words[c] is --namespace=argo
__kubectl_handle_flag: looking for --namespace=
__kubectl_handle_reply
__kubectl_parse_get: get completion by kubectl get --namespace=argo -o template --template="{{ range .items  }}{{ .metadata.name }} {{ end }}" "pod"
__kubectl_handle_word: c is 0 words[c] is kubectl
__kubectl_handle_command: c is 0 words[c] is kubectl
__kubectl_handle_command: looking for _kubectl_root_command
__kubectl_handle_word: c is 1 words[c] is get
__kubectl_handle_command: c is 1 words[c] is get
__kubectl_handle_command: looking for _kubectl_get
__kubectl_handle_word: c is 2 words[c] is pod
__kubectl_handle_noun: c is 2 words[c] is pod
__kubectl_handle_word: c is 3 words[c] is --namespace=argo
__kubectl_handle_flag: c is 3 words[c] is --namespace=argo
__kubectl_handle_flag: looking for --namespace=
__kubectl_handle_reply
__kubectl_parse_get: get completion by kubectl get --namespace=argo -o template --template="{{ range .items  }}{{ .metadata.name }} {{ end }}" "pod"
__kubectl_handle_word: c is 0 words[c] is kubectl
__kubectl_handle_command: c is 0 words[c] is kubectl
__kubectl_handle_command: looking for _kubectl_root_command
__kubectl_handle_word: c is 1 words[c] is get
__kubectl_handle_command: c is 1 words[c] is get
__kubectl_handle_command: looking for _kubectl_get
__kubectl_handle_word: c is 2 words[c] is pod
__kubectl_handle_noun: c is 2 words[c] is pod
__kubectl_handle_word: c is 3 words[c] is --namespace
__kubectl_handle_flag: c is 3 words[c] is --namespace
__kubectl_handle_flag: looking for --namespace
__kubectl_handle_word: c is 4 words[c] is argo
__kubectl_handle_noun: c is 4 words[c] is argo
__kubectl_handle_reply
__kubectl_parse_get: get completion by kubectl get --namespace=argo -o template --template="{{ range .items  }}{{ .metadata.name }} {{ end }}" "argo"
__kubectl_handle_word: c is 0 words[c] is kubectl
__kubectl_handle_command: c is 0 words[c] is kubectl
__kubectl_handle_command: looking for _kubectl_root_command
__kubectl_handle_word: c is 1 words[c] is get
__kubectl_handle_command: c is 1 words[c] is get
__kubectl_handle_command: looking for _kubectl_get
__kubectl_handle_word: c is 2 words[c] is pod
__kubectl_handle_noun: c is 2 words[c] is pod
__kubectl_handle_word: c is 3 words[c] is --namespace
__kubectl_handle_flag: c is 3 words[c] is --namespace
__kubectl_handle_flag: looking for --namespace
__kubectl_handle_word: c is 4 words[c] is argo
__kubectl_handle_noun: c is 4 words[c] is argo
__kubectl_handle_reply
__kubectl_parse_get: get completion by kubectl get --namespace=argo -o template --template="{{ range .items  }}{{ .metadata.name }} {{ end }}" "argo"
__kubectl_handle_word: c is 0 words[c] is kubectl
__kubectl_handle_command: c is 0 words[c] is kubectl
__kubectl_handle_command: looking for _kubectl_root_command
__kubectl_handle_word: c is 1 words[c] is get
__kubectl_handle_command: c is 1 words[c] is get
__kubectl_handle_command: looking for _kubectl_get
__kubectl_handle_word: c is 2 words[c] is -n
__kubectl_handle_flag: c is 2 words[c] is -n
__kubectl_handle_flag: looking for -n
__kubectl_handle_flag: found a flag -n, skip the next argument
__kubectl_handle_word: c is 4 words[c] is pod
__kubectl_handle_noun: c is 4 words[c] is pod
__kubectl_handle_reply
__kubectl_parse_get: get completion by kubectl get -n=argo -o template --template="{{ range .items  }}{{ .metadata.name }} {{ end }}" "pod"
__kubectl_handle_word: c is 0 words[c] is kubectl
__kubectl_handle_command: c is 0 words[c] is kubectl
__kubectl_handle_command: looking for _kubectl_root_command
__kubectl_handle_word: c is 1 words[c] is get
__kubectl_handle_command: c is 1 words[c] is get
__kubectl_handle_command: looking for _kubectl_get
__kubectl_handle_word: c is 2 words[c] is -n
__kubectl_handle_flag: c is 2 words[c] is -n
__kubectl_handle_flag: looking for -n
__kubectl_handle_flag: found a flag -n, skip the next argument
__kubectl_handle_word: c is 4 words[c] is pod
__kubectl_handle_noun: c is 4 words[c] is pod
__kubectl_handle_reply
__kubectl_parse_get: get completion by kubectl get -n=argo -o template --template="{{ range .items  }}{{ .metadata.name }} {{ end }}" "pod"
__kubectl_handle_word: c is 0 words[c] is kubectl
__kubectl_handle_command: c is 0 words[c] is kubectl
__kubectl_handle_command: looking for _kubectl_root_command
__kubectl_handle_word: c is 1 words[c] is get
__kubectl_handle_command: c is 1 words[c] is get
__kubectl_handle_command: looking for _kubectl_get
__kubectl_handle_word: c is 2 words[c] is --namespace=argo
__kubectl_handle_flag: c is 2 words[c] is --namespace=argo
__kubectl_handle_flag: looking for --namespace=
__kubectl_handle_word: c is 3 words[c] is pod
__kubectl_handle_noun: c is 3 words[c] is pod
__kubectl_handle_reply
__kubectl_parse_get: get completion by kubectl get --namespace=argo -o template --template="{{ range .items  }}{{ .metadata.name }} {{ end }}" "pod"
__kubectl_handle_word: c is 0 words[c] is kubectl
__kubectl_handle_command: c is 0 words[c] is kubectl
__kubectl_handle_command: looking for _kubectl_root_command
__kubectl_handle_word: c is 1 words[c] is get
__kubectl_handle_command: c is 1 words[c] is get
__kubectl_handle_command: looking for _kubectl_get
__kubectl_handle_word: c is 2 words[c] is --namespace=argo
__kubectl_handle_flag: c is 2 words[c] is --namespace=argo
__kubectl_handle_flag: looking for --namespace=
__kubectl_handle_word: c is 3 words[c] is pod
__kubectl_handle_noun: c is 3 words[c] is pod
__kubectl_handle_reply
__kubectl_parse_get: get completion by kubectl get --namespace=argo -o template --template="{{ range .items  }}{{ .metadata.name }} {{ end }}" "pod"
__kubectl_handle_word: c is 0 words[c] is kubectl
__kubectl_handle_command: c is 0 words[c] is kubectl
__kubectl_handle_command: looking for _kubectl_root_command
__kubectl_handle_word: c is 1 words[c] is get
__kubectl_handle_command: c is 1 words[c] is get
__kubectl_handle_command: looking for _kubectl_get
__kubectl_handle_word: c is 2 words[c] is --namespace
__kubectl_handle_flag: c is 2 words[c] is --namespace
__kubectl_handle_flag: looking for --namespace
__kubectl_handle_word: c is 3 words[c] is argo
__kubectl_handle_noun: c is 3 words[c] is argo
__kubectl_handle_word: c is 4 words[c] is pod
__kubectl_handle_noun: c is 4 words[c] is pod
__kubectl_handle_reply
__kubectl_parse_get: get completion by kubectl get --namespace=argo -o template --template="{{ range .items  }}{{ .metadata.name }} {{ end }}" "pod"
__kubectl_handle_word: c is 0 words[c] is kubectl
__kubectl_handle_command: c is 0 words[c] is kubectl
__kubectl_handle_command: looking for _kubectl_root_command
__kubectl_handle_word: c is 1 words[c] is get
__kubectl_handle_command: c is 1 words[c] is get
__kubectl_handle_command: looking for _kubectl_get
__kubectl_handle_word: c is 2 words[c] is --namespace
__kubectl_handle_flag: c is 2 words[c] is --namespace
__kubectl_handle_flag: looking for --namespace
__kubectl_handle_word: c is 3 words[c] is argo
__kubectl_handle_noun: c is 3 words[c] is argo
__kubectl_handle_word: c is 4 words[c] is pod
__kubectl_handle_noun: c is 4 words[c] is pod
__kubectl_handle_reply
__kubectl_parse_get: get completion by kubectl get --namespace=argo -o template --template="{{ range .items  }}{{ .metadata.name }} {{ end }}" "pod"

For the failed case of kubectl get pod --namespace argo, it executes get completion by kubectl get --namespace=argo -o template --template="{{ range .items }}{{ .metadata.name }} {{ end }}" "argo" to get the completions but the command has wrong resource name of argo which we expect pod.

I found the completion script has the following related lines.

...
    # skip the argument to a two word flag
    if __kubectl_contains_word "${words[c]}" "${two_word_flags[@]}"; then
        c=$((c+1))
        # if we are looking for a flags value, don't show commands
        if [[ $c -eq $cword ]]; then
            commands=()
        fi
    fi
...

This code skips next argument of two-word flags but it seems only -n is recognized as a two-word flag while --namespace is not.

...
    flags+=("--namespace=")
    flags_with_completion+=("--namespace")
    flags_completion+=("__kubectl_get_resource_namespace")
    two_word_flags+=("-n")
    flags_with_completion+=("-n")
    flags_completion+=("__kubectl_get_resource_namespace")
...

And I dug into the upstream code and found that part of the script is generated by cobra.

So I fixed it and sent a PR to cobra.
spf13/cobra#807

We can fix this issue by using a cobra version with this fix.

I actually have sent a PR to update the Cobra version which addresses another issue but doesn't include this fix.
#71447

I will fix either of the PRs depending on when new Cobra version will be released.

dtaniwaki · 2019-01-13T07:23:00Z

/test pull-kubernetes-godeps

liggitt · 2019-05-16T14:47:37Z

golang.org/x/{sync,sys,tools,net} are currently on the go1.12 branch commits. no need to bump those.

dtaniwaki · 2019-05-16T15:11:41Z

@liggitt So do you mean I can ignore the result of ./hack/lint-dependencies.sh?

liggitt · 2019-07-09T17:35:02Z

@liggitt So do you mean I can ignore the result of ./hack/lint-dependencies.sh?

for the golang.org/x/... dependencies, yes. Opened #79944 to omit those from the output by default to avoid confusing people.

It looks like cobra tagged a release containing the fix we want, which is great. You can replace all the dependency bump commits with a single commit that just bumps cobra:

hack/pin-dependency.sh github.com/spf13/cobra v0.0.5
hack/update-vendor.sh

dtaniwaki · 2019-07-10T02:48:31Z

Thank you for the information!

It looks the fix for two-word flags is included in cobra v0.0.4 and it has been updated in #78187 already although it doesn't mention the fix.

dtaniwaki · 2019-07-10T04:34:54Z

@liggitt As the fix for two-word flags has been included in cobra v0.0.4 which has been updated in Kubernetes, I renamed the title of this PR and committed only the change of custom func name and debug mode autocompletion. Could you review it?

liggitt · 2019-07-10T15:20:29Z

/lgtm
/approve

k8s-ci-robot · 2019-07-10T15:21:25Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dtaniwaki, liggitt

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~pkg/kubectl/OWNERS~~ [liggitt]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

tatsuhiro-t · 2019-07-31T08:40:54Z

It looks like this PR breaks kubectl completion if override flags (e.g., --kubeconfig) are supplied.
With kubectl v1.16.0-alpha.2, kubectl --kubeconfig=foo -n then hit TAB will show "specify resource type" error.

k8s-ci-robot requested review from adohe-zz and rootfs October 31, 2018 07:35

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 31, 2018

k8s-ci-robot removed the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Oct 31, 2018

k8s-ci-robot assigned deads2k Nov 17, 2018

dixudx suggested changes Jan 6, 2019

View reviewed changes

dtaniwaki force-pushed the fix-auto-completion branch from 2bc41bd to 8bcd82b Compare January 12, 2019 16:10

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jan 12, 2019

dtaniwaki changed the title ~~Fix single dash flags handling~~ Fix two-word flags handling Jan 12, 2019

dtaniwaki force-pushed the fix-auto-completion branch 2 times, most recently from ceab413 to e360424 Compare January 12, 2019 17:10

dtaniwaki force-pushed the fix-auto-completion branch from e360424 to 5e8eec7 Compare March 11, 2019 17:37

k8s-ci-robot removed the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Mar 11, 2019

dtaniwaki force-pushed the fix-auto-completion branch from 90ac109 to 8c8e31f Compare May 16, 2019 13:41

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 16, 2019

dtaniwaki force-pushed the fix-auto-completion branch from 8c8e31f to 97d08a7 Compare May 16, 2019 13:43

dtaniwaki changed the title ~~Fix two-word flags handling~~ Avoid conflicts with other cobra auto completions Jul 10, 2019

dtaniwaki force-pushed the fix-auto-completion branch from 97d08a7 to 93d3a52 Compare July 10, 2019 04:31

Avoid conflicts with other cobra auto completion

4200d6c

k8s-ci-robot added sig/apps Categorizes an issue or PR as relevant to SIG Apps. sig/storage Categorizes an issue or PR as relevant to SIG Storage. labels Jul 10, 2019

dtaniwaki force-pushed the fix-auto-completion branch from 93d3a52 to 4200d6c Compare July 10, 2019 04:32

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 10, 2019

k8s-ci-robot assigned liggitt Jul 10, 2019

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 10, 2019

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 10, 2019

k8s-ci-robot merged commit 978c38d into kubernetes:master Jul 10, 2019

dtaniwaki deleted the fix-auto-completion branch July 28, 2019 00:52

tatsuhiro-t mentioned this pull request Jul 31, 2019

Broken kubectl completion with override flags #80797

Closed

dtaniwaki mentioned this pull request Jul 31, 2019

Fix unexpected line end in override flags #80802

Merged

liggitt added this to the v1.16 milestone Aug 6, 2019

ahlinc mentioned this pull request Aug 19, 2019

Use named custom func hetznercloud/cli#202

Closed

dtaniwaki mentioned this pull request Sep 11, 2019

REQUEST: New membership for dtaniwaki kubernetes/org#1178

Closed

6 tasks

liggitt removed the sig/auth Categorizes an issue or PR as relevant to SIG Auth. label Feb 18, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Avoid conflicts with other cobra auto completions #70470

Avoid conflicts with other cobra auto completions #70470

dtaniwaki commented Oct 31, 2018 •

edited

idealhack commented Oct 31, 2018

idealhack commented Oct 31, 2018

dtaniwaki commented Oct 31, 2018 •

edited

dtaniwaki commented Nov 17, 2018

dtaniwaki commented Jan 5, 2019

idealhack commented Jan 5, 2019

dixudx Jan 6, 2019

liggitt Jan 6, 2019

dtaniwaki Jan 12, 2019 •

edited

dtaniwaki commented Jan 12, 2019 •

edited

dtaniwaki commented Jan 13, 2019

liggitt commented May 16, 2019

dtaniwaki commented May 16, 2019 •

edited

liggitt commented Jul 9, 2019

dtaniwaki commented Jul 10, 2019 •

edited

dtaniwaki commented Jul 10, 2019

liggitt commented Jul 10, 2019

k8s-ci-robot commented Jul 10, 2019

tatsuhiro-t commented Jul 31, 2019

Avoid conflicts with other cobra auto completions #70470

Avoid conflicts with other cobra auto completions #70470

Conversation

dtaniwaki commented Oct 31, 2018 • edited

idealhack commented Oct 31, 2018

idealhack commented Oct 31, 2018

dtaniwaki commented Oct 31, 2018 • edited

dtaniwaki commented Nov 17, 2018

dtaniwaki commented Jan 5, 2019

idealhack commented Jan 5, 2019

dixudx Jan 6, 2019

Choose a reason for hiding this comment

liggitt Jan 6, 2019

Choose a reason for hiding this comment

dtaniwaki Jan 12, 2019 • edited

Choose a reason for hiding this comment

dtaniwaki commented Jan 12, 2019 • edited

dtaniwaki commented Jan 13, 2019

liggitt commented May 16, 2019

dtaniwaki commented May 16, 2019 • edited

liggitt commented Jul 9, 2019

dtaniwaki commented Jul 10, 2019 • edited

dtaniwaki commented Jul 10, 2019

liggitt commented Jul 10, 2019

k8s-ci-robot commented Jul 10, 2019

tatsuhiro-t commented Jul 31, 2019

dtaniwaki commented Oct 31, 2018 •

edited

dtaniwaki commented Oct 31, 2018 •

edited

dtaniwaki Jan 12, 2019 •

edited

dtaniwaki commented Jan 12, 2019 •

edited

dtaniwaki commented May 16, 2019 •

edited

dtaniwaki commented Jul 10, 2019 •

edited