tfsdk: Switch Config, Plan, and State type Schema fields to interface (…

…#544)

Reference: #132

As part of upcoming effort to split schema functionality into the datasource, provider, and resource packages, there are some internal implementation details which need to be sorted beforehand. Throughout the 0.x versions, schema functionality has been migrated from the `tfsdk` package into the `internal/fwschema` package, however the exported `Config`, `Plan`, and `State` type `Schema` fields remained hardcoded to the `tfsdk.Schema` type. This change migrates the field type to the `fwschema.Schema` interface, so other framework schema implementations can be introduced.

.changelog/544.txt

@@ -0,0 +1,3 @@
+```release-note:breaking-change
+tfsdk: The `Config`, `Plan`, and `State` type `Schema` field type has been updated from `tfsdk.Schema` to the generic `fwschema.Schema` interface to enable additional schema implementations
+```

internal/fwserver/server_createresource.go

@@ -62,11 +62,11 @@ func (s *Server) CreateResource(ctx context.Context, req *CreateResourceRequest,
 
 	createReq := resource.CreateRequest{
 		Config: tfsdk.Config{
-			Schema: schema(req.ResourceSchema),
+			Schema: req.ResourceSchema,
 			Raw:    nullSchemaData,
 		},
 		Plan: tfsdk.Plan{
-			Schema: schema(req.ResourceSchema),
+			Schema: req.ResourceSchema,
 			Raw:    nullSchemaData,
 		},
 	}
@@ -75,7 +75,7 @@ func (s *Server) CreateResource(ctx context.Context, req *CreateResourceRequest,
 
 	createResp := resource.CreateResponse{
 		State: tfsdk.State{
-			Schema: schema(req.ResourceSchema),
+			Schema: req.ResourceSchema,
 			Raw:    nullSchemaData,
 		},
 		Private: privateProviderData,

internal/fwserver/server_deleteresource.go

@@ -59,13 +59,13 @@ func (s *Server) DeleteResource(ctx context.Context, req *DeleteResourceRequest,
 
 	deleteReq := resource.DeleteRequest{
 		State: tfsdk.State{
-			Schema: schema(req.ResourceSchema),
+			Schema: req.ResourceSchema,
 			Raw:    tftypes.NewValue(req.ResourceSchema.Type().TerraformType(ctx), nil),
 		},
 	}
 	deleteResp := resource.DeleteResponse{
 		State: tfsdk.State{
-			Schema: schema(req.ResourceSchema),
+			Schema: req.ResourceSchema,
 			Raw:    tftypes.NewValue(req.ResourceSchema.Type().TerraformType(ctx), nil),
 		},
 	}

internal/fwserver/server_planresourcechange.go

@@ -70,21 +70,21 @@ func (s *Server) PlanResourceChange(ctx context.Context, req *PlanResourceChange
 	if req.Config == nil {
 		req.Config = &tfsdk.Config{
 			Raw:    nullTfValue,
-			Schema: schema(req.ResourceSchema),
+			Schema: req.ResourceSchema,
 		}
 	}
 
 	if req.ProposedNewState == nil {
 		req.ProposedNewState = &tfsdk.Plan{
 			Raw:    nullTfValue,
-			Schema: schema(req.ResourceSchema),
+			Schema: req.ResourceSchema,
 		}
 	}
 
 	if req.PriorState == nil {
 		req.PriorState = &tfsdk.State{
 			Raw:    nullTfValue,
-			Schema: schema(req.ResourceSchema),
+			Schema: req.ResourceSchema,
 		}
 	}
 

internal/fwserver/server_readdatasource.go

@@ -53,12 +53,12 @@ func (s *Server) ReadDataSource(ctx context.Context, req *ReadDataSourceRequest,
 
 	readReq := datasource.ReadRequest{
 		Config: tfsdk.Config{
-			Schema: schema(req.DataSourceSchema),
+			Schema: req.DataSourceSchema,
 		},
 	}
 	readResp := datasource.ReadResponse{
 		State: tfsdk.State{
-			Schema: schema(req.DataSourceSchema),
+			Schema: req.DataSourceSchema,
 		},
 	}
 

internal/fwserver/server_updateresource.go

@@ -63,21 +63,21 @@ func (s *Server) UpdateResource(ctx context.Context, req *UpdateResourceRequest,
 
 	updateReq := resource.UpdateRequest{
 		Config: tfsdk.Config{
-			Schema: schema(req.ResourceSchema),
+			Schema: req.ResourceSchema,
 			Raw:    nullSchemaData,
 		},
 		Plan: tfsdk.Plan{
-			Schema: schema(req.ResourceSchema),
+			Schema: req.ResourceSchema,
 			Raw:    nullSchemaData,
 		},
 		State: tfsdk.State{
-			Schema: schema(req.ResourceSchema),
+			Schema: req.ResourceSchema,
 			Raw:    nullSchemaData,
 		},
 	}
 	updateResp := resource.UpdateResponse{
 		State: tfsdk.State{
-			Schema: schema(req.ResourceSchema),
+			Schema: req.ResourceSchema,
 			Raw:    nullSchemaData,
 		},
 	}

internal/fwserver/server_upgraderesourcestate.go

@@ -92,7 +92,7 @@ func (s *Server) UpgradeResourceState(ctx context.Context, req *UpgradeResourceS
 		}
 
 		resp.UpgradedState = &tfsdk.State{
-			Schema: schema(req.ResourceSchema),
+			Schema: req.ResourceSchema,
 			Raw:    rawStateValue,
 		}
 
@@ -181,7 +181,7 @@ func (s *Server) UpgradeResourceState(ctx context.Context, req *UpgradeResourceS
 
 	upgradeResourceStateResponse := resource.UpgradeStateResponse{
 		State: tfsdk.State{
-			Schema: schema(req.ResourceSchema),
+			Schema: req.ResourceSchema,
 			// Raw is intentionally not set.
 		},
 	}
@@ -216,7 +216,7 @@ func (s *Server) UpgradeResourceState(ctx context.Context, req *UpgradeResourceS
 		}
 
 		resp.UpgradedState = &tfsdk.State{
-			Schema: schema(req.ResourceSchema),
+			Schema: req.ResourceSchema,
 			Raw:    upgradedStateValue,
 		}
 

tfsdk/config.go

@@ -4,6 +4,7 @@ import (
 	"context"
 
 	"github.com/hashicorp/terraform-plugin-framework/diag"
+	"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
 	"github.com/hashicorp/terraform-plugin-framework/internal/fwschemadata"
 	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-go/tftypes"
@@ -12,7 +13,7 @@ import (
 // Config represents a Terraform config.
 type Config struct {
 	Raw    tftypes.Value
-	Schema Schema
+	Schema fwschema.Schema
 }
 
 // Get populates the struct passed as `target` with the entire config.

tfsdk/plan.go

@@ -4,6 +4,7 @@ import (
 	"context"
 
 	"github.com/hashicorp/terraform-plugin-framework/diag"
+	"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
 	"github.com/hashicorp/terraform-plugin-framework/internal/fwschemadata"
 	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-go/tftypes"
@@ -12,7 +13,7 @@ import (
 // Plan represents a Terraform plan.
 type Plan struct {
 	Raw    tftypes.Value
-	Schema Schema
+	Schema fwschema.Schema
 }
 
 // Get populates the struct passed as `target` with the entire plan.

tfsdk/state.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 
 	"github.com/hashicorp/terraform-plugin-framework/diag"
+	"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
 	"github.com/hashicorp/terraform-plugin-framework/internal/fwschemadata"
 	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-go/tftypes"
@@ -13,7 +14,7 @@ import (
 // State represents a Terraform state.
 type State struct {
 	Raw    tftypes.Value
-	Schema Schema
+	Schema fwschema.Schema
 }
 
 // Get populates the struct passed as `target` with the entire state.