Merge branch 'main' into feature/31

Jenkins CI 구성 및 gradle test logging 적용

.gitignore

@@ -24,6 +24,7 @@ bin/
 out/
 !**/src/main/**/out/
 !**/src/test/**/out/
+lib/
 
 ### NetBeans ###
 /nbproject/private/

Jenkinsfile-service

@@ -0,0 +1,37 @@
+pipeline {
+    agent any
+    tools {
+        jdk("openjdk-17")
+    }
+
+    stages {
+        stage('Init') {
+            steps {
+                sh 'printenv'
+
+                migration_script = './script/db_migration.sh'
+            }
+        }
+
+        stage('DB Migrate') {
+            steps {
+                sh """
+                    chmod 755 ${migration_script}
+                    /bin/bash ${migration_script}
+                """
+            }
+        }
+
+        stage('Test') {
+            steps {
+                sh './gradlew clean :dongne-service-api:test'
+            }
+        }
+
+        stage('Build') {
+            steps {
+                sh './gradlew clean :dongne-service-api:build -x test'
+            }
+        }
+    }
+}

build.gradle.kts

@@ -1,20 +1,26 @@
+import org.gradle.api.tasks.testing.logging.TestExceptionFormat
+import org.gradle.api.tasks.testing.logging.TestLogEvent
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 import org.springframework.boot.gradle.tasks.bundling.BootJar
-
+import plugin.BuildLifecyclePlugin
-plugins {
+import task.test.TestContainer
-    id(Plugins.Spring.boot).version(Version.Spring.boot)
+import task.test.TestLoggingUtils
-    id(Plugins.Spring.dependencyManagement).version(Version.Spring.dependencyManagement).apply(false)
+import task.test.TestSummary
-    kotlin(Plugins.Kotlin.jvm).version(Version.kotlin)
-    kotlin(Plugins.Kotlin.pluginSpring).version(Version.kotlin).apply(false)
-    kotlin(Plugins.Kotlin.pluginJpa).version(Version.kotlin).apply(false)
-}
 
 val bootJar: BootJar by tasks
 bootJar.enabled = false
 
+plugins {
+    id(Plugins.Spring.BOOT).version(Version.Spring.BOOT)
+    id(Plugins.Spring.DEPENDENCY_MANAGEMENT).version(Version.Spring.DEPENDENCY_MANAGEMENT).apply(false)
+    kotlin(Plugins.Kotlin.JVM).version(Version.KOTLIN)
+    kotlin(Plugins.Kotlin.PLUGIN_SPRING).version(Version.KOTLIN).apply(false)
+    kotlin(Plugins.Kotlin.PLUGIN_JPA).version(Version.KOTLIN).apply(false)
+}
+
 allprojects {
     group = "io.beaniejoy.dongecafe"
-    version = Version.projectVersion
+    version = Version.PROJECT_VERSION
 
     repositories {
         mavenCentral()
@@ -24,15 +30,18 @@ allprojects {
 subprojects {
     apply {
         plugin(Plugins.java)
-        plugin(Plugins.Spring.dependencyManagement)
+        plugin(Plugins.Spring.DEPENDENCY_MANAGEMENT)
-        plugin(Plugins.Spring.boot)
+        plugin(Plugins.Spring.BOOT)
 
         plugin(Plugins.Kotlin.KOTLIN)
-        plugin(Plugins.Kotlin.kotlinSpring)
+        plugin(Plugins.Kotlin.KOTLIN_SPRING)
-        plugin(Plugins.Kotlin.kotlinJpa)
+        plugin(Plugins.Kotlin.KOTLIN_JPA)
     }
 
-    java.sourceCompatibility = JavaVersion.VERSION_17
+    java.apply {
+        sourceCompatibility = Version.JAVA
+        targetCompatibility = Version.JAVA
+    }
 
     dependencies {
         // Spring Boot Project
@@ -52,9 +61,9 @@ subprojects {
         runtimeOnly("com.h2database:h2") // H2
 
         // JWT
-        implementation("io.jsonwebtoken:jjwt-api:${Version.Deps.Jwt}")
+        implementation("io.jsonwebtoken:jjwt-api:${Version.Deps.JWT}")
-        runtimeOnly("io.jsonwebtoken:jjwt-impl:${Version.Deps.Jwt}")
+        runtimeOnly("io.jsonwebtoken:jjwt-impl:${Version.Deps.JWT}")
-        runtimeOnly("io.jsonwebtoken:jjwt-jackson:${Version.Deps.Jwt}")
+        runtimeOnly("io.jsonwebtoken:jjwt-jackson:${Version.Deps.JWT}")
 
         // Logging
         implementation("io.github.microutils:kotlin-logging:${Version.Deps.KOTLIN_LOGGING}")
@@ -65,14 +74,54 @@ subprojects {
     }
 
     tasks.withType<KotlinCompile> {
-        println("### Configuring $name in project ${project.name} ###")
         kotlinOptions {
             freeCompilerArgs = listOf("-Xjsr305=strict")
-            jvmTarget = JavaVersion.VERSION_17.toString()
+            jvmTarget = Version.JAVA.toString()
         }
     }
 
+    // for logging when build finished
+    apply<BuildLifecyclePlugin>()
+
+    // gradle test logging
     tasks.withType<Test> {
         useJUnitPlatform()
+
+        testLogging {
+            events = setOf(
+                TestLogEvent.FAILED,
+                TestLogEvent.SKIPPED,
+                TestLogEvent.STANDARD_ERROR
+            )
+
+            exceptionFormat = TestExceptionFormat.FULL
+            showExceptions = true
+            showCauses = true
+            showStackTraces = true
+        }
+
+//        ignoreFailures = true
+
+        addTestListener(object : TestListener {
+            override fun beforeSuite(desc: TestDescriptor) {}
+            // handling after all test finished
+            override fun afterSuite(desc: TestDescriptor, result: TestResult) {
+                if (desc.parent != null) return
+
+                val summary = TestSummary(
+                    projectName = project.name,
+                    taskName = name,
+                    result = result
+                )
+
+                TestContainer.testResults = summary
+            }
+
+            override fun beforeTest(desc: TestDescriptor) {}
+            // handling after each test finished
+            override fun afterTest(desc: TestDescriptor, result: TestResult) {
+                TestLoggingUtils.printEachResult(desc, result)
+            }
+        })
     }
 }

buildSrc/build.gradle.kts

@@ -4,4 +4,4 @@ plugins {
 
 repositories {
     mavenCentral()
-}
+}

buildSrc/src/main/kotlin/Plugins.kt

@@ -2,18 +2,18 @@ object Plugins {
     const val java = "java"
 
     object Spring {
-        const val boot = "org.springframework.boot"
+        const val BOOT = "org.springframework.boot"
-        const val dependencyManagement = "io.spring.dependency-management"
+        const val DEPENDENCY_MANAGEMENT = "io.spring.dependency-management"
     }
 
     object Kotlin {
         const val KOTLIN = "kotlin"
-        const val kotlinSpring = "kotlin-spring"
+        const val KOTLIN_SPRING = "kotlin-spring"
-        const val kotlinJpa = "kotlin-jpa"
+        const val KOTLIN_JPA = "kotlin-jpa"
 
-        const val jvm = "jvm"
+        const val JVM = "jvm"
-        const val pluginSpring = "plugin.spring"
+        const val PLUGIN_SPRING = "plugin.spring"
-        const val pluginJpa = "plugin.jpa"
+        const val PLUGIN_JPA = "plugin.jpa"
     }
 
     object FlywayDB {

buildSrc/src/main/kotlin/Version.kt

@@ -1,15 +1,19 @@
+import org.gradle.api.JavaVersion
+
 object Version {
-    const val projectVersion = "0.0.1-SNAPSHOT"
+    const val PROJECT_VERSION = "0.0.1-SNAPSHOT"
-    const val kotlin = "1.6.21"
+    const val KOTLIN = "1.6.21"
+
+    val JAVA = JavaVersion.VERSION_17
 
     object Spring {
-        const val boot = "2.7.0"
+        const val BOOT = "2.7.0"
-        const val dependencyManagement = "1.0.11.RELEASE"
+        const val DEPENDENCY_MANAGEMENT = "1.0.11.RELEASE"
     }
 
     object Deps {
         const val KOTLIN_LOGGING = "3.0.4"
-        const val Jwt = "0.11.5"
+        const val JWT = "0.11.5"
     }
 
     object FlywayDB {

buildSrc/src/main/kotlin/plugin/BuildLifecyclePlugin.kt

@@ -0,0 +1,23 @@
+package plugin
+
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.gradle.internal.build.event.BuildEventListenerRegistryInternal
+import org.gradle.invocation.DefaultGradle
+
+class BuildLifecyclePlugin : Plugin<Project> {
+    override fun apply(project: Project) {
+        val gradle = project.gradle
+
+        val services = (gradle as DefaultGradle).services
+        val registry = services[BuildEventListenerRegistryInternal::class.java]
+
+        val operationService = gradle.sharedServices.registerIfAbsent("operationService", BuildOperationService::class.java) {
+            gradle.taskGraph.whenReady {
+                parameters.lastTaskPath = this.allTasks.last().path
+            }
+        }
+
+        registry.subscribe(operationService)
+    }
+}

buildSrc/src/main/kotlin/plugin/BuildOperationService.kt

@@ -0,0 +1,26 @@
+package plugin
+
+import org.gradle.api.services.BuildService
+import org.gradle.api.services.BuildServiceParameters
+import org.gradle.tooling.events.FinishEvent
+import org.gradle.tooling.events.OperationCompletionListener
+import org.gradle.tooling.events.task.TaskFinishEvent
+import task.test.TestContainer
+import task.test.TestLoggingUtils
+
+abstract class BuildOperationService : BuildService<BuildOperationService.Params>, OperationCompletionListener {
+    interface Params : BuildServiceParameters {
+        var lastTaskPath: String
+    }
+
+    override fun onFinish(event: FinishEvent?) {
+        if (event == null || event !is TaskFinishEvent) {
+            return
+        }
+
+        if (event.descriptor.taskPath == parameters.lastTaskPath) {
+            TestLoggingUtils.printTotalResult(TestContainer.testResults)
+            TestContainer.testResults = null
+        }
+    }
+}

buildSrc/src/main/kotlin/task/test/TestContainer.kt

@@ -0,0 +1,8 @@
+package task.test
+
+class TestContainer {
+    companion object {
+        var testResults: TestSummary? = null
+        const val colorMode: Boolean = false
+    }
+}

buildSrc/src/main/kotlin/task/test/TestLoggingUtils.kt

@@ -0,0 +1,55 @@
+package task.test
+
+import org.gradle.api.tasks.testing.TestDescriptor
+import org.gradle.api.tasks.testing.TestResult
+
+class TestLoggingUtils {
+    companion object {
+        const val ANSI_RESET = "\u001B[0m"
+        const val ANSI_GREEN = "\u001B[32m"
+        const val ANSI_RED = "\u001B[31m"
+
+        fun printTotalResult(summary: TestSummary?) {
+            if (summary == null) return
+
+            val maxLength = summary.maxWidth()
+
+            println(
+                """
+                |┌${"─".repeat(maxLength)}┐
+                |${
+                    summary.toLogList().joinToString("│\n│", "│", "│") {
+                        val coloredResult = colorResultType(summary.result.resultType)
+                        "$it${" ".repeat(maxLength - it.length)}"
+                            .replace(
+                                oldValue = coloredResult.first.toString(),
+                                newValue = coloredResult.second
+                            )
+                    }
+                }
+                |└${"─".repeat(maxLength)}┘
+                """.trimMargin()
+            )
+        }
+
+        fun printEachResult(desc: TestDescriptor, result: TestResult) {
+            println("[${desc.className}] ${desc.displayName} >> result: ${colorResultType(result.resultType).second}")
+        }
+
+        fun colorResultType(resultType: TestResult.ResultType): Pair<TestResult.ResultType, String> {
+            if (TestContainer.colorMode.not()) {
+                return resultType to "${resultType}"
+            }
+
+            val color = when (resultType) {
+                TestResult.ResultType.SUCCESS -> ANSI_GREEN
+                TestResult.ResultType.FAILURE -> ANSI_RED
+                else -> ""
+            }
+
+            return resultType to if (color.isNotEmpty()) {
+                "${color}${resultType}$ANSI_RESET"
+            } else "${resultType}"
+        }
+    }
+}

buildSrc/src/main/kotlin/task/test/TestSummary.kt

@@ -0,0 +1,20 @@
+package task.test
+
+import org.gradle.api.tasks.testing.TestResult
+
+data class TestSummary(
+    val projectName: String? = null,
+    val taskName: String? = null,
+    val result: TestResult
+) {
+    fun maxWidth(): Int {
+        return toLogList().maxByOrNull { it.length }?.length ?: 0
+    }
+
+    fun toLogList(): List<String> {
+        return listOf(
+            "${projectName}:${taskName} Test result: ${result.resultType}",
+            "Test summary: ${result.testCount} tests, ${result.successfulTestCount} succeeded, ${result.failedTestCount} failed, ${result.skippedTestCount} skipped"
+        )
+    }
+}

dongne-service-api/src/test/kotlin/io/beaniejoy/dongnecafe/domain/cafe/service/CafeServiceTest.kt

@@ -87,13 +87,13 @@ internal class CafeServiceTest {
     fun update_cafe_test() {
         // given
         val (name, address, phoneNumber, description, cafeMenuList) = CafeTestUtils.createCafeRegisterRequest()
-        val cafe = Cafe.createCafe(
+//        val cafe = Cafe.createCafe(
-            name = name!!,
+//            name = name!!,
-            address = address!!,
+//            address = address!!,
-            phoneNumber = phoneNumber!!,
+//            phoneNumber = phoneNumber!!,
-            description = description!!,
+//            description = description!!,
-            cafeMenuRequestList = cafeMenuList
+//            cafeMenuRequestList = cafeMenuList
-        )
+//        )
         val cafeId = 50L
 
         // TODO 'findByIdOrNull'은 kotlin test 라이브러리 필요한 듯

dongne-service-api/src/test/resources/application.yml

@@ -1,6 +1,4 @@
 spring:
-  flyway:
-    enabled: false
   jpa:
     properties:
       hibernate:
@@ -9,7 +7,7 @@ spring:
 
 logging:
   level:
-    org.hibernate.SQL: debug
+    org.hibernate.SQL: info # ionShutdownHook logging issue (in 'DEBUG' level)
     org.hibernate.type: trace # 실제 sql 쿼리의 parameter 값을 확인하고자 함
 
 jwt:

script/db_migration.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+cd ..
+
+./gradlew :db:flywayInfo
+
+./gradlew :db:flywayValidate