Add helper function for adding OwnerReferences to metav1.Objects

Author: pwittrock

pkg/manager/internal.go

@@ -17,13 +17,17 @@ limitations under the License.
 package manager
 
 import (
+	"fmt"
 	"sync"
 
+	"k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/runtime/schema"
 	"k8s.io/client-go/rest"
 	"k8s.io/client-go/tools/record"
 	"sigs.k8s.io/controller-runtime/pkg/cache"
 	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/controller-runtime/pkg/client/apiutil"
 	"sigs.k8s.io/controller-runtime/pkg/recorder"
 	"sigs.k8s.io/controller-runtime/pkg/runtime/inject"
 	logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
@@ -132,6 +136,26 @@ func (cm *controllerManager) GetRecorder(name string) record.EventRecorder {
 	return cm.recorderProvider.GetEventRecorderFor(name)
 }
 
+func (cm *controllerManager) SetControllerReference(owner, object v1.Object) error {
+	s := cm.GetScheme()
+	ro, ok := owner.(runtime.Object)
+	if !ok {
+		return fmt.Errorf("is not a %T a runtime.Object, cannot call SetControllerReference", owner)
+	}
+
+	gvk, err := apiutil.GVKForObject(ro, s)
+	if err != nil {
+		return err
+	}
+
+	// Create a new ref
+	ref := *v1.NewControllerRef(owner, schema.GroupVersionKind{Group: gvk.Group, Version: gvk.Version, Kind: gvk.Kind})
+
+	// Add it to the child
+	object.SetOwnerReferences(append(object.GetOwnerReferences(), ref))
+	return nil
+}
+
 func (cm *controllerManager) Start(stop <-chan struct{}) error {
 	func() {
 		cm.mu.Lock()

pkg/manager/manager.go

@@ -20,6 +20,7 @@ import (
 	"fmt"
 
 	"k8s.io/apimachinery/pkg/api/meta"
+	"k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/client-go/kubernetes/scheme"
 	"k8s.io/client-go/rest"
@@ -63,6 +64,11 @@ type Manager interface {
 
 	// GetRecorder returns a new EventRecorder for the provided name
 	GetRecorder(name string) record.EventRecorder
+
+	// SetControllerReference sets owner as a Controller OwnerReference on owned.
+	// This is used for garbage collection of the owned object and for
+	// reconciling the owner object on changes to owned (with a Watch + EnqueueOwner).
+	SetControllerReference(owner, owned v1.Object) error
 }
 
 // Options are the arguments for creating a new Manager

pkg/manager/manager_test.go

@@ -21,7 +21,10 @@ import (
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+	appsv1 "k8s.io/api/apps/v1"
+	extensionsv1beta1 "k8s.io/api/extensions/v1beta1"
 	"k8s.io/apimachinery/pkg/api/meta"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/client-go/rest"
 	"sigs.k8s.io/controller-runtime/pkg/cache"
@@ -43,6 +46,45 @@ var _ = Describe("manger.Manager", func() {
 		close(stop)
 	})
 
+	Describe("SetControllerReference", func() {
+		It("should set the OwnerReference if it can find the group version kind", func() {
+			m, err := New(cfg, Options{})
+			Expect(err).NotTo(HaveOccurred())
+
+			rs := &appsv1.ReplicaSet{}
+			dep := &extensionsv1beta1.Deployment{
+				ObjectMeta: metav1.ObjectMeta{Name: "foo", UID: "foo-uid"},
+			}
+			Expect(m.SetControllerReference(dep, rs)).NotTo(HaveOccurred())
+			t := true
+			Expect(rs.OwnerReferences).To(ConsistOf(metav1.OwnerReference{
+				Name:               "foo",
+				Kind:               "Deployment",
+				APIVersion:         "extensions/v1beta1",
+				UID:                "foo-uid",
+				Controller:         &t,
+				BlockOwnerDeletion: &t,
+			}))
+		})
+
+		It("should return an error if it can't find the group version kind of the owner", func() {
+			m, err := New(cfg, Options{Scheme: runtime.NewScheme()})
+			Expect(err).NotTo(HaveOccurred())
+			rs := &appsv1.ReplicaSet{}
+			dep := &extensionsv1beta1.Deployment{
+				ObjectMeta: metav1.ObjectMeta{Name: "foo"},
+			}
+			Expect(m.SetControllerReference(dep, rs)).To(HaveOccurred())
+		})
+
+		It("should return an error if the owner isn't a runtime.Object", func() {
+			m, err := New(cfg, Options{Scheme: runtime.NewScheme()})
+			Expect(err).NotTo(HaveOccurred())
+			rs := &appsv1.ReplicaSet{}
+			Expect(m.SetControllerReference(&errMetaObj{}, rs)).To(HaveOccurred())
+		})
+	})
+
 	Describe("New", func() {
 		It("should return an error if there is no Config", func() {
 			m, err := New(nil, Options{})
@@ -382,6 +424,12 @@ var _ = Describe("manger.Manager", func() {
 	})
 })
 
+var _ metav1.Object = &errMetaObj{}
+
+type errMetaObj struct {
+	metav1.ObjectMeta
+}
+
 var _ reconcile.Reconcile = &failRec{}
 var _ inject.Client = &failRec{}