[ABI Validation] Filter out $EntriesMappings class for Kotlin's 1.9 feature 'Enum entries'

* Filter out $EntriesMappings class for Kotlin's 1.9 feature 'Enum entries'

Kotlin compiler generates synthetic class holding EnumEntries starting from 1.9.
This change filters out such classes from the API dump.

* Upgrade a Kotlin version and remove stdlib exclusion

Changed config to make testing of Enum.entries possible.
Enum.entries require stdlib >= 1.8.20.
Exclusion of stdlib artifacts is only required when Gradle's Kotlin version is higher than the project's one.

Fixes Kotlin/binary-compatibility-validator#141
Pull request Kotlin/binary-compatibility-validator#144

Author: fzhinkin

libraries/tools/abi-validation/build.gradle.kts

@@ -66,12 +66,6 @@ val createClasspathManifest = tasks.register("createClasspathManifest") {
 val kotlinVersion: String by project
 val androidGradlePluginVersion: String = "7.2.2"
 
-configurations.implementation {
-    exclude(group = "org.jetbrains.kotlin", module = "kotlin-stdlib")
-    exclude(group = "org.jetbrains.kotlin", module = "kotlin-stdlib-jdk7")
-    exclude(group = "org.jetbrains.kotlin", module = "kotlin-stdlib-jdk8")
-}
-
 dependencies {
     implementation(gradleApi())
     implementation("org.jetbrains.kotlinx:kotlinx-metadata-jvm:0.6.2")
@@ -116,7 +110,8 @@ java {
 tasks {
     compileTestKotlin {
         kotlinOptions {
-            languageVersion = "1.6"
+            languageVersion = "1.9"
+            freeCompilerArgs += "-Xsuppress-version-warnings"
         }
     }
     test {

libraries/tools/abi-validation/gradle.properties

@@ -1,7 +1,7 @@
 version=0.13.2-SNAPSHOT
 group=org.jetbrains.kotlinx
 
-kotlinVersion=1.8.10
+kotlinVersion=1.8.20
 pluginPublishVersion=0.10.1
 
 kotlin.stdlib.default.dependency=false

libraries/tools/abi-validation/src/main/kotlin/api/AsmMetadataLoading.kt

@@ -32,6 +32,7 @@ fun ClassNode.isEffectivelyPublic(classVisibility: ClassVisibility?) =
             && !isLocal()
             && !isWhenMappings()
             && !isSyntheticAnnotationClass()
+            && !isEnumEntriesMappings()
             && (classVisibility?.isPublic(isPublishedApi()) ?: true)
 
 
@@ -40,6 +41,7 @@ fun ClassNode.isLocal() = outerMethod != null
 fun ClassNode.isInner() = innerClassNode != null
 fun ClassNode.isWhenMappings() = isSynthetic(access) && name.endsWith("\$WhenMappings")
 fun ClassNode.isSyntheticAnnotationClass() = isSynthetic(access) && name.contains("\$annotationImpl\$")
+fun ClassNode.isEnumEntriesMappings() = isSynthetic(access) && name.endsWith("\$EntriesMappings")
 
 val ClassNode.effectiveAccess: Int get() = innerClassNode?.access ?: access
 val ClassNode.outerClassName: String? get() = innerClassNode?.outerName

libraries/tools/abi-validation/src/test/kotlin/cases/enums/EnumClass.kt

@@ -0,0 +1,8 @@
+/*
+ * Copyright 2016-2023 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 cases.enums
+
+enum class EnumClass { A, B, C }

libraries/tools/abi-validation/src/test/kotlin/cases/enums/JavaEnum.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright 2016-2023 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 cases.enums;
+
+public enum JavaEnum {
+    JA, JB, JC
+}

libraries/tools/abi-validation/src/test/kotlin/cases/enums/entries.kt

@@ -0,0 +1,13 @@
+package cases.enums
+
+@OptIn(ExperimentalStdlibApi::class)
+fun test() {
+    EnumClass.entries.forEach {
+        println(it)
+    }
+
+    JavaEnum.entries.forEach {
+        println(it)
+    }
+}
+

libraries/tools/abi-validation/src/test/kotlin/cases/enums/enums.txt

@@ -0,0 +1,21 @@
+public final class cases/enums/EntriesKt {
+	public static final fun test ()V
+}
+
+public final class cases/enums/EnumClass : java/lang/Enum {
+	public static final field A Lcases/enums/EnumClass;
+	public static final field B Lcases/enums/EnumClass;
+	public static final field C Lcases/enums/EnumClass;
+	public static fun getEntries ()Lkotlin/enums/EnumEntries;
+	public static fun valueOf (Ljava/lang/String;)Lcases/enums/EnumClass;
+	public static fun values ()[Lcases/enums/EnumClass;
+}
+
+public final class cases/enums/JavaEnum : java/lang/Enum {
+	public static final field JA Lcases/enums/JavaEnum;
+	public static final field JB Lcases/enums/JavaEnum;
+	public static final field JC Lcases/enums/JavaEnum;
+	public static fun valueOf (Ljava/lang/String;)Lcases/enums/JavaEnum;
+	public static fun values ()[Lcases/enums/JavaEnum;
+}
+

libraries/tools/abi-validation/src/test/kotlin/cases/whenMappings/whenMappings.txt

@@ -7,6 +7,7 @@ public final class cases/whenMappings/SampleEnum : java/lang/Enum {
 	public static final field A Lcases/whenMappings/SampleEnum;
 	public static final field B Lcases/whenMappings/SampleEnum;
 	public static final field C Lcases/whenMappings/SampleEnum;
+	public static fun getEntries ()Lkotlin/enums/EnumEntries;
 	public static fun valueOf (Ljava/lang/String;)Lcases/whenMappings/SampleEnum;
 	public static fun values ()[Lcases/whenMappings/SampleEnum;
 }

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

@@ -55,6 +55,8 @@ class CasesPublicAPITest {
 
     @Test fun whenMappings() { snapshotAPIAndCompare(testName.methodName) }
 
+    @Test fun enums() { snapshotAPIAndCompare(testName.methodName) }
+
     private fun snapshotAPIAndCompare(testClassRelativePath: String, nonPublicMarkers: Set<String> = emptySet()) {
         val testClassPaths = baseClassPaths.map { it.resolve(testClassRelativePath) }
         val testClasses = testClassPaths.flatMap { it.listFiles().orEmpty().asIterable() }