add gradle tasks for metalava generation

buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/FirebaseLibraryPlugin.java

@@ -15,12 +15,19 @@
 package com.google.firebase.gradle.plugins;
 
 import com.android.build.gradle.LibraryExtension;
+import com.android.build.gradle.api.AndroidSourceSet;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMap;
+import com.google.firebase.gradle.plugins.apiinfo.GenerateApiTxtFileTask;
+import com.google.firebase.gradle.plugins.apiinfo.ApiInformationTask;
 import com.google.firebase.gradle.plugins.ci.device.FirebaseTestServer;
+
 import org.gradle.api.Plugin;
 import org.gradle.api.Project;
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile;
+import java.io.File;
+import java.util.ArrayList;
+import java.util.List;
 
 public class FirebaseLibraryPlugin implements Plugin<Project> {
 
@@ -54,6 +61,40 @@ public void apply(Project project) {
                 }
               });
     }
+    if (System.getenv().containsKey("METALAVA_BINARY_PATH")) {
+      String METALAVA_BINARY_PATH = System.getenv("METALAVA_BINARY_PATH");
+      AndroidSourceSet mainSourceSet = android.getSourceSets().getByName("main");
+      List<String> sourcePaths = new ArrayList<>();
+      for (File directory : mainSourceSet.getJava().getSrcDirs()) {
+        sourcePaths.add(directory.getAbsolutePath());
+      }
+      String sourcePathArgument = String.join(",", sourcePaths);
+      project.getTasks().create("apiInformation", ApiInformationTask.class, task -> {
+        task.setProperty("apiTxt", project.getProjectDir() + "/api.txt");
+        task.setProperty("metalavaBinaryPath", METALAVA_BINARY_PATH);
+        task.setProperty("sourcePath", sourcePathArgument);
+        task.setProperty("outputPath", project.getRootProject().getBuildDir() + "/apiinfo/subproject" + project.getPath());
+        task.setProperty("baselinePath", project.getProjectDir() + "/baseline.txt");
+        if (project.hasProperty("updateBaseline")) {
+          task.setProperty("updateBaseline", true);
+        } else {
+          task.setProperty("updateBaseline", false);
+        }
+      });
+
+      project.getTasks().create("generateApiTxtFile", GenerateApiTxtFileTask.class, task -> {
+        task.setProperty("apiTxt", project.getProjectDir() + "/api.txt");
+        task.setProperty("metalavaBinaryPath", METALAVA_BINARY_PATH);
+        task.setProperty("sourcePath", sourcePathArgument);
+        task.setProperty("baselinePath", project.getProjectDir() + "/baseline.txt");
+        if (project.hasProperty("updateBaseline")) {
+          task.setProperty("updateBaseline", true);
+        } else {
+          task.setProperty("updateBaseline", false);
+        }
+      });
+    }
+
 
     android.testServer(new FirebaseTestServer(project, firebaseLibrary.testLab));
 

buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/apiinfo/ApiInformationTask.java

@@ -0,0 +1,98 @@
+// Copyright 2019 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.firebase.gradle.plugins.apiinfo;
+
+import groovy.transform.CompileStatic;
+import jdk.nashorn.internal.objects.annotations.Property;
+import org.gradle.api.DefaultTask;
+import org.gradle.api.tasks.TaskAction;
+
+import java.io.BufferedReader;
+import java.io.BufferedWriter;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.io.InputStreamReader;
+
+/**
+    Task generates the api diff of the current source code against the api.txt file stored
+    alongside the project's src directory.
+ */
+@CompileStatic
+public class ApiInformationTask extends DefaultTask {
+
+    @Property
+    String metalavaBinaryPath;
+
+    @Property
+    String apiTxt;
+
+    @Property
+    String sourcePath;
+
+    @Property
+    String baselinePath;
+
+    @Property
+    boolean updateBaseline;
+
+    @Property
+    String outputPath;
+
+
+    private String getCmdOutput (String cmdToRun) {
+        ProcessBuilder processBuilder = new ProcessBuilder(cmdToRun.split(" "));
+        try {
+            Process p = processBuilder.start();
+            BufferedReader reader =
+                    new BufferedReader(new InputStreamReader(p.getInputStream()));
+            StringBuilder builder = new StringBuilder();
+            String line = null;
+            while ( (line = reader.readLine()) != null) {
+                builder.append(line);
+                builder.append(System.getProperty("line.separator"));
+            }
+            return builder.toString();
+        } catch (IOException e) {
+            e.printStackTrace();
+            return null;
+        }
+
+    }
+
+    private void writeToFile(String output) {
+        try(BufferedWriter out = new BufferedWriter(new FileWriter(outputPath))) {
+            out.write(output);
+        } catch (IOException e) {
+            System.err.println("Error: " + e.getMessage());
+        }
+    }
+
+    @TaskAction
+    void execute() {
+        String cmdTemplate = "%s --source-path %s --check-compatibility:api:current %s --format=v2 --baseline %s --no-color";
+        if(updateBaseline) {
+            cmdTemplate = "%s --source-path %s --check-compatibility:api:current %s --format=v2 --update-baseline %s --no-color";
+        }
+        String cmdToRun = String.format(cmdTemplate, metalavaBinaryPath, sourcePath, apiTxt, baselinePath);
+        String cmdOutput = getCmdOutput(cmdToRun);
+        if(cmdOutput == null ){
+            System.out.println("Unable to run the command " + cmdToRun);
+        }
+        else {
+            writeToFile(cmdOutput);
+        }
+    }
+
+}

buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/apiinfo/GenerateApiTask.java

@@ -0,0 +1,52 @@
+// Copyright 2019 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.firebase.gradle.plugins.apiinfo;
+
+import groovy.transform.CompileStatic;
+import org.gradle.api.DefaultTask;
+import org.gradle.api.tasks.Input;
+import org.gradle.api.tasks.TaskAction;
+
+import java.io.IOException;
+
+/**
+    Task generates the api txt file for the current source code.
+ */
+@CompileStatic
+class GenerateApiTask extends DefaultTask {
+
+    @Input
+    private String metalavaBinaryPath;
+
+    @Input
+    private String apiTxt;
+
+    @Input
+    private String sourcePath;
+
+
+    @TaskAction
+    void execute() {
+        String cmdTemplate = "%s --source-path %s --api %s --format=v2";
+        String cmdToRun = String.format(cmdTemplate, metalavaBinaryPath, sourcePath, apiTxt);
+        try {
+            Runtime.getRuntime().exec(cmdToRun);
+        } catch (IOException e) {
+            System.out.println("Failed to run command " + cmdToRun);
+            System.out.println(e.toString());
+        }
+    }
+
+}

buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/apiinfo/GenerateApiTxtFileTask.java

@@ -0,0 +1,64 @@
+// Copyright 2019 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.firebase.gradle.plugins.apiinfo;
+
+
+
+import org.gradle.api.DefaultTask;
+import org.gradle.api.tasks.Input;
+import org.gradle.api.tasks.TaskAction;
+
+import java.io.IOException;
+
+import groovy.transform.CompileStatic;
+import jdk.nashorn.internal.objects.annotations.Property;
+
+@CompileStatic
+public class GenerateApiTxtFileTask extends DefaultTask {
+
+    @Property
+    String metalavaBinaryPath;
+
+    @Property
+    String apiTxt;
+
+    @Property
+    String sourcePath;
+
+    @Property
+    String baselinePath;
+
+    @Property
+    boolean updateBaseline;
+
+
+
+    @TaskAction
+    void execute() {
+        String cmdTemplate = "%s --source-path %s --api %s --format=v2 --baseline %s";
+        if(updateBaseline) {
+            cmdTemplate = "%s --source-path %s --api %s --format=v2 --update-baseline %s";
+        }
+        String cmdToRun = String.format(cmdTemplate, metalavaBinaryPath, sourcePath, apiTxt, baselinePath);
+        try {
+            Process p = Runtime.getRuntime().exec(cmdToRun);
+            System.out.println("Generated api txt file at " + apiTxt);
+        } catch (IOException e) {
+            System.out.println("Failed to run command " + cmdToRun);
+            System.out.println(e.toString());
+        }
+    }
+
+}

ci/fireci/fireci/commands.py

@@ -15,6 +15,8 @@
 import click
 import os
 
+from github import Github
+
 from . import gradle
 from . import ci_command
 from . import stats
@@ -61,3 +63,38 @@ def smoke_tests(app_build_variant, test_apps_dir):
             os.path.join(cwd, 'build', 'm2repository')),
         workdir=location,
     )
+
+
+@click.argument('issue_number', required=True)
+@click.argument('repo_name', required=True)
+@click.argument('auth_token', required=True)
+@ci_command()
+def api_information(auth_token, repo_name, issue_number):
+  """Comments the api information on the pr"""
+
+  gradle.run('apiInformation')
+  gradle.run('generateApiTxtFile')
+  dir_suffix = 'build/apiinfo'
+  comment_string = ""
+  for filename in os.listdir(dir_suffix):
+    subproject = filename
+    formatted_output_lines = []
+    with open(os.path.join(dir_suffix, filename), 'r') as f:
+      outputlines = f.readlines()
+      for line in outputlines:
+        if 'error' in line:
+          formatted_output_lines.append(line[line.find('error:'):])
+    if formatted_output_lines:
+      comment_string += 'The public api surface has changed for the subproject {}:\n'.format(subproject[len('subproject:'):])
+      comment_string += ''.join(formatted_output_lines)
+      comment_string += '\n'
+  if comment_string:
+    comment_string += ('Please update the api.txt files for the subprojects being affected by this change '
+      'with the files present in the artifacts directory. Also perform a major/minor bump accordingly.\n')
+  else:
+    comment_string = 'No project\'s public api surface was changed due to this PR.\n'
+  # Comment to github.
+  github_client = Github(auth_token)
+  repo = github_client.get_repo(repo_name)
+  pr = repo.get_pull(int(issue_number))
+  pr.create_issue_comment(comment_string)

ci/fireci/setup.py

@@ -28,6 +28,7 @@
         'click==7.0',
         'opencensus==0.2.0',
         'google-cloud-monitoring==0.31.1',
+        'PyGithub==1.43.8'
     ],
     packages=find_packages(exclude=['tests']),
     entry_points={

firebase-abt/api.txt

@@ -0,0 +1 @@
+// Signature format: 2.0

firebase-abt/baseline.txt

@@ -0,0 +1 @@
+// Baseline format: 1.0