update for default resource tags

go.mod

@@ -3,7 +3,7 @@ module github.com/aws-controllers-k8s/code-generator
 go 1.17
 
 require (
-	github.com/aws-controllers-k8s/runtime v0.18.4
+	github.com/aws-controllers-k8s/runtime v0.19.0
 	github.com/aws/aws-sdk-go v1.42.0
 	github.com/dlclark/regexp2 v1.4.0
 	// pin to v0.1.1 due to release problem with v0.1.2

go.sum

@@ -90,8 +90,8 @@ github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPd
 github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs=
 github.com/asaskevich/govalidator v0.0.0-20180720115003-f9ffefc3facf/go.mod h1:lB+ZfQJz7igIIfQNfa7Ml4HSf2uFQQRzpGGRXenZAgY=
 github.com/asaskevich/govalidator v0.0.0-20190424111038-f61b66f89f4a/go.mod h1:lB+ZfQJz7igIIfQNfa7Ml4HSf2uFQQRzpGGRXenZAgY=
-github.com/aws-controllers-k8s/runtime v0.18.4 h1:iwLYNwhbuiWZrHPoulGj75oT+alE91wCNkF1FUELiAw=
-github.com/aws-controllers-k8s/runtime v0.18.4/go.mod h1:oA8ML1/LL3chPn26P6SzBNu1CUI2nekB+PTqykNs0qU=
+github.com/aws-controllers-k8s/runtime v0.19.0 h1:+O5a6jBSBAd8XTNMrVCIYu4G+ZUPZe/G5eopVFO18Dc=
+github.com/aws-controllers-k8s/runtime v0.19.0/go.mod h1:oA8ML1/LL3chPn26P6SzBNu1CUI2nekB+PTqykNs0qU=
 github.com/aws/aws-sdk-go v1.42.0 h1:BMZws0t8NAhHFsfnT3B40IwD13jVDG5KerlRksctVIw=
 github.com/aws/aws-sdk-go v1.42.0/go.mod h1:585smgzpB/KqRA+K3y/NL/oYRqQvpNJYvLm+LY1U59Q=
 github.com/benbjohnson/clock v1.0.3/go.mod h1:bGMdMPoPVvcYyt1gHDf4J2KE153Yf9BuiUKYMaxlTDM=

pkg/config/resource.go

@@ -96,6 +96,28 @@ type ResourceConfig struct {
 	// IsARNPrimaryKey determines whether the CRD uses the ARN as the primary
 	// identifier in the ReadOne operations.
 	IsARNPrimaryKey bool `json:"is_arn_primary_key"`
+	// TagConfig contains instructions for the code generator to generate
+	// custom code for ensuring tags
+	TagConfig *TagConfig `json:"tags,omitempty"`
+}
+
+// TagConfig instructs the code  generator on how to generate functions that
+// ensure that controller tags are added to the AWS Resource
+type TagConfig struct {
+	// Ignore is a boolean that indicates whether ensuring controller tags
+	// should be ignored for a resource. For AWS resources which do not
+	// support tagging, this should be set to True
+	Ignore bool `json:"ignore,omitempty"`
+	// Path represents the field path for the member which contains the tags
+	Path *string `json:"path,omitempty"`
+	// KeyMemberName is the name of field which represents AWS tag key inside tag
+	// struct. This is only used for tag fields with shape as list of struct,
+	// where the struct represents a single tag.
+	KeyMemberName *string `json:"key_name,omitempty"`
+	// ValueMemberName is the name of field which represents AWS tag value inside
+	// tag struct. This is only used for tag fields with shape as list of struct,
+	// where the struct represents a single tag.
+	ValueMemberName *string `json:"value_name,omitempty"`
 }
 
 // SyncedConfig instructs the code generator on how to generate functions that checks

pkg/generate/ack/controller.go

@@ -169,6 +169,12 @@ var (
 		"CheckNilReferencesPath": func(f *ackmodel.Field, sourceVarName string) string {
 			return code.CheckNilReferencesPath(f, sourceVarName)
 		},
+		"GoCodeInitializeNestedStructField": func(r *ackmodel.CRD,
+			sourceVarName string, f *ackmodel.Field, apiPkgImportName string,
+			indentLevel int) string {
+			return code.InitializeNestedStructField(r, sourceVarName, f,
+				apiPkgImportName, indentLevel)
+		},
 	}
 )
 
@@ -220,9 +226,14 @@ func Controller(
 		"references.go.tpl",
 		"resource.go.tpl",
 		"sdk.go.tpl",
+		"tags.go.tpl",
 	}
 	for _, crd := range crds {
 		for _, target := range targets {
+			// skip adding "tags.go.tpl" file if tagging is ignored for a crd
+			if target == "tags.go.tpl" && crd.GetIgnoreTagging() {
+				continue
+			}
 			outPath := filepath.Join("pkg/resource", crd.Names.Snake, strings.TrimSuffix(target, ".tpl"))
 			tplPath := filepath.Join("pkg/resource", target)
 			crdVars := &templateCRDVars{

pkg/generate/ack/hook.go

@@ -63,6 +63,12 @@ code paths:
 * late_initialize_post_read_one
 * references_pre_resolve
 * references_post_resolve
+* ensure_tags
+* convert_tags
+* convert_tags_pre_to_ack_tags
+* convert_tags_post_to_ack_tags
+* convert_tags_pre_from_ack_tags
+* convert_tags_post_from_ack_tags
 
 The "pre_build_request" hooks are called BEFORE the call to construct
 the Input shape that is used in the API operation and therefore BEFORE
@@ -119,6 +125,24 @@ method
 The "references_post_resolve" hooks are called AFTER resolving the
 references for all Reference fields inside AWSResourceManager.ResolveReferences()
 method
+
+The "ensure_tags" hooks provide the complete custom implementation for
+AWSResourceManager.EnsureTags() method
+
+The "convert_tags" hooks provide the complete custom implementation for
+"ToACKTags" and "FromACKTags" methods.
+
+The "convert_tags_pre_to_ack_tags" are called before converting the K8s
+resource tags into ACK tags
+
+The "convert_tags_post_to_ack_tags" are called after converting the K8s
+resource tags into ACK tags
+
+The "convert_tags_pre_from_ack_tags" are called before converting the ACK
+tags into K8s resource tags
+
+The "convert_tags_post_from_ack_tags" are called after converting the ACK
+tags into K8s resource tags
 */
 
 // ResourceHookCode returns a string with custom callback code for a resource

pkg/generate/ack/runtime_test.go

@@ -134,6 +134,14 @@ func (frm *fakeRM) IsSynced(context.Context, acktypes.AWSResource) (bool, error)
 	return true, nil
 }
 
+func (frm *fakeRM) EnsureTags(
+	context.Context,
+	acktypes.AWSResource,
+	acktypes.ServiceControllerMetadata,
+) error {
+	return nil
+}
+
 // This test is mostly just a hack to introduce a Go module dependency between
 // the ACK runtime library and the code generator. The code generator doesn't
 // actually depend on Go code in the ACK runtime, but it *produces* templated

pkg/generate/code/initialize_field.go

@@ -0,0 +1,98 @@
+// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License"). You may
+// not use this file except in compliance with the License. A copy of the
+// License is located at
+//
+//     http://aws.amazon.com/apache2.0/
+//
+// or in the "license" file accompanying this file. This file is distributed
+// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+// express or implied. See the License for the specific language governing
+// permissions and limitations under the License.
+
+package code
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/aws-controllers-k8s/code-generator/pkg/fieldpath"
+
+	"github.com/aws-controllers-k8s/code-generator/pkg/model"
+)
+
+// InitializeNestedStructField returns the go code for initializing a nested
+// struct field. Currently this method only supports the struct shape for
+// nested elements.
+//
+// TODO(vijtrip2): Refactor the code out of set_resource.go for generating
+// constructors and reuse here. This method is currently being used for handling
+// nested Tagging fields.
+//
+// Example: generated code for "Logging.LoggingEnabled.TargetBucket" field
+// inside "s3" "bucket" crd looks like:
+//
+//  ```
+// 	r.ko.BucketLoggingStatus = &svcapitypes.BucketLoggingStatus{}
+//	r.ko.BucketLoggingStatus.LoggingEnabled = &svcapitypes.LoggingEnabled{}
+//  ```
+
+func InitializeNestedStructField(
+	r *model.CRD,
+	sourceVarName string,
+	field *model.Field,
+	// apiPkgImportName contains the imported package name where the type definition
+	// for nested structs is present.
+	// ex: svcapitypes "github.com/aws-controllers-k8s/s3-controller/apis/v1alpha1"
+	apiPkgImportName string,
+	// Number of levels of indentation to use
+	indentLevel int,
+) string {
+	out := ""
+	indent := strings.Repeat("\t", indentLevel)
+	fieldPath := field.Path
+	if fieldPath != "" {
+		fp := fieldpath.FromString(fieldPath)
+		if fp.Size() > 1 {
+			// replace the front field name with front field shape name inside
+			// the field path to construct the fieldShapePath
+			front := fp.Front()
+			frontField := r.Fields[front]
+			if frontField == nil {
+				panic(fmt.Sprintf("unable to find the field with name %s"+
+					" for fieldpath %s", front, fieldPath))
+			}
+			if frontField.ShapeRef == nil {
+				panic(fmt.Sprintf("nil ShapeRef for field %s", front))
+			}
+			fieldShapePath := strings.Replace(fieldPath, front,
+				frontField.ShapeRef.ShapeName, 1)
+			fsp := fieldpath.FromString(fieldShapePath)
+			var index int
+			elemAccessPrefix := sourceVarName
+			var importPath string
+			if apiPkgImportName != "" {
+				importPath = fmt.Sprintf("%s.", apiPkgImportName)
+			}
+			// traverse over the fieldShapePath and initialize every element
+			// except the last.
+			for index < fsp.Size()-1 {
+				elemName := fsp.At(index)
+				elemShapeRef := fsp.ShapeRefAt(frontField.ShapeRef, index)
+				if elemShapeRef.Shape.Type != "structure" {
+					panic(fmt.Sprintf("only nested structures are supported."+
+						" Shape type for %s is %s inside fieldpath %s", elemName,
+						elemShapeRef.Shape.Type, fieldPath))
+				}
+				out += fmt.Sprintf("%s%s.%s = &%s%s{}\n",
+					indent, elemAccessPrefix, elemName, importPath,
+					elemShapeRef.GoTypeElem())
+				elemAccessPrefix = fmt.Sprintf("%s.%s", elemAccessPrefix,
+					elemName)
+				index++
+			}
+		}
+	}
+	return out
+}

pkg/generate/code/initialize_field_test.go

@@ -0,0 +1,30 @@
+package code_test
+
+import (
+	"testing"
+
+	"github.com/aws-controllers-k8s/code-generator/pkg/generate/code"
+
+	"github.com/aws-controllers-k8s/code-generator/pkg/testutil"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestInitializeNestedStructField(t *testing.T) {
+	assert := assert.New(t)
+
+	g := testutil.NewModelForServiceWithOptions(t, "s3",
+		&testutil.TestingModelOptions{GeneratorConfigFile: "generator-with-tags.yaml"})
+
+	crd := testutil.GetCRDByName(t, g, "Bucket")
+	assert.NotNil(crd)
+
+	f := crd.Fields["Logging.LoggingEnabled.TargetBucket"]
+
+	s := code.InitializeNestedStructField(crd, "r.ko", f,
+		"svcapitypes", 1)
+	expected :=
+		`	r.ko.BucketLoggingStatus = &svcapitypes.BucketLoggingStatus{}
+	r.ko.BucketLoggingStatus.LoggingEnabled = &svcapitypes.LoggingEnabled{}
+`
+	assert.Equal(expected, s)
+}

pkg/model/crd.go

@@ -718,6 +718,119 @@ func (r *CRD) SortedFieldNames() []string {
 	return fieldNames
 }
 
+// GetIgnoreTagging returns whether ensuring controller tags should be ignored
+// for a resource or not.
+func (r *CRD) GetIgnoreTagging() bool {
+	if resConfig := r.cfg.GetResourceConfig(r.Names.Original); resConfig != nil {
+		if tagConfig := resConfig.TagConfig; tagConfig != nil {
+			return tagConfig.Ignore
+		}
+	}
+	return false
+}
+
+// GetTagFieldName returns the name of field containing AWS tags. The default
+// name is "Tags". If no tag field is found inside the CRD, an error is returned
+func (r *CRD) GetTagFieldName() (string, error) {
+	tagFieldPath := "Tags" // default tag field path
+
+	// If there is an explicit tag field path mentioned inside generator config,
+	// retrieve it.
+	if resConfig := r.cfg.GetResourceConfig(r.Names.Original); resConfig != nil {
+		if tagConfig := resConfig.TagConfig; tagConfig != nil {
+			if tagConfig.Path != nil {
+				tagFieldPath = *tagConfig.Path
+			}
+		}
+	}
+	// verify that the tagFieldPath exists inside CRD
+	for fName, field := range r.Fields {
+		if strings.EqualFold(field.Path, tagFieldPath) {
+			return fName, nil
+		}
+	}
+	// If the tagFieldPath did not exist in CRD, return an error
+	return "", fmt.Errorf("tag field path %s does not exist inside %s"+
+		" crd", tagFieldPath, r.Names.Original)
+}
+
+// GetTagField return the model.Field representing the Tag field for CRD. If no
+// such field is found an error is returned.
+func (r *CRD) GetTagField() (*Field, error) {
+	if r.GetIgnoreTagging() {
+		return nil, nil
+	}
+	tagFieldName, err := r.GetTagFieldName()
+	if err != nil {
+		return nil, err
+	}
+	tagField := r.Fields[tagFieldName]
+	return tagField, nil
+}
+
+// GetTagKeyMemberName returns the member name which represents tag key.
+// The default value is "Key". This is only applicable for tag fields with
+// shape list of struct.If the tag field shape is not list of struct, an empty
+// string is returned.
+func (r *CRD) GetTagKeyMemberName() (keyMemberName string) {
+	tagField, _ := r.GetTagField()
+	if tagField == nil {
+		return keyMemberName
+	}
+	// TagKey member field will only be present when the tag field shape is
+	// list of struct
+	if isListOfStruct(tagField) {
+		keyMemberName = "Key"
+		if resConfig := r.Config().GetResourceConfig(r.Names.Original); resConfig != nil {
+			if tagsConfig := resConfig.TagConfig; tagsConfig != nil {
+				if tagsConfig.KeyMemberName != nil && *tagsConfig.KeyMemberName != "" {
+					keyMemberName = *tagsConfig.KeyMemberName
+				}
+			}
+		}
+	}
+	return keyMemberName
+}
+
+// GetTagValueMemberName returns the member name which represents tag value.
+// The default value is "Value". This is only applicable for tag fields with
+// shape list of struct.If the tag field shape is not list of struct, an empty
+// string is returned.
+func (r *CRD) GetTagValueMemberName() (valueMemberName string) {
+	tagField, _ := r.GetTagField()
+	if tagField == nil {
+		return valueMemberName
+	}
+	// TagValue member field will only be present when the tag field shape is
+	// list of struct.
+	if isListOfStruct(tagField) {
+		valueMemberName = "Value"
+		if resConfig := r.Config().GetResourceConfig(r.Names.Original); resConfig != nil {
+			if tagsConfig := resConfig.TagConfig; tagsConfig != nil {
+				if tagsConfig.ValueMemberName != nil && *tagsConfig.ValueMemberName != "" {
+					valueMemberName = *tagsConfig.ValueMemberName
+				}
+			}
+		}
+	}
+	return valueMemberName
+}
+
+// isListOfStruct method returns true is the shape of field is list of struct,
+// false otherwise
+func isListOfStruct(f *Field) bool {
+	if f.ShapeRef != nil && f.ShapeRef.Shape != nil {
+		if f.ShapeRef.Shape.Type == "list" {
+			if f.ShapeRef.Shape.MemberRef.Shape != nil {
+				if f.ShapeRef.Shape.MemberRef.Shape.Type == "structure" {
+					return true
+				}
+			}
+		}
+	}
+	return false
+}
+
 // NewCRD returns a pointer to a new `ackmodel.CRD` struct that describes a
 // single top-level resource in an AWS service API
 func NewCRD(