all: Included missing attribute path details in error diagnostics (#61)

Reference: #57
Reference: hashicorp/terraform#31575

Terraform output currently does not include the attribute path details if the attribute is not present in the configuration. This can make troubleshooting difficult for practitioners and provider developers.

Even if Terraform implements path details for unconfigured attributes, those details may not necessarily be clear for troubleshooting as they would likely be implemented in a very short, concise manner to reduce diagnostic message noise. Those details would also only be present on recent and future Terraform versions, while these validators support all versions of Terraform supported by the terraform-plugin-framework Go module, currently Terraform 0.12 and later.

Author: bflad

.changelog/61.txt

@@ -0,0 +1,3 @@
+```release-note:bug
+all: Included missing attribute path details in error diagnostics since they are currently not output by Terraform
+```

float64validator/type_validation.go

@@ -14,7 +14,7 @@ func validateFloat(ctx context.Context, request tfsdk.ValidateAttributeRequest,
 	if t != types.Float64Type {
 		response.Diagnostics.Append(validatordiag.InvalidAttributeTypeDiagnostic(
 			request.AttributePath,
-			"Expected value of type float64",
+			"expected value of type float64",
 			t.String(),
 		))
 		return 0.0, false

helpers/validatordiag/diag.go

@@ -1,6 +1,7 @@
 package validatordiag
 
 import (
+	"fmt"
 	"unicode"
 	"unicode/utf8"
 
@@ -13,7 +14,7 @@ func InvalidAttributeValueDiagnostic(path path.Path, description string, value s
 	return diag.NewAttributeErrorDiagnostic(
 		path,
 		"Invalid Attribute Value",
-		capitalize(description)+", got: "+value,
+		fmt.Sprintf("Attribute %s %s, got: %s", path, description, value),
 	)
 }
 
@@ -22,7 +23,7 @@ func InvalidAttributeValueLengthDiagnostic(path path.Path, description string, v
 	return diag.NewAttributeErrorDiagnostic(
 		path,
 		"Invalid Attribute Value Length",
-		capitalize(description)+", got: "+value,
+		fmt.Sprintf("Attribute %s %s, got: %s", path, description, value),
 	)
 }
 
@@ -31,7 +32,7 @@ func InvalidAttributeValueMatchDiagnostic(path path.Path, description string, va
 	return diag.NewAttributeErrorDiagnostic(
 		path,
 		"Invalid Attribute Value Match",
-		capitalize(description)+", got: "+value,
+		fmt.Sprintf("Attribute %s %s, got: %s", path, description, value),
 	)
 }
 
@@ -49,7 +50,7 @@ func InvalidAttributeTypeDiagnostic(path path.Path, description string, value st
 	return diag.NewAttributeErrorDiagnostic(
 		path,
 		"Invalid Attribute Type",
-		capitalize(description)+", got: "+value,
+		fmt.Sprintf("Attribute %s %s, got: %s", path, description, value),
 	)
 }
 

metavalidator/all_test.go

@@ -36,7 +36,7 @@ func TestAllValidator(t *testing.T) {
 				diag.NewAttributeErrorDiagnostic(
 					path.Root("test"),
 					"Invalid Attribute Type",
-					"Expected value of type string, got: types.Int64Type",
+					"Attribute test expected value of type string, got: types.Int64Type",
 				),
 			},
 		},
@@ -51,7 +51,7 @@ func TestAllValidator(t *testing.T) {
 				diag.NewAttributeErrorDiagnostic(
 					path.Root("test"),
 					"Invalid Attribute Value Length",
-					"String length must be at least 5, got: 3",
+					"Attribute test string length must be at least 5, got: 3",
 				),
 			},
 		},

metavalidator/any_test.go

@@ -36,7 +36,7 @@ func TestAnyValidator(t *testing.T) {
 				diag.NewAttributeErrorDiagnostic(
 					path.Root("test"),
 					"Invalid Attribute Type",
-					"Expected value of type string, got: types.Int64Type",
+					"Attribute test expected value of type string, got: types.Int64Type",
 				),
 			},
 		},
@@ -51,12 +51,12 @@ func TestAnyValidator(t *testing.T) {
 				diag.NewAttributeErrorDiagnostic(
 					path.Root("test"),
 					"Invalid Attribute Value Length",
-					"String length must be at least 4, got: 3",
+					"Attribute test string length must be at least 4, got: 3",
 				),
 				diag.NewAttributeErrorDiagnostic(
 					path.Root("test"),
 					"Invalid Attribute Value Length",
-					"String length must be at least 5, got: 3",
+					"Attribute test string length must be at least 5, got: 3",
 				),
 			},
 		},
@@ -80,12 +80,12 @@ func TestAnyValidator(t *testing.T) {
 				diag.NewAttributeErrorDiagnostic(
 					path.Root("test"),
 					"Invalid Attribute Value Length",
-					"String length must be at least 6, got: 3",
+					"Attribute test string length must be at least 6, got: 3",
 				),
 				diag.NewAttributeErrorDiagnostic(
 					path.Root("test"),
 					"Invalid Attribute Value Length",
-					"String length must be at least 5, got: 3",
+					"Attribute test string length must be at least 5, got: 3",
 				),
 			},
 		},

metavalidator/any_with_all_warnings_test.go

@@ -55,7 +55,7 @@ func TestAnyWithAllWarningsValidator(t *testing.T) {
 				diag.NewAttributeErrorDiagnostic(
 					path.Root("test"),
 					"Invalid Attribute Type",
-					"Expected value of type string, got: types.Int64Type",
+					"Attribute test expected value of type string, got: types.Int64Type",
 				),
 			},
 		},
@@ -70,12 +70,12 @@ func TestAnyWithAllWarningsValidator(t *testing.T) {
 				diag.NewAttributeErrorDiagnostic(
 					path.Root("test"),
 					"Invalid Attribute Value Length",
-					"String length must be at least 4, got: 3",
+					"Attribute test string length must be at least 4, got: 3",
 				),
 				diag.NewAttributeErrorDiagnostic(
 					path.Root("test"),
 					"Invalid Attribute Value Length",
-					"String length must be at least 5, got: 3",
+					"Attribute test string length must be at least 5, got: 3",
 				),
 			},
 		},
@@ -99,12 +99,12 @@ func TestAnyWithAllWarningsValidator(t *testing.T) {
 				diag.NewAttributeErrorDiagnostic(
 					path.Root("test"),
 					"Invalid Attribute Value Length",
-					"String length must be at least 6, got: 3",
+					"Attribute test string length must be at least 6, got: 3",
 				),
 				diag.NewAttributeErrorDiagnostic(
 					path.Root("test"),
 					"Invalid Attribute Value Length",
-					"String length must be at least 5, got: 3",
+					"Attribute test string length must be at least 5, got: 3",
 				),
 			},
 		},

stringvalidator/type_validation.go

@@ -14,7 +14,7 @@ func validateString(ctx context.Context, request tfsdk.ValidateAttributeRequest,
 	if t != types.StringType {
 		response.Diagnostics.Append(validatordiag.InvalidAttributeTypeDiagnostic(
 			request.AttributePath,
-			"Expected value of type string",
+			"expected value of type string",
 			t.String(),
 		))
 		return "", false