feat: add Schema generator Gradle plugin

gradle/libs.versions.toml

@@ -46,6 +46,7 @@ kotlinx-coroutines-jdk8 = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-j
 kotlinx-coroutines-slf4j = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-slf4j", version.ref = "coroutines-version" }
 
 ksp-api = { module = "com.google.devtools.ksp:symbol-processing-api", version.ref = "ksp-version" }
+ksp-gradle-plugin = { module = "com.google.devtools.ksp:com.google.devtools.ksp.gradle.plugin", version.ref = "ksp-version" }
 
 slf4j-api = { module = "org.slf4j:slf4j-api", version.ref = "slf4j-version" }
 slf4j-simple = { module = "org.slf4j:slf4j-simple", version.ref = "slf4j-version" }
@@ -145,3 +146,4 @@ ksp = { id = "com.google.devtools.ksp", version.ref = "ksp-version" }
 aws-kotlin-repo-tools-kmp = { id = "aws.sdk.kotlin.gradle.kmp", version.ref = "aws-kotlin-repo-tools-version" }
 aws-kotlin-repo-tools-smithybuild = { id = "aws.sdk.kotlin.gradle.smithybuild", version.ref = "aws-kotlin-repo-tools-version" }
 aws-kotlin-repo-tools-artifactsizemetrics = { id = "aws.sdk.kotlin.gradle.artifactsizemetrics", version.ref = "aws-kotlin-repo-tools-version" }
+gradle-plugin-publish = { id = "com.gradle.plugin-publish", version = "1.2.1"}

hll/build.gradle.kts

@@ -90,5 +90,6 @@ apiValidation {
         "hll-codegen",
         "dynamodb-mapper-annotation-processor-test",
         "dynamodb-mapper-codegen",
+        "dynamodb-mapper-schema-generator-plugin-test",
     ).filter { it in availableSubprojects } // Some projects may not be in the build depending on bootstrapping
 }

hll/dynamodb-mapper/dynamodb-mapper-codegen/build.gradle.kts

@@ -9,6 +9,7 @@ extra["moduleName"] = "aws.sdk.kotlin.hll.dynamodbmapper.codegen"
 
 plugins {
     alias(libs.plugins.kotlin.jvm)
+    `maven-publish`
 }
 
 dependencies {
@@ -22,3 +23,34 @@ dependencies {
     testImplementation(libs.kotest.assertions.core.jvm)
     testImplementation(libs.kotlin.test.junit5)
 }
+
+tasks.test {
+    useJUnitPlatform()
+    testLogging {
+        events("passed", "skipped", "failed")
+        showStandardStreams = true
+        showStackTraces = true
+        showExceptions = true
+        exceptionFormat = org.gradle.api.tasks.testing.logging.TestExceptionFormat.FULL
+    }
+}
+
+val sdkVersion: String by project
+group = "aws.sdk.kotlin"
+version = sdkVersion
+
+val sourcesJar by tasks.creating(Jar::class) {
+    group = "publishing"
+    description = "Assembles Kotlin sources jar"
+    archiveClassifier.set("sources")
+    from(sourceSets.getByName("main").allSource)
+}
+
+publishing {
+    publications {
+        create<MavenPublication>("dynamodb-mapper-codegen") {
+            from(components["java"])
+            artifact(sourcesJar)
+        }
+    }
+}

hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/api/dynamodb-mapper-schema-generator-plugin.api

@@ -0,0 +1,19 @@
+public final class aws/sdk/kotlin/hll/dynamodbmapper/plugins/SchemaGeneratorPlugin : org/gradle/api/Plugin {
+	public fun <init> ()V
+	public synthetic fun apply (Ljava/lang/Object;)V
+	public fun apply (Lorg/gradle/api/Project;)V
+}
+
+public final class aws/sdk/kotlin/hll/dynamodbmapper/plugins/SchemaGeneratorPlugin$inlined$sam$i$org_gradle_api_Action$0 : org/gradle/api/Action {
+	public fun <init> (Lkotlin/jvm/functions/Function1;)V
+	public final synthetic fun execute (Ljava/lang/Object;)V
+}
+
+public class aws/sdk/kotlin/hll/dynamodbmapper/plugins/SchemaGeneratorPluginExtension {
+	public fun <init> ()V
+}
+
+public final class aws/sdk/kotlin/hll/dynamodbmapper/plugins/SchemaGeneratorPluginKt {
+	public static final field SCHEMA_GENERATOR_PLUGIN_EXTENSION Ljava/lang/String;
+}
+

hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/build.gradle.kts

@@ -0,0 +1,82 @@
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+description = "Plugin used to generate DynamoDbMapper schemas from user classes"
+extra["displayName"] = "AWS :: SDK :: Kotlin :: HLL :: DynamoDbMapper :: Schema Generator Plugin"
+extra["moduleName"] = "aws.sdk.kotlin.hll.dynamodbmapper.plugins"
+
+plugins {
+    `kotlin-dsl`
+    `java-gradle-plugin`
+    alias(libs.plugins.gradle.plugin.publish)
+    `maven-publish`
+}
+
+dependencies {
+    implementation(kotlin("gradle-plugin"))
+    implementation(libs.ksp.gradle.plugin)
+
+    testImplementation(libs.junit.jupiter)
+    testImplementation(libs.junit.jupiter.params)
+    testImplementation(libs.kotlin.test)
+}
+
+gradlePlugin {
+    website = "https://github.com/awslabs/aws-sdk-kotlin"
+    vcsUrl = "https://github.com/awslabs/aws-sdk-kotlin.git"
+    plugins {
+        create("dynamodb-mapper-schema-generator") {
+            id = "aws.sdk.kotlin.hll.dynamodbmapper.schema.generator"
+            displayName = "DynamoDbMapper Schema Generator"
+            description = "Plugin used to generate DynamoDbMapper schemas from user classes"
+            tags = setOf("kotlin", "dynamodb", "aws")
+            implementationClass = "aws.sdk.kotlin.hll.dynamodbmapper.plugins.SchemaGeneratorPlugin"
+        }
+    }
+}
+
+val sdkVersion: String by project
+group = "aws.sdk.kotlin"
+version = sdkVersion
+
+publishing {
+    publications {
+        create<MavenPublication>("dynamodb-mapper-schema-generator-plugin") {
+            from(components["java"])
+        }
+    }
+}
+
+tasks.test {
+    useJUnitPlatform()
+    testLogging {
+        events("passed", "skipped", "failed")
+        showStandardStreams = true
+        showStackTraces = true
+        showExceptions = true
+        exceptionFormat = org.gradle.api.tasks.testing.logging.TestExceptionFormat.FULL
+    }
+}
+
+/**
+ * Create a file containing the sdkVersion to use as a resource
+ * This saves us from having to manually change version numbers in multiple places
+ */
+val generateSdkRuntimeVersion by tasks.registering {
+    val resourcesDir = layout.buildDirectory.dir("resources/main/aws/sdk/kotlin/hll/dynamodbmapper/plugins").get()
+    val versionFile = file("$resourcesDir/sdk-version.txt")
+    val gradlePropertiesFile = rootProject.file("gradle.properties")
+    inputs.file(gradlePropertiesFile)
+    outputs.file(versionFile)
+    sourceSets.main.get().output.dir(resourcesDir)
+    doLast {
+        versionFile.writeText(sdkVersion)
+    }
+}
+
+tasks.withType<KotlinCompile> {
+    dependsOn(generateSdkRuntimeVersion)
+}

hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/main/kotlin/aws/sdk/kotlin/hll/dynamodbmapper/plugins/SchemaGeneratorPlugin.kt

@@ -0,0 +1,46 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package aws.sdk.kotlin.hll.dynamodbmapper.plugins
+
+import com.google.devtools.ksp.gradle.KspExtension
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.gradle.kotlin.dsl.configure
+import org.gradle.kotlin.dsl.create
+
+open class SchemaGeneratorPluginExtension {
+    // TODO Add configuration here (such as codegen configuration)
+}
+
+const val SCHEMA_GENERATOR_PLUGIN_EXTENSION = "schemaGeneratorPluginExtension"
+
+public class SchemaGeneratorPlugin : Plugin<Project> {
+    override fun apply(project: Project): Unit = project.run {
+        createExtension()
+        configureDependencies()
+    }
+
+    private fun Project.createExtension(): SchemaGeneratorPluginExtension = extensions.create<SchemaGeneratorPluginExtension>(SCHEMA_GENERATOR_PLUGIN_EXTENSION)
+
+    private fun Project.configureDependencies() {
+        logger.info("Configuring dependencies for schema generation...")
+        pluginManager.apply("com.google.devtools.ksp")
+
+        extensions.configure<KspExtension> {
+            excludeProcessor("aws.sdk.kotlin.hll.dynamodbmapper.codegen.operations.HighLevelOpsProcessorProvider")
+            // TODO pass plugin configuration to KSP as args...
+        }
+
+        val sdkVersion = getSdkVersion()
+        dependencies.add("ksp", "aws.sdk.kotlin:dynamodb-mapper-codegen:$sdkVersion")
+    }
+
+    // Reads sdk-version.txt for the SDK version to add dependencies on. The file is created in this module's build.gradle.kts
+    private fun getSdkVersion(): String = try {
+        this.javaClass.getResource("sdk-version.txt")?.readText() ?: throw IllegalStateException("sdk-version.txt does not exist")
+    } catch (ex: Exception) {
+        throw IllegalStateException("Failed to load sdk-version.txt which sets the SDK version", ex)
+    }
+}

hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/kotlin/aws/sdk/kotlin/hll/dynamodbmapper/plugins/SchemaGeneratorPluginTest.kt

@@ -0,0 +1,58 @@
+package aws.sdk.kotlin.hll.dynamodbmapper.plugins
+
+import org.gradle.testkit.runner.GradleRunner
+import org.gradle.testkit.runner.TaskOutcome
+import org.junit.jupiter.api.AfterEach
+import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.io.TempDir
+import java.io.File
+import kotlin.test.assertContains
+
+class SchemaGeneratorPluginTest {
+    @TempDir
+    lateinit var testProjectDir: File
+
+    private lateinit var settingsFile: File
+    private lateinit var buildFile: File
+
+    @BeforeEach
+    fun setup() {
+        settingsFile = File(testProjectDir, "settings.gradle.kts")
+        buildFile = File(testProjectDir, "build.gradle.kts")
+    }
+
+    @AfterEach
+    fun cleanup() {
+        if (settingsFile.exists()) {
+            settingsFile.delete()
+        }
+        if (buildFile.exists()) {
+            buildFile.delete()
+        }
+    }
+
+    // TODO Parameterize the test across multiple versions of Kotlin and Gradle
+    @Test
+    fun `applies the plugin`() {
+        val buildFileContent = """
+         plugins {
+            id("org.jetbrains.kotlin.jvm") version "2.0.0"
+            id("aws.sdk.kotlin.hll.dynamodbmapper.schema.generator")
+         }
+         configure<aws.sdk.kotlin.hll.dynamodbmapper.plugins.SchemaGeneratorPluginExtension>{ }
+        """.trimIndent()
+
+        buildFile.writeText(buildFileContent)
+
+        val result = GradleRunner.create()
+            .withProjectDir(testProjectDir)
+            .withArguments("--info", "build")
+            .withPluginClasspath()
+            .withGradleVersion("8.5")
+            .forwardOutput()
+            .build()
+
+        assertContains(setOf(TaskOutcome.SUCCESS, TaskOutcome.UP_TO_DATE), result.task(":build")?.outcome)
+    }
+}

hll/dynamodb-mapper/dynamodb-mapper/build.gradle.kts

@@ -80,7 +80,7 @@ if (project.NATIVE_ENABLED) {
     // Start by invoking the JVM-only KSP configuration
     dependencies.kspJvm(project(":hll:dynamodb-mapper:dynamodb-mapper-codegen"))
 
-    // Then we need to move the generated source from jvm to common. Gradle lacks a move task so we roll our own!
+    // Then we need to move the generated source from jvm to common
     val moveGenSrc by tasks.registering {
         // Can't move src until the src is generated
         dependsOn(tasks.named("kspKotlinJvm"))
@@ -105,6 +105,10 @@ if (project.NATIVE_ENABLED) {
         }
     }
 
+    tasks.named("jvmSourcesJar") {
+        dependsOn(moveGenSrc)
+    }
+
     tasks.withType<KotlinCompilationTask<*>> {
         if (this !is KspTaskJvm) {
             // Ensure that any **non-KSP** compile tasks depend on the generated src move

hll/dynamodb-mapper/tests/dynamodb-mapper-schema-generator-plugin-test/build.gradle.kts

@@ -0,0 +1,22 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+val sdkVersion: String by project
+
+plugins {
+    id("aws.sdk.kotlin.hll.dynamodbmapper.schema.generator") version "1.3.17-SNAPSHOT"
+}
+
+kotlin {
+    sourceSets {
+        commonMain {
+            dependencies {
+                implementation(project(":hll:dynamodb-mapper:dynamodb-mapper"))
+                implementation(project(":hll:dynamodb-mapper:dynamodb-mapper-annotations"))
+                implementation(project(":hll:dynamodb-mapper:dynamodb-mapper-schema-generator-plugin"))
+            }
+        }
+    }
+}

hll/dynamodb-mapper/tests/dynamodb-mapper-schema-generator-plugin-test/common/src/aws/sdk/kotlin/hll/dynamodbmapper/tests/plugins/Group.kt

@@ -0,0 +1,14 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package aws.sdk.kotlin.hll.dynamodbmapper.tests.plugins
+
+import aws.sdk.kotlin.hll.dynamodbmapper.DynamoDbItem
+import aws.sdk.kotlin.hll.dynamodbmapper.DynamoDbPartitionKey
+
+@DynamoDbItem
+public data class Group(
+    @DynamoDbPartitionKey val name: String,
+    val userIds: String,
+)

hll/dynamodb-mapper/tests/dynamodb-mapper-schema-generator-plugin-test/common/src/aws/sdk/kotlin/hll/dynamodbmapper/tests/plugins/User.kt

@@ -0,0 +1,17 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package aws.sdk.kotlin.hll.dynamodbmapper.tests.plugins
+
+import aws.sdk.kotlin.hll.dynamodbmapper.DynamoDbAttribute
+import aws.sdk.kotlin.hll.dynamodbmapper.DynamoDbItem
+import aws.sdk.kotlin.hll.dynamodbmapper.DynamoDbPartitionKey
+
+@DynamoDbItem
+public data class User(
+    @DynamoDbPartitionKey val id: Int,
+    @DynamoDbAttribute("fName") val givenName: String,
+    @DynamoDbAttribute("lName") val surname: String,
+    val age: Int,
+)

hll/dynamodb-mapper/tests/dynamodb-mapper-schema-generator-plugin-test/common/test/aws/sdk/kotlin/hll/dynamodbmapper/tests/plugins/UserTest.kt

@@ -0,0 +1,33 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package aws.sdk.kotlin.hll.dynamodbmapper.tests.plugins
+
+import aws.sdk.kotlin.hll.dynamodbmapper.model.itemOf
+import aws.sdk.kotlin.hll.dynamodbmapper.tests.plugins.mapper.schemas.UserConverter
+import aws.sdk.kotlin.services.dynamodb.model.AttributeValue
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class UserTest {
+    @Test
+    fun testConversion() {
+        val user = User(123, "Steve", "Rogers", 84)
+        val converted = UserConverter.toItem(user)
+
+        assertEquals(
+            itemOf(
+                "id" to AttributeValue.N("123"),
+                "fName" to AttributeValue.S("Steve"),
+                "lName" to AttributeValue.S("Rogers"),
+                "age" to AttributeValue.N("84"),
+            ),
+            converted,
+        )
+
+        val unconverted = UserConverter.fromItem(converted)
+
+        assertEquals(user, unconverted)
+    }
+}