framework: Add semantic equality tests for set bug fix

go.mod

@@ -6,8 +6,10 @@ require (
 	github.com/hashicorp/go-memdb v1.3.4
 	github.com/hashicorp/terraform-json v0.24.0
 	github.com/hashicorp/terraform-plugin-framework v1.14.0
+	github.com/hashicorp/terraform-plugin-framework-nettypes v0.2.0
 	github.com/hashicorp/terraform-plugin-framework-timeouts v0.5.0
 	github.com/hashicorp/terraform-plugin-framework-timetypes v0.5.0
+	github.com/hashicorp/terraform-plugin-framework-validators v0.16.0
 	github.com/hashicorp/terraform-plugin-go v0.26.0
 	github.com/hashicorp/terraform-plugin-mux v0.18.0
 	github.com/hashicorp/terraform-plugin-sdk/v2 v2.36.1

go.sum

@@ -89,10 +89,14 @@ github.com/hashicorp/terraform-json v0.24.0 h1:rUiyF+x1kYawXeRth6fKFm/MdfBS6+lW4
 github.com/hashicorp/terraform-json v0.24.0/go.mod h1:Nfj5ubo9xbu9uiAoZVBsNOjvNKB66Oyrvtit74kC7ow=
 github.com/hashicorp/terraform-plugin-framework v1.14.0 h1:lsmTJqBlZ4GUabnDxj8Lsa5bmbuUKiUO3Zm9iIKSDf0=
 github.com/hashicorp/terraform-plugin-framework v1.14.0/go.mod h1:xNUKmvTs6ldbwTuId5euAtg37dTxuyj3LHS3uj7BHQ4=
+github.com/hashicorp/terraform-plugin-framework-nettypes v0.2.0 h1:Zap24rkky7SvNGGNYHMKFhAriP6+6riI21BMYOYgLRE=
+github.com/hashicorp/terraform-plugin-framework-nettypes v0.2.0/go.mod h1:CYPq+I5bWsmI8021VJY85hAyOeiEEQpdGW+NapdQn7A=
 github.com/hashicorp/terraform-plugin-framework-timeouts v0.5.0 h1:I/N0g/eLZ1ZkLZXUQ0oRSXa8YG/EF0CEuQP1wXdrzKw=
 github.com/hashicorp/terraform-plugin-framework-timeouts v0.5.0/go.mod h1:t339KhmxnaF4SzdpxmqW8HnQBHVGYazwtfxU0qCs4eE=
 github.com/hashicorp/terraform-plugin-framework-timetypes v0.5.0 h1:v3DapR8gsp3EM8fKMh6up9cJUFQ2iRaFsYLP8UJnCco=
 github.com/hashicorp/terraform-plugin-framework-timetypes v0.5.0/go.mod h1:c3PnGE9pHBDfdEVG9t1S1C9ia5LW+gkFR0CygXlM8ak=
+github.com/hashicorp/terraform-plugin-framework-validators v0.16.0 h1:O9QqGoYDzQT7lwTXUsZEtgabeWW96zUBh47Smn2lkFA=
+github.com/hashicorp/terraform-plugin-framework-validators v0.16.0/go.mod h1:Bh89/hNmqsEWug4/XWKYBwtnw3tbz5BAy1L1OgvbIaY=
 github.com/hashicorp/terraform-plugin-go v0.26.0 h1:cuIzCv4qwigug3OS7iKhpGAbZTiypAfFQmw8aE65O2M=
 github.com/hashicorp/terraform-plugin-go v0.26.0/go.mod h1:+CXjuLDiFgqR+GcrM5a2E2Kal5t5q2jb0E3D57tTdNY=
 github.com/hashicorp/terraform-plugin-log v0.9.0 h1:i7hOA+vdAItN1/7UrfBqBwvYPQ9TFvymaRGZED3FCV0=

internal/framework5provider/provider.go

@@ -91,6 +91,7 @@ func (p *testProvider) Resources(_ context.Context) []func() resource.Resource {
 		NewTFSDKReflectionResource,
 		NewMoveStateResource,
 		NewSetNestedBlockWithDefaultsResource,
+		NewSetSemanticEqualityResource,
 	}
 }
 

internal/framework5provider/set_semantic_equality_resource.go

@@ -0,0 +1,137 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package framework
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-framework-nettypes/iptypes"
+	"github.com/hashicorp/terraform-plugin-framework-validators/setvalidator"
+	"github.com/hashicorp/terraform-plugin-framework/attr"
+	"github.com/hashicorp/terraform-plugin-framework/resource"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+)
+
+var _ resource.Resource = SetSemanticEqualityResource{}
+
+func NewSetSemanticEqualityResource() resource.Resource {
+	return &SetSemanticEqualityResource{}
+}
+
+// This resource tests that semantic equality for elements inside of a set are correctly executed
+// Original bug: https://github.com/hashicorp/terraform-plugin-framework/issues/1061
+type SetSemanticEqualityResource struct{}
+
+func (r SetSemanticEqualityResource) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
+	resp.TypeName = req.ProviderTypeName + "_set_semantic_equality"
+}
+
+func (r SetSemanticEqualityResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
+	resp.Schema = schema.Schema{
+		Attributes: map[string]schema.Attribute{
+			"set_of_ipv6": schema.SetAttribute{
+				ElementType: iptypes.IPv6AddressType{},
+				Required:    true,
+			},
+		},
+		Blocks: map[string]schema.Block{
+			"set_nested_block": schema.SetNestedBlock{
+				Validators: []validator.Set{
+					setvalidator.IsRequired(),
+				},
+				NestedObject: schema.NestedBlockObject{
+					Attributes: map[string]schema.Attribute{
+						"ipv6": schema.StringAttribute{
+							CustomType: iptypes.IPv6AddressType{},
+							Required:   true,
+						},
+					},
+				},
+			},
+		},
+	}
+}
+
+func (r SetSemanticEqualityResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
+	var data SetSemanticEqualityResourceModel
+
+	resp.Diagnostics.Append(req.Plan.Get(ctx, &data)...)
+
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	// Simulate remote API returning semantically equivalent IPv6 addresses
+	data.shiftAndShorten()
+
+	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
+}
+
+func (r SetSemanticEqualityResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) {
+	var data SetSemanticEqualityResourceModel
+
+	resp.Diagnostics.Append(req.State.Get(ctx, &data)...)
+
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	// Simulate remote API returning semantically equivalent IPv6 addresses
+	data.shiftAndShorten()
+
+	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
+}
+
+func (r SetSemanticEqualityResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) {
+	var data SetSemanticEqualityResourceModel
+
+	resp.Diagnostics.Append(req.Plan.Get(ctx, &data)...)
+
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	// Simulate remote API returning semantically equivalent IPv6 addresses
+	data.shiftAndShorten()
+
+	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
+}
+
+func (r SetSemanticEqualityResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) {
+}
+
+type SetSemanticEqualityResourceModel struct {
+	SetOfIPv6      types.Set `tfsdk:"set_of_ipv6"`
+	SetNestedBlock types.Set `tfsdk:"set_nested_block"`
+}
+
+var setObjectWithIPv6 = types.ObjectType{
+	AttrTypes: map[string]attr.Type{
+		"ipv6": iptypes.IPv6AddressType{},
+	},
+}
+
+// Shifts + switches data to shortened IPv6 addresses, but is semantically equal to test config
+func (m *SetSemanticEqualityResourceModel) shiftAndShorten() {
+	m.SetOfIPv6 = types.SetValueMust(iptypes.IPv6AddressType{}, []attr.Value{
+		iptypes.NewIPv6AddressValue("2001:DB8::8:800:200C:417A"),
+		iptypes.NewIPv6AddressValue("::FFFF:192.168.255.255"),
+		iptypes.NewIPv6AddressValue("::"),
+		iptypes.NewIPv6AddressValue("::101"),
+	})
+
+	m.SetNestedBlock = types.SetValueMust(setObjectWithIPv6, []attr.Value{
+		types.ObjectValueMust(setObjectWithIPv6.AttributeTypes(), map[string]attr.Value{
+			"ipv6": iptypes.NewIPv6AddressValue("::FFFF:192.168.255.255"),
+		}),
+		types.ObjectValueMust(setObjectWithIPv6.AttributeTypes(), map[string]attr.Value{
+			"ipv6": iptypes.NewIPv6AddressValue("FF01::"),
+		}),
+		types.ObjectValueMust(setObjectWithIPv6.AttributeTypes(), map[string]attr.Value{
+			"ipv6": iptypes.NewIPv6AddressValue("2001:DB8::8:800:200C:417A"),
+		}),
+	})
+}

internal/framework5provider/set_semantic_equality_resource_test.go

@@ -0,0 +1,99 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package framework
+
+import (
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-framework/providerserver"
+	"github.com/hashicorp/terraform-plugin-go/tfprotov5"
+	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
+	"github.com/hashicorp/terraform-plugin-testing/plancheck"
+)
+
+// This resource tests that semantic equality for elements inside of a set are correctly executed
+// Original bug: https://github.com/hashicorp/terraform-plugin-framework/issues/1061
+func TestSetSemanticEqualityResource(t *testing.T) {
+	resource.UnitTest(t, resource.TestCase{
+		ProtoV5ProviderFactories: map[string]func() (tfprotov5.ProviderServer, error){
+			"framework": providerserver.NewProtocol5WithError(New()),
+		},
+		Steps: []resource.TestStep{
+			{
+				// The resource Create/Read will return semantically equal data that will cause a diff if returned to Terraform.
+				// The semantic equality logic in iptypes.IPv6Address allows this configuration to successfully apply.
+				Config: `resource "framework_set_semantic_equality" "test" {
+					set_of_ipv6 = [
+						"0:0:0:0:0:0:0:0",
+						"2001:0DB8:0000:0000:0008:0800:200C:417A",
+						"0:0:0:0:0:0:0:101",
+						"0:0:0:0:0:FFFF:192.168.255.255",
+					]
+
+					set_nested_block {
+						ipv6 = "FF01:0:0:0:0:0:0:0"
+					}
+					set_nested_block {
+						ipv6 = "2001:db8::8:800:200c:417a"
+					}
+					set_nested_block {
+						ipv6 = "0:0:0:0:0:FFFF:192.168.255.255"
+					}
+				}`,
+			},
+			{
+				// Re-ordering the set doesn't produce a diff with semantically equal hardcoded data
+				Config: `resource "framework_set_semantic_equality" "test" {
+					set_of_ipv6 = [
+						"0:0:0:0:0:FFFF:192.168.255.255",
+						"0:0:0:0:0:0:0:0",
+						"2001:0DB8:0000:0000:0008:0800:200C:417A",
+						"0:0:0:0:0:0:0:101",
+					]
+
+					set_nested_block {
+						ipv6 = "0:0:0:0:0:FFFF:192.168.255.255"
+					}
+					set_nested_block {
+						ipv6 = "FF01:0:0:0:0:0:0:0"
+					}
+					set_nested_block {
+						ipv6 = "2001:db8::8:800:200c:417a"
+					}
+				}`,
+				ConfigPlanChecks: resource.ConfigPlanChecks{
+					PreApply: []plancheck.PlanCheck{
+						plancheck.ExpectResourceAction("framework_set_semantic_equality.test", plancheck.ResourceActionNoop),
+					},
+				},
+			},
+			{
+				// User config changes will still produce a diff, but the apply will be successful with semantically equal data
+				Config: `resource "framework_set_semantic_equality" "test" {
+					set_of_ipv6 = [
+						"0:0:0:0:0:FFFF:192.168.255.255",
+						"::", # <----------- This update will cause a diff 
+						"2001:0DB8:0000:0000:0008:0800:200C:417A",
+						"0:0:0:0:0:0:0:101",
+					]
+
+					set_nested_block {
+						ipv6 = "0:0:0:0:0:FFFF:192.168.255.255"
+					}
+					set_nested_block {
+						ipv6 = "FF01::" # <----------- This update will cause a diff 
+					}
+					set_nested_block {
+						ipv6 = "2001:db8::8:800:200c:417a"
+					}
+				}`,
+				ConfigPlanChecks: resource.ConfigPlanChecks{
+					PreApply: []plancheck.PlanCheck{
+						plancheck.ExpectResourceAction("framework_set_semantic_equality.test", plancheck.ResourceActionUpdate),
+					},
+				},
+			},
+		},
+	})
+}

internal/framework6provider/provider.go

@@ -91,6 +91,7 @@ func (p *testProvider) Resources(_ context.Context) []func() resource.Resource {
 		NewMoveStateResource,
 		NewSetNestedBlockWithDefaultsResource,
 		NewSetNestedAttributeWithDefaultsResource,
+		NewSetSemanticEqualityResource,
 	}
 }