Add support for KSP annotation processing via KspCompile (bazelbuild#955)

Author: Bencodes

.bazelci/presubmit.yml

@@ -33,6 +33,12 @@ tasks:
     working_directory: examples/android
     test_targets:
       - //...
+  example-ksp:
+    name: "Example - Android KSP"
+    platform: ubuntu1804
+    working_directory: examples/ksp
+    test_targets:
+      - //...
   example-associates:
     name: "Example - Associates"
     platform: ubuntu1804

examples/android/WORKSPACE

@@ -45,6 +45,9 @@ maven_install(
         "androidx.test.espresso:espresso-core:3.1.1",
         "org.hamcrest:hamcrest-library:1.3",
         "org.jetbrains.kotlinx:kotlinx-serialization-runtime:1.0-M1-1.4.0-rc",
+        "com.squareup.moshi:moshi:1.14.0",
+        "com.squareup.moshi:moshi-kotlin:1.14.0",
+        "com.squareup.moshi:moshi-kotlin-codegen:1.14.0",
         "com.google.dagger:dagger:2.45",
         "com.google.dagger:dagger-compiler:2.45",
         "com.google.dagger:dagger-producers:2.45",

examples/android/libKtAndroid/BUILD.bazel

@@ -1,4 +1,4 @@
-load("@io_bazel_rules_kotlin//kotlin:core.bzl", "kt_compiler_plugin")
+load("@io_bazel_rules_kotlin//kotlin:core.bzl", "kt_compiler_plugin", "kt_ksp_plugin")
 load("@io_bazel_rules_kotlin//kotlin:android.bzl", "kt_android_library")
 load("@rules_java//java:defs.bzl", "java_plugin")
 
@@ -19,12 +19,23 @@ java_plugin(
     deps = ["@maven//:com_google_auto_value_auto_value"],
 )
 
+kt_ksp_plugin(
+    name = "moshi-kotlin-codegen",
+    processor_class = "com.squareup.moshi.kotlin.codegen.ksp.JsonClassSymbolProcessorProvider",
+    deps = [
+        "@maven//:com_squareup_moshi_moshi",
+        "@maven//:com_squareup_moshi_moshi_kotlin",
+        "@maven//:com_squareup_moshi_moshi_kotlin_codegen",
+    ],
+)
+
 kt_android_library(
     name = "my_kt",
     srcs = glob(["src/main/java/**/*.kt"]),
     custom_package = "examples.android.lib",
     manifest = "src/main/AndroidManifest.xml",
     plugins = [
+        ":moshi-kotlin-codegen",
         ":serialization_plugin",
         ":autovalue",
     ],
@@ -35,6 +46,7 @@ kt_android_library(
         ":res2",
         "@maven//:androidx_appcompat_appcompat",
         "@maven//:com_google_auto_value_auto_value_annotations",
+        "@maven//:com_squareup_moshi_moshi",
         "@maven//:org_jetbrains_kotlinx_kotlinx_serialization_runtime",
     ],
 )

examples/android/libKtAndroid/src/main/java/examples/android/lib/DataJsonModel.kt

@@ -0,0 +1,6 @@
+package examples.android.lib
+
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class DataJsonModel(val data: String)

examples/android/libKtAndroid/src/main/java/examples/android/lib/MainActivity.kt

@@ -6,6 +6,7 @@ import android.widget.Button
 import android.widget.LinearLayout
 import android.widget.LinearLayout.LayoutParams
 import androidx.appcompat.app.AppCompatActivity
+import com.squareup.moshi.Moshi
 
 class MainActivity : AppCompatActivity() {
 
@@ -22,6 +23,9 @@ class MainActivity : AppCompatActivity() {
     // Ensure Serialization plugin has run and generated code correctly.
     Data.serializer()
 
+    val adapter = DataJsonModelJsonAdapter(Moshi.Builder().build())
+    println(adapter.toJson(DataJsonModel("foo")))
+
     TestKtValue.create {
       setName("Auto Value Test") // can't use property syntax, because autovalue builder's codegen
     }

examples/ksp/BUILD

@@ -0,0 +1,71 @@
+# Copyright 2018 The Bazel Authors. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+load("@io_bazel_rules_kotlin//kotlin:core.bzl", "define_kt_toolchain", "kt_ksp_plugin")
+load("@bazel_skylib//rules:build_test.bzl", "build_test")
+load("@rules_java//java:defs.bzl", "java_binary", "java_plugin")
+load("@io_bazel_rules_kotlin//kotlin:jvm.bzl", "kt_jvm_library")
+
+package(default_visibility = ["//visibility:public"])
+
+define_kt_toolchain(name = "kotlin_toolchain")
+
+java_plugin(
+    name = "autovalue",
+    generates_api = True,
+    processor_class = "com.google.auto.value.processor.AutoValueProcessor",
+    deps = ["@maven//:com_google_auto_value_auto_value"],
+)
+
+kt_ksp_plugin(
+    name = "moshi-kotlin-codegen",
+    processor_class = "com.squareup.moshi.kotlin.codegen.ksp.JsonClassSymbolProcessorProvider",
+    deps = [
+        "@maven//:com_squareup_moshi_moshi",
+        "@maven//:com_squareup_moshi_moshi_kotlin",
+        "@maven//:com_squareup_moshi_moshi_kotlin_codegen",
+    ],
+)
+
+kt_jvm_library(
+    name = "coffee_lib",
+    srcs = glob([
+        "*.kt",
+        "*.java",
+    ]),
+    plugins = [
+        "//:moshi-kotlin-codegen",
+        "//:autovalue",
+    ],
+    deps = [
+        "@maven//:com_google_auto_value_auto_value_annotations",
+        "@maven//:com_squareup_moshi_moshi",
+        "@maven//:com_squareup_moshi_moshi_kotlin",
+    ],
+)
+
+java_binary(
+    name = "coffee_app",
+    main_class = "coffee.CoffeeApp",
+    visibility = ["//visibility:public"],
+    runtime_deps = [":coffee_lib"],
+)
+
+build_test(
+    name = "force_build_app_test",
+    targets = [
+        "//:coffee_app",
+        # build_test doesn't actually fail unless you force the deploy jar to be built
+        "//:coffee_app_deploy.jar",
+    ],
+)

examples/ksp/CoffeeApp.kt

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2018 The Bazel Authors. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package coffee
+
+import com.squareup.moshi.Moshi
+
+class CoffeeApp {
+
+  companion object {
+
+    private val adapter = CoffeeAppModelJsonAdapter(Moshi.Builder().build())
+    private val d = AutoValue_CoffeeAppJavaModel.Builder()
+      .setCoffeeAppModel(CoffeeAppModel("1"))
+      .build()
+
+    @JvmStatic
+    fun main(args: Array<String>) {
+      println(
+        adapter.toJson(d.coffeeAppModel())
+      )
+    }
+  }
+}

examples/ksp/CoffeeAppJavaModel.java

@@ -0,0 +1,21 @@
+package coffee;
+
+import com.google.auto.value.AutoValue;
+
+@AutoValue
+public abstract class CoffeeAppJavaModel {
+
+    abstract CoffeeAppModel coffeeAppModel();
+
+    Builder builder() {
+        return new AutoValue_CoffeeAppJavaModel.Builder();
+    }
+
+    @AutoValue.Builder
+    abstract static class Builder {
+
+        abstract Builder setCoffeeAppModel(CoffeeAppModel coffeeAppModel);
+
+        abstract CoffeeAppJavaModel build();
+    }
+}

examples/ksp/CoffeeAppModel.kt

@@ -0,0 +1,6 @@
+package coffee
+
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class CoffeeAppModel(val id: String)

examples/ksp/WORKSPACE

@@ -0,0 +1,52 @@
+workspace(name = "ksp_example")
+
+local_repository(
+    name = "release_archive",
+    path = "../../src/main/starlark/release_archive",
+)
+
+load("@release_archive//:repository.bzl", "archive_repository")
+
+archive_repository(
+    name = "io_bazel_rules_kotlin",
+)
+
+load("@io_bazel_rules_kotlin//kotlin:repositories.bzl", "kotlin_repositories", "versions")
+
+kotlin_repositories()
+
+register_toolchains("//:kotlin_toolchain")
+
+load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
+
+http_archive(
+    name = "bazel_skylib",
+    sha256 = versions.SKYLIB_SHA,
+    urls = ["https://github.com/bazelbuild/bazel-skylib/releases/download/%s/bazel-skylib-%s.tar.gz" % (
+        versions.SKYLIB_VERSION,
+        versions.SKYLIB_VERSION,
+    )],
+)
+
+http_archive(
+    name = "rules_jvm_external",
+    sha256 = versions.RULES_JVM_EXTERNAL_SHA,
+    strip_prefix = "rules_jvm_external-%s" % versions.RULES_JVM_EXTERNAL_TAG,
+    url = "https://github.com/bazelbuild/rules_jvm_external/archive/%s.zip" % versions.RULES_JVM_EXTERNAL_TAG,
+)
+
+load("@rules_jvm_external//:defs.bzl", "maven_install")
+
+maven_install(
+    artifacts = [
+        "com.squareup.moshi:moshi:1.14.0",
+        "com.squareup.moshi:moshi-kotlin:1.14.0",
+        "com.squareup.moshi:moshi-kotlin-codegen:1.14.0",
+        "com.google.auto.value:auto-value:1.10.1",
+        "com.google.auto.value:auto-value-annotations:1.10.1",
+    ],
+    repositories = [
+        "https://maven.google.com",
+        "https://repo1.maven.org/maven2",
+    ],
+)

kotlin/core.bzl

@@ -6,6 +6,7 @@ load(
 load(
     "//kotlin/internal/jvm:jvm.bzl",
     _kt_compiler_plugin = "kt_compiler_plugin",
+    _kt_ksp_plugin = "kt_ksp_plugin",
 )
 load(
     "//kotlin/internal:toolchains.bzl",
@@ -18,3 +19,4 @@ kt_register_toolchains = _kt_register_toolchains
 kt_javac_options = _kt_javac_options
 kt_kotlinc_options = _kt_kotlinc_options
 kt_compiler_plugin = _kt_compiler_plugin
+kt_ksp_plugin = _kt_ksp_plugin

kotlin/internal/defs.bzl

@@ -25,6 +25,9 @@ JavaPluginInfo = getattr(java_common, "JavaPluginInfo")
 # The name of the Kotlin compiler workspace.
 KT_COMPILER_REPO = "com_github_jetbrains_kotlin"
 
+# The name of the KSP compiler plugin workspace
+KSP_COMPILER_PLUGIN_REPO = "com_github_google_ksp"
+
 KtJvmInfo = provider(
     fields = {
         "module_name": "the module name",
@@ -57,3 +60,9 @@ KtCompilerPluginInfo = provider(
         "options": "List of plugin options, represented as structs with an id and a value field, to be passed to the compiler",
     },
 )
+
+KspPluginInfo = provider(
+    fields = {
+        "plugins": "List of JavaPLuginInfo providers for the plugins to run with KSP",
+    },
+)