tfsdk: Initial support for Data Source, Provider, and Resource validation

Reference: #17
Reference: #65

Author: bflad

tfsdk/data_source_validation.go

@@ -0,0 +1,33 @@
+package tfsdk
+
+import (
+	"context"
+)
+
+// DataSourceConfigValidator describes reusable DataSource configuration validation functionality.
+type DataSourceConfigValidator interface {
+	// Description describes the validation in plain text formatting.
+	Description(context.Context) string
+
+	// MarkdownDescription describes the validation in Markdown formatting.
+	MarkdownDescription(context.Context) string
+
+	// Validate performs the validation.
+	Validate(context.Context, ValidateDataSourceConfigRequest, *ValidateDataSourceConfigResponse)
+}
+
+// DataSourceWithConfigValidators is an interface type that extends DataSource to include declarative validations.
+type DataSourceWithConfigValidators interface {
+	DataSource
+
+	// ConfigValidators returns a list of functions which will all be performed during validation.
+	ConfigValidators(context.Context) []DataSourceConfigValidator
+}
+
+// DataSourceWithValidateConfig is an interface type that extends DataSource to include imperative validation.
+type DataSourceWithValidateConfig interface {
+	DataSource
+
+	// ValidateConfig performs the validation.
+	ValidateConfig(context.Context, ValidateDataSourceConfigRequest, *ValidateDataSourceConfigResponse)
+}

tfsdk/provider_validation.go

@@ -0,0 +1,33 @@
+package tfsdk
+
+import (
+	"context"
+)
+
+// ProviderConfigValidator describes reusable Provider configuration validation functionality.
+type ProviderConfigValidator interface {
+	// Description describes the validation in plain text formatting.
+	Description(context.Context) string
+
+	// MarkdownDescription describes the validation in Markdown formatting.
+	MarkdownDescription(context.Context) string
+
+	// Validate performs the validation.
+	Validate(context.Context, ValidateProviderConfigRequest, *ValidateProviderConfigResponse)
+}
+
+// ProviderWithConfigValidators is an interface type that extends Provider to include declarative validations.
+type ProviderWithConfigValidators interface {
+	Provider
+
+	// ConfigValidators returns a list of functions which will all be performed during validation.
+	ConfigValidators(context.Context) []ProviderConfigValidator
+}
+
+// ProviderWithValidateConfig is an interface type that extends Provider to include imperative validation.
+type ProviderWithValidateConfig interface {
+	Provider
+
+	// ValidateConfig performs the validation.
+	ValidateConfig(context.Context, ValidateProviderConfigRequest, *ValidateProviderConfigResponse)
+}

tfsdk/request_validation.go

@@ -0,0 +1,46 @@
+package tfsdk
+
+// ValidateDataSourceConfigRequest represents a request to validate the
+// configuration of a data source. An instance of this request struct is
+// supplied as an argument to the DataSource ValidateConfig receiver method
+// or automatically passed through to each ConfigValidator.
+type ValidateDataSourceConfigRequest struct {
+	// Config is the configuration the user supplied for the data source.
+	//
+	// This configuration may contain unknown values if a user uses
+	// interpolation or other functionality that would prevent Terraform
+	// from knowing the value at request time.
+	Config Config
+
+	// TypeName is the data source type name.
+	TypeName string
+}
+
+// ValidateProviderConfigRequest represents a request to validate the
+// configuration of a provider. An instance of this request struct is
+// supplied as an argument to the Provider ValidateConfig receiver method
+// or automatically passed through to each ConfigValidator.
+type ValidateProviderConfigRequest struct {
+	// Config is the configuration the user supplied for the provider.
+	//
+	// This configuration may contain unknown values if a user uses
+	// interpolation or other functionality that would prevent Terraform
+	// from knowing the value at request time.
+	Config Config
+}
+
+// ValidateResourceConfigRequest represents a request to validate the
+// configuration of a resource. An instance of this request struct is
+// supplied as an argument to the Resource ValidateConfig receiver method
+// or automatically passed through to each ConfigValidator.
+type ValidateResourceConfigRequest struct {
+	// Config is the configuration the user supplied for the resource.
+	//
+	// This configuration may contain unknown values if a user uses
+	// interpolation or other functionality that would prevent Terraform
+	// from knowing the value at request time.
+	Config Config
+
+	// TypeName is the resource type name.
+	TypeName string
+}

tfsdk/resource_validation.go

@@ -0,0 +1,33 @@
+package tfsdk
+
+import (
+	"context"
+)
+
+// ResourceConfigValidator describes reusable Resource configuration validation functionality.
+type ResourceConfigValidator interface {
+	// Description describes the validation in plain text formatting.
+	Description(context.Context) string
+
+	// MarkdownDescription describes the validation in Markdown formatting.
+	MarkdownDescription(context.Context) string
+
+	// Validate performs the validation.
+	Validate(context.Context, ValidateResourceConfigRequest, *ValidateResourceConfigResponse)
+}
+
+// ResourceWithConfigValidators is an interface type that extends Resource to include declarative validations.
+type ResourceWithConfigValidators interface {
+	Resource
+
+	// ConfigValidators returns a list of functions which will all be performed during validation.
+	ConfigValidators(context.Context) []ResourceConfigValidator
+}
+
+// ResourceWithValidateConfig is an interface type that extends Resource to include imperative validation.
+type ResourceWithValidateConfig interface {
+	Resource
+
+	// ValidateConfig performs the validation.
+	ValidateConfig(context.Context, ValidateResourceConfigRequest, *ValidateResourceConfigResponse)
+}

tfsdk/response_validation.go

@@ -0,0 +1,38 @@
+package tfsdk
+
+import (
+	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
+)
+
+// ValidateDataSourceConfigResponse represents a response to a
+// ValidateDataSourceConfigRequest. An instance of this response struct is
+// supplied as an argument to the DataSource ValidateConfig receiver method
+// or automatically passed through to each ConfigValidator.
+type ValidateDataSourceConfigResponse struct {
+	// Diagnostics report errors or warnings related to validating the data
+	// source configuration. An empty slice indicates success, with no warnings
+	// or errors generated.
+	Diagnostics []*tfprotov6.Diagnostic
+}
+
+// ValidateResourceConfigResponse represents a response to a
+// ValidateResourceConfigRequest. An instance of this response struct is
+// supplied as an argument to the Resource ValidateConfig receiver method
+// or automatically passed through to each ConfigValidator.
+type ValidateResourceConfigResponse struct {
+	// Diagnostics report errors or warnings related to validating the resource
+	// configuration. An empty slice indicates success, with no warnings or
+	// errors generated.
+	Diagnostics []*tfprotov6.Diagnostic
+}
+
+// ValidateProviderConfigResponse represents a response to a
+// ValidateProviderConfigRequest. An instance of this response struct is
+// supplied as an argument to the Provider ValidateConfig receiver method
+// or automatically passed through to each ConfigValidator.
+type ValidateProviderConfigResponse struct {
+	// Diagnostics report errors or warnings related to validating the provider
+	// configuration. An empty slice indicates success, with no warnings or
+	// errors generated.
+	Diagnostics []*tfprotov6.Diagnostic
+}