[RELEASE] - Release version: 0.3.0

- update release in README.md
- add action run checks
- add action release
- remove release.sh

.editorconfig

@@ -19,12 +19,14 @@ end_of_line = crlf
 
 # noinspection EditorConfigKeyCorrectness
 [*.{kt,kts}]
-ij_kotlin_packages_to_use_import_on_demand = unset
-ij_kotlin_allow_trailing_comma_on_call_site = true
 ij_kotlin_allow_trailing_comma = true
-ktlint_standard_import-ordering = disabled
-ktlint_standard_no-empty-first-line-in-class-body = disabled
+ij_kotlin_allow_trailing_comma_on_call_site = true
+ij_kotlin_packages_to_use_import_on_demand = unset
+ktlint_standard_chain-method-continuation = disabled
+ktlint_standard_class-signature = disabled
 ktlint_standard_function-signature = disabled
-ktlint_standard_parameter-list-wrapping = disabled
+ktlint_standard_import-ordering = disabled
 ktlint_standard_multiline-expression-wrapping = disabled
+ktlint_standard_no-empty-first-line-in-class-body = disabled
+ktlint_standard_parameter-list-wrapping = disabled
 ktlint_standard_string-template-indent = disabled

.github/workflows/release.yml

@@ -0,0 +1,12 @@
+name: Release
+
+on:
+  workflow_dispatch:
+
+jobs:
+  release:
+    uses: swordsteel/hlaeja-common-workflows/.github/workflows/release.yml@master
+    secrets:
+      CI_BOT_PAT: ${{ secrets.CI_BOT_PAT }}
+    with:
+      TYPE: artifact

.github/workflows/run-checks.yml

@@ -0,0 +1,12 @@
+name: Pull request validation
+
+on:
+  pull_request:
+    paths-ignore:
+      - '.github/**'
+
+jobs:
+  validate:
+    uses: swordsteel/hlaeja-common-workflows/.github/workflows/run-checks.yml@master
+    secrets:
+      CI_BOT_PAT: ${{ secrets.CI_BOT_PAT }}

README.md

@@ -2,22 +2,26 @@
 
 In the forge of software development, where annotations ignite, A crucible of testing, common classes to excite. Each annotation examined, with attention to detail and might, Their effects on code behavior, tested through day and night. From mockk objects to test doubles, a toolkit to refine, Developers and testers, their skills to redefine. The Annotation Validator, a sentinel of code integrity true, A library of verification, where testing wisdom shines anew.
 
+
 ## Postgres Test Container
 
 `@PostgresContainer` Annotation for integration tests.
 
 Initialize Postgres test container using spring properties for R2DBC,
-script located in `src/<test path>/resources/postgres` folder. 
+script located in `src/<test path>/resources` folder. And specify properties in `src/<test path>/resources/application.properties`.
 
-* `schema.sql` file containing all structure and functions when star. 
-* `data.sql` file containing all data added before all test.
-* `reset.sql` file containing all to reset database after all test. 
+### Properties For Test Container
 
-if file exist it will be loaded...
+| name                       | required | example     | info                                                           |
+|----------------------------|:--------:|-------------|----------------------------------------------------------------|
+| container.postgres.version |          | postgres:17 | postgres container default postgres:latest                     |
+| container.postgres.init    | &check;  | schema.sql  | Postgres init script containing all structure and functions    |
+| container.postgres.before  |          | data.sql    | Postgres data script containing all data to populate database  |
+| container.postgres.after   |          | reset.sql   | Postgres reset script containing all command to reset database |
 
 ## Releasing library
 
-Run `release.sh` script from `master` branch.
+Run release pipeline from `master` branch.
 
 ## Publishing library
 

build.gradle.kts

@@ -1,12 +1,13 @@
 plugins {
     alias(hlaeja.plugins.kotlin.jvm)
     alias(hlaeja.plugins.kotlin.spring)
-    alias(hlaeja.plugins.ltd.hlaeja.plugin.library)
+    alias(hlaeja.plugins.spring.boot)
     alias(hlaeja.plugins.spring.dependency.management)
-    alias(hlaeja.plugins.springframework.boot)
+    alias(hlaeja.plugins.library)
 }
 
 dependencies {
+    implementation(hlaeja.kotlin.logging)
     implementation(hlaeja.kotlinx.coroutines)
     implementation(hlaeja.springboot.starter.r2dbc)
     implementation(hlaeja.springboot.starter.test)

gradle.properties

@@ -1,3 +1,3 @@
 kotlin.code.style=official
-version=0.1.0
-catalog=0.9.0
+version=0.3.0
+catalog=0.11.0

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.11.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.3-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

gradlew

@@ -86,8 +86,7 @@ done
 # 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 -P "${APP_HOME:-./}" > /dev/null && printf '%s
-' "$PWD" ) || exit
+APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -115,7 +114,7 @@ case "$( uname )" in                #(
   NONSTOP* )        nonstop=true ;;
 esac
 
-CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+CLASSPATH="\\\"\\\""
 
 
 # Determine the Java command to use to start the JVM.
@@ -206,7 +205,7 @@ fi
 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,
+#   * DEFAULT_JVM_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.
@@ -214,7 +213,7 @@ DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 set -- \
         "-Dorg.gradle.appname=$APP_BASE_NAME" \
         -classpath "$CLASSPATH" \
-        org.gradle.wrapper.GradleWrapperMain \
+        -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
         "$@"
 
 # Stop when "xargs" is not available.

gradlew.bat

@@ -70,11 +70,11 @@ goto fail
 :execute
 @rem Setup the command line
 
-set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+set CLASSPATH=
 
 
 @rem Execute Gradle
-"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
 
 :end
 @rem End local scope for the variables with windows NT shell

release.sh

@@ -1,89 +0,0 @@
-#!/bin/sh
-
-### This should be a pipeline, but for this example let use this ###
-
-check_active_branch() {
-  if [ "$(git rev-parse --abbrev-ref HEAD)" != "$1" ]; then
-    echo "Error: The current branch is not $1."
-    exit 1
-  fi
-}
-
-check_uncommitted_changes() {
-  if [ -n "$(git status --porcelain)" ]; then
-    echo "Error: There are uncommitted changes in the repository."
-    exit 1
-  fi
-}
-
-prepare_environment() {
-    git fetch origin
-}
-
-check_last_commit() {
-  last_commit_message=$(git log -1 --pretty=format:%s)
-  if [ "$last_commit_message" = "[RELEASE] - bump version" ]; then
-    echo "Warning: Nothing to release!!!"
-    exit 1
-  fi
-}
-
-check_differences() {
-  if ! git diff --quiet origin/"$1" "$1"; then
-    echo "Error: The branches origin/$1 and $1 have differences."
-    exit 1
-  fi
-}
-
-un_snapshot_version() {
-  sed -i "s/\($1\s*=\s*[0-9]\+\.[0-9]\+\.[0-9]\+\).*/\1/" gradle.properties
-}
-
-current_version() {
-    awk -F '=' '/version\s*=\s*[0-9.]*/ {gsub(/^ +| +$/,"",$2); print $2}' gradle.properties
-}
-
-stage_files() {
-    for file in "$@"; do
-        if git diff --exit-code --quiet -- "$file"; then
-            echo "No changes in $file"
-        else
-            git add "$file"
-            echo "Changes in $file staged for commit"
-        fi
-    done
-}
-
-commit_change() {
-    stage_files gradle.properties
-    git commit -m "[RELEASE] - $1"
-    git push --porcelain origin master
-}
-
-add_release_tag() {
-  gitTag="v$(current_version)"
-  git tag -a "$gitTag" -m "Release version $gitTag"
-  git push --porcelain origin "$gitTag"
-}
-
-snapshot_version() {
-  new_version="$(current_version | awk -F '.' '{print $1 "." $2+1 ".0"}')"
-  sed -i "s/\(version\s*=\s*\)[0-9.]*/\1$new_version-SNAPSHOT/" gradle.properties
-}
-
-# check and prepare for release
-check_active_branch master
-check_uncommitted_changes
-prepare_environment
-check_last_commit
-check_differences master
-
-# un-snapshot version for release
-un_snapshot_version version
-un_snapshot_version catalog
-
-# release changes and prepare for next release
-commit_change "release version: $(current_version)"
-add_release_tag
-snapshot_version
-commit_change 'bump version'

src/main/kotlin/ltd/hlaeja/test/Assertion.kt

@@ -1,5 +1,7 @@
 package ltd.hlaeja.test
 
+import java.util.UUID
+import org.assertj.core.api.AbstractAssert
 import org.assertj.core.api.AbstractStringAssert
 
 @Suppress("unused")
@@ -13,3 +15,12 @@ fun <SELF : AbstractStringAssert<SELF>?> AbstractStringAssert<SELF>.compareToFil
     ?: throw UnsupportedOperationException(
         "Attempted to compare assertion object to context of a file but expected file was not found: $file",
     )
+
+@Suppress("unused")
+fun <SELF : AbstractAssert<SELF, ACTUAL>?, ACTUAL> AbstractAssert<SELF, ACTUAL>.isEqualToUuid(
+    uuid: String,
+): SELF = try {
+    UUID.fromString(uuid).let { expected -> this.isEqualTo(expected) }
+} catch (e: IllegalArgumentException) {
+    throw UnsupportedOperationException("Invalid UUID string provided: $uuid", e)
+}

src/main/kotlin/ltd/hlaeja/test/container/PostgresContainer.kt

@@ -1,11 +1,12 @@
 package ltd.hlaeja.test.container
 
-import org.junit.jupiter.api.extension.ExtendWith
 import org.springframework.test.context.ContextConfiguration
+import org.springframework.test.context.TestExecutionListeners
+import org.springframework.test.context.TestExecutionListeners.MergeMode.MERGE_WITH_DEFAULTS
 
 @Suppress("unused")
 @Retention(AnnotationRetention.RUNTIME)
 @Target(AnnotationTarget.CLASS)
-@ExtendWith(PostgresExtension::class)
 @ContextConfiguration(initializers = [PostgresInitializer::class])
+@TestExecutionListeners(listeners = [PostgresInitializer::class], mergeMode = MERGE_WITH_DEFAULTS)
 annotation class PostgresContainer

src/main/kotlin/ltd/hlaeja/test/container/PostgresExecutor.kt

@@ -0,0 +1,55 @@
+package ltd.hlaeja.test.container
+
+import io.github.oshai.kotlinlogging.KotlinLogging
+import java.io.BufferedReader
+import java.io.InputStream
+import java.io.InputStreamReader
+import kotlinx.coroutines.runBlocking
+import ltd.hlaeja.test.util.isResourceFile
+import org.springframework.r2dbc.core.DatabaseClient
+import org.springframework.r2dbc.core.await
+import org.springframework.stereotype.Component
+
+private val log = KotlinLogging.logger {}
+
+@Component
+class PostgresExecutor(
+    private val databaseClient: DatabaseClient,
+) {
+
+    fun executeSqlFile(
+        sqlFile: String,
+    ) = runBlocking {
+        sqlFile.isResourceFile()
+            ?.inputStream
+            ?.use {
+                log.debug { "Executing SQL file: $sqlFile" }
+                executeSqlStatements(makeSqlStatements(it))
+            }
+            ?: log.debug { "SQL file not found or not readable: $sqlFile" }
+    }
+
+    @Suppress("TooGenericExceptionThrown")
+    private suspend fun executeSqlStatements(
+        statements: List<String>,
+    ) = try {
+        statements.forEach { statement ->
+            log.debug { "Running statement: $statement" }
+            databaseClient.sql(statement).await()
+        }
+    } catch (e: Exception) {
+        throw RuntimeException("Failed to execute SQL statements", e)
+    }
+
+    private suspend fun makeSqlStatements(
+        inputStream: InputStream,
+    ): List<String> = BufferedReader(InputStreamReader(inputStream))
+        .lines()
+        .filter { it.isNotEmpty() && !it.startsWith("--") }
+        .map { it.trim() }
+        .toList()
+        .joinToString(" ")
+        .split(';')
+        .filter { it.isNotBlank() }
+        .map { "${it.trim()};" }
+}

src/main/kotlin/ltd/hlaeja/test/container/PostgresExtension.kt

@@ -1,74 +0,0 @@
-package ltd.hlaeja.test.container
-
-import java.io.BufferedReader
-import java.io.InputStreamReader
-import org.junit.jupiter.api.extension.AfterAllCallback
-import org.junit.jupiter.api.extension.BeforeAllCallback
-import org.junit.jupiter.api.extension.ExtensionContext
-import org.springframework.core.io.ClassPathResource
-import org.springframework.test.context.junit.jupiter.SpringExtension
-import kotlinx.coroutines.runBlocking
-import io.r2dbc.spi.Connection
-import io.r2dbc.spi.ConnectionFactory
-import kotlinx.coroutines.reactive.awaitFirstOrElse
-import kotlinx.coroutines.reactive.awaitFirstOrNull
-
-class PostgresExtension : BeforeAllCallback, AfterAllCallback {
-
-    override fun beforeAll(context: ExtensionContext) {
-        executeSqlFile(context, "postgres/data.sql")
-    }
-
-    override fun afterAll(context: ExtensionContext) {
-        executeSqlFile(context, "postgres/reset.sql")
-    }
-
-    private fun executeSqlFile(
-        context: ExtensionContext,
-        resourceSourcePath: String,
-    ) = runBlocking {
-        if (ClassPathResource(resourceSourcePath).exists()) {
-            executeSqlStatements(
-                postgresConnection(context),
-                makeSqlStatements(ClassPathResource(resourceSourcePath)),
-            )
-        }
-    }
-
-    @Suppress("TooGenericExceptionThrown")
-    private suspend fun postgresConnection(
-        context: ExtensionContext,
-    ) = SpringExtension.getApplicationContext(context)
-        .getBean(ConnectionFactory::class.java)
-        .create()
-        .awaitFirstOrElse { throw RuntimeException("Connection factory could not be created") }
-
-    private suspend fun executeSqlStatements(
-        connection: Connection,
-        statements: List<String>,
-    ) {
-        try {
-            statements.forEach { statement ->
-                connection.createStatement(statement)
-                    .execute()
-                    .awaitFirstOrNull()
-            }
-        } finally {
-            connection.close().awaitFirstOrNull()
-        }
-    }
-
-    private fun makeSqlStatements(
-        classPathResource: ClassPathResource,
-    ): List<String> = classPathResource.inputStream.use { inputStream ->
-        BufferedReader(InputStreamReader(inputStream))
-            .lines()
-            .filter { it.isNotEmpty() && !it.startsWith("--") }
-            .map { it.trim() }
-            .toList()
-            .joinToString(" ")
-            .split(';')
-            .filter { it.isNotBlank() }
-            .map { "${it.trim()};" }
-    }
-}

src/main/kotlin/ltd/hlaeja/test/container/PostgresInitializer.kt

@@ -1,32 +1,67 @@
 package ltd.hlaeja.test.container
 
+import io.github.oshai.kotlinlogging.KotlinLogging
+import ltd.hlaeja.test.util.getProperty
+import ltd.hlaeja.test.util.isResourceFile
 import org.springframework.boot.test.util.TestPropertyValues
 import org.springframework.context.ApplicationContextInitializer
 import org.springframework.context.ConfigurableApplicationContext
-import org.springframework.core.io.ClassPathResource
+import org.springframework.test.context.TestContext
+import org.springframework.test.context.TestExecutionListener
 import org.testcontainers.containers.PostgreSQLContainer
 
-@Suppress("unused")
-class PostgresInitializer : ApplicationContextInitializer<ConfigurableApplicationContext> {
+private val log = KotlinLogging.logger {}
 
-    override fun initialize(applicationContext: ConfigurableApplicationContext) {
-        postgres().apply {
+@Suppress("unused")
+class PostgresInitializer : ApplicationContextInitializer<ConfigurableApplicationContext>, TestExecutionListener {
+
+    companion object {
+        const val SCRIPT_INIT = "container.postgres.init"
+        const val SCRIPT_BEFORE = "container.postgres.before"
+        const val SCRIPT_AFTER = "container.postgres.after"
+        const val POSTGRES_VERSION = "container.postgres.version"
+        const val POSTGRES_LATEST = "postgres:latest"
+    }
+
+    override fun initialize(
+        context: ConfigurableApplicationContext,
+    ) {
+        postgres(context).apply {
             TestPropertyValues.of(
                 "spring.r2dbc.url=r2dbc:pool:postgresql://$host:$firstMappedPort/$databaseName",
                 "spring.r2dbc.username=$username",
                 "spring.r2dbc.password=$password",
-            ).applyTo(applicationContext)
+            ).applyTo(context)
         }
     }
 
-    private fun postgres(): PostgreSQLContainer<*> = PostgreSQLContainer("postgres:17")
-        .withReuse(true)
-        .apply {
-            "postgres/schema.sql".let {
-                if (ClassPathResource(it).exists()) {
-                    withInitScript(it)
-                }
-            }
-            start()
-        }
+    override fun beforeTestClass(
+        context: TestContext,
+    ) {
+        context.testClass
+            .also { log.debug { "Starting execution before class: ${it.simpleName}" } }
+            .getAnnotation(PostgresContainer::class.java) ?: return
+        context.getProperty(SCRIPT_BEFORE)
+            ?.let { context.applicationContext.getBean(PostgresExecutor::class.java).executeSqlFile(it) }
+    }
+
+    override fun afterTestClass(
+        context: TestContext,
+    ) {
+        context.testClass
+            .also { log.debug { "Starting execution after class: ${it.simpleName}" } }
+            .getAnnotation(PostgresContainer::class.java) ?: return
+        context.getProperty(SCRIPT_AFTER)
+            ?.let { context.applicationContext.getBean(PostgresExecutor::class.java).executeSqlFile(it) }
+    }
+
+    private fun postgres(
+        context: ConfigurableApplicationContext,
+    ): PostgreSQLContainer<*> = PostgreSQLContainer(context.getProperty(POSTGRES_VERSION, POSTGRES_LATEST)).apply {
+        context.getProperty(SCRIPT_INIT)
+            ?.isResourceFile()
+            ?.let { lala -> withInitScript(lala.path) }
+            ?: log.error { "Postgres init script not found" }
+        start()
+    }
 }

src/main/kotlin/ltd/hlaeja/test/util/ContainerUtil.kt

@@ -0,0 +1,26 @@
+package ltd.hlaeja.test.util
+
+import org.springframework.context.ConfigurableApplicationContext
+import org.springframework.core.io.ClassPathResource
+import org.springframework.test.context.TestContext
+
+fun ConfigurableApplicationContext.getProperty(
+    property: String,
+): String? = this.environment.getProperty(property)
+
+fun ConfigurableApplicationContext.getProperty(
+    property: String,
+    default: String,
+): String = this.environment.getProperty(property, default)
+
+fun TestContext.getProperty(
+    property: String,
+): String? = this.applicationContext.environment.getProperty(property)
+
+fun String.isResourceFile(): ClassPathResource? {
+    val resource = ClassPathResource(this)
+    return when {
+        resource.exists() && resource.isReadable -> resource
+        else -> null
+    }
+}