[Internal] Add AddPlanModifer method for AttributeBuilder (#4009)

edwardfeng-db · web-flow · commit 2c6b876fd9f6 · 2024-09-12T11:16:04.000Z
## Changes
&lt;!-- Summary of your changes that are easy to understand --&gt;
- Add `AddPlanModifier` methods for all AttributeBuilders so that we can
do things equivalent to set supress diff or force new

## Tests
&lt;!-- 
How is this tested? Please see the checklist below and also describe any
other relevant tests
--&gt;

- [x] `make test` run locally
- [x] relevant change in `docs/` folder
- [x] covered with integration tests in `internal/acceptance`
- [x] relevant acceptance tests are passing
- [x] using Go SDK
diff --git a/internal/providers/pluginfw/tfschema/bool_attribute.go b/internal/providers/pluginfw/tfschema/bool_attribute.go
@@ -3,6 +3,7 @@ package tfschema
 import (
 	dataschema "github.com/hashicorp/terraform-plugin-framework/datasource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 )
 
@@ -13,6 +14,7 @@ type BoolAttributeBuilder struct {
 	Computed           bool
 	DeprecationMessage string
 	Validators         []validator.Bool
+	PlanModifiers      []planmodifier.Bool
 }
 
 func (a BoolAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute {
@@ -34,6 +36,7 @@ func (a BoolAttributeBuilder) BuildResourceAttribute() schema.Attribute {
 		DeprecationMessage: a.DeprecationMessage,
 		Computed:           a.Computed,
 		Validators:         a.Validators,
+		PlanModifiers:      a.PlanModifiers,
 	}
 }
 
@@ -90,3 +93,8 @@ func (a BoolAttributeBuilder) AddValidator(v validator.Bool) AttributeBuilder {
 	a.Validators = append(a.Validators, v)
 	return a
 }
+
+func (a BoolAttributeBuilder) AddPlanModifier(v planmodifier.Bool) AttributeBuilder {
+	a.PlanModifiers = append(a.PlanModifiers, v)
+	return a
+}
diff --git a/internal/providers/pluginfw/tfschema/customizable_schema.go b/internal/providers/pluginfw/tfschema/customizable_schema.go
@@ -5,6 +5,7 @@ import (
 	"reflect"
 
 	"github.com/databricks/terraform-provider-databricks/common"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 )
 
@@ -72,6 +73,37 @@ func (s *CustomizableSchema) AddValidator(v any, path ...string) *CustomizableSc
 	return s
 }
 
+func (s *CustomizableSchema) AddPlanModifier(v any, path ...string) *CustomizableSchema {
+	cb := func(attr AttributeBuilder) AttributeBuilder {
+		switch a := attr.(type) {
+		case BoolAttributeBuilder:
+			return a.AddPlanModifier(v.(planmodifier.Bool))
+		case Float64AttributeBuilder:
+			return a.AddPlanModifier(v.(planmodifier.Float64))
+		case Int64AttributeBuilder:
+			return a.AddPlanModifier(v.(planmodifier.Int64))
+		case ListAttributeBuilder:
+			return a.AddPlanModifier(v.(planmodifier.List))
+		case ListNestedAttributeBuilder:
+			return a.AddPlanModifier(v.(planmodifier.List))
+		case MapAttributeBuilder:
+			return a.AddPlanModifier(v.(planmodifier.Map))
+		case MapNestedAttributeBuilder:
+			return a.AddPlanModifier(v.(planmodifier.Map))
+		case SingleNestedAttributeBuilder:
+			return a.AddPlanModifier(v.(planmodifier.Object))
+		case StringAttributeBuilder:
+			return a.AddPlanModifier(v.(planmodifier.String))
+		default:
+			panic(fmt.Errorf("cannot add planmodifier, attribute builder type is invalid: %s. %s", reflect.TypeOf(attr).String(), common.TerraformBugErrorMessage))
+		}
+	}
+
+	navigateSchemaWithCallback(&s.attr, cb, path...)
+
+	return s
+}
+
 func (s *CustomizableSchema) SetOptional(path ...string) *CustomizableSchema {
 	cb := func(attr AttributeBuilder) AttributeBuilder {
 		return attr.SetOptional()
diff --git a/internal/providers/pluginfw/tfschema/customizable_schema_test.go b/internal/providers/pluginfw/tfschema/customizable_schema_test.go
@@ -6,6 +6,7 @@ import (
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 	"github.com/stretchr/testify/assert"
@@ -111,3 +112,12 @@ func TestCustomizeSchemaAddValidator(t *testing.T) {
 
 	assert.True(t, len(scm.Attributes["description"].(schema.StringAttribute).Validators) == 1)
 }
+
+func TestCustomizeSchemaAddPlanModifier(t *testing.T) {
+	scm := ResourceStructToSchema(TestTfSdk{}, func(c CustomizableSchema) CustomizableSchema {
+		c.AddPlanModifier(stringplanmodifier.RequiresReplace(), "description")
+		return c
+	})
+
+	assert.True(t, len(scm.Attributes["description"].(schema.StringAttribute).PlanModifiers) == 1)
+}
diff --git a/internal/providers/pluginfw/tfschema/float64_attribute.go b/internal/providers/pluginfw/tfschema/float64_attribute.go
@@ -3,6 +3,7 @@ package tfschema
 import (
 	dataschema "github.com/hashicorp/terraform-plugin-framework/datasource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 )
 
@@ -13,6 +14,7 @@ type Float64AttributeBuilder struct {
 	Computed           bool
 	DeprecationMessage string
 	Validators         []validator.Float64
+	PlanModifiers      []planmodifier.Float64
 }
 
 func (a Float64AttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute {
@@ -34,6 +36,7 @@ func (a Float64AttributeBuilder) BuildResourceAttribute() schema.Attribute {
 		DeprecationMessage: a.DeprecationMessage,
 		Computed:           a.Computed,
 		Validators:         a.Validators,
+		PlanModifiers:      a.PlanModifiers,
 	}
 }
 
@@ -90,3 +93,8 @@ func (a Float64AttributeBuilder) AddValidator(v validator.Float64) AttributeBuil
 	a.Validators = append(a.Validators, v)
 	return a
 }
+
+func (a Float64AttributeBuilder) AddPlanModifier(v planmodifier.Float64) AttributeBuilder {
+	a.PlanModifiers = append(a.PlanModifiers, v)
+	return a
+}
diff --git a/internal/providers/pluginfw/tfschema/int64_attribute.go b/internal/providers/pluginfw/tfschema/int64_attribute.go
@@ -3,6 +3,7 @@ package tfschema
 import (
 	dataschema "github.com/hashicorp/terraform-plugin-framework/datasource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 )
 
@@ -13,6 +14,7 @@ type Int64AttributeBuilder struct {
 	Computed           bool
 	DeprecationMessage string
 	Validators         []validator.Int64
+	PlanModifiers      []planmodifier.Int64
 }
 
 func (a Int64AttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute {
@@ -34,6 +36,7 @@ func (a Int64AttributeBuilder) BuildResourceAttribute() schema.Attribute {
 		DeprecationMessage: a.DeprecationMessage,
 		Computed:           a.Computed,
 		Validators:         a.Validators,
+		PlanModifiers:      a.PlanModifiers,
 	}
 }
 
@@ -90,3 +93,8 @@ func (a Int64AttributeBuilder) AddValidator(v validator.Int64) AttributeBuilder
 	a.Validators = append(a.Validators, v)
 	return a
 }
+
+func (a Int64AttributeBuilder) AddPlanModifier(v planmodifier.Int64) AttributeBuilder {
+	a.PlanModifiers = append(a.PlanModifiers, v)
+	return a
+}
diff --git a/internal/providers/pluginfw/tfschema/list_attribute.go b/internal/providers/pluginfw/tfschema/list_attribute.go
@@ -4,6 +4,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/attr"
 	dataschema "github.com/hashicorp/terraform-plugin-framework/datasource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 )
 
@@ -16,6 +17,7 @@ type ListAttributeBuilder struct {
 	Computed           bool
 	DeprecationMessage string
 	Validators         []validator.List
+	PlanModifiers      []planmodifier.List
 }
 
 func (a ListAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute {
@@ -39,6 +41,7 @@ func (a ListAttributeBuilder) BuildResourceAttribute() schema.Attribute {
 		DeprecationMessage: a.DeprecationMessage,
 		Computed:           a.Computed,
 		Validators:         a.Validators,
+		PlanModifiers:      a.PlanModifiers,
 	}
 }
 
@@ -95,3 +98,8 @@ func (a ListAttributeBuilder) AddValidator(v validator.List) AttributeBuilder {
 	a.Validators = append(a.Validators, v)
 	return a
 }
+
+func (a ListAttributeBuilder) AddPlanModifier(v planmodifier.List) AttributeBuilder {
+	a.PlanModifiers = append(a.PlanModifiers, v)
+	return a
+}
diff --git a/internal/providers/pluginfw/tfschema/list_nested_attribute.go b/internal/providers/pluginfw/tfschema/list_nested_attribute.go
@@ -3,6 +3,7 @@ package tfschema
 import (
 	dataschema "github.com/hashicorp/terraform-plugin-framework/datasource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 )
 
@@ -15,6 +16,7 @@ type ListNestedAttributeBuilder struct {
 	Computed           bool
 	DeprecationMessage string
 	Validators         []validator.List
+	PlanModifiers      []planmodifier.List
 }
 
 func (a ListNestedAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute {
@@ -38,6 +40,7 @@ func (a ListNestedAttributeBuilder) BuildResourceAttribute() schema.Attribute {
 		DeprecationMessage: a.DeprecationMessage,
 		Computed:           a.Computed,
 		Validators:         a.Validators,
+		PlanModifiers:      a.PlanModifiers,
 	}
 }
 
@@ -94,3 +97,8 @@ func (a ListNestedAttributeBuilder) AddValidator(v validator.List) AttributeBuil
 	a.Validators = append(a.Validators, v)
 	return a
 }
+
+func (a ListNestedAttributeBuilder) AddPlanModifier(v planmodifier.List) AttributeBuilder {
+	a.PlanModifiers = append(a.PlanModifiers, v)
+	return a
+}
diff --git a/internal/providers/pluginfw/tfschema/map_attribute.go b/internal/providers/pluginfw/tfschema/map_attribute.go
@@ -4,6 +4,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/attr"
 	dataschema "github.com/hashicorp/terraform-plugin-framework/datasource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 )
 
@@ -16,6 +17,7 @@ type MapAttributeBuilder struct {
 	Computed           bool
 	DeprecationMessage string
 	Validators         []validator.Map
+	PlanModifiers      []planmodifier.Map
 }
 
 func (a MapAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute {
@@ -39,6 +41,7 @@ func (a MapAttributeBuilder) BuildResourceAttribute() schema.Attribute {
 		DeprecationMessage: a.DeprecationMessage,
 		Computed:           a.Computed,
 		Validators:         a.Validators,
+		PlanModifiers:      a.PlanModifiers,
 	}
 }
 
@@ -95,3 +98,8 @@ func (a MapAttributeBuilder) AddValidator(v validator.Map) AttributeBuilder {
 	a.Validators = append(a.Validators, v)
 	return a
 }
+
+func (a MapAttributeBuilder) AddPlanModifier(v planmodifier.Map) AttributeBuilder {
+	a.PlanModifiers = append(a.PlanModifiers, v)
+	return a
+}
diff --git a/internal/providers/pluginfw/tfschema/map_nested_attribute.go b/internal/providers/pluginfw/tfschema/map_nested_attribute.go
@@ -3,6 +3,7 @@ package tfschema
 import (
 	dataschema "github.com/hashicorp/terraform-plugin-framework/datasource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 )
 
@@ -15,6 +16,7 @@ type MapNestedAttributeBuilder struct {
 	Computed           bool
 	DeprecationMessage string
 	Validators         []validator.Map
+	PlanModifiers      []planmodifier.Map
 }
 
 func (a MapNestedAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute {
@@ -38,6 +40,7 @@ func (a MapNestedAttributeBuilder) BuildResourceAttribute() schema.Attribute {
 		DeprecationMessage: a.DeprecationMessage,
 		Computed:           a.Computed,
 		Validators:         a.Validators,
+		PlanModifiers:      a.PlanModifiers,
 	}
 }
 
@@ -94,3 +97,8 @@ func (a MapNestedAttributeBuilder) AddValidator(v validator.Map) AttributeBuilde
 	a.Validators = append(a.Validators, v)
 	return a
 }
+
+func (a MapNestedAttributeBuilder) AddPlanModifier(v planmodifier.Map) AttributeBuilder {
+	a.PlanModifiers = append(a.PlanModifiers, v)
+	return a
+}
diff --git a/internal/providers/pluginfw/tfschema/single_nested_attribute.go b/internal/providers/pluginfw/tfschema/single_nested_attribute.go
@@ -3,6 +3,7 @@ package tfschema
 import (
 	dataschema "github.com/hashicorp/terraform-plugin-framework/datasource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 )
 
@@ -15,6 +16,7 @@ type SingleNestedAttributeBuilder struct {
 	Computed           bool
 	DeprecationMessage string
 	Validators         []validator.Object
+	PlanModifiers      []planmodifier.Object
 }
 
 func (a SingleNestedAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute {
@@ -38,6 +40,7 @@ func (a SingleNestedAttributeBuilder) BuildResourceAttribute() schema.Attribute
 		DeprecationMessage: a.DeprecationMessage,
 		Computed:           a.Computed,
 		Validators:         a.Validators,
+		PlanModifiers:      a.PlanModifiers,
 	}
 }
 
@@ -94,3 +97,8 @@ func (a SingleNestedAttributeBuilder) AddValidator(v validator.Object) Attribute
 	a.Validators = append(a.Validators, v)
 	return a
 }
+
+func (a SingleNestedAttributeBuilder) AddPlanModifier(v planmodifier.Object) AttributeBuilder {
+	a.PlanModifiers = append(a.PlanModifiers, v)
+	return a
+}
diff --git a/internal/providers/pluginfw/tfschema/string_attribute.go b/internal/providers/pluginfw/tfschema/string_attribute.go
@@ -3,6 +3,7 @@ package tfschema
 import (
 	dataschema "github.com/hashicorp/terraform-plugin-framework/datasource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 )
 
@@ -13,6 +14,7 @@ type StringAttributeBuilder struct {
 	Computed           bool
 	DeprecationMessage string
 	Validators         []validator.String
+	PlanModifiers      []planmodifier.String
 }
 
 func (a StringAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute {
@@ -34,6 +36,7 @@ func (a StringAttributeBuilder) BuildResourceAttribute() schema.Attribute {
 		DeprecationMessage: a.DeprecationMessage,
 		Computed:           a.Computed,
 		Validators:         a.Validators,
+		PlanModifiers:      a.PlanModifiers,
 	}
 }
 
@@ -90,3 +93,8 @@ func (a StringAttributeBuilder) AddValidator(v validator.String) AttributeBuilde
 	a.Validators = append(a.Validators, v)
 	return a
 }
+
+func (a StringAttributeBuilder) AddPlanModifier(v planmodifier.String) AttributeBuilder {
+	a.PlanModifiers = append(a.PlanModifiers, v)
+	return a
+}

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ package tfschema`
`3`	`3`	`import (`
`4`	`4`	`dataschema "github.com/hashicorp/terraform-plugin-framework/datasource/schema"`
`5`	`5`	`"github.com/hashicorp/terraform-plugin-framework/resource/schema"`
	`6`	`+ "github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"`
`6`	`7`	`"github.com/hashicorp/terraform-plugin-framework/schema/validator"`
`7`	`8`	`)`
`8`	`9`
`@@ -13,6 +14,7 @@ type BoolAttributeBuilder struct {`
`13`	`14`	`Computed bool`
`14`	`15`	`DeprecationMessage string`
`15`	`16`	`Validators []validator.Bool`
	`17`	`+ PlanModifiers []planmodifier.Bool`
`16`	`18`	`}`
`17`	`19`
`18`	`20`	`func (a BoolAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute {`
`@@ -34,6 +36,7 @@ func (a BoolAttributeBuilder) BuildResourceAttribute() schema.Attribute {`
`34`	`36`	`DeprecationMessage: a.DeprecationMessage,`
`35`	`37`	`Computed: a.Computed,`
`36`	`38`	`Validators: a.Validators,`
	`39`	`+ PlanModifiers: a.PlanModifiers,`
`37`	`40`	`}`
`38`	`41`	`}`
`39`	`42`
`@@ -90,3 +93,8 @@ func (a BoolAttributeBuilder) AddValidator(v validator.Bool) AttributeBuilder {`
`90`	`93`	`a.Validators = append(a.Validators, v)`
`91`	`94`	`return a`
`92`	`95`	`}`
	`96`	`+`
	`97`	`+func (a BoolAttributeBuilder) AddPlanModifier(v planmodifier.Bool) AttributeBuilder {`
	`98`	`+ a.PlanModifiers = append(a.PlanModifiers, v)`
	`99`	`+ return a`
	`100`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ import (`
`4`	`4`	`"github.com/hashicorp/terraform-plugin-framework/attr"`
`5`	`5`	`dataschema "github.com/hashicorp/terraform-plugin-framework/datasource/schema"`
`6`	`6`	`"github.com/hashicorp/terraform-plugin-framework/resource/schema"`
	`7`	`+ "github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"`
`7`	`8`	`"github.com/hashicorp/terraform-plugin-framework/schema/validator"`
`8`	`9`	`)`
`9`	`10`
`@@ -16,6 +17,7 @@ type ListAttributeBuilder struct {`
`16`	`17`	`Computed bool`
`17`	`18`	`DeprecationMessage string`
`18`	`19`	`Validators []validator.List`
	`20`	`+ PlanModifiers []planmodifier.List`
`19`	`21`	`}`
`20`	`22`
`21`	`23`	`func (a ListAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute {`
`@@ -39,6 +41,7 @@ func (a ListAttributeBuilder) BuildResourceAttribute() schema.Attribute {`
`39`	`41`	`DeprecationMessage: a.DeprecationMessage,`
`40`	`42`	`Computed: a.Computed,`
`41`	`43`	`Validators: a.Validators,`
	`44`	`+ PlanModifiers: a.PlanModifiers,`
`42`	`45`	`}`
`43`	`46`	`}`
`44`	`47`
`@@ -95,3 +98,8 @@ func (a ListAttributeBuilder) AddValidator(v validator.List) AttributeBuilder {`
`95`	`98`	`a.Validators = append(a.Validators, v)`
`96`	`99`	`return a`
`97`	`100`	`}`
	`101`	`+`
	`102`	`+func (a ListAttributeBuilder) AddPlanModifier(v planmodifier.List) AttributeBuilder {`
	`103`	`+ a.PlanModifiers = append(a.PlanModifiers, v)`
	`104`	`+ return a`
	`105`	`+}`