Described a klib validation pipeline, fixed task names, improved erro…

…r messages
Kotlin · Feb 5, 2024 · cac5669 · cac5669
1 parent 0a2d44f
commit cac5669
Show file tree

Hide file tree

Showing 8 changed files with 87 additions and 49 deletions.
diff --git a/src/functionalTest/kotlin/kotlinx/validation/test/KLibVerificationTests.kt b/src/functionalTest/kotlin/kotlinx/validation/test/KLibVerificationTests.kt
@@ -474,7 +474,7 @@ internal class KLibVerificationTests : BaseKotlinGradleTest() {
         }
 
         runner.buildAndFail().apply {
-            assertTaskFailure(":klibApiPrepareAbiForValidation")
+            assertTaskFailure(":klibApiExtractForValidation")
         }
     }
 
@@ -527,7 +527,7 @@ internal class KLibVerificationTests : BaseKotlinGradleTest() {
         }
 
         runner.buildAndFail().apply {
-            assertTaskFailure(":linuxArm64ApiInferAbiDump")
+            assertTaskFailure(":linuxArm64ApiInfer")
             Assertions.assertThat(output).contains(
                 "The target linuxArm64 is not supported by the host compiler " +
                         "and there are no targets similar to linuxArm64 to infer a dump from it."
@@ -590,7 +590,7 @@ internal class KLibVerificationTests : BaseKotlinGradleTest() {
 
         runner.buildAndFail().apply {
             Assertions.assertThat(output).contains(
-                "KLib ABI dump/validation requires at least enabled klib target, but none were found."
+                "KLib ABI dump/validation requires at least one enabled klib target, but none were found."
             )
         }
     }

diff --git a/src/main/kotlin/BinaryCompatibilityValidatorPlugin.kt b/src/main/kotlin/BinaryCompatibilityValidatorPlugin.kt
diff --git a/src/main/kotlin/KotlinApiBuildTask.kt b/src/main/kotlin/KotlinApiBuildTask.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2020 JetBrains s.r.o.
+ * 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.
  */
 

diff --git a/src/main/kotlin/KotlinApiCompareTask.kt b/src/main/kotlin/KotlinApiCompareTask.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2020 JetBrains s.r.o.
+ * 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.
  */
 

diff --git a/src/main/kotlin/KotlinKlibAbiBuildTask.kt b/src/main/kotlin/KotlinKlibAbiBuildTask.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2023 JetBrains s.r.o.
+ * 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.
  */
 
@@ -68,7 +68,7 @@ public abstract class KotlinKlibAbiBuildTask : BuildTaskBase() {
         val parsedAbi = try {
             LibraryAbiReader.readAbiInfo(klibFile.singleFile, filters)
         } catch (e: Exception) {
-            throw IllegalStateException("Can't read a KLib: ${klibFile.singleFile}", e)
+            throw IllegalStateException("Can't read a klib: ${klibFile.singleFile}", e)
         }
 
         val supportedVersions = parsedAbi.signatureVersions.asSequence()
@@ -83,7 +83,7 @@ public abstract class KotlinKlibAbiBuildTask : BuildTaskBase() {
             AbiSignatureVersion.resolveByVersionNumber(signatureVersion!!)
         } else {
             supportedVersions.maxByOrNull(AbiSignatureVersion::versionNumber)
-                ?: throw IllegalStateException("Can't choose abiSignatureVersion")
+                ?: throw IllegalStateException("Can't choose signatureVersion")
         }
 
         outputApiFile.bufferedWriter().use {

diff --git a/src/main/kotlin/KotlinKlibExtractSupportedTargetsAbiTask.kt b/src/main/kotlin/KotlinKlibExtractSupportedTargetsAbiTask.kt
@@ -61,7 +61,7 @@ public abstract class KotlinKlibExtractSupportedTargetsAbiTask : DefaultTask() {
         if (targetsToRemove.isNotEmpty() && strictValidation) {
             throw IllegalStateException(
                 "Validation could not be performed as some targets are not available " +
-                        "and the strictValidation mode was enabled"
+                        "and the strictValidation mode was enabled."
             )
         }
         for (target in targetsToRemove) {

diff --git a/src/main/kotlin/KotlinKlibInferAbiForUnsupportedTargetTask.kt b/src/main/kotlin/KotlinKlibInferAbiForUnsupportedTargetTask.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2023 JetBrains s.r.o.
+ * 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.
  */
 
@@ -105,10 +105,10 @@ public abstract class KotlinKlibInferAbiForUnsupportedTargetTask : DefaultTask()
         }
 
         logger.warn(
-            "An ABI dump for target $unsupportedTarget was inferred from the ABI generated for target " +
-                    "[${matchingTargets.joinToString(",")}] " +
-                    "as the former target is not supported by the host compiler. " +
-                    "Inferred dump may not reflect actual ABI for the target $unsupportedTarget. " +
+            "An ABI dump for target $unsupportedTarget was inferred from the ABI generated for the following targets " +
+                    "as the former target is not supported by the host compiler: " +
+                    "[${matchingTargets.joinToString(",")}]. " +
+                    "Inferred dump may not reflect an actual ABI for the target $unsupportedTarget. " +
                     "It is recommended to regenerate the dump on the host supporting all required compilation target."
         )
     }

diff --git a/src/main/kotlin/KotlinKlibMergeAbiTask.kt b/src/main/kotlin/KotlinKlibMergeAbiTask.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2023 JetBrains s.r.o.
+ * 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.
  */