Feature: 프로젝트 추가 세팅

.editorconfig

@@ -0,0 +1,4 @@
+[*.{kt,kts}]
+insert_final_newline=true
+ij_kotlin_allow_trailing_comma = true
+# ij_kotlin_allow_trailing_comma_on_call_site = true

.github/ISSUE_TEMPLATE/issue-enhancement.md

@@ -0,0 +1,21 @@
+---
+name: 'Issue: Enhancement'
+about: 새로운 기능 구현, 리팩토링과 관련된 이슈 템플릿
+title: "🤖 [FEATURE]"
+labels: ''
+assignees: ''
+
+---
+
+# 🤖 기능 개요
+<!-- 이슈에 할당된 기능이 무엇인지 간략하게 한 줄로 적습니다 -->
+
+### ✅ Implement TODO
+<!-- 이슈에 할당된 TODO를 나름대로 항목화하여 적습니다 (PR할 때에는 모두 체크되어야함) -->
+- [ ] 
+
+### 🚧 작업 브랜치
+<!-- 작업 브랜치 이름 적어주세요 -->
+
+### 📚 Remarks
+<!-- 기능 개발에 있어 비고사항이 있었다면 적기 -->

.github/ISSUE_TEMPLATE/issue-fix.md

@@ -0,0 +1,25 @@
+---
+name: 'Issue: Fix'
+about: 에러 및 버그에 관련된 이슈 템플릿
+title: "🐞 [ERROR / BUG]"
+labels: ''
+assignees: ''
+
+---
+
+# 🐞 에러 상황 설명
+### 📄  에러 대상
+<!-- 에러가 어디서 났는지 적기 -->
+
+### 🕵🏻‍♀️    에러 상황
+<!-- 에러가 어떻게 나고 있는지 상세하게 적기 (사진 있으면 첨부) -->
+
+### ✅ Resolve TODO
+<!-- 에러/버그 수정 항목 나열하기 (PR할 때에는 모두 체크되어야함) -->
+- [ ] 
+
+### 🚧 작업 브랜치
+<!-- 작업 브랜치 이름 적어주세요 -->
+
+### 📚 Remarks
+<!-- 이슈 해결에 있어 비고사항이 있었다면 적기 -->

.github/ISSUE_TEMPLATE/issue-refactor.md

@@ -0,0 +1,20 @@
+---
+name: "Issue: Refactor"
+about: 리팩토링 시에 적는 템플릿
+title: "🔨[REFACTOR]"
+labels: ''
+assignees: ''
+
+---
+
+# 🔨 리팩토링이 필요한 부분
+<!-- 리팩토링 내용 -->
+
+### ✅ refactoring TODO
+<!-- 리팩토링 투두  -->
+
+### 🚧 작업 브랜치
+<!-- 작업 브랜치 이름 적어주세요 -->
+
+### 📚 Remarks
+<!-- 기능 개발에 있어 비고사항이 있었다면 적기 -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,8 @@
+## 개요
+- close #issueNumber
+
+## 작업사항
+- 내용을 적어주세요.
+
+## 변경로직
+- 내용을 적어주세요.

.github/workflows/CI.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  pull_request:
+    branches:
+      - develop
+    types: [ opened, synchronize, reopened ]
+
+jobs:
+  build:
+    name: CI
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        kotlin-version: [ "1.8.22" ]
+        java-version: [ "17" ]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Kotlin
+        uses: actions/setup-java@v3
+        with:
+          java-version: ${{ matrix.java-version }}
+          kotlin-version: ${{ matrix.kotlin-version }}
+          distribution: 'adopt'
+
+      # 빌드, ktlint check도 진행됨
+      - name: Gradle Clean & Build
+        run: ./gradlew clean build
+
+      # 컨테이너 실행
+      - name: Start containers  # test 돌릴때 mysql 필요
+        run: docker-compose up -d
+
+      # jacoco, sonarcube
+      - name: test and analyze
+        run: ./gradlew test sonar --stacktrace
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUBTOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.gitignore

@@ -35,3 +35,5 @@ out/
 
 ### VS Code ###
 .vscode/
+
+mysqldata/

README.md

@@ -1,5 +1,5 @@
 # Spring Webflux + Coroutine Boilerplate
 
 ### Spec
-- SpringBoot v2.7.17
-- jdk 11
+- SpringBoot v3.1.5
+- jdk 17

build.gradle.kts

@@ -3,18 +3,27 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 plugins {
     val kotlinVersion = "1.8.22"
 
-    id("org.springframework.boot") version "2.7.17"
-    id("io.spring.dependency-management") version "1.0.15.RELEASE"
+    id("org.springframework.boot") version "3.1.5"
+    id("io.spring.dependency-management") version "1.1.3"
     kotlin("jvm") version kotlinVersion
     kotlin("plugin.spring") version kotlinVersion
     kotlin("plugin.jpa") version kotlinVersion
     kotlin("plugin.allopen") version kotlinVersion
     kotlin("kapt") version kotlinVersion
     idea
+
+    /** ktlint **/
+    id("org.jlleitschuh.gradle.ktlint") version "11.6.1"
+
+    /** jacoco **/
+    id("jacoco")
+
+    /** sonarqube **/
+    id("org.sonarqube") version "4.3.1.3277"
 }
 
 group = "com.goofy"
-java.sourceCompatibility = JavaVersion.VERSION_11
+java.sourceCompatibility = JavaVersion.VERSION_17
 
 repositories {
     mavenCentral()
@@ -47,10 +56,12 @@ object DependencyVersion {
     /** external */
     const val QUERYDSL_VERSION = "5.0.0"
     const val ARROW_FX_VERSION = "1.1.3"
-    const val SPRINGDOC_VERSION = "1.6.15"
+    const val SPRINGDOC_VERSION = "2.2.0"
     const val JAVADOC_SCRIBE_VERSION = "0.15.0"
     const val KOTLIN_LOGGING_VERSION = "2.0.11"
     const val LOGBACK_ENCODER_VERSION = "6.6"
+    const val KOTEST_VERSION = "5.7.2"
+    const val KOTEST_EXTENSION_VERSION = "1.1.2"
 }
 
 dependencies {
@@ -81,9 +92,7 @@ dependencies {
     implementation("io.arrow-kt:arrow-fx-stm:${DependencyVersion.ARROW_FX_VERSION}")
 
     /** swagger */
-    implementation("org.springdoc:springdoc-openapi-webflux-ui:${DependencyVersion.SPRINGDOC_VERSION}")
-    implementation("org.springdoc:springdoc-openapi-kotlin:${DependencyVersion.SPRINGDOC_VERSION}")
-    implementation("org.springdoc:springdoc-openapi-javadoc:${DependencyVersion.SPRINGDOC_VERSION}")
+    implementation("org.springdoc:springdoc-openapi-starter-webflux-ui:${DependencyVersion.SPRINGDOC_VERSION}")
     kapt("com.github.therapi:therapi-runtime-javadoc-scribe:${DependencyVersion.JAVADOC_SCRIBE_VERSION}")
 
     /** database */
@@ -93,6 +102,12 @@ dependencies {
     implementation("io.github.microutils:kotlin-logging:${DependencyVersion.KOTLIN_LOGGING_VERSION}")
     implementation("net.logstash.logback:logstash-logback-encoder:${DependencyVersion.LOGBACK_ENCODER_VERSION}")
 
+    /** test **/
+    testImplementation("org.springframework.boot:spring-boot-starter-test")
+    testImplementation("io.kotest:kotest-runner-junit5:${DependencyVersion.KOTEST_VERSION}")
+    testImplementation("io.kotest:kotest-assertions-core:${DependencyVersion.KOTEST_VERSION}")
+    testImplementation("io.kotest.extensions:kotest-extensions-spring:${DependencyVersion.KOTEST_EXTENSION_VERSION}")
+
     /** etc */
     developmentOnly("org.springframework.boot:spring-boot-devtools")
 }
@@ -110,7 +125,7 @@ tasks.getByName<Jar>("jar") {
 tasks.withType<KotlinCompile> {
     kotlinOptions {
         freeCompilerArgs = listOf("-Xjsr305=strict")
-        jvmTarget = "11"
+        jvmTarget = "17"
     }
 }
 
@@ -142,3 +157,63 @@ when {
 }
 
 val Project.isSnapshotVersion: Boolean get() = version.toString().endsWith("SNAPSHOT")
+
+/** jacoco **/
+tasks.withType<Test> {
+    useJUnitPlatform()
+}
+
+tasks.test {
+    finalizedBy(tasks.jacocoTestReport) // 테스트 후 진행
+}
+
+tasks.jacocoTestReport {
+    dependsOn(tasks.test) // 테스트 선행 필요
+    reports {
+        html.required.set(true)
+        csv.required.set(false)
+        xml.required.set(true)
+        xml.outputLocation.set(File("$buildDir/reports/jacoco.xml"))
+    }
+
+    classDirectories.setFrom(
+        files(
+            classDirectories.files.map {
+                fileTree(it) {
+                    exclude(
+                        "**/*Application*",
+                        "**/*Config*",
+                        "**/*Dto*",
+                        "**/*Request*",
+                        "**/*Response*",
+                        "**/*Interceptor*",
+                        "**/*Exception*",
+                        "**/Q*.class"
+                    ) // Query Dsl 용
+                }
+            }
+        )
+    )
+}
+
+/** sonarqube **/
+sonarqube {
+    properties {
+        property("sonar.projectKey", "YAPP-Github_23rd-Android-Team-1-BE")
+        property("sonar.organization", "yapp-github")
+        property("sonar.host.url", "https://sonarcloud.io")
+
+        // sonar additional settings
+        property("sonar.sources", "src")
+        property("sonar.language", "Kotlin")
+        property("sonar.sourceEncoding", "UTF-8")
+        property("sonar.test.inclusions", "**/*Test.java")
+        property(
+            "sonar.exclusions",
+            "**/test/**, **/Q*.kt, **/*Doc*.kt, **/resources/** ,**/*Application*.kt , **/*Config*.kt, **/*Dto*.kt, **/*Request*.kt, **/*Response*.kt ,**/*Exception*.kt ,**/*ErrorCode*.kt"
+        )
+        property("sonar.java.coveragePlugin", "jacoco")
+        property("sonar.java.binaries", "$buildDir/classes")
+        property("sonar.coverage.jacoco.xmlReportPaths", "$buildDir/reports/jacoco.xml")
+    }
+}

docker-compose.yml

@@ -0,0 +1,18 @@
+version: '3.7'
+
+services:
+  mysql:
+    image: mysql
+    container_name: mysql
+    hostname: mysql
+    volumes:
+      - ./mysqldata:/var/lib/mysql
+    environment:
+      - MYSQL_USER=user
+      - MYSQL_PASSWORD=user
+      - MYSQL_ROOT_PASSWORD=root
+      - MYSQL_HOST=localhost
+      - MYSQL_PORT=3306
+      - MYSQL_DATABASE=test
+    ports:
+      - "3307:3306"

src/main/kotlin/com/goofy/boilerplate/Application.kt

@@ -14,7 +14,7 @@ import java.util.*
 @SpringBootApplication
 class Application(
     private val buildProperties: BuildProperties,
-    private val environment: Environment
+    private val environment: Environment,
 ) : ApplicationListener<ApplicationReadyEvent> {
     private val logger = mu.KotlinLogging.logger { }
 

src/main/kotlin/com/goofy/boilerplate/common/dto/ErrorResponse.kt

@@ -1,17 +1,17 @@
 package com.goofy.boilerplate.common.dto
 
 import com.goofy.boilerplate.exception.ErrorCode
+import jakarta.validation.ConstraintViolationException
 import kotlinx.coroutines.CancellationException
 import org.hibernate.TypeMismatchException
 import org.springframework.core.codec.DecodingException
 import org.springframework.web.bind.support.WebExchangeBindException
 import org.springframework.web.server.ServerWebInputException
-import javax.validation.ConstraintViolationException
 
 data class ErrorResponse(
     val errorCode: String,
     val reason: String,
-    val extra: Map<String, Any>? = null
+    val extra: Map<String, Any>? = null,
 ) {
     companion object {
         private const val FAIL_TO_VALIDATE_MESSAGE = "fail to validate"

src/main/kotlin/com/goofy/boilerplate/common/dto/Response.kt → src/main/kotlin/com/goofy/boilerplate/common/dto/PageResponseDto.kt

@@ -9,7 +9,7 @@ data class PageResponseDto<T>(
     val size: Int?,
     val totalPage: Int,
     val totalCount: Long,
-    val sort: Sort
+    val sort: Sort,
 ) {
     constructor(page: Page<T>) : this(
         data = page.content,

src/main/kotlin/com/goofy/boilerplate/config/database/BoilerPlateDatabaseConfig.kt

@@ -1,6 +1,7 @@
 package com.goofy.boilerplate.config.database
 
 import com.zaxxer.hikari.HikariDataSource
+import jakarta.persistence.EntityManagerFactory
 import org.hibernate.cfg.AvailableSettings
 import org.springframework.beans.factory.annotation.Qualifier
 import org.springframework.beans.factory.config.ConfigurableListableBeanFactory
@@ -19,7 +20,6 @@ import org.springframework.orm.jpa.JpaTransactionManager
 import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean
 import org.springframework.transaction.PlatformTransactionManager
 import org.springframework.transaction.annotation.EnableTransactionManagement
-import javax.persistence.EntityManagerFactory
 import javax.sql.DataSource
 
 @Configuration
@@ -41,7 +41,7 @@ class BoilerPlateDatabaseConfig {
     @Primary
     @ConfigurationProperties(prefix = "boilerplate.master.datasource.hikari")
     fun boilerplateMasterHikariDataSource(
-        @Qualifier("boilerplateMasterDataSourceProperties") masterProperty: DataSourceProperties
+        @Qualifier("boilerplateMasterDataSourceProperties") masterProperty: DataSourceProperties,
     ): HikariDataSource {
         return masterProperty
             .initializeDataSourceBuilder()
@@ -68,12 +68,12 @@ class BoilerPlateDatabaseConfig {
     fun boilerplateEntityManager(
         entityManagerFactoryBuilder: EntityManagerFactoryBuilder,
         configurableListableBeanFactory: ConfigurableListableBeanFactory,
-        @Qualifier("boilerplateMasterHikariDataSource") boilerplateDataSource: DataSource
+        @Qualifier("boilerplateMasterHikariDataSource") boilerplateDataSource: DataSource,
     ): LocalContainerEntityManagerFactoryBean {
         return entityManagerFactoryBuilder
             .dataSource(boilerplateDataSource)
             .packages(
-                "com.goofy.boilerplate.user.domain",
+                "com.goofy.boilerplate.user.domain"
             )
             .properties(
                 mapOf(AvailableSettings.BEAN_CONTAINER to SpringBeanContainer(configurableListableBeanFactory))
@@ -84,7 +84,7 @@ class BoilerPlateDatabaseConfig {
     @Bean
     @Primary
     fun boilerplateTransactionManager(
-        @Qualifier("boilerplateEntityManager") boilerplateEntityManager: EntityManagerFactory
+        @Qualifier("boilerplateEntityManager") boilerplateEntityManager: EntityManagerFactory,
     ): PlatformTransactionManager {
         return JpaTransactionManager(boilerplateEntityManager)
     }