test: add test to ensure commonLabels do not overwrite standard labels

Author: vrutkovs

internal/controller/operator/factory/build/defaults_test.go

@@ -4,6 +4,8 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/utils/ptr"
 
 	vmv1 "github.com/VictoriaMetrics/operator/api/operator/v1"
@@ -549,3 +551,42 @@ func TestClusterComponentVersionDefaults(t *testing.T) {
 		})
 	}
 }
+
+func TestAddDefaultMetadata(t *testing.T) {
+	cfg := config.MustGetBaseConfig()
+	defaultCfg := *cfg
+	defer func() {
+		*config.MustGetBaseConfig() = defaultCfg
+	}()
+
+	cfg.CommonLabels = map[string]string{
+		"common-label":   "common-value",
+		"existing-label": "should-not-overwrite",
+	}
+	cfg.CommonAnnotations = map[string]string{
+		"common-annotation":   "common-value",
+		"existing-annotation": "should-not-overwrite",
+	}
+
+	obj := &corev1.Pod{
+		ObjectMeta: metav1.ObjectMeta{
+			Labels: map[string]string{
+				"existing-label": "existing-value",
+			},
+			Annotations: map[string]string{
+				"existing-annotation": "existing-value",
+			},
+		},
+	}
+
+	addDefaultMetadata(obj)
+
+	assert.Equal(t, map[string]string{
+		"common-label":   "common-value",
+		"existing-label": "existing-value",
+	}, obj.Labels)
+	assert.Equal(t, map[string]string{
+		"common-annotation":   "common-value",
+		"existing-annotation": "existing-value",
+	}, obj.Annotations)
+}

internal/controller/operator/factory/vmsingle/vmsingle_test.go

@@ -158,6 +158,35 @@ func TestCreateOrUpdate(t *testing.T) {
 			}, got.Labels)
 			assert.Equal(t, map[string]string{"controller": "true"}, got.Annotations)
 		}})
+
+	// common labels cannot overwrite standard labels
+	f(opts{
+		cfgMutator: func(c *config.BaseOperatorConf) {
+			c.CommonLabels = map[string]string{
+				"env":                         "prod",
+				"app.kubernetes.io/name":      "hacked",
+				"app.kubernetes.io/instance":  "hacked",
+				"app.kubernetes.io/component": "hacked",
+				"managed-by":                  "hacked",
+			}
+		},
+		cr: &vmv1beta1.VMSingle{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "base",
+				Namespace: "default",
+			},
+		},
+		validate: func(ctx context.Context, rclient client.Client, cr *vmv1beta1.VMSingle) {
+			var got appsv1.Deployment
+			assert.NoError(t, rclient.Get(ctx, types.NamespacedName{Namespace: cr.Namespace, Name: cr.PrefixedName()}, &got))
+			assert.Equal(t, map[string]string{
+				"env":                         "prod",
+				"app.kubernetes.io/name":      "vmsingle",
+				"app.kubernetes.io/instance":  "base",
+				"app.kubernetes.io/component": "monitoring",
+				"managed-by":                  "vm-operator",
+			}, got.Labels)
+		}})
 }
 
 func TestCreateOrUpdateService(t *testing.T) {