types/basetypes: Add Tuple type support #870
Conversation
|
For some reason I forgot that the documentation existed in this repo 😖, updated the PR with the tuple docs ⚡ |
There was a problem hiding this comment.
This looks great to me 🚀 Just a few minor suggestions.
I wasn't 100% sure if we needed to implement (TupleType).ApplyTerraform5AttributePathStep for dynamic attributes, so I can update the implementation to return an error if that's not needed.
Adding the correct implementation now (which it looks like you did), rather than potentially discovering that as an issue later, is definitely appreciated!
| @@ -83,7 +83,7 @@ Call one of the following to create a `types.List` value: | |||
| * [`types.ListUnknown(attr.Type) types.List`](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework/types#ListUnknown): An unknown list value with the given element type. | |||
| * [`types.ListValue(attr.Type, []attr.Value) (types.List, diag.Diagnostics)`](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework/types#ListValue): A known value with the given element type and values. | |||
| * [`types.ListValueFrom(context.Context, attr.Type, any) (types.List, diag.Diagnostics)`](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework/types#ListValueFrom): A known value with the given element type and values. This can convert the source data from standard Go types into framework types as noted in the documentation for each element type, such as giving `[]*string` for a `types.List` of `types.String`. | |||
| * [`types.ListValueMust(map[string]attr.Type, map[string]attr.Value) types.List`](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework/types#ListValueMust): A known value with the given element type and values. Any diagnostics are converted to a runtime panic. This is recommended only for testing or exhaustively tested logic. | |||
| * [`types.ListValueMust(attr.Type, []attr.Value) types.List`](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework/types#ListValueMust): A known value with the given element type and values. Any diagnostics are converted to a runtime panic. This is recommended only for testing or exhaustively tested logic. | |||
There was a problem hiding this comment.
I definitely did NOT find this because I was copy pasting the docs 😅
bflad
added
enhancement
Co-authored-by: Brian Flad <bflad417@gmail.com>
Co-authored-by: Brian Flad <bflad417@gmail.com>
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
Ref: #54
This PR introduces
basetypes.TupleType,basetypes.TupleValue, and tuple helper functions/aliases in thetypespackage. This PR does not introduce any accompanyingTupleAttributeimplementations, so currently there is no way to describe this schema to Terraform core.Eventually when #147 is implemented, the
TupleTypewill be necessary to fully handle dynamic attributes, as then Terraform core could possible send a tuple to Plugin Framework.Notes
types.Tupleis not supported. Also added tests around the code that was refactored relating to sets/listsIntoandFromValue, so I created table tests for them and added tests for just what I refactored. We can continually update the tests as we make changes tointernal/reflect(TupleType).ApplyTerraform5AttributePathStepfor dynamic attributes, so I can update the implementation to return an error if that's not needed.