mirror of
https://github.com/ceph/ceph-csi.git
synced 2024-11-24 07:10:20 +00:00
82 lines
2.3 KiB
Go
82 lines
2.3 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 genericclioptions
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"k8s.io/cli-runtime/pkg/printers"
|
|
)
|
|
|
|
// NamePrintFlags provides default flags necessary for printing
|
|
// a resource's fully-qualified Kind.group/name, or a successful
|
|
// message about that resource if an Operation is provided.
|
|
type NamePrintFlags struct {
|
|
// Operation describes the name of the action that
|
|
// took place on an object, to be included in the
|
|
// finalized "successful" message.
|
|
Operation string
|
|
}
|
|
|
|
func (f *NamePrintFlags) Complete(successTemplate string) error {
|
|
f.Operation = fmt.Sprintf(successTemplate, f.Operation)
|
|
return nil
|
|
}
|
|
|
|
func (f *NamePrintFlags) AllowedFormats() []string {
|
|
if f == nil {
|
|
return []string{}
|
|
}
|
|
return []string{"name"}
|
|
}
|
|
|
|
// ToPrinter receives an outputFormat and returns a printer capable of
|
|
// handling --output=name printing.
|
|
// Returns false if the specified outputFormat does not match a supported format.
|
|
// Supported format types can be found in pkg/printers/printers.go
|
|
func (f *NamePrintFlags) ToPrinter(outputFormat string) (printers.ResourcePrinter, error) {
|
|
namePrinter := &printers.NamePrinter{
|
|
Operation: f.Operation,
|
|
}
|
|
|
|
outputFormat = strings.ToLower(outputFormat)
|
|
switch outputFormat {
|
|
case "name":
|
|
namePrinter.ShortOutput = true
|
|
fallthrough
|
|
case "":
|
|
return namePrinter, nil
|
|
default:
|
|
return nil, NoCompatiblePrinterError{OutputFormat: &outputFormat, AllowedFormats: f.AllowedFormats()}
|
|
}
|
|
}
|
|
|
|
// AddFlags receives a *cobra.Command reference and binds
|
|
// flags related to name printing to it
|
|
func (f *NamePrintFlags) AddFlags(c *cobra.Command) {}
|
|
|
|
// NewNamePrintFlags returns flags associated with
|
|
// --name printing, with default values set.
|
|
func NewNamePrintFlags(operation string) *NamePrintFlags {
|
|
return &NamePrintFlags{
|
|
Operation: operation,
|
|
}
|
|
}
|