Fixed plugin issues found with tests

Mr3zee · Mr3zee · commit 4f5c707d48f2 · 2025-07-29T17:06:35.000+02:00
diff --git a/gradle-plugin/src/main/kotlin/kotlinx/rpc/buf/BufExecutable.kt b/gradle-plugin/src/main/kotlin/kotlinx/rpc/buf/BufExecutable.kt
@@ -56,7 +56,7 @@ internal fun BufExecTask.execBuf(args: Iterable<Any>) {
         val configValue = configFile.orNull
         if (configValue != null) {
             add("--config")
-            add(configValue.absolutePath)
+            add(configValue.path)
         }
 
         if (debug.get()) {
diff --git a/gradle-plugin/src/main/kotlin/kotlinx/rpc/buf/tasks/BufExecTask.kt b/gradle-plugin/src/main/kotlin/kotlinx/rpc/buf/tasks/BufExecTask.kt
@@ -27,6 +27,7 @@ import kotlinx.rpc.buf.BUF_GEN_YAML
 import kotlinx.rpc.buf.BUF_YAML
 import kotlinx.rpc.buf.BufTasksExtension
 import org.gradle.api.logging.LogLevel
+import org.gradle.api.tasks.Classpath
 
 /**
  * Abstract base class for `buf` tasks.
@@ -60,6 +61,8 @@ public abstract class BufExecTask : DefaultTask() {
      * The working directory for the `buf` command.
      */
     @get:InputDirectory
+    // https://docs.gradle.org/current/userguide/incremental_build.html#sec:configure_input_normalization
+    @get:Classpath
     public abstract val workingDir: Property<File>
 
     /**
diff --git a/gradle-plugin/src/main/kotlin/kotlinx/rpc/buf/tasks/BufGenerateTask.kt b/gradle-plugin/src/main/kotlin/kotlinx/rpc/buf/tasks/BufGenerateTask.kt
@@ -15,7 +15,6 @@ import org.gradle.api.tasks.OutputDirectory
 import org.gradle.api.tasks.TaskProvider
 import java.io.File
 import kotlinx.rpc.buf.BufGenerateExtension
-import org.gradle.api.provider.Provider
 import org.gradle.api.tasks.InputDirectory
 
 /**
@@ -24,11 +23,11 @@ import org.gradle.api.tasks.InputDirectory
  * @see <a href="https://buf.build/docs/reference/cli/buf/generate/">buf generate</a>
  */
 public abstract class BufGenerateTask : BufExecTask() {
-    // unsued, but required for Gradle to properly recognize inputs
+    // unsued, but required for Gradle to properly recognise inputs
     @get:InputDirectory
     internal abstract val protoFilesDir: Property<File>
 
-    // unsued, but required for Gradle to properly recognize inputs
+    // unsued, but required for Gradle to properly recognise inputs
     @get:InputDirectory
     internal abstract val importFilesDir: Property<File>
 
diff --git a/gradle-plugin/src/main/kotlin/kotlinx/rpc/buf/tasks/GenerateBufGenYaml.kt b/gradle-plugin/src/main/kotlin/kotlinx/rpc/buf/tasks/GenerateBufGenYaml.kt
@@ -26,7 +26,7 @@ internal data class ResolvedGrpcPlugin(
     val type: Type,
     val locator: List<String>,
     val out: String,
-    val options: Map<String, Any?>,
+    val options: Map<String, Any>,
     val strategy: String?,
     val includeImports: Boolean?,
     val includeWkt: Boolean?,
@@ -91,6 +91,13 @@ public abstract class GenerateBufGenYaml : DefaultTask() {
                 }
 
                 writer.appendLine("  - ${plugin.type.name}: $locatorLine")
+                writer.appendLine("    out: ${plugin.out}")
+                if (plugin.options.isNotEmpty()) {
+                    writer.appendLine("    opt:")
+                    plugin.options.forEach { (key, value) ->
+                        writer.appendLine("      - $key=$value")
+                    }
+                }
                 if (plugin.strategy != null) {
                     writer.appendLine("    strategy: ${plugin.strategy}")
                 }
@@ -112,13 +119,6 @@ public abstract class GenerateBufGenYaml : DefaultTask() {
                         writer.appendLine("      - $type")
                     }
                 }
-                writer.appendLine("    out: ${plugin.out}")
-                if (plugin.options.isNotEmpty()) {
-                    writer.appendLine("    opt:")
-                    plugin.options.forEach { (key, value) ->
-                        writer.appendLine("      - $key${if (value != null) "=$value" else ""}")
-                    }
-                }
             }
 
             writer.appendLine("inputs:")
diff --git a/gradle-plugin/src/main/kotlin/kotlinx/rpc/buf/tasks/GenerateBufYaml.kt b/gradle-plugin/src/main/kotlin/kotlinx/rpc/buf/tasks/GenerateBufYaml.kt
@@ -11,7 +11,6 @@ import org.gradle.api.DefaultTask
 import org.gradle.api.Project
 import org.gradle.api.provider.Property
 import org.gradle.api.tasks.Input
-import org.gradle.api.tasks.InputDirectory
 import org.gradle.api.tasks.OutputFile
 import org.gradle.api.tasks.TaskAction
 import org.gradle.api.tasks.TaskProvider
@@ -22,11 +21,11 @@ import java.io.File
  * Generates/updates a Buf `buf.yaml` file.
  */
 public abstract class GenerateBufYaml : DefaultTask() {
-    @get:InputDirectory
-    internal abstract val protoSourceDir: Property<File>
+    @get:Input
+    internal abstract val protoSourceDir: Property<String>
 
-    @get:InputDirectory
-    internal abstract val importSourceDir: Property<File>
+    @get:Input
+    internal abstract val importSourceDir: Property<String>
 
     @get:Input
     internal abstract val withImport: Property<Boolean>
@@ -61,13 +60,15 @@ public abstract class GenerateBufYaml : DefaultTask() {
 
             writer.appendLine("modules:")
 
-            val protoDir = protoSourceDir.get()
+            val protoDirName = protoSourceDir.get()
+            val protoDir = file.parentFile.resolve(protoDirName)
             if (protoDir.exists()) {
                 val modulePath = protoDir.relativeTo(file.parentFile)
                 writer.appendLine("  - path: $modulePath")
             }
 
-            val importDir = importSourceDir.get()
+            val importDirName = importSourceDir.get()
+            val importDir = file.parentFile.resolve(importDirName)
             if (withImport.get() && importDir.exists()) {
                 val modulePath = importDir.relativeTo(file.parentFile)
                 writer.appendLine("  - path: $modulePath")
@@ -92,8 +93,8 @@ internal fun Project.registerGenerateBufYamlTask(
 ): TaskProvider<GenerateBufYaml> {
     val capitalizeName = name.replaceFirstChar { it.uppercase() }
     return tasks.register<GenerateBufYaml>("${GenerateBufYaml.NAME_PREFIX}$capitalizeName") {
-        protoSourceDir.set(buildSourceSetsProtoDir)
-        importSourceDir.set(buildSourceSetsImportDir)
+        protoSourceDir.set(buildSourceSetsProtoDir.name)
+        importSourceDir.set(buildSourceSetsImportDir.name)
         this.withImport.set(withImport)
 
         val bufYamlFile = buildSourceSetsDir
diff --git a/gradle-plugin/src/main/kotlin/kotlinx/rpc/grpc/DefaultGrpcExtension.kt b/gradle-plugin/src/main/kotlin/kotlinx/rpc/grpc/DefaultGrpcExtension.kt
@@ -80,6 +80,15 @@ internal open class DefaultGrpcExtension @Inject constructor(
 
     @Suppress("detekt.LongMethod", "detekt.CyclomaticComplexMethod")
     private fun Project.configureTasks(protoSourceSet: DefaultProtoSourceSet) {
+        // todo remove after KRPC-180
+        if (!protoSourceSet.languageSourceSets.isPresent) {
+            logger.debug(
+                "Language source sets are not set for proto source set '${protoSourceSet.name}', skipping buf tasks configuration"
+            )
+
+            return
+        }
+
         val baseName = protoSourceSet.name
 
         val buildSourceSetsDir = project.protoBuildDirSourceSets.resolve(baseName)
@@ -103,30 +112,11 @@ internal open class DefaultGrpcExtension @Inject constructor(
 
         val protoFiles = protoSourceSet.proto
 
-        val generateBufYamlTask = registerGenerateBufYamlTask(
-            name = baseName,
-            buildSourceSetsDir = buildSourceSetsDir,
-            buildSourceSetsProtoDir = buildSourceSetsProtoDir,
-            buildSourceSetsImportDir = buildSourceSetsImportDir,
-            withImport = pairSourceSet != null,
-        )
-
-        val generateBufGenYamlTask = registerGenerateBufGenYamlTask(
-            name = baseName,
-            buildSourceSetsDir = buildSourceSetsDir,
-            protocPlugins = includedProtocPlugins,
-        ) {
-            dependsOn(generateBufYamlTask)
-        }
-
         val processProtoTask = registerProcessProtoFilesTask(
             name = baseName,
             destination = buildSourceSetsProtoDir,
             protoFiles = protoFiles,
-        ) {
-            dependsOn(generateBufYamlTask)
-            dependsOn(generateBufGenYamlTask)
-        }
+        )
 
         val processImportProtoTask = if (pairSourceSet != null) {
             val importProtoFiles = pairSourceSet.proto
@@ -136,14 +126,33 @@ internal open class DefaultGrpcExtension @Inject constructor(
                 destination = buildSourceSetsImportDir,
                 protoFiles = importProtoFiles,
             ) {
-                dependsOn(generateBufYamlTask)
-                dependsOn(generateBufGenYamlTask)
                 dependsOn(processProtoTask)
             }
         } else {
             null
         }
 
+        val generateBufYamlTask = registerGenerateBufYamlTask(
+            name = baseName,
+            buildSourceSetsDir = buildSourceSetsDir,
+            buildSourceSetsProtoDir = buildSourceSetsProtoDir,
+            buildSourceSetsImportDir = buildSourceSetsImportDir,
+            withImport = pairSourceSet != null,
+        ) {
+            dependsOn(processProtoTask)
+            if (processImportProtoTask != null) {
+                dependsOn(processImportProtoTask)
+            }
+        }
+
+        val generateBufGenYamlTask = registerGenerateBufGenYamlTask(
+            name = baseName,
+            buildSourceSetsDir = buildSourceSetsDir,
+            protocPlugins = includedProtocPlugins,
+        ) {
+            dependsOn(generateBufYamlTask)
+        }
+
         val out = protoBuildDirGenerated.resolve(baseName)
 
         val destinationFileTree = fileTree(buildSourceSetsProtoDir)
@@ -281,6 +290,10 @@ internal open class DefaultGrpcExtension @Inject constructor(
             })
         }
 
+        // ignore for bufGenerate task caching
+        project.normalization.runtimeClasspath.ignore("**/protoc-gen-kotlin-multiplatform.log")
+        project.normalization.runtimeClasspath.ignore("**/.keep")
+
         protocPlugins.create(GRPC_JAVA) {
             isJava.set(true)
 
diff --git a/gradle-plugin/src/main/kotlin/kotlinx/rpc/proto/DefaultProtoSourceSet.kt b/gradle-plugin/src/main/kotlin/kotlinx/rpc/proto/DefaultProtoSourceSet.kt
@@ -63,7 +63,7 @@ internal open class DefaultProtoSourceSet @Inject constructor(
 }
 
 internal fun Project.createProtoExtensions() {
-    fun findOrCreateAndConfigure(languageSourceSetName: String, languageSourceSet: Any) {
+    fun findOrCreateAndConfigure(languageSourceSetName: String, languageSourceSet: Any?) {
         val container = project.findOrCreate(PROTO_SOURCE_SETS) {
             val container = objects.domainObjectContainer(
                 ProtoSourceSet::class.java,
@@ -77,10 +77,13 @@ internal fun Project.createProtoExtensions() {
 
         val protoSourceSet = container.maybeCreate(languageSourceSetName) as DefaultProtoSourceSet
 
-        protoSourceSet.languageSourceSets.add(languageSourceSet)
+        languageSourceSet?.let { protoSourceSet.languageSourceSets.add(it) }
     }
 
     project.withKotlinJvmExtension {
+        findOrCreateAndConfigure("main", null)
+        findOrCreateAndConfigure("test", null)
+
         sourceSets.configureEach {
             if (name == SourceSet.MAIN_SOURCE_SET_NAME || name == SourceSet.TEST_SOURCE_SET_NAME) {
                 findOrCreateAndConfigure(name, this)
@@ -97,6 +100,9 @@ internal fun Project.createProtoExtensions() {
     }
 
     project.withKotlinKmpExtension {
+        findOrCreateAndConfigure("jvmMain", null)
+        findOrCreateAndConfigure("jvmTest", null)
+
         sourceSets.configureEach {
             if (name == "jvmMain" || name == "jvmTest") {
                 findOrCreateAndConfigure(name, this)
diff --git a/gradle-plugin/src/main/kotlin/kotlinx/rpc/proto/ProcessProtoFiles.kt b/gradle-plugin/src/main/kotlin/kotlinx/rpc/proto/ProcessProtoFiles.kt
@@ -4,15 +4,13 @@
 
 package kotlinx.rpc.proto
 
-import kotlinx.rpc.util.ensureDirectoryExists
 import kotlinx.rpc.util.ensureRegularFileExists
 import org.gradle.api.Project
 import org.gradle.api.file.SourceDirectorySet
 import org.gradle.api.tasks.Copy
 import org.gradle.api.tasks.TaskProvider
 import org.gradle.kotlin.dsl.register
 import java.io.File
-import java.nio.file.Files
 
 /**
  * Copy proto files to a temporary directory for Buf to process.
@@ -32,19 +30,12 @@ internal fun Project.registerProcessProtoFilesTask(
     val capitalName = name.replaceFirstChar { it.uppercase() }
 
     return tasks.register<ProcessProtoFiles>("process${capitalName}ProtoFiles") {
-        val allFiles = protoFiles.files
-
         // this task deletes the destination directory if it results in NO-SOURCE,
         // which breaks the configuration cache for bufGenerate
         // so we prevent No-SOURCE by creating a .keep file in the destination directory
         val keep = protoBuildDirSourceSetsKeep.ensureRegularFileExists()
         from(keep)
-
-        from(protoFiles.srcDirs) {
-            include {
-                it.file in allFiles
-            }
-        }
+        from(protoFiles)
 
         into(destination)
 
diff --git a/gradle-plugin/src/main/kotlin/kotlinx/rpc/proto/ProtocPlugin.kt b/gradle-plugin/src/main/kotlin/kotlinx/rpc/proto/ProtocPlugin.kt
@@ -93,8 +93,8 @@ public open class ProtocPlugin(
      *
      * @see <a href="https://buf.build/docs/configuration/v2/buf-gen-yaml/#opt">Buf documentation - opt</a>
      */
-    public val options: MapProperty<String, Any?> = project.objects
-        .mapProperty<String, Any?>()
+    public val options: MapProperty<String, Any> = project.objects
+        .mapProperty<String, Any>()
         .convention(emptyMap())
 
     /**
diff --git a/gradle-plugin/src/main/kotlin/kotlinx/rpc/util/ProcessRunner.kt b/gradle-plugin/src/main/kotlin/kotlinx/rpc/util/ProcessRunner.kt
@@ -55,7 +55,7 @@ internal class ProcessRunner : Closeable {
     ) {
         fun formattedOutput() = buildString {
             appendLine("Process $name finished:")
-            appendLine("  - Arguments: $args")
+            appendLine("  - Buf Arguments: $args")
             appendLine("  - Exit code: $exitCode")
             val perStream = { name: String, content: ByteArray ->
                 val string = content.toString(StandardCharsets.UTF_8)

Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ internal fun BufExecTask.execBuf(args: Iterable<Any>) {`
`56`	`56`	`val configValue = configFile.orNull`
`57`	`57`	`if (configValue != null) {`
`58`	`58`	`add("--config")`
`59`		`- add(configValue.absolutePath)`
	`59`	`+ add(configValue.path)`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`if (debug.get()) {`