Added support for Android (not KMP) projects KRPC-203

Author: Mr3zee

gradle-plugin/build.gradle.kts

@@ -31,6 +31,7 @@ tasks.withType<KotlinCompile>().configureEach {
 dependencies {
     compileOnly(libs.kotlin.gradle.plugin)
     compileOnly(libs.android.gradle.plugin)
+    compileOnly(libs.android.gradle.plugin.api)
 
     testImplementation(libs.kotlin.gradle.plugin)
     testImplementation(gradleTestKit())

gradle-plugin/src/main/kotlin/kotlinx/rpc/Extensions.kt

@@ -83,14 +83,13 @@ public open class RpcExtension @Inject internal constructor(objects: ObjectFacto
     internal val protocApplied = AtomicBoolean(false)
 
     internal val protocInternal by lazy {
-        if (protocApplied.get()) {
+        if (protocApplied.compareAndSet(false, true)) {
+            objects.newInstance<DefaultProtocExtension>().apply {
+                callbacks.forEach { it.execute(this) }
+            }
+        } else {
             error("Illegal access to protoc extension during DefaultProtocExtension.init")
         }
-
-        protocApplied.set(true)
-        objects.newInstance<DefaultProtocExtension>().apply {
-            callbacks.forEach { it.execute(this) }
-        }
     }
 
     private val callbacks = mutableListOf<Action<ProtocExtension>>()

gradle-plugin/src/main/kotlin/kotlinx/rpc/buf/tasks/BufExecTask.kt

@@ -4,6 +4,7 @@
 
 package kotlinx.rpc.buf.tasks
 
+import com.android.build.api.variant.Variant
 import kotlinx.rpc.buf.BUF_EXECUTABLE_CONFIGURATION
 import kotlinx.rpc.buf.BufExtension
 import kotlinx.rpc.buf.execBuf
@@ -29,20 +30,31 @@ import kotlinx.rpc.buf.BufTasksExtension
 import org.gradle.api.logging.LogLevel
 import org.gradle.api.provider.SetProperty
 import org.gradle.api.tasks.Classpath
+import org.gradle.api.tasks.InputFiles
 import org.gradle.api.tasks.Internal
+import org.gradle.api.tasks.SkipWhenEmpty
 import javax.inject.Inject
 
 /**
  * Abstract base class for `buf` tasks.
  */
 public abstract class BufExecTask @Inject constructor(
     @Internal
-    public val properties: Properties
+    public val properties: Properties,
 ) : DefaultTask() {
     init {
         group = PROTO_GROUP
     }
 
+    // unsued, but required for Gradle to properly recognise inputs
+    @get:InputFiles
+    @get:SkipWhenEmpty
+    internal abstract val protoFiles: ListProperty<File>
+
+    // unsued, but required for Gradle to properly recognise inputs
+    @get:InputFiles
+    internal abstract val importProtoFiles: ListProperty<File>
+
     // list of buf task dependencies of the same type
     @get:Internal
     internal abstract val bufTaskDependencies: SetProperty<String>
@@ -78,17 +90,33 @@ public abstract class BufExecTask @Inject constructor(
         isTest: Boolean,
         sourceSetName: String,
         /**
-         * Name of the android flavor this task is associated with.
+         * Name of the android flavors this task is associated with.
+         *
+         * @see [Variant.productFlavors]
          */
-        public val flavor: String,
+        public val flavors: List<String>,
         /**
          * Name of the android build type this task is associated with.
+         *
+         * @see Variant.buildType
          */
-        public val buildType: String,
+        public val buildType: String?,
         /**
          * Name of the android variant this task is associated with.
+         *
+         * @see Variant.name
          */
         public val variant: String,
+
+        /**
+         * Whether the task is for instrumentation tests.
+         */
+        public val isAndroidTest: Boolean,
+
+        /**
+         * Whether the task is for unit tests.
+         */
+        public val isUnitTest: Boolean,
     ) : Properties(isTest, sourceSetName)
 
     /**
@@ -164,8 +192,8 @@ internal fun <T : BufExecTask> Project.registerBufExecTask(
     configuration: T.() -> Unit = {},
 ): TaskProvider<T> = tasks.register(name, clazz, properties).apply {
     configure {
-        val executableConfiguration = configurations.getByName(BUF_EXECUTABLE_CONFIGURATION)
-        bufExecutable.set(executableConfiguration.singleFile)
+        val executableConfiguration = configurations.named(BUF_EXECUTABLE_CONFIGURATION)
+        bufExecutable.set(project.provider { executableConfiguration.get().singleFile })
         this.workingDir.set(workingDir)
 
         val buf = provider { rpcExtension().protoc.get().buf }

gradle-plugin/src/main/kotlin/kotlinx/rpc/buf/tasks/BufGenerateTask.kt

@@ -16,8 +16,15 @@ import org.gradle.api.tasks.OutputDirectory
 import org.gradle.api.tasks.TaskProvider
 import java.io.File
 import kotlinx.rpc.buf.BufGenerateExtension
+import kotlinx.rpc.protoc.DefaultProtoSourceSet
+import kotlinx.rpc.protoc.bufExecProperties
+import org.gradle.api.file.SourceDirectorySet
+import org.gradle.api.provider.Provider
 import org.gradle.api.tasks.InputDirectory
 import org.gradle.api.tasks.InputFiles
+import org.gradle.api.tasks.OutputDirectories
+import org.gradle.api.tasks.SkipWhenEmpty
+import org.gradle.kotlin.dsl.listProperty
 import javax.inject.Inject
 
 /**
@@ -26,16 +33,12 @@ import javax.inject.Inject
  * @see <a href="https://buf.build/docs/reference/cli/buf/generate/">buf generate</a>
  */
 public abstract class BufGenerateTask @Inject internal constructor(properties: Properties) : BufExecTask(properties) {
-    // unsued, but required for Gradle to properly recognise inputs
-    @get:InputDirectory
-    internal abstract val protoFilesDir: Property<File>
-
-    // unsued, but required for Gradle to properly recognise inputs
-    @get:InputDirectory
-    internal abstract val importFilesDir: Property<File>
+    // used to properly calculate output directories
+    @get:Input
+    internal abstract val pluginNames: ListProperty<String>
 
     /**
-     * List of files used during `buf generate` command execution.
+     * List of executable files used during `buf generate` command execution.
      *
      * @see [ProtocPlugin.Artifact.Local.executableFiles]
      */
@@ -82,11 +85,22 @@ public abstract class BufGenerateTask @Inject internal constructor(properties: P
     public abstract val additionalArgs: ListProperty<String>
 
     /**
-     * The directory to output generated files.
+     * The directory to output generated files to, used as a `buf generate --output` argument,
+     * not the directory for sources. For that see [outputSourceDirectories].
      */
     @get:OutputDirectory
     public abstract val outputDirectory: Property<File>
 
+    private val outputSourceDirectoriesInternal: ListProperty<File> = project.objects.listProperty()
+
+    /**
+     * Generated source directories by plugin name.
+     *
+     * Can be used in [SourceDirectorySet.srcDirs].
+     */
+    @get:OutputDirectories
+    public val outputSourceDirectories: Provider<List<File>> = outputSourceDirectoriesInternal
+
     init {
         command.set("generate")
 
@@ -110,6 +124,11 @@ public abstract class BufGenerateTask @Inject internal constructor(properties: P
         }
 
         this.args.set(args)
+
+        outputSourceDirectoriesInternal.set(pluginNames.map { plugins ->
+            val out = outputDirectory.get()
+            plugins.map { out.resolve(it) }
+        })
     }
 
     internal companion object {
@@ -118,20 +137,16 @@ public abstract class BufGenerateTask @Inject internal constructor(properties: P
 }
 
 internal fun Project.registerBufGenerateTask(
-    sourceSetName: String,
+    protoSourceSet: DefaultProtoSourceSet,
     workingDir: File,
     outputDirectory: File,
-    protoFilesDir: File,
-    importFilesDir: File,
+    includedPlugins: Provider<Set<ProtocPlugin>>,
     configure: BufGenerateTask.() -> Unit = {},
 ): TaskProvider<BufGenerateTask> {
-    val capitalName = sourceSetName.replaceFirstChar { it.uppercase() }
+    val capitalName = protoSourceSet.name.replaceFirstChar { it.uppercase() }
     val bufGenerateTaskName = "${BufGenerateTask.NAME_PREFIX}$capitalName"
 
-    val properties = BufExecTask.Properties(
-        isTest = sourceSetName.lowercase().endsWith("test"),
-        sourceSetName = sourceSetName,
-    )
+    val properties = protoSourceSet.bufExecProperties()
 
     return registerBufExecTask<BufGenerateTask>(bufGenerateTaskName, provider { workingDir }, properties) {
         group = PROTO_GROUP
@@ -145,8 +160,7 @@ internal fun Project.registerBufGenerateTask(
 
         this.outputDirectory.set(outputDirectory)
 
-        this.protoFilesDir.set(protoFilesDir)
-        this.importFilesDir.set(importFilesDir)
+        this.pluginNames.set(includedPlugins.map { it.map { plugin -> plugin.name } })
 
         configure()
     }

gradle-plugin/src/main/kotlin/kotlinx/rpc/buf/tasks/BufTasks.kt

@@ -333,7 +333,35 @@ public sealed interface BufTasks<BufTask : BufExecTask> : TaskCollection<BufTask
     // android
 
     /**
-     * Filters tasks by where [BufExecTask.AndroidProperties.flavor] matches the given flavor.
+     * Android only.
+     *
+     * Filters tasks by where [BufExecTask.AndroidProperties.isUnitTest] is `true`.
+     *
+     * ```kotlin
+     * rpc.protoc {
+     *     buf.tasks.all().unitTestTasks()
+     * }
+     * ```
+     */
+    public fun unitTestTasks(): BufTasks<BufTask>
+
+    /**
+     * Android only.
+     *
+     * Filters tasks by where [BufExecTask.AndroidProperties.isAndroidTest] is `true`.
+     *
+     * ```kotlin
+     * rpc.protoc {
+     *     buf.tasks.all().androidTestTasks()
+     * }
+     * ```
+     */
+    public fun androidTestTasks(): BufTasks<BufTask>
+
+    /**
+     * Android only.
+     *
+     * Filters tasks by where [BufExecTask.AndroidProperties.flavors] matches the given flavor.
      *
      * Only returns Android tasks.
      *
@@ -346,6 +374,8 @@ public sealed interface BufTasks<BufTask : BufExecTask> : TaskCollection<BufTask
     public fun matchingFlavor(flavor: String): BufTasks<BufTask>
 
     /**
+     * Android only.
+     *
      * Filters tasks by where [BufExecTask.AndroidProperties.buildType] matches the given buildType.
      *
      * Only returns Android tasks.
@@ -356,9 +386,11 @@ public sealed interface BufTasks<BufTask : BufExecTask> : TaskCollection<BufTask
      * }
      * ```
      */
-    public fun matchingBuildType(buildType: String): BufTasks<BufTask>
+    public fun matchingBuildType(buildType: String?): BufTasks<BufTask>
 
     /**
+     * Android only.
+     *
      * Filters tasks by where [BufExecTask.AndroidProperties.variant] matches the given variant.
      *
      * Only returns Android tasks.
@@ -532,21 +564,53 @@ internal open class BufTasksImpl<BufTask : BufExecTask> internal constructor(
         return BufTasksImpl(project, collection.matching { !it.properties.isTest }, kClass)
     }
 
+    override fun unitTestTasks(): BufTasks<BufTask> {
+        return BufTasksImpl(
+            project = project,
+            collection = collection.matching {
+                val properties = it.properties as? BufExecTask.AndroidProperties
+                    ?: return@matching false
+
+                properties.isUnitTest
+            },
+            kClass = kClass,
+        )
+    }
+
+    override fun androidTestTasks(): BufTasks<BufTask> {
+        return BufTasksImpl(
+            project = project,
+            collection = collection.matching {
+                val properties = it.properties as? BufExecTask.AndroidProperties
+                    ?: return@matching false
+
+                properties.isAndroidTest
+            },
+            kClass = kClass,
+        )
+    }
+
     override fun matchingFlavor(flavor: String): BufTasks<BufTask> {
         return BufTasksImpl(
             project = project,
             collection = collection.matching {
-                (it.properties as? BufExecTask.AndroidProperties)?.flavor == flavor
+                val properties = it.properties as? BufExecTask.AndroidProperties
+                    ?: return@matching false
+
+                properties.flavors.contains(flavor)
             },
             kClass = kClass,
         )
     }
 
-    override fun matchingBuildType(buildType: String): BufTasks<BufTask> {
+    override fun matchingBuildType(buildType: String?): BufTasks<BufTask> {
         return BufTasksImpl(
             project = project,
             collection = collection.matching {
-                (it.properties as? BufExecTask.AndroidProperties)?.buildType == buildType
+                val properties = it.properties as? BufExecTask.AndroidProperties
+                    ?: return@matching false
+
+                properties.buildType == buildType
             },
             kClass = kClass,
         )
@@ -556,7 +620,10 @@ internal open class BufTasksImpl<BufTask : BufExecTask> internal constructor(
         return BufTasksImpl(
             project = project,
             collection = collection.matching {
-                (it.properties as? BufExecTask.AndroidProperties)?.variant == variant
+                val properties = it.properties as? BufExecTask.AndroidProperties
+                    ?: return@matching false
+
+                properties.variant == variant
             },
             kClass = kClass,
         )