[ABI Validation] Added support for dumping jar files in ABI tools

The ability to dump JVM classes from jar files has been added to the API of ABI tools.

#KT-80313 Fixed

Co-authored-by: Filipp Zhinkin <[email protected]>

Merge-request: KT-MR-23137
Merged-by: Sergei Shanshin <[email protected]>

Author: shanshin

libraries/tools/abi-validation/abi-tools-api/src/main/kotlin/org/jetbrains/kotlin/abi/tools/api/AbiFilters.kt

@@ -17,7 +17,7 @@ package org.jetbrains.kotlin.abi.tools.api
  *
  * A declaration passes the inclusion filters if there is no inclusion rules, or it matches any inclusion rule, or at least one of its members (actual for class declaration) matches any inclusion rule.
  *
- * @since 2.1.20
+ * @since 2.2.0
  */
 public class AbiFilters(
     /**

libraries/tools/abi-validation/abi-tools-api/src/main/kotlin/org/jetbrains/kotlin/abi/tools/api/AbiToolsFactory.kt

@@ -8,7 +8,7 @@ package org.jetbrains.kotlin.abi.tools.api
 /**
  * An abstract factory for obtaining an instance of [AbiToolsInterface] - main class for using the capabilities of ABI Validation tool.
  *
- * @since 2.1.20
+ * @since 2.2.0
  */
 public interface AbiToolsFactory {
     /**

libraries/tools/abi-validation/abi-tools-api/src/main/kotlin/org/jetbrains/kotlin/abi/tools/api/AbiToolsInterface.kt

@@ -11,7 +11,7 @@ import java.io.File
 /**
  * All features of Kotlin ABI Validation tool.
  *
- * @since 2.1.20
+ * @since 2.2.0
  */
 public interface AbiToolsInterface {
     /**

libraries/tools/abi-validation/abi-tools-api/src/main/kotlin/org/jetbrains/kotlin/abi/tools/api/v2/AbiToolsV2.kt

@@ -12,16 +12,25 @@ import java.io.File
  * A set of features for working with legacy format dumps,
  * used in previous [Binary Compatibility Validator plugin](https://github.com/Kotlin/binary-compatibility-validator).
  *
- * @since 2.1.20
+ * @since 2.2.0
  */
 public interface AbiToolsV2 {
     /**
-     * Print ABI dump for JVM class-files into specified [appendable].
+     * Print ABI dump for JVM from [inputFiles] into specified [appendable].
+     * It is possible to pass class-files or jar files in [inputFiles].
+     *
+     * To control which declarations are passed to the dump, [filters] could be used. By default, no filters will be applied.
+     *
+     * A class declaration with internal visibility will be printed as public if [internalDeclarationsAsPublic] returns `true` for its name.
      */
-    public fun <T : Appendable> printJvmDump(appendable: T, classfiles: Iterable<File>, filters: AbiFilters)
+    public fun <T : Appendable> printJvmDump(
+        appendable: T,
+        inputFiles: Iterable<File>,
+        filters: AbiFilters
+    )
 
     /**
-     * Create empty KLib dump without any declarations and targets.
+     * Create an empty KLib dump without any declarations and targets.
      */
     public fun createKlibDump(): KlibDump
 
@@ -43,12 +52,14 @@ public interface AbiToolsV2 {
     public fun loadKlibDump(dump: CharSequence): KlibDump
 
     /**
-     * Get an ABI from a zipped or unpacked KLib specified in [klib] with specified [target].
+     * Get an ABI from a zipped or unpacked KLib specified in [klib].
+     *
+     * Original target will be overridden by [target] if it's not `null`.
      *
      * To control which declarations are passed to the dump, [filters] could be used. By default, no filters will be applied.
      *
      * @throws IllegalStateException if a KLib could not be loaded from [klib].
      * @throws java.io.FileNotFoundException if file or directory [klib] does not exist.
      */
-    public fun extractKlibAbi(klib: File, target: KlibTarget, filters: AbiFilters = AbiFilters.Companion.EMPTY): KlibDump
+    public fun extractKlibAbi(klib: File, target: KlibTarget? = null, filters: AbiFilters = AbiFilters.EMPTY): KlibDump
 }

libraries/tools/abi-validation/abi-tools-api/src/main/kotlin/org/jetbrains/kotlin/abi/tools/api/v2/KlibDump.kt

@@ -41,7 +41,7 @@ import java.io.File
  * mergedDump.print(File("/path/to/merged.klib.api"))
  * ```
  *
- * @since 2.1.20
+ * @since 2.2.0
  */
 public interface KlibDump {
     /**

libraries/tools/abi-validation/abi-tools/src/main/kotlin/org/jetbrains/kotlin/abi/tools/v2/ToolsV2.kt

@@ -12,17 +12,19 @@ import org.jetbrains.kotlin.abi.tools.api.v2.KlibTarget
 import org.jetbrains.kotlin.abi.tools.filtering.compileMatcher
 import org.jetbrains.kotlin.abi.tools.v2.klib.KlibDumpImpl
 import java.io.File
+import java.io.InputStream
+import java.util.jar.JarFile
 
 internal object ToolsV2 : AbiToolsV2 {
+
     override fun <T : Appendable> printJvmDump(
         appendable: T,
-        classfiles: Iterable<File>,
-        filters: AbiFilters,
+        inputFiles: Iterable<File>,
+        filters: AbiFilters
     ) {
         val filtersMatcher = compileMatcher(filters)
 
-        val signatures = classfiles.asSequence()
-            .map { classfile -> classfile.inputStream() }
+        val signatures = streamsForInputFiles(inputFiles)
             .loadApiFromJvmClasses()
             .filterByMatcher(filtersMatcher)
 
@@ -43,11 +45,34 @@ internal object ToolsV2 : AbiToolsV2 {
 
     override fun extractKlibAbi(
         klib: File,
-        target: KlibTarget,
+        target: KlibTarget?,
         filters: AbiFilters,
     ): KlibDump {
         val dump = KlibDumpImpl.fromKlib(klib, filters)
-        dump.renameSingleTarget(target)
+        if (target != null) {
+            dump.renameSingleTarget(target)
+        }
         return dump
     }
+
+    private fun streamsFromJar(jarFile: File): Sequence<InputStream> {
+        val jar = JarFile(jarFile)
+        return jar.entries().iterator().asSequence()
+            .filter { file ->
+                !file.isDirectory && file.name.endsWith(".class") && !file.name.startsWith("META-INF/")
+            }.map { entry -> jar.getInputStream(entry) }
+    }
+
+    private fun streamsForInputFiles(inputFiles: Iterable<File>): Sequence<InputStream> {
+        return inputFiles.asSequence().flatMap { file ->
+            if (!file.exists() || !file.isFile) {
+                return@flatMap emptySequence()
+            }
+            when (file.extension) {
+                "jar" -> streamsFromJar(file)
+                "class" -> sequenceOf(file.inputStream())
+                else -> emptySequence()
+            }
+        }
+    }
 }

libraries/tools/abi-validation/abi-tools/src/test/kotlin/v2/tests/CasesPublicAPITest.kt

@@ -160,7 +160,7 @@ class CasesPublicAPITest {
         includedClasses: Set<String> = emptySet(),
         excludedClasses: Set<String> = emptySet(),
         includedAnnotatedWith: Set<String> = emptySet(),
-        excludedAnnotatedWith: Set<String> = emptySet(),
+        excludedAnnotatedWith: Set<String> = emptySet()
     ) {
         val filters = AbiFilters(includedClasses, excludedClasses, includedAnnotatedWith, excludedAnnotatedWith)
 
@@ -172,17 +172,17 @@ class CasesPublicAPITest {
 }
 
 internal fun doCheck(testClassPaths: List<File>, target: File, filters: AbiFilters) {
-    val testClasses = testClassPaths.flatMap { it.walk() }.filter { it.name.endsWith(".class") }
-    check(testClasses.isNotEmpty()) { "No class files are found in paths: $testClassPaths" }
+    val inputFiles = testClassPaths.flatMap { it.walk() }.filter { it.extension == "class" || it.extension == "jar" }
+    check(inputFiles.isNotEmpty()) { "No class or jar files are found in paths: $testClassPaths" }
 
     if (!target.exists()) {
         target.bufferedWriter().use { writer ->
-            ToolsV2.printJvmDump(writer, testClasses, filters)
+            ToolsV2.printJvmDump(writer, inputFiles, filters)
         }
         fail("Expected data file did not exist. Generating: $target")
     } else {
         val stringBuffer = StringBuffer()
-        ToolsV2.printJvmDump(stringBuffer, testClasses, filters)
+        ToolsV2.printJvmDump(stringBuffer, inputFiles, filters)
         assertEqualsToFile(target, stringBuffer.toString())
     }
 }

libraries/tools/abi-validation/abi-tools/src/test/kotlin/v2/tests/PrecompiledCasesTest.kt

@@ -25,18 +25,25 @@ class PrecompiledCasesTest {
     @Test
     fun parcelable() = snapshotAPIAndCompare()
 
+    @Test
+    fun jar() {
+        val testDir = baseOutputPath.resolve(testName.methodName)
+        val target = testDir.resolve(testName.methodName + ".txt")
+
+        doCheck(listOf(testDir), target, AbiFilters.EMPTY)
+    }
+
     @OptIn(ExperimentalPathApi::class)
     private fun snapshotAPIAndCompare(
         includedClasses: Set<String> = emptySet(),
         excludedClasses: Set<String> = emptySet(),
         includedAnnotatedWith: Set<String> = emptySet(),
         excludedAnnotatedWith: Set<String> = emptySet(),
     ) {
-        val testClassRelativePath = testName.methodName
+        val testDir = baseOutputPath.resolve(testName.methodName)
         val filters = AbiFilters(includedClasses, excludedClasses, includedAnnotatedWith, excludedAnnotatedWith)
+        val target = testDir.resolve(testName.methodName + ".txt")
 
-        val target = baseOutputPath.resolve(testClassRelativePath).resolve(testName.methodName + ".txt")
-
-        doCheck(listOf(baseOutputPath), target, filters)
+        doCheck(listOf(testDir), target, filters)
     }
 }