Fixed compiler tests classpath

Author: Mr3zee

compiler-plugin/compiler-plugin-k2/build.gradle.kts

@@ -2,6 +2,7 @@
  * Copyright 2023-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
  */
 
+import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
 import org.jetbrains.kotlin.gradle.dsl.ExplicitApiMode
 import util.enableContextReceivers
 import util.otherwise
@@ -10,6 +11,49 @@ import util.whenForIde
 plugins {
     alias(libs.plugins.conventions.jvm)
     alias(libs.plugins.compiler.specific.module)
+    alias(libs.plugins.shadow.jar)
+}
+
+/*
+This is a hack to solve the next problem:
+
+There is PsiElement class that is used in compiler and plugin.
+
+If we use kotlin-compiler-embeddable.jar to compile the module,
+PsiElement is org.jetbrains.kotlin.com.jetbrains.intellij.PsiElement.
+And it works ok in the user projects!
+
+But.
+
+If we run tests, which use kotlin-compiler.jar, we run into ClassNotFoundException.
+Because the class it has in th classpath is com.jetbrains.intellij.PsiElement
+
+- Alright, we can use kotlin-compiler.jar to compile the plugin.
+- No, because the same error now will occur in the user projects,
+  but it is com.jetbrains.intellij.PsiElement that is not found.
+
+- Ok, we can use kotlin-compiler-embeddable.jar to compile tests.
+- Then we ran into java.lang.VerifyError: Bad type on operand stack, which I have no idea how to fix.
+
+This solution replaces org.jetbrains.kotlin.com.jetbrains.intellij.PsiElement usages in plugin
+with com.jetbrains.intellij.PsiElement only for the tests, fixing both use cases.
+It is basically a reverse engineering of what Kotlin does for the embedded jar.
+ */
+val shadowJar = tasks.named<ShadowJar>("shadowJar") {
+    configurations = listOf(project.configurations.compileClasspath.get())
+    relocate("org.jetbrains.kotlin.com.intellij.psi", "com.intellij.psi")
+
+    exclude("javaslang/**")
+    exclude("kotlin/**")
+    exclude("messages/**")
+    exclude("misc/**")
+    exclude("org/**")
+
+    archiveFileName.set("plugin-k2-for-tests.jar")
+}
+
+tasks.jar {
+    finalizedBy(shadowJar)
 }
 
 kotlin {

tests/compiler-plugin-tests/build.gradle.kts

@@ -27,6 +27,8 @@ kotlin {
 val testDataClasspath: Configuration by configurations.creating
 val testRuntimeClasspath: Configuration by project.configurations.getting
 
+val globalRootDir: String by extra
+
 /**
  * I should probably explain this.
  *
@@ -36,7 +38,7 @@ val testRuntimeClasspath: Configuration by project.configurations.getting
  *
  * `NioFiles` is problematic.
  * It was packed with kotlin-compiler jar, but Proguard which excluded `deleteRecursively` method from it.
- * It this method is called.
+ * And this method is called.
  * So tests fail with:
  * ```
  * java.lang.NoSuchMethodError: com.intellij.openapi.util.io.NioFiles.deleteRecursively(Ljava/nio/file/Path;)V
@@ -62,7 +64,6 @@ sourceSets.test.configure {
 }
 
 dependencies {
-    @Suppress("UnstableApiUsage")
     testPriorityRuntimeClasspath(libs.intellij.util) { isTransitive = false }
 
     implementation(projects.core)
@@ -79,7 +80,10 @@ dependencies {
         testImplementation(libs.serialization.plugin)
     }
 
-    testImplementation(libs.compiler.plugin.cli)
+    testImplementation(libs.compiler.plugin.cli) {
+        exclude(group = "org.jetbrains.kotlinx", module = "compiler-plugin-k2")
+    }
+    testImplementation(files("$globalRootDir/compiler-plugin/compiler-plugin-k2/build/libs/plugin-k2-for-tests.jar"))
 
     testImplementation(libs.kotlin.reflect)
     testImplementation(libs.kotlin.compiler)
@@ -99,8 +103,6 @@ dependencies {
     testDataClasspath(libs.serialization.core)
 }
 
-val globalRootDir: String by extra
-
 val updateTestData = (project.findProperty("kotlin.test.update.test.data") as? String) ?: "false"
 
 tasks.test {
@@ -154,7 +156,7 @@ fun Test.setJarPathAsProperty(
 
     val path = testRuntimeClasspath
         .files
-        .first { includedRegex.matches(it.name) }
+        .firstOrNull { includedRegex.matches(it.name) }
         ?: run {
             logger.warn("Can't find $jarName in testRuntimeClasspath configuration")
             return

versions-root/libs.versions.toml

@@ -20,6 +20,7 @@ junit5 = "5.11.3"
 intellij = "233.13135.128"
 gradle-doctor = "0.10.0"
 kotlinx-browser = "0.2"
+shadow-jar = "9.0.0-beta2"
 
 # Stub versions – relpaced based on kotlin, mostly for gradle-related (plugins) dependencies
 #  but also for dependencies for compiler-specific modules.
@@ -112,6 +113,7 @@ atomicfu = { id = "org.jetbrains.kotlinx.atomicfu", version.ref = "atomicfu" }
 gradle-kotlin-dsl = { id = "org.gradle.kotlin.kotlin-dsl", version.ref = "gradle-kotlin-dsl" }
 kover = { id = "org.jetbrains.kotlinx.kover", version.ref = "kover" }
 gradle-plugin-publish = { id = "com.gradle.plugin-publish", version.ref = "gradle-plugin-publish" }
+shadow-jar = { id = "com.gradleup.shadow", version.ref = "shadow-jar" }
 
 # gradle-conventions project
 conventions-common = { id = "conventions-common", version.ref = "kotlinx-rpc" }