Skip to content

Commit abfc5bb

Browse files
seans3seans3
committed
Rename TablePrinter interface to TableGenerator
1 parent e8fc79d commit abfc5bb

File tree

35 files changed

+62
-62
lines changed

35 files changed

+62
-62
lines changed

‎pkg/printers/humanreadable.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ import (
3434
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
3535
)
3636

37-
type TablePrinter interface {
38-
PrintTable(obj runtime.Object, options PrintOptions) (*metav1beta1.Table, error)
37+
type TableGenerator interface {
38+
GenerateTable(obj runtime.Object, options PrintOptions) (*metav1beta1.Table, error)
3939
}
4040

4141
type PrintHandler interface {
@@ -75,8 +75,8 @@ func NewHumanReadablePrinter(options PrintOptions) *HumanReadablePrinter {
7575
return printer
7676
}
7777

78-
// NewTablePrinter creates a HumanReadablePrinter suitable for calling PrintTable().
79-
func NewTablePrinter() *HumanReadablePrinter {
78+
// NewTableGenerator creates a HumanReadablePrinter suitable for calling GenerateTable().
79+
func NewTableGenerator() *HumanReadablePrinter {
8080
return &HumanReadablePrinter{
8181
handlerMap: make(map[reflect.Type]*handlerEntry),
8282
}
@@ -445,10 +445,10 @@ func DecorateTable(table *metav1beta1.Table, options PrintOptions) error {
445445
return nil
446446
}
447447

448-
// PrintTable returns a table for the provided object, using the printer registered for that type. It returns
448+
// GenerateTable returns a table for the provided object, using the printer registered for that type. It returns
449449
// a table that includes all of the information requested by options, but will not remove rows or columns. The
450450
// caller is responsible for applying rules related to filtering rows or columns.
451-
func (h *HumanReadablePrinter) PrintTable(obj runtime.Object, options PrintOptions) (*metav1beta1.Table, error) {
451+
func (h *HumanReadablePrinter) GenerateTable(obj runtime.Object, options PrintOptions) (*metav1beta1.Table, error) {
452452
t := reflect.TypeOf(obj)
453453
handler, ok := h.handlerMap[t]
454454
if !ok {

‎pkg/printers/internalversion/printers_test.go‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1094,7 +1094,7 @@ func TestPrintHunmanReadableIngressWithColumnLabels(t *testing.T) {
10941094
},
10951095
}
10961096
buff := bytes.NewBuffer([]byte{})
1097-
table, err := printers.NewTablePrinter().With(AddHandlers).PrintTable(&ingress, printers.PrintOptions{ColumnLabels: []string{"app_name"}})
1097+
table, err := printers.NewTableGenerator().With(AddHandlers).GenerateTable(&ingress, printers.PrintOptions{ColumnLabels: []string{"app_name"}})
10981098
if err != nil {
10991099
t.Fatal(err)
11001100
}
@@ -1228,7 +1228,7 @@ func TestPrintHumanReadableService(t *testing.T) {
12281228
for _, svc := range tests {
12291229
for _, wide := range []bool{false, true} {
12301230
buff := bytes.NewBuffer([]byte{})
1231-
table, err := printers.NewTablePrinter().With(AddHandlers).PrintTable(&svc, printers.PrintOptions{Wide: wide})
1231+
table, err := printers.NewTableGenerator().With(AddHandlers).GenerateTable(&svc, printers.PrintOptions{Wide: wide})
12321232
if err != nil {
12331233
t.Fatal(err)
12341234
}
@@ -1507,7 +1507,7 @@ func TestPrintPodTable(t *testing.T) {
15071507
}
15081508

15091509
for i, test := range tests {
1510-
table, err := printers.NewTablePrinter().With(AddHandlers).PrintTable(test.obj, printers.PrintOptions{})
1510+
table, err := printers.NewTableGenerator().With(AddHandlers).GenerateTable(test.obj, printers.PrintOptions{})
15111511
if err != nil {
15121512
t.Fatal(err)
15131513
}
@@ -1865,7 +1865,7 @@ func TestPrintNonTerminatedPod(t *testing.T) {
18651865
}
18661866

18671867
for i, test := range tests {
1868-
table, err := printers.NewTablePrinter().With(AddHandlers).PrintTable(&test.pod, printers.PrintOptions{})
1868+
table, err := printers.NewTableGenerator().With(AddHandlers).GenerateTable(&test.pod, printers.PrintOptions{})
18691869
if err != nil {
18701870
t.Fatal(err)
18711871
}
@@ -1927,7 +1927,7 @@ func TestPrintPodWithLabels(t *testing.T) {
19271927
}
19281928

19291929
for i, test := range tests {
1930-
table, err := printers.NewTablePrinter().With(AddHandlers).PrintTable(&test.pod, printers.PrintOptions{ColumnLabels: test.labelColumns})
1930+
table, err := printers.NewTableGenerator().With(AddHandlers).GenerateTable(&test.pod, printers.PrintOptions{ColumnLabels: test.labelColumns})
19311931
if err != nil {
19321932
t.Fatal(err)
19331933
}
@@ -2036,7 +2036,7 @@ func TestPrintDeployment(t *testing.T) {
20362036

20372037
buf := bytes.NewBuffer([]byte{})
20382038
for _, test := range tests {
2039-
table, err := printers.NewTablePrinter().With(AddHandlers).PrintTable(&test.deployment, printers.PrintOptions{})
2039+
table, err := printers.NewTableGenerator().With(AddHandlers).GenerateTable(&test.deployment, printers.PrintOptions{})
20402040
if err != nil {
20412041
t.Fatal(err)
20422042
}
@@ -2048,7 +2048,7 @@ func TestPrintDeployment(t *testing.T) {
20482048
t.Fatalf("Expected: %s, got: %s", test.expect, buf.String())
20492049
}
20502050
buf.Reset()
2051-
table, err = printers.NewTablePrinter().With(AddHandlers).PrintTable(&test.deployment, printers.PrintOptions{Wide: true})
2051+
table, err = printers.NewTableGenerator().With(AddHandlers).GenerateTable(&test.deployment, printers.PrintOptions{Wide: true})
20522052
verifyTable(t, table)
20532053
// print deployment with '-o wide' option
20542054
if err := printers.PrintTable(table, buf, printers.PrintOptions{Wide: true, NoHeaders: true}); err != nil {
@@ -2091,7 +2091,7 @@ func TestPrintDaemonSet(t *testing.T) {
20912091

20922092
buf := bytes.NewBuffer([]byte{})
20932093
for _, test := range tests {
2094-
table, err := printers.NewTablePrinter().With(AddHandlers).PrintTable(&test.ds, printers.PrintOptions{})
2094+
table, err := printers.NewTableGenerator().With(AddHandlers).GenerateTable(&test.ds, printers.PrintOptions{})
20952095
if err != nil {
20962096
t.Fatal(err)
20972097
}
@@ -2180,7 +2180,7 @@ func TestPrintJob(t *testing.T) {
21802180

21812181
buf := bytes.NewBuffer([]byte{})
21822182
for _, test := range tests {
2183-
table, err := printers.NewTablePrinter().With(AddHandlers).PrintTable(&test.job, printers.PrintOptions{})
2183+
table, err := printers.NewTableGenerator().With(AddHandlers).GenerateTable(&test.job, printers.PrintOptions{})
21842184
if err != nil {
21852185
t.Fatal(err)
21862186
}
@@ -2787,7 +2787,7 @@ func TestPrintHPA(t *testing.T) {
27872787

27882788
buff := bytes.NewBuffer([]byte{})
27892789
for _, test := range tests {
2790-
table, err := printers.NewTablePrinter().With(AddHandlers).PrintTable(&test.hpa, printers.PrintOptions{})
2790+
table, err := printers.NewTableGenerator().With(AddHandlers).GenerateTable(&test.hpa, printers.PrintOptions{})
27912791
if err != nil {
27922792
t.Fatal(err)
27932793
}
@@ -2850,7 +2850,7 @@ func TestPrintPodShowLabels(t *testing.T) {
28502850
}
28512851

28522852
for i, test := range tests {
2853-
table, err := printers.NewTablePrinter().With(AddHandlers).PrintTable(&test.pod, printers.PrintOptions{ShowLabels: test.showLabels})
2853+
table, err := printers.NewTableGenerator().With(AddHandlers).GenerateTable(&test.pod, printers.PrintOptions{ShowLabels: test.showLabels})
28542854
if err != nil {
28552855
t.Fatal(err)
28562856
}
@@ -3017,7 +3017,7 @@ func TestPrintService(t *testing.T) {
30173017

30183018
buf := bytes.NewBuffer([]byte{})
30193019
for _, test := range tests {
3020-
table, err := printers.NewTablePrinter().With(AddHandlers).PrintTable(&test.service, printers.PrintOptions{})
3020+
table, err := printers.NewTableGenerator().With(AddHandlers).GenerateTable(&test.service, printers.PrintOptions{})
30213021
if err != nil {
30223022
t.Fatal(err)
30233023
}
@@ -3075,7 +3075,7 @@ func TestPrintPodDisruptionBudget(t *testing.T) {
30753075

30763076
buf := bytes.NewBuffer([]byte{})
30773077
for _, test := range tests {
3078-
table, err := printers.NewTablePrinter().With(AddHandlers).PrintTable(&test.pdb, printers.PrintOptions{})
3078+
table, err := printers.NewTableGenerator().With(AddHandlers).GenerateTable(&test.pdb, printers.PrintOptions{})
30793079
if err != nil {
30803080
t.Fatal(err)
30813081
}
@@ -3156,7 +3156,7 @@ func TestPrintControllerRevision(t *testing.T) {
31563156

31573157
buf := bytes.NewBuffer([]byte{})
31583158
for _, test := range tests {
3159-
table, err := printers.NewTablePrinter().With(AddHandlers).PrintTable(&test.history, printers.PrintOptions{})
3159+
table, err := printers.NewTableGenerator().With(AddHandlers).GenerateTable(&test.history, printers.PrintOptions{})
31603160
if err != nil {
31613161
t.Fatal(err)
31623162
}
@@ -3217,7 +3217,7 @@ func TestPrintReplicaSet(t *testing.T) {
32173217

32183218
buf := bytes.NewBuffer([]byte{})
32193219
for _, test := range tests {
3220-
table, err := printers.NewTablePrinter().With(AddHandlers).PrintTable(&test.replicaSet, printers.PrintOptions{})
3220+
table, err := printers.NewTableGenerator().With(AddHandlers).GenerateTable(&test.replicaSet, printers.PrintOptions{})
32213221
if err != nil {
32223222
t.Fatal(err)
32233223
}
@@ -3230,7 +3230,7 @@ func TestPrintReplicaSet(t *testing.T) {
32303230
}
32313231
buf.Reset()
32323232

3233-
table, err = printers.NewTablePrinter().With(AddHandlers).PrintTable(&test.replicaSet, printers.PrintOptions{Wide: true})
3233+
table, err = printers.NewTableGenerator().With(AddHandlers).GenerateTable(&test.replicaSet, printers.PrintOptions{Wide: true})
32343234
if err != nil {
32353235
t.Fatal(err)
32363236
}
@@ -3329,7 +3329,7 @@ func TestPrintPersistentVolumeClaim(t *testing.T) {
33293329
}
33303330
buf := bytes.NewBuffer([]byte{})
33313331
for _, test := range tests {
3332-
table, err := printers.NewTablePrinter().With(AddHandlers).PrintTable(&test.pvc, printers.PrintOptions{})
3332+
table, err := printers.NewTableGenerator().With(AddHandlers).GenerateTable(&test.pvc, printers.PrintOptions{})
33333333
if err != nil {
33343334
t.Fatal(err)
33353335
}
@@ -3402,7 +3402,7 @@ func TestPrintCronJob(t *testing.T) {
34023402

34033403
buf := bytes.NewBuffer([]byte{})
34043404
for _, test := range tests {
3405-
table, err := printers.NewTablePrinter().With(AddHandlers).PrintTable(&test.cronjob, printers.PrintOptions{})
3405+
table, err := printers.NewTableGenerator().With(AddHandlers).GenerateTable(&test.cronjob, printers.PrintOptions{})
34063406
if err != nil {
34073407
t.Fatal(err)
34083408
}
@@ -3446,7 +3446,7 @@ func TestPrintStorageClass(t *testing.T) {
34463446

34473447
buf := bytes.NewBuffer([]byte{})
34483448
for _, test := range tests {
3449-
table, err := printers.NewTablePrinter().With(AddHandlers).PrintTable(&test.sc, printers.PrintOptions{})
3449+
table, err := printers.NewTableGenerator().With(AddHandlers).GenerateTable(&test.sc, printers.PrintOptions{})
34503450
if err != nil {
34513451
t.Fatal(err)
34523452
}
@@ -3496,7 +3496,7 @@ func TestPrintLease(t *testing.T) {
34963496

34973497
buf := bytes.NewBuffer([]byte{})
34983498
for _, test := range tests {
3499-
table, err := printers.NewTablePrinter().With(AddHandlers).PrintTable(&test.sc, printers.PrintOptions{})
3499+
table, err := printers.NewTableGenerator().With(AddHandlers).GenerateTable(&test.sc, printers.PrintOptions{})
35003500
if err != nil {
35013501
t.Fatal(err)
35023502
}
@@ -3540,7 +3540,7 @@ func TestPrintPriorityClass(t *testing.T) {
35403540

35413541
buf := bytes.NewBuffer([]byte{})
35423542
for _, test := range tests {
3543-
table, err := printers.NewTablePrinter().With(AddHandlers).PrintTable(&test.pc, printers.PrintOptions{})
3543+
table, err := printers.NewTableGenerator().With(AddHandlers).GenerateTable(&test.pc, printers.PrintOptions{})
35443544
if err != nil {
35453545
t.Fatal(err)
35463546
}
@@ -3584,7 +3584,7 @@ func TestPrintRuntimeClass(t *testing.T) {
35843584

35853585
buf := bytes.NewBuffer([]byte{})
35863586
for _, test := range tests {
3587-
table, err := printers.NewTablePrinter().With(AddHandlers).PrintTable(&test.rc, printers.PrintOptions{})
3587+
table, err := printers.NewTableGenerator().With(AddHandlers).GenerateTable(&test.rc, printers.PrintOptions{})
35883588
if err != nil {
35893589
t.Fatal(err)
35903590
}

‎pkg/printers/storage/storage.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import (
2626
)
2727

2828
type TableConvertor struct {
29-
printers.TablePrinter
29+
printers.TableGenerator
3030
}
3131

3232
func (c TableConvertor) ConvertToTable(ctx context.Context, obj runtime.Object, tableOptions runtime.Object) (*metav1beta1.Table, error) {
@@ -41,5 +41,5 @@ func (c TableConvertor) ConvertToTable(ctx context.Context, obj runtime.Object,
4141
return nil, fmt.Errorf("unrecognized type %T for table options, can't display tabular output", tableOptions)
4242
}
4343
}
44-
return c.TablePrinter.PrintTable(obj, printers.PrintOptions{Wide: true, NoHeaders: noHeaders})
44+
return c.TableGenerator.GenerateTable(obj, printers.PrintOptions{Wide: true, NoHeaders: noHeaders})
4545
}

‎pkg/registry/apps/controllerrevision/storage/storage.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ func NewREST(optsGetter generic.RESTOptionsGetter) *REST {
4343
UpdateStrategy: controllerrevision.Strategy,
4444
DeleteStrategy: controllerrevision.Strategy,
4545

46-
TableConvertor: printerstorage.TableConvertor{TablePrinter: printers.NewTablePrinter().With(printersinternal.AddHandlers)},
46+
TableConvertor: printerstorage.TableConvertor{TableGenerator: printers.NewTableGenerator().With(printersinternal.AddHandlers)},
4747
}
4848
options := &generic.StoreOptions{RESTOptions: optsGetter}
4949
if err := store.CompleteWithOptions(options); err != nil {

‎pkg/registry/apps/daemonset/storage/storage.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ func NewREST(optsGetter generic.RESTOptionsGetter) (*REST, *StatusREST) {
4848
UpdateStrategy: daemonset.Strategy,
4949
DeleteStrategy: daemonset.Strategy,
5050

51-
TableConvertor: printerstorage.TableConvertor{TablePrinter: printers.NewTablePrinter().With(printersinternal.AddHandlers)},
51+
TableConvertor: printerstorage.TableConvertor{TableGenerator: printers.NewTableGenerator().With(printersinternal.AddHandlers)},
5252
}
5353
options := &generic.StoreOptions{RESTOptions: optsGetter}
5454
if err := store.CompleteWithOptions(options); err != nil {

‎pkg/registry/apps/deployment/storage/storage.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ func NewREST(optsGetter generic.RESTOptionsGetter) (*REST, *StatusREST, *Rollbac
8080
UpdateStrategy: deployment.Strategy,
8181
DeleteStrategy: deployment.Strategy,
8282

83-
TableConvertor: printerstorage.TableConvertor{TablePrinter: printers.NewTablePrinter().With(printersinternal.AddHandlers)},
83+
TableConvertor: printerstorage.TableConvertor{TableGenerator: printers.NewTableGenerator().With(printersinternal.AddHandlers)},
8484
}
8585
options := &generic.StoreOptions{RESTOptions: optsGetter}
8686
if err := store.CompleteWithOptions(options); err != nil {

‎pkg/registry/apps/replicaset/storage/storage.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ func NewREST(optsGetter generic.RESTOptionsGetter) (*REST, *StatusREST) {
7676
UpdateStrategy: replicaset.Strategy,
7777
DeleteStrategy: replicaset.Strategy,
7878

79-
TableConvertor: printerstorage.TableConvertor{TablePrinter: printers.NewTablePrinter().With(printersinternal.AddHandlers)},
79+
TableConvertor: printerstorage.TableConvertor{TableGenerator: printers.NewTableGenerator().With(printersinternal.AddHandlers)},
8080
}
8181
options := &generic.StoreOptions{RESTOptions: optsGetter, AttrFunc: replicaset.GetAttrs}
8282
if err := store.CompleteWithOptions(options); err != nil {

‎pkg/registry/apps/statefulset/storage/storage.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ func NewREST(optsGetter generic.RESTOptionsGetter) (*REST, *StatusREST) {
7272
UpdateStrategy: statefulset.Strategy,
7373
DeleteStrategy: statefulset.Strategy,
7474

75-
TableConvertor: printerstorage.TableConvertor{TablePrinter: printers.NewTablePrinter().With(printersinternal.AddHandlers)},
75+
TableConvertor: printerstorage.TableConvertor{TableGenerator: printers.NewTableGenerator().With(printersinternal.AddHandlers)},
7676
}
7777
options := &generic.StoreOptions{RESTOptions: optsGetter}
7878
if err := store.CompleteWithOptions(options); err != nil {

‎pkg/registry/autoscaling/horizontalpodautoscaler/storage/storage.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ func NewREST(optsGetter generic.RESTOptionsGetter) (*REST, *StatusREST) {
4646
UpdateStrategy: horizontalpodautoscaler.Strategy,
4747
DeleteStrategy: horizontalpodautoscaler.Strategy,
4848

49-
TableConvertor: printerstorage.TableConvertor{TablePrinter: printers.NewTablePrinter().With(printersinternal.AddHandlers)},
49+
TableConvertor: printerstorage.TableConvertor{TableGenerator: printers.NewTableGenerator().With(printersinternal.AddHandlers)},
5050
}
5151
options := &generic.StoreOptions{RESTOptions: optsGetter}
5252
if err := store.CompleteWithOptions(options); err != nil {

‎pkg/registry/batch/cronjob/storage/storage.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ func NewREST(optsGetter generic.RESTOptionsGetter) (*REST, *StatusREST) {
4747
UpdateStrategy: cronjob.Strategy,
4848
DeleteStrategy: cronjob.Strategy,
4949

50-
TableConvertor: printerstorage.TableConvertor{TablePrinter: printers.NewTablePrinter().With(printersinternal.AddHandlers)},
50+
TableConvertor: printerstorage.TableConvertor{TableGenerator: printers.NewTableGenerator().With(printersinternal.AddHandlers)},
5151
}
5252
options := &generic.StoreOptions{RESTOptions: optsGetter}
5353
if err := store.CompleteWithOptions(options); err != nil {

0 commit comments

Comments
 (0)