:Warning: Use controllerutil.Object for event handling

Author: alvaroaleman

pkg/builder/controller_test.go

@@ -251,7 +251,7 @@ var _ = Describe("application", func() {
 				CreateFunc: func(e event.CreateEvent) bool {
 					defer GinkgoRecover()
 					// check that it was called only for deployment
-					Expect(e.Meta).To(BeAssignableToTypeOf(&appsv1.Deployment{}))
+					Expect(e.Object).To(BeAssignableToTypeOf(&appsv1.Deployment{}))
 					deployPrctExecuted = true
 					return true
 				},
@@ -261,7 +261,7 @@ var _ = Describe("application", func() {
 				CreateFunc: func(e event.CreateEvent) bool {
 					defer GinkgoRecover()
 					// check that it was called only for replicaset
-					Expect(e.Meta).To(BeAssignableToTypeOf(&appsv1.ReplicaSet{}))
+					Expect(e.Object).To(BeAssignableToTypeOf(&appsv1.ReplicaSet{}))
 					replicaSetPrctExecuted = true
 					return true
 				},
@@ -271,7 +271,7 @@ var _ = Describe("application", func() {
 				CreateFunc: func(e event.CreateEvent) bool {
 					defer GinkgoRecover()
 					//check that it was called for all registered kinds
-					Expect(e.Meta).Should(Or(
+					Expect(e.Object).Should(Or(
 						BeAssignableToTypeOf(&appsv1.Deployment{}),
 						BeAssignableToTypeOf(&appsv1.ReplicaSet{}),
 					))

pkg/event/event.go

@@ -17,44 +17,31 @@ limitations under the License.
 package event
 
 import (
-	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"k8s.io/apimachinery/pkg/runtime"
+	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 )
 
 // CreateEvent is an event where a Kubernetes object was created.  CreateEvent should be generated
 // by a source.Source and transformed into a reconcile.Request by an handler.EventHandler.
 type CreateEvent struct {
-	// Meta is the ObjectMeta of the Kubernetes Type that was created
-	Meta metav1.Object
-
 	// Object is the object from the event
-	Object runtime.Object
+	Object controllerutil.Object
 }
 
 // UpdateEvent is an event where a Kubernetes object was updated.  UpdateEvent should be generated
 // by a source.Source and transformed into a reconcile.Request by an handler.EventHandler.
 type UpdateEvent struct {
-	// MetaOld is the ObjectMeta of the Kubernetes Type that was updated (before the update)
-	MetaOld metav1.Object
-
 	// ObjectOld is the object from the event
-	ObjectOld runtime.Object
-
-	// MetaNew is the ObjectMeta of the Kubernetes Type that was updated (after the update)
-	MetaNew metav1.Object
+	ObjectOld controllerutil.Object
 
 	// ObjectNew is the object from the event
-	ObjectNew runtime.Object
+	ObjectNew controllerutil.Object
 }
 
 // DeleteEvent is an event where a Kubernetes object was deleted.  DeleteEvent should be generated
 // by a source.Source and transformed into a reconcile.Request by an handler.EventHandler.
 type DeleteEvent struct {
-	// Meta is the ObjectMeta of the Kubernetes Type that was deleted
-	Meta metav1.Object
-
 	// Object is the object from the event
-	Object runtime.Object
+	Object controllerutil.Object
 
 	// DeleteStateUnknown is true if the Delete event was missed but we identified the object
 	// as having been deleted.
@@ -65,9 +52,6 @@ type DeleteEvent struct {
 // GenericEvent should be generated by a source.Source and transformed into a reconcile.Request by an
 // handler.EventHandler.
 type GenericEvent struct {
-	// Meta is the ObjectMeta of a Kubernetes Type this event is for
-	Meta metav1.Object
-
 	// Object is the object from the event
-	Object runtime.Object
+	Object controllerutil.Object
 }

pkg/handler/enqueue.go

@@ -35,31 +35,31 @@ type EnqueueRequestForObject struct{}
 
 // Create implements EventHandler
 func (e *EnqueueRequestForObject) Create(evt event.CreateEvent, q workqueue.RateLimitingInterface) {
-	if evt.Meta == nil {
+	if evt.Object == nil {
 		enqueueLog.Error(nil, "CreateEvent received with no metadata", "event", evt)
 		return
 	}
 	q.Add(reconcile.Request{NamespacedName: types.NamespacedName{
-		Name:      evt.Meta.GetName(),
-		Namespace: evt.Meta.GetNamespace(),
+		Name:      evt.Object.GetName(),
+		Namespace: evt.Object.GetNamespace(),
 	}})
 }
 
 // Update implements EventHandler
 func (e *EnqueueRequestForObject) Update(evt event.UpdateEvent, q workqueue.RateLimitingInterface) {
-	if evt.MetaOld != nil {
+	if evt.ObjectOld != nil {
 		q.Add(reconcile.Request{NamespacedName: types.NamespacedName{
-			Name:      evt.MetaOld.GetName(),
-			Namespace: evt.MetaOld.GetNamespace(),
+			Name:      evt.ObjectOld.GetName(),
+			Namespace: evt.ObjectOld.GetNamespace(),
 		}})
 	} else {
 		enqueueLog.Error(nil, "UpdateEvent received with no old metadata", "event", evt)
 	}
 
-	if evt.MetaNew != nil {
+	if evt.ObjectNew != nil {
 		q.Add(reconcile.Request{NamespacedName: types.NamespacedName{
-			Name:      evt.MetaNew.GetName(),
-			Namespace: evt.MetaNew.GetNamespace(),
+			Name:      evt.ObjectNew.GetName(),
+			Namespace: evt.ObjectNew.GetNamespace(),
 		}})
 	} else {
 		enqueueLog.Error(nil, "UpdateEvent received with no new metadata", "event", evt)
@@ -68,24 +68,24 @@ func (e *EnqueueRequestForObject) Update(evt event.UpdateEvent, q workqueue.Rate
 
 // Delete implements EventHandler
 func (e *EnqueueRequestForObject) Delete(evt event.DeleteEvent, q workqueue.RateLimitingInterface) {
-	if evt.Meta == nil {
+	if evt.Object == nil {
 		enqueueLog.Error(nil, "DeleteEvent received with no metadata", "event", evt)
 		return
 	}
 	q.Add(reconcile.Request{NamespacedName: types.NamespacedName{
-		Name:      evt.Meta.GetName(),
-		Namespace: evt.Meta.GetNamespace(),
+		Name:      evt.Object.GetName(),
+		Namespace: evt.Object.GetNamespace(),
 	}})
 }
 
 // Generic implements EventHandler
 func (e *EnqueueRequestForObject) Generic(evt event.GenericEvent, q workqueue.RateLimitingInterface) {
-	if evt.Meta == nil {
+	if evt.Object == nil {
 		enqueueLog.Error(nil, "GenericEvent received with no metadata", "event", evt)
 		return
 	}
 	q.Add(reconcile.Request{NamespacedName: types.NamespacedName{
-		Name:      evt.Meta.GetName(),
-		Namespace: evt.Meta.GetNamespace(),
+		Name:      evt.Object.GetName(),
+		Namespace: evt.Object.GetNamespace(),
 	}})
 }

pkg/handler/enqueue_mapped.go

@@ -17,9 +17,8 @@ limitations under the License.
 package handler
 
 import (
-	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/client-go/util/workqueue"
+	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 	"sigs.k8s.io/controller-runtime/pkg/event"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 	"sigs.k8s.io/controller-runtime/pkg/runtime/inject"
@@ -44,23 +43,23 @@ type EnqueueRequestsFromMapFunc struct {
 
 // Create implements EventHandler
 func (e *EnqueueRequestsFromMapFunc) Create(evt event.CreateEvent, q workqueue.RateLimitingInterface) {
-	e.mapAndEnqueue(q, MapObject{Meta: evt.Meta, Object: evt.Object})
+	e.mapAndEnqueue(q, MapObject{Object: evt.Object})
 }
 
 // Update implements EventHandler
 func (e *EnqueueRequestsFromMapFunc) Update(evt event.UpdateEvent, q workqueue.RateLimitingInterface) {
-	e.mapAndEnqueue(q, MapObject{Meta: evt.MetaOld, Object: evt.ObjectOld})
-	e.mapAndEnqueue(q, MapObject{Meta: evt.MetaNew, Object: evt.ObjectNew})
+	e.mapAndEnqueue(q, MapObject{Object: evt.ObjectOld})
+	e.mapAndEnqueue(q, MapObject{Object: evt.ObjectNew})
 }
 
 // Delete implements EventHandler
 func (e *EnqueueRequestsFromMapFunc) Delete(evt event.DeleteEvent, q workqueue.RateLimitingInterface) {
-	e.mapAndEnqueue(q, MapObject{Meta: evt.Meta, Object: evt.Object})
+	e.mapAndEnqueue(q, MapObject{Object: evt.Object})
 }
 
 // Generic implements EventHandler
 func (e *EnqueueRequestsFromMapFunc) Generic(evt event.GenericEvent, q workqueue.RateLimitingInterface) {
-	e.mapAndEnqueue(q, MapObject{Meta: evt.Meta, Object: evt.Object})
+	e.mapAndEnqueue(q, MapObject{Object: evt.Object})
 }
 
 func (e *EnqueueRequestsFromMapFunc) mapAndEnqueue(q workqueue.RateLimitingInterface, object MapObject) {
@@ -87,11 +86,7 @@ type Mapper interface {
 
 // MapObject contains information from an event to be transformed into a Request.
 type MapObject struct {
-	// Meta is the meta data for an object from an event.
-	Meta metav1.Object
-
-	// Object is the object from an event.
-	Object runtime.Object
+	Object controllerutil.Object
 }
 
 var _ Mapper = ToRequestsFunc(nil)

pkg/handler/enqueue_owner.go

@@ -59,31 +59,31 @@ type EnqueueRequestForOwner struct {
 
 // Create implements EventHandler
 func (e *EnqueueRequestForOwner) Create(evt event.CreateEvent, q workqueue.RateLimitingInterface) {
-	for _, req := range e.getOwnerReconcileRequest(evt.Meta) {
+	for _, req := range e.getOwnerReconcileRequest(evt.Object) {
 		q.Add(req)
 	}
 }
 
 // Update implements EventHandler
 func (e *EnqueueRequestForOwner) Update(evt event.UpdateEvent, q workqueue.RateLimitingInterface) {
-	for _, req := range e.getOwnerReconcileRequest(evt.MetaOld) {
+	for _, req := range e.getOwnerReconcileRequest(evt.ObjectOld) {
 		q.Add(req)
 	}
-	for _, req := range e.getOwnerReconcileRequest(evt.MetaNew) {
+	for _, req := range e.getOwnerReconcileRequest(evt.ObjectNew) {
 		q.Add(req)
 	}
 }
 
 // Delete implements EventHandler
 func (e *EnqueueRequestForOwner) Delete(evt event.DeleteEvent, q workqueue.RateLimitingInterface) {
-	for _, req := range e.getOwnerReconcileRequest(evt.Meta) {
+	for _, req := range e.getOwnerReconcileRequest(evt.Object) {
 		q.Add(req)
 	}
 }
 
 // Generic implements EventHandler
 func (e *EnqueueRequestForOwner) Generic(evt event.GenericEvent, q workqueue.RateLimitingInterface) {
-	for _, req := range e.getOwnerReconcileRequest(evt.Meta) {
+	for _, req := range e.getOwnerReconcileRequest(evt.Object) {
 		q.Add(req)
 	}
 }