[ggj] feat: support file header (apache license) for outer class definition

src/main/java/com/google/api/generator/engine/ast/BlockComment.java

@@ -14,7 +14,6 @@
 
 package com.google.api.generator.engine.ast;
 
-import com.google.api.generator.engine.escaper.MetacharEscaper;
 import com.google.auto.value.AutoValue;
 
 @AutoValue
@@ -38,14 +37,6 @@ public static BlockComment withComment(String comment) {
   public abstract static class Builder {
     public abstract Builder setComment(String comment);
 
-    // Private accessor.
-    abstract String comment();
-
-    public abstract BlockComment autoBuild();
-
-    public BlockComment build() {
-      setComment(MetacharEscaper.escaper(comment()));
-      return autoBuild();
-    }
+    public abstract BlockComment build();
   }
 }

src/main/java/com/google/api/generator/engine/ast/ClassDefinition.java

@@ -23,6 +23,8 @@
 
 @AutoValue
 public abstract class ClassDefinition implements AstNode {
+  // Optional.
+  public abstract ImmutableList<CommentStatement> fileHeader();
   // Required.
   public abstract ScopeNode scope();
   // Required.
@@ -66,6 +68,7 @@ public void accept(AstNodeVisitor visitor) {
 
   public static Builder builder() {
     return new AutoValue_ClassDefinition.Builder()
+        .setFileHeader(Collections.emptyList())
         .setHeaderCommentStatements(Collections.emptyList())
         .setIsNested(false)
         .setIsFinal(false)
@@ -80,6 +83,8 @@ public static Builder builder() {
 
   @AutoValue.Builder
   public abstract static class Builder {
+    public abstract Builder setFileHeader(List<CommentStatement> fileHeader);
+
     public abstract Builder setHeaderCommentStatements(
         List<CommentStatement> headerCommentStatements);
 

src/main/java/com/google/api/generator/engine/writer/JavaWriterVisitor.java

@@ -62,14 +62,15 @@ public class JavaWriterVisitor implements AstNodeVisitor {
 
   private static final String COLON = ":";
   private static final String COMMA = ",";
-  private static final String BLOCK_COMMENT_START = "/**";
+  private static final String BLOCK_COMMENT_START = "/*";
   private static final String BLOCK_COMMENT_END = "*/";
   private static final String DOT = ".";
   private static final String ESCAPED_QUOTE = "\"";
   private static final String EQUALS = "=";
   private static final String LEFT_ANGLE = "<";
   private static final String LEFT_BRACE = "{";
   private static final String LEFT_PAREN = "(";
+  private static final String JAVADOC_COMMENT_START = "/**";
   private static final String QUESTION_MARK = "?";
   private static final String RIGHT_ANGLE = ">";
   private static final String RIGHT_BRACE = "}";
@@ -487,17 +488,21 @@ public void visit(LineComment lineComment) {
   }
 
   public void visit(BlockComment blockComment) {
-    // Split comments by new line and embrace the comment block with `/** */`.
-    String sourceComment = blockComment.comment();
-    String formattedSource =
-        JavaFormatter.format(
-            String.format("%s %s %s", BLOCK_COMMENT_START, sourceComment, BLOCK_COMMENT_END));
-    buffer.append(formattedSource);
+    // Split comments by new line and embrace the comment block with `/* */`.
+    StringBuilder sourceComment = new StringBuilder();
+    sourceComment.append(BLOCK_COMMENT_START).append(NEWLINE);
+    Arrays.stream(blockComment.comment().split("\\r?\\n"))
+        .forEach(
+            comment -> {
+              sourceComment.append(String.format("%s %s%s", ASTERISK, comment, NEWLINE));
+            });
+    sourceComment.append(BLOCK_COMMENT_END);
+    buffer.append(JavaFormatter.format(sourceComment.toString()));
   }
 
   public void visit(JavaDocComment javaDocComment) {
     StringBuilder sourceComment = new StringBuilder();
-    sourceComment.append(BLOCK_COMMENT_START).append(NEWLINE);
+    sourceComment.append(JAVADOC_COMMENT_START).append(NEWLINE);
     Arrays.stream(javaDocComment.comment().split("\\r?\\n"))
         .forEach(
             comment -> {
@@ -624,6 +629,8 @@ public void visit(MethodDefinition methodDefinition) {
   @Override
   public void visit(ClassDefinition classDefinition) {
     if (!classDefinition.isNested()) {
+      statements(classDefinition.fileHeader().stream().collect(Collectors.toList()));
+      newline();
       importWriterVisitor.initialize(
           classDefinition.packageString(), classDefinition.classIdentifier().name());
       buffer.append(String.format("package %s;", classDefinition.packageString()));

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

@@ -3,7 +3,7 @@ package(default_visibility = ["//visibility:public"])
 filegroup(
     name = "gapic_files",
     srcs = glob(["*.java"]) + [
-        "//src/test/java/com/google/api/generator/gapic/composer:composer_files",
+        "//src/main/java/com/google/api/generator/gapic/composer:composer_files",
         "//src/main/java/com/google/api/generator/gapic/model:model_files",
         "//src/main/java/com/google/api/generator/gapic/protoparser:protoparser_files",
     ],

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

@@ -0,0 +1,37 @@
+// 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.BlockComment;
+import com.google.api.generator.engine.ast.CommentStatement;
+import java.util.Arrays;
+import java.util.List;
+
+public class ApacheLicenseComposer {
+  private static final String fileHeadeString =
+      "Copyright 2020 Google LLC\n\n"
+          + "Licensed under the Apache License, Version 2.0 (the \"License\");\n"
+          + "you may not use this file except in compliance with the License.\n"
+          + "You may obtain a copy of the License at\n\n"
+          + "     https://www.apache.org/licenses/LICENSE-2.0\n\n"
+          + "Unless required by applicable law or agreed to in writing, software\n"
+          + "distributed under the License is distributed on an \"AS IS\" BASIS,\n"
+          + "WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n"
+          + "See the License for the specific language governing permissions and\n"
+          + "limitations under the License.";
+
+  public static final List<CommentStatement> APACHE_LICENSE =
+      Arrays.asList(CommentStatement.withComment(BlockComment.withComment(fileHeadeString)));;
+}

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

@@ -22,6 +22,7 @@
 import com.google.api.generator.gapic.model.Message;
 import com.google.api.generator.gapic.model.ResourceName;
 import com.google.api.generator.gapic.model.Service;
+import com.google.common.annotations.VisibleForTesting;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
@@ -85,7 +86,8 @@ public static List<GapicClass> generateMocksAndTestClasses(
   }
 
   /** ====================== STUB CLASSES ==================== */
-  private static GapicClass generateStubServiceSettings(Service service) {
+  @VisibleForTesting
+  protected static GapicClass generateStubServiceSettings(Service service) {
     return generateGenericClass(
         Kind.STUB, String.format("%sStubSettings", service.name()), service);
   }
@@ -100,6 +102,7 @@ private static GapicClass generateGenericClass(Kind kind, String name, Service s
 
     ClassDefinition classDef =
         ClassDefinition.builder()
+            .setFileHeader(ApacheLicenseComposer.APACHE_LICENSE)
             .setPackageString(pakkage)
             .setName(name)
             .setScope(ScopeNode.PUBLIC)

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

@@ -232,7 +232,8 @@ private static Statement createMethodDescriptorVariableDecl(
     return ExprStatement.withExpr(
         AssignmentExpr.builder()
             .setVariableExpr(
-                methodDescriptorVarExpr.toBuilder()
+                methodDescriptorVarExpr
+                    .toBuilder()
                     .setIsDecl(true)
                     .setScope(ScopeNode.PRIVATE)
                     .setIsStatic(true)

src/test/java/com/google/api/generator/engine/ast/ClassDefinitionTest.java

@@ -23,7 +23,7 @@
 public class ClassDefinitionTest {
 
   @Test
-  public void validClassDefinition_basicWithComments() {
+  public void validClassDefinition_basicWithCommentsAndHeader() {
     LineComment lineComment = LineComment.withComment("AUTO-GENERATED DOCUMENTATION AND CLASS");
     JavaDocComment javaDocComment =
         JavaDocComment.builder()
@@ -32,6 +32,7 @@ public void validClassDefinition_basicWithComments() {
                 "This class is for advanced usage and reflects the underlying API directly.")
             .build();
     ClassDefinition.builder()
+        .setFileHeader(createFileHeader())
         .setHeaderCommentStatements(
             Arrays.asList(
                 CommentStatement.withComment(lineComment),
@@ -347,4 +348,8 @@ private static ForStatement createForStatement() {
         .setBody(Arrays.asList(ExprStatement.withExpr(createAssignmentExpr())))
         .build();
   }
+  // Create a simple block comment to stand for the Apache License header.
+  private static List<CommentStatement> createFileHeader() {
+    return Arrays.asList(CommentStatement.withComment(BlockComment.withComment("Apache License")));
+  }
 }

src/test/java/com/google/api/generator/engine/writer/ImportWriterVisitorTest.java

@@ -89,7 +89,6 @@ public void writeNewObjectExprImports_withArgs() {
             .setArguments(Arrays.asList(fileExpr))
             .build();
     newObjectExpr.accept(writerVisitor);
-    System.out.println(writerVisitor.write());
     assertEquals(
         writerVisitor.write(),
         String.format(

src/test/java/com/google/api/generator/engine/writer/JavaWriterVisitorTest.java

@@ -322,7 +322,7 @@ public void writeBlockCommentStatement_basic() {
     String content = "this is a test comment";
     BlockComment blockComment = BlockComment.builder().setComment(content).build();
     CommentStatement commentStatement = CommentStatement.withComment(blockComment);
-    String expected = "/** this is a test comment */\n";
+    String expected = "/*\n" + "* this is a test comment\n" + "*/\n";
     commentStatement.accept(writerVisitor);
     assertEquals(writerVisitor.write(), expected);
   }
@@ -400,11 +400,10 @@ public void writeJavaDocCommentStatement_allComponents() {
   }
 
   @Test
-  public void writeBlockComment_specialChar() {
-    String content = "Testing special characters: \b\t\n\r\"`'?/\\,.[]{}|-_!@#$%^()";
+  public void writeBlockComment_multipleLine() {
+    String content = "Apache License \nThis is a test file header";
     BlockComment blockComment = BlockComment.builder().setComment(content).build();
-    String expected =
-        "/** Testing special characters: \\b\\t\\n\\r\"`'?/\\\\,.[]{}|-_!@#$%^() */\n";
+    String expected = "/*\n" + "* Apache License\n" + "* This is a test file header\n" + "*/\n";
     blockComment.accept(writerVisitor);
     assertEquals(writerVisitor.write(), expected);
   }
@@ -1499,9 +1498,10 @@ public void writeMethodDefinition_templatedReturnTypeAndArguments() {
   }
 
   @Test
-  public void writeClassDefinition_basic() {
+  public void writeClassDefinition_basicWithFileHeader() {
     ClassDefinition classDef =
         ClassDefinition.builder()
+            .setFileHeader(createFileHeader())
             .setPackageString("com.google.example.library.v1.stub")
             .setName("LibraryServiceStub")
             .setScope(ScopeNode.PUBLIC)
@@ -1511,7 +1511,10 @@ public void writeClassDefinition_basic() {
     assertEquals(
         writerVisitor.write(),
         String.format(
-            createLines(3),
+            createLines(6),
+            "/*\n",
+            " * Apache License\n",
+            " */\n\n",
             "package com.google.example.library.v1.stub;\n",
             "\n",
             "public class LibraryServiceStub {}\n"));
@@ -1788,4 +1791,9 @@ private static String createSampleCode() {
     tryCatch.accept(writerVisitor);
     return writerVisitor.write();
   }
+
+  // Create a simple block comment to stand for the Apache License header.
+  private static List<CommentStatement> createFileHeader() {
+    return Arrays.asList(CommentStatement.withComment(BlockComment.withComment("Apache License")));
+  }
 }

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

@@ -1,6 +1,7 @@
 package(default_visibility = ["//visibility:public"])
 
 TESTS = [
+    "ComposerTest",
     "GrpcServiceCallableFactoryClassComposerTest",
     "GrpcServiceStubClassComposerTest",
     "MockServiceClassComposerTest",

src/test/java/com/google/api/generator/gapic/composer/ComposerTest.java

@@ -0,0 +1,80 @@
+// 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 static junit.framework.Assert.assertEquals;
+
+import com.google.api.generator.engine.writer.JavaWriterVisitor;
+import com.google.api.generator.gapic.model.Message;
+import com.google.api.generator.gapic.model.ResourceName;
+import com.google.api.generator.gapic.model.Service;
+import com.google.api.generator.gapic.protoparser.Parser;
+import com.google.protobuf.Descriptors.FileDescriptor;
+import com.google.protobuf.Descriptors.ServiceDescriptor;
+import com.google.showcase.v1beta1.EchoOuterClass;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import org.junit.Before;
+import org.junit.Test;
+
+public class ComposerTest {
+  private ServiceDescriptor echoService;
+  private FileDescriptor echoFileDescriptor;
+
+  @Before
+  public void setUp() {
+    echoFileDescriptor = EchoOuterClass.getDescriptor();
+    echoService = echoFileDescriptor.getServices().get(0);
+    assertEquals(echoService.getName(), "Echo");
+  }
+
+  @Test
+  public void generateStubServiceSettings() {
+    Map<String, Message> messageTypes = Parser.parseMessages(echoFileDescriptor);
+    Map<String, ResourceName> resourceNames = Parser.parseResourceNames(echoFileDescriptor);
+    Set<ResourceName> outputResourceNames = new HashSet<>();
+
+    List<Service> services =
+        Parser.parseService(echoFileDescriptor, messageTypes, resourceNames, outputResourceNames);
+    Service echoProtoService = services.get(0);
+    JavaWriterVisitor visitor = new JavaWriterVisitor();
+    Composer.generateStubServiceSettings(echoProtoService).classDefinition().accept(visitor);
+    System.out.println(visitor.write());
+    System.out.println(EXPECTED_CLASS_STRING);
+
+    assertEquals(visitor.write(), EXPECTED_CLASS_STRING);
+  }
+
+  private static final String EXPECTED_CLASS_STRING =
+      "/*\n"
+          + " * Copyright 2020 Google LLC\n"
+          + " *\n"
+          + " * Licensed under the Apache License, Version 2.0 (the \"License\");\n"
+          + " * you may not use this file except in compliance with the License.\n"
+          + " * You may obtain a copy of the License at\n"
+          + " *\n"
+          + " *      https://www.apache.org/licenses/LICENSE-2.0\n"
+          + " *\n"
+          + " * Unless required by applicable law or agreed to in writing, software\n"
+          + " * distributed under the License is distributed on an \"AS IS\" BASIS,\n"
+          + " * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n"
+          + " * See the License for the specific language governing permissions and\n"
+          + " * limitations under the License.\n"
+          + " */\n\n"
+          + "package com.google.showcase.v1beta1.stub;\n\n"
+          + "public class EchoStubSettings {}\n";
+}