[Build, BTA] Add the build tools api tests module

The module is configured to run a bunch of test suites defined as API pairs. Currently those are `CURRENT API` – `CURRENT IMPL`, `CURRENT API` – `1.9.20 IMPL`, `1.9.20 API` – `CURRENT IMPL` ^KT-61860 In Progress
2023-11-09 21:25:03 +01:00
parent 0196928af7
commit 4afb393ff1
5 changed files with 226 additions and 1 deletions
@@ -0,0 +1,143 @@
+import org.gradle.configurationcache.extensions.capitalized
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+import org.jetbrains.kotlin.tooling.core.KotlinToolingVersion
+
+plugins {
+    kotlin("jvm")
+    id("jps-compatible")
+    `jvm-test-suite`
+}
+
+dependencies {
+    api(kotlinStdlib())
+}
+
+kotlin {
+    compilerOptions {
+        optIn.add("org.jetbrains.kotlin.buildtools.api.ExperimentalBuildToolsApi")
+    }
+}
+
+class BuildToolsApiTestSuit(
+    val testName: String,
+    val apiVersion: BuildToolsVersion,
+    val implVersion: BuildToolsVersion,
+    /**
+     * Tells whether only tests marked with the `CompatibilityTest` JUnit tag must be run
+     */
+    val onlyCompatibilityTests: Boolean = true,
+)
+
+val testMatrix = listOf(
+    BuildToolsApiTestSuit(
+        "testDefaultToDefault",
+        BuildToolsVersion(KotlinToolingVersion(project.version.toString()), isCurrent = true),
+        BuildToolsVersion(KotlinToolingVersion(project.version.toString()), isCurrent = true),
+        onlyCompatibilityTests = false,
+    ),
+    BuildToolsApiTestSuit(
+        "test1.9.20ToDefault",
+        BuildToolsVersion(KotlinToolingVersion(1, 9, 20, null)),
+        BuildToolsVersion(KotlinToolingVersion(project.version.toString()), isCurrent = true),
+    ),
+    BuildToolsApiTestSuit(
+        "testDefaultTo1.9.20",
+        BuildToolsVersion(KotlinToolingVersion(project.version.toString()), isCurrent = true),
+        BuildToolsVersion(KotlinToolingVersion(1, 9, 20, null)),
+    ),
+)
+
+val SourceSet.kotlinCompileTask
+    get() = tasks.named<KotlinCompile>("compile${name.capitalized()}Kotlin")
+
+class BuildToolsVersion(val version: KotlinToolingVersion, val isCurrent: Boolean = false) {
+    override fun toString() = version.toString()
+}
+
+fun KotlinCompile.ensureCompiledAgainstExpectedBuildToolsApiVersion(version: BuildToolsVersion) {
+    if (version.isCurrent) return
+    // the check is required for the case when Gradle substitutes external dependencies with project ones
+    doFirst {
+        check(libraries.any { "kotlin-build-tools-api-${version}" in it.name }) {
+            "compilation classpath must contain kotlin-build-tools-api:$version"
+        }
+    }
+}
+
+fun Test.ensureExecutedAgainstExpectedBuildToolsImplVersion(version: BuildToolsVersion) {
+    if (version.isCurrent) return
+    // the check is required for the case when Gradle substitutes external dependencies with project ones
+    doFirst {
+        check(classpath.any { "kotlin-build-tools-impl-${version}" in it.name }) {
+            "runtime classpath must contain kotlin-build-tools-impl:$version"
+        }
+    }
+}
+
+fun SourceSet.configureApiVersionSourceDirectories() {
+    java.setSrcDirs(
+        listOf(
+            layout.projectDirectory.dir("src/testCommon/java"),
+        )
+    )
+    kotlin.setSrcDirs(
+        listOf(
+            layout.projectDirectory.dir("src/testCommon/java"),
+            layout.projectDirectory.dir("src/testCommon/kotlin"),
+        )
+    )
+    resources.setSrcDirs(
+        listOf(
+            layout.projectDirectory.dir("src/testCommon/resources"),
+        )
+    )
+}
+
+testing {
+    suites {
+        for (suitConfig in testMatrix) {
+            register<JvmTestSuite>(suitConfig.testName) {
+                sources.configureApiVersionSourceDirectories()
+                dependencies {
+                    useJUnitJupiter(libs.versions.junit5.get())
+
+                    compileOnly(project()) // propagate stdlib from the main dependencies for compilation,
+                    // the runtime dependency provides the actual required version
+                    implementation(project(":kotlin-tooling-core")) // to reuse `KotlinToolingVersion`
+
+                    if (suitConfig.apiVersion.isCurrent) {
+                        compileOnly(project(":compiler:build-tools:kotlin-build-tools-api"))
+                    } else {
+                        compileOnly("org.jetbrains.kotlin:kotlin-build-tools-api:${suitConfig.apiVersion}")
+                    }
+                    sources.kotlinCompileTask.configure {
+                        ensureCompiledAgainstExpectedBuildToolsApiVersion(suitConfig.apiVersion)
+                    }
+
+                    if (suitConfig.implVersion.isCurrent) {
+                        runtimeOnly(project(":compiler:build-tools:kotlin-build-tools-impl"))
+                    } else {
+                        runtimeOnly("org.jetbrains.kotlin:kotlin-build-tools-impl:${suitConfig.implVersion}")
+                    }
+                }
+
+                targets.all {
+                    projectTest(taskName = testTask.name, jUnitMode = JUnitMode.JUnit5) {
+                        ensureExecutedAgainstExpectedBuildToolsImplVersion(suitConfig.implVersion)
+                        useJUnitPlatform {
+                            if (suitConfig.onlyCompatibilityTests) {
+                                includeTags("CompatibilityTest")
+                            }
+                        }
+                        systemProperty("kotlin.build-tools-api.log.level", "DEBUG")
+                        systemProperty("kotlin.build-tools-api.impl-version", suitConfig.implVersion.toString()) // TODO: remove after KT-63862
+                    }
+                }
+            }
+        }
+    }
+}
+
+tasks.named("check") {
+    dependsOn(testing.suites)
+}
@@ -0,0 +1,13 @@
+/*
+ * Copyright 2010-2023 JetBrains s.r.o. and Kotlin Programming Language contributors.
+ * Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
+ */
+
+package org.jetbrains.kotlin.buildtools.api.tests
+
+import org.junit.jupiter.api.Tag
+
+@Target(AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.FUNCTION)
+@Retention(AnnotationRetention.RUNTIME)
+@Tag("CompatibilityTest")
+annotation class CompatibilityTest
@@ -0,0 +1,14 @@
+/*
+ * Copyright 2010-2023 JetBrains s.r.o. and Kotlin Programming Language contributors.
+ * Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
+ */
+
+package org.jetbrains.kotlin.buildtools.api.tests
+
+import org.jetbrains.kotlin.tooling.core.KotlinToolingVersion
+
+// TODO: remove after KT-63862
+const val IMPL_VERSION_SYSTEM_PROPERTY = "kotlin.build-tools-api.impl-version"
+val buildToolsVersion = System.getProperty(IMPL_VERSION_SYSTEM_PROPERTY)
+    ?.let { KotlinToolingVersion(it) }
+    ?: error("The build tools implementation version must be passed via the `$IMPL_VERSION_SYSTEM_PROPERTY` system property to the tests")