Adds tagUpdating API for parametergroup. (#39)

kyriechen96 · web-flow · commit d078b748470b · 2022-12-13T15:22:35.000-08:00
Issue #, if available:
Controller doesn't support customers to update tags of parameter group after creation.

Description of changes:
Adds API to let customers update tags of parameter group.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
diff --git a/apis/v1alpha1/ack-generate-metadata.yaml b/apis/v1alpha1/ack-generate-metadata.yaml
@@ -1,13 +1,13 @@
 ack_generate_info:
-  build_date: "2022-12-08T19:08:31Z"
-  build_hash: 12246c7da82841b351ec7a9e1f139f9338f2784b
-  go_version: go1.17.5
-  version: v0.21.0
+  build_date: "2022-12-13T17:51:08Z"
+  build_hash: 16f0e201b37a06b535370cc69e11adb934a22d33
+  go_version: go1.19
+  version: v0.20.1-18-g16f0e20
 api_directory_checksum: a1e396caca4bdd1612fa7d09f0ee56f3e4976ff7
 api_version: v1alpha1
 aws_sdk_go_version: v1.44.93
 generator_config_info:
-  file_checksum: 24344616e89a51daae2b05f38438010f32995a4f
+  file_checksum: c20e176b6706e0a4c8db79814d1a1672ad760c81
   original_file_name: generator.yaml
 last_modification:
   reason: API generation
diff --git a/apis/v1alpha1/generator.yaml b/apis/v1alpha1/generator.yaml
@@ -258,9 +258,9 @@ resources:
       sdk_read_many_post_set_output:
         template_path: hooks/parametergroup/sdk_read_many_post_set_output.go.tpl
       sdk_create_post_set_output:
-        template_path: hooks/parametergroup/sdk_read_many_post_set_output.go.tpl
+        template_path: hooks/parametergroup/sdk_create_post_set_output.go.tpl
       sdk_update_post_set_output:
-        template_path: hooks/parametergroup/sdk_read_many_post_set_output.go.tpl
+        template_path: hooks/parametergroup/sdk_update_post_set_output.go.tpl
       sdk_update_pre_build_request:
         template_path: hooks/parametergroup/sdk_update_pre_build_request.go.tpl
     renames:
diff --git a/apis/v1alpha1/subnet_group.go b/apis/v1alpha1/subnet_group.go
diff --git a/apis/v1alpha1/types.go b/apis/v1alpha1/types.go
diff --git a/generator.yaml b/generator.yaml
@@ -258,9 +258,9 @@ resources:
       sdk_read_many_post_set_output:
         template_path: hooks/parametergroup/sdk_read_many_post_set_output.go.tpl
       sdk_create_post_set_output:
-        template_path: hooks/parametergroup/sdk_read_many_post_set_output.go.tpl
+        template_path: hooks/parametergroup/sdk_create_post_set_output.go.tpl
       sdk_update_post_set_output:
-        template_path: hooks/parametergroup/sdk_read_many_post_set_output.go.tpl
+        template_path: hooks/parametergroup/sdk_update_post_set_output.go.tpl
       sdk_update_pre_build_request:
         template_path: hooks/parametergroup/sdk_update_pre_build_request.go.tpl
     renames:
diff --git a/helm/crds/memorydb.services.k8s.aws_subnetgroups.yaml b/helm/crds/memorydb.services.k8s.aws_subnetgroups.yaml
@@ -34,8 +34,8 @@ spec:
             type: object
           spec:
             description: "SubnetGroupSpec defines the desired state of SubnetGroup.
-              \n Represents the output of one of the following operations: \n * CreateSubnetGroup
-              \n * UpdateSubnetGroup \n A subnet group is a collection of subnets
+              \n Represents the output of one of the following operations: \n - CreateSubnetGroup
+              \n - UpdateSubnetGroup \n A subnet group is a collection of subnets
               (typically private) that you can designate for your clusters running
               in an Amazon Virtual Private Cloud (VPC) environment."
             properties:
diff --git a/helm/templates/deployment.yaml b/helm/templates/deployment.yaml
@@ -89,7 +89,7 @@ spec:
           - name: {{ .Values.aws.credentials.secretName }}
             mountPath: {{ include "aws.credentials.secret_mount_path" . }}
             readOnly: true
-        {{- end }}          
+        {{- end }}
         securityContext:
           allowPrivilegeEscalation: false
           privileged: false
diff --git a/pkg/resource/parameter_group/hooks.go b/pkg/resource/parameter_group/hooks.go
@@ -15,10 +15,13 @@ package parameter_group
 
 import (
 	"context"
+
 	ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1"
+	ackerr "github.com/aws-controllers-k8s/runtime/pkg/errors"
+	ackrtlog "github.com/aws-controllers-k8s/runtime/pkg/runtime/log"
 
 	svcapitypes "github.com/aws-controllers-k8s/memorydb-controller/apis/v1alpha1"
-	ackerr "github.com/aws-controllers-k8s/runtime/pkg/errors"
+
 	svcsdk "github.com/aws/aws-sdk-go/service/memorydb"
 )
 
@@ -154,3 +157,123 @@ func (rm *resourceManager) resetAllParameters(
 	}
 	return &resource{ko}, nil
 }
+
+// getTags gets tags from given ParameterGroup.
+func (rm *resourceManager) getTags(
+	ctx context.Context,
+	resourceARN string,
+) ([]*svcapitypes.Tag, error) {
+	resp, err := rm.sdkapi.ListTagsWithContext(
+		ctx,
+		&svcsdk.ListTagsInput{
+			ResourceArn: &resourceARN,
+		},
+	)
+	rm.metrics.RecordAPICall("GET", "ListTags", err)
+	if err != nil {
+		return nil, err
+	}
+	tags := make([]*svcapitypes.Tag, 0, len(resp.TagList))
+	for _, tag := range resp.TagList {
+		tags = append(tags, &svcapitypes.Tag{
+			Key:   tag.Key,
+			Value: tag.Value,
+		})
+	}
+	return tags, nil
+}
+
+// updateTags updates tags of given ParameterGroup to desired tags.
+func (rm *resourceManager) updateTags(
+	ctx context.Context,
+	desired *resource,
+	latest *resource,
+) (err error) {
+	rlog := ackrtlog.FromContext(ctx)
+	exit := rlog.Trace("rm.syncTags")
+	defer func() { exit(err) }()
+
+	arn := (*string)(latest.ko.Status.ACKResourceMetadata.ARN)
+
+	toAdd, toDelete := computeTagsDelta(
+		desired.ko.Spec.Tags, latest.ko.Spec.Tags,
+	)
+
+	if len(toDelete) > 0 {
+		rlog.Debug("removing tags from parameter group", "tags", toDelete)
+		_, err = rm.sdkapi.UntagResourceWithContext(
+			ctx,
+			&svcsdk.UntagResourceInput{
+				ResourceArn: arn,
+				TagKeys:     toDelete,
+			},
+		)
+		rm.metrics.RecordAPICall("UPDATE", "UntagResource", err)
+		if err != nil {
+			return err
+		}
+	}
+
+	if len(toAdd) > 0 {
+		rlog.Debug("adding tags to parameter group", "tags", toAdd)
+		_, err = rm.sdkapi.TagResourceWithContext(
+			ctx,
+			&svcsdk.TagResourceInput{
+				ResourceArn: arn,
+				Tags:        sdkTagsFromResourceTags(toAdd),
+			},
+		)
+		rm.metrics.RecordAPICall("UPDATE", "TagResource", err)
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func computeTagsDelta(
+	desired []*svcapitypes.Tag,
+	latest []*svcapitypes.Tag,
+) (added []*svcapitypes.Tag, removed []*string) {
+	toDelete := []*string{}
+	toAdd := []*svcapitypes.Tag{}
+
+	desiredTags := map[string]string{}
+	key := ""
+	value := ""
+	for _, tag := range desired {
+		if tag.Key != nil {
+			key = *tag.Key
+			value = ""
+			if tag.Value != nil {
+				value = *tag.Value
+			}
+			desiredTags[key] = value
+		}
+	}
+
+	for _, tag := range desired {
+		toAdd = append(toAdd, tag)
+	}
+	for _, tag := range latest {
+		_, ok := desiredTags[*tag.Key]
+		if !ok {
+			toDelete = append(toDelete, tag.Key)
+		}
+	}
+	return toAdd, toDelete
+}
+
+func sdkTagsFromResourceTags(
+	rTags []*svcapitypes.Tag,
+) []*svcsdk.Tag {
+	tags := make([]*svcsdk.Tag, len(rTags))
+	for i := range rTags {
+		tags[i] = &svcsdk.Tag{
+			Key:   rTags[i].Key,
+			Value: rTags[i].Value,
+		}
+	}
+	return tags
+}
diff --git a/pkg/resource/parameter_group/sdk.go b/pkg/resource/parameter_group/sdk.go
diff --git a/templates/hooks/parametergroup/sdk_create_post_set_output.go.tpl b/templates/hooks/parametergroup/sdk_create_post_set_output.go.tpl
@@ -0,0 +1,5 @@
+    ko, err = rm.setParameters(ctx, ko)
+
+    if err != nil {
+        return nil, err
+    }
diff --git a/templates/hooks/parametergroup/sdk_read_many_post_set_output.go.tpl b/templates/hooks/parametergroup/sdk_read_many_post_set_output.go.tpl
@@ -1,5 +1,12 @@
-ko, err = rm.setParameters(ctx, ko)
+    resourceARN := (*string)(ko.Status.ACKResourceMetadata.ARN)
+    tags, err := rm.getTags(ctx, *resourceARN)
+    if err != nil {
+        return nil, err
+    }
+    ko.Spec.Tags = tags
 
-if err != nil {
-    return nil, err
-}
+    ko, err = rm.setParameters(ctx, ko)
+
+    if err != nil {
+        return nil, err
+    }
diff --git a/templates/hooks/parametergroup/sdk_update_post_set_output.go.tpl b/templates/hooks/parametergroup/sdk_update_post_set_output.go.tpl
@@ -0,0 +1,5 @@
+    ko, err = rm.setParameters(ctx, ko)
+
+    if err != nil {
+        return nil, err
+    }
diff --git a/templates/hooks/parametergroup/sdk_update_pre_build_request.go.tpl b/templates/hooks/parametergroup/sdk_update_pre_build_request.go.tpl
@@ -1,7 +1,18 @@
-if delta.DifferentAt("Spec.ParameterNameValues") {
-    ko, err := rm.resetParameterGroup(ctx, desired, latest)
+    if delta.DifferentAt("Spec.Tags") {
+        err = rm.updateTags(ctx, desired, latest)
+        if err != nil {
+            return nil, err
+        }
+    }
+
+    if delta.DifferentAt("Spec.ParameterNameValues") {
+        ko, err := rm.resetParameterGroup(ctx, desired, latest)
+
+        if ko != nil || err != nil {
+            return ko, err
+        }
+    }
 
-    if ko != nil || err != nil {
-        return ko, err
+    if !delta.DifferentExcept("Spec.Tags", "Spec.ParameterNameValues") {
+    	return desired, nil
     }
-}
diff --git a/test/e2e/scenarios/ParameterGroup/pg_update_with_tags.yaml b/test/e2e/scenarios/ParameterGroup/pg_update_with_tags.yaml
