Migrate schema package into tfsdk package

bflad · bflad · commit bcb5ce16508c · 2021-07-27T11:58:34.000-04:00
Reference: #76 This is now stuck at the below: ``` package github.com/hashicorp/terraform-plugin-framework/internal/proto6 imports github.com/hashicorp/terraform-plugin-framework/tfsdk imports github.com/hashicorp/terraform-plugin-framework/internal/proto6: import cycle not allowed ```
diff --git a/internal/proto6/schema.go b/internal/proto6/schema.go
@@ -5,15 +5,14 @@ import (
 	"errors"
 	"sort"
 
-	"github.com/hashicorp/terraform-plugin-framework/schema"
-
+	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
 	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
 	"github.com/hashicorp/terraform-plugin-go/tftypes"
 )
 
-// Schema returns the *tfprotov6.Schema equivalent of a schema.Schema. At least
+// Schema returns the *tfprotov6.Schema equivalent of a tfsdk.Schema. At least
 // one attribute must be set in the schema, or an error will be returned.
-func Schema(ctx context.Context, s schema.Schema) (*tfprotov6.Schema, error) {
+func Schema(ctx context.Context, s tfsdk.Schema) (*tfprotov6.Schema, error) {
 	result := &tfprotov6.Schema{
 		Version: s.Version,
 	}
@@ -55,9 +54,9 @@ func Schema(ctx context.Context, s schema.Schema) (*tfprotov6.Schema, error) {
 }
 
 // Attribute returns the *tfprotov6.SchemaAttribute equivalent of a
-// schema.Attribute. Errors will be tftypes.AttributePathErrors based on
+// tfsdk.Attribute. Errors will be tftypes.AttributePathErrors based on
 // `path`. `name` is the name of the attribute.
-func Attribute(ctx context.Context, name string, attr schema.Attribute, path *tftypes.AttributePath) (*tfprotov6.SchemaAttribute, error) {
+func Attribute(ctx context.Context, name string, attr tfsdk.Attribute, path *tftypes.AttributePath) (*tfprotov6.SchemaAttribute, error) {
 	a := &tfprotov6.SchemaAttribute{
 		Name:      name,
 		Required:  attr.Required,
@@ -85,13 +84,13 @@ func Attribute(ctx context.Context, name string, attr schema.Attribute, path *tf
 		}
 		nm := attr.Attributes.GetNestingMode()
 		switch nm {
-		case schema.NestingModeSingle:
+		case tfsdk.NestingModeSingle:
 			object.Nesting = tfprotov6.SchemaObjectNestingModeSingle
-		case schema.NestingModeList:
+		case tfsdk.NestingModeList:
 			object.Nesting = tfprotov6.SchemaObjectNestingModeList
-		case schema.NestingModeSet:
+		case tfsdk.NestingModeSet:
 			object.Nesting = tfprotov6.SchemaObjectNestingModeSet
-		case schema.NestingModeMap:
+		case tfsdk.NestingModeMap:
 			object.Nesting = tfprotov6.SchemaObjectNestingModeMap
 		default:
 			return nil, path.NewErrorf("unrecognized nesting mode %v", nm)
diff --git a/tfsdk/attribute.go b/tfsdk/attribute.go
@@ -1,4 +1,4 @@
-package schema
+package tfsdk
 
 import (
 	"errors"
diff --git a/tfsdk/config.go b/tfsdk/config.go
@@ -6,14 +6,13 @@ import (
 
 	"github.com/hashicorp/terraform-plugin-framework/attr"
 	"github.com/hashicorp/terraform-plugin-framework/internal/reflect"
-	"github.com/hashicorp/terraform-plugin-framework/schema"
 	"github.com/hashicorp/terraform-plugin-go/tftypes"
 )
 
 // Config represents a Terraform config.
 type Config struct {
 	Raw    tftypes.Value
-	Schema schema.Schema
+	Schema Schema
 }
 
 // Get populates the struct passed as `target` with the entire config.
diff --git a/tfsdk/data_source.go b/tfsdk/data_source.go
@@ -3,7 +3,6 @@ package tfsdk
 import (
 	"context"
 
-	"github.com/hashicorp/terraform-plugin-framework/schema"
 	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
 )
 
@@ -12,7 +11,7 @@ import (
 // return an instance of it in the map returned by Provider.GetDataSources.
 type DataSourceType interface {
 	// GetSchema returns the schema for this data source.
-	GetSchema(context.Context) (schema.Schema, []*tfprotov6.Diagnostic)
+	GetSchema(context.Context) (Schema, []*tfprotov6.Diagnostic)
 
 	// NewDataSource instantiates a new DataSource of this DataSourceType.
 	NewDataSource(context.Context, Provider) (DataSource, []*tfprotov6.Diagnostic)
diff --git a/tfsdk/nested_attributes.go b/tfsdk/nested_attributes.go
@@ -1,4 +1,4 @@
-package schema
+package tfsdk
 
 import (
 	"fmt"
diff --git a/tfsdk/plan.go b/tfsdk/plan.go
@@ -6,14 +6,13 @@ import (
 
 	"github.com/hashicorp/terraform-plugin-framework/attr"
 	"github.com/hashicorp/terraform-plugin-framework/internal/reflect"
-	"github.com/hashicorp/terraform-plugin-framework/schema"
 	"github.com/hashicorp/terraform-plugin-go/tftypes"
 )
 
 // Plan represents a Terraform plan.
 type Plan struct {
 	Raw    tftypes.Value
-	Schema schema.Schema
+	Schema Schema
 }
 
 // Get populates the struct passed as `target` with the entire plan.
diff --git a/tfsdk/provider.go b/tfsdk/provider.go
@@ -3,15 +3,14 @@ package tfsdk
 import (
 	"context"
 
-	"github.com/hashicorp/terraform-plugin-framework/schema"
 	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
 )
 
 // Provider is the core interface that all Terraform providers must implement.
 type Provider interface {
 	// GetSchema returns the schema for this provider's configuration. If
 	// this provider has no configuration, return an empty schema.Schema.
-	GetSchema(context.Context) (schema.Schema, []*tfprotov6.Diagnostic)
+	GetSchema(context.Context) (Schema, []*tfprotov6.Diagnostic)
 
 	// Configure is called at the beginning of the provider lifecycle, when
 	// Terraform sends to the provider the values the user specified in the
@@ -38,5 +37,5 @@ type Provider interface {
 type ProviderWithProviderMeta interface {
 	Provider
 	// GetMetaSchema returns the provider meta schema.
-	GetMetaSchema(context.Context) (schema.Schema, []*tfprotov6.Diagnostic)
+	GetMetaSchema(context.Context) (Schema, []*tfprotov6.Diagnostic)
 }
diff --git a/tfsdk/resource.go b/tfsdk/resource.go
@@ -3,7 +3,6 @@ package tfsdk
 import (
 	"context"
 
-	"github.com/hashicorp/terraform-plugin-framework/schema"
 	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
 )
 
@@ -12,7 +11,7 @@ import (
 // instance of it in the map returned by Provider.GeResources.
 type ResourceType interface {
 	// GetSchema returns the schema for this resource.
-	GetSchema(context.Context) (schema.Schema, []*tfprotov6.Diagnostic)
+	GetSchema(context.Context) (Schema, []*tfprotov6.Diagnostic)
 
 	// NewResource instantiates a new Resource of this ResourceType.
 	NewResource(context.Context, Provider) (Resource, []*tfprotov6.Diagnostic)
diff --git a/tfsdk/schema.go b/tfsdk/schema.go
@@ -1,4 +1,4 @@
-package schema
+package tfsdk
 
 import (
 	"context"
diff --git a/tfsdk/schema_test.go b/tfsdk/schema_test.go
@@ -1,4 +1,4 @@
-package schema
+package tfsdk
 
 import (
 	"testing"
diff --git a/tfsdk/serve.go b/tfsdk/serve.go
@@ -7,8 +7,6 @@ import (
 	"sync"
 
 	"github.com/hashicorp/terraform-plugin-framework/internal/proto6"
-	"github.com/hashicorp/terraform-plugin-framework/schema"
-
 	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
 	tf6server "github.com/hashicorp/terraform-plugin-go/tfprotov6/server"
 	"github.com/hashicorp/terraform-plugin-go/tftypes"
@@ -379,14 +377,14 @@ func (s *server) ReadResource(ctx context.Context, req *tfprotov6.ReadResourceRe
 	return resp, nil
 }
 
-func markComputedNilsAsUnknown(ctx context.Context, resourceSchema schema.Schema) func(*tftypes.AttributePath, tftypes.Value) (tftypes.Value, error) {
+func markComputedNilsAsUnknown(ctx context.Context, resourceSchema Schema) func(*tftypes.AttributePath, tftypes.Value) (tftypes.Value, error) {
 	return func(path *tftypes.AttributePath, val tftypes.Value) (tftypes.Value, error) {
 		if !val.IsNull() {
 			return val, nil
 		}
 		attribute, err := resourceSchema.AttributeAtPath(path)
 		if err != nil {
-			if errors.Is(err, schema.ErrPathInsideAtomicAttribute) {
+			if errors.Is(err, ErrPathInsideAtomicAttribute) {
 				// ignore attributes/elements inside schema.Attributes, they have no schema of their own
 				return val, nil
 			}
diff --git a/tfsdk/serve_data_source_one_test.go b/tfsdk/serve_data_source_one_test.go
@@ -4,18 +4,16 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/hashicorp/terraform-plugin-framework/schema"
 	"github.com/hashicorp/terraform-plugin-framework/types"
-
 	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
 	"github.com/hashicorp/terraform-plugin-go/tftypes"
 )
 
 type testServeDataSourceTypeOne struct{}
 
-func (dt testServeDataSourceTypeOne) GetSchema(_ context.Context) (schema.Schema, []*tfprotov6.Diagnostic) {
-	return schema.Schema{
-		Attributes: map[string]schema.Attribute{
+func (dt testServeDataSourceTypeOne) GetSchema(_ context.Context) (Schema, []*tfprotov6.Diagnostic) {
+	return Schema{
+		Attributes: map[string]Attribute{
 			"current_time": {
 				Type:     types.StringType,
 				Computed: true,
diff --git a/tfsdk/serve_data_source_two_test.go b/tfsdk/serve_data_source_two_test.go
@@ -4,18 +4,16 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/hashicorp/terraform-plugin-framework/schema"
 	"github.com/hashicorp/terraform-plugin-framework/types"
-
 	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
 	"github.com/hashicorp/terraform-plugin-go/tftypes"
 )
 
 type testServeDataSourceTypeTwo struct{}
 
-func (dt testServeDataSourceTypeTwo) GetSchema(_ context.Context) (schema.Schema, []*tfprotov6.Diagnostic) {
-	return schema.Schema{
-		Attributes: map[string]schema.Attribute{
+func (dt testServeDataSourceTypeTwo) GetSchema(_ context.Context) (Schema, []*tfprotov6.Diagnostic) {
+	return Schema{
+		Attributes: map[string]Attribute{
 			"family": {
 				Type:     types.StringType,
 				Optional: true,
diff --git a/tfsdk/serve_provider_test.go b/tfsdk/serve_provider_test.go
@@ -4,56 +4,54 @@ import (
 	"context"
 
 	"github.com/hashicorp/terraform-plugin-framework/attr"
-	"github.com/hashicorp/terraform-plugin-framework/schema"
 	"github.com/hashicorp/terraform-plugin-framework/types"
-
 	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
 	"github.com/hashicorp/terraform-plugin-go/tftypes"
 )
 
 type testServeProvider struct {
 	// configure
 	configuredVal       tftypes.Value
-	configuredSchema    schema.Schema
+	configuredSchema    Schema
 	configuredTFVersion string
 
 	// read resource request
 	readResourceCurrentStateValue  tftypes.Value
-	readResourceCurrentStateSchema schema.Schema
+	readResourceCurrentStateSchema Schema
 	readResourceProviderMetaValue  tftypes.Value
-	readResourceProviderMetaSchema schema.Schema
+	readResourceProviderMetaSchema Schema
 	readResourceImpl               func(context.Context, ReadResourceRequest, *ReadResourceResponse)
 	readResourceCalledResourceType string
 
 	// apply resource change
 	applyResourceChangeCalledResourceType string
 	applyResourceChangeCalledAction       string
 	applyResourceChangePriorStateValue    tftypes.Value
-	applyResourceChangePriorStateSchema   schema.Schema
+	applyResourceChangePriorStateSchema   Schema
 	applyResourceChangePlannedStateValue  tftypes.Value
-	applyResourceChangePlannedStateSchema schema.Schema
+	applyResourceChangePlannedStateSchema Schema
 	applyResourceChangeConfigValue        tftypes.Value
-	applyResourceChangeConfigSchema       schema.Schema
+	applyResourceChangeConfigSchema       Schema
 	applyResourceChangeProviderMetaValue  tftypes.Value
-	applyResourceChangeProviderMetaSchema schema.Schema
+	applyResourceChangeProviderMetaSchema Schema
 	createFunc                            func(context.Context, CreateResourceRequest, *CreateResourceResponse)
 	updateFunc                            func(context.Context, UpdateResourceRequest, *UpdateResourceResponse)
 	deleteFunc                            func(context.Context, DeleteResourceRequest, *DeleteResourceResponse)
 
 	// read data source request
 	readDataSourceConfigValue          tftypes.Value
-	readDataSourceConfigSchema         schema.Schema
+	readDataSourceConfigSchema         Schema
 	readDataSourceProviderMetaValue    tftypes.Value
-	readDataSourceProviderMetaSchema   schema.Schema
+	readDataSourceProviderMetaSchema   Schema
 	readDataSourceImpl                 func(context.Context, ReadDataSourceRequest, *ReadDataSourceResponse)
 	readDataSourceCalledDataSourceType string
 }
 
-func (t *testServeProvider) GetSchema(_ context.Context) (schema.Schema, []*tfprotov6.Diagnostic) {
-	return schema.Schema{
+func (t *testServeProvider) GetSchema(_ context.Context) (Schema, []*tfprotov6.Diagnostic) {
+	return Schema{
 		Version:            1,
 		DeprecationMessage: "Deprecated in favor of other_resource",
-		Attributes: map[string]schema.Attribute{
+		Attributes: map[string]Attribute{
 			"required": {
 				Type:     types.StringType,
 				Required: true,
@@ -143,7 +141,7 @@ func (t *testServeProvider) GetSchema(_ context.Context) (schema.Schema, []*tfpr
 			// TODO: add sets when we support them
 			// TODO: add tuples when we support them
 			"single-nested-attributes": {
-				Attributes: schema.SingleNestedAttributes(map[string]schema.Attribute{
+				Attributes: SingleNestedAttributes(map[string]Attribute{
 					"foo": {
 						Type:     types.StringType,
 						Optional: true,
@@ -157,7 +155,7 @@ func (t *testServeProvider) GetSchema(_ context.Context) (schema.Schema, []*tfpr
 				Optional: true,
 			},
 			"list-nested-attributes": {
-				Attributes: schema.ListNestedAttributes(map[string]schema.Attribute{
+				Attributes: ListNestedAttributes(map[string]Attribute{
 					"foo": {
 						Type:     types.StringType,
 						Optional: true,
@@ -167,11 +165,11 @@ func (t *testServeProvider) GetSchema(_ context.Context) (schema.Schema, []*tfpr
 						Type:     types.NumberType,
 						Required: true,
 					},
-				}, schema.ListNestedAttributesOptions{}),
+				}, ListNestedAttributesOptions{}),
 				Optional: true,
 			},
 			"map-nested-attributes": {
-				Attributes: schema.MapNestedAttributes(map[string]schema.Attribute{
+				Attributes: MapNestedAttributes(map[string]Attribute{
 					"foo": {
 						Type:     types.StringType,
 						Optional: true,
@@ -181,7 +179,7 @@ func (t *testServeProvider) GetSchema(_ context.Context) (schema.Schema, []*tfpr
 						Type:     types.NumberType,
 						Required: true,
 					},
-				}, schema.MapNestedAttributesOptions{}),
+				}, MapNestedAttributesOptions{}),
 				Optional: true,
 			},
 		},
@@ -429,10 +427,10 @@ type testServeProviderWithMetaSchema struct {
 	*testServeProvider
 }
 
-func (t *testServeProviderWithMetaSchema) GetMetaSchema(context.Context) (schema.Schema, []*tfprotov6.Diagnostic) {
-	return schema.Schema{
+func (t *testServeProviderWithMetaSchema) GetMetaSchema(context.Context) (Schema, []*tfprotov6.Diagnostic) {
+	return Schema{
 		Version: 2,
-		Attributes: map[string]schema.Attribute{
+		Attributes: map[string]Attribute{
 			"foo": {
 				Type:                types.StringType,
 				Required:            true,
diff --git a/tfsdk/serve_resource_one_test.go b/tfsdk/serve_resource_one_test.go
@@ -4,19 +4,17 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/hashicorp/terraform-plugin-framework/schema"
 	"github.com/hashicorp/terraform-plugin-framework/types"
-
 	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
 	"github.com/hashicorp/terraform-plugin-go/tftypes"
 )
 
 type testServeResourceTypeOne struct{}
 
-func (rt testServeResourceTypeOne) GetSchema(_ context.Context) (schema.Schema, []*tfprotov6.Diagnostic) {
-	return schema.Schema{
+func (rt testServeResourceTypeOne) GetSchema(_ context.Context) (Schema, []*tfprotov6.Diagnostic) {
+	return Schema{
 		Version: 1,
-		Attributes: map[string]schema.Attribute{
+		Attributes: map[string]Attribute{
 			"name": {
 				Required: true,
 				Type:     types.StringType,
diff --git a/tfsdk/serve_resource_two_test.go b/tfsdk/serve_resource_two_test.go
diff --git a/tfsdk/serve_test.go b/tfsdk/serve_test.go
diff --git a/tfsdk/state.go b/tfsdk/state.go
diff --git a/tfsdk/state_test.go b/tfsdk/state_test.go

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package schema`
	`1`	`+package tfsdk`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"errors"`
Original file line number	Diff line number	Diff line change
`@@ -6,14 +6,13 @@ import (`
`6`	`6`
`7`	`7`	`"github.com/hashicorp/terraform-plugin-framework/attr"`
`8`	`8`	`"github.com/hashicorp/terraform-plugin-framework/internal/reflect"`
`9`		`- "github.com/hashicorp/terraform-plugin-framework/schema"`
`10`	`9`	`"github.com/hashicorp/terraform-plugin-go/tftypes"`
`11`	`10`	`)`
`12`	`11`
`13`	`12`	`// Config represents a Terraform config.`
`14`	`13`	`type Config struct {`
`15`	`14`	`Raw tftypes.Value`
`16`		`- Schema schema.Schema`
	`15`	`+ Schema Schema`
`17`	`16`	`}`
`18`	`17`
`19`	`18`	// Get populates the struct passed as `target` with the entire config.