995c5a07ea
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
```
79 lines
2.8 KiB
Go
79 lines
2.8 KiB
Go
/*
|
|
Copyright 2018 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 printers
|
|
|
|
import (
|
|
"github.com/spf13/cobra"
|
|
|
|
"k8s.io/kubernetes/pkg/kubectl/genericclioptions"
|
|
)
|
|
|
|
// KubeTemplatePrintFlags composes print flags that provide both a JSONPath and a go-template printer.
|
|
// This is necessary if dealing with cases that require support both both printers, since both sets of flags
|
|
// require overlapping flags.
|
|
type KubeTemplatePrintFlags struct {
|
|
*GoTemplatePrintFlags
|
|
*JSONPathPrintFlags
|
|
|
|
AllowMissingKeys *bool
|
|
TemplateArgument *string
|
|
}
|
|
|
|
func (f *KubeTemplatePrintFlags) AllowedFormats() []string {
|
|
return append(f.GoTemplatePrintFlags.AllowedFormats(), f.JSONPathPrintFlags.AllowedFormats()...)
|
|
}
|
|
|
|
func (f *KubeTemplatePrintFlags) ToPrinter(outputFormat string) (ResourcePrinter, error) {
|
|
if p, err := f.JSONPathPrintFlags.ToPrinter(outputFormat); !genericclioptions.IsNoCompatiblePrinterError(err) {
|
|
return p, err
|
|
}
|
|
return f.GoTemplatePrintFlags.ToPrinter(outputFormat)
|
|
}
|
|
|
|
// AddFlags receives a *cobra.Command reference and binds
|
|
// flags related to template printing to it
|
|
func (f *KubeTemplatePrintFlags) AddFlags(c *cobra.Command) {
|
|
if f.TemplateArgument != nil {
|
|
c.Flags().StringVar(f.TemplateArgument, "template", *f.TemplateArgument, "Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].")
|
|
c.MarkFlagFilename("template")
|
|
}
|
|
if f.AllowMissingKeys != nil {
|
|
c.Flags().BoolVar(f.AllowMissingKeys, "allow-missing-template-keys", *f.AllowMissingKeys, "If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.")
|
|
}
|
|
}
|
|
|
|
// NewKubeTemplatePrintFlags returns flags associated with
|
|
// --template printing, with default values set.
|
|
func NewKubeTemplatePrintFlags() *KubeTemplatePrintFlags {
|
|
allowMissingKeysPtr := true
|
|
templateArgPtr := ""
|
|
|
|
return &KubeTemplatePrintFlags{
|
|
GoTemplatePrintFlags: &GoTemplatePrintFlags{
|
|
TemplateArgument: &templateArgPtr,
|
|
AllowMissingKeys: &allowMissingKeysPtr,
|
|
},
|
|
JSONPathPrintFlags: &JSONPathPrintFlags{
|
|
TemplateArgument: &templateArgPtr,
|
|
AllowMissingKeys: &allowMissingKeysPtr,
|
|
},
|
|
|
|
TemplateArgument: &templateArgPtr,
|
|
AllowMissingKeys: &allowMissingKeysPtr,
|
|
}
|
|
}
|