Merge pull request #280 from tomasaschan/add-annotations

Add AddAnnotations companion to AddLabels

Author: k8s-ci-robot

pkg/patterns/declarative/annotations.go

@@ -0,0 +1,21 @@
+package declarative
+
+import (
+	"context"
+
+	"sigs.k8s.io/controller-runtime/pkg/log"
+	"sigs.k8s.io/kubebuilder-declarative-pattern/pkg/patterns/declarative/pkg/manifest"
+)
+
+// AddAnnotations returns an ObjectTransform that adds annotations to all the objects
+func AddAnnotations(annotations map[string]string) ObjectTransform {
+	return func(ctx context.Context, o DeclarativeObject, manifest *manifest.Objects) error {
+		log := log.Log
+		for _, o := range manifest.Items {
+			log.WithValues("object", o).WithValues("annotations", annotations).V(1).Info("add annotations to object")
+			o.AddAnnotations(annotations)
+		}
+
+		return nil
+	}
+}

pkg/patterns/declarative/pkg/manifest/objects.go

@@ -95,6 +95,21 @@ func (o *Object) AddLabels(labels map[string]string) {
 	o.json = nil
 }
 
+func (o *Object) AddAnnotations(annotations map[string]string) {
+	merged := make(map[string]string)
+	for k, v := range o.object.GetAnnotations() {
+		merged[k] = v
+	}
+
+	for k, v := range annotations {
+		merged[k] = v
+	}
+
+	o.object.SetAnnotations(merged)
+	// Invalidate cached json
+	o.json = nil
+}
+
 func (o *Object) GetNamespace() string {
 	return o.namespace
 }

pkg/patterns/declarative/pkg/manifest/objects_test.go

@@ -281,6 +281,69 @@ spec:
 	}
 }
 
+func Test_AddAnnotations(t *testing.T) {
+	inputManifest := `---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  annotations:
+    app: test-app
+  name: frontend
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: test-app
+  strategy: {}
+  template:
+    metadata:
+      labels:
+        app: test-app
+    spec:
+      containers:
+      - image: busybox
+        name: busybox`
+	tests := []struct {
+		name                string
+		inputManifest       string
+		inputAnnotations    map[string]string
+		expectedAnnotations map[string]string
+	}{
+		{
+			name:                "add annotations which are all new one",
+			inputManifest:       inputManifest,
+			inputAnnotations:    map[string]string{"sample-key1": "sample-value1", "sample-key2": "sample-value2"},
+			expectedAnnotations: map[string]string{"app": "test-app", "sample-key1": "sample-value1", "sample-key2": "sample-value2"},
+		},
+		{
+			// If call AddAnnotations with a key which has exists already, value will be overwritten.
+			name:                "add annotations which has already exist in manifest",
+			inputManifest:       inputManifest,
+			inputAnnotations:    map[string]string{"app": "test-app2"},
+			expectedAnnotations: map[string]string{"app": "test-app2"},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			ctx := context.Background()
+			objects, err := ParseObjects(ctx, tt.inputManifest)
+			if err != nil {
+				t.Fatalf("unexpected error: %v", err)
+			}
+			for _, o := range objects.Items {
+				o.AddAnnotations(tt.inputAnnotations)
+				if len(tt.expectedAnnotations) != len(o.object.GetAnnotations()) {
+					t.Errorf("Expected length of labels to be %v but is %v", len(tt.expectedAnnotations), len(o.object.GetAnnotations()))
+				}
+				if diff := cmp.Diff(tt.expectedAnnotations, o.object.GetAnnotations()); diff != "" {
+					t.Fatalf("result mismatch (-want +got):\n%s", diff)
+				}
+			}
+		})
+	}
+}
+
 func Test_ParseJSONToObject(t *testing.T) {
 	tests := []struct {
 		name           string