Add ksp compiler support (#160)

Author: minkuan88

WORKSPACE

@@ -12,14 +12,26 @@ KOTLIN_VERSION = "1.9.25"
 
 KOTLINC_RELEASE_SHA = "6ab72d6144e71cbbc380b770c2ad380972548c63ab6ed4c79f11c88f2967332e"
 
-load("@io_bazel_rules_kotlin//kotlin:repositories.bzl", "kotlin_repositories", "kotlinc_version")
+KSP_VERSION = "1.8.10-1.0.9"
+
+KSP_COMPILER_RELEASE_SHA = "2f60c27956e4033c4c94355624e3fe88f255df42d8b67af44c1f2cdcbd513a13"
+
+load("@io_bazel_rules_kotlin//kotlin:repositories.bzl", "kotlin_repositories", "kotlinc_version", "ksp_version")
 
 KOTLINC_RELEASE = kotlinc_version(
     release = KOTLIN_VERSION,
     sha256 = KOTLINC_RELEASE_SHA,
 )
 
-kotlin_repositories(compiler_release = KOTLINC_RELEASE)
+KSP_COMPILER_RELEASE = ksp_version(
+    release = KSP_VERSION,
+    sha256 = KSP_COMPILER_RELEASE_SHA,
+)
+
+kotlin_repositories(
+    compiler_release = KOTLINC_RELEASE,
+    ksp_compiler_release = KSP_COMPILER_RELEASE,
+)
 
 register_toolchains("//:kotlin_toolchain")
 

build.gradle

@@ -129,6 +129,10 @@ grazel {
                 tag = "1.9.25"
                 sha = "6ab72d6144e71cbbc380b770c2ad380972548c63ab6ed4c79f11c88f2967332e"
             }
+            kspCompiler {
+                tag = "1.8.10-1.0.9"
+                sha = "2f60c27956e4033c4c94355624e3fe88f255df42d8b67af44c1f2cdcbd513a13"
+            }
             toolchain {
                 enabled = true
                 apiVersion = "1.7"

grazel-gradle-plugin/src/main/kotlin/com/grab/grazel/bazel/rules/KotlinRules.kt

@@ -50,28 +50,58 @@ fun StatementsBuilder.kotlinRepository(repositoryRule: BazelRepositoryRule) {
 private const val KOTLIN_VERSION = "KOTLIN_VERSION"
 private const val KOTLINC_RELEASE = "KOTLINC_RELEASE"
 private const val KOTLINC_RELEASE_SHA = "KOTLINC_RELEASE_SHA"
+private const val KSP_VERSION = "KSP_VERSION"
+private const val KSP_COMPILER_RELEASE = "KSP_COMPILER_RELEASE"
+private const val KSP_COMPILER_RELEASE_SHA = "KSP_COMPILER_RELEASE_SHA"
 
 fun StatementsBuilder.kotlinCompiler(
     kotlinCompilerVersion: String,
-    kotlinCompilerReleaseSha: String
+    kotlinCompilerReleaseSha: String,
+    kspCompilerVersion: String? = null,
+    kspCompilerReleaseSha: String? = null
 ) {
     KOTLIN_VERSION `=` kotlinCompilerVersion.quote
     KOTLINC_RELEASE_SHA `=` kotlinCompilerReleaseSha.quote
+
+    val hasKsp = kspCompilerVersion != null && kspCompilerReleaseSha != null
+    if (hasKsp) {
+        KSP_VERSION `=` kspCompilerVersion!!.quote
+        KSP_COMPILER_RELEASE_SHA `=` kspCompilerReleaseSha!!.quote
+    }
     newLine()
 
-    load(
-        "@io_bazel_rules_kotlin//kotlin:repositories.bzl",
-        "kotlin_repositories",
-        "kotlinc_version"
-    )
+    if (hasKsp) {
+        load(
+            "@io_bazel_rules_kotlin//kotlin:repositories.bzl",
+            "kotlin_repositories",
+            "kotlinc_version",
+            "ksp_version"
+        )
+    } else {
+        load(
+            "@io_bazel_rules_kotlin//kotlin:repositories.bzl",
+            "kotlin_repositories",
+            "kotlinc_version"
+        )
+    }
 
     KOTLINC_RELEASE `=` """kotlinc_version(
         release = $KOTLIN_VERSION,
         sha256 = $KOTLINC_RELEASE_SHA
     )
     """.trimIndent()
 
-    add("""kotlin_repositories(compiler_release = $KOTLINC_RELEASE)""")
+    if (hasKsp) {
+        KSP_COMPILER_RELEASE `=` """ksp_version(
+            release = $KSP_VERSION,
+            sha256 = $KSP_COMPILER_RELEASE_SHA
+        )
+        """.trimIndent()
+
+        add("""kotlin_repositories(compiler_release = $KOTLINC_RELEASE, ksp_compiler_release = $KSP_COMPILER_RELEASE)""")
+    } else {
+        add("""kotlin_repositories(compiler_release = $KOTLINC_RELEASE)""")
+    }
 }
 
 /**

grazel-gradle-plugin/src/main/kotlin/com/grab/grazel/extension/KotlinExtension.kt

@@ -70,6 +70,18 @@ data class KotlinCompiler(
     var sha: String = "46720991a716e90bfc0cf3f2c81b2bd735c14f4ea6a5064c488e04fd76e6b6c7"
 )
 
+/**
+ * Configuration for KSP (Kotlin Symbol Processing) compiler.
+ * When configured, KSP compiler release will be added to kotlin_repositories in WORKSPACE.
+ *
+ * @param tag KSP version tag (e.g., "1.8.10-1.0.9")
+ * @param sha SHA256 hash of the KSP compiler release
+ */
+data class KspCompiler(
+    var tag: String? = null,
+    var sha: String? = null
+)
+
 /**
  * Configuration for Kotlin compiler and toolchains. Options configured will be used in root `BUILD.bazel`, `WORKSPACE`
  * respectively.
@@ -95,6 +107,7 @@ data class KotlinCompiler(
  */
 data class KotlinExtension(
     val compiler: KotlinCompiler = KotlinCompiler(),
+    val kspCompiler: KspCompiler = KspCompiler(),
     val kotlinCOptions: KotlinCOptions = KotlinCOptions(),
     val javaCOptions: JavaCOptions = JavaCOptions(),
     val toolchain: KotlinToolChain = KotlinToolChain(),
@@ -137,6 +150,15 @@ data class KotlinExtension(
         closure.call()
     }
 
+    fun kspCompiler(block: KspCompiler.() -> Unit) {
+        block(kspCompiler)
+    }
+
+    fun kspCompiler(closure: Closure<*>) {
+        closure.delegate = kspCompiler
+        closure.call()
+    }
+
     fun gitRepository(closure: Closure<*>) {
         repository = GitRepositoryRule(name = RULE_KOTLIN_NAME, remote = "")
         closure.delegate = repository

grazel-gradle-plugin/src/main/kotlin/com/grab/grazel/migrate/internal/WorkspaceBuilder.kt

@@ -196,12 +196,18 @@ internal class WorkspaceBuilder(
      * Add Kotlin specific statements to WORKSPACE namely
      * * Kotlin repository
      * * Kotlin compiler
+     * * KSP compiler (if configured)
      * * Registering toolchains
      */
     private fun StatementsBuilder.kotlinRules() {
         val kotlin = grazelExtension.rules.kotlin
         kotlinRepository(repositoryRule = kotlin.repository)
-        kotlinCompiler(kotlin.compiler.tag, kotlin.compiler.sha)
+        kotlinCompiler(
+            kotlinCompilerVersion = kotlin.compiler.tag,
+            kotlinCompilerReleaseSha = kotlin.compiler.sha,
+            kspCompilerVersion = kotlin.kspCompiler.tag,
+            kspCompilerReleaseSha = kotlin.kspCompiler.sha
+        )
         registerKotlinToolchain(toolchain = kotlin.toolchain)
     }
 }

grazel-gradle-plugin/src/test/kotlin/com/grab/grazel/migrate/KotlinWorkspaceRulesTest.kt

@@ -137,6 +137,61 @@ class KotlinWorkspaceRulesTest {
         }
     }
 
+    @Test
+    fun `assert KSP compiler not generated when not configured`() {
+        val kotlinTag = "1.6.21"
+        val kotlinSha = "somesha256"
+        rootProject.configure<GrazelExtension> {
+            rules.kotlin.compiler {
+                tag = kotlinTag
+                sha = kotlinSha
+            }
+        }
+        generateWorkspace().truth {
+            contains("""KOTLIN_VERSION = "$kotlinTag"""")
+            contains("""KOTLINC_RELEASE_SHA = "$kotlinSha"""")
+            contains("kotlin_repositories(compiler_release = KOTLINC_RELEASE)")
+            doesNotContain("KSP_VERSION")
+            doesNotContain("KSP_COMPILER_RELEASE")
+            doesNotContain("ksp_version")
+            doesNotContain("ksp_compiler_release")
+        }
+    }
+
+    @Test
+    fun `assert KSP compiler generated when configured`() {
+        val kotlinTag = "1.8.10"
+        val kotlinSha = "kotlinsha256"
+        val kspTag = "1.8.10-1.0.9"
+        val kspSha = "kspsha256"
+        rootProject.configure<GrazelExtension> {
+            rules.kotlin {
+                compiler {
+                    tag = kotlinTag
+                    sha = kotlinSha
+                }
+                kspCompiler {
+                    tag = kspTag
+                    sha = kspSha
+                }
+            }
+        }
+        generateWorkspace().truth {
+            // Kotlin compiler vars
+            contains("""KOTLIN_VERSION = "$kotlinTag"""")
+            contains("""KOTLINC_RELEASE_SHA = "$kotlinSha"""")
+            // KSP compiler vars
+            contains("""KSP_VERSION = "$kspTag"""")
+            contains("""KSP_COMPILER_RELEASE_SHA = "$kspSha"""")
+            // Load statement should include ksp_version
+            contains("ksp_version")
+            // KSP_COMPILER_RELEASE assignment
+            contains("KSP_COMPILER_RELEASE = ksp_version(")
+            // kotlin_repositories should include ksp_compiler_release
+            contains("ksp_compiler_release = KSP_COMPILER_RELEASE")
+        }
+    }
+
     fun generateWorkspace() = workspaceFactory
         .create(
             projectsToMigrate = listOf(rootProject, subProject),