Update tags support for Instance resource (#100)

Description of changes:

- Included `update_operation` in `generator.yaml` file.
- Implemented update tags support for **Instance** resource.
- Added e2e tests for update tags.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Author: LikithaVemulapalli

apis/v1alpha1/ack-generate-metadata.yaml

@@ -1,13 +1,13 @@
 ack_generate_info:
-  build_date: "2022-09-15T18:20:58Z"
+  build_date: "2022-09-15T22:23:28Z"
   build_hash: 1da44f4be322eea156ed23a86e33c29da5cede9c
   go_version: go1.18.3
   version: v0.20.1-2-g1da44f4
 api_directory_checksum: 127aa0f51fbcdde596b8f42f93bcdf3b6dee8488
 api_version: v1alpha1
 aws_sdk_go_version: v1.44.93
 generator_config_info:
-  file_checksum: 765a0d09844f3b22d5d0b2d24f39fc0eec244d5c
+  file_checksum: ba7c8beee2b77dd73262cc870ec0a19ea7ca174f
   original_file_name: generator.yaml
 last_modification:
   reason: API generation

apis/v1alpha1/generator.yaml

@@ -207,6 +207,10 @@ resources:
         template_path: hooks/instance/sdk_create_post_build_request.go.tpl
       sdk_delete_post_build_request:
         template_path: hooks/instance/sdk_delete_post_build_request.go.tpl
+      sdk_file_end:
+        template_path: hooks/instance/sdk_file_end.go.tpl
+    update_operation:
+      custom_method_name: customUpdateInstance
   ElasticIPAddress:
     exceptions:
       terminal_codes:

generator.yaml

@@ -207,6 +207,10 @@ resources:
         template_path: hooks/instance/sdk_create_post_build_request.go.tpl
       sdk_delete_post_build_request:
         template_path: hooks/instance/sdk_delete_post_build_request.go.tpl
+      sdk_file_end:
+        template_path: hooks/instance/sdk_file_end.go.tpl
+    update_operation:
+      custom_method_name: customUpdateInstance
   ElasticIPAddress:
     exceptions:
       terminal_codes:

pkg/resource/instance/hooks.go

@@ -14,8 +14,12 @@
 package instance
 
 import (
+	"context"
 	"errors"
 
+	svcapitypes "github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1"
+	ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare"
+	ackrtlog "github.com/aws-controllers-k8s/runtime/pkg/runtime/log"
 	svcsdk "github.com/aws/aws-sdk-go/service/ec2"
 )
 
@@ -31,6 +35,129 @@ func addInstanceIDsToTerminateRequest(r *resource,
 	return nil
 }
 
+func (rm *resourceManager) customUpdateInstance(
+	ctx context.Context,
+	desired *resource,
+	latest *resource,
+	delta *ackcompare.Delta,
+) (updated *resource, err error) {
+	rlog := ackrtlog.FromContext(ctx)
+	exit := rlog.Trace("rm.customUpdateInstance")
+	defer exit(err)
+
+	// Merge in the information we read from the API call above to the copy of
+	// the original Kubernetes object we passed to the function
+	ko := desired.ko.DeepCopy()
+
+	if delta.DifferentAt("Spec.Tags") {
+		if err := rm.syncTags(ctx, desired, latest); err != nil {
+			return nil, err
+		}
+	}
+
+	rm.setStatusDefaults(ko)
+	return &resource{ko}, nil
+}
+
+// syncTags used to keep tags in sync by calling Create and Delete API's
+func (rm *resourceManager) syncTags(
+	ctx context.Context,
+	desired *resource,
+	latest *resource,
+) (err error) {
+	rlog := ackrtlog.FromContext(ctx)
+	exit := rlog.Trace("rm.syncTags")
+	defer func(err error) {
+		exit(err)
+	}(err)
+
+	resourceId := []*string{latest.ko.Status.InstanceID}
+
+	toAdd, toDelete := computeTagsDelta(
+		desired.ko.Spec.Tags, latest.ko.Spec.Tags,
+	)
+
+	if len(toDelete) > 0 {
+		rlog.Debug("removing tags from Instance resource", "tags", toDelete)
+		_, err = rm.sdkapi.DeleteTagsWithContext(
+			ctx,
+			&svcsdk.DeleteTagsInput{
+				Resources: resourceId,
+				Tags:      rm.sdkTags(toDelete),
+			},
+		)
+		rm.metrics.RecordAPICall("UPDATE", "DeleteTags", err)
+		if err != nil {
+			return err
+		}
+
+	}
+
+	if len(toAdd) > 0 {
+		rlog.Debug("adding tags to Instance resource", "tags", toAdd)
+		_, err = rm.sdkapi.CreateTagsWithContext(
+			ctx,
+			&svcsdk.CreateTagsInput{
+				Resources: resourceId,
+				Tags:      rm.sdkTags(toAdd),
+			},
+		)
+		rm.metrics.RecordAPICall("UPDATE", "CreateTags", err)
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+// sdkTags converts *svcapitypes.Tag array to a *svcsdk.Tag array
+func (rm *resourceManager) sdkTags(
+	tags []*svcapitypes.Tag,
+) (sdktags []*svcsdk.Tag) {
+
+	for _, i := range tags {
+		sdktag := rm.newTag(*i)
+		sdktags = append(sdktags, sdktag)
+	}
+
+	return sdktags
+}
+
+// computeTagsDelta returns tags to be added and removed from the resource
+func computeTagsDelta(
+	desired []*svcapitypes.Tag,
+	latest []*svcapitypes.Tag,
+) (toAdd []*svcapitypes.Tag, toDelete []*svcapitypes.Tag) {
+
+	desiredTags := map[string]string{}
+	for _, tag := range desired {
+		desiredTags[*tag.Key] = *tag.Value
+	}
+
+	latestTags := map[string]string{}
+	for _, tag := range latest {
+		latestTags[*tag.Key] = *tag.Value
+	}
+
+	for _, tag := range desired {
+		val, ok := latestTags[*tag.Key]
+		if !ok || val != *tag.Value {
+			toAdd = append(toAdd, tag)
+		}
+	}
+
+	for _, tag := range latest {
+		_, ok := desiredTags[*tag.Key]
+		if !ok {
+			toDelete = append(toDelete, tag)
+		}
+	}
+
+	return toAdd, toDelete
+
+}
+
 // updateTagSpecificationsInCreateRequest adds
 // Tags defined in the Spec to RunInstancesInput.TagSpecification
 // and ensures the ResourceType is always set to 'instance'

pkg/resource/instance/sdk.go

@@ -0,0 +1,23 @@
+{{ $CRD := .CRD }}
+{{ $SDKAPI := .SDKAPI }}
+
+{{/* Generate helper methods for Instance */}}
+{{- range $specFieldName, $specField := $CRD.Config.Resources.Instance.Fields }}
+{{- if $specField.From }}
+{{- $operationName := $specField.From.Operation }}
+{{- $operation := (index $SDKAPI.API.Operations $operationName) -}}
+{{- range $instanceRefName, $instanceMemberRefs := $operation.InputRef.Shape.MemberRefs -}}
+{{- if eq $instanceRefName "Tags" }}
+{{- $instanceRef := $instanceMemberRefs.Shape.MemberRef }}
+{{- $instanceRefName = "Tag" }}
+func (rm *resourceManager) new{{ $instanceRefName }}(
+	    c svcapitypes.{{ $instanceRefName }},
+) *svcsdk.{{ $instanceRefName }} {
+	res := &svcsdk.{{ $instanceRefName }}{}
+{{ GoCodeSetSDKForStruct $CRD "" "res" $instanceRef "" "c" 1 }}
+	return res
+}
+{{- end }}
+{{- end }}
+{{- end }}
+{{- end }}

templates/hooks/instance/sdk_file_end.go.tpl

@@ -34,6 +34,7 @@
 
 CREATE_WAIT_AFTER_SECONDS = 10
 DELETE_WAIT_AFTER_SECONDS = 10
+MODIFY_WAIT_AFTER_SECONDS = 5
 TIMEOUT_SECONDS = 300
 
 def get_instance(ec2_client, instance_id: str) -> dict:
@@ -159,6 +160,73 @@ def test_create_delete(self, ec2_client, instance):
         _, deleted = k8s.delete_custom_resource(ref, 2, 5)
         assert deleted is True
 
+        # Reservation still exists, but instance will commence termination
+        # State needs to be 'terminated' in order to remove the dependency on the shared subnet
+        # for successful test cleanup
+        wait_for_instance_or_die(ec2_client, resource_id, 'terminated', TIMEOUT_SECONDS)
+    
+    def test_crud_tags(self, ec2_client, instance):
+        (ref, cr) = instance
+        
+        resource = k8s.get_resource(ref)
+        resource_id = cr["status"]["instanceID"]
+
+        time.sleep(CREATE_WAIT_AFTER_SECONDS)
+
+        # Check Instance exists
+        instance = get_instance(ec2_client, resource_id)
+        assert instance is not None
+        
+        # Check tags exist for Instance resource
+        assert resource["spec"]["tags"][0]["key"] == INSTANCE_TAG_KEY
+        assert resource["spec"]["tags"][0]["value"] == INSTANCE_TAG_VAL
+
+        # New pair of tags
+        new_tags = [
+                {
+                    "key": "updatedtagkey",
+                    "value": "updatedtagvalue",
+                }
+               
+            ]
+
+        # Patch the Instance, updating the tags with new pair
+        updates = {
+            "spec": {"tags": new_tags},
+        }
+
+        k8s.patch_custom_resource(ref, updates)
+        time.sleep(MODIFY_WAIT_AFTER_SECONDS)
+
+        # Check resource synced successfully
+        assert k8s.wait_on_condition(ref, "ACK.ResourceSynced", "True", wait_periods=5)
+        
+        # Assert tags are updated for Instance resource
+        resource = k8s.get_resource(ref)
+        assert resource["spec"]["tags"][0]["key"] == "updatedtagkey"
+        assert resource["spec"]["tags"][0]["value"] == "updatedtagvalue"
+
+        # Patch the Instance resource, deleting the tags
+        updates = {
+                "spec": {"tags": []},
+        }
+
+        k8s.patch_custom_resource(ref, updates)
+        time.sleep(MODIFY_WAIT_AFTER_SECONDS)
+
+        # Check resource synced successfully
+        assert k8s.wait_on_condition(ref, "ACK.ResourceSynced", "True", wait_periods=5)
+        
+        # Assert tags are deleted
+        resource = k8s.get_resource(ref)
+        assert len(resource['spec']['tags']) == 0
+
+        # Delete k8s resource
+        _, deleted = k8s.delete_custom_resource(ref)
+        assert deleted is True
+
+        time.sleep(DELETE_WAIT_AFTER_SECONDS)
+
         # Reservation still exists, but instance will commence termination
         # State needs to be 'terminated' in order to remove the dependency on the shared subnet
         # for successful test cleanup