DRY up resource mock production in recon test

There was a lot of repetitive code in the pkg/runtime/reconciler_test.go
unit test file around construction of the CR mocks and the k8s
apimachinery meta object and k8s runtime object mocks.

This patch adds a utility function `resourceMocks` that returns a tuple
of the resource mock, the k8s runtime object mock, and the meta object
associated with that k8s runtime object/resource.

This allows unit tests to reduce the amount of boilerplate code
substantially and focus on the specific differences to those mocks that
impact the code behaviour under test.

Author: jaypipes

pkg/runtime/reconciler_test.go

@@ -38,15 +38,11 @@ import (
 	ackmocks "github.com/aws-controllers-k8s/runtime/mocks/pkg/types"
 )
 
-func TestReconcilerUpdate(t *testing.T) {
-	require := require.New(t)
-
-	ctx := context.TODO()
-	arn := ackv1alpha1.AWSResourceName("mybook-arn")
-
-	delta := ackcompare.NewDelta()
-	delta.Add("Spec.A", "val1", "val2")
-
+func resourceMocks() (
+	*ackmocks.AWSResource, // mocked resource
+	*k8srtmocks.Object, // mocked k8s controller-runtime RuntimeObject
+	*k8sobj.Unstructured, // NON-mocked k8s apimachinery meta object
+) {
 	objKind := &k8srtschemamocks.ObjectKind{}
 	objKind.On("GroupVersionKind").Return(
 		k8srtschema.GroupVersionKind{
@@ -56,38 +52,40 @@ func TestReconcilerUpdate(t *testing.T) {
 		},
 	)
 
-	desiredRTObj := &k8srtmocks.Object{}
-	desiredRTObj.On("GetObjectKind").Return(objKind)
-	desiredRTObj.On("DeepCopyObject").Return(desiredRTObj)
+	rtObj := &k8srtmocks.Object{}
+	rtObj.On("GetObjectKind").Return(objKind)
+	rtObj.On("DeepCopyObject").Return(rtObj)
 
-	desiredMetaObj := &k8sobj.Unstructured{}
-	desiredMetaObj.SetAnnotations(map[string]string{})
-	desiredMetaObj.SetNamespace("default")
-	desiredMetaObj.SetName("mybook")
-	desiredMetaObj.SetGeneration(int64(1))
+	metaObj := &k8sobj.Unstructured{}
+	metaObj.SetAnnotations(map[string]string{})
+	metaObj.SetNamespace("default")
+	metaObj.SetName("mybook")
+	metaObj.SetGeneration(int64(1))
 
-	desired := &ackmocks.AWSResource{}
-	desired.On("MetaObject").Return(desiredMetaObj)
-	desired.On("RuntimeObject").Return(desiredRTObj)
+	res := &ackmocks.AWSResource{}
+	res.On("MetaObject").Return(metaObj)
+	res.On("RuntimeObject").Return(rtObj)
 
-	ids := &ackmocks.AWSResourceIdentifiers{}
-	ids.On("ARN").Return(&arn)
+	return res, rtObj, metaObj
+}
+
+func TestReconcilerUpdate(t *testing.T) {
+	require := require.New(t)
 
-	latestRTObj := &k8srtmocks.Object{}
-	latestRTObj.On("GetObjectKind").Return(objKind)
-	latestRTObj.On("DeepCopyObject").Return(latestRTObj)
+	ctx := context.TODO()
+	arn := ackv1alpha1.AWSResourceName("mybook-arn")
+
+	delta := ackcompare.NewDelta()
+	delta.Add("Spec.A", "val1", "val2")
 
-	latestMetaObj := &k8sobj.Unstructured{}
-	latestMetaObj.SetAnnotations(map[string]string{})
-	latestMetaObj.SetNamespace("default")
-	latestMetaObj.SetName("mybook")
-	latestMetaObj.SetGeneration(int64(1))
+	desired, desiredRTObj, _ := resourceMocks()
 
-	latest := &ackmocks.AWSResource{}
+	ids := &ackmocks.AWSResourceIdentifiers{}
+	ids.On("ARN").Return(&arn)
+
+	latest, latestRTObj, _ := resourceMocks()
 	latest.On("Identifiers").Return(ids)
 	latest.On("Conditions").Return([]*ackv1alpha1.Condition{})
-	latest.On("MetaObject").Return(latestMetaObj)
-	latest.On("RuntimeObject").Return(latestRTObj)
 
 	rd := &ackmocks.AWSResourceDescriptor{}
 	rd.On("GroupKind").Return(
@@ -163,48 +161,17 @@ func TestReconcilerUpdate_PatchMetadataAndSpec_DiffInMetadata(t *testing.T) {
 	delta := ackcompare.NewDelta()
 	delta.Add("Spec.A", "val1", "val2")
 
-	objKind := &k8srtschemamocks.ObjectKind{}
-	objKind.On("GroupVersionKind").Return(
-		k8srtschema.GroupVersionKind{
-			Group:   "bookstore.services.k8s.aws",
-			Kind:    "Book",
-			Version: "v1alpha1",
-		},
-	)
-
-	desiredRTObj := &k8srtmocks.Object{}
-	desiredRTObj.On("GetObjectKind").Return(objKind)
-	desiredRTObj.On("DeepCopyObject").Return(desiredRTObj)
-
-	desiredMetaObj := &k8sobj.Unstructured{}
-	desiredMetaObj.SetAnnotations(map[string]string{})
-	desiredMetaObj.SetNamespace("default")
-	desiredMetaObj.SetName("mybook")
-	desiredMetaObj.SetGeneration(int64(1))
-
-	desired := &ackmocks.AWSResource{}
-	desired.On("MetaObject").Return(desiredMetaObj)
-	desired.On("RuntimeObject").Return(desiredRTObj)
+	desired, desiredRTObj, _ := resourceMocks()
 
 	ids := &ackmocks.AWSResourceIdentifiers{}
 	ids.On("ARN").Return(&arn)
 
-	latestRTObj := &k8srtmocks.Object{}
-	latestRTObj.On("GetObjectKind").Return(objKind)
-	latestRTObj.On("DeepCopyObject").Return(latestRTObj)
+	latest, latestRTObj, latestMetaObj := resourceMocks()
+	latest.On("Identifiers").Return(ids)
+	latest.On("Conditions").Return([]*ackv1alpha1.Condition{})
 
-	latestMetaObj := &k8sobj.Unstructured{}
 	// Note the change in annotaions
 	latestMetaObj.SetAnnotations(map[string]string{"a": "b"})
-	latestMetaObj.SetNamespace("default")
-	latestMetaObj.SetName("mybook")
-	latestMetaObj.SetGeneration(int64(1))
-
-	latest := &ackmocks.AWSResource{}
-	latest.On("Identifiers").Return(ids)
-	latest.On("Conditions").Return([]*ackv1alpha1.Condition{})
-	latest.On("MetaObject").Return(latestMetaObj)
-	latest.On("RuntimeObject").Return(latestRTObj)
 
 	rd := &ackmocks.AWSResourceDescriptor{}
 	rd.On("GroupKind").Return(
@@ -280,48 +247,15 @@ func TestReconcilerUpdate_PatchMetadataAndSpec_DiffInSpec(t *testing.T) {
 	delta := ackcompare.NewDelta()
 	delta.Add("Spec.A", "val1", "val2")
 
-	objKind := &k8srtschemamocks.ObjectKind{}
-	objKind.On("GroupVersionKind").Return(
-		k8srtschema.GroupVersionKind{
-			Group:   "bookstore.services.k8s.aws",
-			Kind:    "Book",
-			Version: "v1alpha1",
-		},
-	)
-
-	desiredRTObj := &k8srtmocks.Object{}
-	desiredRTObj.On("GetObjectKind").Return(objKind)
-	desiredRTObj.On("DeepCopyObject").Return(desiredRTObj)
-
-	desiredMetaObj := &k8sobj.Unstructured{}
-	desiredMetaObj.SetAnnotations(map[string]string{})
-	desiredMetaObj.SetNamespace("default")
-	desiredMetaObj.SetName("mybook")
-	desiredMetaObj.SetGeneration(int64(1))
-
-	desired := &ackmocks.AWSResource{}
-	desired.On("MetaObject").Return(desiredMetaObj)
-	desired.On("RuntimeObject").Return(desiredRTObj)
+	desired, desiredRTObj, _ := resourceMocks()
 
 	ids := &ackmocks.AWSResourceIdentifiers{}
 	ids.On("ARN").Return(&arn)
 
-	latestRTObj := &k8srtmocks.Object{}
-	latestRTObj.On("GetObjectKind").Return(objKind)
-	latestRTObj.On("DeepCopyObject").Return(latestRTObj)
-
-	latestMetaObj := &k8sobj.Unstructured{}
-	// Note Similar metadata
-	latestMetaObj.SetAnnotations(map[string]string{})
-	latestMetaObj.SetNamespace("default")
-	latestMetaObj.SetName("mybook")
-	latestMetaObj.SetGeneration(int64(1))
-
-	latest := &ackmocks.AWSResource{}
+	latest, latestRTObj, _ := resourceMocks()
 	latest.On("Identifiers").Return(ids)
 	latest.On("Conditions").Return([]*ackv1alpha1.Condition{})
-	latest.On("MetaObject").Return(latestMetaObj)
-	latest.On("RuntimeObject").Return(latestRTObj)
+	// Note no change to metadata...
 
 	rd := &ackmocks.AWSResourceDescriptor{}
 	rd.On("GroupKind").Return(