Support inherited annotations for all major objects (#1236)

* add comments where inherited annotations could be added * add inheritedAnnotations feature * return nil if no annotations are set * minor changes * first downscaler then inherited annotations * add unit test for inherited annotations * add pvc to test + minor changes * missing comma * fix nil map assignment * set annotations in the same order it is done in other places * replace acidClientSet with acid getters in K8s client * more fixes on clientSet vs getters * minor changes * remove endpoints from annotation test * refine unit test - but deployment and sts are still empty * fix checkinng sts and deployment * make annotations setter one liners * no need for len check anymore Co-authored-by: Rafia Sabih <rafia.sabih@zalando.de>
2026-10-21 12:59:54 +02:00 · 2020-12-11 16:34:01 +01:00
parent 549f71bb49
commit 6a97316a69
23 changed files with 288 additions and 55 deletions
@@ -0,0 +1,141 @@
+package cluster
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	acidv1 "github.com/zalando/postgres-operator/pkg/apis/acid.zalan.do/v1"
+	fakeacidv1 "github.com/zalando/postgres-operator/pkg/generated/clientset/versioned/fake"
+	"github.com/zalando/postgres-operator/pkg/util"
+	"github.com/zalando/postgres-operator/pkg/util/config"
+	"github.com/zalando/postgres-operator/pkg/util/k8sutil"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	k8sFake "k8s.io/client-go/kubernetes/fake"
+)
+
+func newFakeK8sAnnotationsClient() (k8sutil.KubernetesClient, *k8sFake.Clientset) {
+	clientSet := k8sFake.NewSimpleClientset()
+	acidClientSet := fakeacidv1.NewSimpleClientset()
+
+	return k8sutil.KubernetesClient{
+		PodDisruptionBudgetsGetter: clientSet.PolicyV1beta1(),
+		ServicesGetter:             clientSet.CoreV1(),
+		StatefulSetsGetter:         clientSet.AppsV1(),
+		PostgresqlsGetter:          acidClientSet.AcidV1(),
+	}, clientSet
+}
+
+func TestInheritedAnnotations(t *testing.T) {
+	testName := "test inheriting annotations from manifest"
+	client, _ := newFakeK8sAnnotationsClient()
+	clusterName := "acid-test-cluster"
+	namespace := "default"
+	annotationValue := "acid"
+	role := Master
+
+	pg := acidv1.Postgresql{
+		ObjectMeta: metav1.ObjectMeta{
+			Name: clusterName,
+			Annotations: map[string]string{
+				"owned-by": annotationValue,
+			},
+		},
+		Spec: acidv1.PostgresSpec{
+			EnableReplicaConnectionPooler: boolToPointer(true),
+			Volume: acidv1.Volume{
+				Size: "1Gi",
+			},
+		},
+	}
+
+	var cluster = New(
+		Config{
+			OpConfig: config.Config{
+				ConnectionPooler: config.ConnectionPooler{
+					ConnectionPoolerDefaultCPURequest:    "100m",
+					ConnectionPoolerDefaultCPULimit:      "100m",
+					ConnectionPoolerDefaultMemoryRequest: "100Mi",
+					ConnectionPoolerDefaultMemoryLimit:   "100Mi",
+					NumberOfInstances:                    int32ToPointer(1),
+				},
+				PodManagementPolicy: "ordered_ready",
+				Resources: config.Resources{
+					ClusterLabels:        map[string]string{"application": "spilo"},
+					ClusterNameLabel:     "cluster-name",
+					DefaultCPURequest:    "300m",
+					DefaultCPULimit:      "300m",
+					DefaultMemoryRequest: "300Mi",
+					DefaultMemoryLimit:   "300Mi",
+					InheritedAnnotations: []string{"owned-by"},
+					PodRoleLabel:         "spilo-role",
+				},
+			},
+		}, client, pg, logger, eventRecorder)
+
+	cluster.Name = clusterName
+	cluster.Namespace = namespace
+
+	// test annotationsSet function
+	inheritedAnnotations := cluster.annotationsSet(nil)
+
+	listOptions := metav1.ListOptions{
+		LabelSelector: cluster.labelsSet(false).String(),
+	}
+
+	// check statefulset annotations
+	_, err := cluster.createStatefulSet()
+	assert.NoError(t, err)
+
+	stsList, err := client.StatefulSets(namespace).List(context.TODO(), listOptions)
+	assert.NoError(t, err)
+	for _, sts := range stsList.Items {
+		if !(util.MapContains(sts.ObjectMeta.Annotations, inheritedAnnotations)) {
+			t.Errorf("%s: StatefulSet %v not inherited annotations %#v, got %#v", testName, sts.ObjectMeta.Name, inheritedAnnotations, sts.ObjectMeta.Annotations)
+		}
+		// pod template
+		if !(util.MapContains(sts.Spec.Template.ObjectMeta.Annotations, inheritedAnnotations)) {
+			t.Errorf("%s: pod template %v not inherited annotations %#v, got %#v", testName, sts.ObjectMeta.Name, inheritedAnnotations, sts.ObjectMeta.Annotations)
+		}
+		// pvc template
+		if util.MapContains(sts.Spec.VolumeClaimTemplates[0].Annotations, inheritedAnnotations) {
+			t.Errorf("%s: PVC template %v not expected to have inherited annotations %#v, got %#v", testName, sts.ObjectMeta.Name, inheritedAnnotations, sts.ObjectMeta.Annotations)
+		}
+	}
+
+	// check service annotations
+	cluster.createService(Master)
+	svcList, err := client.Services(namespace).List(context.TODO(), listOptions)
+	assert.NoError(t, err)
+	for _, svc := range svcList.Items {
+		if !(util.MapContains(svc.ObjectMeta.Annotations, inheritedAnnotations)) {
+			t.Errorf("%s: Service %v not inherited annotations %#v, got %#v", testName, svc.ObjectMeta.Name, inheritedAnnotations, svc.ObjectMeta.Annotations)
+		}
+	}
+
+	// check pod disruption budget annotations
+	cluster.createPodDisruptionBudget()
+	pdbList, err := client.PodDisruptionBudgets(namespace).List(context.TODO(), listOptions)
+	assert.NoError(t, err)
+	for _, pdb := range pdbList.Items {
+		if !(util.MapContains(pdb.ObjectMeta.Annotations, inheritedAnnotations)) {
+			t.Errorf("%s: Pod Disruption Budget %v not inherited annotations %#v, got %#v", testName, pdb.ObjectMeta.Name, inheritedAnnotations, pdb.ObjectMeta.Annotations)
+		}
+	}
+
+	// check pooler deployment annotations
+	cluster.ConnectionPooler = map[PostgresRole]*ConnectionPoolerObjects{}
+	cluster.ConnectionPooler[role] = &ConnectionPoolerObjects{
+		Name:        cluster.connectionPoolerName(role),
+		ClusterName: cluster.ClusterName,
+		Namespace:   cluster.Namespace,
+		Role:        role,
+	}
+	deploy, err := cluster.generateConnectionPoolerDeployment(cluster.ConnectionPooler[role])
+	assert.NoError(t, err)
+
+	if !(util.MapContains(deploy.ObjectMeta.Annotations, inheritedAnnotations)) {
+		t.Errorf("%s: Deployment %v not inherited annotations %#v, got %#v", testName, deploy.ObjectMeta.Name, inheritedAnnotations, deploy.ObjectMeta.Annotations)
+	}
+
+}