SaveAnnotations and test

controllers/ingress.go

@@ -4,6 +4,8 @@ import (
 	"context"
 	"reflect"
 
+	"github.com/AbsaOSS/k8gb/controllers/internal/utils"
+
 	k8gbv1beta1 "github.com/AbsaOSS/k8gb/api/v1beta1"
 	v1beta1 "k8s.io/api/extensions/v1beta1"
 	"k8s.io/apimachinery/pkg/api/errors"
@@ -64,10 +66,11 @@ func (r *GslbReconciler) saveIngress(instance *k8gbv1beta1.Gslb, i *v1beta1.Ingr
 	// Update existing object with new spec and annotations
 	if !ingressCompare(found, i) {
 		found.Spec = i.Spec
-		found.Annotations = i.Annotations
+		found.Annotations = utils.SaveAnnotations(found.Annotations, i.Annotations)
 		err = r.Update(context.TODO(), found)
 		if errors.IsConflict(err) {
-			r.Log.Info("CONFLICT, Ingress updated by third-party")
+			r.Log.Info("Ingress has been modified outside of controller, retrying reconciliation",
+				"Ingress.Namespace", found.Namespace, "Ingress.Name", found.Name)
 			return nil
 		}
 		if err != nil {

controllers/internal/utils/annotations.go

@@ -0,0 +1,17 @@
+package utils
+
+// SaveAnnotations adds or updates annotations from a2 from a1 and returns merge
+func SaveAnnotations(a1 map[string]string, a2 map[string]string) map[string]string {
+	if a1 == nil {
+		a1 = make(map[string]string)
+	}
+	if a2 == nil {
+		a2 = make(map[string]string)
+	}
+	for k, v := range a2 {
+		if a1[k] != v {
+			a1[k] = v
+		}
+	}
+	return a1
+}

controllers/internal/utils/annotations_test.go

@@ -0,0 +1,73 @@
+package utils
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+var a2 = map[string]string{"k8gb.io/primary-geotag": "eu", "k8gb.io/strategy": "failover"}
+var a1 = map[string]string{"field.cattle.io/publicEndpoints": "dummy"}
+
+func TestAddNewAnnotations(t *testing.T) {
+	// arrange
+	// act
+	repaired := SaveAnnotations(a1, a2)
+	// assert
+	assert.Equal(t, 3, len(repaired))
+	assert.Equal(t, "eu", repaired["k8gb.io/primary-geotag"])
+	assert.Equal(t, "dummy", repaired["field.cattle.io/publicEndpoints"])
+}
+
+func TestAddExistingAnnotations(t *testing.T) {
+	// arrange
+	for k, v := range a2 {
+		a1[k] = v
+	}
+	// act
+	repaired := SaveAnnotations(a1, a2)
+	// assert
+	assert.Equal(t, 3, len(repaired))
+	assert.Equal(t, "eu", repaired["k8gb.io/primary-geotag"])
+	assert.Equal(t, "dummy", repaired["field.cattle.io/publicEndpoints"])
+	assert.Equal(t, "failover", repaired["k8gb.io/strategy"])
+}
+
+func TestUpdateExistingRecords(t *testing.T) {
+	// arrange
+	for k, v := range a2 {
+		a1[k] = v
+	}
+	a1["k8gb.io/primary-geotag"] = "us"
+	// act
+	repaired := SaveAnnotations(a1, a2)
+	// assert
+	assert.Equal(t, 3, len(repaired))
+	assert.Equal(t, "eu", repaired["k8gb.io/primary-geotag"])
+	assert.Equal(t, "dummy", repaired["field.cattle.io/publicEndpoints"])
+	assert.Equal(t, "failover", repaired["k8gb.io/strategy"])
+}
+
+func TestEqualAnnotationsWithNilA1(t *testing.T) {
+	// arrange
+	// act
+	repaired := SaveAnnotations(nil, a2)
+	// assert
+	assert.True(t, assert.ObjectsAreEqual(a2, repaired))
+}
+
+func TestEqualAnnotationsWithNilA2(t *testing.T) {
+	// arrange
+	// act
+	repaired := SaveAnnotations(a1, nil)
+	// assert
+	assert.True(t, assert.ObjectsAreEqual(a1, repaired))
+}
+
+func TestEqualAnnotationsWithNilInput(t *testing.T) {
+	// arrange
+	// act
+	repaired := SaveAnnotations(nil, nil)
+	// assert
+	assert.Equal(t, 0, len(repaired))
+}