internal/fwserver: Ensure Attribute and Block Plan Modification Returns Custom Value Type Implementations When Using Custom Type NestedAttributeObject/NestedBlockObject #823

bendbennett · 2023-08-15T16:31:49Z

Closes: #767
Closes: #821
Reference: #768

This PR addresses diagnostic errors arising from using a CustomType associated with a NestedObject within a ListNestedAttribute, ListNestedBlock, MapNestedAttribute, SetNestedAttribute or SetNestedBlock. The diagnostic error generated is Invalid ... Element Type. Further details can be found in #821 and #767.

Previously, before logic updates:

=== NAME  TestAttributeModifyPlan/attribute-map-nested-nested-custom-nested-object
    attribute_plan_modification_test.go:3285: Unexpected response (-wanted, +got):   fwserver.ModifyAttributePlanResponse{
                AttributePlan: s`{"outer":{"nested_map_nested_attribute":{"inner":{"nested_attr":`...,
        -       Diagnostics:   nil,
        +       Diagnostics: diag.Diagnostics{
        +               diag.ErrorDiagnostic{
        +                       detail:  "While creating a Map value, an invalid element was detected. A M"...,
        +                       summary: "Invalid Map Element Type",
        +               },
        +               diag.ErrorDiagnostic{
        +                       detail:  "While creating a Map value, an invalid element was detected. A M"...,
        +                       summary: "Invalid Map Element Type",
        +               },
        +       },
                RequiresReplace: s"[]",
                Private:         nil,
          }
=== NAME  TestAttributeModifyPlan/attribute-map-nested-custom-nested-object
    attribute_plan_modification_test.go:3285: Unexpected response (-wanted, +got):   fwserver.ModifyAttributePlanResponse{
                AttributePlan: s`{"testkey":{"nested_attr":"testvalue"}}`,
        -       Diagnostics:   nil,
        +       Diagnostics: diag.Diagnostics{
        +               diag.ErrorDiagnostic{
        +                       detail:  "While creating a Map value, an invalid element was detected. A M"...,
        +                       summary: "Invalid Map Element Type",
        +               },
        +       },
                RequiresReplace: s"[]",
                Private:         nil,
          }
=== NAME  TestAttributeModifyPlan/attribute-set-nested-custom-nested-object
    attribute_plan_modification_test.go:3285: Unexpected response (-wanted, +got):   fwserver.ModifyAttributePlanResponse{
                AttributePlan: s`[{"nested_attr":"testvalue"}]`,
        -       Diagnostics:   nil,
        +       Diagnostics: diag.Diagnostics{
        +               diag.ErrorDiagnostic{
        +                       detail:  "While creating a Set value, an invalid element was detected. A S"...,
        +                       summary: "Invalid Set Element Type",
        +               },
        +       },
                RequiresReplace: s"[]",
                Private:         nil,
          }
=== NAME  TestAttributeModifyPlan/attribute-list-nested-nested-custom-nested-object
    attribute_plan_modification_test.go:3285: Unexpected response (-wanted, +got):   fwserver.ModifyAttributePlanResponse{
                AttributePlan: s`[{"nested_list_nested_attribute":[{"nested_attr":"testvalue"}]}]`,
        -       Diagnostics:   nil,
        +       Diagnostics: diag.Diagnostics{
        +               diag.ErrorDiagnostic{
        +                       detail:  "While creating a List value, an invalid element was detected. A "...,
        +                       summary: "Invalid List Element Type",
        +               },
        +               diag.ErrorDiagnostic{
        +                       detail:  "While creating a List value, an invalid element was detected. A "...,
        +                       summary: "Invalid List Element Type",
        +               },
        +       },
                RequiresReplace: s"[]",
                Private:         nil,
          }
=== NAME  TestAttributeModifyPlan/attribute-list-nested-custom-nested-object
    attribute_plan_modification_test.go:3285: Unexpected response (-wanted, +got):   fwserver.ModifyAttributePlanResponse{
                AttributePlan: s`[{"nested_attr":"testvalue"}]`,
        -       Diagnostics:   nil,
        +       Diagnostics: diag.Diagnostics{
        +               diag.ErrorDiagnostic{
        +                       detail:  "While creating a List value, an invalid element was detected. A "...,
        +                       summary: "Invalid List Element Type",
        +               },
        +       },
                RequiresReplace: s"[]",
                Private:         nil,
          }
=== NAME  TestAttributeModifyPlan/attribute-set-nested-nested-custom-nested-object
    attribute_plan_modification_test.go:3285: Unexpected response (-wanted, +got):   fwserver.ModifyAttributePlanResponse{
                AttributePlan: s`[{"nested_set_nested_attribute":[{"nested_attr":"testvalue"}]}]`,
        -       Diagnostics:   nil,
        +       Diagnostics: diag.Diagnostics{
        +               diag.ErrorDiagnostic{
        +                       detail:  "While creating a Set value, an invalid element was detected. A S"...,
        +                       summary: "Invalid Set Element Type",
        +               },
        +               diag.ErrorDiagnostic{
        +                       detail:  "While creating a Set value, an invalid element was detected. A S"...,
        +                       summary: "Invalid Set Element Type",
        +               },
        +       },
                RequiresReplace: s"[]",
                Private:         nil,
          }

=== NAME  TestBlockModifyPlan/block-set-nested-nested-custom-nested-object
    block_plan_modification_test.go:4040: Error: Invalid Set Element Type
        While creating a Set value, an invalid element was detected. A Set must use the single, given element type. This is always an issue with the provider and should be reported to the provider developers.
        
        Set Element Type: NestedObjectCustomType
        Set Index (0) Element Type: types.ObjectType["nested_attr":basetypes.StringType]
=== NAME  TestBlockModifyPlan/block-set-nested-custom-nested-object
    block_plan_modification_test.go:4040: Error: Invalid Set Element Type
        While creating a Set value, an invalid element was detected. A Set must use the single, given element type. This is always an issue with the provider and should be reported to the provider developers.
        
        Set Element Type: NestedObjectCustomType
        Set Index (0) Element Type: types.ObjectType["nested_attr":basetypes.StringType]
=== NAME  TestBlockModifyPlan/block-list-nested-nested-custom-nested-object
    block_plan_modification_test.go:4040: Error: Invalid List Element Type
        While creating a List value, an invalid element was detected. A List must use the single, given element type. This is always an issue with the provider and should be reported to the provider developers.
        
        List Element Type: NestedObjectCustomType
        List Index (0) Element Type: types.ObjectType["nested_attr":basetypes.StringType]
    block_plan_modification_test.go:4040: Error: Invalid List Element Type
        While creating a List value, an invalid element was detected. A List must use the single, given element type. This is always an issue with the provider and should be reported to the provider developers.
        
        List Element Type: ListNestedObjectCustomType
        List Index (0) Element Type: types.ObjectType["nested_list_nested":types.ListType[NestedObjectCustomType]]
    block_plan_modification_test.go:4042: Unexpected response (+wanted, -got):   fwserver.ModifyAttributePlanResponse{
                AttributePlan: s`[{"nested_list_nested":[{"nested_attr":"testvalue"}]}]`,
        -       Diagnostics:   nil,
        +       Diagnostics: diag.Diagnostics{
        +               diag.ErrorDiagnostic{
        +                       detail:  "While creating a List value, an invalid element was detected. A "...,
        +                       summary: "Invalid List Element Type",
        +               },
        +               diag.ErrorDiagnostic{
        +                       detail:  "While creating a List value, an invalid element was detected. A "...,
        +                       summary: "Invalid List Element Type",
        +               },
        +       },
                RequiresReplace: s"[]",
                Private:         nil,
          }
=== NAME  TestBlockModifyPlan/block-set-nested-custom-nested-object
    block_plan_modification_test.go:4042: Unexpected response (+wanted, -got):   fwserver.ModifyAttributePlanResponse{
                AttributePlan: s`[{"nested_attr":"testvalue"}]`,
        -       Diagnostics:   nil,
        +       Diagnostics: diag.Diagnostics{
        +               diag.ErrorDiagnostic{
        +                       detail:  "While creating a Set value, an invalid element was detected. A S"...,
        +                       summary: "Invalid Set Element Type",
        +               },
        +       },
                RequiresReplace: s"[]",
                Private:         nil,
          }
=== NAME  TestBlockModifyPlan/block-set-nested-nested-custom-nested-object
    block_plan_modification_test.go:4040: Error: Invalid Set Element Type
        While creating a Set value, an invalid element was detected. A Set must use the single, given element type. This is always an issue with the provider and should be reported to the provider developers.
        
        Set Element Type: SetNestedObjectCustomType
        Set Index (0) Element Type: types.ObjectType["nested_set_nested":types.SetType[NestedObjectCustomType]]
=== NAME  TestBlockModifyPlan/block-set-nested-nested-custom-nested-object
    block_plan_modification_test.go:4042: Unexpected response (+wanted, -got):   fwserver.ModifyAttributePlanResponse{
                AttributePlan: s`[{"nested_set_nested":[{"nested_attr":"testvalue"}]}]`,
        -       Diagnostics:   nil,
        +       Diagnostics: diag.Diagnostics{
        +               diag.ErrorDiagnostic{
        +                       detail:  "While creating a Set value, an invalid element was detected. A S"...,
        +                       summary: "Invalid Set Element Type",
        +               },
        +               diag.ErrorDiagnostic{
        +                       detail:  "While creating a Set value, an invalid element was detected. A S"...,
        +                       summary: "Invalid Set Element Type",
        +               },
        +       },
                RequiresReplace: s"[]",
                Private:         nil,
          }
=== NAME  TestBlockModifyPlan/block-list-nested-custom-nested-object
    block_plan_modification_test.go:4040: Error: Invalid List Element Type
        While creating a List value, an invalid element was detected. A List must use the single, given element type. This is always an issue with the provider and should be reported to the provider developers.
        
        List Element Type: NestedObjectCustomType
        List Index (0) Element Type: types.ObjectType["nested_attr":basetypes.StringType]
    block_plan_modification_test.go:4042: Unexpected response (+wanted, -got):   fwserver.ModifyAttributePlanResponse{
                AttributePlan: s`[{"nested_attr":"testvalue"}]`,
        -       Diagnostics:   nil,
        +       Diagnostics: diag.Diagnostics{
        +               diag.ErrorDiagnostic{
        +                       detail:  "While creating a List value, an invalid element was detected. A "...,
        +                       summary: "Invalid List Element Type",
        +               },
        +       },
                RequiresReplace: s"[]",
                Private:         nil,
          }

…ype implementations for list, map, set nested attributes using a nested object with a custom type (#821) Reference: #768 Reference: #767

…implementations for list, set nested blocks using a nested object with a custom type (#821) Reference: #768 Reference: #767

…er (#821)

austinvalle

lgtm 🎸

bflad

Nice work! One minor testing thing I noticed, otherwise looks good to me 🚀

bflad · 2023-08-16T19:34:01Z

internal/testing/testschema/nested_attribute_object_custom_type.go

+		basetypes.ObjectType{
+			AttrTypes: map[string]attr.Type{
+				"nested_attr": types.StringType,
+			},
+		},


Sorry I might be being dense, should this be c.ObjectValue.Type(ctx) so it matches up with how the type was created?

Similarly with the other custom types below.

Perhaps I've misunderstood, but I don't think we can use the return value of c.ObjectValue.Type(ctx) as the type is attr.Type and NestedObjectCustomType expects the embedded type to be basetypes.ObjectType:

func (c NestedObjectCustomValue) Type(ctx context.Context) attr.Type { return NestedObjectCustomType{ c.ObjectValue.Type(ctx), // wrong type, expects `basetypes.ObjectType`, gets `attr.Type` } }

However, we could use a call to obtain the attributes for the embedded basetypes.ObjectType, for instance:

func (c NestedObjectCustomValue) Type(ctx context.Context) attr.Type { return NestedObjectCustomType{ basetypes.ObjectType{ AttrTypes: c.AttributeTypes(ctx), }, } }

Ah yes, you are correct -- I was just surprised by the hardcoded attribute names/types in there.

If this works:

func (c NestedObjectCustomValue) Type(ctx context.Context) attr.Type { return NestedObjectCustomType{ basetypes.ObjectType{ AttrTypes: c.AttributeTypes(ctx), }, } }

I'd highly suggest it, so anyone can implement test schemas without hardcoded schema implementation details. 👍

github-actions · 2023-09-17T02:03:37Z

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.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

internal/fwserver: Attribute plan modification returns custom value t…

fd35298

…ype implementations for list, map, set nested attributes using a nested object with a custom type (#821) Reference: #768 Reference: #767

bendbennett added the bug Something isn't working label Aug 15, 2023

bendbennett added this to the v1.3.5 milestone Aug 15, 2023

bendbennett added 4 commits August 16, 2023 10:53

internal/fwserver: Block plan modification returns custom value type …

3f4d956

…implementations for list, set nested blocks using a nested object with a custom type (#821) Reference: #768 Reference: #767

Using testschema throughout tests for attribute and block plan modifi…

0f46f8d

…er (#821)

Renaming attr and updating tests (#821)

f6fadff

Add changelog entry (#821)

7dbc386

bendbennett marked this pull request as ready for review August 16, 2023 10:48

bendbennett requested a review from a team as a code owner August 16, 2023 10:48

bendbennett mentioned this pull request Aug 16, 2023

Consider naming of "expand" and "flatten" functions for associated external types linked to list, map, set, single nested attributes and blocks hashicorp/terraform-plugin-codegen-framework#36

Closed

austinvalle approved these changes Aug 16, 2023

View reviewed changes

bflad approved these changes Aug 16, 2023

View reviewed changes

Removing hardcoded AttrTypes (#821)

d61ad1d

bendbennett merged commit 4ee15c8 into main Aug 17, 2023

bendbennett deleted the bendbendbennett/issues-821 branch August 17, 2023 15:45

github-actions bot locked as resolved and limited conversation to collaborators Sep 17, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

internal/fwserver: Ensure Attribute and Block Plan Modification Returns Custom Value Type Implementations When Using Custom Type NestedAttributeObject/NestedBlockObject #823

internal/fwserver: Ensure Attribute and Block Plan Modification Returns Custom Value Type Implementations When Using Custom Type NestedAttributeObject/NestedBlockObject #823

bendbennett commented Aug 15, 2023 •

edited

Loading

austinvalle left a comment

bflad left a comment

bflad Aug 16, 2023

bendbennett Aug 17, 2023

bflad Aug 17, 2023

github-actions bot commented Sep 17, 2023

internal/fwserver: Ensure Attribute and Block Plan Modification Returns Custom Value Type Implementations When Using Custom Type NestedAttributeObject/NestedBlockObject #823

internal/fwserver: Ensure Attribute and Block Plan Modification Returns Custom Value Type Implementations When Using Custom Type NestedAttributeObject/NestedBlockObject #823

Conversation

bendbennett commented Aug 15, 2023 • edited Loading

austinvalle left a comment

Choose a reason for hiding this comment

bflad left a comment

Choose a reason for hiding this comment

bflad Aug 16, 2023

Choose a reason for hiding this comment

bendbennett Aug 17, 2023

Choose a reason for hiding this comment

bflad Aug 17, 2023

Choose a reason for hiding this comment

github-actions bot commented Sep 17, 2023

bendbennett commented Aug 15, 2023 •

edited

Loading