external interface

Author: austinvalle

action/action.go

@@ -49,3 +49,33 @@ type ActionWithModifyPlan interface {
 	// diagnostics to practitioners, such as validation errors.
 	ModifyPlan(context.Context, ModifyPlanRequest, *ModifyPlanResponse)
 }
+
+// ActionWithConfigValidators is an interface type that extends Action to include declarative validations.
+//
+// Declaring validation using this methodology simplifies implementation of
+// reusable functionality. These also include descriptions, which can be used
+// for automating documentation.
+//
+// Validation will include ConfigValidators and ValidateConfig, if both are
+// implemented, in addition to any Attribute or Type validation.
+type ActionWithConfigValidators interface {
+	Action
+
+	// ConfigValidators returns a list of functions which will all be performed during validation.
+	ConfigValidators(context.Context) []ConfigValidator
+}
+
+// ActionWithValidateConfig is an interface type that extends Action to include imperative validation.
+//
+// Declaring validation using this methodology simplifies one-off
+// functionality that typically applies to a single action. Any documentation
+// of this functionality must be manually added into schema descriptions.
+//
+// Validation will include ConfigValidators and ValidateConfig, if both are
+// implemented, in addition to any Attribute or Type validation.
+type ActionWithValidateConfig interface {
+	Action
+
+	// ValidateConfig performs the validation.
+	ValidateConfig(context.Context, ValidateConfigRequest, *ValidateConfigResponse)
+}

action/config_validator.go

@@ -0,0 +1,30 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package action
+
+import "context"
+
+// ConfigValidator describes reusable Action configuration validation functionality.
+type ConfigValidator interface {
+	// Description describes the validation in plain text formatting.
+	//
+	// This information may be automatically added to action plain text
+	// descriptions by external tooling.
+	Description(context.Context) string
+
+	// MarkdownDescription describes the validation in Markdown formatting.
+	//
+	// This information may be automatically added to action Markdown
+	// descriptions by external tooling.
+	MarkdownDescription(context.Context) string
+
+	// ValidateAction performs the validation.
+	//
+	// This method name is separate from the datasource.ConfigValidator
+	// interface ValidateDataSource method name, provider.ConfigValidator
+	// interface ValidateProvider method name, ephemeral.ConfigValidator
+	// interface ValidateEphemeralResource method name, and resource.ConfigValidator
+	// interface ValidateResource method name to allow generic validators.
+	ValidateAction(context.Context, ValidateConfigRequest, *ValidateConfigResponse)
+}

action/validate_config.go

@@ -0,0 +1,33 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package action
+
+import (
+	"github.com/hashicorp/terraform-plugin-framework/diag"
+	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
+)
+
+// ValidateConfigRequest represents a request to validate the
+// configuration of an action. An instance of this request struct is
+// supplied as an argument to the Action ValidateConfig receiver method
+// or automatically passed through to each ConfigValidator.
+type ValidateConfigRequest struct {
+	// Config is the configuration the user supplied for the action.
+	//
+	// 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 tfsdk.Config
+}
+
+// ValidateConfigResponse represents a response to a
+// ValidateConfigRequest. An instance of this response struct is
+// supplied as an argument to the Action ValidateConfig receiver method
+// or automatically passed through to each ConfigValidator.
+type ValidateConfigResponse struct {
+	// Diagnostics report errors or warnings related to validating the action
+	// configuration. An empty slice indicates success, with no warnings or
+	// errors generated.
+	Diagnostics diag.Diagnostics
+}