-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[ggj][codegen] feat: add HTTP annotation parsing/validation (#401)
* fix: refactor requestBuilder into separate method in ServiceClientClassComposer * feat: add varargs to AnonClass and ref setter methods * feat: add HTTP annotation parsing/validation
- Loading branch information
Showing
6 changed files
with
226 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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 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
129 changes: 129 additions & 0 deletions
129
src/main/java/com/google/api/generator/gapic/protoparser/HttpRuleParser.java
This file contains 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,129 @@ | ||
| // Copyright 2020 Google LLC | ||
| // | ||
| // 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 com.google.api.generator.gapic.protoparser; | ||
|
|
||
| import com.google.api.AnnotationsProto; | ||
| import com.google.api.HttpRule; | ||
| import com.google.api.HttpRule.PatternCase; | ||
| import com.google.api.generator.gapic.model.Field; | ||
| import com.google.api.generator.gapic.model.Message; | ||
| import com.google.api.pathtemplate.PathTemplate; | ||
| import com.google.common.base.Preconditions; | ||
| import com.google.common.base.Strings; | ||
| import com.google.protobuf.DescriptorProtos.MethodOptions; | ||
| import com.google.protobuf.Descriptors.MethodDescriptor; | ||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Optional; | ||
|
|
||
| public class HttpRuleParser { | ||
| private static final String ASTERISK = "*"; | ||
|
|
||
| public static Optional<List<String>> parseHttpBindings( | ||
| MethodDescriptor protoMethod, Message inputMessage, Map<String, Message> messageTypes) { | ||
| MethodOptions methodOptions = protoMethod.getOptions(); | ||
| if (!methodOptions.hasExtension(AnnotationsProto.http)) { | ||
| return Optional.empty(); | ||
| } | ||
|
|
||
| HttpRule httpRule = methodOptions.getExtension(AnnotationsProto.http); | ||
|
|
||
| // Body validation. | ||
| if (!Strings.isNullOrEmpty(httpRule.getBody()) && !httpRule.getBody().equals(ASTERISK)) { | ||
| checkHttpFieldIsValid(httpRule.getBody(), inputMessage, true); | ||
| } | ||
|
|
||
| // Get pattern. | ||
| List<String> bindings = getPatternBindings(httpRule); | ||
| if (bindings.isEmpty()) { | ||
| return Optional.empty(); | ||
| } | ||
|
|
||
| // Binding validation. | ||
| for (String binding : bindings) { | ||
| // Handle foo.bar cases by descending into the subfields. | ||
| String[] descendantBindings = binding.split("\\."); | ||
| Message containingMessage = inputMessage; | ||
| for (int i = 0; i < descendantBindings.length; i++) { | ||
| String subField = descendantBindings[i]; | ||
| if (i < descendantBindings.length - 1) { | ||
| Field field = containingMessage.fieldMap().get(subField); | ||
| containingMessage = messageTypes.get(field.type().reference().name()); | ||
| } else { | ||
| checkHttpFieldIsValid(subField, containingMessage, false); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return Optional.of(bindings); | ||
| } | ||
|
|
||
| private static List<String> getPatternBindings(HttpRule httpRule) { | ||
| String pattern = null; | ||
| // Assign a temp variable to prevent the formatter from removing the import. | ||
| PatternCase patternCase = httpRule.getPatternCase(); | ||
| switch (patternCase) { | ||
| case GET: | ||
| pattern = httpRule.getGet(); | ||
| break; | ||
| case PUT: | ||
| pattern = httpRule.getPut(); | ||
| break; | ||
| case POST: | ||
| pattern = httpRule.getPost(); | ||
| break; | ||
| case DELETE: | ||
| pattern = httpRule.getDelete(); | ||
| break; | ||
| case PATCH: | ||
| pattern = httpRule.getPatch(); | ||
| break; | ||
| case CUSTOM: // Invalid pattern. | ||
| // Fall through. | ||
| default: | ||
| return Collections.emptyList(); | ||
| } | ||
|
|
||
| PathTemplate template = PathTemplate.create(pattern); | ||
| List<String> bindings = new ArrayList<String>(template.vars()); | ||
| Collections.sort(bindings); | ||
| return bindings; | ||
| } | ||
|
|
||
| private static void checkHttpFieldIsValid(String binding, Message inputMessage, boolean isBody) { | ||
| Preconditions.checkState( | ||
| !Strings.isNullOrEmpty(binding), | ||
| String.format("DEL: Null or empty binding for " + inputMessage.name())); | ||
| Preconditions.checkState( | ||
| inputMessage.fieldMap().containsKey(binding), | ||
| String.format( | ||
| "Expected message %s to contain field %s but none found", | ||
| inputMessage.name(), binding)); | ||
| Field field = inputMessage.fieldMap().get(binding); | ||
| boolean fieldCondition = !field.isRepeated(); | ||
| if (!isBody) { | ||
| fieldCondition &= field.type().isProtoPrimitiveType(); | ||
| } | ||
| String messageFormat = | ||
| "Expected a non-repeated " | ||
| + (isBody ? "" : "primitive ") | ||
| + "type for field %s in message %s but got type %s"; | ||
| Preconditions.checkState( | ||
| fieldCondition, | ||
| String.format(messageFormat, field.name(), inputMessage.name(), field.type())); | ||
| } | ||
| } |
This file contains 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 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
73 changes: 73 additions & 0 deletions
73
src/test/java/com/google/api/generator/gapic/protoparser/HttpRuleParserTest.java
This file contains 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,73 @@ | ||
| // Copyright 2020 Google LLC | ||
| // | ||
| // 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 com.google.api.generator.gapic.protoparser; | ||
|
|
||
| import static com.google.common.truth.Truth.assertThat; | ||
| import static junit.framework.Assert.assertEquals; | ||
| import static junit.framework.Assert.assertFalse; | ||
| import static junit.framework.Assert.assertTrue; | ||
| import static org.junit.Assert.assertThrows; | ||
|
|
||
| import com.google.api.generator.gapic.model.Message; | ||
| import com.google.protobuf.Descriptors.FileDescriptor; | ||
| import com.google.protobuf.Descriptors.MethodDescriptor; | ||
| import com.google.protobuf.Descriptors.ServiceDescriptor; | ||
| import com.google.showcase.v1beta1.TestingOuterClass; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Optional; | ||
| import org.junit.Test; | ||
|
|
||
| public class HttpRuleParserTest { | ||
| @Test | ||
| public void parseHttpAnnotation_basic() { | ||
| FileDescriptor testingFileDescriptor = TestingOuterClass.getDescriptor(); | ||
| ServiceDescriptor testingService = testingFileDescriptor.getServices().get(0); | ||
| assertEquals(testingService.getName(), "Testing"); | ||
|
|
||
| Map<String, Message> messages = Parser.parseMessages(testingFileDescriptor); | ||
|
|
||
| // CreateSession method. | ||
| MethodDescriptor rpcMethod = testingService.getMethods().get(0); | ||
| Message inputMessage = messages.get("CreateSessionRequest"); | ||
| Optional<List<String>> httpBindingsOpt = | ||
| HttpRuleParser.parseHttpBindings(rpcMethod, inputMessage, messages); | ||
| assertFalse(httpBindingsOpt.isPresent()); | ||
|
|
||
| // VerityTest method. | ||
| rpcMethod = testingService.getMethods().get(testingService.getMethods().size() - 1); | ||
| inputMessage = messages.get("VerifyTestRequest"); | ||
| httpBindingsOpt = HttpRuleParser.parseHttpBindings(rpcMethod, inputMessage, messages); | ||
| assertTrue(httpBindingsOpt.isPresent()); | ||
| assertThat(httpBindingsOpt.get()).containsExactly("name"); | ||
| } | ||
|
|
||
| @Test | ||
| public void parseHttpAnnotation_missingFieldFromMessage() { | ||
| FileDescriptor testingFileDescriptor = TestingOuterClass.getDescriptor(); | ||
| ServiceDescriptor testingService = testingFileDescriptor.getServices().get(0); | ||
| assertEquals(testingService.getName(), "Testing"); | ||
|
|
||
| Map<String, Message> messages = Parser.parseMessages(testingFileDescriptor); | ||
|
|
||
| // VerityTest method. | ||
| MethodDescriptor rpcMethod = | ||
| testingService.getMethods().get(testingService.getMethods().size() - 1); | ||
| Message inputMessage = messages.get("CreateSessionRequest"); | ||
| assertThrows( | ||
| IllegalStateException.class, | ||
| () -> HttpRuleParser.parseHttpBindings(rpcMethod, inputMessage, messages)); | ||
| } | ||
| } |