PR review

Ivan De Marino · Ivan De Marino · commit df13514b22c2 · 2022-06-23T11:56:49.000+01:00
diff --git a/.changelog/42.txt b/.changelog/42.txt
@@ -11,5 +11,5 @@ numbervalidator: New package that starts with 2 validation functions, `OneOf()`
 ```
 
 ```release-note:enhancement
-stringvalidator: 2 new validation functions, `OneOf()` and `NoneOf()`, similar to the ones in `genericvalidator` but option to control case-sensitivity
+stringvalidator: 2 new validation functions, `OneOf()` and `NoneOf()`, that offer case-sensitivity control
 ```
diff --git a/float64validator/at_least.go b/float64validator/at_least.go
@@ -34,7 +34,7 @@ func (validator atLeastValidator) Validate(ctx context.Context, request tfsdk.Va
 	}
 
 	if f < validator.min {
-		response.Diagnostics.Append(validatordiag.InvalidValueDiagnostic(
+		response.Diagnostics.Append(validatordiag.InvalidAttributeValueDiagnostic(
 			request.AttributePath,
 			validator.Description(ctx),
 			fmt.Sprintf("%f", f),
diff --git a/float64validator/at_most.go b/float64validator/at_most.go
@@ -34,7 +34,7 @@ func (validator atMostValidator) Validate(ctx context.Context, request tfsdk.Val
 	}
 
 	if f > validator.max {
-		response.Diagnostics.Append(validatordiag.InvalidValueDiagnostic(
+		response.Diagnostics.Append(validatordiag.InvalidAttributeValueDiagnostic(
 			request.AttributePath,
 			validator.Description(ctx),
 			fmt.Sprintf("%f", f),
diff --git a/float64validator/between.go b/float64validator/between.go
@@ -34,7 +34,7 @@ func (validator betweenValidator) Validate(ctx context.Context, request tfsdk.Va
 	}
 
 	if f < validator.min || f > validator.max {
-		response.Diagnostics.Append(validatordiag.InvalidValueDiagnostic(
+		response.Diagnostics.Append(validatordiag.InvalidAttributeValueDiagnostic(
 			request.AttributePath,
 			validator.Description(ctx),
 			fmt.Sprintf("%f", f),
diff --git a/float64validator/type_validation.go b/float64validator/type_validation.go
@@ -12,7 +12,7 @@ import (
 func validateFloat(ctx context.Context, request tfsdk.ValidateAttributeRequest, response *tfsdk.ValidateAttributeResponse) (float64, bool) {
 	t := request.AttributeConfig.Type(ctx)
 	if t != types.Float64Type {
-		response.Diagnostics.Append(validatordiag.InvalidTypeDiagnostic(
+		response.Diagnostics.Append(validatordiag.InvalidAttributeTypeDiagnostic(
 			request.AttributePath,
 			"Expected value of type float64",
 			t.String(),
diff --git a/helpers/validatordiag/diag.go b/helpers/validatordiag/diag.go
@@ -8,44 +8,44 @@ import (
 	"github.com/hashicorp/terraform-plugin-go/tftypes"
 )
 
-// InvalidValueDiagnostic returns an error Diagnostic to be used when an attribute has an invalid value.
-func InvalidValueDiagnostic(path *tftypes.AttributePath, description string, value string) diag.Diagnostic {
+// InvalidAttributeValueDiagnostic returns an error Diagnostic to be used when an attribute has an invalid value.
+func InvalidAttributeValueDiagnostic(path *tftypes.AttributePath, description string, value string) diag.Diagnostic {
 	return diag.NewAttributeErrorDiagnostic(
 		path,
 		"Invalid Attribute Value",
 		capitalize(description)+", got: "+value,
 	)
 }
 
-// InvalidValueLengthDiagnostic returns an error Diagnostic to be used when an attribute's value has an invalid length.
-func InvalidValueLengthDiagnostic(path *tftypes.AttributePath, description string, value string) diag.Diagnostic {
+// InvalidAttributeValueLengthDiagnostic returns an error Diagnostic to be used when an attribute's value has an invalid length.
+func InvalidAttributeValueLengthDiagnostic(path *tftypes.AttributePath, description string, value string) diag.Diagnostic {
 	return diag.NewAttributeErrorDiagnostic(
 		path,
 		"Invalid Attribute Value Length",
 		capitalize(description)+", got: "+value,
 	)
 }
 
-// InvalidValueMatchDiagnostic returns an error Diagnostic to be used when an attribute's value has an invalid match.
-func InvalidValueMatchDiagnostic(path *tftypes.AttributePath, description string, value string) diag.Diagnostic {
+// InvalidAttributeValueMatchDiagnostic returns an error Diagnostic to be used when an attribute's value has an invalid match.
+func InvalidAttributeValueMatchDiagnostic(path *tftypes.AttributePath, description string, value string) diag.Diagnostic {
 	return diag.NewAttributeErrorDiagnostic(
 		path,
 		"Invalid Attribute Value Match",
 		capitalize(description)+", got: "+value,
 	)
 }
 
-// InvalidSchemaDiagnostic returns an error Diagnostic to be used when a schemavalidator of attributes is invalid.
-func InvalidSchemaDiagnostic(path *tftypes.AttributePath, description string) diag.Diagnostic {
+// InvalidAttributeSchemaDiagnostic returns an error Diagnostic to be used when a schemavalidator of attributes is invalid.
+func InvalidAttributeSchemaDiagnostic(path *tftypes.AttributePath, description string) diag.Diagnostic {
 	return diag.NewAttributeErrorDiagnostic(
 		path,
 		"Invalid Attribute Combination",
 		capitalize(description),
 	)
 }
 
-// InvalidTypeDiagnostic returns an error Diagnostic to be used when an attribute has an invalid type.
-func InvalidTypeDiagnostic(path *tftypes.AttributePath, description string, value string) diag.Diagnostic {
+// InvalidAttributeTypeDiagnostic returns an error Diagnostic to be used when an attribute has an invalid type.
+func InvalidAttributeTypeDiagnostic(path *tftypes.AttributePath, description string, value string) diag.Diagnostic {
 	return diag.NewAttributeErrorDiagnostic(
 		path,
 		"Invalid Attribute Type",
diff --git a/int64validator/at_least.go b/int64validator/at_least.go
@@ -34,7 +34,7 @@ func (validator atLeastValidator) Validate(ctx context.Context, request tfsdk.Va
 	}
 
 	if i < validator.min {
-		response.Diagnostics.Append(validatordiag.InvalidValueDiagnostic(
+		response.Diagnostics.Append(validatordiag.InvalidAttributeValueDiagnostic(
 			request.AttributePath,
 			validator.Description(ctx),
 			fmt.Sprintf("%d", i),
diff --git a/int64validator/at_most.go b/int64validator/at_most.go
@@ -34,7 +34,7 @@ func (validator atMostValidator) Validate(ctx context.Context, request tfsdk.Val
 	}
 
 	if i > validator.max {
-		response.Diagnostics.Append(validatordiag.InvalidValueDiagnostic(
+		response.Diagnostics.Append(validatordiag.InvalidAttributeValueDiagnostic(
 			request.AttributePath,
 			validator.Description(ctx),
 			fmt.Sprintf("%d", i),
diff --git a/int64validator/between.go b/int64validator/between.go
@@ -34,7 +34,7 @@ func (validator betweenValidator) Validate(ctx context.Context, request tfsdk.Va
 	}
 
 	if i < validator.min || i > validator.max {
-		response.Diagnostics.Append(validatordiag.InvalidValueDiagnostic(
+		response.Diagnostics.Append(validatordiag.InvalidAttributeValueDiagnostic(
 			request.AttributePath,
 			validator.Description(ctx),
 			fmt.Sprintf("%d", i),
diff --git a/int64validator/type_validation.go b/int64validator/type_validation.go
@@ -12,7 +12,7 @@ import (
 func validateInt(ctx context.Context, request tfsdk.ValidateAttributeRequest, response *tfsdk.ValidateAttributeResponse) (int64, bool) {
 	t := request.AttributeConfig.Type(ctx)
 	if t != types.Int64Type {
-		response.Diagnostics.Append(validatordiag.InvalidTypeDiagnostic(
+		response.Diagnostics.Append(validatordiag.InvalidAttributeTypeDiagnostic(
 			request.AttributePath,
 			"Expected value of type int64",
 			t.String(),
diff --git a/internal/primitivevalidator/acceptable_values_validator.go b/internal/primitivevalidator/acceptable_values_validator.go
@@ -51,7 +51,7 @@ func (av *acceptablePrimitiveValuesAttributeValidator) Validate(ctx context.Cont
 
 	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(
+		res.Diagnostics.Append(validatordiag.InvalidAttributeValueMatchDiagnostic(
 			req.AttributePath,
 			av.Description(ctx),
 			value.String(),
diff --git a/internal/primitivevalidator/none_of_test.go b/internal/primitivevalidator/none_of_test.go
@@ -50,6 +50,7 @@ func TestNoneOfValidator(t *testing.T) {
 				types.String{Value: "bar"},
 				types.String{Value: "baz"},
 			),
+			expErrors: 0,
 		},
 		"mixed": {
 			in: types.Float64{Value: 1.234},
@@ -154,6 +155,7 @@ func TestNoneOfValidator(t *testing.T) {
 				types.String{Value: "bar"},
 				types.String{Value: "baz"},
 			),
+			expErrors: 0,
 		},
 		"skip-validation-on-unknown": {
 			in: types.String{Unknown: true},
@@ -162,6 +164,7 @@ func TestNoneOfValidator(t *testing.T) {
 				types.String{Value: "bar"},
 				types.String{Value: "baz"},
 			),
+			expErrors: 0,
 		},
 	}
 
diff --git a/internal/primitivevalidator/one_of_test.go b/internal/primitivevalidator/one_of_test.go
@@ -41,6 +41,7 @@ func TestOneOfValidator(t *testing.T) {
 				types.String{Value: "bar"},
 				types.String{Value: "baz"},
 			),
+			expErrors: 0,
 		},
 		"simple-mismatch": {
 			in: types.String{Value: "foz"},
@@ -58,6 +59,7 @@ func TestOneOfValidator(t *testing.T) {
 				types.Int64{Value: 567},
 				types.Float64{Value: 1.234},
 			),
+			expErrors: 0,
 		},
 		"list-not-allowed": {
 			in: types.List{
@@ -153,6 +155,7 @@ func TestOneOfValidator(t *testing.T) {
 				types.String{Value: "bar"},
 				types.String{Value: "baz"},
 			),
+			expErrors: 0,
 		},
 		"skip-validation-on-unknown": {
 			in: types.String{Unknown: true},
@@ -161,6 +164,7 @@ func TestOneOfValidator(t *testing.T) {
 				types.String{Value: "bar"},
 				types.String{Value: "baz"},
 			),
+			expErrors: 0,
 		},
 	}
 
diff --git a/stringvalidator/acceptable_strings_validator.go b/stringvalidator/acceptable_strings_validator.go
@@ -38,7 +38,7 @@ func (av *acceptableStringsAttributeValidator) Validate(ctx context.Context, req
 
 	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(
+		res.Diagnostics.Append(validatordiag.InvalidAttributeValueMatchDiagnostic(
 			req.AttributePath,
 			av.Description(ctx),
 			value,
diff --git a/stringvalidator/length_at_least.go b/stringvalidator/length_at_least.go
@@ -34,7 +34,7 @@ func (validator lengthAtLeastValidator) Validate(ctx context.Context, request tf
 	}
 
 	if l := len(s); l < validator.minLength {
-		response.Diagnostics.Append(validatordiag.InvalidValueLengthDiagnostic(
+		response.Diagnostics.Append(validatordiag.InvalidAttributeValueLengthDiagnostic(
 			request.AttributePath,
 			validator.Description(ctx),
 			fmt.Sprintf("%d", l),
diff --git a/stringvalidator/length_at_most.go b/stringvalidator/length_at_most.go
@@ -34,7 +34,7 @@ func (validator lengthAtMostValidator) Validate(ctx context.Context, request tfs
 	}
 
 	if l := len(s); l > validator.maxLength {
-		response.Diagnostics.Append(validatordiag.InvalidValueLengthDiagnostic(
+		response.Diagnostics.Append(validatordiag.InvalidAttributeValueLengthDiagnostic(
 			request.AttributePath,
 			validator.Description(ctx),
 			fmt.Sprintf("%d", l),
diff --git a/stringvalidator/length_between.go b/stringvalidator/length_between.go
@@ -34,7 +34,7 @@ func (validator lengthBetweenValidator) Validate(ctx context.Context, request tf
 	}
 
 	if l := len(s); l < validator.minLength || l > validator.maxLength {
-		response.Diagnostics.Append(validatordiag.InvalidValueLengthDiagnostic(
+		response.Diagnostics.Append(validatordiag.InvalidAttributeValueLengthDiagnostic(
 			request.AttributePath,
 			validator.Description(ctx),
 			fmt.Sprintf("%d", l),
diff --git a/stringvalidator/none_of_test.go b/stringvalidator/none_of_test.go
@@ -55,6 +55,7 @@ func TestNoneOfValidator(t *testing.T) {
 				"bar",
 				"baz",
 			),
+			expErrors: 0,
 		},
 		"list-not-allowed": {
 			in: types.List{
@@ -140,6 +141,7 @@ func TestNoneOfValidator(t *testing.T) {
 				"bar",
 				"baz",
 			),
+			expErrors: 0,
 		},
 		"skip-validation-on-unknown": {
 			in: types.String{Unknown: true},
@@ -149,6 +151,7 @@ func TestNoneOfValidator(t *testing.T) {
 				"bar",
 				"baz",
 			),
+			expErrors: 0,
 		},
 	}
 
diff --git a/stringvalidator/one_of_test.go b/stringvalidator/one_of_test.go
@@ -35,6 +35,7 @@ func TestOneOfValidator(t *testing.T) {
 				"bar",
 				"baz",
 			),
+			expErrors: 0,
 		},
 		"simple-match-case-insensitive": {
 			in: types.String{Value: "foo"},
@@ -44,6 +45,7 @@ func TestOneOfValidator(t *testing.T) {
 				"bar",
 				"baz",
 			),
+			expErrors: 0,
 		},
 		"simple-mismatch": {
 			in: types.String{Value: "foz"},
@@ -139,6 +141,7 @@ func TestOneOfValidator(t *testing.T) {
 				"bar",
 				"baz",
 			),
+			expErrors: 0,
 		},
 		"skip-validation-on-unknown": {
 			in: types.String{Unknown: true},
@@ -148,6 +151,7 @@ func TestOneOfValidator(t *testing.T) {
 				"bar",
 				"baz",
 			),
+			expErrors: 0,
 		},
 	}
 
diff --git a/stringvalidator/regex_matches.go b/stringvalidator/regex_matches.go
@@ -39,7 +39,7 @@ func (validator regexMatchesValidator) Validate(ctx context.Context, request tfs
 	}
 
 	if ok := validator.regexp.MatchString(s); !ok {
-		response.Diagnostics.Append(validatordiag.InvalidValueMatchDiagnostic(
+		response.Diagnostics.Append(validatordiag.InvalidAttributeValueMatchDiagnostic(
 			request.AttributePath,
 			validator.Description(ctx),
 			s,
diff --git a/stringvalidator/type_validation.go b/stringvalidator/type_validation.go
@@ -12,7 +12,7 @@ import (
 func validateString(ctx context.Context, request tfsdk.ValidateAttributeRequest, response *tfsdk.ValidateAttributeResponse) (string, bool) {
 	t := request.AttributeConfig.Type(ctx)
 	if t != types.StringType {
-		response.Diagnostics.Append(validatordiag.InvalidTypeDiagnostic(
+		response.Diagnostics.Append(validatordiag.InvalidAttributeTypeDiagnostic(
 			request.AttributePath,
 			"Expected value of type string",
 			t.String(),

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ func (validator atLeastValidator) Validate(ctx context.Context, request tfsdk.Va`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`if f < validator.min {`
`37`		`- response.Diagnostics.Append(validatordiag.InvalidValueDiagnostic(`
	`37`	`+ response.Diagnostics.Append(validatordiag.InvalidAttributeValueDiagnostic(`
`38`	`38`	`request.AttributePath,`
`39`	`39`	`validator.Description(ctx),`
`40`	`40`	`fmt.Sprintf("%f", f),`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ func (validator atMostValidator) Validate(ctx context.Context, request tfsdk.Val`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`if f > validator.max {`
`37`		`- response.Diagnostics.Append(validatordiag.InvalidValueDiagnostic(`
	`37`	`+ response.Diagnostics.Append(validatordiag.InvalidAttributeValueDiagnostic(`
`38`	`38`	`request.AttributePath,`
`39`	`39`	`validator.Description(ctx),`
`40`	`40`	`fmt.Sprintf("%f", f),`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ func (validator betweenValidator) Validate(ctx context.Context, request tfsdk.Va`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`if f < validator.min \|\| f > validator.max {`
`37`		`- response.Diagnostics.Append(validatordiag.InvalidValueDiagnostic(`
	`37`	`+ response.Diagnostics.Append(validatordiag.InvalidAttributeValueDiagnostic(`
`38`	`38`	`request.AttributePath,`
`39`	`39`	`validator.Description(ctx),`
`40`	`40`	`fmt.Sprintf("%f", f),`