Update plugin

Author: emilypgoogle

.github/workflows/unit-test-report.yml

@@ -1,4 +1,4 @@
-name: Firebase AI Daily Tests
+name: Generate Test Report
 
 on:
   schedule:
@@ -10,8 +10,8 @@ permissions:
   issues: write
 
 jobs:
-  dailies:
-    name: "Unit Test Report"
+  report:
+    name: "Generate Test Report"
     runs-on: ubuntu-latest
 
     steps:

build.gradle.kts

@@ -23,6 +23,7 @@ plugins {
   alias(libs.plugins.errorprone)
   alias(libs.plugins.crashlytics) apply false
   id("PublishingPlugin")
+  id("test-report")
   id("firebase-ci")
   id("smoke-tests")
   alias(libs.plugins.google.services)

plugins/build.gradle.kts

@@ -114,6 +114,10 @@ gradlePlugin {
       id = "copy-google-services"
       implementationClass = "com.google.firebase.gradle.plugins.CopyGoogleServicesPlugin"
     }
+    register("testReportPlugin") {
+      id = "test-report"
+      implementationClass = "com.google.firebase.gradle.plugins.report.UnitTestReportPlugin"
+    }
   }
 }
 

plugins/src/main/java/com/google/firebase/gradle/plugins/BaseFirebaseLibraryPlugin.kt

@@ -18,7 +18,6 @@ package com.google.firebase.gradle.plugins
 
 import com.android.build.gradle.LibraryExtension
 import com.google.firebase.gradle.plugins.ci.Coverage
-import com.google.firebase.gradle.plugins.report.UnitTestReportTask
 import com.google.firebase.gradle.plugins.services.GMavenService
 import java.io.File
 import java.nio.file.Paths
@@ -142,13 +141,6 @@ abstract class BaseFirebaseLibraryPlugin : Plugin<Project> {
     }
   }
 
-  protected fun registerUnitTestReportTask(project: Project) =
-    project.tasks.register<UnitTestReportTask>("generateTestReport") {
-      outputFile.set(project.file("test-report.md"))
-      commitCount.set(8 as Integer)
-      apiToken.set(System.getenv("GH_TOKEN"))
-    }
-
   protected fun getApiInfo(
     project: Project,
     srcDirs: ConfigurableFileCollection,

plugins/src/main/java/com/google/firebase/gradle/plugins/FirebaseAndroidLibraryPlugin.kt

@@ -162,7 +162,6 @@ class FirebaseAndroidLibraryPlugin : BaseFirebaseLibraryPlugin() {
     }
 
     setupMetalavaSemver(project, firebaseLibrary)
-    registerUnitTestReportTask(project)
   }
 
   private fun setupApiInformationAnalysis(project: Project, android: LibraryExtension) {

plugins/src/main/java/com/google/firebase/gradle/plugins/FirebaseJavaLibraryPlugin.kt

@@ -105,7 +105,6 @@ class FirebaseJavaLibraryPlugin : BaseFirebaseLibraryPlugin() {
     }
 
     setupMetalavaSemver(project, firebaseLibrary)
-    registerUnitTestReportTask(project)
   }
 
   private fun setupApiInformationAnalysis(project: Project) {

plugins/src/main/java/com/google/firebase/gradle/plugins/report/UnitTestReport.kt

@@ -20,6 +20,7 @@ import com.google.gson.GsonBuilder
 import com.google.gson.JsonArray
 import com.google.gson.JsonElement
 import com.google.gson.JsonObject
+import java.io.File
 import java.io.FileWriter
 import java.io.IOException
 import java.net.URI
@@ -30,7 +31,6 @@ import java.time.Duration
 import java.util.regex.Matcher
 import java.util.regex.Pattern
 import org.gradle.internal.Pair
-import java.io.File
 
 @SuppressWarnings("NewApi")
 class UnitTestReport(private val apiToken: String) {

plugins/src/main/java/com/google/firebase/gradle/plugins/report/UnitTestReportPlugin.kt

@@ -0,0 +1,15 @@
+package com.google.firebase.gradle.plugins.report
+
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.gradle.kotlin.dsl.register
+
+class UnitTestReportPlugin : Plugin<Project> {
+  override fun apply(project: Project) {
+    project.tasks.register<UnitTestReportTask>("generateTestReport") {
+      outputFile.set(project.file("test-report.md"))
+      commitCount.set(8 as Integer)
+      apiToken.set(System.getenv("GH_TOKEN"))
+    }
+  }
+}

plugins/src/main/java/com/google/firebase/gradle/plugins/report/UnitTestReportTask.kt

@@ -22,7 +22,16 @@ import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.OutputFile
 import org.gradle.api.tasks.TaskAction
 
-abstract class UnitTestReportTask: DefaultTask() {
+/**
+ * Creates a markdown unit test report file based on recent runs of GitHub Actions. Task simply
+ * aggregates live test data and does not rely on the current state of the repository.
+ *
+ * @property outputFile The file path to output the markdown test report to.
+ * @property commitCount The number of remote commits to aggregate test results from.
+ * @property apiToken The GitHub API token with adequate permissions to read test result data and
+ *   execute GraphQL queries.
+ */
+abstract class UnitTestReportTask : DefaultTask() {
   @get:OutputFile abstract val outputFile: RegularFileProperty
 
   @get:Input abstract val commitCount: Property<Integer>