prep for klib extract

Author: aSemy

modules/bcv-gradle-plugin-functional-tests/src/functionalTest/kotlin/kotlinx/validation/test/KlibVerificationTests.kt

@@ -229,7 +229,6 @@ internal class KlibVerificationTests : BaseKotlinGradleTest() {
       }
     }
 
-
     runner.build {
       checkKLibDump("/examples/classes/Subclasses.klib.dump")
     }

modules/bcv-gradle-plugin/src/main/kotlin/tasks/BCVApiGenerateTask.kt

@@ -4,10 +4,7 @@ import dev.adamko.kotlin.binary_compatibility_validator.internal.*
 import dev.adamko.kotlin.binary_compatibility_validator.targets.BCVJvmTarget
 import dev.adamko.kotlin.binary_compatibility_validator.targets.BCVKLibTarget
 import dev.adamko.kotlin.binary_compatibility_validator.targets.BCVTarget
-import dev.adamko.kotlin.binary_compatibility_validator.workers.JvmSignaturesWorker
-import dev.adamko.kotlin.binary_compatibility_validator.workers.KLibInferSignaturesWorker
-import dev.adamko.kotlin.binary_compatibility_validator.workers.KLibMergeWorker
-import dev.adamko.kotlin.binary_compatibility_validator.workers.KLibSignaturesWorker
+import dev.adamko.kotlin.binary_compatibility_validator.workers.*
 import java.io.File
 import javax.inject.Inject
 import org.gradle.api.NamedDomainObjectContainer
@@ -184,6 +181,23 @@ constructor(
 
     val (supportedKLibTargets, unsupportedKLibTargets) =
       klibTargets.partition { it.supportedByCurrentHost.get() }
+
+    generateSupportedKLibTargets(workQueue, supportedKLibTargets)
+    generateUnsupportedKLibTargets(workQueue, unsupportedKLibTargets)
+
+    workQueue.await()
+
+    val allTargetDumpFiles =
+      supportedTargetsDir.walk().filter { it.isFile }.toSet() union
+          unsupportedTargetsDir.walk().filter { it.isFile }.toSet()
+
+    mergeDumpFiles(workQueue, allTargetDumpFiles, outputApiBuildDir.asFile)
+  }
+
+  private fun generateSupportedKLibTargets(
+    workQueue: WorkQueue,
+    supportedKLibTargets: List<BCVKLibTarget>
+  ) {
     logger.lifecycle("[$path] generating ${supportedKLibTargets.size} supported KLib targets : ${supportedKLibTargets.joinToString { it.name }}")
 
     val supportedKLibGenDuration = measureTime {
@@ -195,8 +209,14 @@ constructor(
       }
       workQueue.await()
     }
+
     logger.lifecycle("[$path] finished generating supported KLib targets in $supportedKLibGenDuration")
+  }
 
+  private fun generateUnsupportedKLibTargets(
+    workQueue: WorkQueue,
+    unsupportedKLibTargets: List<BCVKLibTarget>
+  ) {
     logger.lifecycle("[$path] generating ${unsupportedKLibTargets.size} unsupported KLib targets : ${unsupportedKLibTargets.joinToString { it.name }}")
 
     val unsupportedKLibGenDuration = measureTime {
@@ -210,30 +230,32 @@ constructor(
         )
       }
     }
-    logger.lifecycle("[$path] finished generating unsupported KLib targets in $unsupportedKLibGenDuration")
 
-    workQueue.await()
+    logger.lifecycle("[$path] finished generating unsupported KLib targets in $unsupportedKLibGenDuration")
+  }
 
-    val allTargetDumpFiles =
-      supportedTargetsDir.walk().filter { it.isFile }.toSet() union
-          unsupportedTargetsDir.walk().filter { it.isFile }.toSet()
 
+  private fun mergeDumpFiles(
+    workQueue: WorkQueue,
+    allTargetDumpFiles: Set<File>,
+    outputApiBuildDir: File
+  ) {
     logger.lifecycle("[$path] merging ${allTargetDumpFiles.size} dump files : ${allTargetDumpFiles.joinToString { it.name }}")
 
     workQueue.merge(
       projectName.get(),
       targetDumpFiles = allTargetDumpFiles,
-      outputDir = outputApiBuildDir.asFile,
+      outputDir = outputApiBuildDir,
     )
     workQueue.await()
 
-    logger.lifecycle(
-      "[$path] merged ${allTargetDumpFiles.size} dump files : ${
-        outputApiBuildDir.asFile.walk().filter { it.isFile }.toList()
-      }"
-    )
+    if (logger.isLifecycleEnabled) {
+      val fileNames = outputApiBuildDir.walk().filter { it.isFile }.toList()
+      logger.lifecycle("[$path] merged ${allTargetDumpFiles.size} dump files : $fileNames")
+    }
   }
 
+
   @OptIn(BCVExperimentalApi::class)
   private fun WorkQueue.submit(
     target: BCVKLibTarget,
@@ -300,5 +322,24 @@ constructor(
       this@worker.targetDumpFiles.from(targetDumpFiles)
     }
   }
+
+  @OptIn(BCVExperimentalApi::class)
+  private fun WorkQueue.extract(
+    target: BCVKLibTarget,
+    targetDumpFiles: Set<File>,
+    outputDir: File,
+  ) {
+    val task = this@BCVApiGenerateTask
+
+    @OptIn(BCVInternalApi::class)
+    submit(KLibExtractWorker::class) worker@{
+      this@worker.taskPath.set(task.path)
+      this@worker.strictValidation.set(target.strictValidation)
+
+//      this@worker.inputAbiFile.set()
+//      this@worker.outputAbiFile.set()
+//      this@worker.supportedTargets.set()
+    }
+  }
   //endregion
 }

modules/bcv-gradle-plugin/src/main/kotlin/workers/KLibExtractWorker.kt

@@ -0,0 +1,67 @@
+package dev.adamko.kotlin.binary_compatibility_validator.workers
+
+import dev.adamko.kotlin.binary_compatibility_validator.internal.BCVExperimentalApi
+import dev.adamko.kotlin.binary_compatibility_validator.internal.BCVInternalApi
+import java.io.Serializable
+import kotlinx.validation.ExperimentalBCVApi
+import kotlinx.validation.KlibValidationSettings
+import kotlinx.validation.api.klib.KlibDump
+import kotlinx.validation.api.klib.KlibTarget
+import kotlinx.validation.api.klib.saveTo
+import org.gradle.api.file.RegularFileProperty
+import org.gradle.api.logging.Logger
+import org.gradle.api.logging.Logging
+import org.gradle.api.provider.Property
+import org.gradle.api.provider.SetProperty
+import org.gradle.workers.WorkAction
+import org.gradle.workers.WorkParameters
+
+@BCVInternalApi
+@BCVExperimentalApi
+@OptIn(ExperimentalBCVApi::class)
+abstract class KLibExtractWorker : WorkAction<KLibExtractWorker.Parameters> {
+
+  @BCVInternalApi
+  interface Parameters : WorkParameters, Serializable {
+//    val projectName: Property<String>
+    /** Merged KLib dump that should be filtered by this task. */
+    val inputAbiFile: RegularFileProperty
+    /** A path to the resulting dump file. */
+    val outputAbiFile: RegularFileProperty
+    /** Provider returning targets supported by the host compiler. */
+    val supportedTargets: SetProperty<String>
+    /** Refer to [KlibValidationSettings.strictValidation] for details. */
+    val strictValidation: Property<Boolean>
+    /**
+     * [Task path][org.gradle.api.Task.getPath] of the task that invoked this worker,
+     * for log messages
+     */
+    val taskPath: Property<String>
+  }
+
+  override fun execute() {
+    val inputAbiFile = parameters.inputAbiFile.get().asFile
+    val supportedTargets = parameters.supportedTargets.get()
+    val strictValidation = parameters.strictValidation.getOrElse(false)
+    val outputAbiFile = parameters.outputAbiFile.get().asFile
+
+    if (inputAbiFile.length() == 0L) {
+      error("Project ABI file $inputAbiFile is empty")
+    }
+    val dump = KlibDump.from(inputAbiFile)
+    val enabledTargets = supportedTargets.map { KlibTarget.parse(it).targetName }
+    // Filter out only unsupported files.
+    // That ensures that target renaming will be caught and reported as a change.
+    val targetsToRemove = dump.targets.filter { it.targetName !in enabledTargets }
+    if (targetsToRemove.isNotEmpty() && strictValidation) {
+      error("Validation could not be performed as some targets are not available and strictValidation mode is enabled")
+    }
+    dump.remove(targetsToRemove)
+    dump.saveTo(outputAbiFile)
+  }
+
+  @BCVInternalApi
+  companion object {
+    private val logger: Logger = Logging.getLogger(KLibExtractWorker::class.java)
+  }
+}