Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix missing pod name for kubectl attach #77606

Merged
merged 1 commit into from
May 20, 2019
Merged

Fix missing pod name for kubectl attach #77606

merged 1 commit into from
May 20, 2019

Conversation

tnqn
Copy link
Member

@tnqn tnqn commented May 8, 2019

What type of PR is this?
/kind bug

What this PR does / why we need it:
The pod name is missing in suggested cmd usage when executing kubectl attach:

# kubectl attach deployment/testpod
Defaulting container name to master.
Use 'kubectl describe pod/ -n default' to see all of the containers in this pod.

The PodName is empty in func Complete as the attached Pod isn't populated yet, causing suggested cmd usage imcomplete.
This patch renders PodName after it is populated.

Which issue(s) this PR fixes:

Fixes #77604

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. kind/bug Categorizes issue or PR as related to a bug. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels May 8, 2019
@k8s-ci-robot
Copy link
Contributor

Hi @tnqn. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. area/kubectl sig/cli Categorizes an issue or PR as relevant to SIG CLI. and removed needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels May 8, 2019
@k8s-ci-robot k8s-ci-robot requested review from dixudx and rootfs May 8, 2019 16:10
@tnqn
Copy link
Member Author

tnqn commented May 8, 2019

/assign @dims

@gnufied
Copy link
Member

gnufied commented May 8, 2019

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 8, 2019
@yue9944882
Copy link
Member

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 9, 2019
dixudx
dixudx approved these changes May 9, 2019
View reviewed changes
Copy link
Member

@dixudx dixudx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@tnqn
Copy link
Member Author

tnqn commented May 10, 2019

/assign @soltysh

@tnqn
Copy link
Member Author

tnqn commented May 17, 2019

/assign @liggitt

liggitt
liggitt reviewed May 17, 2019
View reviewed changes
Copy link
Member

@liggitt liggitt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one comment on placing unknown content into a format string.

also, the same issue exists for exec, can we fix both commands in this PR?

pkg/kubectl/cmd/attach/attach.go Outdated
@@ -189,7 +189,7 @@ func (o *AttachOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []s
fullCmdName = cmdParent.CommandPath()
}
if len(fullCmdName) > 0 && cmdutil.IsSiblingCommandExists(cmd, "describe") {
o.SuggestedCmdUsage = fmt.Sprintf("Use '%s describe pod/%s -n %s' to see all of the containers in this pod.", fullCmdName, o.PodName, o.Namespace)
o.SuggestedCmdUsage = fmt.Sprintf("Use '%s describe pod/%%s -n %s' to see all of the containers in this pod.", fullCmdName, o.Namespace)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

using SuggestedCmdUsage as a format string means that if fullCmdName or o.Namespace contain % characters, the output will be malformed

Copy link
Member Author

@tnqn tnqn May 17, 2019 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for pointing this out. I checked Namespace is only allowed to be [a-z0-9]([-a-z0-9]*[a-z0-9])?, but can't be sure that fullCmdName won't contain %, it should be kubectl for most cases though.
To avoid potential problem, I move the suggested usage formatting to where it could be done completely. The issue in exec is also addressed.
PTAL. Thanks!

@tnqn
Fix missing pod name for kubectl attach and exec
efcca8f 
The pod name is missing in suggested cmd usage when executing kubectl attach
and exec:
"Defaulting container name to master.
 Use 'kubectl describe pod/ -n default' to see all of the containers in this pod."

The PodName is empty in func Complete as the attached Pod isn't populated yet,
causing suggested cmd usage imcomplete. This patch renders PodName after it is
populated.
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels May 17, 2019
@tnqn
Copy link
Member Author

tnqn commented May 18, 2019

/retest

@liggitt
Copy link
Member

liggitt commented May 20, 2019

thanks

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 20, 2019
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: liggitt, tnqn, yue9944882

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:

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 20, 2019
@k8s-ci-robot k8s-ci-robot merged commit 1ae2a5d into kubernetes:master May 20, 2019
@prksu prksu mentioned this pull request May 20, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@liggitt liggitt liggitt left review comments

@dixudx dixudx dixudx approved these changes

@rootfs rootfs Awaiting requested review from rootfs

Assignees

@dims dims

@soltysh soltysh

@liggitt liggitt

@dixudx dixudx

@yue9944882 yue9944882

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/kubectl cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/bug Categorizes issue or PR as related to a bug. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. sig/cli Categorizes an issue or PR as relevant to SIG CLI. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Pod name is missing in suggested cmd usage when executing kubectl attach
8 participants
@tnqn @k8s-ci-robot @gnufied @yue9944882 @liggitt @dixudx @dims @soltysh