Add the attribute from the request to at-least-one validator's error message

.changes/unreleased/BUG FIXES-20240306-234246.yaml

@@ -0,0 +1,5 @@
+kind: BUG FIXES
+body: Add the attribute from the request to the at-least-one validator's error message
+time: 2024-03-06T23:42:46.773751412-05:00
+custom:
+  Issue: "199"

internal/schemavalidator/at_least_one_of.go

@@ -91,6 +91,10 @@ func (av AtLeastOneOfValidator) Validate(ctx context.Context, req AtLeastOneOfVa
 		}
 	}
 
+	// This attribute is among those required attributes,
+	// append it to make it appears in the error message.
+	expressions.Append(req.PathExpression)
+
 	res.Diagnostics.Append(validatordiag.InvalidAttributeCombinationDiagnostic(
 		req.Path,
 		fmt.Sprintf("At least one attribute out of %s must be specified", expressions),

internal/schemavalidator/at_least_one_of_test.go

@@ -5,8 +5,10 @@ package schemavalidator_test
 
 import (
 	"context"
+	"strings"
 	"testing"
 
+	"github.com/hashicorp/terraform-plugin-framework/diag"
 	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
@@ -20,9 +22,10 @@ func TestAtLeastOneOfValidatorValidate(t *testing.T) {
 	t.Parallel()
 
 	type testCase struct {
-		req       schemavalidator.AtLeastOneOfValidatorRequest
-		in        path.Expressions
-		expErrors int
+		req             schemavalidator.AtLeastOneOfValidatorRequest
+		in              path.Expressions
+		expErrors       int
+		expDiagsMsgSegs []string
 	}
 
 	testCases := map[string]testCase{
@@ -112,6 +115,38 @@ func TestAtLeastOneOfValidatorValidate(t *testing.T) {
 			},
 			expErrors: 1,
 		},
+		"both-attrs-in-diag-msg": {
+			req: schemavalidator.AtLeastOneOfValidatorRequest{
+				ConfigValue:    types.NumberNull(),
+				Path:           path.Root("bar"),
+				PathExpression: path.MatchRoot("bar"),
+				Config: tfsdk.Config{
+					Schema: schema.Schema{
+						Attributes: map[string]schema.Attribute{
+							"foo": schema.Int64Attribute{},
+							"bar": schema.Int64Attribute{},
+						},
+					},
+					Raw: tftypes.NewValue(
+						tftypes.Object{
+							AttributeTypes: map[string]tftypes.Type{
+								"foo": tftypes.Number,
+								"bar": tftypes.Number,
+							},
+						},
+						map[string]tftypes.Value{
+							"foo": tftypes.NewValue(tftypes.Number, nil),
+							"bar": tftypes.NewValue(tftypes.Number, nil),
+						},
+					),
+				},
+			},
+			in: path.Expressions{
+				path.MatchRoot("foo"),
+			},
+			expErrors:       1,
+			expDiagsMsgSegs: []string{"foo", "bar"},
+		},
 		"multiple-set": {
 			req: schemavalidator.AtLeastOneOfValidatorRequest{
 				ConfigValue:    types.StringValue("bar value"),
@@ -236,6 +271,22 @@ func TestAtLeastOneOfValidatorValidate(t *testing.T) {
 		},
 	}
 
+	checkDiagsForExpectedMessageSegments := func(diags diag.Diagnostics, segs []string) {
+		for _, seg := range segs {
+			found := false
+			for _, diag := range diags {
+				if strings.Contains(diag.Summary(), seg) || strings.Contains(diag.Detail(), seg) {
+					found = true
+					break
+				}
+			}
+
+			if !found {
+				t.Fatalf("expected diagnostic message to contain %q, got none", seg)
+			}
+		}
+	}
+
 	for name, test := range testCases {
 		name, test := name, test
 		t.Run(name, func(t *testing.T) {
@@ -254,6 +305,10 @@ func TestAtLeastOneOfValidatorValidate(t *testing.T) {
 				t.Fatalf("expected %d error(s), got %d: %v", test.expErrors, res.Diagnostics.ErrorsCount(), res.Diagnostics)
 			}
 
+			if len(test.expDiagsMsgSegs) > 0 {
+				checkDiagsForExpectedMessageSegments(res.Diagnostics, test.expDiagsMsgSegs)
+			}
+
 			if test.expErrors == 0 && res.Diagnostics.HasError() {
 				t.Fatalf("expected no error(s), got %d: %v", res.Diagnostics.ErrorsCount(), res.Diagnostics)
 			}