collect Field structs for members of structures (#258)

When inferring the structure of a CRD and its fields, we create a
`pkg/model.Field` struct for each *top-level* field in the CRD's Spec or
Status. The `pkg/model.GetCRDs()` function ends up calling
`pkg/model.CRD:AddSpecField()` and `pkg/model.CRD:AddStatusField()` for
those field definitions that the API inference stage of the generation
pipeline discovers in the aws-sdk-go API model.

Because we were creating `pkg/model.Field` objects for only the
top-level fields in Spec and Status and the `pkg/model.Field` object is
what was tied to a `pkg/generate/config.FieldConfig` object, this meant
that only the top-level field definitions were able to be *configured*
via the generator.yaml file. This is a problem for more complex APIs
like EC2 which have resources with top-level fields that are structures
themselves. We were not able to configure nested fields properly because
we were not actually constructing a `pkg/model.Field` object for these
nested fields.

This PR enhances the API inference process inside the code generator to
detect when a new `pkg/model.Field` refers to an
`aws-sdk-go/private/model.Shape` that is of type "structure" and recurse
through that Shape's MemberRefs collection, building a map of
`pkg/model.Field` objects for each member field along with a fieldpath
that allows these nested struct member fields to later be "found" by the
code generator.

Issue: aws-controllers-k8s/community#1100

Signed-off-by: Jay Pipes <[email protected]>

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

Author: jaypipes

pkg/model/field.go

@@ -47,6 +47,10 @@ type Field struct {
 	GoTypeWithPkgName string
 	ShapeRef          *awssdkmodel.ShapeRef
 	FieldConfig       *ackgenconfig.FieldConfig
+
+	// MemberFields is a map, keyed by the *renamed, cleaned, camel-cased name* of
+	// member fields when this Field is a struct type.
+	MemberFields map[string]*Field
 }
 
 // IsRequired checks the FieldConfig for Field and returns if the field is
@@ -162,6 +166,7 @@ func NewField(
 	shapeRef *awssdkmodel.ShapeRef,
 	cfg *ackgenconfig.FieldConfig,
 ) *Field {
+	memberFields := map[string]*Field{}
 	var gte, gt, gtwp string
 	var shape *awssdkmodel.Shape
 	if shapeRef != nil {
@@ -170,6 +175,15 @@ func NewField(
 
 	if shape != nil {
 		gte, gt, gtwp = CleanGoType(crd.sdkAPI, crd.cfg, shape, cfg)
+		if shape.Type == "structure" {
+			// "unpack" the member fields composing this struct field...
+			for _, memberName := range shape.MemberNames() {
+				cleanMemberNames := names.New(memberName)
+				memberPath := path + "." + cleanMemberNames.Camel
+				memberField := NewField(crd, memberPath, cleanMemberNames, shape.MemberRefs[memberName], cfg)
+				memberFields[cleanMemberNames.Camel] = memberField
+			}
+		}
 	} else {
 		gte = "string"
 		gt = "*string"
@@ -184,5 +198,6 @@ func NewField(
 		GoTypeElem:        gte,
 		GoTypeWithPkgName: gtwp,
 		FieldConfig:       cfg,
+		MemberFields:      memberFields,
 	}
 }

pkg/model/field_test.go

@@ -4,8 +4,10 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 
 	"github.com/aws-controllers-k8s/code-generator/pkg/model"
+	"github.com/aws-controllers-k8s/code-generator/pkg/testutil"
 )
 
 func TestParentFieldPath(t *testing.T) {
@@ -35,3 +37,42 @@ func TestParentFieldPath(t *testing.T) {
 		assert.Equal(tc.want, result)
 	}
 }
+
+func TestMemberFields(t *testing.T) {
+	assert := assert.New(t)
+	require := require.New(t)
+
+	g := testutil.NewModelForService(t, "ec2")
+
+	crds, err := g.GetCRDs()
+	require.Nil(err)
+
+	crd := getCRDByName("LaunchTemplate", crds)
+	require.NotNil(crd)
+
+	specFields := crd.SpecFields
+
+	// LaunchTemplate.Spec.LaunchTemplateData field is itself a struct field
+	// with a number of member fields. We are checking here to ensure that the
+	// LaunchTemplate.Spec.LaunchTemplateData Field definition properly
+	// gathered the member field information.
+	ltdField := specFields["LaunchTemplateData"]
+	require.NotNil(ltdField)
+	require.Equal(ltdField.Path, "LaunchTemplateData")
+	require.NotNil(ltdField.ShapeRef)
+	require.Equal(ltdField.ShapeRef.Shape.Type, "structure")
+
+	assert.NotNil(ltdField.MemberFields)
+
+	// HibernationOptions is a member of the LaunchTemplateData structure and
+	// is itself another structure field. Make sure that the Field definition
+	// for this nested structure member field exists.
+	hoField := ltdField.MemberFields["HibernationOptions"]
+	assert.NotNil(hoField)
+	assert.Equal(hoField.Path, "LaunchTemplateData.HibernationOptions")
+	assert.NotNil(hoField.MemberFields)
+
+	hocField := hoField.MemberFields["Configured"]
+	assert.NotNil(hocField)
+	assert.Equal(hocField.Path, "LaunchTemplateData.HibernationOptions.Configured")
+}