Continue cleaning tasks up

Author: fzhinkin

api/binary-compatibility-validator.api

@@ -85,6 +85,10 @@ public class kotlinx/validation/KotlinApiCompareTask : org/gradle/api/DefaultTas
 	public final fun setProjectApiFile (Ljava/io/File;)V
 }
 
+public final class kotlinx/validation/_UtilsKt {
+	public static final fun toKlibTarget (Lorg/jetbrains/kotlin/gradle/plugin/KotlinTarget;)Lkotlinx/validation/api/klib/KlibTarget;
+}
+
 public final class kotlinx/validation/api/ClassBinarySignature {
 	public final fun copy (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;Ljava/util/List;Lkotlinx/validation/api/AccessFlags;ZZLjava/util/List;)Lkotlinx/validation/api/ClassBinarySignature;
 	public static synthetic fun copy$default (Lkotlinx/validation/api/ClassBinarySignature;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;Ljava/util/List;Lkotlinx/validation/api/AccessFlags;ZZLjava/util/List;ILjava/lang/Object;)Lkotlinx/validation/api/ClassBinarySignature;

src/main/kotlin/-Utils.kt

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2016-2024 JetBrains s.r.o.
+ * Use of this source code is governed by the Apache 2.0 License that can be found in the LICENSE.txt file.
+ */
+
+package kotlinx.validation
+
+import kotlinx.validation.api.klib.KlibTarget
+import kotlinx.validation.api.klib.konanTargetNameMapping
+import org.gradle.api.file.RegularFileProperty
+import org.gradle.api.tasks.Input
+import org.gradle.api.tasks.InputFiles
+import org.jetbrains.kotlin.gradle.plugin.KotlinPlatformType
+import org.jetbrains.kotlin.gradle.plugin.KotlinTarget
+import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget
+import org.jetbrains.kotlin.gradle.targets.js.KotlinWasmTargetType
+import org.jetbrains.kotlin.gradle.targets.js.ir.KotlinJsIrTarget
+import java.io.Serializable
+
+/**
+ * Converts [KotlinTarget] to a [KlibTarget].
+ */
+public fun KotlinTarget.toKlibTarget(): KlibTarget = KlibTarget(extractUnderlyingTarget(this), targetName)
+
+private fun extractUnderlyingTarget(target: KotlinTarget): String {
+    if (target is KotlinNativeTarget) {
+        return konanTargetNameMapping[target.konanTarget.name]!!
+    }
+    return when (target.platformType) {
+        KotlinPlatformType.js -> "js"
+        KotlinPlatformType.wasm -> when ((target as KotlinJsIrTarget).wasmTargetType) {
+            KotlinWasmTargetType.WASI -> "wasmWasi"
+            KotlinWasmTargetType.JS -> "wasmJs"
+            else -> throw IllegalStateException("Unreachable")
+        }
+        else -> throw IllegalArgumentException("Unsupported platform type: ${target.platformType}")
+    }
+}
+
+/**
+ * Information about a generated klib dump.
+ */
+public class GeneratedDump(
+    /**
+     * The target the dump was generated for.
+     */
+    @get:Input
+    public val target: KlibTarget,
+
+    /**
+     * Path to a resulting dump file.
+     */
+    @get:InputFiles
+    public val dumpFile: RegularFileProperty
+) : Serializable

src/main/kotlin/BinaryCompatibilityValidatorPlugin.kt

@@ -511,6 +511,23 @@ private class KlibValidationPipelineBuilder(
         val kotlin = project.kotlinMultiplatform
 
         val supportedTargetsProvider = supportedTargets()
+        val generatedDumps = objects.listProperty(GeneratedDump::class.java)
+        val inferredDumps = objects.listProperty(GeneratedDump::class.java)
+        mergeTask.configure {
+            it.dumps.addAll(generatedDumps)
+            it.doFirst {
+                if (supportedTargetsProvider.get().isEmpty()) {
+                    throw IllegalStateException(
+                        "KLib ABI dump/validation requires at least one enabled klib target, but none were found."
+                    )
+                }
+            }
+        }
+        mergeInferredTask.configure {
+            it.dumps.addAll(generatedDumps)
+            it.dumps.addAll(inferredDumps)
+        }
+
         kotlin.targets.matching { it.emitsKlib }.configureEach { currentTarget ->
             val mainCompilation = currentTarget.mainCompilationOrNull ?: return@configureEach
 
@@ -521,14 +538,9 @@ private class KlibValidationPipelineBuilder(
             // If a target is supported, the workflow is simple: create a dump, then merge it along with other dumps.
             if (targetSupported) {
                 val buildTargetAbi = configureKlibCompilation(mainCompilation, extension, targetConfig, apiBuildDir)
-                mergeTask.configure {
-                    it.dumps.add(GeneratedDump(targetName,
-                        objects.fileProperty().fileProvider(buildTargetAbi.map { it.outputApiFile })))
-                }
-                mergeInferredTask.configure {
-                    it.dumps.add(GeneratedDump(targetName,
-                        objects.fileProperty().fileProvider(buildTargetAbi.map { it.outputApiFile })))
-                }
+                generatedDumps.add(GeneratedDump(
+                    currentTarget.toKlibTarget(),
+                    objects.fileProperty().fileProvider(buildTargetAbi.map { it.outputApiFile })))
                 return@configureEach
             }
             // If the target is unsupported, the regular merge task will only depend on a task complaining about
@@ -542,22 +554,12 @@ private class KlibValidationPipelineBuilder(
             val proxy = unsupportedTargetDumpProxy(
                 mainCompilation,
                 klibApiDir, targetConfig,
-                KlibTarget(extractUnderlyingTarget(currentTarget), currentTarget.targetName),
-                apiBuildDir, supportedTargetsProvider
+                currentTarget.toKlibTarget(),
+                apiBuildDir
             )
-            mergeInferredTask.configure {
-                it.dumps.add(GeneratedDump(targetName,
-                    objects.fileProperty().fileProvider(proxy.map { it.outputFile })))
-            }
-        }
-        mergeTask.configure {
-            it.doFirst {
-                if (supportedTargetsProvider.get().isEmpty()) {
-                    throw IllegalStateException(
-                        "KLib ABI dump/validation requires at least one enabled klib target, but none were found."
-                    )
-                }
-            }
+            proxy.configure { it.dumps.addAll(generatedDumps) }
+            inferredDumps.add(GeneratedDump(currentTarget.toKlibTarget(),
+                objects.fileProperty().fileProvider(proxy.map { it.outputFile })))
         }
     }
 
@@ -584,7 +586,7 @@ private class KlibValidationPipelineBuilder(
                         true
                     }
                 }
-                .map { KlibTarget(extractUnderlyingTarget(it), it.targetName) }
+                .map { it.toKlibTarget() }
                 .toSet()
         }
     }
@@ -639,8 +641,7 @@ private class KlibValidationPipelineBuilder(
         klibApiDir: Provider<File>,
         targetConfig: TargetConfig,
         unsupportedTarget: KlibTarget,
-        apiBuildDir: File,
-        supportedTargets: Provider<Set<KlibTarget>>
+        apiBuildDir: File
     ): TaskProvider<KotlinKlibInferAbiForUnsupportedTargetTask> {
         val targetName = targetConfig.targetName!!
         return project.task<KotlinKlibInferAbiForUnsupportedTargetTask>(targetConfig.apiTaskName("Infer")) {
@@ -650,12 +651,9 @@ private class KlibValidationPipelineBuilder(
             description = "Try to infer the dump for unsupported target $targetName using dumps " +
                     "generated for supported targets."
             group = "other"
-            this.supportedTargets.addAll(supportedTargets)
             inputImageFile = klibApiDir.get().resolve(klibDumpFileName)
-            outputApiDir = apiBuildDir.toString()
             outputFile = apiBuildDir.resolve(klibDumpFileName)
             this.unsupportedTarget = unsupportedTarget
-            dumpFileName = klibDumpFileName
             dependsOn(project.tasks.withType(KotlinKlibAbiBuildTask::class.java))
         }
     }
@@ -675,21 +673,6 @@ private val KotlinTarget.jvmBased: Boolean
         return platformType == KotlinPlatformType.jvm || platformType == KotlinPlatformType.androidJvm
     }
 
-private fun extractUnderlyingTarget(target: KotlinTarget): String {
-    if (target is KotlinNativeTarget) {
-        return konanTargetNameMapping[target.konanTarget.name]!!
-    }
-    return when (target.platformType) {
-        KotlinPlatformType.js -> "js"
-        KotlinPlatformType.wasm -> when ((target as KotlinJsIrTarget).wasmTargetType) {
-            KotlinWasmTargetType.WASI -> "wasmWasi"
-            KotlinWasmTargetType.JS -> "wasmJs"
-            else -> throw IllegalStateException("Unreachable")
-        }
-        else -> throw IllegalArgumentException("Unsupported platform type: ${target.platformType}")
-    }
-}
-
 private val Project.kotlinMultiplatform
     get() = extensions.getByName("kotlin") as KotlinMultiplatformExtension
 

src/main/kotlin/KotlinKlibExtractSupportedTargetsAbiTask.kt

@@ -17,8 +17,6 @@ import java.io.File
  * Extracts dump for targets supported by the host compiler from a merged API dump stored in a project.
  */
 internal abstract class KotlinKlibExtractSupportedTargetsAbiTask : DefaultTask() {
-    @get:Internal
-    internal val projectName = project.name
 
     /**
      * Merged KLib dump that should be filtered by this task.

src/main/kotlin/KotlinKlibInferAbiForUnsupportedTargetTask.kt

@@ -23,40 +23,24 @@ import java.io.File
  * The resulting dump is then used as an inferred dump for the unsupported target.
  */
 internal abstract class KotlinKlibInferAbiForUnsupportedTargetTask : DefaultTask() {
-    @get:Internal
-    internal val projectName = project.name
-
     /**
      * The name of a target to infer a dump for.
      */
     @Input
     lateinit var unsupportedTarget: KlibTarget
 
-    /**
-     * A root directory containing dumps successfully generated for each supported target.
-     * It is assumed that this directory contains subdirectories named after targets.
-     */
-    @InputFiles
-    lateinit var outputApiDir: String
-
     /**
      * Set of all supported targets.
      */
-    @get:Input
-    val supportedTargets: ListProperty<KlibTarget> = project.objects.listProperty(KlibTarget::class.java)
+    @Nested
+    val dumps: ListProperty<GeneratedDump> = project.objects.listProperty(GeneratedDump::class.java)
 
     /**
      * Previously generated merged ABI dump file, the golden image every dump should be verified against.
      */
     @InputFiles
     lateinit var inputImageFile: File
 
-    /**
-     * The name of a dump file.
-     */
-    @Input
-    lateinit var dumpFileName: String
-
     /**
      * A path to an inferred dump file.
      */
@@ -66,13 +50,15 @@ internal abstract class KotlinKlibInferAbiForUnsupportedTargetTask : DefaultTask
     @OptIn(ExperimentalBCVApi::class)
     @TaskAction
     internal fun generate() {
-        val supportedTargetNames = supportedTargets.get().toSet()
+        val availableDumps = dumps.get().map {
+            it.target to it.dumpFile.asFile.get()
+        }.filter { it.second.exists() }.toMap()
         // Find a set of supported targets that are closer to unsupported target in the hierarchy.
         // Note that dumps are stored using configurable name, but grouped by the canonical target name.
-        val matchingTargets = findMatchingTargets(supportedTargetNames, unsupportedTarget)
+        val matchingTargets = findMatchingTargets(availableDumps.keys, unsupportedTarget)
         // Load dumps that are a good fit for inference
         val supportedTargetDumps = matchingTargets.map { target ->
-            val dumpFile = File(outputApiDir).parentFile.resolve(target.configurableName).resolve(dumpFileName)
+            val dumpFile = availableDumps[target]!!
             KlibDump.from(dumpFile, target.configurableName).also {
                 check(it.targets.single() == target)
             }

src/main/kotlin/KotlinKlibMergeAbiTask.kt

@@ -6,29 +6,18 @@
 package kotlinx.validation
 
 import kotlinx.validation.api.klib.KlibDump
+import kotlinx.validation.api.klib.KlibTarget
 import kotlinx.validation.api.klib.saveTo
 import org.gradle.api.DefaultTask
 import org.gradle.api.file.RegularFileProperty
 import org.gradle.api.provider.ListProperty
 import org.gradle.api.tasks.*
 import java.io.File
-import java.io.Serializable
-
-internal class GeneratedDump(
-    @get:Input
-    val targetName: String,
-
-    @get:InputFiles
-    val dumpFile: RegularFileProperty
-) : Serializable
 
 /**
  * Merges multiple individual KLib ABI dumps into a single merged dump.
  */
 internal abstract class KotlinKlibMergeAbiTask : DefaultTask() {
-    @get:Internal
-    internal val projectName = project.name
-
     @get:Nested
     val dumps: ListProperty<GeneratedDump> = project.objects.listProperty(GeneratedDump::class.java)
 
@@ -52,7 +41,7 @@ internal abstract class KotlinKlibMergeAbiTask : DefaultTask() {
             dumps.get().forEach { dump ->
                 val dumpFile = dump.dumpFile.asFile.get()
                 if (dumpFile.exists()) {
-                    merge(dumpFile, dump.targetName)
+                    merge(dumpFile, dump.target.configurableName)
                 }
             }
         }.saveTo(mergedFile)