Update tags support for NAT gateway (#102)

Description of changes:

- Included `update_operation` in `generator.yaml` file.
- Implemented update tags support for **NATGateway** 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-15T22:23:28Z"
+  build_date: "2022-09-16T18:43:47Z"
   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: ba7c8beee2b77dd73262cc870ec0a19ea7ca174f
+  file_checksum: 8573a89b8220023263610579bfb84b762d99f5fa
   original_file_name: generator.yaml
 last_modification:
   reason: API generation

apis/v1alpha1/generator.yaml

@@ -297,6 +297,10 @@ resources:
     hooks:
       sdk_create_post_build_request:
         template_path: hooks/nat_gateway/sdk_create_post_build_request.go.tpl
+      sdk_file_end:
+        template_path: hooks/nat_gateway/sdk_file_end.go.tpl
+    update_operation:
+      custom_method_name: customUpdateNATGateway
   RouteTable:
     fields:
       # RouteStatuses as Route to ensure

generator.yaml

@@ -297,6 +297,10 @@ resources:
     hooks:
       sdk_create_post_build_request:
         template_path: hooks/nat_gateway/sdk_create_post_build_request.go.tpl
+      sdk_file_end:
+        template_path: hooks/nat_gateway/sdk_file_end.go.tpl
+    update_operation:
+      custom_method_name: customUpdateNATGateway
   RouteTable:
     fields:
       # RouteStatuses as Route to ensure

pkg/resource/nat_gateway/hook.go

@@ -14,9 +14,137 @@
 package nat_gateway
 
 import (
+	"context"
+
+	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"
 )
 
+func (rm *resourceManager) customUpdateNATGateway(
+	ctx context.Context,
+	desired *resource,
+	latest *resource,
+	delta *ackcompare.Delta,
+) (updated *resource, err error) {
+	rlog := ackrtlog.FromContext(ctx)
+	exit := rlog.Trace("rm.customUpdateNATGateway")
+	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.NATGatewayID}
+
+	toAdd, toDelete := computeTagsDelta(
+		desired.ko.Spec.Tags, latest.ko.Spec.Tags,
+	)
+
+	if len(toDelete) > 0 {
+		rlog.Debug("removing tags from NATGateway 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 NATGateway 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 CreateNatGatewayInput.TagSpecification
 // and ensures the ResourceType is always set to 'natgateway'

pkg/resource/nat_gateway/sdk.go

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

templates/hooks/nat_gateway/sdk_file_end.go.tpl

@@ -5,8 +5,6 @@ metadata:
 spec:
   allocationID: $ALLOCATION_ID
   subnetID: $SUBNET_ID
-  tagSpecifications:
-  - resourceType: "natgateway"
-    tags:
-    - key: Name
-      value: $NAT_GATEWAY_NAME
+  tags:
+    - key: $TAG_KEY
+      value: $TAG_VALUE

test/e2e/resources/nat_gateway.yaml

@@ -29,6 +29,7 @@
 
 CREATE_WAIT_AFTER_SECONDS = 10
 DELETE_WAIT_AFTER_SECONDS = 10
+MODIFY_WAIT_AFTER_SECONDS = 10
 
 @pytest.fixture
 def standard_elastic_address():
@@ -69,7 +70,7 @@ def standard_elastic_address():
         pass
 
 @pytest.fixture
-def simple_nat_gateway(standard_elastic_address):
+def simple_nat_gateway(standard_elastic_address, request):
     test_resource_values = REPLACEMENT_VALUES.copy()
     resource_name = random_suffix_name("nat-gateway-test", 24)
     test_vpc = get_bootstrap_resources().SharedTestVPC
@@ -81,6 +82,14 @@ def simple_nat_gateway(standard_elastic_address):
     test_resource_values["SUBNET_ID"] = subnet_id
     test_resource_values["ALLOCATION_ID"] = eip["status"]["allocationID"]
 
+    marker = request.node.get_closest_marker("resource_data")
+    if marker is not None:
+        data = marker.args[0]
+        if 'tag_key' in data:
+            test_resource_values["TAG_KEY"] = data["tag_key"]
+        if 'tag_value' in data:
+            test_resource_values["TAG_VALUE"] = data["tag_value"]
+
     # Load NAT Gateway CR
     resource_data = load_ec2_resource(
         "nat_gateway",
@@ -133,6 +142,67 @@ def test_create_delete(self, simple_nat_gateway, ec2_client):
 
         # Check NAT Gateway no longer exists in AWS
         ec2_validator.assert_nat_gateway(resource_id, exists=False)
+    
+    @pytest.mark.resource_data({'tag_key': 'initialtagkey', 'tag_value': 'initialtagvalue'})
+    def test_crud_tags(self, ec2_client, simple_nat_gateway):
+        (ref, cr) = simple_nat_gateway
+        
+        resource = k8s.get_resource(ref)
+        resource_id = cr["status"]["natGatewayID"]
+
+        time.sleep(CREATE_WAIT_AFTER_SECONDS)
+
+        # Check natGateway exists in AWS
+        ec2_validator = EC2Validator(ec2_client)
+        ec2_validator.assert_nat_gateway(resource_id)
+        
+        # Check tags exist for natGateway resource
+        assert resource["spec"]["tags"][0]["key"] == "initialtagkey"
+        assert resource["spec"]["tags"][0]["value"] == "initialtagvalue"
+
+        # New pair of tags
+        new_tags = [
+                {
+                    "key": "updatedtagkey",
+                    "value": "updatedtagvalue",
+                }
+               
+            ]
+
+        # Patch the natGateway, updating the tags with new pair
+        updates = {
+            "spec": {"tags": new_tags},
+        }
+
+        k8s.patch_custom_resource(ref, updates)
+        time.sleep(MODIFY_WAIT_AFTER_SECONDS)
+        
+        # Assert tags are updated for natGateway resource
+        resource = k8s.get_resource(ref)
+        assert resource["spec"]["tags"][0]["key"] == "updatedtagkey"
+        assert resource["spec"]["tags"][0]["value"] == "updatedtagvalue"
+
+        # Patch the natGateway resource, deleting the tags
+        updates = {
+                "spec": {"tags": []},
+        }
+
+        k8s.patch_custom_resource(ref, updates)
+        time.sleep(MODIFY_WAIT_AFTER_SECONDS)
+        
+        # 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)
+
+        # Check natGateway no longer exists in AWS
+        ec2_validator.assert_nat_gateway(resource_id, exists=False)
+
 
     def test_terminal_condition_invalid_subnet(self, standard_elastic_address):
         test_resource_values = REPLACEMENT_VALUES.copy()