internal/fwschemadata: Replace fwserver duplicate logic, add data des…

…cription (hashicorp#464) Reference: hashicorp#365 Reference: hashicorp#366 This change represents another evolutionary step to move away from `tfsdk.Config`, `tfsdk.Plan`, and `tfsdk.State` types directly, where the temporarily duplicated logic in `internal/fwserver` which worked directly with those types is replaced with the shared data implementation.
liamcervante · Aug 30, 2022 · 5810578 · 5810578
1 parent 1a3f8fe
commit 5810578
Show file tree

Hide file tree

Showing 19 changed files with 145 additions and 388 deletions.
diff --git a/internal/fwschemadata/data.go b/internal/fwschemadata/data.go
@@ -8,6 +8,10 @@ import (
 // Data is the shared storage implementation for schema-based values, such as
 // configuration, plan, and state.
 type Data struct {
+ // Description contains the human friendly type of the data. Used in error
+ // diagnostics.
+ Description DataDescription
+
  // Schema contains the data structure and types for the value.
  Schema fwschema.Schema
 

diff --git a/internal/fwschemadata/data_description.go b/internal/fwschemadata/data_description.go
@@ -0,0 +1,43 @@
+package fwschemadata
+
+const (
+ // DataDescriptionConfiguration is used for Data that represents
+ // a configuration-based value.
+ DataDescriptionConfiguration DataDescription = "configuration"
+
+ // DataDescriptionPlan is used for Data that represents
+ // a plan-based value.
+ DataDescriptionPlan DataDescription = "plan"
+
+ // DataDescriptionState is used for Data that represents
+ // a state-based value.
+ DataDescriptionState DataDescription = "state"
+)
+
+// DataDescription is a human friendly type for Data. Used in error
+// diagnostics.
+type DataDescription string
+
+// String returns the lowercase string of the description.
+func (d DataDescription) String() string {
+ switch d {
+ case "":
+ return "data"
+ default:
+ return string(d)
+ }
+}
+
+// Title returns the titlecase string of the description.
+func (d DataDescription) Title() string {
+ switch d {
+ case DataDescriptionConfiguration:
+ return "Configuration"
+ case DataDescriptionPlan:
+ return "Plan"
+ case DataDescriptionState:
+ return "State"
+ default:
+ return "Data"
+ }
+}
diff --git a/internal/fwschemadata/data_get_at_path.go b/internal/fwschemadata/data_get_at_path.go
@@ -25,8 +25,8 @@ func (d Data) GetAtPath(ctx context.Context, schemaPath path.Path, target any) d
  if attrValue == nil {
  diags.AddAttributeError(
  schemaPath,
- "Config Read Error",
- "An unexpected error was encountered trying to read an attribute from the configuration. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
+ d.Description.Title()+" Read Error",
+ "An unexpected error was encountered trying to read an attribute from the "+d.Description.String()+". This is always an error in the provider. Please report the following to the provider developer:\n\n"+
  "Missing attribute value, however no error was returned. Preventing the panic from this situation.",
  )
  return diags
@@ -42,7 +42,7 @@ func (d Data) GetAtPath(ctx context.Context, schemaPath path.Path, target any) d
  if err != nil {
  diags.AddAttributeError(
  schemaPath,
- "Error converting value",
+ d.Description.Title()+" Value Conversion Error",
  fmt.Sprintf("An unexpected error was encountered converting a %T to its equivalent Terraform representation. This is always a bug in the provider.\n\n"+
  "Error: %s", attrValue, err),
  )

diff --git a/internal/fwschemadata/data_path_exists.go b/internal/fwschemadata/data_path_exists.go
@@ -33,9 +33,9 @@ func (d Data) PathExists(ctx context.Context, path path.Path) (bool, diag.Diagno
 
  diags.AddAttributeError(
  path,
- "State Read Error",
- "An unexpected error was encountered trying to read an attribute from the state. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
- fmt.Sprintf("Cannot walk attribute path in state: %s", err),
+ d.Description.Title()+" Read Error",
+ "An unexpected error was encountered trying to read an attribute from the "+d.Description.String()+". This is always an error in the provider. Please report the following to the provider developer:\n\n"+
+ fmt.Sprintf("Cannot walk attribute path in %s: %s", d.Description, err),
  )
  return false, diags
  }

diff --git a/internal/fwschemadata/data_set.go b/internal/fwschemadata/data_set.go
@@ -22,8 +22,8 @@ func (d *Data) Set(ctx context.Context, val any) diag.Diagnostics {
 
  if err != nil {
  diags.AddError(
- "Data Write Error",
- "An unexpected error was encountered trying to write the data. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
+ d.Description.Title()+" Write Error",
+ "An unexpected error was encountered trying to write the "+d.Description.String()+". This is always an error in the provider. Please report the following to the provider developer:\n\n"+
  fmt.Sprintf("Error: Unable to run ToTerraformValue on new value: %s", err),
  )
  return diags

diff --git a/internal/fwschemadata/data_set_at_path.go b/internal/fwschemadata/data_set_at_path.go
@@ -40,7 +40,7 @@ func (d *Data) SetAtPath(ctx context.Context, path path.Path, val interface{}) d
  if err != nil {
  diags.AddAttributeError(
  path,
- "Data Write Error",
+ d.Description.Title()+" Write Error",
  "An unexpected error was encountered trying to retrieve type information at a given path. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
  "Error: "+err.Error(),
  )
@@ -59,8 +59,8 @@ func (d *Data) SetAtPath(ctx context.Context, path path.Path, val interface{}) d
  if err != nil {
  diags.AddAttributeError(
  path,
- "Data Write Error",
- "An unexpected error was encountered trying to write an attribute to the data. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
+ d.Description.Title()+" Write Error",
+ "An unexpected error was encountered trying to write an attribute to the "+d.Description.String()+". This is always an error in the provider. Please report the following to the provider developer:\n\n"+
  "Error: Cannot run ToTerraformValue on new data value: "+err.Error(),
  )
  return diags
@@ -89,8 +89,8 @@ func (d *Data) SetAtPath(ctx context.Context, path path.Path, val interface{}) d
  if err != nil {
  diags.AddAttributeError(
  path,
- "Data Write Error",
- "An unexpected error was encountered trying to write an attribute to the data. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
+ d.Description.Title()+" Write Error",
+ "An unexpected error was encountered trying to write an attribute to the "+d.Description.String()+". This is always an error in the provider. Please report the following to the provider developer:\n\n"+
  "Error: Cannot transform data: "+err.Error(),
  )
  return diags
@@ -137,8 +137,8 @@ func (d Data) SetAtPathTransformFunc(ctx context.Context, path path.Path, tfVal
  err = fmt.Errorf("error getting parent attribute type in schema: %w", err)
  diags.AddAttributeError(
  parentPath,
- "Plan Write Error",
- "An unexpected error was encountered trying to write an attribute to the plan. This is always an error in the provider. Please report the following to the provider developer:\n\n"+err.Error(),
+ d.Description.Title()+" Write Error",
+ "An unexpected error was encountered trying to write an attribute to the "+d.Description.String()+". This is always an error in the provider. Please report the following to the provider developer:\n\n"+err.Error(),
  )
  return nil, diags
  }
@@ -148,8 +148,8 @@ func (d Data) SetAtPathTransformFunc(ctx context.Context, path path.Path, tfVal
  if err != nil && !errors.Is(err, tftypes.ErrInvalidStep) {
  diags.AddAttributeError(
  parentPath,
- "Plan Read Error",
- "An unexpected error was encountered trying to read an attribute from the plan. This is always an error in the provider. Please report the following to the provider developer:\n\n"+err.Error(),
+ d.Description.Title()+" Read Error",
+ "An unexpected error was encountered trying to read an attribute from the "+d.Description.String()+". This is always an error in the provider. Please report the following to the provider developer:\n\n"+err.Error(),
  )
  return nil, diags
  }

diff --git a/internal/fwschemadata/data_value.go b/internal/fwschemadata/data_value.go
@@ -32,7 +32,7 @@ func (d Data) ValueAtPath(ctx context.Context, schemaPath path.Path) (attr.Value
  if err != nil {
  diags.AddAttributeError(
  schemaPath,
- "Data Read Error",
+ d.Description.Title()+" Read Error",
  "An unexpected error was encountered trying to retrieve type information at a given path. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
  "Error: "+err.Error(),
  )
@@ -51,7 +51,7 @@ func (d Data) ValueAtPath(ctx context.Context, schemaPath path.Path) (attr.Value
  if err != nil && !errors.Is(err, tftypes.ErrInvalidStep) {
  diags.AddAttributeError(
  schemaPath,
- "Data Read Error",
+ d.Description.Title()+" Read Error",
  "An unexpected error was encountered trying to retrieve an attribute value from the given path. This is always an error in the provider. Please report the following to the provider developer:\n\n"+err.Error(),
  )
  return nil, diags
@@ -77,8 +77,8 @@ func (d Data) ValueAtPath(ctx context.Context, schemaPath path.Path) (attr.Value
  if err != nil {
  diags.AddAttributeError(
  schemaPath,
- "Data Read Error",
- "An unexpected error was encountered trying to convert an attribute value from the data. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
+ d.Description.Title()+" Read Error",
+ "An unexpected error was encountered trying to convert an attribute value from the "+d.Description.String()+". This is always an error in the provider. Please report the following to the provider developer:\n\n"+
  "Error: "+err.Error(),
  )
  return nil, diags

diff --git a/internal/fwserver/attribute_plan_modification.go b/internal/fwserver/attribute_plan_modification.go
@@ -6,6 +6,7 @@ import (
 
  "github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
  "github.com/hashicorp/terraform-plugin-framework/internal/fwschema/fwxschema"
+ "github.com/hashicorp/terraform-plugin-framework/internal/fwschemadata"
  "github.com/hashicorp/terraform-plugin-framework/internal/logging"
  "github.com/hashicorp/terraform-plugin-framework/internal/privatestate"
  "github.com/hashicorp/terraform-plugin-framework/tfsdk"
@@ -21,7 +22,13 @@ import (
 func AttributeModifyPlan(ctx context.Context, a fwschema.Attribute, req tfsdk.ModifyAttributePlanRequest, resp *ModifySchemaPlanResponse) {
  ctx = logging.FrameworkWithAttributePath(ctx, req.AttributePath.String())
 
- attrConfig, diags := ConfigGetAttributeValue(ctx, req.Config, req.AttributePath)
+ configData := &fwschemadata.Data{
+ Description: fwschemadata.DataDescriptionConfiguration,
+ Schema: req.Config.Schema,
+ TerraformValue: req.Config.Raw,
+ }
+
+ attrConfig, diags := configData.ValueAtPath(ctx, req.AttributePath)
  resp.Diagnostics.Append(diags...)
 
  // Only on new errors.
@@ -30,7 +37,13 @@ func AttributeModifyPlan(ctx context.Context, a fwschema.Attribute, req tfsdk.Mo
  }
  req.AttributeConfig = attrConfig
 
- attrState, diags := StateGetAttributeValue(ctx, req.State, req.AttributePath)
+ stateData := &fwschemadata.Data{
+ Description: fwschemadata.DataDescriptionState,
+ Schema: req.State.Schema,
+ TerraformValue: req.State.Raw,
+ }
+
+ attrState, diags := stateData.ValueAtPath(ctx, req.AttributePath)
  resp.Diagnostics.Append(diags...)
 
  // Only on new errors.
@@ -39,7 +52,13 @@ func AttributeModifyPlan(ctx context.Context, a fwschema.Attribute, req tfsdk.Mo
  }
  req.AttributeState = attrState
 
- attrPlan, diags := PlanGetAttributeValue(ctx, req.Plan, req.AttributePath)
+ planData := &fwschemadata.Data{
+ Description: fwschemadata.DataDescriptionPlan,
+ Schema: req.Plan.Schema,
+ TerraformValue: req.Plan.Raw,
+ }
+
+ attrPlan, diags := planData.ValueAtPath(ctx, req.AttributePath)
  resp.Diagnostics.Append(diags...)
 
  // Only on new errors.

diff --git a/internal/fwserver/attribute_plan_modification_test.go b/internal/fwserver/attribute_plan_modification_test.go
@@ -93,8 +93,8 @@ func TestAttributeModifyPlan(t *testing.T) {
  diag.NewAttributeErrorDiagnostic(
  path.Root("test"),
  "Configuration Read Error",
- "An unexpected error was encountered trying to read an attribute from the configuration. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
- "can't use tftypes.String<\"testvalue\"> as value of List with ElementType types.primitive, can only use tftypes.String values",
+ "An unexpected error was encountered trying to convert an attribute value from the configuration. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
+ "Error: can't use tftypes.String<\"testvalue\"> as value of List with ElementType types.primitive, can only use tftypes.String values",
  ),
  },
  Plan: tfsdk.Plan{
@@ -188,8 +188,8 @@ func TestAttributeModifyPlan(t *testing.T) {
  diag.NewAttributeErrorDiagnostic(
  path.Root("test"),
  "Configuration Read Error",
- "An unexpected error was encountered trying to read an attribute from the configuration. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
- "can't use tftypes.String<\"testvalue\"> as value of List with ElementType types.primitive, can only use tftypes.String values",
+ "An unexpected error was encountered trying to convert an attribute value from the configuration. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
+ "Error: can't use tftypes.String<\"testvalue\"> as value of List with ElementType types.primitive, can only use tftypes.String values",
  ),
  },
  Plan: tfsdk.Plan{
@@ -272,8 +272,8 @@ func TestAttributeModifyPlan(t *testing.T) {
  diag.NewAttributeErrorDiagnostic(
  path.Root("test"),
  "Plan Read Error",
- "An unexpected error was encountered trying to read an attribute from the plan. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
- "can't use tftypes.String<\"testvalue\"> as value of List with ElementType types.primitive, can only use tftypes.String values",
+ "An unexpected error was encountered trying to convert an attribute value from the plan. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
+ "Error: can't use tftypes.String<\"testvalue\"> as value of List with ElementType types.primitive, can only use tftypes.String values",
  ),
  },
  Plan: tfsdk.Plan{
@@ -367,8 +367,8 @@ func TestAttributeModifyPlan(t *testing.T) {
  diag.NewAttributeErrorDiagnostic(
  path.Root("test"),
  "Plan Read Error",
- "An unexpected error was encountered trying to read an attribute from the plan. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
- "can't use tftypes.String<\"testvalue\"> as value of List with ElementType types.primitive, can only use tftypes.String values",
+ "An unexpected error was encountered trying to convert an attribute value from the plan. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
+ "Error: can't use tftypes.String<\"testvalue\"> as value of List with ElementType types.primitive, can only use tftypes.String values",
  ),
  },
  Plan: tfsdk.Plan{
@@ -451,8 +451,8 @@ func TestAttributeModifyPlan(t *testing.T) {
  diag.NewAttributeErrorDiagnostic(
  path.Root("test"),
  "State Read Error",
- "An unexpected error was encountered trying to read an attribute from the state. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
- "can't use tftypes.String<\"testvalue\"> as value of List with ElementType types.primitive, can only use tftypes.String values",
+ "An unexpected error was encountered trying to convert an attribute value from the state. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
+ "Error: can't use tftypes.String<\"testvalue\"> as value of List with ElementType types.primitive, can only use tftypes.String values",
  ),
  },
  Plan: tfsdk.Plan{
@@ -546,8 +546,8 @@ func TestAttributeModifyPlan(t *testing.T) {
  diag.NewAttributeErrorDiagnostic(
  path.Root("test"),
  "State Read Error",
- "An unexpected error was encountered trying to read an attribute from the state. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
- "can't use tftypes.String<\"testvalue\"> as value of List with ElementType types.primitive, can only use tftypes.String values",
+ "An unexpected error was encountered trying to convert an attribute value from the state. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
+ "Error: can't use tftypes.String<\"testvalue\"> as value of List with ElementType types.primitive, can only use tftypes.String values",
  ),
  },
  Plan: tfsdk.Plan{

diff --git a/internal/fwserver/attribute_validation.go b/internal/fwserver/attribute_validation.go
@@ -6,6 +6,7 @@ import (
 
  "github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
  "github.com/hashicorp/terraform-plugin-framework/internal/fwschema/fwxschema"
+ "github.com/hashicorp/terraform-plugin-framework/internal/fwschemadata"
  "github.com/hashicorp/terraform-plugin-framework/internal/logging"
  "github.com/hashicorp/terraform-plugin-framework/tfsdk"
  "github.com/hashicorp/terraform-plugin-framework/types"
@@ -50,7 +51,13 @@ func AttributeValidate(ctx context.Context, a fwschema.Attribute, req tfsdk.Vali
  return
  }
 
- attributeConfig, diags := ConfigGetAttributeValue(ctx, req.Config, req.AttributePath)
+ configData := &fwschemadata.Data{
+ Description: fwschemadata.DataDescriptionConfiguration,
+ Schema: req.Config.Schema,
+ TerraformValue: req.Config.Raw,
+ }
+
+ attributeConfig, diags := configData.ValueAtPath(ctx, req.AttributePath)
  resp.Diagnostics.Append(diags...)
 
  if diags.HasError() {

diff --git a/internal/fwserver/attribute_validation_test.go b/internal/fwserver/attribute_validation_test.go
@@ -144,8 +144,8 @@ func TestAttributeValidate(t *testing.T) {
  diag.NewAttributeErrorDiagnostic(
  path.Root("test"),
  "Configuration Read Error",
- "An unexpected error was encountered trying to read an attribute from the configuration. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
- "can't use tftypes.String<\"testvalue\"> as value of List with ElementType types.primitive, can only use tftypes.String values",
+ "An unexpected error was encountered trying to convert an attribute value from the configuration. This is always an error in the provider. Please report the following to the provider developer:\n\n"+
+ "Error: can't use tftypes.String<\"testvalue\"> as value of List with ElementType types.primitive, can only use tftypes.String values",
  ),
  },
  },

diff --git a/internal/fwserver/block_plan_modification.go b/internal/fwserver/block_plan_modification.go
@@ -6,6 +6,7 @@ import (
 
  "github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
  "github.com/hashicorp/terraform-plugin-framework/internal/fwschema/fwxschema"
+ "github.com/hashicorp/terraform-plugin-framework/internal/fwschemadata"
  "github.com/hashicorp/terraform-plugin-framework/internal/privatestate"
  "github.com/hashicorp/terraform-plugin-framework/tfsdk"
  "github.com/hashicorp/terraform-plugin-framework/types"
@@ -18,7 +19,13 @@ import (
 // package from the tfsdk package and not wanting to export the method.
 // Reference: https://github.com/hashicorp/terraform-plugin-framework/issues/365
 func BlockModifyPlan(ctx context.Context, b fwschema.Block, req tfsdk.ModifyAttributePlanRequest, resp *ModifySchemaPlanResponse) {
- attributeConfig, diags := ConfigGetAttributeValue(ctx, req.Config, req.AttributePath)
+ configData := &fwschemadata.Data{
+ Description: fwschemadata.DataDescriptionConfiguration,
+ Schema: req.Config.Schema,
+ TerraformValue: req.Config.Raw,
+ }
+
+ attributeConfig, diags := configData.ValueAtPath(ctx, req.AttributePath)
  resp.Diagnostics.Append(diags...)
 
  if diags.HasError() {
@@ -27,7 +34,13 @@ func BlockModifyPlan(ctx context.Context, b fwschema.Block, req tfsdk.ModifyAttr
 
  req.AttributeConfig = attributeConfig
 
- attributePlan, diags := PlanGetAttributeValue(ctx, req.Plan, req.AttributePath)
+ planData := &fwschemadata.Data{
+ Description: fwschemadata.DataDescriptionPlan,
+ Schema: req.Plan.Schema,
+ TerraformValue: req.Plan.Raw,
+ }
+
+ attributePlan, diags := planData.ValueAtPath(ctx, req.AttributePath)
  resp.Diagnostics.Append(diags...)
 
  if diags.HasError() {
@@ -36,7 +49,13 @@ func BlockModifyPlan(ctx context.Context, b fwschema.Block, req tfsdk.ModifyAttr
 
  req.AttributePlan = attributePlan
 
- attributeState, diags := StateGetAttributeValue(ctx, req.State, req.AttributePath)
+ stateData := &fwschemadata.Data{
+ Description: fwschemadata.DataDescriptionState,
+ Schema: req.State.Schema,
+ TerraformValue: req.State.Raw,
+ }
+
+ attributeState, diags := stateData.ValueAtPath(ctx, req.AttributePath)
  resp.Diagnostics.Append(diags...)
 
  if diags.HasError() {