Add new Events API group

2025-11-02 19:28:16 +00:00 · 2017-09-13 16:46:26 +02:00
parent 2a724dfc9c
commit 69e2a9cb48
37 changed files with 1046 additions and 17 deletions
--- a/pkg/apis/core/validation/events.go
+++ b/pkg/apis/core/validation/events.go
@@ -18,6 +18,7 @@ package validation

 import (
 	"fmt"
+	"time"

 	"k8s.io/apimachinery/pkg/api/meta"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -28,24 +29,68 @@ import (
 	"k8s.io/kubernetes/pkg/apis/core"
 )

+const (
+	ReportingInstanceLengthLimit = 128
+	ActionLengthLimit            = 128
+	ReasonLengthLimit            = 128
+	NoteLengthLimit              = 1024
+)
+
 // ValidateEvent makes sure that the event makes sense.
 func ValidateEvent(event *core.Event) field.ErrorList {
 	allErrs := field.ErrorList{}
+	// Because go
+	zeroTime := time.Time{}

-	// Make sure event.Namespace and the involvedObject.Namespace agree
-	if len(event.InvolvedObject.Namespace) == 0 {
-		// event.Namespace must also be empty (or "default", for compatibility with old clients)
-		if event.Namespace != metav1.NamespaceNone && event.Namespace != metav1.NamespaceDefault {
+	// "New" Events need to have EventTime set, so it's validating old object.
+	if event.EventTime.Time == zeroTime {
+		// Make sure event.Namespace and the involvedInvolvedObject.Namespace agree
+		if len(event.InvolvedObject.Namespace) == 0 {
+			// event.Namespace must also be empty (or "default", for compatibility with old clients)
+			if event.Namespace != metav1.NamespaceNone && event.Namespace != metav1.NamespaceDefault {
+				allErrs = append(allErrs, field.Invalid(field.NewPath("involvedObject", "namespace"), event.InvolvedObject.Namespace, "does not match event.namespace"))
+			}
+		} else {
+			// event namespace must match
+			if event.Namespace != event.InvolvedObject.Namespace {
+				allErrs = append(allErrs, field.Invalid(field.NewPath("involvedObject", "namespace"), event.InvolvedObject.Namespace, "does not match event.namespace"))
+			}
+		}
+
+	} else {
+		if len(event.InvolvedObject.Namespace) == 0 && event.Namespace != metav1.NamespaceSystem {
 			allErrs = append(allErrs, field.Invalid(field.NewPath("involvedObject", "namespace"), event.InvolvedObject.Namespace, "does not match event.namespace"))
 		}
-	} else {
-		// event namespace must match
-		if event.Namespace != event.InvolvedObject.Namespace {
-			allErrs = append(allErrs, field.Invalid(field.NewPath("involvedObject", "namespace"), event.InvolvedObject.Namespace, "does not match event.namespace"))
+		if len(event.ReportingController) == 0 {
+			allErrs = append(allErrs, field.Required(field.NewPath("reportingController"), ""))
+		}
+		for _, msg := range validation.IsQualifiedName(event.ReportingController) {
+			allErrs = append(allErrs, field.Invalid(field.NewPath("reportingController"), event.ReportingController, msg))
+		}
+		if len(event.ReportingInstance) == 0 {
+			allErrs = append(allErrs, field.Required(field.NewPath("reportingInstance"), ""))
+		}
+		if len(event.ReportingInstance) > ReportingInstanceLengthLimit {
+			allErrs = append(allErrs, field.Invalid(field.NewPath("repotingIntance"), "", fmt.Sprintf("can have at most %v characters", ReportingInstanceLengthLimit)))
+		}
+		if len(event.Action) == 0 {
+			allErrs = append(allErrs, field.Required(field.NewPath("action"), ""))
+		}
+		if len(event.Action) > ActionLengthLimit {
+			allErrs = append(allErrs, field.Invalid(field.NewPath("action"), "", fmt.Sprintf("can have at most %v characters", ActionLengthLimit)))
+		}
+		if len(event.Reason) == 0 {
+			allErrs = append(allErrs, field.Required(field.NewPath("reason"), ""))
+		}
+		if len(event.Reason) > ReasonLengthLimit {
+			allErrs = append(allErrs, field.Invalid(field.NewPath("reason"), "", fmt.Sprintf("can have at most %v characters", ReasonLengthLimit)))
+		}
+		if len(event.Message) > NoteLengthLimit {
+			allErrs = append(allErrs, field.Invalid(field.NewPath("message"), "", fmt.Sprintf("can have at most %v characters", NoteLengthLimit)))
 		}
 	}

-	// For kinds we recognize, make sure involvedObject.Namespace is set for namespaced kinds
+	// For kinds we recognize, make sure InvolvedObject.Namespace is set for namespaced kinds
 	if namespaced, err := isNamespacedKind(event.InvolvedObject.Kind, event.InvolvedObject.APIVersion); err == nil {
 		if namespaced && len(event.InvolvedObject.Namespace) == 0 {
 			allErrs = append(allErrs, field.Required(field.NewPath("involvedObject", "namespace"), fmt.Sprintf("required for kind %s", event.InvolvedObject.Kind)))
--- a/pkg/apis/core/validation/events_test.go
+++ b/pkg/apis/core/validation/events_test.go
@@ -18,6 +18,7 @@ package validation

 import (
 	"testing"
+	"time"

 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/kubernetes/pkg/apis/core"
@@ -215,7 +216,177 @@ func TestValidateEvent(t *testing.T) {

 	for _, item := range table {
 		if e, a := item.valid, len(ValidateEvent(item.Event)) == 0; e != a {
-			t.Errorf("%v: expected %v, got %v", item.Event.Name, e, a)
+			t.Errorf("%v: expected %v, got %v: %v", item.Event.Name, e, a, ValidateEvent(item.Event))
+		}
+	}
+}
+
+func TestValidateNewEvent(t *testing.T) {
+	someTime := metav1.MicroTime{Time: time.Unix(1505828956, 0)}
+	table := []struct {
+		*core.Event
+		valid bool
+		msg   string
+	}{
+		{
+			Event: &core.Event{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "test",
+					Namespace: metav1.NamespaceDefault,
+				},
+				InvolvedObject: core.ObjectReference{
+					APIVersion: "v1",
+					Kind:       "Node",
+				},
+				EventTime: someTime,
+			},
+			valid: false,
+			msg:   "Old Event with EventTime should trigger new validation and fail",
+		},
+		{
+			Event: &core.Event{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "test",
+					Namespace: metav1.NamespaceSystem,
+				},
+				InvolvedObject: core.ObjectReference{
+					APIVersion: "v1",
+					Kind:       "Node",
+				},
+				EventTime:           someTime,
+				ReportingController: "k8s.io/my-controller",
+				ReportingInstance:   "node-xyz",
+				Action:              "Do",
+				Reason:              "Because",
+			},
+			valid: true,
+			msg:   "Valid new Event",
+		},
+		{
+			Event: &core.Event{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "test",
+					Namespace: metav1.NamespaceSystem,
+				},
+				InvolvedObject: core.ObjectReference{
+					APIVersion: "v1",
+					Kind:       "Node",
+				},
+				EventTime:           someTime,
+				ReportingController: "my-contr@ller",
+				ReportingInstance:   "node-xyz",
+				Action:              "Do",
+				Reason:              "Because",
+			},
+			valid: false,
+			msg:   "not qualified reportingController",
+		},
+		{
+			Event: &core.Event{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "test",
+					Namespace: metav1.NamespaceSystem,
+				},
+				InvolvedObject: core.ObjectReference{
+					APIVersion: "v1",
+					Kind:       "Node",
+				},
+				EventTime:           someTime,
+				ReportingController: "k8s.io/my-controller",
+				ReportingInstance:   "node-xyzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz",
+				Action:              "Do",
+				Reason:              "Because",
+			},
+			valid: false,
+			msg:   "too long reporting instance",
+		},
+		{
+			Event: &core.Event{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "test",
+					Namespace: metav1.NamespaceSystem,
+				},
+				InvolvedObject: core.ObjectReference{
+					APIVersion: "v1",
+					Kind:       "Node",
+				},
+				EventTime:           someTime,
+				ReportingController: "k8s.io/my-controller",
+				ReportingInstance:   "node-xyz",
+				Action:              "Do",
+			},
+			valid: false,
+			msg:   "missing reason",
+		},
+		{
+			Event: &core.Event{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "test",
+					Namespace: metav1.NamespaceSystem,
+				},
+				InvolvedObject: core.ObjectReference{
+					APIVersion: "v1",
+					Kind:       "Node",
+				},
+				EventTime:           someTime,
+				ReportingController: "k8s.io/my-controller",
+				ReportingInstance:   "node-xyz",
+				Reason:              "Because",
+			},
+			valid: false,
+			msg:   "missing action",
+		},
+		{
+			Event: &core.Event{
+				ObjectMeta: metav1.ObjectMeta{
+					Name: "test",
+				},
+				InvolvedObject: core.ObjectReference{
+					APIVersion: "v1",
+					Kind:       "Node",
+				},
+				EventTime:           someTime,
+				ReportingController: "k8s.io/my-controller",
+				ReportingInstance:   "node-xyz",
+				Reason:              "Because",
+			},
+			valid: false,
+			msg:   "missing namespace",
+		},
+		{
+			Event: &core.Event{
+				ObjectMeta: metav1.ObjectMeta{
+					Name: "test",
+				},
+				InvolvedObject: core.ObjectReference{
+					APIVersion: "v1",
+					Kind:       "Node",
+				},
+				EventTime:           someTime,
+				ReportingController: "k8s.io/my-controller",
+				ReportingInstance:   "node-xyz",
+				Action:              "Do",
+				Reason:              "Because",
+				Message: `zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
+zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
+zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
+zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
+zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
+zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
+zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
+zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
+zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
+zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
+zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz`,
+			},
+			valid: false,
+			msg:   "too long message",
+		},
+	}
+
+	for _, item := range table {
+		if e, a := item.valid, len(ValidateEvent(item.Event)) == 0; e != a {
+			t.Errorf("%v: expected %v, got %v: %v", item.msg, e, a, ValidateEvent(item.Event))
 		}
 	}
 }