Rpc unary sc 31

src/main/java/com/google/api/generator/gapic/composer/BUILD.bazel

@@ -15,9 +15,11 @@ java_library(
     deps = [
         "//:service_config_java_proto",
         "//src/main/java/com/google/api/generator/engine/ast",
+        "//src/main/java/com/google/api/generator/engine/writer",
         "//src/main/java/com/google/api/generator/gapic:status_java_proto",
         "//src/main/java/com/google/api/generator/gapic/model",
         "//src/main/java/com/google/api/generator/gapic/utils",
+        "//src/main/java/com/google/api/generator/gapic/composer/samplecode",
         "@com_google_api_api_common//jar",
         "@com_google_api_gax_java//gax",
         "@com_google_api_gax_java//gax-grpc:gax_grpc",

src/main/java/com/google/api/generator/gapic/composer/SampleCodeHelperComposer.java

@@ -0,0 +1,149 @@
+// 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.composer;
+
+import com.google.api.generator.engine.ast.AssignmentExpr;
+import com.google.api.generator.engine.ast.CommentStatement;
+import com.google.api.generator.engine.ast.LineComment;
+import com.google.api.generator.engine.ast.MethodInvocationExpr;
+import com.google.api.generator.engine.ast.TryCatchStatement;
+import com.google.api.generator.engine.ast.TypeNode;
+import com.google.api.generator.engine.ast.Variable;
+import com.google.api.generator.engine.ast.VariableExpr;
+import com.google.api.generator.gapic.model.Method;
+import com.google.api.generator.gapic.model.MethodArgument;
+import com.google.api.generator.gapic.utils.JavaStyle;
+import java.util.Arrays;
+import java.util.List;
+
+public final class SampleCodeHelperComposer {
+
+  public static TryCatchStatement composeRpcMethodSampleCode(
+      Method method, List<MethodArgument> arguments, TypeNode clientType) {
+    // Default Unary RPC method.
+    if (arguments.isEmpty()) {
+      return composeUnaryRpcDefaultMethodSampleCode(method, clientType);
+    }
+    // Paged Unary RPC method.
+    if (method.isPaged()) {
+      return composePagedUnaryRpcMethodSampleCode(method, arguments, clientType);
+    }
+    // Long run operation Unary RPC method.
+    if (method.hasLro()) {
+      return composeLroUnaryRpcMethodSampleCode(method, arguments, clientType);
+    }
+    // Pure Unary RPC method.
+    return composeUnaryRpcMethodSampleCode(method, arguments, clientType);
+  }
+
+  private static TryCatchStatement composeUnaryRpcMethodSampleCode(
+      Method method, List<MethodArgument> arguments, TypeNode clientType) {
+    // TODO(summerji): compose sample code for unary rpc method.
+    return TryCatchStatement.builder()
+        .setTryResourceExpr(assignClientVariableWithCreateMethodExpr(clientType))
+        .setTryBody(
+            Arrays.asList(
+                createLineCommentStatement(
+                    "Note: Not Implement yet. Hold for pure unary rpc method sample code.")))
+        .setIsSampleCode(true)
+        .build();
+  }
+
+  private static TryCatchStatement composeLroUnaryRpcMethodSampleCode(
+      Method method, List<MethodArgument> arguments, TypeNode clientType) {
+    // TODO(summerji): compose sample code for unary lro rpc method.
+    return TryCatchStatement.builder()
+        .setTryResourceExpr(assignClientVariableWithCreateMethodExpr(clientType))
+        .setTryBody(
+            Arrays.asList(
+                createLineCommentStatement(
+                    "Note: Not Implement yet. Holder for lro Unary rpc method sample code.")))
+        .setIsSampleCode(true)
+        .build();
+  }
+
+  private static TryCatchStatement composePagedUnaryRpcMethodSampleCode(
+      Method method, List<MethodArgument> arguments, TypeNode clientType) {
+    // TODO(summerji): compose sample code for unary paged rpc method.
+    return TryCatchStatement.builder()
+        .setTryResourceExpr(assignClientVariableWithCreateMethodExpr(clientType))
+        .setTryBody(
+            Arrays.asList(
+                createLineCommentStatement(
+                    "Note: Not Implement yet. Holder for paged unary rpc method sample code.")))
+        .setIsSampleCode(true)
+        .build();
+  }
+
+  private static TryCatchStatement composeUnaryRpcDefaultMethodSampleCode(
+      Method method, TypeNode clientType) {
+    // TODO(summerji): compose sample code for unary default rpc method.
+    String content =
+        String.format(
+            "Note: Not Implement yet. Holder for unary %s rpc method sample code.",
+            (!method.hasLro() && !method.isPaged()
+                ? "default"
+                : (method.hasLro() ? "lro" : "paged")));
+    return TryCatchStatement.builder()
+        .setTryResourceExpr(assignClientVariableWithCreateMethodExpr(clientType))
+        .setTryBody(Arrays.asList(createLineCommentStatement(content)))
+        .setIsSampleCode(true)
+        .build();
+  }
+
+  // ==================================Helpers===================================================//
+
+  // Assign client variable expr with create client.
+  // e.g EchoClient echoClient = EchoClient.create()
+  private static AssignmentExpr assignClientVariableWithCreateMethodExpr(TypeNode clientType) {
+    return AssignmentExpr.builder()
+        .setVariableExpr(createVariableDeclExpr(getClientName(clientType), clientType))
+        .setValueExpr(
+            MethodInvocationExpr.builder()
+                .setStaticReferenceType(clientType)
+                .setReturnType(clientType)
+                .setMethodName("create")
+                .build())
+        .build();
+  }
+
+  private static String getClientName(TypeNode clientType) {
+    return JavaStyle.toLowerCamelCase(clientType.reference().name());
+  }
+
+  private static CommentStatement createLineCommentStatement(String content) {
+    return CommentStatement.withComment(LineComment.withComment(content));
+  }
+
+  private static VariableExpr createVariableExpr(String variableName, TypeNode type) {
+    return createVariableExpr(variableName, type, false);
+  }
+
+  private static VariableExpr createVariableDeclExpr(String variableName, TypeNode type) {
+    return createVariableExpr(variableName, type, true);
+  }
+
+  private static VariableExpr createVariableExpr(
+      String variableName, TypeNode type, boolean isDecl) {
+    return VariableExpr.builder()
+        .setVariable(createVariable(variableName, type))
+        .setIsDecl(isDecl)
+        .build();
+  }
+
+  private static Variable createVariable(String varName, TypeNode type) {
+    return Variable.builder().setName(varName).setType(type).build();
+  }
+}

src/main/java/com/google/api/generator/gapic/composer/ServiceClientClassComposer.java

@@ -119,7 +119,10 @@ public GapicClass generate(Service service, Map<String, Message> messageTypes) {
     ClassDefinition classDef =
         ClassDefinition.builder()
             .setHeaderCommentStatements(
-                ServiceClientCommentComposer.createClassHeaderComments(service))
+                ServiceClientCommentComposer.createClassHeaderComments(
+                    service,
+                    types.get(getClientClassName(service.name())),
+                    types.get(getSettingsName(service.name()))))
             .setPackageString(pakkage)
             .setAnnotations(createClassAnnotations(types))
             .setScope(ScopeNode.PUBLIC)
@@ -154,7 +157,9 @@ private static List<MethodDefinition> createClassMethods(
     methods.addAll(createStaticCreatorMethods(service, types));
     methods.addAll(createConstructorMethods(service, types, hasLroClient));
     methods.addAll(createGetterMethods(service, types, hasLroClient));
-    methods.addAll(createServiceMethods(service, messageTypes, types));
+    methods.addAll(
+        createServiceMethods(
+            service, messageTypes, types, types.get(getClientClassName(service.name()))));
     methods.addAll(createBackgroundResourceMethods(service, types));
     return methods;
   }
@@ -466,12 +471,15 @@ private static List<MethodDefinition> createGetterMethods(
   }
 
   private static List<MethodDefinition> createServiceMethods(
-      Service service, Map<String, Message> messageTypes, Map<String, TypeNode> types) {
+      Service service,
+      Map<String, Message> messageTypes,
+      Map<String, TypeNode> types,
+      TypeNode clientType) {
     List<MethodDefinition> javaMethods = new ArrayList<>();
     for (Method method : service.methods()) {
       if (method.stream().equals(Stream.NONE)) {
-        javaMethods.addAll(createMethodVariants(method, messageTypes, types));
-        javaMethods.add(createMethodDefaultMethod(method, types));
+        javaMethods.addAll(createMethodVariants(method, messageTypes, types, clientType));
+        javaMethods.add(createMethodDefaultMethod(method, types, clientType));
       }
       if (method.hasLro()) {
         javaMethods.add(createLroCallableMethod(service.name(), method, types));
@@ -485,7 +493,10 @@ private static List<MethodDefinition> createServiceMethods(
   }
 
   private static List<MethodDefinition> createMethodVariants(
-      Method method, Map<String, Message> messageTypes, Map<String, TypeNode> types) {
+      Method method,
+      Map<String, Message> messageTypes,
+      Map<String, TypeNode> types,
+      TypeNode clientType) {
     List<MethodDefinition> javaMethods = new ArrayList<>();
     String methodName = JavaStyle.toLowerCamelCase(method.name());
     TypeNode methodInputType = method.inputType();
@@ -549,7 +560,8 @@ private static List<MethodDefinition> createMethodVariants(
       javaMethods.add(
           MethodDefinition.builder()
               .setHeaderCommentStatements(
-                  ServiceClientCommentComposer.createRpcMethodHeaderComment(method, signature))
+                  ServiceClientCommentComposer.createRpcMethodHeaderComment(
+                      method, signature, clientType))
               .setScope(ScopeNode.PUBLIC)
               .setIsFinal(true)
               .setReturnType(methodOutputType)
@@ -564,7 +576,7 @@ private static List<MethodDefinition> createMethodVariants(
   }
 
   private static MethodDefinition createMethodDefaultMethod(
-      Method method, Map<String, TypeNode> types) {
+      Method method, Map<String, TypeNode> types, TypeNode clientType) {
     String methodName = JavaStyle.toLowerCamelCase(method.name());
     TypeNode methodInputType = method.inputType();
     TypeNode methodOutputType =
@@ -608,7 +620,7 @@ private static MethodDefinition createMethodDefaultMethod(
             .build();
     return MethodDefinition.builder()
         .setHeaderCommentStatements(
-            ServiceClientCommentComposer.createRpcMethodHeaderComment(method))
+            ServiceClientCommentComposer.createRpcMethodHeaderComment(method, clientType))
         .setScope(ScopeNode.PUBLIC)
         .setIsFinal(true)
         .setReturnType(methodOutputType)
@@ -1505,6 +1517,10 @@ private static String getClientClassName(String serviceName) {
     return String.format("%sClient", serviceName);
   }
 
+  private static String getSettingsName(String serviceName) {
+    return String.format("%sSettings", serviceName);
+  }
+
   private static List<Reference> getGenericsForCallable(
       CallableMethodKind kind, Method method, Map<String, TypeNode> types) {
     if (kind.equals(CallableMethodKind.LRO)) {

src/main/java/com/google/api/generator/gapic/composer/ServiceClientCommentComposer.java

@@ -29,6 +29,10 @@
 import java.util.stream.Stream;
 
 class ServiceClientCommentComposer {
+  // Name Pattern.
+  private static final String SETTINGS_NAME_PATTERN = "%sSettings";
+  private static final String CLASS_NAME_PATTERN = "%sClient";
+
   // Tokens.
   private static final String COLON = ":";
   private static final String EMPTY_STRING = "";
@@ -103,7 +107,10 @@ class ServiceClientCommentComposer {
           "Returns the OperationsClient that can be used to query the status of a long-running"
               + " operation returned by another API method call.");
 
-  static List<CommentStatement> createClassHeaderComments(Service service) {
+  static List<CommentStatement> createClassHeaderComments(
+      Service service, TypeNode clientType, TypeNode settingsType) {
+    String settingsName = JavaStyle.toLowerCamelCase(getSettingsName(service.name()));
+    String clientName = JavaStyle.toLowerCamelCase(getClientClassName(service.name()));
     JavaDocComment.Builder classHeaderJavadocBuilder = JavaDocComment.builder();
     if (service.hasDescription()) {
       classHeaderJavadocBuilder =
@@ -134,9 +141,13 @@ static List<CommentStatement> createClassHeaderComments(Service service) {
             SERVICE_DESCRIPTION_CUSTOMIZE_SUMMARY_PATTERN,
             String.format("%sSettings", JavaStyle.toUpperCamelCase(service.name()))));
     classHeaderJavadocBuilder.addParagraph(SERVICE_DESCRIPTION_CREDENTIALS_SUMMARY_STRING);
-    // TODO(summerji): Add credentials' customization sample code here.
+    classHeaderJavadocBuilder.addSampleCode(
+        ServiceClientSampleCodeComposer.composeClassHeaderCredentialsSampleCode(
+            clientType, settingsType));
     classHeaderJavadocBuilder.addParagraph(SERVICE_DESCRIPTION_ENDPOINT_SUMMARY_STRING);
-    // TODO(summerji): Add endpoint customization sample code here.
+    classHeaderJavadocBuilder.addSampleCode(
+        ServiceClientSampleCodeComposer.composeClassHeaderEndpointSampleCode(
+            clientType, settingsType));
 
     return Arrays.asList(
         CommentComposer.AUTO_GENERATED_CLASS_COMMENT,
@@ -151,7 +162,7 @@ static CommentStatement createCreateMethodStubArgComment(
   }
 
   static List<CommentStatement> createRpcMethodHeaderComment(
-      Method method, List<MethodArgument> methodArguments) {
+      Method method, List<MethodArgument> methodArguments, TypeNode clientType) {
     JavaDocComment.Builder methodJavadocBuilder = JavaDocComment.builder();
 
     if (method.hasDescription()) {
@@ -160,7 +171,9 @@ static List<CommentStatement> createRpcMethodHeaderComment(
     }
 
     methodJavadocBuilder.addParagraph(METHOD_DESCRIPTION_SAMPLE_CODE_SUMMARY_STRING);
-    // TODO(summerji): Add sample code here.
+    methodJavadocBuilder.addSampleCode(
+        ServiceClientSampleCodeComposer.composeRpcMethodHeaderSampleCode(
+            method, methodArguments, clientType));
 
     if (methodArguments.isEmpty()) {
       methodJavadocBuilder.addParam(
@@ -181,8 +194,8 @@ static List<CommentStatement> createRpcMethodHeaderComment(
         CommentStatement.withComment(methodJavadocBuilder.build()));
   }
 
-  static List<CommentStatement> createRpcMethodHeaderComment(Method method) {
-    return createRpcMethodHeaderComment(method, Collections.emptyList());
+  static List<CommentStatement> createRpcMethodHeaderComment(Method method, TypeNode clientType) {
+    return createRpcMethodHeaderComment(method, Collections.emptyList(), clientType);
   }
 
   static CommentStatement createMethodNoArgComment(String serviceName) {
@@ -254,4 +267,12 @@ private static JavaDocComment.Builder processProtobufComment(
 
     return commentBuilder;
   }
+
+  private static String getSettingsName(String serviceName) {
+    return String.format(SETTINGS_NAME_PATTERN, serviceName);
+  }
+
+  private static String getClientClassName(String serviceName) {
+    return String.format(CLASS_NAME_PATTERN, serviceName);
+  }
 }