chore: validation error path merging with index/keys (#5652)

Signed-off-by: Mike Beaumont <mjboamail@gmail.com>

pkg/core/validators/types.go

@@ -54,34 +54,32 @@ func (v *ValidationError) AddViolation(field string, message string) {
 	v.Violations = append(v.Violations, violation)
 }
 
-func (v *ValidationError) Add(err ValidationError) {
-	v.AddError("", err)
-}
-
 func (v *ValidationError) AddErrorAt(path PathBuilder, validationErr ValidationError) {
-	v.AddError(path.String(), validationErr)
-}
-
-func (v *ValidationError) AddError(rootField string, validationErr ValidationError) {
-	rootPrefix := ""
-	if rootField != "" {
-		rootPrefix += fmt.Sprintf("%s.", rootField)
-	}
 	for _, violation := range validationErr.Violations {
-		field := ""
-		if violation.Field == "" {
-			field = rootField
-		} else {
-			field = fmt.Sprintf("%s%s", rootPrefix, violation.Field)
+		field := Root()
+		if violation.Field != "" {
+			field = RootedAt(violation.Field)
 		}
 		newViolation := Violation{
-			Field:   field,
+			Field:   path.concat(field).String(),
 			Message: violation.Message,
 		}
 		v.Violations = append(v.Violations, newViolation)
 	}
 }
 
+func (v *ValidationError) Add(err ValidationError) {
+	v.AddErrorAt(Root(), err)
+}
+
+func (v *ValidationError) AddError(rootField string, validationErr ValidationError) {
+	root := Root()
+	if rootField != "" {
+		root = RootedAt(rootField)
+	}
+	v.AddErrorAt(root, validationErr)
+}
+
 // Transform returns a new ValidationError with every violation
 // transformed by a given transformFunc.
 func (v *ValidationError) Transform(transformFunc func(Violation) Violation) *ValidationError {
@@ -124,6 +122,10 @@ func RootedAt(name string) PathBuilder {
 	return PathBuilder{name}
 }
 
+func Root() PathBuilder {
+	return PathBuilder{}
+}
+
 func (p PathBuilder) Field(name string) PathBuilder {
 	return append(p, fmt.Sprintf(".%s", name))
 }
@@ -139,3 +141,19 @@ func (p PathBuilder) Key(key string) PathBuilder {
 func (p PathBuilder) String() string {
 	return strings.Join(p, "")
 }
+
+func (p PathBuilder) concat(other PathBuilder) PathBuilder {
+	if len(other) == 0 {
+		return p
+	}
+	if len(p) == 0 {
+		return other
+	}
+
+	firstOther := other[0]
+	if !strings.HasPrefix(firstOther, "[") {
+		firstOther = "." + firstOther
+	}
+
+	return append(append(p, firstOther), other[1:]...)
+}

pkg/core/validators/types_test.go

@@ -99,6 +99,25 @@ var _ = Describe("Validation Error", func() {
 		})
 	})
 
+	Describe("AddErrorAt()", func() {
+		It("properly concatenates paths with index/keys", func() {
+			// given
+			path := validators.RootedAt("spec").Field("fields")
+			err := validators.ValidationError{}
+			subErr := validators.ValidationError{}
+			subErr.AddViolationAt(validators.Root().Index(2), "something bad")
+
+			// when
+			err.AddErrorAt(path, subErr)
+			// then
+			Expect(err).To(Equal(validators.ValidationError{
+				Violations: []validators.Violation{
+					{Field: "spec.fields[2]", Message: "something bad"},
+				},
+			}))
+		})
+	})
+
 	Describe("Transform()", func() {
 		type testCase struct {
 			input         *validators.ValidationError
@@ -174,7 +193,7 @@ var _ = Describe("Validation Error", func() {
 
 var _ = Describe("PathBuilder", func() {
 	It("should produce empty path by default", func() {
-		Expect(validators.PathBuilder{}.String()).To(Equal(""))
+		Expect(validators.Root().String()).To(Equal(""))
 	})
 
 	It("should produce valid root path", func() {