diff --git a/.github/semantic.yml b/.github/semantic.yml new file mode 100644 index 0000000..fd160e5 --- /dev/null +++ b/.github/semantic.yml @@ -0,0 +1 @@ +titleOnly: true diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml new file mode 100644 index 0000000..f4573c2 --- /dev/null +++ b/.github/workflows/build.yaml @@ -0,0 +1,66 @@ +name: build + +on: + push: + branches: [ main ] + pull_request: + workflow_dispatch: + +env: + GRADLE_OPTS: "-Dorg.gradle.workers.max=2 -Dorg.gradle.console=plain" + +jobs: + # Verifies all tests pass + verify: + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-java@v4 + with: + distribution: corretto + java-version: 17 + cache: gradle + - uses: taiki-e/install-action@v2 + with: + tool: just@1 + - run: just verify + + # Prepare a release PR or release + release: + if: github.ref == 'refs/heads/main' + runs-on: ubuntu-latest + permissions: + contents: write + pull-requests: write + outputs: + released: ${{ steps.release.outputs.release_created }} + steps: + - id: release + uses: googleapis/release-please-action@v4 + with: + release-type: simple + + # Publish the artifacts (only if `verify` passed, and `release` created release) + publish: + needs: [ verify, release ] + if: needs.verify.result == 'success' && needs.release.outputs.released + runs-on: ubuntu-latest + timeout-minutes: 30 + permissions: + contents: write + packages: write + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-java@v4 + with: + distribution: corretto + java-version: 17 + cache: gradle + - uses: taiki-e/install-action@v2 + with: + tool: just@1 + - run: just publish + env: + GITHUB_USERNAME: ${{ github.actor }} + GITHUB_TOKEN: ${{ github.token }} diff --git a/.github/workflows/dependency_submission.yml b/.github/workflows/dependency_submission.yml new file mode 100644 index 0000000..61952a3 --- /dev/null +++ b/.github/workflows/dependency_submission.yml @@ -0,0 +1,19 @@ +name: Dependency Submission + +on: + push: + branches: [ main ] + +permissions: + contents: write + +jobs: + dependency-submission: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-java@v4 + with: + distribution: 'corretto' + java-version: 17 + - uses: gradle/actions/dependency-submission@v3 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9d36ee3 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +.gradle/ +.idea/ +.kotlin/ +build/ diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..a01904a --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1 @@ +* @Optravis-LLC/saas-platform diff --git a/README.md b/README.md new file mode 100644 index 0000000..421cc25 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Jooq generator plugin + +An opinionated gradle plugin generate jOOQ classes from Flyway migrations. + +The goal is to be very easy to set up jOOQ generation for projects using Kotlin, flyway and postgres. + +The minimal setup for projects using Postgres (and the default flyway migration directory) is: + +```kotlin +plugins { + kotlin("jvm") version "" // The Kotlin plugin is required + id("com.optravis.platform.jooq") version "" // Install the gradle plugin +} +``` + +It is possible to use other databases by configuring the (experimental) 'JooqGeneratorExtension' + +```kotlin +@OptIn(ExperimentalJooqGeneratorConfig::class) +configure { + //... +} +``` diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..23a0952 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,59 @@ +import org.jetbrains.kotlin.gradle.dsl.JvmTarget + +plugins { + alias(libs.plugins.kotlin.jvm) + alias(libs.plugins.detekt) + `java-gradle-plugin` +} + +group = "com.optravis.jooq.gradle" + + +repositories { + mavenCentral() +} + +dependencies { + implementation(gradleKotlinDsl()) + implementation(libs.jooq.codegen) + implementation(libs.flyway.core) + implementation(libs.testcontainers.core) + implementation(libs.hikari) + + runtimeOnly(libs.jooq.meta.kotlin) + runtimeOnly(libs.flyway.postgres) + runtimeOnly(libs.postgresql) + + testImplementation(rootProject.libs.kotest.runner) + testImplementation(rootProject.libs.kotest.assertions) +} + +gradlePlugin { + plugins { + create("jooqGenerator") { + id = "com.optravis.jooq.gradle" + implementationClass = "com.optravis.jooq.gradle.JooqGeneratorPlugin" + } + } +} + +java { + withSourcesJar() + withJavadocJar() + sourceCompatibility = JavaVersion.VERSION_17 +} + +kotlin { + explicitApi() + compilerOptions { + jvmTarget.set(JvmTarget.JVM_17) + } +} + +detekt { + config.setFrom(rootDir.resolve("detekt.yml")) +} + +tasks.withType().configureEach { + useJUnitPlatform() +} diff --git a/detekt.yml b/detekt.yml new file mode 100644 index 0000000..c076404 --- /dev/null +++ b/detekt.yml @@ -0,0 +1,15 @@ +config: + validation: true + warningsAsErrors: true + +style: + ReturnCount: + active: false + ThrowsCount: + active: false + MaxLineLength: + excludeCommentStatements: true + +exceptions: + TooGenericExceptionCaught: + active: false diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..d35ead2 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,4 @@ +org.gradle.parallel=true +org.gradle.daemon=true +org.gradle.configuration-cache=true +org.gradle.caching=true diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml new file mode 100644 index 0000000..e3b69b6 --- /dev/null +++ b/gradle/libs.versions.toml @@ -0,0 +1,40 @@ +[versions] +kotlin = "2.0.0" +detekt = "1.23.6" +kotest = "5.9.1" +flyway = "10.15.0" +jooq = "3.19.10" +testcontainers = "1.19.8" +postgres = "42.7.3" +hikari = "5.1.0" + +[plugins] +kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" } +detekt = { id = "io.gitlab.arturbosch.detekt", version.ref = "detekt" } +jooq = { id = "org.jooq.jooq-codegen-gradle", version.ref = "jooq" } + +[libraries] +# jOOQ +jooq-core = { module = "org.jooq:jooq", version.ref = "jooq" } +jooq-kotlin = { module = "org.jooq:jooq-kotlin", version.ref = "jooq" } +jooq-coroutines = { module = "org.jooq:jooq-kotlin-coroutines", version.ref = "jooq" } +jooq-meta-core = { module = "org.jooq:jooq-meta", version.ref = "jooq" } +jooq-meta-kotlin = { module = "org.jooq:jooq-meta-kotlin", version.ref = "jooq" } +jooq-codegen = { module = "org.jooq:jooq-codegen", version.ref = "jooq" } + +# Flyway +flyway-core = { module = "org.flywaydb:flyway-core", version.ref = "flyway" } +flyway-postgres = { module = "org.flywaydb:flyway-database-postgresql", version.ref = "flyway" } + +# Test Containers +testcontainers-core = { module = "org.testcontainers:testcontainers", version.ref = "testcontainers" } +testcontainers-postgresql = { module = "org.testcontainers:postgresql", version.ref = "testcontainers" } + +# DB access +postgresql = { module = "org.postgresql:postgresql", version.ref = "postgres" } +hikari = { module = "com.zaxxer:HikariCP", version.ref = "hikari" } + +# Test +kotest-assertions = { module = "io.kotest:kotest-assertions-core", version.ref = "kotest" } +kotest-datatest = { module = "io.kotest:kotest-framework-datatest", version.ref = "kotest" } +kotest-runner = { module = "io.kotest:kotest-runner-junit5", version.ref = "kotest" } diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..e644113 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..a441313 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..b740cf1 --- /dev/null +++ b/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# 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 +# +# https://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. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..7101f8e --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/justfile b/justfile new file mode 100644 index 0000000..6012ade --- /dev/null +++ b/justfile @@ -0,0 +1,13 @@ +set dotenv-load + +verify: + ./gradlew check + +test: + ./gradlew check + +action-lint: + actionlint -verbose + +publish: + ./gradlew publish -Pversion=$(cat version.txt | xargs) diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..005021f --- /dev/null +++ b/renovate.json @@ -0,0 +1,8 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": [ + "config:recommended", + "schedule:nonOfficeHours" + ], + "timezone": "Europe/Zurich" +} diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..958077b --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,7 @@ +pluginManagement { + repositories { + gradlePluginPortal() + } +} + +rootProject.name = "jooq-gradle" diff --git a/src/main/kotlin/com/optravis/jooq/gradle/Config.kt b/src/main/kotlin/com/optravis/jooq/gradle/Config.kt new file mode 100644 index 0000000..28a705f --- /dev/null +++ b/src/main/kotlin/com/optravis/jooq/gradle/Config.kt @@ -0,0 +1,77 @@ +package com.optravis.jooq.gradle + +import java.io.File +import java.io.Serializable + + +@RequiresOptIn( + message = "This configuration API is not yet stabilized and is subject to breaking changes", + level = RequiresOptIn.Level.WARNING +) +public annotation class ExperimentalJooqGeneratorConfig + +@OptIn(ExperimentalJooqGeneratorConfig::class) +internal data class JooqGeneratorConfig( + val container: ContainerConfig, + val connection: DbConnectionConfig, + val database: JooqDatabaseConfig, + val migrationDirectory: File, + val target: JooqTargetConfig, + val deprecateUnknownTypes: Boolean, +) + +@ExperimentalJooqGeneratorConfig +public data class ContainerConfig( + internal val image: String, + internal val port: Int, + internal val environment: Map +) : Serializable { + internal companion object { + fun postgres(db: String, user: String, password: String, version: Int = 16) = ContainerConfig( + image = "postgres:$version", + port = 5432, + environment = mapOf( + "POSTGRES_DB" to db, + "POSTGRES_USER" to user, + "POSTGRES_PASSWORD" to password, + ), + ) + } +} + +@ExperimentalJooqGeneratorConfig +public data class JooqDatabaseConfig( + /** Name of the jOOQ database connector (e.g. 'org.jooq.meta.postgres.PostgresDatabase') */ + internal val name: String, + internal val inputSchema: String, +) : Serializable { + internal companion object { + val postgres: JooqDatabaseConfig = JooqDatabaseConfig( + name = "org.jooq.meta.postgres.PostgresDatabase", + inputSchema = "public", + ) + } +} + +internal data class JooqTargetConfig( + val packageName: String, + val directory: File, +) : Serializable + +@ExperimentalJooqGeneratorConfig +public data class DbConnectionConfig( + internal val user: String, + internal val password: String, + /** JDBC url template. `{{port}}` will be substituted with the container port */ + internal val urlTemplate: String, +) : Serializable { + internal companion object { + fun postgres(db: String, user: String, password: String) = DbConnectionConfig( + user = user, + password = password, + urlTemplate = "jdbc:postgresql://localhost:{{port}}/$db" + ) + } + + internal fun makeUrl(port: Int) = urlTemplate.replace(Regex("\\{\\{\\s*port\\s*}}"), port.toString()) +} diff --git a/src/main/kotlin/com/optravis/jooq/gradle/Generator.kt b/src/main/kotlin/com/optravis/jooq/gradle/Generator.kt new file mode 100644 index 0000000..724fa2f --- /dev/null +++ b/src/main/kotlin/com/optravis/jooq/gradle/Generator.kt @@ -0,0 +1,92 @@ +@file:OptIn(ExperimentalJooqGeneratorConfig::class) + +package com.optravis.jooq.gradle + +import com.zaxxer.hikari.HikariConfig +import com.zaxxer.hikari.HikariDataSource +import org.flywaydb.core.Flyway +import org.jooq.codegen.GenerationTool +import org.jooq.meta.jaxb.Configuration +import org.jooq.meta.jaxb.Database +import org.jooq.meta.jaxb.Generate +import org.jooq.meta.jaxb.Generator +import org.jooq.meta.jaxb.Jdbc +import org.jooq.meta.jaxb.Target +import org.testcontainers.containers.GenericContainer +import org.testcontainers.containers.wait.strategy.Wait +import org.testcontainers.utility.DockerImageName + + +internal fun JooqGeneratorConfig.generate() { + container.run { port -> + val jdbcUrl = connection.makeUrl(port) + var attempts = 0 + while (attempts < 10 && !connection.isReady(jdbcUrl)) { + ++attempts + Thread.sleep(500) + } + Flyway.configure() + .dataSource(jdbcUrl, connection.user, connection.password) + .locations("filesystem:${migrationDirectory.absolutePath}") + .load() + .migrate() + target.directory.deleteRecursively() + GenerationTool.generate(toConfiguration(jdbcUrl)) + } +} + +private fun DbConnectionConfig.isReady(jdbcUrl: String): Boolean { + val config = HikariConfig() + config.jdbcUrl = jdbcUrl + config.username = user + config.password = password + return runCatching { HikariDataSource(config).connection.close() }.isSuccess +} + +private fun JooqGeneratorConfig.toConfiguration(jdbcUrl: String) = + Configuration() + .withJdbc( + Jdbc() + .withUrl(jdbcUrl) + .withUsername(connection.user) + .withPassword(connection.password) + ) + .withGenerator( + Generator() + .withName("org.jooq.codegen.KotlinGenerator") + .withDatabase( + Database() + .withName(database.name) + .withInputSchema(database.inputSchema) + .withExcludes("flyway_schema_history") + ) + .withGenerate( + Generate() + .withDaos(true) + .withDeprecationOnUnknownTypes(deprecateUnknownTypes) + .withPojosAsKotlinDataClasses(true) + .withKotlinDefaultedNullablePojoAttributes(true) + .withKotlinDefaultedNullableRecordAttributes(true) + .withKotlinNotNullPojoAttributes(true) + .withKotlinNotNullInterfaceAttributes(true) + .withKotlinNotNullRecordAttributes(true) + ) + .withTarget( + Target() + .withPackageName(target.packageName) + .withDirectory(target.directory.absolutePath) + ) + ) + +private inline fun ContainerConfig.run(action: (exposedPort: Int) -> T): T { + val container = GenericContainer(DockerImageName.parse(image)) + .withExposedPorts(port) + .withEnv(environment) + .waitingFor(Wait.forListeningPorts(port)) + container.start() + return try { + action(container.getMappedPort(port)) + } finally { + container.stop() + } +} diff --git a/src/main/kotlin/com/optravis/jooq/gradle/JooqGeneratorPlugin.kt b/src/main/kotlin/com/optravis/jooq/gradle/JooqGeneratorPlugin.kt new file mode 100644 index 0000000..bad7945 --- /dev/null +++ b/src/main/kotlin/com/optravis/jooq/gradle/JooqGeneratorPlugin.kt @@ -0,0 +1,120 @@ +@file:OptIn(ExperimentalJooqGeneratorConfig::class) + +package com.optravis.jooq.gradle + +import org.gradle.api.DefaultTask +import org.gradle.api.Plugin +import org.gradle.api.Project +import org.gradle.api.provider.Property +import org.gradle.api.tasks.Input +import org.gradle.api.tasks.InputDirectory +import org.gradle.api.tasks.OutputDirectory +import org.gradle.api.tasks.SourceSetContainer +import org.gradle.api.tasks.TaskAction +import org.gradle.kotlin.dsl.TaskContainerScope +import org.gradle.kotlin.dsl.create +import org.gradle.kotlin.dsl.get +import org.gradle.kotlin.dsl.invoke +import org.gradle.kotlin.dsl.register +import java.io.File + +@ExperimentalJooqGeneratorConfig +public interface JooqGeneratorExtension { + public val containerConfig: Property + public val connectionConfig: Property + public val jooqDbConfig: Property + public val migrationDirectory: Property + public val packageName: Property + public val deprecateUnknownTypes: Property +} + +private object Default { + const val DB = "jooq" + const val USER = "jooq" + const val PASSWORD = "jooq" +} + +public class JooqGeneratorPlugin : Plugin { + override fun apply(project: Project): Unit = with(project) { + val extension = createExtension() + configureSourceSets() + project.tasks { + configureTasks(extension) + } + } + + private fun TaskContainerScope.configureTasks(ext: JooqGeneratorExtension) { + val generateTask = register("generateJooq") { + group = "jOOQ" + description = "Generate jOOQ classes from database migrations" + outputDirectory = project.jooqTargetDir + containerConfig.convention(ext.containerConfig) + connectionConfig.convention(ext.connectionConfig) + jooqDbConfig.convention(ext.jooqDbConfig) + migrationDirectory.convention(ext.migrationDirectory) + deprecateUnknownTypes.convention(ext.deprecateUnknownTypes) + packageName.convention(ext.packageName.orElse("${project.group}.jooq")) + } + "compileJava" { dependsOn(generateTask) } + "compileKotlin" { dependsOn(generateTask) } + } + + private fun Project.configureSourceSets() { + val sourceSets = properties["sourceSets"] as SourceSetContainer + sourceSets["main"].java.srcDir(jooqTargetDir) + } + + private fun Project.createExtension() = + extensions.create("jooqGeneratorExtension").apply { + containerConfig.convention(ContainerConfig.postgres(Default.DB, Default.USER, Default.PASSWORD)) + connectionConfig.convention(DbConnectionConfig.postgres(Default.DB, Default.USER, Default.PASSWORD)) + jooqDbConfig.convention(JooqDatabaseConfig.postgres) + migrationDirectory.convention(File("${project.layout.projectDirectory}/src/main/resources/db/migration")) + deprecateUnknownTypes.convention(true) + } +} + +private abstract class JooqGenerateTask : DefaultTask() { + + @get:Input + abstract val containerConfig: Property + + @get:Input + abstract val connectionConfig: Property + + @get:Input + abstract val jooqDbConfig: Property + + @get:Input + abstract val packageName: Property + + @get:Input + abstract val deprecateUnknownTypes: Property + + @get:InputDirectory + abstract val migrationDirectory: Property + + @get:OutputDirectory + lateinit var outputDirectory: File + + @TaskAction + fun generate() { + config() + .also { logger.info("jOOQ generator config: {}", it) } + .generate() + } + + private fun config(): JooqGeneratorConfig = JooqGeneratorConfig( + container = containerConfig.get(), + connection = connectionConfig.get(), + database = jooqDbConfig.get(), + migrationDirectory = migrationDirectory.get(), + deprecateUnknownTypes = deprecateUnknownTypes.get(), + target = JooqTargetConfig( + packageName = packageName.get(), + directory = outputDirectory, + ) + ) +} + +private val Project.jooqTargetDir get() = File("${layout.buildDirectory.get()}/generated-src/jooq") diff --git a/src/test/kotlin/com/optravis/jooq/gradle/DbConnectionConfigSpec.kt b/src/test/kotlin/com/optravis/jooq/gradle/DbConnectionConfigSpec.kt new file mode 100644 index 0000000..2125926 --- /dev/null +++ b/src/test/kotlin/com/optravis/jooq/gradle/DbConnectionConfigSpec.kt @@ -0,0 +1,12 @@ +package com.optravis.jooq.gradle + +import io.kotest.core.spec.style.FunSpec +import io.kotest.matchers.equals.shouldBeEqual + +@OptIn(ExperimentalJooqGeneratorConfig::class) +class DbConnectionConfigSpec : FunSpec({ + test("replace port in postgres url template") { + DbConnectionConfig.postgres("mydb", "myuser", "mypassword").makeUrl(42) + .shouldBeEqual("jdbc:postgresql://localhost:42/mydb") + } +}) diff --git a/version.txt b/version.txt new file mode 100644 index 0000000..77d6f4c --- /dev/null +++ b/version.txt @@ -0,0 +1 @@ +0.0.0