UpdateTags support for InternetGateway resource (#94)

Description of changes:

- Implemented update tags support for **Internet Gateway** resource.
- Added integration tests for the same.

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-13T16:18:40Z"
+  build_date: "2022-09-13T21:29:16Z"
   build_hash: 585f06bbd6d4cc1b738acb85901e7a009bf452c7
   go_version: go1.18.3
   version: v0.20.0
 api_directory_checksum: 3960da50b98c36b05635d3abbfd129ae7bb48e32
 api_version: v1alpha1
 aws_sdk_go_version: v1.42.0
 generator_config_info:
-  file_checksum: 7862e66fc124ed9cba5b17483244f5619039eb23
+  file_checksum: 6dda562aa9c69e0c93f33141f2c5a671456fc306
   original_file_name: generator.yaml
 last_modification:
   reason: API generation

apis/v1alpha1/generator.yaml

@@ -247,6 +247,8 @@ resources:
         template_path: hooks/internet_gateway/sdk_read_many_post_set_output.go.tpl
       sdk_delete_pre_build_request:
         template_path: hooks/internet_gateway/sdk_delete_pre_build_request.go.tpl
+      sdk_file_end:
+        template_path: hooks/internet_gateway/sdk_file_end.go.tpl
     update_operation:
       custom_method_name: customUpdateInternetGateway
   NatGateway:

generator.yaml

@@ -247,6 +247,8 @@ resources:
         template_path: hooks/internet_gateway/sdk_read_many_post_set_output.go.tpl
       sdk_delete_pre_build_request:
         template_path: hooks/internet_gateway/sdk_delete_pre_build_request.go.tpl
+      sdk_file_end:
+        template_path: hooks/internet_gateway/sdk_file_end.go.tpl
     update_operation:
       custom_method_name: customUpdateInternetGateway
   NatGateway:

pkg/resource/internet_gateway/hook.go

@@ -16,6 +16,7 @@ package internet_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"
@@ -49,6 +50,12 @@ func (rm *resourceManager) customUpdateInternetGateway(
 		}
 	}
 
+	if delta.DifferentAt("Spec.Tags") {
+		if err = rm.syncTags(ctx, desired, latest); err != nil {
+			return nil, err
+		}
+	}
+
 	return &resource{ko}, nil
 }
 
@@ -131,6 +138,105 @@ func (rm *resourceManager) detachFromVPC(
 	return nil
 }
 
+// syncTags used to keep tags in sync by calling Create and Delete Tags 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.InternetGatewayID}
+
+	toAdd, toDelete := computeTagsDelta(
+		desired.ko.Spec.Tags, latest.ko.Spec.Tags,
+	)
+
+	if len(toDelete) > 0 {
+		rlog.Debug("removing tags from InternetGateway 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 InternetGateway 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 CreateInternetGatewayInput.TagSpecification
 // and ensures the ResourceType is always set to 'internet-gateway'

pkg/resource/internet_gateway/sdk.go

@@ -250,7 +250,7 @@ func toStrPtr(str string) *string {
 	return &str
 }
 
-// syncTags used to keep tags in sync using createTags and deleteTags functions
+// syncTags used to keep tags in sync by calling Create and Delete Tags API's
 func (rm *resourceManager) syncTags(
 	ctx context.Context,
 	desired *resource,

pkg/resource/subnet/hooks.go

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

templates/hooks/internet_gateway/sdk_file_end.go.tpl

@@ -1,4 +1,8 @@
 apiVersion: ec2.services.k8s.aws/v1alpha1
 kind: InternetGateway
 metadata:
-  name: $INTERNET_GATEWAY_NAME
+  name: $INTERNET_GATEWAY_NAME
+spec:
+  tags:
+    - key: $TAG_KEY
+      value: $TAG_VALUE

test/e2e/resources/internet_gateway.yaml

@@ -50,6 +50,10 @@ def simple_internet_gateway(request, simple_vpc):
             (_, vpc_cr) = simple_vpc
             vpc_id = vpc_cr["status"]["vpcID"]
             replacements["VPC_ID"] = vpc_id
+        if 'tag_key' in data:
+            replacements["TAG_KEY"] = data["tag_key"]
+        if 'tag_value' in data:
+            replacements["TAG_VALUE"] = data["tag_value"]
 
     # Load Internet Gateway CR
     resource_data = load_ec2_resource(
@@ -141,4 +145,70 @@ def test_vpc_association(self, ec2_client, simple_internet_gateway):
         time.sleep(DELETE_WAIT_AFTER_SECONDS)
 
         # Check Internet Gateway no longer exists in AWS
+        ec2_validator.assert_internet_gateway(resource_id, exists=False)
+    
+    @pytest.mark.resource_data({'tag_key': 'initialtagkey', 'tag_value': 'initialtagvalue'})
+    def test_crud_tags(self, ec2_client, simple_internet_gateway):
+        (ref, cr) = simple_internet_gateway
+        
+        resource = k8s.get_resource(ref)
+        resource_id = cr["status"]["internetGatewayID"]
+
+        time.sleep(CREATE_WAIT_AFTER_SECONDS)
+
+        # Check IGW exists in AWS
+        ec2_validator = EC2Validator(ec2_client)
+        ec2_validator.assert_internet_gateway(resource_id)
+        
+        # Check tags exist for IGW 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 IGW, 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 IGW resource
+        resource = k8s.get_resource(ref)
+        assert resource["spec"]["tags"][0]["key"] == "updatedtagkey"
+        assert resource["spec"]["tags"][0]["value"] == "updatedtagvalue"
+
+        # Patch the IGW 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)
+
+        # Check IGW no longer exists in AWS
         ec2_validator.assert_internet_gateway(resource_id, exists=False)