Support Table and PartialObjectMetadata on watch

Clean up the code paths that lead to objects being transformed and output with negotiation.
Remove some duplicate code that was not consistent. Now, watch will respond correctly to
Table and PartialObjectMetadata requests. Add unit and integration tests.

When transforming responses to Tables, only the first watch event for a given type will
include the columns. Columns will not change unless the watch is restarted.

Add a volume attachment printer and tighten up table validation error cases.

Disable protobuf from table conversion because Tables don't have protobuf because they
use `interface{}`

Author: smarterclayton

pkg/api/testing/fuzzer.go

@@ -22,10 +22,11 @@ import (
 	fuzz "github.com/google/gofuzz"
 
 	appsv1 "k8s.io/api/apps/v1"
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	apitesting "k8s.io/apimachinery/pkg/api/apitesting"
 	"k8s.io/apimachinery/pkg/api/apitesting/fuzzer"
 	genericfuzzer "k8s.io/apimachinery/pkg/apis/meta/fuzzer"
+	metafuzzer "k8s.io/apimachinery/pkg/apis/meta/fuzzer"
 	"k8s.io/apimachinery/pkg/runtime"
 	runtimeserializer "k8s.io/apimachinery/pkg/runtime/serializer"
 	admissionregistrationfuzzer "k8s.io/kubernetes/pkg/apis/admissionregistration/fuzzer"
@@ -105,4 +106,5 @@ var FuzzerFuncs = fuzzer.MergeFuzzerFuncs(
 	auditregistrationfuzzer.Funcs,
 	storagefuzzer.Funcs,
 	networkingfuzzer.Funcs,
+	metafuzzer.Funcs,
 )

pkg/printers/humanreadable.go

@@ -509,14 +509,17 @@ func (h *HumanReadablePrinter) PrintTable(obj runtime.Object, options PrintOptio
 		return nil, results[1].Interface().(error)
 	}
 
-	columns := handler.columnDefinitions
-	if !options.Wide {
-		columns = make([]metav1beta1.TableColumnDefinition, 0, len(handler.columnDefinitions))
-		for i := range handler.columnDefinitions {
-			if handler.columnDefinitions[i].Priority != 0 {
-				continue
+	var columns []metav1beta1.TableColumnDefinition
+	if !options.NoHeaders {
+		columns = handler.columnDefinitions
+		if !options.Wide {
+			columns = make([]metav1beta1.TableColumnDefinition, 0, len(handler.columnDefinitions))
+			for i := range handler.columnDefinitions {
+				if handler.columnDefinitions[i].Priority != 0 {
+					continue
+				}
+				columns = append(columns, handler.columnDefinitions[i])
 			}
-			columns = append(columns, handler.columnDefinitions[i])
 		}
 	}
 	table := &metav1beta1.Table{

pkg/printers/internalversion/printers.go

@@ -430,14 +430,14 @@ func AddHandlers(h printers.PrintHandler) {
 	h.TableHandler(controllerRevisionColumnDefinition, printControllerRevision)
 	h.TableHandler(controllerRevisionColumnDefinition, printControllerRevisionList)
 
-	resorceQuotaColumnDefinitions := []metav1beta1.TableColumnDefinition{
+	resourceQuotaColumnDefinitions := []metav1beta1.TableColumnDefinition{
 		{Name: "Name", Type: "string", Format: "name", Description: metav1.ObjectMeta{}.SwaggerDoc()["name"]},
 		{Name: "Age", Type: "string", Description: metav1.ObjectMeta{}.SwaggerDoc()["creationTimestamp"]},
 		{Name: "Request", Type: "string", Description: "Request represents a minimum amount of cpu/memory that a container may consume."},
 		{Name: "Limit", Type: "string", Description: "Limits control the maximum amount of cpu/memory that a container may use independent of contention on the node."},
 	}
-	h.TableHandler(resorceQuotaColumnDefinitions, printResourceQuota)
-	h.TableHandler(resorceQuotaColumnDefinitions, printResourceQuotaList)
+	h.TableHandler(resourceQuotaColumnDefinitions, printResourceQuota)
+	h.TableHandler(resourceQuotaColumnDefinitions, printResourceQuotaList)
 
 	priorityClassColumnDefinitions := []metav1beta1.TableColumnDefinition{
 		{Name: "Name", Type: "string", Format: "name", Description: metav1.ObjectMeta{}.SwaggerDoc()["name"]},
@@ -456,6 +456,17 @@ func AddHandlers(h printers.PrintHandler) {
 	h.TableHandler(runtimeClassColumnDefinitions, printRuntimeClass)
 	h.TableHandler(runtimeClassColumnDefinitions, printRuntimeClassList)
 
+	volumeAttachmentColumnDefinitions := []metav1beta1.TableColumnDefinition{
+		{Name: "Name", Type: "string", Format: "name", Description: metav1.ObjectMeta{}.SwaggerDoc()["name"]},
+		{Name: "Attacher", Type: "string", Format: "name", Description: storagev1.VolumeAttachmentSpec{}.SwaggerDoc()["attacher"]},
+		{Name: "PV", Type: "string", Description: storagev1.VolumeAttachmentSource{}.SwaggerDoc()["persistentVolumeName"]},
+		{Name: "Node", Type: "string", Description: storagev1.VolumeAttachmentSpec{}.SwaggerDoc()["nodeName"]},
+		{Name: "Attached", Type: "boolean", Description: storagev1.VolumeAttachmentStatus{}.SwaggerDoc()["attached"]},
+		{Name: "Age", Type: "string", Description: metav1.ObjectMeta{}.SwaggerDoc()["creationTimestamp"]},
+	}
+	h.TableHandler(volumeAttachmentColumnDefinitions, printVolumeAttachment)
+	h.TableHandler(volumeAttachmentColumnDefinitions, printVolumeAttachmentList)
+
 	AddDefaultHandlers(h)
 }
 
@@ -1996,6 +2007,34 @@ func printRuntimeClassList(list *nodeapi.RuntimeClassList, options printers.Prin
 	rows := make([]metav1beta1.TableRow, 0, len(list.Items))
 	for i := range list.Items {
 		r, err := printRuntimeClass(&list.Items[i], options)
+
+		if err != nil {
+			return nil, err
+		}
+		rows = append(rows, r...)
+	}
+	return rows, nil
+}
+
+func printVolumeAttachment(obj *storage.VolumeAttachment, options printers.PrintOptions) ([]metav1beta1.TableRow, error) {
+	row := metav1beta1.TableRow{
+		Object: runtime.RawExtension{Object: obj},
+	}
+
+	name := obj.Name
+	pvName := ""
+	if obj.Spec.Source.PersistentVolumeName != nil {
+		pvName = *obj.Spec.Source.PersistentVolumeName
+	}
+	row.Cells = append(row.Cells, name, obj.Spec.Attacher, pvName, obj.Spec.NodeName, obj.Status.Attached, translateTimestampSince(obj.CreationTimestamp))
+
+	return []metav1beta1.TableRow{row}, nil
+}
+
+func printVolumeAttachmentList(list *storage.VolumeAttachmentList, options printers.PrintOptions) ([]metav1beta1.TableRow, error) {
+	rows := make([]metav1beta1.TableRow, 0, len(list.Items))
+	for i := range list.Items {
+		r, err := printVolumeAttachment(&list.Items[i], options)
 		if err != nil {
 			return nil, err
 		}

pkg/printers/storage/storage.go

@@ -18,6 +18,7 @@ package storage
 
 import (
 	"context"
+	"fmt"
 
 	metav1beta1 "k8s.io/apimachinery/pkg/apis/meta/v1beta1"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -29,5 +30,16 @@ type TableConvertor struct {
 }
 
 func (c TableConvertor) ConvertToTable(ctx context.Context, obj runtime.Object, tableOptions runtime.Object) (*metav1beta1.Table, error) {
-	return c.TablePrinter.PrintTable(obj, printers.PrintOptions{Wide: true})
+	noHeaders := false
+	if tableOptions != nil {
+		switch t := tableOptions.(type) {
+		case *metav1beta1.TableOptions:
+			if t != nil {
+				noHeaders = t.NoHeaders
+			}
+		default:
+			return nil, fmt.Errorf("unrecognized type %T for table options, can't display tabular output", tableOptions)
+		}
+	}
+	return c.TablePrinter.PrintTable(obj, printers.PrintOptions{Wide: true, NoHeaders: noHeaders})
 }

pkg/registry/storage/volumeattachment/storage/BUILD

@@ -7,6 +7,9 @@ go_library(
     visibility = ["//visibility:public"],
     deps = [
         "//pkg/apis/storage:go_default_library",
+        "//pkg/printers:go_default_library",
+        "//pkg/printers/internalversion:go_default_library",
+        "//pkg/printers/storage:go_default_library",
         "//pkg/registry/storage/volumeattachment:go_default_library",
         "//staging/src/k8s.io/apimachinery/pkg/apis/meta/v1:go_default_library",
         "//staging/src/k8s.io/apimachinery/pkg/runtime:go_default_library",

pkg/registry/storage/volumeattachment/storage/storage.go

@@ -25,6 +25,9 @@ import (
 	genericregistry "k8s.io/apiserver/pkg/registry/generic/registry"
 	"k8s.io/apiserver/pkg/registry/rest"
 	storageapi "k8s.io/kubernetes/pkg/apis/storage"
+	"k8s.io/kubernetes/pkg/printers"
+	printersinternal "k8s.io/kubernetes/pkg/printers/internalversion"
+	printerstorage "k8s.io/kubernetes/pkg/printers/storage"
 	"k8s.io/kubernetes/pkg/registry/storage/volumeattachment"
 )
 
@@ -50,6 +53,8 @@ func NewStorage(optsGetter generic.RESTOptionsGetter) *VolumeAttachmentStorage {
 		UpdateStrategy:      volumeattachment.Strategy,
 		DeleteStrategy:      volumeattachment.Strategy,
 		ReturnDeletedObject: true,
+
+		TableConvertor: printerstorage.TableConvertor{TablePrinter: printers.NewTablePrinter().With(printersinternal.AddHandlers)},
 	}
 	options := &generic.StoreOptions{RESTOptions: optsGetter}
 	if err := store.CompleteWithOptions(options); err != nil {

staging/src/k8s.io/apiextensions-apiserver/Godeps/Godeps.json

@@ -36,4 +36,11 @@ go_test(
     name = "go_default_test",
     srcs = ["tableconvertor_test.go"],
     embed = [":go_default_library"],
+    deps = [
+        "//staging/src/k8s.io/apimachinery/pkg/apis/meta/v1:go_default_library",
+        "//staging/src/k8s.io/apimachinery/pkg/apis/meta/v1beta1:go_default_library",
+        "//staging/src/k8s.io/apimachinery/pkg/runtime:go_default_library",
+        "//staging/src/k8s.io/apimachinery/pkg/util/diff:go_default_library",
+        "//staging/src/k8s.io/client-go/util/jsonpath:go_default_library",
+    ],
 )

staging/src/k8s.io/apiextensions-apiserver/pkg/registry/customresource/tableconvertor/BUILD

@@ -76,9 +76,13 @@ type convertor struct {
 }
 
 func (c *convertor) ConvertToTable(ctx context.Context, obj runtime.Object, tableOptions runtime.Object) (*metav1beta1.Table, error) {
-	table := &metav1beta1.Table{
-		ColumnDefinitions: c.headers,
+	table := &metav1beta1.Table{}
+	opt, ok := tableOptions.(*metav1beta1.TableOptions)
+	noHeaders := ok && opt != nil && opt.NoHeaders
+	if !noHeaders {
+		table.ColumnDefinitions = c.headers
 	}
+
 	if m, err := meta.ListAccessor(obj); err == nil {
 		table.ResourceVersion = m.GetResourceVersion()
 		table.SelfLink = m.GetSelfLink()

staging/src/k8s.io/apiextensions-apiserver/pkg/registry/customresource/tableconvertor/tableconvertor.go

@@ -17,10 +17,17 @@ limitations under the License.
 package tableconvertor
 
 import (
+	"context"
 	"fmt"
 	"reflect"
 	"testing"
 	"time"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	metav1beta1 "k8s.io/apimachinery/pkg/apis/meta/v1beta1"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/util/diff"
+	"k8s.io/client-go/util/jsonpath"
 )
 
 func Test_cellForJSONValue(t *testing.T) {
@@ -66,3 +73,149 @@ func Test_cellForJSONValue(t *testing.T) {
 		})
 	}
 }
+
+func Test_convertor_ConvertToTable(t *testing.T) {
+	type fields struct {
+		headers           []metav1beta1.TableColumnDefinition
+		additionalColumns []*jsonpath.JSONPath
+	}
+	type args struct {
+		ctx          context.Context
+		obj          runtime.Object
+		tableOptions runtime.Object
+	}
+	tests := []struct {
+		name    string
+		fields  fields
+		args    args
+		want    *metav1beta1.Table
+		wantErr bool
+	}{
+		{
+			name: "Return table for object",
+			fields: fields{
+				headers: []metav1beta1.TableColumnDefinition{{Name: "name", Type: "string"}},
+			},
+			args: args{
+				obj: &metav1beta1.PartialObjectMetadata{
+					ObjectMeta: metav1.ObjectMeta{Name: "blah", CreationTimestamp: metav1.NewTime(time.Unix(1, 0))},
+				},
+				tableOptions: nil,
+			},
+			want: &metav1beta1.Table{
+				ColumnDefinitions: []metav1beta1.TableColumnDefinition{{Name: "name", Type: "string"}},
+				Rows: []metav1beta1.TableRow{
+					{
+						Cells: []interface{}{"blah"},
+						Object: runtime.RawExtension{
+							Object: &metav1beta1.PartialObjectMetadata{
+								ObjectMeta: metav1.ObjectMeta{Name: "blah", CreationTimestamp: metav1.NewTime(time.Unix(1, 0))},
+							},
+						},
+					},
+				},
+			},
+		},
+		{
+			name: "Return table for list",
+			fields: fields{
+				headers: []metav1beta1.TableColumnDefinition{{Name: "name", Type: "string"}},
+			},
+			args: args{
+				obj: &metav1beta1.PartialObjectMetadataList{
+					Items: []*metav1beta1.PartialObjectMetadata{
+						{ObjectMeta: metav1.ObjectMeta{Name: "blah", CreationTimestamp: metav1.NewTime(time.Unix(1, 0))}},
+						{ObjectMeta: metav1.ObjectMeta{Name: "blah-2", CreationTimestamp: metav1.NewTime(time.Unix(2, 0))}},
+					},
+				},
+				tableOptions: nil,
+			},
+			want: &metav1beta1.Table{
+				ColumnDefinitions: []metav1beta1.TableColumnDefinition{{Name: "name", Type: "string"}},
+				Rows: []metav1beta1.TableRow{
+					{
+						Cells: []interface{}{"blah"},
+						Object: runtime.RawExtension{
+							Object: &metav1beta1.PartialObjectMetadata{
+								ObjectMeta: metav1.ObjectMeta{Name: "blah", CreationTimestamp: metav1.NewTime(time.Unix(1, 0))},
+							},
+						},
+					},
+					{
+						Cells: []interface{}{"blah-2"},
+						Object: runtime.RawExtension{
+							Object: &metav1beta1.PartialObjectMetadata{
+								ObjectMeta: metav1.ObjectMeta{Name: "blah-2", CreationTimestamp: metav1.NewTime(time.Unix(2, 0))},
+							},
+						},
+					},
+				},
+			},
+		},
+		{
+			name: "Accept TableOptions",
+			fields: fields{
+				headers: []metav1beta1.TableColumnDefinition{{Name: "name", Type: "string"}},
+			},
+			args: args{
+				obj: &metav1beta1.PartialObjectMetadata{
+					ObjectMeta: metav1.ObjectMeta{Name: "blah", CreationTimestamp: metav1.NewTime(time.Unix(1, 0))},
+				},
+				tableOptions: &metav1beta1.TableOptions{},
+			},
+			want: &metav1beta1.Table{
+				ColumnDefinitions: []metav1beta1.TableColumnDefinition{{Name: "name", Type: "string"}},
+				Rows: []metav1beta1.TableRow{
+					{
+						Cells: []interface{}{"blah"},
+						Object: runtime.RawExtension{
+							Object: &metav1beta1.PartialObjectMetadata{
+								ObjectMeta: metav1.ObjectMeta{Name: "blah", CreationTimestamp: metav1.NewTime(time.Unix(1, 0))},
+							},
+						},
+					},
+				},
+			},
+		},
+		{
+			name: "Omit headers from TableOptions",
+			fields: fields{
+				headers: []metav1beta1.TableColumnDefinition{{Name: "name", Type: "string"}},
+			},
+			args: args{
+				obj: &metav1beta1.PartialObjectMetadata{
+					ObjectMeta: metav1.ObjectMeta{Name: "blah", CreationTimestamp: metav1.NewTime(time.Unix(1, 0))},
+				},
+				tableOptions: &metav1beta1.TableOptions{NoHeaders: true},
+			},
+			want: &metav1beta1.Table{
+				Rows: []metav1beta1.TableRow{
+					{
+						Cells: []interface{}{"blah"},
+						Object: runtime.RawExtension{
+							Object: &metav1beta1.PartialObjectMetadata{
+								ObjectMeta: metav1.ObjectMeta{Name: "blah", CreationTimestamp: metav1.NewTime(time.Unix(1, 0))},
+							},
+						},
+					},
+				},
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			c := &convertor{
+				headers:           tt.fields.headers,
+				additionalColumns: tt.fields.additionalColumns,
+			}
+			got, err := c.ConvertToTable(tt.args.ctx, tt.args.obj, tt.args.tableOptions)
+			if (err != nil) != tt.wantErr {
+				t.Errorf("convertor.ConvertToTable() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			if !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("convertor.ConvertToTable() = %s", diff.ObjectReflectDiff(tt.want, got))
+			}
+		})
+	}
+}