Add dummy task in javadoc plugin to generate an empty api.txt file (#2447)

Also add support for formatting plugin in buildSrc.

Author: rlazo

buildSrc/build.gradle

@@ -15,6 +15,7 @@
 plugins {
     id "org.gradle.kotlin.kotlin-dsl" version "1.2.6"
     id "org.jlleitschuh.gradle.ktlint" version "9.2.1"
+    id 'com.github.sherter.google-java-format' version '0.9'
 }
 
 repositories {
@@ -35,6 +36,23 @@ repositories {
 // Refer go/fireperf-plugin-test-on-head for more details.
 def perfPluginVersion = System.getenv("FIREBASE_PERF_PLUGIN_VERSION") ?: "1.3.4"
 
+googleJavaFormat {
+    toolVersion = '1.7'
+}
+tasks.googleJavaFormat {
+    source '.'
+    include '**/java/**/*.java'
+    exclude '**/generated/**'
+    exclude '**/package-info.java'
+}
+
+tasks.verifyGoogleJavaFormat {
+    source '.'
+    include '**/java/**/*.java'
+    exclude '**/generated/**'
+    exclude '**/package-info.java'
+}
+
 dependencies {
     // Firebase performance plugin, it should be added here because of how gradle dependency
     // resolution works, otherwise it breaks Fireperf Test Apps.

buildSrc/src/main/java/com/google/firebase/gradle/plugins/Dokka.java

@@ -63,7 +63,7 @@ static void configure(
               BuildTypeAttr.ATTRIBUTE, project.getObjects().named(BuildTypeAttr.class, "release"));
     }
     Configuration runtimeOnly = project.getConfigurations().findByName("runtimeOnly");
-    if(runtimeOnly != null) {
+    if (runtimeOnly != null) {
       javadocClasspath.extendsFrom(runtimeOnly);
     }
 

buildSrc/src/main/java/com/google/firebase/gradle/plugins/JavadocPlugin.java

@@ -13,8 +13,8 @@
 // limitations under the License.
 package com.google.firebase.gradle.plugins;
 
-import static com.google.firebase.gradle.plugins.ProjectUtilsKt.toBoolean;
 import static com.google.firebase.gradle.plugins.ClosureUtil.closureOf;
+import static com.google.firebase.gradle.plugins.ProjectUtilsKt.toBoolean;
 
 import com.android.build.gradle.LibraryExtension;
 import com.google.common.collect.ImmutableList;
@@ -93,11 +93,14 @@ private static void applyDoclava(Project project) {
         generateJavadoc,
         closureOf(
             (Javadoc javadoc) -> {
-              project.getTasks().all(it -> {
-                if (it.getName().equals("assembleRelease")) {
-                  javadoc.dependsOn(it);
-                }
-              });
+              project
+                  .getTasks()
+                  .all(
+                      it -> {
+                        if (it.getName().equals("assembleRelease")) {
+                          javadoc.dependsOn(it);
+                        }
+                      });
               // Besides third party libraries, firestore depends on the sibling module
               // :immutable-collection,
               // which needs to be in the classpath when javadoc is run
@@ -148,8 +151,9 @@ private static void applyDoclava(Project project) {
                           javadoc.setClasspath(
                               javadoc
                                   .getClasspath()
-                                  .plus(getJars(variant.getCompileConfiguration())
-                                      .plus(getJars(variant.getRuntimeConfiguration()))));
+                                  .plus(
+                                      getJars(variant.getCompileConfiguration())
+                                          .plus(getJars(variant.getRuntimeConfiguration()))));
 
                           // this includes compiled sources which avoids "cannot find symbol" errors
                           javadoc.setClasspath(
@@ -260,9 +264,12 @@ private static void applyDoclava(Project project) {
             }));
     project
         .getTasks()
-        .create(TasksKt.JAVADOC_TASK_NAME, task -> {
-          task.dependsOn(generateJavadoc);
-        });
+        .create(
+            TasksKt.JAVADOC_TASK_NAME,
+            task -> {
+              task.dependsOn(generateJavadoc);
+              createEmptyApiFile(project);
+            });
   }
 
   private static void applyDokka(Project project) {
@@ -275,20 +282,25 @@ private static void applyDokka(Project project) {
   private static Task applyDummyJavadoc(Project project) {
     return project
         .getTasks()
-        .create(TasksKt.JAVADOC_TASK_NAME, task -> {
-          task.doLast(
-              t -> {
-                File dir = project.file(project.getBuildDir() + "/tmp/javadoc");
-                project.mkdir(dir);
-                try {
-                  project.file(dir + "/api.txt").createNewFile();
-                } catch (IOException e) {
-                  throw new GradleException("Unable to create file", e);
-                }
-              });
-          task.doLast(
-              t -> project.mkdir(project.getBuildDir() + "/docs/javadoc/reference"));
-        });
+        .create(
+            TasksKt.JAVADOC_TASK_NAME,
+            task -> {
+              task.doLast(
+                  t -> {
+                    createEmptyApiFile(project);
+                  });
+              task.doLast(t -> project.mkdir(project.getBuildDir() + "/docs/javadoc/reference"));
+            });
+  }
+
+  private static void createEmptyApiFile(Project project) {
+    File dir = project.file(project.getBuildDir() + "/tmp/javadoc");
+    project.mkdir(dir);
+    try {
+      project.file(dir + "/api.txt").createNewFile();
+    } catch (IOException e) {
+      throw new GradleException("Unable to create file", e);
+    }
   }
 
   private static FileCollection getJars(Configuration configuration) {

buildSrc/src/main/java/com/google/firebase/gradle/plugins/ci/ContinuousIntegrationPlugin.java

@@ -39,8 +39,7 @@ public void apply(Project project) {
           Task connectedCheckDependents = sub.task("connectedCheckDependents");
           Task deviceCheckDependents = sub.task("deviceCheckDependents");
 
-          sub
-              .getConfigurations()
+          sub.getConfigurations()
               .all(
                   cfg -> {
                     if ("releaseUnitTestRuntimeClasspath".equals(cfg.getName())) {

buildSrc/src/main/java/com/google/firebase/gradle/plugins/ci/device/FirebaseTestLabExtension.java

@@ -14,40 +14,37 @@
 
 package com.google.firebase.gradle.plugins.ci.device;
 
-
-import org.gradle.api.model.ObjectFactory;
-import org.gradle.api.provider.SetProperty;
-
 import java.util.Collections;
 import java.util.Set;
-
 import javax.inject.Inject;
+import org.gradle.api.model.ObjectFactory;
+import org.gradle.api.provider.SetProperty;
 
 public class FirebaseTestLabExtension {
-    private final SetProperty<String> devices;
-    private boolean enabled;
+  private final SetProperty<String> devices;
+  private boolean enabled;
 
-    @Inject
-    public FirebaseTestLabExtension(ObjectFactory objectFactory) {
-        devices = objectFactory.setProperty(String.class);
-    }
+  @Inject
+  public FirebaseTestLabExtension(ObjectFactory objectFactory) {
+    devices = objectFactory.setProperty(String.class);
+  }
 
-    public void setEnabled(boolean value) {
-        enabled = value;
-    }
+  public void setEnabled(boolean value) {
+    enabled = value;
+  }
 
-    public boolean getEnabled() {
-        return enabled;
-    }
+  public boolean getEnabled() {
+    return enabled;
+  }
 
-    public void device(String device) {
-        devices.add(device);
-    }
+  public void device(String device) {
+    devices.add(device);
+  }
 
-    Set<String> getDevices() {
-        if( devices.get().isEmpty()) {
-            return Collections.singleton("model=Pixel2,version=27,locale=en,orientation=portrait");
-        }
-        return devices.get();
+  Set<String> getDevices() {
+    if (devices.get().isEmpty()) {
+      return Collections.singleton("model=Pixel2,version=27,locale=en,orientation=portrait");
     }
+    return devices.get();
+  }
 }