Merge pull request #197 from jnummelin/fix/copy-svc-annotations

Copy both Cluster and Cluster.spec.service.annotations to created svc

Author: jnummelin

internal/controller/k0smotron.io/k0smotroncluster_service.go

@@ -69,6 +69,15 @@ func (r *ClusterReconciler) generateService(kmc *km.Cluster) v1.Service {
 
 	labels := labelsForCluster(kmc)
 
+	// Copy both Cluster level annotations and Service annotations
+	annotations := map[string]string{}
+	for k, v := range annotationsForCluster(kmc) {
+		annotations[k] = v
+	}
+	for k, v := range kmc.Spec.Service.Annotations {
+		annotations[k] = v
+	}
+
 	svc := v1.Service{
 		TypeMeta: metav1.TypeMeta{
 			APIVersion: "v1",
@@ -78,7 +87,7 @@ func (r *ClusterReconciler) generateService(kmc *km.Cluster) v1.Service {
 			Name:        name,
 			Namespace:   kmc.Namespace,
 			Labels:      labels,
-			Annotations: annotationsForCluster(kmc),
+			Annotations: annotations,
 		},
 		Spec: v1.ServiceSpec{
 			Type:     kmc.Spec.Service.Type,
@@ -87,8 +96,6 @@ func (r *ClusterReconciler) generateService(kmc *km.Cluster) v1.Service {
 		},
 	}
 
-	_ = ctrl.SetControllerReference(kmc, &svc, r.Scheme)
-
 	return svc
 }
 
@@ -98,6 +105,8 @@ func (r *ClusterReconciler) reconcileServices(ctx context.Context, kmc km.Cluste
 	logger.Info("Reconciling services")
 	svc := r.generateService(&kmc)
 
+	_ = ctrl.SetControllerReference(&kmc, &svc, r.Scheme)
+
 	if err := r.Client.Patch(ctx, &svc, client.Apply, patchOpts...); err != nil {
 		return err
 	}

internal/controller/k0smotron.io/k0smotroncluster_service_test.go

@@ -19,8 +19,10 @@ package k0smotronio
 import (
 	"testing"
 
+	km "github.com/k0sproject/k0smotron/api/k0smotron.io/v1beta1"
 	"github.com/stretchr/testify/assert"
 	v1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 func TestClusterReconciler_findNodeAddress(t *testing.T) {
@@ -127,3 +129,88 @@ func TestClusterReconciler_findNodeAddress(t *testing.T) {
 		})
 	}
 }
+
+func TestClusterReconciler_serviceAnnotations(t *testing.T) {
+	tests := []struct {
+		name string
+		kmc  *km.Cluster
+		want map[string]string
+	}{
+		{
+			name: "when no annotations are set on either Cluster on svc",
+			kmc: &km.Cluster{
+				ObjectMeta: metav1.ObjectMeta{
+					Name: "test",
+				},
+				Spec: km.ClusterSpec{},
+			},
+			want: map[string]string{},
+		},
+		{
+			name: "when annotations are set on only Cluster",
+			kmc: &km.Cluster{
+				ObjectMeta: metav1.ObjectMeta{
+					Name: "test",
+					Annotations: map[string]string{
+						"test": "test",
+					},
+				},
+				Spec: km.ClusterSpec{},
+			},
+			want: map[string]string{
+				"test": "test",
+			},
+		},
+		{
+			name: "when annotations are set on both Cluster and svc",
+			kmc: &km.Cluster{
+				ObjectMeta: metav1.ObjectMeta{
+					Name: "test",
+					Annotations: map[string]string{
+						"test": "test",
+					},
+				},
+				Spec: km.ClusterSpec{
+					Service: km.ServiceSpec{
+						Annotations: map[string]string{
+							"foo": "bar",
+						},
+					},
+				},
+			},
+			want: map[string]string{
+				"test": "test",
+				"foo":  "bar",
+			},
+		},
+		{
+			name: "when same annotation is set on both Cluster and svc the svc annotation wins",
+			kmc: &km.Cluster{
+				ObjectMeta: metav1.ObjectMeta{
+					Name: "test",
+					Annotations: map[string]string{
+						"test": "test",
+					},
+				},
+				Spec: km.ClusterSpec{
+					Service: km.ServiceSpec{
+						Annotations: map[string]string{
+							"test": "foobar",
+						},
+					},
+				},
+			},
+			want: map[string]string{
+				"test": "foobar",
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			r := &ClusterReconciler{}
+			svc := r.generateService(tt.kmc)
+			got := svc.Annotations
+			assert.Equal(t, tt.want, got)
+		})
+	}
+}