Provider, Resource, and DataSource types (#32)

* improve request godoc

* define provider and resource types

Co-authored-by: Paddy <[email protected]>

* clarify godoc for resource types

* use our schema package

Co-authored-by: Paddy <[email protected]>

Author: kmoe

data_source.go

@@ -0,0 +1,28 @@
+package tfsdk
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-framework/schema"
+	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
+)
+
+// A DataSourceType is a type of data source. For each type of data source this
+// provider supports, it should define a type implementing DataSourceType and
+// 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)
+
+	// NewDataSource instantiates a new DataSource of this DataSourceType.
+	NewDataSource(Provider) (DataSource, []*tfprotov6.Diagnostic)
+}
+
+// DataSource implements a data source instance.
+type DataSource interface {
+	// Read is called when the provider must read data source values in
+	// order to update state. Planned state values should be read from the
+	// ReadResourceRequest and new state values set on the
+	// ReadResourceResponse.
+	Read(context.Context, *ReadResourceRequest, *ReadResourceResponse)
+}

provider.go

@@ -0,0 +1,42 @@
+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 nil.
+	GetSchema(context.Context) (schema.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
+	// provider configuration block. These are supplied in the
+	// ConfigureProviderRequest argument.
+	// Values from provider configuration are often used to initialise an
+	// API client, which should be stored on the struct implementing the
+	// Provider interface.
+	Configure(context.Context, *ConfigureProviderRequest, *ConfigureProviderResponse)
+
+	// GetResources returns a map of the resource types this provider
+	// supports.
+	GetResources(context.Context) (map[string]ResourceType, []*tfprotov6.Diagnostic)
+
+	// GetDataSources returns a map of the data source types this provider
+	// supports.
+	GetDataSources(context.Context) (map[string]DataSourceType, []*tfprotov6.Diagnostic)
+}
+
+// ProviderWithProviderMeta is a provider with a provider meta schema.
+// This functionality is currently experimental and subject to change or break
+// without warning; it should only be used by providers that are collaborating
+// on its use with the Terraform team.
+type ProviderWithProviderMeta interface {
+	Provider
+	// GetMetaSchema returns the provider meta schema.
+	GetMetaSchema(context.Context) (*tfprotov6.Schema, []*tfprotov6.Diagnostic)
+}

request.go

@@ -4,11 +4,10 @@ import (
 	"github.com/hashicorp/terraform-plugin-go/tftypes"
 )
 
-// ConfigureProviderRequest represents a request supplying the provider with
-// the values the user supplied for the provider configuration block, along with
-// other runtime information supplied by Terraform or the Plugin SDK. An
-// instance of this request struct is supplied as an argument to the provider's
-// Configure function.
+// ConfigureProviderRequest represents a request containing the values the user
+// specified for the provider configuration block, along with other runtime
+// information from Terraform or the Plugin SDK. An instance of this request
+// struct is supplied as an argument to the provider's Configure function.
 type ConfigureProviderRequest struct {
 	// TerraformVersion is the version of Terraform executing the request.
 	// This is supplied for logging, analytics, and User-Agent purposes
@@ -45,9 +44,6 @@ type CreateResourceRequest struct {
 // resource. An instance of this request struct is supplied as an argument to
 // the resource's Read function.
 type ReadResourceRequest struct {
-	// tfprotov6.ReadResourceRequest has no Config field
-	// Config     Config
-
 	// State is the current state of the resource prior to the Read
 	// operation.
 	// TODO uncomment when implemented

resource.go

@@ -0,0 +1,45 @@
+package tfsdk
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-framework/schema"
+	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
+)
+
+// A ResourceType is a type of resource. For each type of resource this provider
+// supports, it should define a type implementing ResourceType and return an
+// 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)
+
+	// NewResource instantiates a new Resource of this ResourceType.
+	NewResource(Provider) (Resource, []*tfprotov6.Diagnostic)
+}
+
+// Resource represents a resource instance. This is the core interface that all
+// resources must implement.
+type Resource interface {
+	// Create is called when the provider must create a new resource. Config
+	// and planned state values should be read from the
+	// CreateResourceRequest and new state values set on the
+	// CreateResourceResponse.
+	Create(context.Context, *CreateResourceRequest, *CreateResourceResponse)
+
+	// Read is called when the provider must read resource values in order
+	// to update state. Planned state values should be read from the
+	// ReadResourceRequest and new state values set on the
+	// ReadResourceResponse.
+	Read(context.Context, *ReadResourceRequest, *ReadResourceResponse)
+
+	// Update is called to update the state of the resource. Config, planned
+	// state, and prior state values should be read from the
+	// UpdateResourceRequest and new state values set on the
+	// UpdateResourceResponse.
+	Update(context.Context, *UpdateResourceRequest, *UpdateResourceResponse)
+
+	// Delete is called when the provider must delete the resource. Config
+	// values may be read from the DeleteResourceRequest.
+	Delete(context.Context, *DeleteResourceRequest, *DeleteResourceResponse)
+}