action: Add standard validation methods/interfaces for ValidateActionConfig RPCs (#1188)

* go mod

* generate RPC methods

* protov5 and fwserver impl

* protov6 copy

* add initial schema attributes and unlinked schema

* implement unlinked schemas, some attributes, and the rpcs

* the rest of the tests

* fix double import

* external interfaces for plan / configure

* plan action impl and fwserver tests

* proto server tests

* from/to plan tests

* from invoke

* add invoke impl with just completed event

* fix map access in unit tests

* implementation of sending progress events

* mention progress events

* comments

* all attributes (primitive, collection, nested)

* add blocks and docs

* update all commented out custom type tests

* go mod

* external interface

* test provider

* add validators to schemas

* fwserver

* proto5 and proto6 impl

* update config validator comments

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,27 @@
+// 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 ConfigValidators in resource and other packages in
+	// order to allow generic validators.
+	ValidateAction(context.Context, ValidateConfigRequest, *ValidateConfigResponse)
+}

action/schema/bool_attribute.go

@@ -8,13 +8,16 @@ import (
 
 	"github.com/hashicorp/terraform-plugin-framework/attr"
 	"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
+	"github.com/hashicorp/terraform-plugin-framework/internal/fwschema/fwxschema"
+	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 	"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
 )
 
 // Ensure the implementation satisfies the desired interfaces.
 var (
-	_ Attribute = BoolAttribute{}
+	_ Attribute                             = BoolAttribute{}
+	_ fwxschema.AttributeWithBoolValidators = BoolAttribute{}
 )
 
 // BoolAttribute represents a schema attribute that is a boolean. When
@@ -89,6 +92,18 @@ type BoolAttribute struct {
 	//  - https://github.com/hashicorp/terraform/issues/7569
 	//
 	DeprecationMessage string
+
+	// Validators define value validation functionality for the attribute. All
+	// elements of the slice of AttributeValidator are run, regardless of any
+	// previous error diagnostics.
+	//
+	// Many common use case validators can be found in the
+	// github.com/hashicorp/terraform-plugin-framework-validators Go module.
+	//
+	// If the Type field points to a custom type that implements the
+	// xattr.TypeWithValidate interface, the validators defined in this field
+	// are run in addition to the validation defined by the type.
+	Validators []validator.Bool
 }
 
 // ApplyTerraform5AttributePathStep always returns an error as it is not
@@ -167,3 +182,8 @@ func (a BoolAttribute) IsRequiredForImport() bool {
 func (a BoolAttribute) IsOptionalForImport() bool {
 	return false
 }
+
+// BoolValidators returns the Validators field value.
+func (a BoolAttribute) BoolValidators() []validator.Bool {
+	return a.Validators
+}

action/schema/bool_attribute_test.go

@@ -16,6 +16,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
 	"github.com/hashicorp/terraform-plugin-framework/internal/testing/testschema"
 	"github.com/hashicorp/terraform-plugin-framework/internal/testing/testtypes"
+	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 )
 
@@ -435,3 +436,35 @@ func TestBoolAttributeIsOptionalForImport(t *testing.T) {
 		})
 	}
 }
+
+func TestBoolAttributeBoolValidators(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		attribute schema.BoolAttribute
+		expected  []validator.Bool
+	}{
+		"no-validators": {
+			attribute: schema.BoolAttribute{},
+			expected:  nil,
+		},
+		"validators": {
+			attribute: schema.BoolAttribute{
+				Validators: []validator.Bool{},
+			},
+			expected: []validator.Bool{},
+		},
+	}
+
+	for name, testCase := range testCases {
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			got := testCase.attribute.BoolValidators()
+
+			if diff := cmp.Diff(got, testCase.expected); diff != "" {
+				t.Errorf("unexpected difference: %s", diff)
+			}
+		})
+	}
+}

action/schema/dynamic_attribute.go

@@ -8,13 +8,16 @@ import (
 
 	"github.com/hashicorp/terraform-plugin-framework/attr"
 	"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
+	"github.com/hashicorp/terraform-plugin-framework/internal/fwschema/fwxschema"
+	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 	"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
 )
 
 // Ensure the implementation satisifies the desired interfaces.
 var (
-	_ Attribute = DynamicAttribute{}
+	_ Attribute                                = DynamicAttribute{}
+	_ fwxschema.AttributeWithDynamicValidators = DynamicAttribute{}
 )
 
 // DynamicAttribute represents a schema attribute that is a dynamic, rather
@@ -90,6 +93,18 @@ type DynamicAttribute struct {
 	//  - https://github.com/hashicorp/terraform/issues/7569
 	//
 	DeprecationMessage string
+
+	// Validators define value validation functionality for the attribute. All
+	// elements of the slice of AttributeValidator are run, regardless of any
+	// previous error diagnostics.
+	//
+	// Many common use case validators can be found in the
+	// github.com/hashicorp/terraform-plugin-framework-validators Go module.
+	//
+	// If the Type field points to a custom type that implements the
+	// xattr.TypeWithValidate interface, the validators defined in this field
+	// are run in addition to the validation defined by the type.
+	Validators []validator.Dynamic
 }
 
 // ApplyTerraform5AttributePathStep always returns an error as it is not
@@ -168,3 +183,8 @@ func (a DynamicAttribute) IsRequiredForImport() bool {
 func (a DynamicAttribute) IsOptionalForImport() bool {
 	return false
 }
+
+// DynamicValidators returns the Validators field value.
+func (a DynamicAttribute) DynamicValidators() []validator.Dynamic {
+	return a.Validators
+}

action/schema/dynamic_attribute_test.go

@@ -14,6 +14,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
 	"github.com/hashicorp/terraform-plugin-framework/internal/testing/testschema"
 	"github.com/hashicorp/terraform-plugin-framework/internal/testing/testtypes"
+	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 	"github.com/hashicorp/terraform-plugin-go/tftypes"
 )
@@ -434,3 +435,35 @@ func TestDynamicAttributeIsOptionalForImport(t *testing.T) {
 		})
 	}
 }
+
+func TestDynamicAttributeDynamicValidators(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		attribute schema.DynamicAttribute
+		expected  []validator.Dynamic
+	}{
+		"no-validators": {
+			attribute: schema.DynamicAttribute{},
+			expected:  nil,
+		},
+		"validators": {
+			attribute: schema.DynamicAttribute{
+				Validators: []validator.Dynamic{},
+			},
+			expected: []validator.Dynamic{},
+		},
+	}
+
+	for name, testCase := range testCases {
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			got := testCase.attribute.DynamicValidators()
+
+			if diff := cmp.Diff(got, testCase.expected); diff != "" {
+				t.Errorf("unexpected difference: %s", diff)
+			}
+		})
+	}
+}

action/schema/float32_attribute.go

@@ -8,13 +8,16 @@ import (
 
 	"github.com/hashicorp/terraform-plugin-framework/attr"
 	"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
+	"github.com/hashicorp/terraform-plugin-framework/internal/fwschema/fwxschema"
+	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 	"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
 )
 
 // Ensure the implementation satisifies the desired interfaces.
 var (
-	_ Attribute = Float32Attribute{}
+	_ Attribute                                = Float32Attribute{}
+	_ fwxschema.AttributeWithFloat32Validators = Float32Attribute{}
 )
 
 // Float32Attribute represents a schema attribute that is a 32-bit floating
@@ -92,6 +95,18 @@ type Float32Attribute struct {
 	//  - https://github.com/hashicorp/terraform/issues/7569
 	//
 	DeprecationMessage string
+
+	// Validators define value validation functionality for the attribute. All
+	// elements of the slice of AttributeValidator are run, regardless of any
+	// previous error diagnostics.
+	//
+	// Many common use case validators can be found in the
+	// github.com/hashicorp/terraform-plugin-framework-validators Go module.
+	//
+	// If the Type field points to a custom type that implements the
+	// xattr.TypeWithValidate interface, the validators defined in this field
+	// are run in addition to the validation defined by the type.
+	Validators []validator.Float32
 }
 
 // ApplyTerraform5AttributePathStep always returns an error as it is not
@@ -170,3 +185,8 @@ func (a Float32Attribute) IsRequiredForImport() bool {
 func (a Float32Attribute) IsOptionalForImport() bool {
 	return false
 }
+
+// Float32Validators returns the Validators field value.
+func (a Float32Attribute) Float32Validators() []validator.Float32 {
+	return a.Validators
+}

action/schema/float32_attribute_test.go

@@ -16,6 +16,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
 	"github.com/hashicorp/terraform-plugin-framework/internal/testing/testschema"
 	"github.com/hashicorp/terraform-plugin-framework/internal/testing/testtypes"
+	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 )
 
@@ -435,3 +436,35 @@ func TestFloat32AttributeIsOptionalForImport(t *testing.T) {
 		})
 	}
 }
+
+func TestFloat32AttributeFloat32Validators(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		attribute schema.Float32Attribute
+		expected  []validator.Float32
+	}{
+		"no-validators": {
+			attribute: schema.Float32Attribute{},
+			expected:  nil,
+		},
+		"validators": {
+			attribute: schema.Float32Attribute{
+				Validators: []validator.Float32{},
+			},
+			expected: []validator.Float32{},
+		},
+	}
+
+	for name, testCase := range testCases {
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			got := testCase.attribute.Float32Validators()
+
+			if diff := cmp.Diff(got, testCase.expected); diff != "" {
+				t.Errorf("unexpected difference: %s", diff)
+			}
+		})
+	}
+}

action/schema/float64_attribute.go

@@ -8,13 +8,16 @@ import (
 
 	"github.com/hashicorp/terraform-plugin-framework/attr"
 	"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
+	"github.com/hashicorp/terraform-plugin-framework/internal/fwschema/fwxschema"
+	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 	"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
 )
 
 // Ensure the implementation satisifies the desired interfaces.
 var (
-	_ Attribute = Float64Attribute{}
+	_ Attribute                                = Float64Attribute{}
+	_ fwxschema.AttributeWithFloat64Validators = Float64Attribute{}
 )
 
 // Float64Attribute represents a schema attribute that is a 64-bit floating
@@ -92,6 +95,18 @@ type Float64Attribute struct {
 	//  - https://github.com/hashicorp/terraform/issues/7569
 	//
 	DeprecationMessage string
+
+	// Validators define value validation functionality for the attribute. All
+	// elements of the slice of AttributeValidator are run, regardless of any
+	// previous error diagnostics.
+	//
+	// Many common use case validators can be found in the
+	// github.com/hashicorp/terraform-plugin-framework-validators Go module.
+	//
+	// If the Type field points to a custom type that implements the
+	// xattr.TypeWithValidate interface, the validators defined in this field
+	// are run in addition to the validation defined by the type.
+	Validators []validator.Float64
 }
 
 // ApplyTerraform5AttributePathStep always returns an error as it is not
@@ -170,3 +185,8 @@ func (a Float64Attribute) IsRequiredForImport() bool {
 func (a Float64Attribute) IsOptionalForImport() bool {
 	return false
 }
+
+// Float64Validators returns the Validators field value.
+func (a Float64Attribute) Float64Validators() []validator.Float64 {
+	return a.Validators
+}