Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Implement basic functionality for StructToSchema #3788

Merged
merged 3 commits into from
Jul 19, 2024
Merged

Implement basic functionality for StructToSchema #3788

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d72ed85
wip
edwardfeng-db Jul 11, 2024
81dd4d3
wip
edwardfeng-db Jul 12, 2024
cd99b67
update
edwardfeng-db Jul 17, 2024
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
103 changes: 103 additions & 0 deletions common/reflect_resource_plugin_framework.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"fmt"
"reflect"

"github.com/hashicorp/terraform-plugin-framework/provider/schema"
"github.com/hashicorp/terraform-plugin-framework/types"
)

Expand Down Expand Up @@ -289,3 +290,105 @@ func checkTheStringInForceSendFields(fieldName string, forceSendFields []string)
}
return false
}

func pluginFrameworkTypeToSchema(v reflect.Value) map[string]schema.Attribute {
Copy link
Contributor

Choose a reason for hiding this comment

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

This would also need to include aliases and tracking context that we currently have to typeToSchema for sdkv2?

Example -- we use tracking context for depth:

		if tc.depthExceeded(typeField) {
			// Skip the field if recursion depth is over the limit.
			log.Printf("[TRACE] over recursion limit, skipping field: %s, max depth: %d", getNameForType(typeField.Type), tc.getMaxDepthForTypeField(typeField))
			continue
		}

and aliases while getting field name:

fieldName := chooseFieldNameWithAliases(typeField, v.Type(), aliases)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For tracking context yes, alias no.

Tracking context is coming up as the next step for recursion depth limit.

In the future all of alias information will go directly into the proto layer with annotations, so we don't have to worry about them in tf

scm := map[string]schema.Attribute{}
rk := v.Kind()
if rk == reflect.Ptr {
v = v.Elem()
rk = v.Kind()
}
if rk != reflect.Struct {
panic(fmt.Errorf("Schema value of Struct is expected, but got %s: %#v", reflectKind(rk), v))
}
fields := listAllFields(v)
for _, field := range fields {
typeField := field.sf
fieldName := typeField.Tag.Get("tfsdk")
if fieldName == "-" {
continue
}
// For now everything is marked as optional. TODO: add tf annotations for computed, optional, etc.
kind := typeField.Type.Kind()
if kind == reflect.Ptr {
elem := typeField.Type.Elem()
sv := reflect.New(elem).Elem()
nestedScm := pluginFrameworkTypeToSchema(sv)
scm[fieldName] = schema.SingleNestedAttribute{Attributes: nestedScm, Optional: true}
} else if kind == reflect.Slice {
elem := typeField.Type.Elem()
if elem.Kind() == reflect.Ptr {
elem = elem.Elem()
}
if elem.Kind() != reflect.Struct {
panic(fmt.Errorf("unsupported slice value for %s: %s", fieldName, reflectKind(elem.Kind())))
}
switch elem {
case reflect.TypeOf(types.Bool{}):
scm[fieldName] = schema.ListAttribute{ElementType: types.BoolType, Optional: true}
case reflect.TypeOf(types.Int64{}):
scm[fieldName] = schema.ListAttribute{ElementType: types.Int64Type, Optional: true}
case reflect.TypeOf(types.Float64{}):
scm[fieldName] = schema.ListAttribute{ElementType: types.Float64Type, Optional: true}
case reflect.TypeOf(types.String{}):
scm[fieldName] = schema.ListAttribute{ElementType: types.StringType, Optional: true}
default:
// Nested struct
nestedScm := pluginFrameworkTypeToSchema(reflect.New(elem).Elem())
scm[fieldName] = schema.ListNestedAttribute{NestedObject: schema.NestedAttributeObject{Attributes: nestedScm}, Optional: true}
}
} else if kind == reflect.Map {
elem := typeField.Type.Elem()
if elem.Kind() == reflect.Ptr {
elem = elem.Elem()
}
if elem.Kind() != reflect.Struct {
panic(fmt.Errorf("unsupported map value for %s: %s", fieldName, reflectKind(elem.Kind())))
}
switch elem {
case reflect.TypeOf(types.Bool{}):
scm[fieldName] = schema.MapAttribute{ElementType: types.BoolType, Optional: true}
case reflect.TypeOf(types.Int64{}):
scm[fieldName] = schema.MapAttribute{ElementType: types.Int64Type, Optional: true}
case reflect.TypeOf(types.Float64{}):
scm[fieldName] = schema.MapAttribute{ElementType: types.Float64Type, Optional: true}
case reflect.TypeOf(types.String{}):
scm[fieldName] = schema.MapAttribute{ElementType: types.StringType, Optional: true}
default:
// Nested struct
nestedScm := pluginFrameworkTypeToSchema(reflect.New(elem).Elem())
scm[fieldName] = schema.MapNestedAttribute{NestedObject: schema.NestedAttributeObject{Attributes: nestedScm}, Optional: true}
}
} else if kind == reflect.Struct {
switch field.v.Interface().(type) {
case types.Bool:
scm[fieldName] = schema.BoolAttribute{Optional: true}
case types.Int64:
scm[fieldName] = schema.Int64Attribute{Optional: true}
case types.Float64:
scm[fieldName] = schema.Float64Attribute{Optional: true}
case types.String:
scm[fieldName] = schema.StringAttribute{Optional: true}
case types.List:
panic("types.List should never be used in tfsdk structs")
case types.Map:
panic("types.Map should never be used in tfsdk structs")
default:
// If it is a real stuct instead of a tfsdk type, recursively resolve it.
elem := typeField.Type
sv := reflect.New(elem)
nestedScm := pluginFrameworkTypeToSchema(sv)
scm[fieldName] = schema.SingleNestedAttribute{Attributes: nestedScm, Optional: true}
}
} else {
panic(fmt.Errorf("unknown type for field: %s", typeField.Name))
Copy link
Contributor

Choose a reason for hiding this comment

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

should we also print the type as well here?

}
}
return scm
}

func pluginFrameworkStructToSchema(v any) schema.Schema {
return schema.Schema{
Attributes: pluginFrameworkTypeToSchema(reflect.ValueOf(v)),
}
}
99 changes: 3 additions & 96 deletions common/reflect_resource_plugin_framework_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,13 @@ import (
"testing"
"time"

"github.com/hashicorp/terraform-plugin-framework/provider/schema"
"github.com/hashicorp/terraform-plugin-framework/tfsdk"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/stretchr/testify/assert"
)

type DummyTfSdk struct {
Enabled types.Bool `tfsdk:"enabled"`
Enabled types.Bool `tfsdk:"enabled",tf:"optional"`
Workers types.Int64 `tfsdk:"workers"`
Floats types.Float64 `tfsdk:"floats"`
Description types.String `tfsdk:"description"`
Expand Down Expand Up @@ -129,99 +128,8 @@ var tfSdkStruct = DummyTfSdk{
}

func TestGetAndSetPluginFramework(t *testing.T) {
// Creating schema.
scm := schema.Schema{
Attributes: map[string]schema.Attribute{
"enabled": schema.BoolAttribute{
Required: true,
},
"workers": schema.Int64Attribute{
Optional: true,
},
"description": schema.StringAttribute{
Optional: true,
},
"task": schema.StringAttribute{
Optional: true,
},
"repeated": schema.ListAttribute{
ElementType: types.Int64Type,
Optional: true,
},
"floats": schema.Float64Attribute{
Optional: true,
},
"nested": schema.SingleNestedAttribute{
Optional: true,
Attributes: map[string]schema.Attribute{
"name": schema.StringAttribute{
Optional: true,
},
"enabled": schema.BoolAttribute{
Optional: true,
},
},
},
"no_pointer_nested": schema.SingleNestedAttribute{
Optional: true,
Attributes: map[string]schema.Attribute{
"name": schema.StringAttribute{
Optional: true,
},
"enabled": schema.BoolAttribute{
Optional: true,
},
},
},
"nested_list": schema.ListNestedAttribute{
NestedObject: schema.NestedAttributeObject{
Attributes: map[string]schema.Attribute{
"name": schema.StringAttribute{
Optional: true,
},
"enabled": schema.BoolAttribute{
Optional: true,
},
},
},
Optional: true,
},
"map": schema.MapAttribute{
ElementType: types.StringType,
Optional: true,
},
"nested_pointer_list": schema.ListNestedAttribute{
NestedObject: schema.NestedAttributeObject{
Attributes: map[string]schema.Attribute{
"name": schema.StringAttribute{
Optional: true,
},
"enabled": schema.BoolAttribute{
Optional: true,
},
},
},
Optional: true,
},
"attributes": schema.MapAttribute{
ElementType: types.StringType,
Optional: true,
},
"nested_map": schema.MapNestedAttribute{
NestedObject: schema.NestedAttributeObject{
Attributes: map[string]schema.Attribute{
"name": schema.StringAttribute{
Optional: true,
},
"enabled": schema.BoolAttribute{
Optional: true,
},
},
},
Optional: true,
},
},
}
// Also test StructToSchema.
scm := pluginFrameworkStructToSchema(DummyTfSdk{})
state := tfsdk.State{
Schema: scm,
}
Expand All @@ -237,7 +145,6 @@ func TestGetAndSetPluginFramework(t *testing.T) {

// Assert the struct populated from .Get is exactly the same as the original tfsdk struct.
assert.True(t, reflect.DeepEqual(getterStruct, tfSdkStruct))

}

func TestStructConversion(t *testing.T) {
Expand Down
Loading