-
Notifications
You must be signed in to change notification settings - Fork 16
Implement workaround for cel-java import issue #302
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
166 changes: 166 additions & 0 deletions
166
src/test/java/build/buf/protovalidate/ValidatorImportTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,166 @@ | ||
| // Copyright 2023-2024 Buf Technologies, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package build.buf.protovalidate; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| import com.example.imports.validationtest.ExampleImportMessage; | ||
| import com.example.imports.validationtest.ExampleImportMessageFieldRule; | ||
| import com.example.imports.validationtest.ExampleImportMessageInMap; | ||
| import com.example.imports.validationtest.ExampleImportMessageInMapFieldRule; | ||
| import com.example.imports.validationtest.ExampleImportedMessage; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| public class ValidatorImportTest { | ||
| @Test | ||
| public void testImportedMessageFromAnotherFile() throws Exception { | ||
| com.example.imports.validationtest.ExampleImportMessage valid = | ||
| ExampleImportMessage.newBuilder() | ||
| .setImportedSubmessage( | ||
| ExampleImportedMessage.newBuilder().setHexString("0123456789abcdef").build()) | ||
| .build(); | ||
| assertThat( | ||
| ValidatorFactory.newBuilder() | ||
| .build() | ||
| .validate(valid) | ||
| .toProto() | ||
| .getViolationsList() | ||
| .size()) | ||
| .isEqualTo(0); | ||
|
|
||
| com.example.imports.validationtest.ExampleImportMessage invalid = | ||
| ExampleImportMessage.newBuilder() | ||
| .setImportedSubmessage(ExampleImportedMessage.newBuilder().setHexString("zyx").build()) | ||
| .build(); | ||
| assertThat( | ||
| ValidatorFactory.newBuilder() | ||
| .build() | ||
| .validate(invalid) | ||
| .toProto() | ||
| .getViolationsList() | ||
| .size()) | ||
| .isEqualTo(1); | ||
| } | ||
|
|
||
| @Test | ||
| public void testImportedMessageFromAnotherFileInField() throws Exception { | ||
| com.example.imports.validationtest.ExampleImportMessageFieldRule valid = | ||
| ExampleImportMessageFieldRule.newBuilder() | ||
| .setMessageWithImport( | ||
| ExampleImportMessage.newBuilder() | ||
| .setImportedSubmessage( | ||
| ExampleImportedMessage.newBuilder() | ||
| .setHexString("0123456789abcdef") | ||
| .build()) | ||
| .build()) | ||
| .build(); | ||
| assertThat( | ||
| ValidatorFactory.newBuilder() | ||
| .build() | ||
| .validate(valid) | ||
| .toProto() | ||
| .getViolationsList() | ||
| .size()) | ||
| .isEqualTo(0); | ||
|
|
||
| com.example.imports.validationtest.ExampleImportMessageFieldRule invalid = | ||
| ExampleImportMessageFieldRule.newBuilder() | ||
| .setMessageWithImport( | ||
| ExampleImportMessage.newBuilder() | ||
| .setImportedSubmessage( | ||
| ExampleImportedMessage.newBuilder().setHexString("zyx").build()) | ||
| .build()) | ||
| .build(); | ||
| assertThat( | ||
| ValidatorFactory.newBuilder() | ||
| .build() | ||
| .validate(invalid) | ||
| .toProto() | ||
| .getViolationsList() | ||
| .size()) | ||
| .isEqualTo(1); | ||
| } | ||
|
|
||
| @Test | ||
| public void testImportedMessageFromAnotherFileInMap() throws Exception { | ||
| com.example.imports.validationtest.ExampleImportMessageInMap valid = | ||
| ExampleImportMessageInMap.newBuilder() | ||
| .putImportedSubmessage( | ||
| 0, ExampleImportedMessage.newBuilder().setHexString("0123456789abcdef").build()) | ||
| .build(); | ||
| assertThat( | ||
| ValidatorFactory.newBuilder() | ||
| .build() | ||
| .validate(valid) | ||
| .toProto() | ||
| .getViolationsList() | ||
| .size()) | ||
| .isEqualTo(0); | ||
|
|
||
| com.example.imports.validationtest.ExampleImportMessageInMap invalid = | ||
| ExampleImportMessageInMap.newBuilder() | ||
| .putImportedSubmessage( | ||
| 0, ExampleImportedMessage.newBuilder().setHexString("zyx").build()) | ||
| .build(); | ||
| assertThat( | ||
| ValidatorFactory.newBuilder() | ||
| .build() | ||
| .validate(invalid) | ||
| .toProto() | ||
| .getViolationsList() | ||
| .size()) | ||
| .isEqualTo(1); | ||
| } | ||
|
|
||
| @Test | ||
| public void testImportedMessageFromAnotherFileInMapInField() throws Exception { | ||
| com.example.imports.validationtest.ExampleImportMessageInMapFieldRule valid = | ||
| ExampleImportMessageInMapFieldRule.newBuilder() | ||
| .setMessageWithImport( | ||
| ExampleImportMessageInMap.newBuilder() | ||
| .putImportedSubmessage( | ||
| 0, | ||
| ExampleImportedMessage.newBuilder() | ||
| .setHexString("0123456789abcdef") | ||
| .build()) | ||
| .build()) | ||
| .build(); | ||
| assertThat( | ||
| ValidatorFactory.newBuilder() | ||
| .build() | ||
| .validate(valid) | ||
| .toProto() | ||
| .getViolationsList() | ||
| .size()) | ||
| .isEqualTo(0); | ||
|
|
||
| com.example.imports.validationtest.ExampleImportMessageInMapFieldRule invalid = | ||
| ExampleImportMessageInMapFieldRule.newBuilder() | ||
| .setMessageWithImport( | ||
| ExampleImportMessageInMap.newBuilder() | ||
| .putImportedSubmessage( | ||
| 0, ExampleImportedMessage.newBuilder().setHexString("zyx").build()) | ||
| .build()) | ||
| .build(); | ||
| assertThat( | ||
| ValidatorFactory.newBuilder() | ||
| .build() | ||
| .validate(invalid) | ||
| .toProto() | ||
| .getViolationsList() | ||
| .size()) | ||
| .isEqualTo(1); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| // Copyright 2023-2024 Buf Technologies, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| syntax = "proto3"; | ||
|
|
||
| package validationtest; | ||
|
|
||
| import "buf/validate/validate.proto"; | ||
|
|
||
| message ExampleImportedMessage { | ||
| string hex_string = 1 [(buf.validate.field).string.pattern = "^[0-9a-fA-F]+$"]; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just for other readers: This includes edition delimited / proto2 group encoding, and excludes map entries.
See:
https://github.com/protocolbuffers/protobuf/blob/v31.1/java/core/src/main/java/com/google/protobuf/Descriptors.java#L1299
https://github.com/protocolbuffers/protobuf/blob/v31.1/java/core/src/main/java/com/google/protobuf/Descriptors.java#L1657
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmmm, now that you mention it though, I think I probably Do have to cover the map entry case. I'm not sure why I didn't do that last night, maybe I was yet again making the mistake of thinking it's fine since it's a message on the wire. (I keep doing that even though I know it doesn't look that way in the reflection API.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't care about the synthetic message for map entries, but we do care about the message M in
map<int32, M>.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, exactly. However, guess what? I just debugged this thoroughly and... this code actually does traverse the synthetic map entry and therefore the value message in maps. I don't really know why, but I'm going to just add the tests showing that it works (validated by stepping through to make sure it's really not working by accident) and just call it for now since this is a rather urgent fix. At least in Java protobuf, the map fields actually do have type MESSAGE.