Update tags support for Subnet (#81)

Issue #, if available: aws-controllers-k8s/community#1369

Description of changes:

-  Added custom code that supports updating tags for **Subnet** resource.
- Added integration test to check whether tags are being updated as expected.

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-06T20:17:17Z"
+  build_date: "2022-09-06T21:58:54Z"
   build_hash: 87477ae8ca8ac6ddb8c565bbd910cc7e30f55ed0
-  go_version: go1.18.1
+  go_version: go1.18.3
   version: v0.19.3
 api_directory_checksum: 3960da50b98c36b05635d3abbfd129ae7bb48e32
 api_version: v1alpha1
 aws_sdk_go_version: v1.42.0
 generator_config_info:
-  file_checksum: b17fda4c7e3ae9446dd568f3be1f08d70ce15588
+  file_checksum: 6c21f6d996045b6c6c7c79074147f9bbcff5a73c
   original_file_name: generator.yaml
 last_modification:
   reason: API generation

apis/v1alpha1/generator.yaml

@@ -405,6 +405,8 @@ resources:
         template_path: hooks/subnet/sdk_create_post_set_output.go.tpl
       sdk_read_many_post_set_output:
         template_path: hooks/subnet/sdk_read_many_post_set_output.go.tpl
+      sdk_file_end:
+        template_path: hooks/subnet/sdk_file_end.go.tpl
     update_operation:
       custom_method_name: customUpdateSubnet
   TransitGateway:

generator.yaml

@@ -405,6 +405,8 @@ resources:
         template_path: hooks/subnet/sdk_create_post_set_output.go.tpl
       sdk_read_many_post_set_output:
         template_path: hooks/subnet/sdk_read_many_post_set_output.go.tpl
+      sdk_file_end:
+        template_path: hooks/subnet/sdk_file_end.go.tpl
     update_operation:
       custom_method_name: customUpdateSubnet
   TransitGateway:

pkg/resource/subnet/hooks.go

@@ -16,6 +16,7 @@ package subnet
 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"
 	ackutils "github.com/aws-controllers-k8s/runtime/pkg/util"
@@ -43,6 +44,12 @@ func (rm *resourceManager) customUpdateSubnet(
 		}
 	}
 
+	if delta.DifferentAt("Spec.Tags") {
+		if err = rm.syncTags(ctx, desired, latest); err != nil {
+			return nil, err
+		}
+	}
+
 	return &resource{ko}, nil
 }
 
@@ -243,6 +250,121 @@ func toStrPtr(str string) *string {
 	return &str
 }
 
+// syncTags used to keep tags in sync using createTags and deleteTags functions
+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)
+
+	toAdd, toDelete := computeTagsDelta(
+		desired.ko.Spec.Tags, latest.ko.Spec.Tags,
+	)
+
+	if err = rm.deleteTags(ctx, latest, toDelete); err != nil {
+		return err
+	}
+
+	if err = rm.createTags(ctx, desired, toAdd); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+// createTags function creates tags for subnet resource using CreateTags API calls
+func (rm *resourceManager) createTags(
+	ctx context.Context,
+	r *resource,
+	tags []*svcapitypes.Tag,
+) (err error) {
+	rlog := ackrtlog.FromContext(ctx)
+	exit := rlog.Trace("rm.createTags")
+	defer exit(err)
+
+	resourceId := []*string{r.ko.Status.SubnetID}
+
+	for _, i := range tags {
+		toAdd := rm.newTag(*i)
+		req := &svcsdk.CreateTagsInput{
+			Resources: resourceId,
+			Tags:      []*svcsdk.Tag{toAdd},
+		}
+		_, err := rm.sdkapi.CreateTagsWithContext(ctx, req)
+		rm.metrics.RecordAPICall("CREATE", "CreateTags", err)
+		if err != nil {
+			return err
+		}
+	}
+	return err
+}
+
+// deleteTags function deletes tags from subnet resource using DeleteTags API calls
+func (rm *resourceManager) deleteTags(
+	ctx context.Context,
+	r *resource,
+	tags []*svcapitypes.Tag,
+) (err error) {
+	rlog := ackrtlog.FromContext(ctx)
+	exit := rlog.Trace("rm.deleteTags")
+	defer exit(err)
+
+	resourceId := []*string{r.ko.Status.SubnetID}
+
+	for _, i := range tags {
+		toDelete := rm.newTag(*i)
+		req := &svcsdk.DeleteTagsInput{
+			Resources: resourceId,
+			Tags:      []*svcsdk.Tag{toDelete},
+		}
+		_, err = rm.sdkapi.DeleteTagsWithContext(ctx, req)
+		rm.metrics.RecordAPICall("DELETE", "DeleteTags", err)
+		if err != nil {
+			return err
+		}
+	}
+	return err
+}
+
+// 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 CreateSubnetInput.TagSpecification
 // and ensures the ResourceType is always set to 'subnet'

pkg/resource/subnet/sdk.go

@@ -0,0 +1 @@
+compareTags(delta, a, b)

templates/hooks/subnet/delta_pre_compare.go.tpl

@@ -0,0 +1,32 @@
+{{ $CRD := .CRD }}
+{{ $SDKAPI := .SDKAPI }}
+
+{{/* Generate helper methods for Subnet */}}
+{{- range $specFieldName, $specField := $CRD.Config.Resources.Subnet.Fields }}
+{{- if $specField.From }}
+{{- $operationName := $specField.From.Operation }}
+{{- $operation := (index $SDKAPI.API.Operations $operationName) -}}
+{{- range $subnetRefName, $subnetMemberRefs := $operation.InputRef.Shape.MemberRefs -}}
+{{- if eq $subnetRefName "Tags" }}
+{{- $subnetRef := $subnetMemberRefs.Shape.MemberRef }}
+{{- $subnetRefName = "Tag" }}
+func compare{{ $subnetRefName }}(
+	    a *svcapitypes.{{ $subnetRefName }},
+	    b *svcapitypes.{{ $subnetRefName }},
+) *ackcompare.Delta {
+	delta := ackcompare.NewDelta()
+{{ GoCodeCompareStruct $CRD $subnetRef.Shape "delta" "a" "b" $subnetRefName 1 }}
+	return delta
+}
+
+func (rm *resourceManager) new{{ $subnetRefName }}(
+	    c svcapitypes.{{ $subnetRefName }},
+) *svcsdk.{{ $subnetRefName }} {
+	res := &svcsdk.{{ $subnetRefName }}{}
+{{ GoCodeSetSDKForStruct $CRD "" "res" $subnetRef "" "c" 1 }}
+	return res
+}
+{{- end }}
+{{- end }}
+{{- end }}
+{{- end }}

templates/hooks/subnet/sdk_file_end.go.tpl

@@ -4,4 +4,7 @@ metadata:
   name: $SUBNET_NAME
 spec:
   cidrBlock: $CIDR_BLOCK
-  vpcID: $VPC_ID
+  vpcID: $VPC_ID
+  tags:
+    - key: $KEY
+      value: $VALUE

test/e2e/resources/subnet.yaml

@@ -116,6 +116,9 @@ def test_create_delete(self, ec2_client):
         assert cr is not None
         assert k8s.get_resource_exists(ref)
 
+        # Check resource synced successfully
+        assert k8s.wait_on_condition(ref, "ACK.ResourceSynced", "True", wait_periods=5)
+
         resource = k8s.get_resource(ref)
         resource_id = resource["status"]["subnetID"]
 
@@ -134,6 +137,101 @@ def test_create_delete(self, ec2_client):
         # Check Subnet no longer exists in AWS
         ec2_validator.assert_subnet(resource_id, exists=False)
 
+    def test_crud_tags(self, ec2_client):
+        test_resource_values = REPLACEMENT_VALUES.copy()
+        resource_name = random_suffix_name("subnet-test", 24)
+        test_vpc = get_bootstrap_resources().SharedTestVPC
+        vpc_id = test_vpc.vpc_id
+
+        test_resource_values["SUBNET_NAME"] = resource_name
+        test_resource_values["VPC_ID"] = vpc_id
+        # CIDR needs to be within SharedTestVPC range and not overlap other subnets
+        test_resource_values["CIDR_BLOCK"] = "10.0.255.0/24"
+        test_resource_values["KEY"] = "initialtagkey"
+        test_resource_values["VALUE"] = "initialtagvalue"
+
+        # Load Subnet CR
+        resource_data = load_ec2_resource(
+            "subnet",
+            additional_replacements=test_resource_values,
+        )
+        logging.debug(resource_data)
+
+        # Create k8s resource
+        ref = k8s.CustomResourceReference(
+            CRD_GROUP, CRD_VERSION, RESOURCE_PLURAL,
+            resource_name, namespace="default",
+        )
+        k8s.create_custom_resource(ref, resource_data)
+        cr = k8s.wait_resource_consumed_by_controller(ref)
+
+        assert cr is not None
+        assert k8s.get_resource_exists(ref)
+
+        # Check resource synced successfully
+        assert k8s.wait_on_condition(ref, "ACK.ResourceSynced", "True", wait_periods=5)
+
+        resource = k8s.get_resource(ref)
+        resource_id = resource["status"]["subnetID"]
+        time.sleep(CREATE_WAIT_AFTER_SECONDS)
+
+        # Check Subnet exists in AWS
+        ec2_validator = EC2Validator(ec2_client)
+        ec2_validator.assert_subnet(resource_id)
+        
+        # Check tags exist for subnet 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 subnet, 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 subnet resource
+        resource = k8s.get_resource(ref)
+        assert resource["spec"]["tags"][0]["key"] == "updatedtagkey"
+        assert resource["spec"]["tags"][0]["value"] == "updatedtagvalue"
+
+        # Patch the subnet 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 Subnet no longer exists in AWS
+        ec2_validator.assert_subnet(resource_id, exists=False)
+
     def test_route_table_assocations(self, ec2_client, default_route_tables):
         test_resource_values = REPLACEMENT_VALUES.copy()
         resource_name = random_suffix_name("subnet-test", 24)
@@ -165,6 +263,9 @@ def test_route_table_assocations(self, ec2_client, default_route_tables):
         assert cr is not None
         assert k8s.get_resource_exists(ref)
 
+        # Check resource synced successfully
+        assert k8s.wait_on_condition(ref, "ACK.ResourceSynced", "True", wait_periods=5)
+
         resource = k8s.get_resource(ref)
         resource_id = resource["status"]["subnetID"]
 
@@ -185,6 +286,9 @@ def test_route_table_assocations(self, ec2_client, default_route_tables):
         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 ec2_validator.get_route_table_association(initial_rt_cr["status"]["routeTableID"], resource_id) is None
         assert ec2_validator.get_route_table_association(default_route_tables[1][1]["status"]["routeTableID"], resource_id) is not None