Skip to content

Refactor SetResourceForStruct to iterate over targetShape members #289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions pkg/generate/code/common.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
package code

import (
"fmt"
"strings"

awssdkmodel "github.com/aws/aws-sdk-go/private/model/api"
Expand Down Expand Up @@ -188,3 +189,14 @@ func FindPrimaryIdentifierFieldNames(
}
return crField, shapeField
}

// GetMemberIndex returns the index of memberName by iterating over
// shape's slice of member names for deterministic ordering
func GetMemberIndex(shape *awssdkmodel.Shape, memberName string) (int, error) {
for index, shapeMemberName := range shape.MemberNames() {
if strings.EqualFold(shapeMemberName, memberName) {
return index, nil
}
}
return -1, fmt.Errorf("Could not find %s in shape %s", memberName, shape.ShapeName)
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job with this. It will allow the index numbers in variable names to remain consistent, cutting down on unnecessary code changes in generated controllers. thank you!

25 changes: 24 additions & 1 deletion pkg/generate/code/common_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -176,4 +176,27 @@ func TestFindPluralizedIdentifiersInShape_EC2_SG_ReadMany_Rename(t *testing.T) {

assert.Equal(expModelIdentifier, crIdentifier)
assert.Equal(expShapeIdentifier, shapeIdentifier)
}
}

func TestGetMemberIndex_EC2_DHCPOptions_ReadMany(t *testing.T) {
assert := assert.New(t)
require := require.New(t)

g := testutil.NewModelForService(t, "ec2")

crd := testutil.GetCRDByName(t, g, "DhcpOptions")
require.NotNil(crd)

op := crd.Ops.ReadMany
inputShape := op.InputRef.Shape
// inputShape members: [DhcpOptionsIds DryRun Filters MaxResults NextToken]

memberIndex, _ := code.GetMemberIndex(inputShape, "DhcpOptionsIds")
assert.Equal(0, memberIndex)
memberIndex, _ = code.GetMemberIndex(inputShape, "MaxResults")
assert.Equal(3, memberIndex)

memberIndex, err := code.GetMemberIndex(inputShape, "notValidMember")
assert.Equal(-1, memberIndex)
assert.NotNil(err)
}
44 changes: 27 additions & 17 deletions pkg/generate/code/set_resource.go
Original file line number Diff line number Diff line change
Expand Up @@ -1226,53 +1226,63 @@ func SetResourceForStruct(
sourceShape := sourceShapeRef.Shape
targetShape := targetShapeRef.Shape

for memberIndex, memberName := range sourceShape.MemberNames() {
targetMemberShapeRef := targetShape.MemberRefs[memberName]
if targetMemberShapeRef == nil {
for _, targetMemberName := range targetShape.MemberNames() {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be just fine for now (and is a perfect stepping stone for future commits, as you allude to in your PR summary). Long-term, I'd be keen to change this to loop over r.Fields[targetMemberName].MemberFields, though, which will contain all the additional custom fields as well.

sourceMemberShapeRef := sourceShape.MemberRefs[targetMemberName]
if sourceMemberShapeRef == nil {
continue
}
memberVarName := fmt.Sprintf("%sf%d", targetVarName, memberIndex)
memberShapeRef := sourceShape.MemberRefs[memberName]
memberShape := memberShapeRef.Shape
cleanNames := names.New(memberName)
sourceAdaptedVarName := sourceVarName + "." + memberName
// Upstream logic iterates over sourceShape members and therefore uses
// the sourceShape's index; continue using sourceShape's index here for consistency.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

sourceMemberIndex, err := GetMemberIndex(sourceShape, targetMemberName)
if err != nil {
msg := fmt.Sprintf(
"could not determine source shape index: %v", err)
panic(msg)
}

targetMemberShapeRef := targetShape.MemberRefs[targetMemberName]
indexedVarName := fmt.Sprintf("%sf%d", targetVarName, sourceMemberIndex)
sourceMemberShape := sourceMemberShapeRef.Shape
targetMemberCleanNames := names.New(targetMemberName)
sourceAdaptedVarName := sourceVarName + "." + targetMemberName
out += fmt.Sprintf(
"%sif %s != nil {\n", indent, sourceAdaptedVarName,
)
qualifiedTargetVar := fmt.Sprintf(
"%s.%s", targetVarName, cleanNames.Camel,
"%s.%s", targetVarName, targetMemberCleanNames.Camel,
)
switch memberShape.Type {

switch sourceMemberShape.Type {
case "list", "structure", "map":
{
out += varEmptyConstructorK8sType(
cfg, r,
memberVarName,
indexedVarName,
targetMemberShapeRef.Shape,
indentLevel+1,
)
out += setResourceForContainer(
cfg, r,
cleanNames.Camel,
memberVarName,
targetMemberCleanNames.Camel,
indexedVarName,
targetMemberShapeRef,
nil,
sourceAdaptedVarName,
memberShapeRef,
sourceMemberShapeRef,
indentLevel+1,
)
out += setResourceForScalar(
qualifiedTargetVar,
memberVarName,
memberShapeRef,
indexedVarName,
sourceMemberShapeRef,
indentLevel+1,
)
}
default:
out += setResourceForScalar(
qualifiedTargetVar,
sourceAdaptedVarName,
memberShapeRef,
sourceMemberShapeRef,
indentLevel+1,
)
}
Expand Down