Adding OneOf() and NoneOf() validators, a pair for each type.

The underlying implementation sits in `primitivevalidator` package.

Author: Ivan De Marino

.changelog/42.txt

@@ -0,0 +1,19 @@
+```release-note:enhancement
+floatvalidator: 2 new validation functions, `OneOf()` and `NoneOf()`
+```
+
+```release-note:enhancement
+int64validator: 2 new validation functions, `OneOf()` and `NoneOf()`
+```
+
+```release-note:feature
+numbervalidator: New package that starts with 2 validation functions, `OneOf()` and `NoneOf()`
+```
+
+```release-note:enhancement
+stringvalidator: 2 new validation functions, `OneOf()` and `NoneOf()`, similar to the ones in `genericvalidator` but option to control case-sensitivity
+```
+
+```release-note:note
+Introduced a new package `primitivevalidator`, holding the shared code used by type-specific validators (ex. `OneOf()` and `NoneOf()`)
+```

float64validator/none_of.go

@@ -0,0 +1,19 @@
+package float64validator
+
+import (
+	"github.com/hashicorp/terraform-plugin-framework-validators/primitivevalidator"
+	"github.com/hashicorp/terraform-plugin-framework/attr"
+	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+)
+
+// NoneOf checks that the float64 held in the attribute
+// is none of the given `unacceptableFloats`.
+func NoneOf(unacceptableFloats ...float64) tfsdk.AttributeValidator {
+	unacceptableFloatValues := make([]attr.Value, 0, len(unacceptableFloats))
+	for _, f := range unacceptableFloats {
+		unacceptableFloatValues = append(unacceptableFloatValues, types.Float64{Value: f})
+	}
+
+	return primitivevalidator.NoneOf(unacceptableFloatValues...)
+}

float64validator/one_of.go

@@ -0,0 +1,19 @@
+package float64validator
+
+import (
+	"github.com/hashicorp/terraform-plugin-framework-validators/primitivevalidator"
+	"github.com/hashicorp/terraform-plugin-framework/attr"
+	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+)
+
+// OneOf checks that the float64 held in the attribute
+// is one of the given `acceptableFloats`.
+func OneOf(acceptableFloats ...float64) tfsdk.AttributeValidator {
+	acceptableFloatValues := make([]attr.Value, 0, len(acceptableFloats))
+	for _, f := range acceptableFloats {
+		acceptableFloatValues = append(acceptableFloatValues, types.Float64{Value: f})
+	}
+
+	return primitivevalidator.OneOf(acceptableFloatValues...)
+}

int64validator/none_of.go

@@ -0,0 +1,19 @@
+package int64validator
+
+import (
+	"github.com/hashicorp/terraform-plugin-framework-validators/primitivevalidator"
+	"github.com/hashicorp/terraform-plugin-framework/attr"
+	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+)
+
+// NoneOf checks that the int64 held in the attribute
+// is none of the given `unacceptableInts`.
+func NoneOf(unacceptableInts ...int64) tfsdk.AttributeValidator {
+	unacceptableIntValues := make([]attr.Value, 0, len(unacceptableInts))
+	for _, i := range unacceptableInts {
+		unacceptableIntValues = append(unacceptableIntValues, types.Int64{Value: i})
+	}
+
+	return primitivevalidator.NoneOf(unacceptableIntValues...)
+}

int64validator/one_of.go

@@ -0,0 +1,19 @@
+package int64validator
+
+import (
+	"github.com/hashicorp/terraform-plugin-framework-validators/primitivevalidator"
+	"github.com/hashicorp/terraform-plugin-framework/attr"
+	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+)
+
+// OneOf checks that the int64 held in the attribute
+// is one of the given `acceptableInts`.
+func OneOf(acceptableInts ...int64) tfsdk.AttributeValidator {
+	acceptableIntValues := make([]attr.Value, 0, len(acceptableInts))
+	for _, i := range acceptableInts {
+		acceptableIntValues = append(acceptableIntValues, types.Int64{Value: i})
+	}
+
+	return primitivevalidator.OneOf(acceptableIntValues...)
+}

numbervalidator/doc.go

@@ -0,0 +1,2 @@
+// Package numbervalidator provides validators for types.Number attributes.
+package numbervalidator

numbervalidator/none_of.go

@@ -0,0 +1,21 @@
+package numbervalidator
+
+import (
+	"math/big"
+
+	"github.com/hashicorp/terraform-plugin-framework-validators/primitivevalidator"
+	"github.com/hashicorp/terraform-plugin-framework/attr"
+	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+)
+
+// NoneOf checks that the *big.Float held in the attribute
+// is none of the given `unacceptableFloats`.
+func NoneOf(unacceptableFloats ...*big.Float) tfsdk.AttributeValidator {
+	unacceptableFloatValues := make([]attr.Value, 0, len(unacceptableFloats))
+	for _, f := range unacceptableFloats {
+		unacceptableFloatValues = append(unacceptableFloatValues, types.Number{Value: f})
+	}
+
+	return primitivevalidator.NoneOf(unacceptableFloatValues...)
+}

numbervalidator/one_of.go

@@ -0,0 +1,21 @@
+package numbervalidator
+
+import (
+	"math/big"
+
+	"github.com/hashicorp/terraform-plugin-framework-validators/primitivevalidator"
+	"github.com/hashicorp/terraform-plugin-framework/attr"
+	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+)
+
+// OneOf checks that the *big.Float held in the attribute
+// is one of the given `acceptableFloats`.
+func OneOf(acceptableFloats ...*big.Float) tfsdk.AttributeValidator {
+	acceptableFloatValues := make([]attr.Value, 0, len(acceptableFloats))
+	for _, f := range acceptableFloats {
+		acceptableFloatValues = append(acceptableFloatValues, types.Number{Value: f})
+	}
+
+	return primitivevalidator.OneOf(acceptableFloatValues...)
+}

primitivevalidator/acceptable_values_validator.go

@@ -0,0 +1,70 @@
+package primitivevalidator
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/hashicorp/terraform-plugin-framework-validators/helpers/validatordiag"
+	"github.com/hashicorp/terraform-plugin-framework/attr"
+	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+)
+
+// acceptablePrimitiveValuesAttributeValidator is the underlying struct implementing OneOf and NoneOf.
+type acceptablePrimitiveValuesAttributeValidator struct {
+	acceptableValues []attr.Value
+	shouldMatch      bool
+}
+
+var _ tfsdk.AttributeValidator = (*acceptablePrimitiveValuesAttributeValidator)(nil)
+
+func (av *acceptablePrimitiveValuesAttributeValidator) Description(ctx context.Context) string {
+	return av.MarkdownDescription(ctx)
+}
+
+func (av *acceptablePrimitiveValuesAttributeValidator) MarkdownDescription(_ context.Context) string {
+	if av.shouldMatch {
+		return fmt.Sprintf("Value must be one of: %q", av.acceptableValues)
+	} else {
+		return fmt.Sprintf("Value must be none of: %q", av.acceptableValues)
+	}
+
+}
+
+func (av *acceptablePrimitiveValuesAttributeValidator) Validate(ctx context.Context, req tfsdk.ValidateAttributeRequest, res *tfsdk.ValidateAttributeResponse) {
+	if req.AttributeConfig.IsNull() || req.AttributeConfig.IsUnknown() {
+		return
+	}
+
+	var value attr.Value
+	switch typedAttributeConfig := req.AttributeConfig.(type) {
+	case types.String, types.Bool, types.Int64, types.Float64, types.Number:
+		value = typedAttributeConfig
+	default:
+		res.Diagnostics.AddAttributeError(
+			req.AttributePath,
+			"This validator should be used against primitive types (String, Bool, Number, Int64, Float64).",
+			"This is always indicative of a bug within the provider.",
+		)
+		return
+	}
+
+	if av.shouldMatch && !av.isAcceptableValue(value) || //< EITHER should match but it does not
+		!av.shouldMatch && av.isAcceptableValue(value) { //< OR should not match but it does
+		res.Diagnostics.Append(validatordiag.InvalidValueMatchDiagnostic(
+			req.AttributePath,
+			av.Description(ctx),
+			value.String(),
+		))
+	}
+}
+
+func (av *acceptablePrimitiveValuesAttributeValidator) isAcceptableValue(v attr.Value) bool {
+	for _, acceptableV := range av.acceptableValues {
+		if v.Equal(acceptableV) {
+			return true
+		}
+	}
+
+	return false
+}

primitivevalidator/doc.go

@@ -0,0 +1,4 @@
+// Package primitivevalidator provides validators for attributes
+// of "primitive" type (i.e. `types.String`, `types.Number`, `types.Int64`,
+// `types.Float64` and `types.Bool`).
+package primitivevalidator

primitivevalidator/none_of.go

@@ -0,0 +1,19 @@
+package primitivevalidator
+
+import (
+	"github.com/hashicorp/terraform-plugin-framework/attr"
+	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
+)
+
+// NoneOf checks that the value held in the attribute
+// is none of the given `unacceptableValues`.
+//
+// This validator can be used only against primitives like
+// `types.String`, `types.Number`, `types.Int64`,
+// `types.Float64` and `types.Bool`.
+func NoneOf(unacceptableValues ...attr.Value) tfsdk.AttributeValidator {
+	return &acceptablePrimitiveValuesAttributeValidator{
+		acceptableValues: unacceptableValues,
+		shouldMatch:      false,
+	}
+}