Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add the ability to distinguish map key violations #55

Merged
merged 1 commit into from
Jul 20, 2023
Merged

Add the ability to distinguish map key violations #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions proto/protovalidate/buf/validate/expression.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,7 @@ message Violation {
// `message` is a human-readable error message that describes the nature of the violation.
// This can be the default error message from the violated `Constraint`, or it can be a custom message that gives more context about the violation.
string message = 3;

// `for_key` indicates whether the violation was caused by a map key, rather than a value.
bool for_key = 4;
}
51 changes: 31 additions & 20 deletions tools/internal/gen/buf/validate/expression.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions tools/protovalidate-conformance/internal/cases/cases_map.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ func mapSuite() suites.Suite {
FieldPath: "val[1]",
ConstraintId: "sint64.lt",
Message: "value must be less than 0",
ForKey: true,
},
),
},
Expand All @@ -148,6 +149,7 @@ func mapSuite() suites.Suite {
FieldPath: "val[\"!@#$%^&*()\"]",
ConstraintId: "string.pattern",
Message: "value does not match regex pattern `(?i)^[a-z0-9]+$`",
ForKey: true,
},
),
},
Expand Down
8 changes: 6 additions & 2 deletions tools/protovalidate-conformance/internal/results/result.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,11 @@ func (v violationsResult) String() string {
errs := v.inner.GetValidationError().GetViolations()
_, _ = fmt.Fprintf(bldr, "%d validation error(s)", len(errs))
for i, err := range errs {
_, _ = fmt.Fprintf(bldr, "\n%s %2d. %s: %s", resultPadding, i+1, err.FieldPath, err.ConstraintId)
forKey := ""
if err.ForKey {
forKey = " (key)"
}
_, _ = fmt.Fprintf(bldr, "\n%s %2d. %s%s: %s", resultPadding, i+1, err.FieldPath, forKey, err.ConstraintId)
_, _ = fmt.Fprintf(bldr, "\n%s %s", resultPadding, err.Message)
}
return bldr.String()
Expand All @@ -128,7 +132,7 @@ func (v violationsResult) IsSuccessWith(other Result, options *harness.ResultOpt
return false
}
for i := 0; i < len(want); i++ {
matchingField := want[i].FieldPath == got[i].FieldPath
matchingField := want[i].FieldPath == got[i].FieldPath && want[i].ForKey == got[i].ForKey
matchingConstraint := want[i].ConstraintId == got[i].ConstraintId
if !matchingField || !matchingConstraint {
return false
Expand Down