Merge pull request kubernetes#92874 from chelseychen/event-api

Fix a few places where source field is empty when creating events via events/v1

Author: k8s-ci-robot

pkg/apis/core/v1/conversion.go

@@ -435,6 +435,7 @@ func AddFieldLabelConversionsForEvent(scheme *runtime.Scheme) error {
 				"involvedObject.resourceVersion",
 				"involvedObject.fieldPath",
 				"reason",
+				"reportingComponent",
 				"source",
 				"type",
 				"metadata.namespace",

pkg/apis/events/v1/conversion.go

@@ -17,8 +17,11 @@ limitations under the License.
 package v1
 
 import (
+	"fmt"
+
 	v1 "k8s.io/api/events/v1"
 	conversion "k8s.io/apimachinery/pkg/conversion"
+	"k8s.io/apimachinery/pkg/runtime"
 	k8s_api "k8s.io/kubernetes/pkg/apis/core"
 	k8s_api_v1 "k8s.io/kubernetes/pkg/apis/core/v1"
 )
@@ -56,3 +59,29 @@ func Convert_core_Event_To_v1_Event(in *k8s_api.Event, out *v1.Event, s conversi
 	out.DeprecatedCount = in.Count
 	return nil
 }
+
+func AddFieldLabelConversionsForEvent(scheme *runtime.Scheme) error {
+	mapping := map[string]string{
+		"reason":                    "reason",
+		"regarding.kind":            "involvedObject.kind",            // map events.k8s.io field to fieldset returned by ToSelectableFields
+		"regarding.namespace":       "involvedObject.namespace",       // map events.k8s.io field to fieldset returned by ToSelectableFields
+		"regarding.name":            "involvedObject.name",            // map events.k8s.io field to fieldset returned by ToSelectableFields
+		"regarding.uid":             "involvedObject.uid",             // map events.k8s.io field to fieldset returned by ToSelectableFields
+		"regarding.apiVersion":      "involvedObject.apiVersion",      // map events.k8s.io field to fieldset returned by ToSelectableFields
+		"regarding.resourceVersion": "involvedObject.resourceVersion", // map events.k8s.io field to fieldset returned by ToSelectableFields
+		"regarding.fieldPath":       "involvedObject.fieldPath",       // map events.k8s.io field to fieldset returned by ToSelectableFields
+		"reportingController":       "reportingComponent",             // map events.k8s.io field to fieldset returned by ToSelectableFields
+		"type":                      "type",
+		"metadata.namespace":        "metadata.namespace",
+		"metadata.name":             "metadata.name",
+	}
+	return scheme.AddFieldLabelConversionFunc(SchemeGroupVersion.WithKind("Event"),
+		func(label, value string) (string, string, error) {
+			mappedLabel, ok := mapping[label]
+			if !ok {
+				return "", "", fmt.Errorf("field label not supported: %s", label)
+			}
+			return mappedLabel, value, nil
+		},
+	)
+}

pkg/apis/events/v1/register.go

@@ -41,5 +41,5 @@ func init() {
 	// We only register manually written functions here. The registration of the
 	// generated functions takes place in the generated files. The separation
 	// makes the code compile even when the generated files are missing.
-	localSchemeBuilder.Register(RegisterDefaults)
+	localSchemeBuilder.Register(RegisterDefaults, AddFieldLabelConversionsForEvent)
 }

pkg/apis/events/v1beta1/conversion.go

@@ -17,8 +17,11 @@ limitations under the License.
 package v1beta1
 
 import (
+	"fmt"
+
 	v1beta1 "k8s.io/api/events/v1beta1"
 	conversion "k8s.io/apimachinery/pkg/conversion"
+	"k8s.io/apimachinery/pkg/runtime"
 	k8s_api "k8s.io/kubernetes/pkg/apis/core"
 	k8s_api_v1 "k8s.io/kubernetes/pkg/apis/core/v1"
 )
@@ -56,3 +59,29 @@ func Convert_core_Event_To_v1beta1_Event(in *k8s_api.Event, out *v1beta1.Event,
 	out.DeprecatedCount = in.Count
 	return nil
 }
+
+func AddFieldLabelConversionsForEvent(scheme *runtime.Scheme) error {
+	mapping := map[string]string{
+		"reason":                    "reason",
+		"regarding.kind":            "involvedObject.kind",            // map events.k8s.io field to fieldset returned by ToSelectableFields
+		"regarding.namespace":       "involvedObject.namespace",       // map events.k8s.io field to fieldset returned by ToSelectableFields
+		"regarding.name":            "involvedObject.name",            // map events.k8s.io field to fieldset returned by ToSelectableFields
+		"regarding.uid":             "involvedObject.uid",             // map events.k8s.io field to fieldset returned by ToSelectableFields
+		"regarding.apiVersion":      "involvedObject.apiVersion",      // map events.k8s.io field to fieldset returned by ToSelectableFields
+		"regarding.resourceVersion": "involvedObject.resourceVersion", // map events.k8s.io field to fieldset returned by ToSelectableFields
+		"regarding.fieldPath":       "involvedObject.fieldPath",       // map events.k8s.io field to fieldset returned by ToSelectableFields
+		"reportingController":       "reportingComponent",             // map events.k8s.io field to fieldset returned by ToSelectableFields
+		"type":                      "type",
+		"metadata.namespace":        "metadata.namespace",
+		"metadata.name":             "metadata.name",
+	}
+	return scheme.AddFieldLabelConversionFunc(SchemeGroupVersion.WithKind("Event"),
+		func(label, value string) (string, string, error) {
+			mappedLabel, ok := mapping[label]
+			if !ok {
+				return "", "", fmt.Errorf("field label not supported: %s", label)
+			}
+			return mappedLabel, value, nil
+		},
+	)
+}

pkg/apis/events/v1beta1/register.go

@@ -41,5 +41,5 @@ func init() {
 	// We only register manually written functions here. The registration of the
 	// generated functions takes place in the generated files. The separation
 	// makes the code compile even when the generated files are missing.
-	localSchemeBuilder.Register(RegisterDefaults)
+	localSchemeBuilder.Register(RegisterDefaults, AddFieldLabelConversionsForEvent)
 }

pkg/printers/internalversion/printers.go

@@ -1757,7 +1757,7 @@ func printEvent(obj *api.Event, options printers.GenerateOptions) ([]metav1.Tabl
 			obj.Reason,
 			target,
 			obj.InvolvedObject.FieldPath,
-			formatEventSource(obj.Source),
+			formatEventSource(obj.Source, obj.ReportingController, obj.ReportingInstance),
 			strings.TrimSpace(obj.Message),
 			firstTimestamp,
 			int64(count),
@@ -2247,13 +2247,29 @@ func layoutContainerCells(containers []api.Container) (names string, images stri
 	return namesBuffer.String(), imagesBuffer.String()
 }
 
-// formatEventSource formats EventSource as a comma separated string excluding Host when empty
-func formatEventSource(es api.EventSource) string {
-	EventSourceString := []string{es.Component}
-	if len(es.Host) > 0 {
-		EventSourceString = append(EventSourceString, es.Host)
+// formatEventSource formats EventSource as a comma separated string excluding Host when empty.
+// It uses reportingController when Source.Component is empty and reportingInstance when Source.Host is empty
+func formatEventSource(es api.EventSource, reportingController, reportingInstance string) string {
+	return formatEventSourceComponentInstance(
+		firstNonEmpty(es.Component, reportingController),
+		firstNonEmpty(es.Host, reportingInstance),
+	)
+}
+
+func firstNonEmpty(ss ...string) string {
+	for _, s := range ss {
+		if len(s) > 0 {
+			return s
+		}
+	}
+	return ""
+}
+
+func formatEventSourceComponentInstance(component, instance string) string {
+	if len(instance) == 0 {
+		return component
 	}
-	return strings.Join(EventSourceString, ", ")
+	return component + ", " + instance
 }
 
 func printControllerRevision(obj *apps.ControllerRevision, options printers.GenerateOptions) ([]metav1.TableRow, error) {

pkg/printers/internalversion/printers_test.go

@@ -255,6 +255,28 @@ func TestPrintEvent(t *testing.T) {
 			// Columns: Last Seen, Type, Reason, Object, Subobject, Message, First Seen, Count, Name
 			expected: []metav1.TableRow{{Cells: []interface{}{"3d", "Warning", "Event Reason", "deployment/Deployment Name", "spec.containers{foo}", "kubelet, Node1", "Message Data", "3d", int64(1), "event7"}}},
 		},
+		// Basic event, with empty Source; generate options=Wide
+		{
+			event: api.Event{
+				ReportingController: "kubelet",
+				ReportingInstance:   "test",
+				InvolvedObject: api.ObjectReference{
+					Kind:      "Deployment",
+					Name:      "Deployment Name",
+					FieldPath: "spec.containers{foo}",
+				},
+				Reason:         "Event Reason",
+				Message:        "Message Data",
+				FirstTimestamp: metav1.Time{Time: time.Now().UTC().AddDate(0, 0, -3)},
+				LastTimestamp:  metav1.Time{Time: time.Now().UTC().AddDate(0, 0, -2)},
+				Count:          6,
+				Type:           api.EventTypeWarning,
+				ObjectMeta:     metav1.ObjectMeta{Name: "event2"},
+			},
+			options: printers.GenerateOptions{Wide: true},
+			// Columns: Last Seen, Type, Reason, Object, Subobject, Source, Message, First Seen, Count, Name
+			expected: []metav1.TableRow{{Cells: []interface{}{"2d", "Warning", "Event Reason", "deployment/Deployment Name", "spec.containers{foo}", "kubelet, test", "Message Data", "3d", int64(6), "event2"}}},
+		},
 	}
 
 	for i, test := range tests {

pkg/registry/BUILD

@@ -68,7 +68,6 @@ filegroup(
         "//pkg/registry/core/serviceaccount:all-srcs",
         "//pkg/registry/discovery/endpointslice:all-srcs",
         "//pkg/registry/discovery/rest:all-srcs",
-        "//pkg/registry/events/event:all-srcs",
         "//pkg/registry/events/rest:all-srcs",
         "//pkg/registry/extensions/rest:all-srcs",
         "//pkg/registry/flowcontrol/flowschema:all-srcs",

pkg/registry/core/event/strategy.go

@@ -104,6 +104,10 @@ func Matcher(label labels.Selector, field fields.Selector) storage.SelectionPred
 // ToSelectableFields returns a field set that represents the object.
 func ToSelectableFields(event *api.Event) fields.Set {
 	objectMetaFieldsSet := generic.ObjectMetaFieldsSet(&event.ObjectMeta, true)
+	source := event.Source.Component
+	if source == "" {
+		source = event.ReportingController
+	}
 	specificFieldsSet := fields.Set{
 		"involvedObject.kind":            event.InvolvedObject.Kind,
 		"involvedObject.namespace":       event.InvolvedObject.Namespace,
@@ -113,7 +117,8 @@ func ToSelectableFields(event *api.Event) fields.Set {
 		"involvedObject.resourceVersion": event.InvolvedObject.ResourceVersion,
 		"involvedObject.fieldPath":       event.InvolvedObject.FieldPath,
 		"reason":                         event.Reason,
-		"source":                         event.Source.Component,
+		"reportingComponent":             event.ReportingController, // use the core/v1 field name
+		"source":                         source,
 		"type":                           event.Type,
 	}
 	return generic.MergeFieldsSets(objectMetaFieldsSet, specificFieldsSet)

pkg/registry/core/event/strategy_test.go

@@ -50,7 +50,7 @@ func TestGetAttrs(t *testing.T) {
 		Type:   api.EventTypeNormal,
 	}
 	field := ToSelectableFields(eventA)
-	expect := fields.Set{
+	expectA := fields.Set{
 		"metadata.name":                  "f0118",
 		"metadata.namespace":             "default",
 		"involvedObject.kind":            "Pod",
@@ -61,10 +61,49 @@ func TestGetAttrs(t *testing.T) {
 		"involvedObject.resourceVersion": "0",
 		"involvedObject.fieldPath":       "",
 		"reason":                         "ForTesting",
+		"reportingComponent":             "",
 		"source":                         "test",
 		"type":                           api.EventTypeNormal,
 	}
-	if e, a := expect, field; !reflect.DeepEqual(e, a) {
+	if e, a := expectA, field; !reflect.DeepEqual(e, a) {
+		t.Errorf("diff: %s", diff.ObjectDiff(e, a))
+	}
+
+	eventB := &api.Event{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "f0118",
+			Namespace: "default",
+		},
+		InvolvedObject: api.ObjectReference{
+			Kind:            "Pod",
+			Name:            "foo",
+			Namespace:       "baz",
+			UID:             "long uid string",
+			APIVersion:      "v1",
+			ResourceVersion: "0",
+			FieldPath:       "",
+		},
+		Reason:              "ForTesting",
+		ReportingController: "test",
+		Type:                api.EventTypeNormal,
+	}
+	field = ToSelectableFields(eventB)
+	expectB := fields.Set{
+		"metadata.name":                  "f0118",
+		"metadata.namespace":             "default",
+		"involvedObject.kind":            "Pod",
+		"involvedObject.name":            "foo",
+		"involvedObject.namespace":       "baz",
+		"involvedObject.uid":             "long uid string",
+		"involvedObject.apiVersion":      "v1",
+		"involvedObject.resourceVersion": "0",
+		"involvedObject.fieldPath":       "",
+		"reason":                         "ForTesting",
+		"reportingComponent":             "test",
+		"source":                         "test",
+		"type":                           api.EventTypeNormal,
+	}
+	if e, a := expectB, field; !reflect.DeepEqual(e, a) {
 		t.Errorf("diff: %s", diff.ObjectDiff(e, a))
 	}
 }