add gradle tasks for metalava generation #671

VinayGuthal · 2019-07-29T20:23:43Z

This pr does the following things. it provides two tasks

generateApiTxt task
This generates the api.txt file which can be used to generate api information in the future.
apiInformation task
This provides information about the public apis.
Adds the ci command to invoke the github rest api to post the comments of the results.

Additional context:
Baseline files are certain files which allows metalava to ignore the warnings present in these files. There is a system property updateBaseline which is added which allows us to control updation of the baseline file.

The last comment is how the output would look like

VinayGuthal · 2019-07-29T20:24:20Z

Can you guys have an initial look onto this pr

VinayGuthal · 2019-07-29T20:25:13Z

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

@@ -64,6 +69,21 @@ public void apply(Project project) {
                }
              });
    }
+    if(System.getenv().containsKey("METALAVA_BINARY_PATH")) {
+      String metalavaBinaryPath = System.getenv().get("METALAVA_BINARY_PATH");
+      String sourcePath = project.getProjectDir() + "/src/main/java";


probably needs different paths if its a kotlin project

This needs to be replaced with the variant-specific sourceSets collection: see https://android.googlesource.com/platform/frameworks/support/+/refs/heads/androidx-master-dev/buildSrc/src/main/kotlin/androidx/build/java/JavaCompileInputs.kt#43

Also note that they also setup classpath and bootClasspath, I think we need to do it too

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

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

VinayGuthal · 2019-07-31T19:54:28Z

This is a test comment

VinayGuthal · 2019-07-31T20:39:57Z

This is a test comment

VinayGuthal · 2019-08-01T01:04:04Z

This is a testing comment

VinayGuthal · 2019-08-01T01:14:04Z

�[34m _ _
_ __ ___ | | __ | | __ ___ ____ _
| ' _ \ / _ \ __/ _ | |/ \ \ / / _ |
| | | | | | __/ || (| | | (| |\ V / (| |
|| || ||___|__,||_,| _/ _,_|�[0m

�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/DocumentId.java:23: �[31merror: �[0mClass com.google.firebase.firestore.DocumentId no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/Exclude.java:23: �[31merror: �[0mClass com.google.firebase.firestore.Exclude no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/IgnoreExtraProperties.java:23: �[31merror: �[0mClass com.google.firebase.firestore.IgnoreExtraProperties no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/PropertyName.java:23: �[31merror: �[0mClass com.google.firebase.firestore.PropertyName no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/ServerTimestamp.java:23: �[31merror: �[0mClass com.google.firebase.firestore.ServerTimestamp no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/ThrowOnExtraProperties.java:23: �[31merror: �[0mClass com.google.firebase.firestore.ThrowOnExtraProperties no longer implements java.lang.annotation.Annotation [RemovedInterface]

VinayGuthal · 2019-08-01T21:44:44Z

�[34m _ _
_ __ ___ | | __ | | __ ___ ____ _
| ' _ \ / _ \ __/ _ | |/ \ \ / / _ |
| | | | | | __/ || (| | | (| |\ V / (| |
|| || ||___|__,||_,| _/ _,_|�[0m

�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/DocumentId.java:23: �[31merror: �[0mClass com.google.firebase.firestore.DocumentId no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/Exclude.java:23: �[31merror: �[0mClass com.google.firebase.firestore.Exclude no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/IgnoreExtraProperties.java:23: �[31merror: �[0mClass com.google.firebase.firestore.IgnoreExtraProperties no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/PropertyName.java:23: �[31merror: �[0mClass com.google.firebase.firestore.PropertyName no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/ServerTimestamp.java:23: �[31merror: �[0mClass com.google.firebase.firestore.ServerTimestamp no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/ThrowOnExtraProperties.java:23: �[31merror: �[0mClass com.google.firebase.firestore.ThrowOnExtraProperties no longer implements java.lang.annotation.Annotation [RemovedInterface]

VinayGuthal · 2019-08-01T22:09:26Z

�[34m _ _
_ __ ___ | | __ | | __ ___ ____ _
| ' _ \ / _ \ __/ _ | |/ \ \ / / _ |
| | | | | | __/ || (| | | (| |\ V / (| |
|| || ||___|__,||_,| _/ _,_|�[0m

�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/DocumentId.java:23: �[31merror: �[0mClass com.google.firebase.firestore.DocumentId no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/Exclude.java:23: �[31merror: �[0mClass com.google.firebase.firestore.Exclude no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/IgnoreExtraProperties.java:23: �[31merror: �[0mClass com.google.firebase.firestore.IgnoreExtraProperties no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/PropertyName.java:23: �[31merror: �[0mClass com.google.firebase.firestore.PropertyName no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/ServerTimestamp.java:23: �[31merror: �[0mClass com.google.firebase.firestore.ServerTimestamp no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/ThrowOnExtraProperties.java:23: �[31merror: �[0mClass com.google.firebase.firestore.ThrowOnExtraProperties no longer implements java.lang.annotation.Annotation [RemovedInterface]

VinayGuthal · 2019-08-06T14:39:47Z

�[34m _ _
_ __ ___ | | __ | | __ ___ ____ _
| ' _ \ / _ \ __/ _ | |/ \ \ / / _ |
| | | | | | __/ || (| | | (| |\ V / (| |
|| || ||___|__,||_,| _/ _,_|�[0m

�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/DocumentId.java:23: �[31merror: �[0mClass com.google.firebase.firestore.DocumentId no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/Exclude.java:23: �[31merror: �[0mClass com.google.firebase.firestore.Exclude no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/IgnoreExtraProperties.java:23: �[31merror: �[0mClass com.google.firebase.firestore.IgnoreExtraProperties no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/PropertyName.java:23: �[31merror: �[0mClass com.google.firebase.firestore.PropertyName no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/ServerTimestamp.java:23: �[31merror: �[0mClass com.google.firebase.firestore.ServerTimestamp no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/ThrowOnExtraProperties.java:23: �[31merror: �[0mClass com.google.firebase.firestore.ThrowOnExtraProperties no longer implements java.lang.annotation.Annotation [RemovedInterface]

VinayGuthal · 2019-08-06T14:41:27Z

�[34m _ _
_ __ ___ | | __ | | __ ___ ____ _
| ' _ \ / _ \ __/ _ | |/ \ \ / / _ |
| | | | | | __/ || (| | | (| |\ V / (| |
|| || ||___|__,||_,| _/ _,_|�[0m

�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/DocumentId.java:23: �[31merror: �[0mClass com.google.firebase.firestore.DocumentId no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/Exclude.java:23: �[31merror: �[0mClass com.google.firebase.firestore.Exclude no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/IgnoreExtraProperties.java:23: �[31merror: �[0mClass com.google.firebase.firestore.IgnoreExtraProperties no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/PropertyName.java:23: �[31merror: �[0mClass com.google.firebase.firestore.PropertyName no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/ServerTimestamp.java:23: �[31merror: �[0mClass com.google.firebase.firestore.ServerTimestamp no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/ThrowOnExtraProperties.java:23: �[31merror: �[0mClass com.google.firebase.firestore.ThrowOnExtraProperties no longer implements java.lang.annotation.Annotation [RemovedInterface]

VinayGuthal · 2019-08-06T18:38:01Z

�[34m _ _
_ __ ___ | | __ | | __ ___ ____ _
| ' _ \ / _ \ __/ _ | |/ \ \ / / _ |
| | | | | | __/ || (| | | (| |\ V / (| |
|| || ||___|__,||_,| _/ _,_|�[0m

�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/DocumentId.java:23: �[31merror: �[0mClass com.google.firebase.firestore.DocumentId no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/Exclude.java:23: �[31merror: �[0mClass com.google.firebase.firestore.Exclude no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/IgnoreExtraProperties.java:23: �[31merror: �[0mClass com.google.firebase.firestore.IgnoreExtraProperties no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/PropertyName.java:23: �[31merror: �[0mClass com.google.firebase.firestore.PropertyName no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/ServerTimestamp.java:23: �[31merror: �[0mClass com.google.firebase.firestore.ServerTimestamp no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/ThrowOnExtraProperties.java:23: �[31merror: �[0mClass com.google.firebase.firestore.ThrowOnExtraProperties no longer implements java.lang.annotation.Annotation [RemovedInterface]

VinayGuthal · 2019-08-06T20:04:28Z

�[34m _ _
_ __ ___ | | __ | | __ ___ ____ _
| ' _ \ / _ \ __/ _ | |/ \ \ / / _ |
| | | | | | __/ || (| | | (| |\ V / (| |
|| || ||___|__,||_,| _/ _,_|�[0m

�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/DocumentId.java:23: �[31merror: �[0mClass com.google.firebase.firestore.DocumentId no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/Exclude.java:23: �[31merror: �[0mClass com.google.firebase.firestore.Exclude no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/IgnoreExtraProperties.java:23: �[31merror: �[0mClass com.google.firebase.firestore.IgnoreExtraProperties no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/PropertyName.java:23: �[31merror: �[0mClass com.google.firebase.firestore.PropertyName no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/ServerTimestamp.java:23: �[31merror: �[0mClass com.google.firebase.firestore.ServerTimestamp no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/ThrowOnExtraProperties.java:23: �[31merror: �[0mClass com.google.firebase.firestore.ThrowOnExtraProperties no longer implements java.lang.annotation.Annotation [RemovedInterface]

VinayGuthal · 2019-08-06T20:05:16Z

�[34m _ _
_ __ ___ | | __ | | __ ___ ____ _
| ' _ \ / _ \ __/ _ | |/ \ \ / / _ |
| | | | | | __/ || (| | | (| |\ V / (| |
|| || ||___|__,||_,| _/ _,_|�[0m

�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/DocumentId.java:23: �[31merror: �[0mClass com.google.firebase.firestore.DocumentId no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/Exclude.java:23: �[31merror: �[0mClass com.google.firebase.firestore.Exclude no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/IgnoreExtraProperties.java:23: �[31merror: �[0mClass com.google.firebase.firestore.IgnoreExtraProperties no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/PropertyName.java:23: �[31merror: �[0mClass com.google.firebase.firestore.PropertyName no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/ServerTimestamp.java:23: �[31merror: �[0mClass com.google.firebase.firestore.ServerTimestamp no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/ThrowOnExtraProperties.java:23: �[31merror: �[0mClass com.google.firebase.firestore.ThrowOnExtraProperties no longer implements java.lang.annotation.Annotation [RemovedInterface]

VinayGuthal · 2019-08-06T20:06:15Z

�[34m _ _
_ __ ___ | | __ | | __ ___ ____ _
| ' _ \ / _ \ __/ _ | |/ \ \ / / _ |
| | | | | | __/ || (| | | (| |\ V / (| |
|| || ||___|__,||_,| _/ _,_|�[0m

�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/DocumentId.java:23: �[31merror: �[0mClass com.google.firebase.firestore.DocumentId no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/Exclude.java:23: �[31merror: �[0mClass com.google.firebase.firestore.Exclude no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/IgnoreExtraProperties.java:23: �[31merror: �[0mClass com.google.firebase.firestore.IgnoreExtraProperties no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/PropertyName.java:23: �[31merror: �[0mClass com.google.firebase.firestore.PropertyName no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/ServerTimestamp.java:23: �[31merror: �[0mClass com.google.firebase.firestore.ServerTimestamp no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/ThrowOnExtraProperties.java:23: �[31merror: �[0mClass com.google.firebase.firestore.ThrowOnExtraProperties no longer implements java.lang.annotation.Annotation [RemovedInterface]

VinayGuthal · 2019-08-06T21:30:48Z

�[34m _ _
_ __ ___ | | __ | | __ ___ ____ _
| ' _ \ / _ \ __/ _ | |/ \ \ / / _ |
| | | | | | __/ || (| | | (| |\ V / (| |
|| || ||___|__,||_,| _/ _,_|�[0m

�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/DocumentId.java:23: �[31merror: �[0mClass com.google.firebase.firestore.DocumentId no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/Exclude.java:23: �[31merror: �[0mClass com.google.firebase.firestore.Exclude no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/IgnoreExtraProperties.java:23: �[31merror: �[0mClass com.google.firebase.firestore.IgnoreExtraProperties no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/PropertyName.java:23: �[31merror: �[0mClass com.google.firebase.firestore.PropertyName no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/ServerTimestamp.java:23: �[31merror: �[0mClass com.google.firebase.firestore.ServerTimestamp no longer implements java.lang.annotation.Annotation [RemovedInterface]
�[1m/usr/local/google/home/vguthal/firebase-android-sdk/firebase-firestore/src/main/java/com/google/firebase/firestore/ThrowOnExtraProperties.java:23: �[31merror: �[0mClass com.google.firebase.firestore.ThrowOnExtraProperties no longer implements java.lang.annotation.Annotation [RemovedInterface]

VinayGuthal · 2019-08-07T19:48:03Z

This is a test comment

VinayGuthal · 2019-08-07T19:49:59Z

This is a test comment

VinayGuthal · 2019-08-07T19:56:02Z

This is a test comment

VinayGuthal · 2019-08-07T19:56:15Z

This is a test comment

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

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

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

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

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

ci/fireci/fireci/commands.py

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

ci/fireci/fireci/commands.py

VinayGuthal · 2019-08-08T20:34:22Z

No project's public api surface was changed due to this PR.

VinayGuthal · 2019-08-09T17:48:04Z

The public api surface has changed for the subproject firebase-database:
error: Added class com.google.firebase.database.DataSnapshot [AddedClass]

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.

VinayGuthal · 2019-08-09T17:49:04Z

The public api surface has changed for the subproject firebase-firestore:
error: Removed method com.google.firebase.firestore.DocumentChange.val(Object) [RemovedMethod]

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.

VinayGuthal · 2019-08-09T18:00:13Z

/retest

vkryachko · 2019-08-09T18:22:36Z

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

+    if (System.getenv().containsKey("METALAVA_BINARY_PATH")) {
+      String metalavaBinaryPath = System.getenv("METALAVA_BINARY_PATH");
+      AndroidSourceSet mainSourceSet = android.getSourceSets().getByName("main");
+      File apiTxtFile = new File(project.getProjectDir() + "/api.txt");


You can replace this with project.file("api.txt"), and maybe inline it?

vkryachko · 2019-08-09T18:23:10Z

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

+      String metalavaBinaryPath = System.getenv("METALAVA_BINARY_PATH");
+      AndroidSourceSet mainSourceSet = android.getSourceSets().getByName("main");
+      File apiTxtFile = new File(project.getProjectDir() + "/api.txt");
+      File baseLineFile = new File(project.getProjectDir() + "/baseline.txt");


What's the purpose of baseline.txt? it seems to be empty, also why is it's version declared as 1.0, while api.txt is declared as 2.0?

Baseline files are certain files which allows metalava to ignore the warnings present in these files. There is a system property updateBaseline which is added which allows us to control updation of the baseline file.

These files are empty for some sdks whereas its not for firestore, common and other sdks

vkryachko · 2019-08-09T18:27:17Z

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

+      AndroidSourceSet mainSourceSet = android.getSourceSets().getByName("main");
+      File apiTxtFile = new File(project.getProjectDir() + "/api.txt");
+      File baseLineFile = new File(project.getProjectDir() + "/baseline.txt");
+      File outputFile = new File(project.getRootProject().getBuildDir() + "/apiinfo/" + project.getPath().substring(1).replace(":", "_"));


project.getRootProject().file(Paths.get( project.getRootProject().buildDir().getPath(), "apiinfo", project.getPath().substring(1).replace(":", "_")));

vkryachko · 2019-08-09T18:28:02Z

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

+      File baseLineFile = new File(project.getProjectDir() + "/baseline.txt");
+      File outputFile = new File(project.getRootProject().getBuildDir() + "/apiinfo/" + project.getPath().substring(1).replace(":", "_"));
+      File outputFileDir = outputFile.getParentFile();
+      if(!outputFileDir.exists()) {


You should move it into the task action so that this does not happen if the task is not executed.

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

VinayGuthal · 2019-08-09T19:18:54Z

/retest

ashwinraghav · 2019-08-09T19:39:49Z

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

+      File baseLineFile = new File(project.getProjectDir() + "/baseline.txt");
+      File outputFile = new File(project.getRootProject().getBuildDir() + "/apiinfo/" + project.getPath().substring(1).replace(":", "_"));
+      File outputFileDir = outputFile.getParentFile();
+      if(!outputFileDir.exists()) {


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

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

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

VinayGuthal · 2019-08-09T20:10:28Z

The public api surface has changed for the subproject firebase-firestore:
error: Added method com.google.firebase.firestore.CollectionReference.add(Object) [AddedMethod]
error: Added method com.google.firebase.firestore.DocumentChange.equals(Object) [AddedMethod]
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.

VinayGuthal · 2019-08-09T20:14:15Z

The public api surface has changed for the subproject firebase-database:
error: Added class com.google.firebase.database.ChildEventListener [AddedInterface]
error: Added class com.google.firebase.database.DatabaseException [AddedClass]

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.

ashwinraghav · 2019-08-09T20:26:34Z

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

+        }
+        String cmdTemplate = "%s --source-path %s --check-compatibility:api:current %s --format=v2 --baseline %s --no-color";
+        if(getUpdateBaseline()) {
+            cmdTemplate = "%s --source-path %s --check-compatibility:api:current %s --format=v2 --update-baseline %s --no-color";


IMO, there is a lot of boilerplate here that comes down to 2 commands and their respective arguments.

%s --source-path %s --api %s --format=v2 --baseline %s

"%s --source-path %s --check-compatibility:api:current %s --format=v2 --update-baseline %s --no-color";

I think we can remove some cruft by modelling this as

// This task executes in 2 modes. // 1. Generate api text mode // 2. Compare api text mode public abstract class MetalavaExecutionTask extends DefaultTask { @Input abstract String getMetalavaBinaryPath(); @InputFile abstract File getApiTxt(); @Input abstract String getSourcePath(); @InputFile abstract File getBaselineFile(); @Input abstract boolean getUpdateBaseline(); @Input abstract enum getMode(); @OutputFile abstract File getOutputFile(); abstract void setSourcePath(String value); abstract void setBaselineFile(File value); abstract void setUpdateBaseline(boolean value); abstract void setMetalavaBinaryPath(String value); abstract void setApiTxt(File value); abstract void setOutputFile(File value); abstract void setMode(Mode mode); private static enum Mode { GENERATE, COMPARE } @TaskAction void execute() { File outputFileDir = getOutputFile().getParentFile(); if(!outputFileDir.exists()) { outputFileDir.mkdirs(); } String cmd = mode == Mode.GENERATE ? "--check-compatibility:api:current %s" : "--api %s" String baseline = "--baseline %s" : "--update-baseline %s" String format = "--format=v2" String sourcePath = "--source-path %s" String cmdTemplate = ["%s", sourcePath, cmd, baselineArg, "--no-color"].join(" ") String cmdToRun = String.format(cmdTemplate, getMetalavaBinaryPath(), getSourcePath(), getApiTxt().getAbsolutePath(), getBaselineFile().getAbsolutePath()); getProject().exec(spec-> { spec.setCommandLine(Arrays.asList(cmdToRun.split(" "))); try { spec.setStandardOutput(new FileOutputStream(getOutputFile())); } catch (FileNotFoundException e) { getLogger().error(e.toString()); } }); } }

in the ci command we would need to run the task to getApiInformation
and then run the task to generateApiInformation in this order
so we would need two tasks. However we can merge the two task classes into one though

And there is no purpose of outputFile in the generateApiInformation Task

The structure of the second task has changed now. It involves producing the api.txt file and then comparing the already existing api.txt with that. I feel now the structure of the two tasks are fairly different

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

vkryachko · 2019-08-12T14:03:22Z

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

+      }
+      if(doesSourcePathExist) {
+        project.getTasks().register("apiInformation", ApiInformationTask.class, task -> {
+          task.setProperty("apiTxt", project.file("api.txt"));


prefer using setters directly instead of using this "reflective magic".(here and below)

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

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

firebase-database/baseline.txt

firebase-firestore/baseline.txt

firebase-storage/baseline.txt

vkryachko · 2019-08-12T14:22:05Z

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

+            outputFileDir.mkdirs();
+        }
+        String cmdTemplate = getUpdateBaseline() ?
+                "%s --source-path %s --check-compatibility:api:current %s --format=v2 --update-baseline %s --no-color"


As I mentioned before you are still not populating the classpath

VinayGuthal · 2019-08-14T17:56:29Z

The public api surface has changed for the subproject firebase-common:
error: Class com.google.firebase.FirebaseNetworkException superclass changed from com.google.firebase.FirebaseException to java.lang.Object [ChangedSuperclass]
error: Class com.google.firebase.FirebaseTooManyRequestsException superclass changed from com.google.firebase.FirebaseException to java.lang.Object [ChangedSuperclass]metalava wrote updated baseline to /usr/local/google/home/vguthal/firebase-android-sdk/firebase-common/baseline.txt

The public api surface has changed for the subproject firebase-database:
error: Added class com.google.firebase.database.DataSnapshot [AddedClass]metalava wrote updated baseline to /usr/local/google/home/vguthal/firebase-android-sdk/firebase-database/baseline.txt

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.

VinayGuthal · 2019-08-14T18:49:28Z

The public api surface has changed for the subproject firebase-database:
warning: Added method com.google.firebase.database.ChildEventListener.onChildRemoved(com.google.firebase.database.DataSnapshot) [AddedAbstractMethod]

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.

VinayGuthal · 2019-08-14T19:19:48Z

/test device-check-changed

vkryachko · 2019-08-14T20:00:29Z

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

+    boolean doesSourcePathExist = false;
+    for(String sourcePath : sourcePathArgument.split(":")) {
+      if(new File(sourcePath).exists()) {
+        doesSourcePathExist = true;


I think you can replace this for loop with mainSourceSet.getJava().getSrcDirs().stream().anyMatch(File::exists)

VinayGuthal · 2019-08-20T16:12:16Z

The public api surface has changed for the subproject firebase-firestore:
error: Removed class com.google.firebase.firestore.FirebaseFirestore.InstanceRegistry [RemovedInterface]

The public api surface has changed for the subproject firebase-common:
error: Added field com.google.firebase.FirebaseApp.vinay [AddedField]
error: Added field com.google.firebase.FirebaseApp.vinay1 [AddedField]

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

VinayGuthal · 2019-08-20T16:16:14Z

The public api surface has changed for the subproject firebase-firestore:
error: Removed class com.google.firebase.firestore.FirebaseFirestore.InstanceRegistry [RemovedInterface]

The public api surface has changed for the subproject firebase-common:
error: Added field com.google.firebase.FirebaseApp.vinay [AddedField]
error: Added field com.google.firebase.FirebaseApp.vinay1 [AddedField]

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

VinayGuthal · 2019-08-20T17:07:28Z

The public api surface has changed for the subproject firebase-firestore:
error: Removed class com.google.firebase.firestore.FirebaseFirestore.InstanceRegistry [RemovedInterface]

The public api surface has changed for the subproject firebase-common:
error: Added field com.google.firebase.FirebaseApp.vinay [AddedField]
error: Added field com.google.firebase.FirebaseApp.vinay1 [AddedField]

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

add gradle tasks for metalava generation

8016d4b

googlebot added the cla: yes Override cla label Jul 29, 2019

google-oss-bot added the size/XL label Jul 29, 2019

VinayGuthal requested review from vkryachko and ashwinraghav July 29, 2019 20:24

VinayGuthal commented Jul 29, 2019

View reviewed changes

vkryachko requested changes Jul 30, 2019

View reviewed changes

buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/apiinfo/ApiInformationTask.groovy Outdated Show resolved Hide resolved

buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/apiinfo/GenerateApiTask.groovy Outdated Show resolved Hide resolved

Address all comments and have the tasks running

48acad3

google-oss-bot added size/XXL and removed size/XL labels Aug 7, 2019

VinayGuthal added 2 commits August 7, 2019 14:50

Merge branch 'master' into add_metalava_api_txt

b68fd6b

fix merge conflict

a46fa94

vkryachko requested changes Aug 8, 2019

View reviewed changes

vkryachko reviewed Aug 8, 2019

View reviewed changes

ci/fireci/fireci/commands.py Outdated Show resolved Hide resolved

VinayGuthal added 2 commits August 9, 2019 13:53

add fireci commands

1e6c7ac

remove the unwanted task

9023cd7

vkryachko requested changes Aug 9, 2019

View reviewed changes

google java format

c998f48

ashwinraghav reviewed Aug 9, 2019

View reviewed changes

address all comments

6be28ef

ashwinraghav reviewed Aug 9, 2019

View reviewed changes

vkryachko requested changes Aug 12, 2019

View reviewed changes

VinayGuthal added 2 commits August 14, 2019 14:36

update commands

6d334a9

remove unneccasry baselines

82e2fe4

vkryachko approved these changes Aug 14, 2019

View reviewed changes

small updates

d8ed638

VinayGuthal merged commit eab54ce into master Aug 14, 2019

VinayGuthal deleted the add_metalava_api_txt branch August 14, 2019 21:07

firebase locked and limited conversation to collaborators Oct 8, 2019

add gradle tasks for metalava generation #671

add gradle tasks for metalava generation #671

Uh oh!

Conversation

VinayGuthal commented Jul 29, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

VinayGuthal commented Jul 29, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vkryachko Jul 30, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

VinayGuthal commented Jul 31, 2019

Uh oh!

VinayGuthal commented Jul 31, 2019

Uh oh!

VinayGuthal commented Aug 1, 2019

Uh oh!

VinayGuthal commented Aug 1, 2019

Uh oh!

VinayGuthal commented Aug 1, 2019

Uh oh!

VinayGuthal commented Aug 1, 2019

Uh oh!

VinayGuthal commented Aug 6, 2019

Uh oh!

VinayGuthal commented Aug 6, 2019

Uh oh!

VinayGuthal commented Aug 6, 2019

Uh oh!

VinayGuthal commented Aug 6, 2019

Uh oh!

VinayGuthal commented Aug 6, 2019

Uh oh!

VinayGuthal commented Aug 6, 2019

Uh oh!

VinayGuthal commented Aug 6, 2019

Uh oh!

VinayGuthal commented Aug 7, 2019

Uh oh!

VinayGuthal commented Aug 7, 2019

Uh oh!

VinayGuthal commented Aug 7, 2019

Uh oh!

VinayGuthal commented Aug 7, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

VinayGuthal commented Aug 8, 2019

Uh oh!

VinayGuthal commented Aug 9, 2019

Uh oh!

VinayGuthal commented Aug 9, 2019

Uh oh!

VinayGuthal commented Aug 9, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

VinayGuthal commented Jul 29, 2019 •

edited

Loading

vkryachko Jul 30, 2019 •

edited

Loading