fix kubectl -o #64371

CaoShuFeng · 2018-05-27T11:00:46Z

Fix kubectl -o error message:
Before this change:

kubectl get pods -o foo
error: unable to match a printer suitable for the output format "" and the options specified: &get.PrintFlags{JSONYamlPrintFlags:(*genericclioptions.JSONYamlPrintFlags)(0x23aa610), NamePrintFlags:(*genericclioptions.NamePrintFlags)(0xc42058b4e0), TemplateFlags:(*printers.KubeTemplatePrintFlags)(0xc4206765e0), CustomColumnsFlags:(*printers.CustomColumnsPrintFlags)(0xc420676620), HumanReadableFlags:(*get.HumanPrintFlags)(0xc4204eb180), NoHeaders:(*bool)(0xc4206fefbc), OutputFormat:(*string)(0xc42058b4d0)}

After this change:

Kubectl get pods -o foo
error: unable to match a printer suitable for the output format "foo", allowed formats are: json,yaml,name,template,go-template,go-template-file,templatefile,jsonpath,jsonpath-file,custom-columns-file,custom-columns,wide

What this PR does / why we need it:

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

Special notes for your reviewer:

Release note:

kubectl will list all allowed print formats when an invalid format is passed.

CaoShuFeng · 2018-05-28T01:36:40Z

/test pull-kubernetes-e2e-kops-aws
/test pull-kubernetes-kubemark-e2e-gce-big
/test pull-kubernetes-e2e-gce

adohe-zz · 2018-05-28T06:15:40Z

/assign @adohe

CaoShuFeng · 2018-05-28T06:18:40Z

/test pull-kubernetes-e2e-kops-aws
/test pull-kubernetes-e2e-gce

CaoShuFeng · 2018-05-29T08:28:36Z

/test pull-kubernetes-e2e-gce-device-plugin-gpu

CaoShuFeng · 2018-06-01T08:57:37Z

/assign @soltysh
Please take a look

soltysh

If you manage to update that by the end of today ping me on slack and I'll push that forward.

soltysh · 2018-06-05T08:26:04Z

pkg/kubectl/genericclioptions/name_flags.go

@@ -40,6 +40,10 @@ func (f *NamePrintFlags) Complete(successTemplate string) error {
 	return nil
 }

+func (f *NamePrintFlags) AllowedFormats() []string {
+	return []string{"name", `""`}


I'd rather we don't say empty is allowed format.

soltysh · 2018-06-05T08:31:55Z

pkg/printers/template_flags.go

@@ -36,6 +36,10 @@ type GoTemplatePrintFlags struct {
 	TemplateArgument *string
 }

+func (f *GoTemplatePrintFlags) AllowedFormats() []string {
+	return []string{"template", "go-template", "go-template-file", "templatefile"}


We already have a map of supported formats, see ToPrinter method. We should have a single source of truth with these.

Also modified in:
jsonpath_flags.go
customcolumn_flags.go

Fix kubectl -o error message: Before this change: ```shell kubectl get pods -o foo error: unable to match a printer suitable for the output format "" and the options specified: &get.PrintFlags{JSONYamlPrintFlags:(*genericclioptions.JSONYamlPrintFlags)(0x23aa610), NamePrintFlags:(*genericclioptions.NamePrintFlags)(0xc42058b4e0), TemplateFlags:(*printers.KubeTemplatePrintFlags)(0xc4206765e0), CustomColumnsFlags:(*printers.CustomColumnsPrintFlags)(0xc420676620), HumanReadableFlags:(*get.HumanPrintFlags)(0xc4204eb180), NoHeaders:(*bool)(0xc4206fefbc), OutputFormat:(*string)(0xc42058b4d0)} ``` After this change: ```shell Kubectl get pods -o foo error: unable to match a printer suitable for the output format "aaa", allowed formats are: custom-columns,custom-columns-file,go-template,go-template-file,json,jsonpath,jsonpath-file,name,template,templatefile,wide,yaml ```

CaoShuFeng · 2018-06-05T11:54:38Z

pkg/kubectl/genericclioptions/print_flags.go

@@ -35,7 +38,8 @@ func (e NoCompatiblePrinterError) Error() string {
 		output = *e.OutputFormat
 	}

-	return fmt.Sprintf("unable to match a printer suitable for the output format %q and the options specified: %#v", output, e.Options)
+	sort.Strings(e.AllowedFormats)


@soltysh
Since I use range map[key]bool to iterate the map.
The order of output would be uncertain. So I add a sort here.

I don't think I care about this, but ok.

soltysh

/lgtm
/approve

soltysh · 2018-06-05T19:55:10Z

pkg/kubectl/genericclioptions/print_flags.go

@@ -35,7 +38,8 @@ func (e NoCompatiblePrinterError) Error() string {
 		output = *e.OutputFormat
 	}

-	return fmt.Sprintf("unable to match a printer suitable for the output format %q and the options specified: %#v", output, e.Options)
+	sort.Strings(e.AllowedFormats)


I don't think I care about this, but ok.

k8s-ci-robot · 2018-06-05T19:56:30Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: CaoShuFeng, soltysh

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~~ [soltysh]
~~pkg/printers/OWNERS~~ [soltysh]

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

soltysh · 2018-06-06T08:37:56Z

This was tagged before the code freeze, I'm changing the labels to get this in, still.

k8s-github-robot · 2018-06-06T08:40:34Z

[MILESTONENOTIFIER] Milestone Pull Request: Up-to-date for process

@CaoShuFeng @adohe @soltysh

Pull Request Labels

sig/cli: Pull Request will be escalated to these SIGs if needed.
priority/critical-urgent: Never automatically move pull request out of a release milestone; continually escalate to contributor and SIG through all available channels.
kind/bug: Fixes a bug discovered during the current release.

Help

CaoShuFeng · 2018-06-06T10:45:43Z

/test pull-kubernetes-node-e2e

k8s-github-robot · 2018-06-06T11:15:56Z

Automatic merge from submit-queue. If you want to cherry-pick this change to another branch, please follow the instructions here.

k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 27, 2018

k8s-ci-robot requested review from adohe-zz and eparis May 27, 2018 11:01

CaoShuFeng force-pushed the invalid_o branch from 6f6e90d to 652c71d Compare May 27, 2018 11:02

k8s-ci-robot assigned adohe-zz May 28, 2018

k8s-ci-robot assigned soltysh Jun 1, 2018

soltysh requested changes Jun 5, 2018

View reviewed changes

CaoShuFeng force-pushed the invalid_o branch from 652c71d to 8b8106e Compare June 5, 2018 09:09

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 5, 2018

CaoShuFeng force-pushed the invalid_o branch from 8b8106e to 995c5a0 Compare June 5, 2018 11:48

CaoShuFeng commented Jun 5, 2018

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 5, 2018

soltysh approved these changes Jun 5, 2018

View reviewed changes

soltysh added this to the v1.11 milestone Jun 5, 2018

k8s-github-robot added the milestone/incomplete-labels label Jun 5, 2018

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 5, 2018

soltysh added the priority/critical-urgent Highest priority. Must be actively worked on as someone's top priority right now. label Jun 6, 2018

k8s-github-robot added the milestone/incomplete-labels label Jun 6, 2018

soltysh removed the priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. label Jun 6, 2018

k8s-github-robot removed the milestone/incomplete-labels label Jun 6, 2018

k8s-github-robot merged commit bf422b7 into kubernetes:master Jun 6, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix kubectl -o #64371

fix kubectl -o #64371

CaoShuFeng commented May 27, 2018 •

edited

CaoShuFeng commented May 28, 2018

adohe-zz commented May 28, 2018

CaoShuFeng commented May 28, 2018

CaoShuFeng commented May 29, 2018

CaoShuFeng commented Jun 1, 2018

soltysh left a comment

soltysh Jun 5, 2018

CaoShuFeng Jun 5, 2018

soltysh Jun 5, 2018

CaoShuFeng Jun 5, 2018

CaoShuFeng Jun 5, 2018

CaoShuFeng Jun 5, 2018

soltysh Jun 5, 2018

soltysh left a comment

soltysh Jun 5, 2018

k8s-ci-robot commented Jun 5, 2018

soltysh commented Jun 6, 2018

k8s-github-robot commented Jun 6, 2018

CaoShuFeng commented Jun 6, 2018

k8s-github-robot commented Jun 6, 2018

fix kubectl -o #64371

fix kubectl -o #64371

Conversation

CaoShuFeng commented May 27, 2018 • edited

CaoShuFeng commented May 28, 2018

adohe-zz commented May 28, 2018

CaoShuFeng commented May 28, 2018

CaoShuFeng commented May 29, 2018

CaoShuFeng commented Jun 1, 2018

soltysh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

soltysh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jun 5, 2018

soltysh commented Jun 6, 2018

k8s-github-robot commented Jun 6, 2018

CaoShuFeng commented Jun 6, 2018

k8s-github-robot commented Jun 6, 2018

CaoShuFeng commented May 27, 2018 •

edited