Skip to content

Commit

Permalink
internal/fwserver: Add unit test for PlanResourceChange with CustomTy…
Browse files Browse the repository at this point in the history 
…pe and Default (#771)

Reference: #715
Reference: #754

This adjusts the existing `PlanResourceChange` unit testing for schema-based default value handling to include a test case of an attribute with both `CustomType` and `Default` set. The framework now performs stricter value type checking and this test case can act as a canary should the framework's storage of data from Terraform be migrated to the framework type system. The testing passes as-is, unlike the original case of both `CustomType` and `PlanModifiers` being set after the validation logic introduction because the default value handling occurs in the underlying terraform-plugin-go type system so there is no need to re-instantiate custom value types.
  • Loading branch information
@bflad
bflad authored Jun 14, 2023
1 parent e9f48e6 commit 1401070
Showing 1 changed file with 76 additions and 63 deletions.
139 changes: 76 additions & 63 deletions internal/fwserver/server_planresourcechange_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,7 @@ func TestServerPlanResourceChange(t *testing.T) {
"test_computed_object": tftypes.Object{AttributeTypes: map[string]tftypes.Type{"a": tftypes.String}},
"test_computed_set": tftypes.Set{ElementType: tftypes.String},
"test_computed_string": tftypes.String,
"test_computed_string_custom_type": tftypes.String,
"test_computed_nested_list": tftypes.List{ElementType: tftypes.Object{AttributeTypes: map[string]tftypes.Type{"string_attribute": tftypes.String}}},
"test_computed_nested_list_attribute": tftypes.List{ElementType: tftypes.Object{AttributeTypes: map[string]tftypes.Type{"string_attribute": tftypes.String}}},
"test_computed_nested_map": tftypes.Map{ElementType: tftypes.Object{AttributeTypes: map[string]tftypes.Type{"string_attribute": tftypes.String}}},
Expand Down Expand Up @@ -458,6 +459,11 @@ func TestServerPlanResourceChange(t *testing.T) {
Computed: true,
Default: stringdefault.StaticString("one"),
},
"test_computed_string_custom_type": schema.StringAttribute{
Computed: true,
CustomType: testtypes.StringTypeWithSemanticEquals{},
Default: stringdefault.StaticString("one"),
},
"test_computed_nested_list": schema.ListAttribute{
Computed: true,
ElementType: types.ObjectType{
Expand Down Expand Up @@ -928,15 +934,16 @@ func TestServerPlanResourceChange(t *testing.T) {
request: &fwserver.PlanResourceChangeRequest{
Config: &tfsdk.Config{
Raw: tftypes.NewValue(testSchemaTypeDefault, map[string]tftypes.Value{
"test_computed_bool": tftypes.NewValue(tftypes.Bool, nil),
"test_computed_float64": tftypes.NewValue(tftypes.Number, nil),
"test_computed_int64": tftypes.NewValue(tftypes.Number, nil),
"test_computed_list": tftypes.NewValue(tftypes.List{ElementType: tftypes.String}, nil),
"test_computed_map": tftypes.NewValue(tftypes.Map{ElementType: tftypes.String}, nil),
"test_computed_number": tftypes.NewValue(tftypes.Number, nil),
"test_computed_object": tftypes.NewValue(tftypes.Object{AttributeTypes: map[string]tftypes.Type{"a": tftypes.String}}, nil),
"test_computed_set": tftypes.NewValue(tftypes.Set{ElementType: tftypes.String}, nil),
"test_computed_string": tftypes.NewValue(tftypes.String, nil),
"test_computed_bool": tftypes.NewValue(tftypes.Bool, nil),
"test_computed_float64": tftypes.NewValue(tftypes.Number, nil),
"test_computed_int64": tftypes.NewValue(tftypes.Number, nil),
"test_computed_list": tftypes.NewValue(tftypes.List{ElementType: tftypes.String}, nil),
"test_computed_map": tftypes.NewValue(tftypes.Map{ElementType: tftypes.String}, nil),
"test_computed_number": tftypes.NewValue(tftypes.Number, nil),
"test_computed_object": tftypes.NewValue(tftypes.Object{AttributeTypes: map[string]tftypes.Type{"a": tftypes.String}}, nil),
"test_computed_set": tftypes.NewValue(tftypes.Set{ElementType: tftypes.String}, nil),
"test_computed_string": tftypes.NewValue(tftypes.String, nil),
"test_computed_string_custom_type": tftypes.NewValue(tftypes.String, nil),
"test_computed_nested_list": tftypes.NewValue(
tftypes.List{
ElementType: tftypes.Object{
Expand Down Expand Up @@ -1053,15 +1060,16 @@ func TestServerPlanResourceChange(t *testing.T) {
},
ProposedNewState: &tfsdk.Plan{
Raw: tftypes.NewValue(testSchemaTypeDefault, map[string]tftypes.Value{
"test_computed_bool": tftypes.NewValue(tftypes.Bool, nil),
"test_computed_float64": tftypes.NewValue(tftypes.Number, nil),
"test_computed_int64": tftypes.NewValue(tftypes.Number, nil),
"test_computed_list": tftypes.NewValue(tftypes.List{ElementType: tftypes.String}, nil),
"test_computed_map": tftypes.NewValue(tftypes.Map{ElementType: tftypes.String}, nil),
"test_computed_number": tftypes.NewValue(tftypes.Number, nil),
"test_computed_object": tftypes.NewValue(tftypes.Object{AttributeTypes: map[string]tftypes.Type{"a": tftypes.String}}, nil),
"test_computed_set": tftypes.NewValue(tftypes.Set{ElementType: tftypes.String}, nil),
"test_computed_string": tftypes.NewValue(tftypes.String, nil),
"test_computed_bool": tftypes.NewValue(tftypes.Bool, nil),
"test_computed_float64": tftypes.NewValue(tftypes.Number, nil),
"test_computed_int64": tftypes.NewValue(tftypes.Number, nil),
"test_computed_list": tftypes.NewValue(tftypes.List{ElementType: tftypes.String}, nil),
"test_computed_map": tftypes.NewValue(tftypes.Map{ElementType: tftypes.String}, nil),
"test_computed_number": tftypes.NewValue(tftypes.Number, nil),
"test_computed_object": tftypes.NewValue(tftypes.Object{AttributeTypes: map[string]tftypes.Type{"a": tftypes.String}}, nil),
"test_computed_set": tftypes.NewValue(tftypes.Set{ElementType: tftypes.String}, nil),
"test_computed_string": tftypes.NewValue(tftypes.String, nil),
"test_computed_string_custom_type": tftypes.NewValue(tftypes.String, nil),
"test_computed_nested_list": tftypes.NewValue(
tftypes.List{
ElementType: tftypes.Object{
Expand Down Expand Up @@ -1183,15 +1191,16 @@ func TestServerPlanResourceChange(t *testing.T) {
expectedResponse: &fwserver.PlanResourceChangeResponse{
PlannedState: &tfsdk.State{
Raw: tftypes.NewValue(testSchemaTypeDefault, map[string]tftypes.Value{
"test_computed_bool": tftypes.NewValue(tftypes.Bool, true),
"test_computed_float64": tftypes.NewValue(tftypes.Number, 1.2345),
"test_computed_int64": tftypes.NewValue(tftypes.Number, 12345),
"test_computed_list": tftypes.NewValue(tftypes.List{ElementType: tftypes.String}, []tftypes.Value{tftypes.NewValue(tftypes.String, "default")}),
"test_computed_map": tftypes.NewValue(tftypes.Map{ElementType: tftypes.String}, map[string]tftypes.Value{"a": tftypes.NewValue(tftypes.String, "default")}),
"test_computed_number": tftypes.NewValue(tftypes.Number, big.NewFloat(1.2345)),
"test_computed_object": tftypes.NewValue(tftypes.Object{AttributeTypes: map[string]tftypes.Type{"a": tftypes.String}}, map[string]tftypes.Value{"a": tftypes.NewValue(tftypes.String, "default")}),
"test_computed_set": tftypes.NewValue(tftypes.Set{ElementType: tftypes.String}, []tftypes.Value{tftypes.NewValue(tftypes.String, "default")}),
"test_computed_string": tftypes.NewValue(tftypes.String, "one"),
"test_computed_bool": tftypes.NewValue(tftypes.Bool, true),
"test_computed_float64": tftypes.NewValue(tftypes.Number, 1.2345),
"test_computed_int64": tftypes.NewValue(tftypes.Number, 12345),
"test_computed_list": tftypes.NewValue(tftypes.List{ElementType: tftypes.String}, []tftypes.Value{tftypes.NewValue(tftypes.String, "default")}),
"test_computed_map": tftypes.NewValue(tftypes.Map{ElementType: tftypes.String}, map[string]tftypes.Value{"a": tftypes.NewValue(tftypes.String, "default")}),
"test_computed_number": tftypes.NewValue(tftypes.Number, big.NewFloat(1.2345)),
"test_computed_object": tftypes.NewValue(tftypes.Object{AttributeTypes: map[string]tftypes.Type{"a": tftypes.String}}, map[string]tftypes.Value{"a": tftypes.NewValue(tftypes.String, "default")}),
"test_computed_set": tftypes.NewValue(tftypes.Set{ElementType: tftypes.String}, []tftypes.Value{tftypes.NewValue(tftypes.String, "default")}),
"test_computed_string": tftypes.NewValue(tftypes.String, "one"),
"test_computed_string_custom_type": tftypes.NewValue(tftypes.String, "one"),
"test_computed_nested_list": tftypes.NewValue(
tftypes.List{
ElementType: tftypes.Object{
Expand Down Expand Up @@ -2426,15 +2435,16 @@ func TestServerPlanResourceChange(t *testing.T) {
request: &fwserver.PlanResourceChangeRequest{
Config: &tfsdk.Config{
Raw: tftypes.NewValue(testSchemaTypeDefault, map[string]tftypes.Value{
"test_computed_bool": tftypes.NewValue(tftypes.Bool, nil),
"test_computed_float64": tftypes.NewValue(tftypes.Number, nil),
"test_computed_int64": tftypes.NewValue(tftypes.Number, nil),
"test_computed_list": tftypes.NewValue(tftypes.List{ElementType: tftypes.String}, nil),
"test_computed_map": tftypes.NewValue(tftypes.Map{ElementType: tftypes.String}, nil),
"test_computed_number": tftypes.NewValue(tftypes.Number, nil),
"test_computed_object": tftypes.NewValue(tftypes.Object{AttributeTypes: map[string]tftypes.Type{"a": tftypes.String}}, nil),
"test_computed_set": tftypes.NewValue(tftypes.Set{ElementType: tftypes.String}, nil),
"test_computed_string": tftypes.NewValue(tftypes.String, nil),
"test_computed_bool": tftypes.NewValue(tftypes.Bool, nil),
"test_computed_float64": tftypes.NewValue(tftypes.Number, nil),
"test_computed_int64": tftypes.NewValue(tftypes.Number, nil),
"test_computed_list": tftypes.NewValue(tftypes.List{ElementType: tftypes.String}, nil),
"test_computed_map": tftypes.NewValue(tftypes.Map{ElementType: tftypes.String}, nil),
"test_computed_number": tftypes.NewValue(tftypes.Number, nil),
"test_computed_object": tftypes.NewValue(tftypes.Object{AttributeTypes: map[string]tftypes.Type{"a": tftypes.String}}, nil),
"test_computed_set": tftypes.NewValue(tftypes.Set{ElementType: tftypes.String}, nil),
"test_computed_string": tftypes.NewValue(tftypes.String, nil),
"test_computed_string_custom_type": tftypes.NewValue(tftypes.String, nil),
"test_computed_nested_list": tftypes.NewValue(
tftypes.List{
ElementType: tftypes.Object{
Expand Down Expand Up @@ -2551,15 +2561,16 @@ func TestServerPlanResourceChange(t *testing.T) {
},
ProposedNewState: &tfsdk.Plan{
Raw: tftypes.NewValue(testSchemaTypeDefault, map[string]tftypes.Value{
"test_computed_bool": tftypes.NewValue(tftypes.Bool, nil),
"test_computed_float64": tftypes.NewValue(tftypes.Number, nil),
"test_computed_int64": tftypes.NewValue(tftypes.Number, nil),
"test_computed_list": tftypes.NewValue(tftypes.List{ElementType: tftypes.String}, nil),
"test_computed_map": tftypes.NewValue(tftypes.Map{ElementType: tftypes.String}, nil),
"test_computed_number": tftypes.NewValue(tftypes.Number, nil),
"test_computed_object": tftypes.NewValue(tftypes.Object{AttributeTypes: map[string]tftypes.Type{"a": tftypes.String}}, nil),
"test_computed_set": tftypes.NewValue(tftypes.Set{ElementType: tftypes.String}, nil),
"test_computed_string": tftypes.NewValue(tftypes.String, nil),
"test_computed_bool": tftypes.NewValue(tftypes.Bool, nil),
"test_computed_float64": tftypes.NewValue(tftypes.Number, nil),
"test_computed_int64": tftypes.NewValue(tftypes.Number, nil),
"test_computed_list": tftypes.NewValue(tftypes.List{ElementType: tftypes.String}, nil),
"test_computed_map": tftypes.NewValue(tftypes.Map{ElementType: tftypes.String}, nil),
"test_computed_number": tftypes.NewValue(tftypes.Number, nil),
"test_computed_object": tftypes.NewValue(tftypes.Object{AttributeTypes: map[string]tftypes.Type{"a": tftypes.String}}, nil),
"test_computed_set": tftypes.NewValue(tftypes.Set{ElementType: tftypes.String}, nil),
"test_computed_string": tftypes.NewValue(tftypes.String, nil),
"test_computed_string_custom_type": tftypes.NewValue(tftypes.String, nil),
"test_computed_nested_list": tftypes.NewValue(
tftypes.List{
ElementType: tftypes.Object{
Expand Down Expand Up @@ -2676,15 +2687,16 @@ func TestServerPlanResourceChange(t *testing.T) {
},
PriorState: &tfsdk.State{
Raw: tftypes.NewValue(testSchemaTypeDefault, map[string]tftypes.Value{
"test_computed_bool": tftypes.NewValue(tftypes.Bool, false),
"test_computed_float64": tftypes.NewValue(tftypes.Number, 5.4321),
"test_computed_int64": tftypes.NewValue(tftypes.Number, 54321),
"test_computed_list": tftypes.NewValue(tftypes.List{ElementType: tftypes.String}, []tftypes.Value{tftypes.NewValue(tftypes.String, "prior-state")}),
"test_computed_map": tftypes.NewValue(tftypes.Map{ElementType: tftypes.String}, map[string]tftypes.Value{"a": tftypes.NewValue(tftypes.String, "prior-state")}),
"test_computed_number": tftypes.NewValue(tftypes.Number, big.NewFloat(5.4321)),
"test_computed_object": tftypes.NewValue(tftypes.Object{AttributeTypes: map[string]tftypes.Type{"a": tftypes.String}}, map[string]tftypes.Value{"a": tftypes.NewValue(tftypes.String, "prior-state")}),
"test_computed_set": tftypes.NewValue(tftypes.Set{ElementType: tftypes.String}, []tftypes.Value{tftypes.NewValue(tftypes.String, "prior-state")}),
"test_computed_string": tftypes.NewValue(tftypes.String, "two"),
"test_computed_bool": tftypes.NewValue(tftypes.Bool, false),
"test_computed_float64": tftypes.NewValue(tftypes.Number, 5.4321),
"test_computed_int64": tftypes.NewValue(tftypes.Number, 54321),
"test_computed_list": tftypes.NewValue(tftypes.List{ElementType: tftypes.String}, []tftypes.Value{tftypes.NewValue(tftypes.String, "prior-state")}),
"test_computed_map": tftypes.NewValue(tftypes.Map{ElementType: tftypes.String}, map[string]tftypes.Value{"a": tftypes.NewValue(tftypes.String, "prior-state")}),
"test_computed_number": tftypes.NewValue(tftypes.Number, big.NewFloat(5.4321)),
"test_computed_object": tftypes.NewValue(tftypes.Object{AttributeTypes: map[string]tftypes.Type{"a": tftypes.String}}, map[string]tftypes.Value{"a": tftypes.NewValue(tftypes.String, "prior-state")}),
"test_computed_set": tftypes.NewValue(tftypes.Set{ElementType: tftypes.String}, []tftypes.Value{tftypes.NewValue(tftypes.String, "prior-state")}),
"test_computed_string": tftypes.NewValue(tftypes.String, "two"),
"test_computed_string_custom_type": tftypes.NewValue(tftypes.String, "two"),
"test_computed_nested_list": tftypes.NewValue(
tftypes.List{
ElementType: tftypes.Object{
Expand Down Expand Up @@ -2840,15 +2852,16 @@ func TestServerPlanResourceChange(t *testing.T) {
expectedResponse: &fwserver.PlanResourceChangeResponse{
PlannedState: &tfsdk.State{
Raw: tftypes.NewValue(testSchemaTypeDefault, map[string]tftypes.Value{
"test_computed_bool": tftypes.NewValue(tftypes.Bool, true),
"test_computed_float64": tftypes.NewValue(tftypes.Number, 1.2345),
"test_computed_int64": tftypes.NewValue(tftypes.Number, 12345),
"test_computed_list": tftypes.NewValue(tftypes.List{ElementType: tftypes.String}, []tftypes.Value{tftypes.NewValue(tftypes.String, "default")}),
"test_computed_map": tftypes.NewValue(tftypes.Map{ElementType: tftypes.String}, map[string]tftypes.Value{"a": tftypes.NewValue(tftypes.String, "default")}),
"test_computed_number": tftypes.NewValue(tftypes.Number, big.NewFloat(1.2345)),
"test_computed_object": tftypes.NewValue(tftypes.Object{AttributeTypes: map[string]tftypes.Type{"a": tftypes.String}}, map[string]tftypes.Value{"a": tftypes.NewValue(tftypes.String, "default")}),
"test_computed_set": tftypes.NewValue(tftypes.Set{ElementType: tftypes.String}, []tftypes.Value{tftypes.NewValue(tftypes.String, "default")}),
"test_computed_string": tftypes.NewValue(tftypes.String, "one"),
"test_computed_bool": tftypes.NewValue(tftypes.Bool, true),
"test_computed_float64": tftypes.NewValue(tftypes.Number, 1.2345),
"test_computed_int64": tftypes.NewValue(tftypes.Number, 12345),
"test_computed_list": tftypes.NewValue(tftypes.List{ElementType: tftypes.String}, []tftypes.Value{tftypes.NewValue(tftypes.String, "default")}),
"test_computed_map": tftypes.NewValue(tftypes.Map{ElementType: tftypes.String}, map[string]tftypes.Value{"a": tftypes.NewValue(tftypes.String, "default")}),
"test_computed_number": tftypes.NewValue(tftypes.Number, big.NewFloat(1.2345)),
"test_computed_object": tftypes.NewValue(tftypes.Object{AttributeTypes: map[string]tftypes.Type{"a": tftypes.String}}, map[string]tftypes.Value{"a": tftypes.NewValue(tftypes.String, "default")}),
"test_computed_set": tftypes.NewValue(tftypes.Set{ElementType: tftypes.String}, []tftypes.Value{tftypes.NewValue(tftypes.String, "default")}),
"test_computed_string": tftypes.NewValue(tftypes.String, "one"),
"test_computed_string_custom_type": tftypes.NewValue(tftypes.String, "one"),
"test_computed_nested_list": tftypes.NewValue(
tftypes.List{
ElementType: tftypes.Object{
Expand Down

0 comments on commit 1401070

Please sign in to comment.