chore: PoC - Schema code generation - Supporting nested attributes (#…

…2689) * support nested attribute types * rebasing changes related to unit testing adjustment
mongodb · Oct 16, 2024 · 8ddd508 · 8ddd508
1 parent 14e3671
commit 8ddd508
Show file tree

Hide file tree

Showing 8 changed files with 139 additions and 28 deletions.
diff --git a/tools/codegen/codespec/model.go b/tools/codegen/codespec/model.go
@@ -71,9 +71,6 @@ type MapNestedAttribute struct {
 type NumberAttribute struct {
 	Default *CustomDefault
 }
-type ObjectAttribute struct {
-	Default *CustomDefault
-}
 type SetAttribute struct {
 	Default     *CustomDefault
 	ElementType ElemType
@@ -83,8 +80,8 @@ type SetNestedAttribute struct {
 	NestedObject NestedAttributeObject
 }
 type SingleNestedAttribute struct {
-	Default    *CustomDefault
-	Attributes Attributes
+	Default      *CustomDefault
+	NestedObject NestedAttributeObject
 }
 type StringAttribute struct {
 	Default *string

diff --git a/tools/codegen/schema/codetemplate/schema-file.go.tmpl b/tools/codegen/schema/codetemplate/schema-file.go.tmpl
@@ -9,7 +9,8 @@ import (
 
 func ResourceSchema(ctx context.Context) schema.Schema {
 	return schema.Schema{
-		Attributes: map[string]schema.Attribute{ {{ range .SchemaAttributes }}{{ . }}{{- end }}
+		Attributes: map[string]schema.Attribute{ 
+			{{ .SchemaAttributes }} 
 		},
 	}
 }
diff --git a/tools/codegen/schema/codetemplate/template.go b/tools/codegen/schema/codetemplate/template.go
@@ -11,8 +11,8 @@ var schemaFileTemplate string
 
 type SchemaFileInputs struct {
 	PackageName      string
+	SchemaAttributes string
 	Imports          []string
-	SchemaAttributes []string
 }
 
 func ApplySchemaFileTemplate(inputs SchemaFileInputs) bytes.Buffer {

diff --git a/tools/codegen/schema/schema_attribute.go b/tools/codegen/schema/schema_attribute.go
@@ -12,15 +12,22 @@ type CodeStatement struct {
 	Imports []string
 }
 
-func GenerateSchemaAttributes(attrs codespec.Attributes) []CodeStatement {
-	result := []CodeStatement{}
+func GenerateSchemaAttributes(attrs codespec.Attributes) CodeStatement {
+	attrsCode := []string{}
+	imports := []string{}
 	for i := range attrs {
-		result = append(result, attribute(&attrs[i]))
+		result := generateAttribute(&attrs[i])
+		attrsCode = append(attrsCode, result.Result)
+		imports = append(imports, result.Imports...)
+	}
+	finalAttrs := strings.Join(attrsCode, ",\n") + ","
+	return CodeStatement{
+		Result:  finalAttrs,
+		Imports: imports,
 	}
-	return result
 }
 
-func attribute(attr *codespec.Attribute) CodeStatement {
+func generateAttribute(attr *codespec.Attribute) CodeStatement {
 	generator := typeGenerator(attr)
 
 	typeDefinition := generator.TypeDefinition()
@@ -35,10 +42,9 @@ func attribute(attr *codespec.Attribute) CodeStatement {
 
 	name := attr.Name
 	propsResultString := strings.Join(properties, ",\n") + ","
-	code := fmt.Sprintf(`
-	"%s": %s{
+	code := fmt.Sprintf(`"%s": %s{
 		%s
-	},`, name, typeDefinition, propsResultString)
+	}`, name, typeDefinition, propsResultString)
 	return CodeStatement{
 		Result:  code,
 		Imports: imports,

diff --git a/tools/codegen/schema/schema_file.go b/tools/codegen/schema/schema_file.go
@@ -9,17 +9,11 @@ import (
 
 func GenerateGoCode(input genconfigmapper.Resource) string {
 	schemaAttrs := GenerateSchemaAttributes(input.Schema.Attributes)
-	attrsCode := []string{}
-	imports := []string{}
-	for _, attr := range schemaAttrs {
-		attrsCode = append(attrsCode, attr.Result)
-		imports = append(imports, attr.Imports...)
-	}
 
 	tmplInputs := codetemplate.SchemaFileInputs{
 		PackageName:      input.Name,
-		Imports:          imports,
-		SchemaAttributes: attrsCode,
+		Imports:          schemaAttrs.Imports,
+		SchemaAttributes: schemaAttrs.Result,
 	}
 	result := codetemplate.ApplySchemaFileTemplate(tmplInputs)
 

diff --git a/tools/codegen/schema/schema_file_test.go b/tools/codegen/schema/schema_file_test.go
@@ -9,6 +9,13 @@ import (
 	"go.mongodb.org/atlas-sdk/v20240530005/admin"
 )
 
+var stringAttr = codespec.Attribute{
+	Name:                     "string_attr",
+	String:                   &codespec.StringAttribute{},
+	Description:              admin.PtrString("string attribute"),
+	ComputedOptionalRequired: codespec.Optional,
+}
+
 type schemaGenerationTestCase struct {
 	inputModel     codespec.Resource
 	goldenFileName string
@@ -80,6 +87,52 @@ func TestSchemaGenerationFromCodeSpec(t *testing.T) {
 			},
 			goldenFileName: "primitive-attributes",
 		},
+		"Nested attributes": {
+			inputModel: codespec.Resource{
+				Name: "test_name",
+				Schema: &codespec.Schema{
+					Attributes: []codespec.Attribute{
+						{
+							Name:                     "nested_single_attr",
+							Description:              admin.PtrString("nested single attribute"),
+							ComputedOptionalRequired: codespec.Required,
+							SingleNested: &codespec.SingleNestedAttribute{
+								NestedObject: codespec.NestedAttributeObject{
+									Attributes: []codespec.Attribute{
+										stringAttr,
+									},
+								},
+							},
+						},
+						{
+							Name:                     "nested_list_attr",
+							Description:              admin.PtrString("nested list attribute"),
+							ComputedOptionalRequired: codespec.Optional,
+							ListNested: &codespec.ListNestedAttribute{
+								NestedObject: codespec.NestedAttributeObject{
+									Attributes: []codespec.Attribute{
+										stringAttr,
+									},
+								},
+							},
+						},
+						{
+							Name:                     "set_nested_attribute",
+							Description:              admin.PtrString("set nested attribute"),
+							ComputedOptionalRequired: codespec.ComputedOptional,
+							SetNested: &codespec.SetNestedAttribute{
+								NestedObject: codespec.NestedAttributeObject{
+									Attributes: []codespec.Attribute{
+										stringAttr,
+									},
+								},
+							},
+						},
+					},
+				},
+			},
+			goldenFileName: "nested-attributes",
+		},
 	}
 
 	for testName, tc := range testCases {

diff --git a/tools/codegen/schema/schema_nested_attribute.go b/tools/codegen/schema/schema_nested_attribute.go
@@ -1,6 +1,10 @@
 package schema
 
-import "github.com/mongodb/terraform-provider-mongodbatlas/tools/codegen/codespec"
+import (
+	"fmt"
+
+	"github.com/mongodb/terraform-provider-mongodbatlas/tools/codegen/codespec"
+)
 
 type ListNestedAttrGenerator struct {
 	model codespec.ListNestedAttribute
@@ -11,7 +15,7 @@ func (l *ListNestedAttrGenerator) TypeDefinition() string {
 }
 
 func (l *ListNestedAttrGenerator) TypeSpecificProperties() []CodeStatement {
-	return nil
+	return []CodeStatement{getPropertyForNestedObj(l.model.NestedObject)}
 }
 
 type SetNestedGenerator struct {
@@ -23,7 +27,7 @@ func (s *SetNestedGenerator) TypeDefinition() string {
 }
 
 func (s *SetNestedGenerator) TypeSpecificProperties() []CodeStatement {
-	return nil
+	return []CodeStatement{getPropertyForNestedObj(s.model.NestedObject)}
 }
 
 type MapNestedAttrGenerator struct {
@@ -35,7 +39,7 @@ func (m *MapNestedAttrGenerator) TypeDefinition() string {
 }
 
 func (m *MapNestedAttrGenerator) TypeSpecificProperties() []CodeStatement {
-	return nil
+	return []CodeStatement{getPropertyForNestedObj(m.model.NestedObject)}
 }
 
 type SingleNestedAttrGenerator struct {
@@ -47,5 +51,16 @@ func (s *SingleNestedAttrGenerator) TypeDefinition() string {
 }
 
 func (s *SingleNestedAttrGenerator) TypeSpecificProperties() []CodeStatement {
-	return nil
+	return []CodeStatement{getPropertyForNestedObj(s.model.NestedObject)}
+}
+
+func getPropertyForNestedObj(nested codespec.NestedAttributeObject) CodeStatement {
+	attrs := GenerateSchemaAttributes(nested.Attributes)
+	attributeProperty := fmt.Sprintf(`Attributes: map[string]schema.Attribute{ 
+		%s 
+	}`, attrs.Result)
+	return CodeStatement{
+		Result:  attributeProperty,
+		Imports: attrs.Imports,
+	}
 }
diff --git a/tools/codegen/schema/testdata/nested-attributes.golden.go b/tools/codegen/schema/testdata/nested-attributes.golden.go
@@ -0,0 +1,45 @@
+package test_name
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
+)
+
+func ResourceSchema(ctx context.Context) schema.Schema {
+	return schema.Schema{
+		Attributes: map[string]schema.Attribute{
+			"nested_single_attr": schema.SingleNestedAttribute{
+				Required:            true,
+				MarkdownDescription: "nested single attribute",
+				Attributes: map[string]schema.Attribute{
+					"string_attr": schema.StringAttribute{
+						Optional:            true,
+						MarkdownDescription: "string attribute",
+					},
+				},
+			},
+			"nested_list_attr": schema.ListNestedAttribute{
+				Optional:            true,
+				MarkdownDescription: "nested list attribute",
+				Attributes: map[string]schema.Attribute{
+					"string_attr": schema.StringAttribute{
+						Optional:            true,
+						MarkdownDescription: "string attribute",
+					},
+				},
+			},
+			"set_nested_attribute": schema.SetNestedAttribute{
+				Computed:            true,
+				Optional:            true,
+				MarkdownDescription: "set nested attribute",
+				Attributes: map[string]schema.Attribute{
+					"string_attr": schema.StringAttribute{
+						Optional:            true,
+						MarkdownDescription: "string attribute",
+					},
+				},
+			},
+		},
+	}
+}