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.

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

Rename NewHumanReadablePrinter to NewTablePrinter #77221

Merged
merged 1 commit into from
Apr 30, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion pkg/kubectl/cmd/get/humanreadable_flags.go
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ func (f *HumanPrintFlags) ToPrinter(outputFormat string) (printers.ResourcePrint
columnLabels = *f.ColumnLabels
}

p := printers.NewHumanReadablePrinter(printers.PrintOptions{
p := printers.NewTablePrinter(printers.PrintOptions{
Kind: f.Kind,
WithKind: showKind,
NoHeaders: f.NoHeaders,
Expand Down
36 changes: 18 additions & 18 deletions pkg/printers/internalversion/printers_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ func TestPrintUnstructuredObject(t *testing.T) {

for _, test := range tests {
out.Reset()
printer := printers.NewHumanReadablePrinter(test.options).With(AddDefaultHandlers)
printer := printers.NewTablePrinter(test.options).With(AddDefaultHandlers)
printer.PrintObj(test.object, out)

matches, err := regexp.MatchString(test.expected, out.String())
Expand Down Expand Up @@ -299,7 +299,7 @@ func ErrorPrintHandler(obj *TestPrintType, options printers.PrintOptions) ([]met

func TestCustomTypePrinting(t *testing.T) {
columns := []metav1beta1.TableColumnDefinition{{Name: "Data"}}
printer := printers.NewHumanReadablePrinter(printers.PrintOptions{})
printer := printers.NewTablePrinter(printers.PrintOptions{})
printer.TableHandler(columns, PrintCustomType)

obj := TestPrintType{"test object"}
Expand All @@ -316,7 +316,7 @@ func TestCustomTypePrinting(t *testing.T) {

func TestPrintHandlerError(t *testing.T) {
columns := []metav1beta1.TableColumnDefinition{{Name: "Data"}}
printer := printers.NewHumanReadablePrinter(printers.PrintOptions{})
printer := printers.NewTablePrinter(printers.PrintOptions{})
printer.TableHandler(columns, ErrorPrintHandler)
obj := TestPrintType{"test object"}
buffer := &bytes.Buffer{}
Expand All @@ -327,7 +327,7 @@ func TestPrintHandlerError(t *testing.T) {
}

func TestUnknownTypePrinting(t *testing.T) {
printer := printers.NewHumanReadablePrinter(printers.PrintOptions{})
printer := printers.NewTablePrinter(printers.PrintOptions{})
buffer := &bytes.Buffer{}
err := printer.PrintObj(&TestUnknownType{}, buffer)
if err == nil {
Expand Down Expand Up @@ -588,10 +588,10 @@ func TestPrinters(t *testing.T) {

// a humanreadable printer deals with internal-versioned objects
humanReadablePrinter := map[string]printers.ResourcePrinter{
"humanReadable": printers.NewHumanReadablePrinter(printers.PrintOptions{
"humanReadable": printers.NewTablePrinter(printers.PrintOptions{
NoHeaders: true,
}),
"humanReadableHeaders": printers.NewHumanReadablePrinter(printers.PrintOptions{}),
"humanReadableHeaders": printers.NewTablePrinter(printers.PrintOptions{}),
}
AddHandlers((humanReadablePrinter["humanReadable"]).(*printers.HumanReadablePrinter))
AddHandlers((humanReadablePrinter["humanReadableHeaders"]).(*printers.HumanReadablePrinter))
Expand All @@ -611,7 +611,7 @@ func TestPrinters(t *testing.T) {

func TestPrintEventsResultSorted(t *testing.T) {
// Arrange
printer := printers.NewHumanReadablePrinter(printers.PrintOptions{})
printer := printers.NewTablePrinter(printers.PrintOptions{})
AddHandlers(printer)

obj := api.EventList{
Expand Down Expand Up @@ -656,7 +656,7 @@ func TestPrintEventsResultSorted(t *testing.T) {
}

func TestPrintNodeStatus(t *testing.T) {
printer := printers.NewHumanReadablePrinter(printers.PrintOptions{})
printer := printers.NewTablePrinter(printers.PrintOptions{})
AddHandlers(printer)
table := []struct {
node api.Node
Expand Down Expand Up @@ -746,7 +746,7 @@ func TestPrintNodeStatus(t *testing.T) {
}

func TestPrintNodeRole(t *testing.T) {
printer := printers.NewHumanReadablePrinter(printers.PrintOptions{})
printer := printers.NewTablePrinter(printers.PrintOptions{})
AddHandlers(printer)
table := []struct {
node api.Node
Expand Down Expand Up @@ -791,7 +791,7 @@ func TestPrintNodeRole(t *testing.T) {
}

func TestPrintNodeOSImage(t *testing.T) {
printer := printers.NewHumanReadablePrinter(printers.PrintOptions{
printer := printers.NewTablePrinter(printers.PrintOptions{
ColumnLabels: []string{},
Wide: true,
})
Expand Down Expand Up @@ -836,7 +836,7 @@ func TestPrintNodeOSImage(t *testing.T) {
}

func TestPrintNodeKernelVersion(t *testing.T) {
printer := printers.NewHumanReadablePrinter(printers.PrintOptions{
printer := printers.NewTablePrinter(printers.PrintOptions{
ColumnLabels: []string{},
Wide: true,
})
Expand Down Expand Up @@ -881,7 +881,7 @@ func TestPrintNodeKernelVersion(t *testing.T) {
}

func TestPrintNodeContainerRuntimeVersion(t *testing.T) {
printer := printers.NewHumanReadablePrinter(printers.PrintOptions{
printer := printers.NewTablePrinter(printers.PrintOptions{
ColumnLabels: []string{},
Wide: true,
})
Expand Down Expand Up @@ -926,7 +926,7 @@ func TestPrintNodeContainerRuntimeVersion(t *testing.T) {
}

func TestPrintNodeName(t *testing.T) {
printer := printers.NewHumanReadablePrinter(printers.PrintOptions{
printer := printers.NewTablePrinter(printers.PrintOptions{
Wide: true,
})
AddHandlers(printer)
Expand Down Expand Up @@ -963,7 +963,7 @@ func TestPrintNodeName(t *testing.T) {
}

func TestPrintNodeExternalIP(t *testing.T) {
printer := printers.NewHumanReadablePrinter(printers.PrintOptions{
printer := printers.NewTablePrinter(printers.PrintOptions{
Wide: true,
})
AddHandlers(printer)
Expand Down Expand Up @@ -1011,7 +1011,7 @@ func TestPrintNodeExternalIP(t *testing.T) {
}

func TestPrintNodeInternalIP(t *testing.T) {
printer := printers.NewHumanReadablePrinter(printers.PrintOptions{
printer := printers.NewTablePrinter(printers.PrintOptions{
Wide: true,
})
AddHandlers(printer)
Expand Down Expand Up @@ -1419,7 +1419,7 @@ func TestPrintHumanReadableWithNamespace(t *testing.T) {
for i, test := range table {
if test.isNamespaced {
// Expect output to include namespace when requested.
printer := printers.NewHumanReadablePrinter(printers.PrintOptions{
printer := printers.NewTablePrinter(printers.PrintOptions{
WithNamespace: true,
})
AddHandlers(printer)
Expand All @@ -1434,7 +1434,7 @@ func TestPrintHumanReadableWithNamespace(t *testing.T) {
}
} else {
// Expect error when trying to get all namespaces for un-namespaced object.
printer := printers.NewHumanReadablePrinter(printers.PrintOptions{
printer := printers.NewTablePrinter(printers.PrintOptions{
WithNamespace: true,
})
buffer := &bytes.Buffer{}
Expand Down Expand Up @@ -1513,7 +1513,7 @@ func TestPrintPodTable(t *testing.T) {
}
verifyTable(t, table)
buf := &bytes.Buffer{}
p := printers.NewHumanReadablePrinter(test.opts).With(AddHandlers)
p := printers.NewTablePrinter(test.opts).With(AddHandlers)
if err := p.PrintObj(table, buf); err != nil {
t.Fatal(err)
}
Expand Down
4 changes: 2 additions & 2 deletions pkg/printers/tableprinter.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ var _ ResourcePrinter = &HumanReadablePrinter{}

var withNamespacePrefixColumns = []string{"NAMESPACE"} // TODO(erictune): print cluster name too.

// NewHumanReadablePrinter creates a printer suitable for calling PrintObj().
// NewTablePrinter creates a printer suitable for calling PrintObj().
// TODO(seans3): Change return type to ResourcePrinter interface once we no longer need
// to constuct the "handlerMap".
func NewHumanReadablePrinter(options PrintOptions) *HumanReadablePrinter {
func NewTablePrinter(options PrintOptions) *HumanReadablePrinter {
printer := &HumanReadablePrinter{
handlerMap: make(map[reflect.Type]*handlerEntry),
options: options,
Expand Down