introduce common-deps module for classpath isolation

google · Oct 11, 2023 · c3de1a5 · c3de1a5
1 parent ed8d94b
commit c3de1a5
Show file tree

Hide file tree

Showing 12 changed files with 90 additions and 13 deletions.
diff --git a/api/src/main/kotlin/com/google/devtools/ksp/processing/ExitCode.kt b/api/src/main/kotlin/com/google/devtools/ksp/processing/ExitCode.kt
@@ -0,0 +1,10 @@
+package com.google.devtools.ksp.processing
+
+enum class ExitCode(code: Int) {
+    OK(0),
+
+    // Whenever there are some error messages.
+    PROCESSING_ERROR(1),
+
+    // Let exceptions pop through to the caller. Don't catch and convert them to, e.g., INTERNAL_ERROR.
+}
diff --git a/common-deps/build.gradle.kts b/common-deps/build.gradle.kts
@@ -0,0 +1,59 @@
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
+description = "Kotlin Symbol Processor"
+
+val kotlinBaseVersion: String by project
+val junitVersion: String by project
+val googleTruthVersion: String by project
+val agpBaseVersion: String by project
+val signingKey: String? by project
+val signingPassword: String? by project
+
+tasks.withType<KotlinCompile> {
+    compilerOptions.freeCompilerArgs.add("-Xjvm-default=all-compatibility")
+}
+
+plugins {
+    kotlin("jvm")
+    `maven-publish`
+    signing
+    id("org.jetbrains.dokka")
+}
+
+dependencies {
+    compileOnly(project(":api"))
+}
+
+tasks {
+    val sourcesJar by creating(Jar::class) {
+        archiveClassifier.set("sources")
+        from(project.sourceSets.main.get().allSource)
+    }
+}
+
+val dokkaJavadocJar by tasks.register<Jar>("dokkaJavadocJar") {
+    dependsOn(tasks.dokkaJavadoc)
+    from(tasks.dokkaJavadoc.flatMap { it.outputDirectory })
+    archiveClassifier.set("javadoc")
+}
+
+publishing {
+    publications {
+        create<MavenPublication>("default") {
+            artifactId = "symbol-processing-common-deps"
+            from(components["java"])
+            artifact(tasks["sourcesJar"])
+            artifact(tasks["dokkaJavadocJar"])
+            pom {
+                name.set("com.google.devtools.ksp:symbol-processing-common-deps")
+                description.set("Kotlin Symbol processing Gradle Utils")
+            }
+        }
+    }
+}
+
+signing {
+    isRequired = hasProperty("signingKey")
+    useInMemoryPgpKeys(signingKey, signingPassword)
+    sign(extensions.getByType<PublishingExtension>().publications)
+}
diff --git a/...com/google/devtools/ksp/impl/KSPConfig.kt → ...tlin/com/google/devtools/ksp/KSPConfig.kt b/...com/google/devtools/ksp/impl/KSPConfig.kt → ...tlin/com/google/devtools/ksp/KSPConfig.kt
@@ -1,4 +1,4 @@
-package com.google.devtools.ksp.impl
+package com.google.devtools.ksp.processing
 
 import java.io.File
 import java.io.Serializable

diff --git a/...ogle/devtools/ksp/impl/KspGradleLogger.kt → ...om/google/devtools/ksp/KspGradleLogger.kt b/...ogle/devtools/ksp/impl/KspGradleLogger.kt → ...om/google/devtools/ksp/KspGradleLogger.kt
@@ -14,9 +14,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.google.devtools.ksp.impl
+package com.google.devtools.ksp.processing
 
-import com.google.devtools.ksp.processing.KSPLogger
 import com.google.devtools.ksp.symbol.KSNode
 
 class KspGradleLogger(val loglevel: Int) : KSPLogger {

diff --git a/gradle-plugin/build.gradle.kts b/gradle-plugin/build.gradle.kts
@@ -28,10 +28,9 @@ dependencies {
     // replace AGP dependency w/ gradle-api when we have source registering API available.
     compileOnly("com.android.tools.build:gradle:$agpBaseVersion")
     compileOnly(gradleApi())
-    implementation(project(":kotlin-analysis-api")) {
-        isTransitive = false
-    }
+    compileOnly(project(":kotlin-analysis-api"))
     implementation(project(":api"))
+    implementation(project(":common-deps"))
     testImplementation(gradleApi())
     testImplementation(project(":api"))
     testImplementation(project(":common-util"))
@@ -141,6 +140,7 @@ tasks.named("processTestResources").configure {
 
 tasks.named<Test>("test").configure {
     dependsOn(":api:publishAllPublicationsToTestRepository")
+    dependsOn(":common-deps:publishAllPublicationsToTestRepository")
     dependsOn(":gradle-plugin:publishAllPublicationsToTestRepository")
     dependsOn(":symbol-processing:publishAllPublicationsToTestRepository")
     dependsOn(":kotlin-analysis-api:publishAllPublicationsToTestRepository")

diff --git a/gradle-plugin/src/main/kotlin/com/google/devtools/ksp/gradle/KspAATask.kt b/gradle-plugin/src/main/kotlin/com/google/devtools/ksp/gradle/KspAATask.kt
@@ -1,9 +1,9 @@
 package com.google.devtools.ksp.gradle
 
-import com.google.devtools.ksp.impl.KSPJvmConfig
-import com.google.devtools.ksp.impl.KSPLoader
 import com.google.devtools.ksp.impl.KotlinSymbolProcessing
-import com.google.devtools.ksp.impl.KspGradleLogger
+import com.google.devtools.ksp.processing.ExitCode
+import com.google.devtools.ksp.processing.KSPJvmConfig
+import com.google.devtools.ksp.processing.KspGradleLogger
 import org.gradle.api.DefaultTask
 import org.gradle.api.artifacts.Configuration
 import org.gradle.api.file.ConfigurableFileCollection
@@ -80,6 +80,9 @@ abstract class KspAATask @Inject constructor(
             val kspTaskName = kotlinCompileProvider.name.replaceFirst("compile", "ksp")
             val kspAADepCfg = project.configurations.detachedConfiguration(
                 project.dependencies.create("${KspGradleSubplugin.KSP_GROUP_ID}:symbol-processing-aa:$KSP_VERSION"),
+                project.dependencies.create(
+                    "${KspGradleSubplugin.KSP_GROUP_ID}:symbol-processing-common-deps:$KSP_VERSION"
+                ),
                 project.dependencies.create("org.jetbrains.intellij.deps:trove4j:1.0.20200330"),
             ).apply {
                 isTransitive = false
@@ -327,7 +330,7 @@ abstract class KspAAWorkerAction : WorkAction<KspAAWorkParameter> {
         objectOutputStream.writeObject(kspConfig)
 
         val exitCode = try {
-            val kspLoaderClass = isolatedClassLoader.loadClass(KSPLoader::class.java.canonicalName)
+            val kspLoaderClass = isolatedClassLoader.loadClass("com.google.devtools.ksp.impl.KSPLoader")
             val runMethod = kspLoaderClass.getMethod(
                 "loadAndRunKSP",
                 ByteArray::class.java,
@@ -340,14 +343,14 @@ abstract class KspAAWorkerAction : WorkAction<KspAAWorkParameter> {
                 processorProviders,
                 gradleCfg.logLevel.get().ordinal
             ) as Int
-            KotlinSymbolProcessing.ExitCode.values()[returnCode]
+            ExitCode.values()[returnCode]
         } catch (e: Exception) {
             require(e is InvocationTargetException)
             kspGradleLogger.exception(e.targetException)
             throw e.targetException
         }
 
-        if (exitCode != KotlinSymbolProcessing.ExitCode.OK) {
+        if (exitCode != ExitCode.OK) {
             throw Exception("KSP failed with exit code: $exitCode")
         }
     }

diff --git a/integration-tests/build.gradle.kts b/integration-tests/build.gradle.kts
@@ -28,6 +28,7 @@ tasks.withType<Test> {
     jvmArgumentProviders.add(RelativizingInternalPathProvider("testRepo", File(rootProject.buildDir, "repos/test")))
     dependsOn(":api:publishAllPublicationsToTestRepository")
     dependsOn(":gradle-plugin:publishAllPublicationsToTestRepository")
+    dependsOn(":common-deps:publishAllPublicationsToTestRepository")
     dependsOn(":symbol-processing:publishAllPublicationsToTestRepository")
     dependsOn(":symbol-processing-cmdline:publishAllPublicationsToTestRepository")
     dependsOn(":kotlin-analysis-api:publishAllPublicationsToTestRepository")

diff --git a/kotlin-analysis-api/build.gradle.kts b/kotlin-analysis-api/build.gradle.kts
@@ -62,6 +62,7 @@ dependencies {
     implementation("org.jetbrains.intellij.deps:asm-all:$aaAsmVersion")
     implementation("org.codehaus.woodstox:stax2-api:$aaStax2Version") { isTransitive = false }
     implementation("com.fasterxml:aalto-xml:$aaAaltoXmlVersion") { isTransitive = false }
+    compileOnly(project(":common-deps"))
 
     implementation(project(":api"))
     implementation(project(":common-util"))

diff --git a/kotlin-analysis-api/src/main/kotlin/com/google/devtools/ksp/impl/KSPLoader.kt b/kotlin-analysis-api/src/main/kotlin/com/google/devtools/ksp/impl/KSPLoader.kt
@@ -16,6 +16,8 @@
  */
 package com.google.devtools.ksp.impl
 
+import com.google.devtools.ksp.processing.KSPJvmConfig
+import com.google.devtools.ksp.processing.KspGradleLogger
 import com.google.devtools.ksp.processing.SymbolProcessorProvider
 import java.io.ByteArrayInputStream
 import java.io.ObjectInputStream

diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -10,6 +10,7 @@ pluginManagement {
 
 include("api")
 include("gradle-plugin")
+include("common-deps")
 include("common-util")
 include("test-utils")
 include("compiler-plugin")

diff --git a/test-utils/build.gradle.kts b/test-utils/build.gradle.kts
@@ -51,6 +51,7 @@ dependencies {
     runtimeOnly("org.junit.platform:junit-platform-suite:$junitPlatformVersion")
 
     implementation(kotlin("stdlib", kotlinBaseVersion))
+    implementation(project(":common-deps"))
     implementation("org.jetbrains.kotlin:kotlin-compiler:$kotlinBaseVersion")
     implementation("org.jetbrains.kotlin:kotlin-compiler-internal-test-framework:$kotlinBaseVersion")
     implementation("org.jetbrains.kotlin:kotlin-scripting-compiler:$kotlinBaseVersion")

diff --git a/test-utils/src/test/kotlin/com/google/devtools/ksp/test/AbstractKSPAATest.kt b/test-utils/src/test/kotlin/com/google/devtools/ksp/test/AbstractKSPAATest.kt
@@ -18,8 +18,8 @@
 package com.google.devtools.ksp.test
 
 import com.google.devtools.ksp.impl.CommandLineKSPLogger
-import com.google.devtools.ksp.impl.KSPJvmConfig
 import com.google.devtools.ksp.impl.KotlinSymbolProcessing
+import com.google.devtools.ksp.processing.KSPJvmConfig
 import com.google.devtools.ksp.processor.AbstractTestProcessor
 import org.jetbrains.kotlin.cli.jvm.K2JVMCompiler
 import org.jetbrains.kotlin.cli.jvm.config.jvmClasspathRoots