Add a new Misk module which includes a Gradle plugin for

starting a Vitess test database

GitOrigin-RevId: 3b4699e9df7c4d83ba6fdf340de4e0e9503a77cc

Author: aparajon

misk-vitess-database-gradle-plugin/README.md

@@ -0,0 +1,39 @@
+# Vitess Database Gradle Plugin
+
+This module provides a Gradle plugin for starting a Vitess test database. It serves as a wrapper around [VitessTestDb](../misk-vitess/README.md#vitesstestdb) and automatically processes schema changes / database migrations.
+
+## Usage
+
+For simple usage, update your build.gradle.kts file with the following:
+
+```
+plugins {
+  id("com.squareup.misk.vitess.vitess-database")
+}
+
+tasks.withType<Test>().configureEach {
+  // Start the Vitess test database before running tests
+  dependsOn("startVitessDatabase")
+}
+```
+
+To customize Vitess test database properties:
+
+```
+import misk.vitess.gradle.StartVitessDatabaseTask
+
+plugins {
+  id("com.squareup.misk.vitess.vitess-database")
+}
+
+val startVitessDatabase = tasks.named("startVitessDatabase", StartVitessDatabaseTask::class.java) {
+  containerName.set("my_vitess_db")
+  lintSchema.set(true)
+  mysqlVersion.set("8.0.42")
+  vitessImage.set("vitess/vttestserver:v19.0.9-mysql80")
+}
+
+tasks.withType<Test>().configureEach {
+  // Start the Vitess test database before running tests
+  dependsOn(startVitessDatabase)
+```

misk-vitess-database-gradle-plugin/api/misk-vitess-database-gradle-plugin.api

@@ -0,0 +1,25 @@
+public abstract class misk/vitess/gradle/StartVitessDatabaseTask : org/gradle/api/DefaultTask {
+	public fun <init> ()V
+	public abstract fun getAutoApplySchemaChanges ()Lorg/gradle/api/provider/Property;
+	public abstract fun getContainerName ()Lorg/gradle/api/provider/Property;
+	public abstract fun getDebugStartup ()Lorg/gradle/api/provider/Property;
+	public abstract fun getEnableDeclarativeSchemaChanges ()Lorg/gradle/api/provider/Property;
+	public abstract fun getEnableScatters ()Lorg/gradle/api/provider/Property;
+	public abstract fun getKeepAlive ()Lorg/gradle/api/provider/Property;
+	public abstract fun getLintSchema ()Lorg/gradle/api/provider/Property;
+	public abstract fun getMysqlVersion ()Lorg/gradle/api/provider/Property;
+	public abstract fun getPort ()Lorg/gradle/api/provider/Property;
+	public abstract fun getSchemaDir ()Lorg/gradle/api/provider/Property;
+	public abstract fun getSqlMode ()Lorg/gradle/api/provider/Property;
+	public abstract fun getTransactionTimeoutSeconds ()Lorg/gradle/api/provider/Property;
+	public abstract fun getVitessImage ()Lorg/gradle/api/provider/Property;
+	public abstract fun getVitessVersion ()Lorg/gradle/api/provider/Property;
+	public final fun start ()V
+}
+
+public final class misk/vitess/gradle/VitessDatabasePlugin : org/gradle/api/Plugin {
+	public fun <init> ()V
+	public synthetic fun apply (Ljava/lang/Object;)V
+	public fun apply (Lorg/gradle/api/Project;)V
+}
+

misk-vitess-database-gradle-plugin/build.gradle.kts

@@ -0,0 +1,32 @@
+import com.vanniktech.maven.publish.GradlePlugin
+import com.vanniktech.maven.publish.JavadocJar
+
+plugins {
+  id("org.jetbrains.kotlin.jvm")
+  id("com.vanniktech.maven.publish.base")
+  id("java-gradle-plugin")
+}
+
+gradlePlugin {
+  plugins {
+    create("VitessDatabasePlugin") {
+      id = "com.squareup.misk.vitess.vitess-database"
+      implementationClass = "misk.vitess.gradle.VitessDatabasePlugin"
+    }
+  }
+}
+
+dependencies {
+  implementation(testFixtures(project(":misk-vitess")))
+  testImplementation(gradleTestKit())
+  testImplementation(libs.assertj)
+  testImplementation(libs.junitApi)
+  testImplementation(libs.junitParams)
+  testImplementation(libs.mysqlConnector)
+}
+
+mavenPublishing {
+  configure(
+    GradlePlugin(javadocJar = JavadocJar.Dokka("dokkaGfm"))
+  )
+}

misk-vitess-database-gradle-plugin/src/main/kotlin/misk/vitess/gradle/StartVitessDatabaseTask.kt

@@ -0,0 +1,77 @@
+package misk.vitess.gradle
+
+import misk.vitess.testing.VitessTestDb
+import org.gradle.api.DefaultTask
+import org.gradle.api.provider.Property
+import org.gradle.api.tasks.Input
+import org.gradle.api.tasks.TaskAction
+import org.gradle.api.tasks.UntrackedTask
+import java.time.Duration
+
+@UntrackedTask(because = "Every task run re-initializes the database if needed")
+abstract class StartVitessDatabaseTask: DefaultTask() {
+
+  @get:Input
+  abstract val autoApplySchemaChanges: Property<Boolean>
+
+  @get:Input
+  abstract val containerName: Property<String>
+
+  @get:Input
+  abstract val debugStartup: Property<Boolean>
+
+  @get:Input
+  abstract val enableDeclarativeSchemaChanges: Property<Boolean>
+
+  @get:Input
+  abstract val enableScatters: Property<Boolean>
+
+  @get:Input
+  abstract val keepAlive: Property<Boolean>
+
+  @get:Input
+  abstract val lintSchema: Property<Boolean>
+
+  @get:Input
+  abstract val mysqlVersion: Property<String>
+
+  @get:Input
+  abstract val port: Property<Int>
+
+  @get:Input
+  abstract val schemaDir: Property<String>
+
+  @get:Input
+  abstract val sqlMode: Property<String>
+
+  @get:Input
+  abstract val transactionTimeoutSeconds: Property<Duration>
+
+  @get:Input
+  abstract val vitessImage: Property<String>
+
+  @get:Input
+  abstract val vitessVersion: Property<Int>
+
+  @TaskAction
+  fun start() {
+    val vitessTestDb = VitessTestDb(
+      autoApplySchemaChanges = autoApplySchemaChanges.get(),
+      containerName = containerName.get(),
+      debugStartup = debugStartup.get(),
+      enableDeclarativeSchemaChanges = enableDeclarativeSchemaChanges.get(),
+      enableScatters = enableScatters.get(),
+      keepAlive = keepAlive.get(),
+      lintSchema = lintSchema.get(),
+      mysqlVersion = mysqlVersion.get(),
+      port = port.get(),
+      schemaDir = schemaDir.get(),
+      sqlMode = sqlMode.get(),
+      transactionTimeoutSeconds = transactionTimeoutSeconds.get(),
+      vitessImage = vitessImage.get(),
+      vitessVersion = vitessVersion.get()
+    )
+
+    vitessTestDb.run()
+  }
+}

misk-vitess-database-gradle-plugin/src/main/kotlin/misk/vitess/gradle/VitessDatabasePlugin.kt

@@ -0,0 +1,26 @@
+package misk.vitess.gradle
+
+import misk.vitess.testing.DefaultSettings
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+
+class VitessDatabasePlugin: Plugin<Project> {
+  override fun apply(project: Project) {
+    project.tasks.register("startVitessDatabase", StartVitessDatabaseTask::class.java) {
+      it.autoApplySchemaChanges.convention(DefaultSettings.AUTO_APPLY_SCHEMA_CHANGES)
+      it.containerName.convention(DefaultSettings.CONTAINER_NAME)
+      it.debugStartup.convention(DefaultSettings.DEBUG_STARTUP)
+      it.enableDeclarativeSchemaChanges.convention(DefaultSettings.ENABLE_DECLARATIVE_SCHEMA_CHANGES)
+      it.enableScatters.convention(DefaultSettings.ENABLE_SCATTERS)
+      it.keepAlive.convention(DefaultSettings.KEEP_ALIVE)
+      it.lintSchema.convention(DefaultSettings.LINT_SCHEMA)
+      it.mysqlVersion.convention(DefaultSettings.MYSQL_VERSION)
+      it.port.convention(DefaultSettings.PORT)
+      it.schemaDir.convention("filesystem:${project.layout.projectDirectory.dir("src/main/resources/vitess/schema").asFile.absolutePath}")
+      it.sqlMode.convention(DefaultSettings.SQL_MODE)
+      it.transactionTimeoutSeconds.convention(DefaultSettings.TRANSACTION_TIMEOUT_SECONDS)
+      it.vitessImage.convention(DefaultSettings.VITESS_IMAGE)
+      it.vitessVersion.convention(DefaultSettings.VITESS_VERSION)
+    }
+  }
+}

misk-vitess-database-gradle-plugin/src/test/kotlin/misk/vitess/gradle/VitessDatabasePluginTest.kt

@@ -0,0 +1,45 @@
+package misk.vitess.gradle
+
+import org.assertj.core.api.Assertions.assertThat
+import org.gradle.testkit.runner.GradleRunner
+import org.gradle.testkit.runner.TaskOutcome
+import org.junit.jupiter.api.Assertions.assertEquals
+import org.junit.jupiter.api.Test
+import java.io.File
+import java.sql.Connection
+import java.sql.DriverManager
+import java.sql.ResultSet
+import java.sql.Statement
+
+class VitessDatabasePluginTest {
+  @Test
+  fun `start VitessTestDb with custom parameters`() {
+    val testProjectDir = File(this.javaClass.getResource("/vitess-database-plugin-test")!!.file)
+
+    val result = GradleRunner.create()
+      .withProjectDir(testProjectDir)
+      .withArguments("startVitessDatabase")
+      .withPluginClasspath()
+      .forwardOutput()
+      .build()
+
+    assertThat(result.task(":startVitessDatabase")!!.outcome).isEqualTo(TaskOutcome.SUCCESS)
+
+    val resultSet: ResultSet = executeQuery("SHOW KEYSPACES;")
+    var rowCount = 0
+    while (resultSet.next()) {
+      rowCount++
+    }
+
+    assertEquals(2, rowCount)
+  }
+
+  private fun executeQuery(query: String): ResultSet {
+    val url = "jdbc:mysql://localhost:31503/@primary"
+    val user = "root"
+    val password = ""
+    val connection: Connection = DriverManager.getConnection(url, user, password)
+    val statement: Statement = connection.createStatement()
+    return statement.executeQuery(query)
+  }
+}

misk-vitess-database-gradle-plugin/src/test/resources/vitess-database-plugin-test/build.gradle.kts

@@ -0,0 +1,12 @@
+import misk.vitess.gradle.StartVitessDatabaseTask
+
+plugins {
+  id("com.squareup.misk.vitess.vitess-database")
+}
+
+val startVitessDatabase = tasks.named("startVitessDatabase", StartVitessDatabaseTask::class.java) {
+  containerName.set("plugin_test_vitess_db")
+  lintSchema.set(true)
+  port.set(31503)
+  schemaDir.set("filesystem:${layout.projectDirectory.dir("src/main/resources/vitess/schema")}")
+}

misk-vitess-database-gradle-plugin/src/test/resources/vitess-database-plugin-test/gradle.properties

@@ -0,0 +1 @@
+org.gradle.configuration-cache=true

misk-vitess-database-gradle-plugin/src/test/resources/vitess-database-plugin-test/settings.gradle.kts

@@ -0,0 +1 @@
+rootProject.name = "test"

misk-vitess-database-gradle-plugin/src/test/resources/vitess-database-plugin-test/src/main/resources/vitess/schema/gameworld/v0002__add_customers_seq.sql

@@ -0,0 +1,6 @@
+CREATE TABLE `customers_seq` (
+    `id` tinyint unsigned NOT NULL DEFAULT '0',
+    `next_id` bigint unsigned DEFAULT NULL,
+    `cache` bigint unsigned DEFAULT NULL,
+    PRIMARY KEY (`id`)
+) ENGINE=InnoDB COMMENT='vitess_sequence';