Support custom list and map fields (#691)

Issue #, if available:

Description of changes:
Prior to this PR custom fields could only be applied to `structure` shapes. This PR adds support for adding custom fields to the elements of `list` and `map` types as well.

- Add new addMemberShapRef function for applying a shape as a member of another shape
- Add error checks for unsupported types
- Add error check to prevent overriding an existing field
- Add unit test cases to validate new behavior

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

Author: knottnt

go.mod

@@ -4,7 +4,7 @@ go 1.25.0
 
 require (
 	github.com/aws-controllers-k8s/pkg v0.0.23
-	github.com/aws-controllers-k8s/runtime v0.58.0
+	github.com/aws-controllers-k8s/runtime v0.58.1
 	github.com/aws/aws-sdk-go v1.49.0
 	github.com/aws/aws-sdk-go-v2 v1.32.7
 	github.com/dlclark/regexp2 v1.10.0 // indirect

go.sum

@@ -64,8 +64,8 @@ github.com/asaskevich/govalidator v0.0.0-20180720115003-f9ffefc3facf/go.mod h1:l
 github.com/asaskevich/govalidator v0.0.0-20190424111038-f61b66f89f4a/go.mod h1:lB+ZfQJz7igIIfQNfa7Ml4HSf2uFQQRzpGGRXenZAgY=
 github.com/aws-controllers-k8s/pkg v0.0.23 h1:iqu8jKQUnyP/c6TiVcXySQYpkATui0iXFC5ax9x01oM=
 github.com/aws-controllers-k8s/pkg v0.0.23/go.mod h1:VvdjLWmR6IJ3KU8KByKiq/lJE8M+ur2piXysXKTGUS0=
-github.com/aws-controllers-k8s/runtime v0.58.0 h1:PbM3hsM5z66BSPTb2CBBElYmGF3EgSbUO88efLXxL78=
-github.com/aws-controllers-k8s/runtime v0.58.0/go.mod h1:WPlOiAG+xGySh1I076llz5g6nbuUeH62Qxh49hnieGo=
+github.com/aws-controllers-k8s/runtime v0.58.1 h1:FZso3Bwd2JIqglH6cpFurNAWkIyc4Z1qNXE7+t0wxdI=
+github.com/aws-controllers-k8s/runtime v0.58.1/go.mod h1:WPlOiAG+xGySh1I076llz5g6nbuUeH62Qxh49hnieGo=
 github.com/aws/aws-sdk-go v1.49.0 h1:g9BkW1fo9GqKfwg2+zCD+TW/D36Ux+vtfJ8guF4AYmY=
 github.com/aws/aws-sdk-go v1.49.0/go.mod h1:LF8svs817+Nz+DmiMQKTO3ubZ/6IaTpq3TjupRn3Eqk=
 github.com/aws/aws-sdk-go-v2 v1.32.7 h1:ky5o35oENWi0JYWUZkB7WYvVPP+bcRF5/Iq7JWSb5Rw=

pkg/model/crd.go

@@ -802,8 +802,33 @@ func (crd *CRD) addCustomNestedFields(customNestedFields map[string]*ackgenconfi
 		if err != nil {
 			return fmt.Errorf("resource %q, custom nested field %q: %w", crd.Names.Original, customNestedField, err)
 		}
-		parentField.ShapeRef.Shape.MemberRefs[fieldName] = memberShapeRef
+		//parentField.ShapeRef.Shape.MemberRefs[fieldName] = memberShapeRef
+		if err := addMemberShapRef(parentField.ShapeRef, memberShapeRef, fieldName); err != nil {
+			return fmt.Errorf("resource %q, custom nested field %q: %w", crd.Names.Original, customNestedField, err)
+		}
+	}
+	return nil
+}
+
+// addMemberShapRef injects a new member shape into the specified shape.
+// It returns an error if the shape type is unsupported or if a member with
+// the given field name already exists.
+func addMemberShapRef(shapeRef, memberShapeRef *awssdkmodel.ShapeRef, fieldName string) error {
+	var memberRefs map[string]*awssdkmodel.ShapeRef
+	switch shapeRef.Shape.Type {
+	case "structure":
+		memberRefs = shapeRef.Shape.MemberRefs
+	case "list":
+		memberRefs = shapeRef.Shape.MemberRef.Shape.MemberRefs
+	case "map":
+		memberRefs = shapeRef.Shape.ValueRef.Shape.MemberRefs
+	default:
+		return fmt.Errorf("unsupported shape type %q for adding member %q", shapeRef.Shape.Type, fieldName)
+	}
+	if _, exists := memberRefs[fieldName]; exists {
+		return fmt.Errorf("member %q already exists in shape of type %q", fieldName, shapeRef.Shape.Type)
 	}
+	memberRefs[fieldName] = memberShapeRef
 	return nil
 }
 

pkg/model/crd_test.go

@@ -0,0 +1,323 @@
+// 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 model
+
+import (
+	"testing"
+
+	awssdkmodel "github.com/aws-controllers-k8s/code-generator/pkg/api"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestAddMemberShapRef_Structure(t *testing.T) {
+	assert := assert.New(t)
+	require := require.New(t)
+
+	structShape := &awssdkmodel.Shape{
+		Type:       "structure",
+		MemberRefs: map[string]*awssdkmodel.ShapeRef{},
+	}
+	shapeRef := &awssdkmodel.ShapeRef{
+		Shape: structShape,
+	}
+
+	memberShapeRef := &awssdkmodel.ShapeRef{
+		Shape: &awssdkmodel.Shape{Type: "string"},
+	}
+
+	err := addMemberShapRef(shapeRef, memberShapeRef, "NewField")
+
+	require.NoError(err)
+	require.Contains(structShape.MemberRefs, "NewField")
+	assert.Equal(memberShapeRef, structShape.MemberRefs["NewField"])
+}
+
+func TestAddMemberShapRef_List(t *testing.T) {
+	assert := assert.New(t)
+	require := require.New(t)
+
+	innerStructShape := &awssdkmodel.Shape{
+		Type:       "structure",
+		MemberRefs: map[string]*awssdkmodel.ShapeRef{},
+	}
+	listShape := &awssdkmodel.Shape{
+		Type: "list",
+		MemberRef: awssdkmodel.ShapeRef{
+			Shape: innerStructShape,
+		},
+	}
+	shapeRef := &awssdkmodel.ShapeRef{
+		Shape: listShape,
+	}
+
+	memberShapeRef := &awssdkmodel.ShapeRef{
+		Shape: &awssdkmodel.Shape{Type: "integer"},
+	}
+
+	err := addMemberShapRef(shapeRef, memberShapeRef, "Count")
+
+	require.NoError(err)
+	require.Contains(innerStructShape.MemberRefs, "Count")
+	assert.Equal(memberShapeRef, innerStructShape.MemberRefs["Count"])
+}
+
+func TestAddMemberShapRef_Map(t *testing.T) {
+	assert := assert.New(t)
+	require := require.New(t)
+
+	valueStructShape := &awssdkmodel.Shape{
+		Type:       "structure",
+		MemberRefs: map[string]*awssdkmodel.ShapeRef{},
+	}
+	mapShape := &awssdkmodel.Shape{
+		Type: "map",
+		ValueRef: awssdkmodel.ShapeRef{
+			Shape: valueStructShape,
+		},
+	}
+	shapeRef := &awssdkmodel.ShapeRef{
+		Shape: mapShape,
+	}
+
+	memberShapeRef := &awssdkmodel.ShapeRef{
+		Shape: &awssdkmodel.Shape{Type: "boolean"},
+	}
+
+	err := addMemberShapRef(shapeRef, memberShapeRef, "Enabled")
+
+	require.NoError(err)
+	require.Contains(valueStructShape.MemberRefs, "Enabled")
+	assert.Equal(memberShapeRef, valueStructShape.MemberRefs["Enabled"])
+}
+
+func TestAddMemberShapRef_UnsupportedType(t *testing.T) {
+	assert := assert.New(t)
+
+	scalarShape := &awssdkmodel.Shape{
+		Type:       "string",
+		MemberRefs: map[string]*awssdkmodel.ShapeRef{},
+	}
+	shapeRef := &awssdkmodel.ShapeRef{
+		Shape: scalarShape,
+	}
+
+	memberShapeRef := &awssdkmodel.ShapeRef{
+		Shape: &awssdkmodel.Shape{Type: "string"},
+	}
+
+	err := addMemberShapRef(shapeRef, memberShapeRef, "ShouldNotExist")
+
+	assert.Error(err)
+	assert.Contains(err.Error(), "unsupported shape type")
+	assert.Contains(err.Error(), "string")
+	assert.Contains(err.Error(), "ShouldNotExist")
+	assert.NotContains(scalarShape.MemberRefs, "ShouldNotExist")
+}
+
+func TestAddMemberShapRef_Structure_PreservesExistingMembers(t *testing.T) {
+	assert := assert.New(t)
+	require := require.New(t)
+
+	existingMemberRef := &awssdkmodel.ShapeRef{
+		Shape: &awssdkmodel.Shape{Type: "string"},
+	}
+	structShape := &awssdkmodel.Shape{
+		Type: "structure",
+		MemberRefs: map[string]*awssdkmodel.ShapeRef{
+			"ExistingField": existingMemberRef,
+		},
+	}
+	shapeRef := &awssdkmodel.ShapeRef{
+		Shape: structShape,
+	}
+
+	newMemberShapeRef := &awssdkmodel.ShapeRef{
+		Shape: &awssdkmodel.Shape{Type: "integer"},
+	}
+
+	err := addMemberShapRef(shapeRef, newMemberShapeRef, "NewField")
+
+	require.NoError(err)
+	require.Len(structShape.MemberRefs, 2)
+	assert.Equal(existingMemberRef, structShape.MemberRefs["ExistingField"])
+	assert.Equal(newMemberShapeRef, structShape.MemberRefs["NewField"])
+}
+
+func TestAddMemberShapRef_List_PreservesExistingMembers(t *testing.T) {
+	assert := assert.New(t)
+	require := require.New(t)
+
+	existingMemberRef := &awssdkmodel.ShapeRef{
+		Shape: &awssdkmodel.Shape{Type: "string"},
+	}
+	innerStructShape := &awssdkmodel.Shape{
+		Type: "structure",
+		MemberRefs: map[string]*awssdkmodel.ShapeRef{
+			"ExistingField": existingMemberRef,
+		},
+	}
+	listShape := &awssdkmodel.Shape{
+		Type: "list",
+		MemberRef: awssdkmodel.ShapeRef{
+			Shape: innerStructShape,
+		},
+	}
+	shapeRef := &awssdkmodel.ShapeRef{
+		Shape: listShape,
+	}
+
+	newMemberShapeRef := &awssdkmodel.ShapeRef{
+		Shape: &awssdkmodel.Shape{Type: "boolean"},
+	}
+
+	err := addMemberShapRef(shapeRef, newMemberShapeRef, "Active")
+
+	require.NoError(err)
+	require.Len(innerStructShape.MemberRefs, 2)
+	assert.Equal(existingMemberRef, innerStructShape.MemberRefs["ExistingField"])
+	assert.Equal(newMemberShapeRef, innerStructShape.MemberRefs["Active"])
+}
+
+func TestAddMemberShapRef_Map_PreservesExistingMembers(t *testing.T) {
+	assert := assert.New(t)
+	require := require.New(t)
+
+	existingMemberRef := &awssdkmodel.ShapeRef{
+		Shape: &awssdkmodel.Shape{Type: "string"},
+	}
+	valueStructShape := &awssdkmodel.Shape{
+		Type: "structure",
+		MemberRefs: map[string]*awssdkmodel.ShapeRef{
+			"ExistingField": existingMemberRef,
+		},
+	}
+	mapShape := &awssdkmodel.Shape{
+		Type: "map",
+		ValueRef: awssdkmodel.ShapeRef{
+			Shape: valueStructShape,
+		},
+	}
+	shapeRef := &awssdkmodel.ShapeRef{
+		Shape: mapShape,
+	}
+
+	newMemberShapeRef := &awssdkmodel.ShapeRef{
+		Shape: &awssdkmodel.Shape{Type: "integer"},
+	}
+
+	err := addMemberShapRef(shapeRef, newMemberShapeRef, "Priority")
+
+	require.NoError(err)
+	require.Len(valueStructShape.MemberRefs, 2)
+	assert.Equal(existingMemberRef, valueStructShape.MemberRefs["ExistingField"])
+	assert.Equal(newMemberShapeRef, valueStructShape.MemberRefs["Priority"])
+}
+
+func TestAddMemberShapRef_DuplicateField_Structure(t *testing.T) {
+	assert := assert.New(t)
+
+	oldMemberRef := &awssdkmodel.ShapeRef{
+		Shape: &awssdkmodel.Shape{Type: "string"},
+	}
+	structShape := &awssdkmodel.Shape{
+		Type: "structure",
+		MemberRefs: map[string]*awssdkmodel.ShapeRef{
+			"Field": oldMemberRef,
+		},
+	}
+	shapeRef := &awssdkmodel.ShapeRef{
+		Shape: structShape,
+	}
+
+	newMemberRef := &awssdkmodel.ShapeRef{
+		Shape: &awssdkmodel.Shape{Type: "integer"},
+	}
+
+	err := addMemberShapRef(shapeRef, newMemberRef, "Field")
+
+	assert.Error(err)
+	assert.Contains(err.Error(), "Field")
+	assert.Contains(err.Error(), "already exists")
+	// Original member should be unchanged
+	assert.Equal(oldMemberRef, structShape.MemberRefs["Field"])
+}
+
+func TestAddMemberShapRef_DuplicateField_List(t *testing.T) {
+	assert := assert.New(t)
+
+	oldMemberRef := &awssdkmodel.ShapeRef{
+		Shape: &awssdkmodel.Shape{Type: "string"},
+	}
+	innerStructShape := &awssdkmodel.Shape{
+		Type: "structure",
+		MemberRefs: map[string]*awssdkmodel.ShapeRef{
+			"Field": oldMemberRef,
+		},
+	}
+	listShape := &awssdkmodel.Shape{
+		Type: "list",
+		MemberRef: awssdkmodel.ShapeRef{
+			Shape: innerStructShape,
+		},
+	}
+	shapeRef := &awssdkmodel.ShapeRef{
+		Shape: listShape,
+	}
+
+	newMemberRef := &awssdkmodel.ShapeRef{
+		Shape: &awssdkmodel.Shape{Type: "integer"},
+	}
+
+	err := addMemberShapRef(shapeRef, newMemberRef, "Field")
+
+	assert.Error(err)
+	assert.Contains(err.Error(), "Field")
+	assert.Contains(err.Error(), "already exists")
+	assert.Equal(oldMemberRef, innerStructShape.MemberRefs["Field"])
+}
+
+func TestAddMemberShapRef_DuplicateField_Map(t *testing.T) {
+	assert := assert.New(t)
+
+	oldMemberRef := &awssdkmodel.ShapeRef{
+		Shape: &awssdkmodel.Shape{Type: "string"},
+	}
+	valueStructShape := &awssdkmodel.Shape{
+		Type: "structure",
+		MemberRefs: map[string]*awssdkmodel.ShapeRef{
+			"Field": oldMemberRef,
+		},
+	}
+	mapShape := &awssdkmodel.Shape{
+		Type: "map",
+		ValueRef: awssdkmodel.ShapeRef{
+			Shape: valueStructShape,
+		},
+	}
+	shapeRef := &awssdkmodel.ShapeRef{
+		Shape: mapShape,
+	}
+
+	newMemberRef := &awssdkmodel.ShapeRef{
+		Shape: &awssdkmodel.Shape{Type: "integer"},
+	}
+
+	err := addMemberShapRef(shapeRef, newMemberRef, "Field")
+
+	assert.Error(err)
+	assert.Contains(err.Error(), "Field")
+	assert.Contains(err.Error(), "already exists")
+	assert.Equal(oldMemberRef, valueStructShape.MemberRefs["Field"])
+}