Merge pull request #38 from jaypipes/renames

handle renamed fields in SetResource generation

Author: jaypipes

pkg/generate/code/set_resource.go

@@ -197,7 +197,12 @@ func SetResource(
 		var found bool
 		var targetMemberShapeRef *awssdkmodel.ShapeRef
 		targetAdaptedVarName := targetVarName
-		f, found = r.SpecFields[memberName]
+
+		// Check that the field has potentially been renamed
+		renamedName, _ := r.InputFieldRename(
+			op.Name, memberName,
+		)
+		f, found = r.SpecFields[renamedName]
 		if found {
 			targetAdaptedVarName += cfg.PrefixConfig.SpecField
 			if !performSpecUpdate {
@@ -452,7 +457,11 @@ func setResourceReadMany(
 		var found bool
 		var targetMemberShapeRef *awssdkmodel.ShapeRef
 		targetAdaptedVarName := targetVarName
-		f, found = r.SpecFields[memberName]
+		// Check that the field has potentially been renamed
+		renamedName, _ := r.InputFieldRename(
+			op.Name, memberName,
+		)
+		f, found = r.SpecFields[renamedName]
 		if found {
 			targetAdaptedVarName += cfg.PrefixConfig.SpecField
 		} else {

pkg/generate/code/set_resource_test.go

@@ -1945,3 +1945,79 @@ func TestSetResource_SQS_Queue_GetAttributes(t *testing.T) {
 		code.SetResourceGetAttributes(crd.Config(), crd, "resp", "ko", 1),
 	)
 }
+
+func TestSetResource_RDS_DBSubnetGroup_ReadMany(t *testing.T) {
+	assert := assert.New(t)
+	require := require.New(t)
+
+	g := testutil.NewGeneratorForService(t, "rds")
+
+	crd := testutil.GetCRDByName(t, g, "DBSubnetGroup")
+	require.NotNil(crd)
+
+	// There are renamed fields for Name and Description in order to
+	// "de-stutter" the field names. We want to verify that the SetResource for
+	// the DescribeDBSubnetGroups API operation sets these fields in the Spec
+	// properly
+	expected := `
+	found := false
+	for _, elem := range resp.DBSubnetGroups {
+		if elem.DBSubnetGroupArn != nil {
+			if ko.Status.ACKResourceMetadata == nil {
+				ko.Status.ACKResourceMetadata = &ackv1alpha1.ResourceMetadata{}
+			}
+			tmpARN := ackv1alpha1.AWSResourceName(*elem.DBSubnetGroupArn)
+			ko.Status.ACKResourceMetadata.ARN = &tmpARN
+		}
+		if elem.DBSubnetGroupDescription != nil {
+			ko.Spec.Description = elem.DBSubnetGroupDescription
+		}
+		if elem.DBSubnetGroupName != nil {
+			ko.Spec.Name = elem.DBSubnetGroupName
+		}
+		if elem.SubnetGroupStatus != nil {
+			ko.Status.SubnetGroupStatus = elem.SubnetGroupStatus
+		}
+		if elem.Subnets != nil {
+			f4 := []*svcapitypes.Subnet{}
+			for _, f4iter := range elem.Subnets {
+				f4elem := &svcapitypes.Subnet{}
+				if f4iter.SubnetAvailabilityZone != nil {
+					f4elemf0 := &svcapitypes.AvailabilityZone{}
+					if f4iter.SubnetAvailabilityZone.Name != nil {
+						f4elemf0.Name = f4iter.SubnetAvailabilityZone.Name
+					}
+					f4elem.SubnetAvailabilityZone = f4elemf0
+				}
+				if f4iter.SubnetIdentifier != nil {
+					f4elem.SubnetIdentifier = f4iter.SubnetIdentifier
+				}
+				if f4iter.SubnetOutpost != nil {
+					f4elemf2 := &svcapitypes.Outpost{}
+					if f4iter.SubnetOutpost.Arn != nil {
+						f4elemf2.ARN = f4iter.SubnetOutpost.Arn
+					}
+					f4elem.SubnetOutpost = f4elemf2
+				}
+				if f4iter.SubnetStatus != nil {
+					f4elem.SubnetStatus = f4iter.SubnetStatus
+				}
+				f4 = append(f4, f4elem)
+			}
+			ko.Status.Subnets = f4
+		}
+		if elem.VpcId != nil {
+			ko.Status.VPCID = elem.VpcId
+		}
+		found = true
+		break
+	}
+	if !found {
+		return nil, ackerr.NotFound
+	}
+`
+	assert.Equal(
+		expected,
+		code.SetResource(crd.Config(), crd, model.OpTypeList, "resp", "ko", 1, false),
+	)
+}

pkg/generate/generator.go

@@ -116,7 +116,7 @@ func (g *Generator) GetCRDs() ([]*ackmodel.CRD, error) {
 				createOp.Name, memberName,
 			)
 			memberNames := names.New(renamedName)
-			memberNames.ModelOrginal = memberName
+			memberNames.ModelOriginal = memberName
 			if memberName == "Attributes" && g.cfg.UnpacksAttributesMap(crdName) {
 				crd.UnpackAttributes()
 				continue
@@ -174,8 +174,14 @@ func (g *Generator) GetCRDs() ([]*ackmodel.CRD, error) {
 			if memberShapeRef.Shape == nil {
 				return nil, ErrNilShapePointer
 			}
-			memberNames := names.New(memberName)
-			if _, found := crd.SpecFields[memberName]; found {
+			// Check that the field in the output shape isn't the same as
+			// fields in the input shape (where the input shape has potentially
+			// been renamed)
+			renamedName, _ := crd.InputFieldRename(
+				createOp.Name, memberName,
+			)
+			memberNames := names.New(renamedName)
+			if _, found := crd.SpecFields[renamedName]; found {
 				// We don't put fields that are already in the Spec struct into
 				// the Status struct
 				continue

pkg/generate/testdata/models/apis/rds/0000-00-00/generator.yaml

@@ -1,3 +1,18 @@
 ignore:
   shape_names:
-    - DBSecurityGroupMembershipList
+    - DBSecurityGroupMembershipList
+resources:
+  DBSubnetGroup:
+    renames:
+      operations:
+        DescribeDBSubnetGroups:
+          input_fields:
+            DBSubnetGroupName: Name
+            DBSubnetGroupDescription: Description
+        CreateDBSubnetGroup:
+          input_fields:
+            DBSubnetGroupName: Name
+            DBSubnetGroupDescription: Description
+        DeleteDBSubnetGroup:
+          input_fields:
+            DBSubnetGroupName: Name

pkg/model/field.go

@@ -42,7 +42,7 @@ func (f *Field) IsRequired() bool {
 	if f.FieldConfig != nil && f.FieldConfig.IsRequired != nil {
 		return *f.FieldConfig.IsRequired
 	}
-	return util.InStrings(f.Names.ModelOrginal, f.CRD.Ops.Create.InputRef.Shape.Required)
+	return util.InStrings(f.Names.ModelOriginal, f.CRD.Ops.Create.InputRef.Shape.Required)
 }
 
 // newField returns a pointer to a new Field object

pkg/names/names.go

@@ -147,12 +147,12 @@ var goKeywords = []string{
 }
 
 type Names struct {
-	ModelOrginal string
-	Original     string
-	Camel        string
-	CamelLower   string
-	Lower        string
-	Snake        string
+	ModelOriginal string
+	Original      string
+	Camel         string
+	CamelLower    string
+	Lower         string
+	Snake         string
 }
 
 func New(original string) Names {