bool

Author: austinvalle

resource/schema/boolplanmodifier/use_state_for_unknown.go

@@ -36,8 +36,8 @@ func (m useStateForUnknownModifier) MarkdownDescription(_ context.Context) strin
 
 // PlanModifyBool implements the plan modification logic.
 func (m useStateForUnknownModifier) PlanModifyBool(_ context.Context, req planmodifier.BoolRequest, resp *planmodifier.BoolResponse) {
-	// Do nothing if there is no state value.
-	if req.StateValue.IsNull() {
+	// Do nothing if there is no state (resource is being created).
+	if req.State.Raw.IsNull() {
 		return
 	}
 

resource/schema/boolplanmodifier/use_state_for_unknown_test.go

@@ -8,11 +8,11 @@ import (
 	"testing"
 
 	"github.com/google/go-cmp/cmp"
-	"github.com/hashicorp/terraform-plugin-framework/attr"
-	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/boolplanmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
+	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
 	"github.com/hashicorp/terraform-plugin-framework/types"
+	"github.com/hashicorp/terraform-plugin-go/tftypes"
 )
 
 func TestUseStateForUnknownModifierPlanModifyBool(t *testing.T) {
@@ -26,6 +26,16 @@ func TestUseStateForUnknownModifierPlanModifyBool(t *testing.T) {
 			// when we first create the resource, use the unknown
 			// value
 			request: planmodifier.BoolRequest{
+				State: tfsdk.State{
+					Raw: tftypes.NewValue(
+						tftypes.Object{
+							AttributeTypes: map[string]tftypes.Type{
+								"attr": tftypes.Bool,
+							},
+						},
+						nil,
+					),
+				},
 				StateValue:  types.BoolNull(),
 				PlanValue:   types.BoolUnknown(),
 				ConfigValue: types.BoolNull(),
@@ -42,6 +52,18 @@ func TestUseStateForUnknownModifierPlanModifyBool(t *testing.T) {
 			// but we still want to preserve that value, in this
 			// case
 			request: planmodifier.BoolRequest{
+				State: tfsdk.State{
+					Raw: tftypes.NewValue(
+						tftypes.Object{
+							AttributeTypes: map[string]tftypes.Type{
+								"attr": tftypes.Bool,
+							},
+						},
+						map[string]tftypes.Value{
+							"attr": tftypes.NewValue(tftypes.Bool, false),
+						},
+					),
+				},
 				StateValue:  types.BoolValue(false),
 				PlanValue:   types.BoolValue(true),
 				ConfigValue: types.BoolNull(),
@@ -50,10 +72,22 @@ func TestUseStateForUnknownModifierPlanModifyBool(t *testing.T) {
 				PlanValue: types.BoolValue(true),
 			},
 		},
-		"non-null-state-unknown-plan": {
+		"non-null-state-value-unknown-plan": {
 			// this is the situation we want to preserve the state
 			// in
 			request: planmodifier.BoolRequest{
+				State: tfsdk.State{
+					Raw: tftypes.NewValue(
+						tftypes.Object{
+							AttributeTypes: map[string]tftypes.Type{
+								"attr": tftypes.Bool,
+							},
+						},
+						map[string]tftypes.Value{
+							"attr": tftypes.NewValue(tftypes.Bool, true),
+						},
+					),
+				},
 				StateValue:  types.BoolValue(true),
 				PlanValue:   types.BoolUnknown(),
 				ConfigValue: types.BoolNull(),
@@ -62,6 +96,29 @@ func TestUseStateForUnknownModifierPlanModifyBool(t *testing.T) {
 				PlanValue: types.BoolValue(true),
 			},
 		},
+		"null-state-value-unknown-plan": {
+			// Null state values are still known, so we should preserve this as well.
+			request: planmodifier.BoolRequest{
+				State: tfsdk.State{
+					Raw: tftypes.NewValue(
+						tftypes.Object{
+							AttributeTypes: map[string]tftypes.Type{
+								"attr": tftypes.Bool,
+							},
+						},
+						map[string]tftypes.Value{
+							"attr": tftypes.NewValue(tftypes.Bool, nil),
+						},
+					),
+				},
+				StateValue:  types.BoolNull(),
+				PlanValue:   types.BoolUnknown(),
+				ConfigValue: types.BoolNull(),
+			},
+			expected: &planmodifier.BoolResponse{
+				PlanValue: types.BoolNull(),
+			},
+		},
 		"unknown-config": {
 			// this is the situation in which a user is
 			// interpolating into a field. We want that to still
@@ -78,46 +135,6 @@ func TestUseStateForUnknownModifierPlanModifyBool(t *testing.T) {
 				PlanValue: types.BoolUnknown(),
 			},
 		},
-		"under-list": {
-			request: planmodifier.BoolRequest{
-				ConfigValue: types.BoolNull(),
-				Path:        path.Root("test").AtListIndex(0).AtName("nested_test"),
-				PlanValue:   types.BoolUnknown(),
-				StateValue:  types.BoolNull(),
-			},
-			expected: &planmodifier.BoolResponse{
-				PlanValue: types.BoolUnknown(),
-			},
-		},
-		"under-set": {
-			request: planmodifier.BoolRequest{
-				ConfigValue: types.BoolNull(),
-				Path: path.Root("test").AtSetValue(
-					types.SetValueMust(
-						types.ObjectType{
-							AttrTypes: map[string]attr.Type{
-								"nested_test": types.BoolType,
-							},
-						},
-						[]attr.Value{
-							types.ObjectValueMust(
-								map[string]attr.Type{
-									"nested_test": types.BoolType,
-								},
-								map[string]attr.Value{
-									"nested_test": types.BoolUnknown(),
-								},
-							),
-						},
-					),
-				).AtName("nested_test"),
-				PlanValue:  types.BoolUnknown(),
-				StateValue: types.BoolNull(),
-			},
-			expected: &planmodifier.BoolResponse{
-				PlanValue: types.BoolUnknown(),
-			},
-		},
 	}
 
 	for name, testCase := range testCases {