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

Update (buf.validate.oneof).required semantics #123

Closed
wants to merge 1 commit into from
Closed

Update (buf.validate.oneof).required semantics #123

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
2 changes: 2 additions & 0 deletions proto/protovalidate-testing/buf/validate/conformance/cases/oneofs.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ syntax = "proto3";
package buf.validate.conformance.cases;

import "buf/validate/validate.proto";
import "google/protobuf/duration.proto";

message TestOneofMsg {
bool val = 1 [(buf.validate.field).bool.const = true];
Expand Down Expand Up @@ -45,6 +46,7 @@ message OneofRequired {
int32 y = 2;
int32 name_with_underscores = 3;
int32 under_and_1_number = 4;
google.protobuf.Duration duration = 5;
}
}

Expand Down
8 changes: 4 additions & 4 deletions proto/protovalidate/buf/validate/validate.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,12 @@ message MessageConstraints {

// The `OneofConstraints` message type enables you to manage constraints for
// oneof fields in your protobuf messages. Use the `required` constraint to ensure
// that exactly one of the fields within a oneof is set; validation will fail
// if none of the fields in the oneof are set:
// that exactly one of the fields within a oneof is not empty; validation will fail
// if all of the fields in the oneof are empty:
message OneofConstraints {
// `required` is an optional boolean attribute that ensures that
// exactly one of the field options in a oneof is set; validation fails if
// no fields in the oneof are set.
// exactly one of the field options in a oneof is not empty; validation fails if
// all fields in the oneof are empty.
//
// ```proto
// message MyMessage {
Expand Down
104 changes: 64 additions & 40 deletions tools/internal/gen/buf/validate/conformance/cases/oneofs.pb.go
View file
Open in desktop

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

8 changes: 4 additions & 4 deletions tools/internal/gen/buf/validate/validate.pb.go
View file
Open in desktop

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

15 changes: 14 additions & 1 deletion tools/protovalidate-conformance/internal/cases/cases_oneof.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import (
"github.com/bufbuild/protovalidate/tools/internal/gen/buf/validate/conformance/cases"
"github.com/bufbuild/protovalidate/tools/protovalidate-conformance/internal/results"
"github.com/bufbuild/protovalidate/tools/protovalidate-conformance/internal/suites"
"google.golang.org/protobuf/types/known/durationpb"
)

func oneofSuite() suites.Suite {
Expand Down Expand Up @@ -59,10 +60,22 @@ func oneofSuite() suites.Suite {
Message: &cases.Oneof{O: &cases.Oneof_Z{Z: &cases.TestOneofMsg{}}},
Expected: results.Violations(&validate.Violation{FieldPath: "z.val", ConstraintId: "bool.const"}),
},
"required/valid": {
"required/valid_scalar": {
Message: &cases.OneofRequired{O: &cases.OneofRequired_X{X: "foo"}},
Expected: results.Success(true),
},
"required/empty_scalar": {
Message: &cases.OneofRequired{O: &cases.OneofRequired_X{X: ""}},
Expected: results.Violations(&validate.Violation{FieldPath: "o", ConstraintId: "required"}),
},
"required/valid_message": {
Message: &cases.OneofRequired{O: &cases.OneofRequired_Duration{Duration: &durationpb.Duration{}}},
Expected: results.Success(true),
},
"required/empty_message": {
Message: &cases.OneofRequired{O: &cases.OneofRequired_Duration{Duration: nil}},
Expected: results.Violations(&validate.Violation{FieldPath: "o", ConstraintId: "required"}),
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should fail (buf.validate.oneof).required. There is no parallel in a regular (non-oneof) field. Setting Duration to nil here seems like an invalid state, but we still need some behavior from protovalidate.

},
"required/invalid": {
Message: &cases.OneofRequired{},
Expected: results.Violations(&validate.Violation{FieldPath: "o", ConstraintId: "required"}),
Expand Down