[#33] test: 불필요한 요소 제거 테스트

JPA Auditing 기능 수정

Jenkinsfile-service

@@ -1,24 +1,25 @@
 pipeline {
     agent any
-    tools {
-        jdk("openjdk-17")
-    }
 
     stages {
         stage('Init') {
             steps {
-                sh 'printenv'
+                script {
+                    sh 'whoami'
+                    sh 'printenv'
 
-                migration_script = './script/db_migration.sh'
+                    FLYWAY_CONFIG = '/home/ec2-user/flyway/flyway.conf'
+                }
             }
         }
 
         stage('DB Migrate') {
             steps {
-                sh """
-                    chmod 755 ${migration_script}
-                    /bin/bash ${migration_script}
-                """
+                flywayrunner installationName: 'flywaytool-jenkins',
+                        flywayCommand: 'info migrate validate',
+                        commandLineArgs: "-configFiles=${FLYWAY_CONFIG}",
+                        credentialsId: 'ecb29499-7272-4e8b-b3ab-a7a3ab7eafab',
+                        locations: "filesystem:${WORKSPACE}/db/migration"
             }
         }
 

README.md

@@ -6,10 +6,18 @@
 <br>
 
 ## Specification
-- java 17
-- kotlin 1.6.21
-- Spring Boot 2.7.0
-- MySQL 8.0.21
+- Lang
+  - java 17
+  - kotlin 1.6.21
+- Framework
+  - Spring Boot 2.7.0
+- DB
+  - MySQL 8.0.21
+  - Flyway(migration)
+- CI/CD
+  - Jenkins
+- Cloud Server
+  - AWS Lightsail(Amazon Linux2)
 
 <br>
 

db/build.gradle.kts

@@ -19,8 +19,7 @@ flyway {
     baselineDescription = "Start Flyway Migration!"
     baselineOnMigrate = true
     baselineVersion = "000"
-    locations = arrayOf("filesystem:./migration", "filesystem:./seed")
-    configFiles = arrayOf("conf/flyway.conf")
+    configFiles = arrayOf(System.getProperty("config") ?: "flyway.conf")
     cleanDisabled = false   // activate flywayClean
     ignoreMigrationPatterns = arrayOf("*:pending")  // ignore validating pending(대기) state
 }

db/conf/flyway.conf

@@ -1,4 +0,0 @@
-flyway.url=jdbc:mysql://localhost:3306/dongne?autoreconnect=true&characterEncoding=utf8&serverTimezone=Asia/Seoul
-flyway.user=root
-flyway.password=beaniejoy
-flyway.driver=com.mysql.cj.jdbc.Driver

db/flyway.conf

@@ -0,0 +1,10 @@
+flyway.url=jdbc:mysql://localhost:3306/dongne?autoreconnect=true&characterEncoding=utf8&serverTimezone=Asia/Seoul
+flyway.user=root
+flyway.password=beaniejoy
+flyway.driver=com.mysql.cj.jdbc.Driver
+flyway.locations=filesystem:db/migration,db/seed
+
+flyway.baselineOnMigrate=true
+flyway.baselineVersion=000
+# flyway.ignoreMigrationPatterns=*:pending
+flyway.cleanDisabled=false

db/migration/V002__Create_cafe.sql

@@ -6,8 +6,8 @@ CREATE TABLE `cafe` (
     `total_rate` float NOT NULL COMMENT '카페 종합 평가 점수',
     `description` varchar(255) COMMENT '카페 상세설명',
     `created_at` datetime NOT NULL COMMENT '카페 등록날짜',
-    `created_by` varchar(20) NOT NULL COMMENT '카페 등록자',
+    `created_by` varchar(320) NOT NULL COMMENT '카페 등록자',
     `updated_at` datetime NULL COMMENT '카페 변경날짜',
-    `updated_by` varchar(20) NULL COMMENT '카페 변경자',
+    `updated_by` varchar(320) NULL COMMENT '카페 변경자',
     PRIMARY KEY (`id`)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

db/migration/V003__Create_cafe_menu.sql

@@ -3,9 +3,9 @@ CREATE TABLE `cafe_menu` (
     `name` varchar(50) NOT NULL COMMENT '카페 메뉴명',
     `price` decimal(10, 2) NOT NULL COMMENT '메뉴 가격',
     `created_at` datetime NOT NULL COMMENT '메뉴 등록날짜',
-    `created_by` varchar(20) NOT NULL COMMENT '메뉴 등록자',
+    `created_by` varchar(320) NOT NULL COMMENT '메뉴 등록자',
     `updated_at` datetime COMMENT '메뉴 변경날짜',
-    `updated_by` varchar(20) NULL COMMENT '메뉴 변경자',
+    `updated_by` varchar(320) NULL COMMENT '메뉴 변경자',
     `cafe_id` bigint unsigned NOT NULL COMMENT '연관된 카페 ID',
     PRIMARY KEY (`id`),
     KEY `cafe_id` (`cafe_id`),

db/migration/V004__Create_cafe_image.sql

@@ -2,9 +2,9 @@ CREATE TABLE `cafe_image` (
     `id` bigint unsigned NOT NULL AUTO_INCREMENT COMMENT '카페 이미지 ID',
     `img_url` varchar(255) NOT NULL COMMENT '이미지 경로',
     `created_at` datetime NOT NULL COMMENT '이미지 등록날짜',
-    `created_by` varchar(20) NOT NULL COMMENT '이미지 등록자',
+    `created_by` varchar(320) NOT NULL COMMENT '이미지 등록자',
     `updated_at` datetime COMMENT '이미지 변경날짜',
-    `updated_by` varchar(20) NULL COMMENT '이미지 변경자',
+    `updated_by` varchar(320) NULL COMMENT '이미지 변경자',
     `cafe_id` bigint unsigned NOT NULL COMMENT '연관된 카페 ID',
     PRIMARY KEY (`id`),
     KEY `cafe_id` (`cafe_id`),

db/migration/V005__Create_menu_option.sql

@@ -2,9 +2,9 @@ CREATE TABLE `menu_option`(
     `id` bigint unsigned NOT NULL AUTO_INCREMENT COMMENT '옵션 ID',
     `title` varchar(50) NOT NULL COMMENT '메뉴 옵션 이름',
     `created_at` datetime NOT NULL COMMENT '옵션 등록날짜',
-    `created_by` varchar(20) NOT NULL COMMENT '옵션 등록자',
+    `created_by` varchar(320) NOT NULL COMMENT '옵션 등록자',
     `updated_at` datetime COMMENT '옵션 변경날짜',
-    `updated_by` varchar(20) NULL COMMENT '옵션 변경자',
+    `updated_by` varchar(320) NULL COMMENT '옵션 변경자',
     `menu_id` bigint unsigned NOT NULL COMMENT '연관된 카페 메뉴 ID',
     PRIMARY KEY (`id`),
     KEY `menu_id` (`menu_id`),

db/migration/V006__Create_option_detail.sql

@@ -3,9 +3,9 @@ CREATE TABLE `option_detail` (
     `name` varchar(50) NOT NULL COMMENT '옵션 상세명',
     `extra_price` decimal(10, 2) NOT NULL COMMENT '옵션 추가 요금',
     `created_at` datetime NOT NULL COMMENT '옵션 상세 등록날짜',
-    `created_by` varchar(20) NOT NULL COMMENT '옵션 상세 등록자',
+    `created_by` varchar(320) NOT NULL COMMENT '옵션 상세 등록자',
     `updated_at` datetime COMMENT '옵션 상세 변경날짜',
-    `updated_by` varchar(20) NULL COMMENT '옵션 상세 변경자',
+    `updated_by` varchar(320) NULL COMMENT '옵션 상세 변경자',
     `option_id` bigint unsigned NOT NULL COMMENT '연관된 옵션 ID',
     PRIMARY KEY (`id`),
     KEY `option_id` (`option_id`),

db/migration/V008__Create_member.sql

@@ -7,8 +7,8 @@ CREATE TABLE `member` (
     `role_type` varchar(20) COMMENT '회원 권한',
     `activated` tinyint NOT NULL COMMENT '계정 활성화 여부',
     `created_at` datetime NOT NULL COMMENT '회원 등록날짜',
-    `created_by` varchar(20) NOT NULL COMMENT '회원 등록자',
+    `created_by` varchar(320) NOT NULL COMMENT '회원 등록자',
     `updated_at` datetime NULL COMMENT '회원 변경날짜',
-    `updated_by` varchar(20) NULL COMMENT '회원 변경자',
+    `updated_by` varchar(320) NULL COMMENT '회원 변경자',
     PRIMARY KEY (`member_id`)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

dongne-account-api/src/main/kotlin/io/beaniejoy/dongnecafe/common/config/AuditingConfig.kt

@@ -1,8 +0,0 @@
-package io.beaniejoy.dongnecafe.common.config
-
-import org.springframework.context.annotation.Configuration
-import org.springframework.data.jpa.repository.config.EnableJpaAuditing
-
-@Configuration
-@EnableJpaAuditing
-class AuditingConfig 

dongne-account-api/src/main/kotlin/io/beaniejoy/dongnecafe/common/entity/BaseEntityAuditorAware.kt

@@ -1,12 +0,0 @@
-package io.beaniejoy.dongnecafe.common.entity
-
-import org.springframework.data.domain.AuditorAware
-import org.springframework.stereotype.Component
-import java.util.*
-
-@Component
-class BaseEntityAuditorAware: AuditorAware<String> {
-    override fun getCurrentAuditor(): Optional<String> {
-        return Optional.of("system")
-    }
-}

dongne-common/src/main/kotlin/io/beaniejoy/dongnecafe/common/config/AuditingConfig.kt

@@ -0,0 +1,25 @@
+package io.beaniejoy.dongnecafe.common.config
+
+import io.beaniejoy.dongnecafe.security.getAuthPrincipal
+import mu.KLogging
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+import org.springframework.data.domain.AuditorAware
+import org.springframework.data.jpa.repository.config.EnableJpaAuditing
+import org.springframework.security.core.context.SecurityContextHolder
+import java.util.*
+
+@Configuration
+@EnableJpaAuditing
+class AuditingConfig {
+    companion object: KLogging() {
+        const val SYSTEM = "system"
+    }
+
+    @Bean
+    fun auditorProvider(): AuditorAware<String> {
+        return AuditorAware<String> {
+            Optional.of(SecurityContextHolder.getContext().authentication?.getAuthPrincipal() ?: SYSTEM)
+        }
+    }
+}

dongne-common/src/main/kotlin/io/beaniejoy/dongnecafe/common/entity/BaseEntity.kt

@@ -0,0 +1,21 @@
+package io.beaniejoy.dongnecafe.common.entity
+
+import org.springframework.data.annotation.CreatedBy
+import org.springframework.data.annotation.LastModifiedBy
+import org.springframework.data.jpa.domain.support.AuditingEntityListener
+import javax.persistence.Column
+import javax.persistence.EntityListeners
+import javax.persistence.MappedSuperclass
+
+@MappedSuperclass
+@EntityListeners(AuditingEntityListener::class)
+abstract class BaseEntity protected constructor() : BaseTimeEntity() {
+    @CreatedBy
+    @Column(updatable = false)
+    lateinit var createdBy: String
+        protected set
+
+    @LastModifiedBy
+    lateinit var updatedBy: String
+        protected set
+}

dongne-common/src/main/kotlin/io/beaniejoy/dongnecafe/common/entity/BaseTimeEntity.kt

@@ -1,11 +1,10 @@
-package io.beaniejoy.dongnecafe.common
+package io.beaniejoy.dongnecafe.common.entity
 
-import org.springframework.data.annotation.CreatedBy
 import org.springframework.data.annotation.CreatedDate
-import org.springframework.data.annotation.LastModifiedBy
 import org.springframework.data.annotation.LastModifiedDate
 import org.springframework.data.jpa.domain.support.AuditingEntityListener
 import java.time.LocalDateTime
+import javax.persistence.Column
 import javax.persistence.EntityListeners
 import javax.persistence.MappedSuperclass
 
@@ -13,18 +12,11 @@ import javax.persistence.MappedSuperclass
 @EntityListeners(AuditingEntityListener::class)
 abstract class BaseTimeEntity protected constructor() {
     @CreatedDate
-    var createdAt: LocalDateTime = LocalDateTime.now()
-        protected set
-
-    @CreatedBy
-    var createdBy: String = ""
+    @Column(updatable = false)
+    lateinit var createdAt: LocalDateTime
         protected set
 
     @LastModifiedDate
-    var updatedAt: LocalDateTime? = null
-        protected set
-
-    @LastModifiedBy
-    var updatedBy: String? = null
+    lateinit var updatedAt: LocalDateTime
         protected set
 }

dongne-common/src/main/kotlin/io/beaniejoy/dongnecafe/domain/cafe/entity/Cafe.kt

@@ -1,6 +1,6 @@
 package io.beaniejoy.dongnecafe.domain.cafe.entity
 
-import io.beaniejoy.dongnecafe.common.BaseTimeEntity
+import io.beaniejoy.dongnecafe.common.entity.BaseEntity
 import io.beaniejoy.dongnecafe.domain.cafe.model.request.CafeMenuRegisterRequest
 import javax.persistence.*
 
@@ -11,7 +11,7 @@ class Cafe protected constructor(
     address: String,
     phoneNumber: String,
     description: String,
-) : BaseTimeEntity() {
+) : BaseEntity() {
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     @Column(name = "cafe_id", nullable = false)

dongne-common/src/main/kotlin/io/beaniejoy/dongnecafe/domain/cafe/entity/CafeImage.kt

@@ -1,11 +1,11 @@
 package io.beaniejoy.dongnecafe.domain.cafe.entity
 
-import io.beaniejoy.dongnecafe.common.BaseTimeEntity
+import io.beaniejoy.dongnecafe.common.entity.BaseEntity
 import javax.persistence.*
 
 @Entity
 @Table(name = "cafe_image")
-class CafeImage(
+class CafeImage protected constructor(
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     @Column(name = "cafe_image_id", nullable = false)
@@ -17,4 +17,4 @@ class CafeImage(
     @ManyToOne
     @JoinColumn(name = "cafe_id", nullable = false)
     val cafe: Cafe
-) : BaseTimeEntity()
+) : BaseEntity()

dongne-common/src/main/kotlin/io/beaniejoy/dongnecafe/domain/cafe/entity/CafeMenu.kt

@@ -1,6 +1,6 @@
 package io.beaniejoy.dongnecafe.domain.cafe.entity
 
-import io.beaniejoy.dongnecafe.common.BaseTimeEntity
+import io.beaniejoy.dongnecafe.common.entity.BaseEntity
 import io.beaniejoy.dongnecafe.domain.cafe.model.request.MenuOptionRegisterRequest
 import java.math.BigDecimal
 import javax.persistence.*
@@ -10,7 +10,7 @@ import javax.persistence.*
 class CafeMenu protected constructor(
     name: String,
     price: BigDecimal,
-) : BaseTimeEntity() {
+) : BaseEntity() {
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     @Column(name = "cafe_menu_id", nullable = false)
@@ -33,7 +33,11 @@ class CafeMenu protected constructor(
     val menuOptionList: MutableList<MenuOption> = arrayListOf()
 
     companion object {
-        fun createCafeMenu(name: String, price: BigDecimal, menuOptionRequestList: List<MenuOptionRegisterRequest>): CafeMenu {
+        fun createCafeMenu(
+            name: String,
+            price: BigDecimal,
+            menuOptionRequestList: List<MenuOptionRegisterRequest>
+        ): CafeMenu {
             val menuOptionEntityList = menuOptionRequestList.map { menuOptionRequestDto ->
                 MenuOption.createMenuOption(
                     title = menuOptionRequestDto.title,

dongne-common/src/main/kotlin/io/beaniejoy/dongnecafe/domain/cafe/entity/MenuOption.kt

@@ -1,6 +1,6 @@
 package io.beaniejoy.dongnecafe.domain.cafe.entity
 
-import io.beaniejoy.dongnecafe.common.BaseTimeEntity
+import io.beaniejoy.dongnecafe.common.entity.BaseEntity
 import io.beaniejoy.dongnecafe.domain.cafe.model.request.OptionDetailRegisterRequest
 import javax.persistence.*
 
@@ -8,7 +8,7 @@ import javax.persistence.*
 @Table(name = "menu_option")
 class MenuOption protected constructor(
     title: String
-) : BaseTimeEntity() {
+) : BaseEntity() {
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     @Column(name = "menu_option_id", nullable = false)

dongne-common/src/main/kotlin/io/beaniejoy/dongnecafe/domain/cafe/entity/OptionDetail.kt

@@ -1,6 +1,6 @@
 package io.beaniejoy.dongnecafe.domain.cafe.entity
 
-import io.beaniejoy.dongnecafe.common.BaseTimeEntity
+import io.beaniejoy.dongnecafe.common.entity.BaseEntity
 import java.math.BigDecimal
 import javax.persistence.*
 
@@ -9,7 +9,7 @@ import javax.persistence.*
 class OptionDetail protected constructor(
     name: String,
     extraPrice: BigDecimal
-) : BaseTimeEntity() {
+) : BaseEntity() {
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     @Column(name = "option_detail_id", nullable = false)

dongne-common/src/main/kotlin/io/beaniejoy/dongnecafe/domain/member/entity/Member.kt

@@ -1,6 +1,6 @@
 package io.beaniejoy.dongnecafe.domain.member.entity
 
-import io.beaniejoy.dongnecafe.common.BaseTimeEntity
+import io.beaniejoy.dongnecafe.common.entity.BaseEntity
 import io.beaniejoy.dongnecafe.domain.member.constant.RoleType
 import javax.persistence.*
 
@@ -11,7 +11,7 @@ class Member(
     password: String,
     address: String,
     phoneNumber: String
-): BaseTimeEntity() {
+) : BaseEntity() {
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     @Column(name = "member_id", nullable = false)

dongne-common/src/main/kotlin/io/beaniejoy/dongnecafe/security/SecurityExtensions.kt

@@ -0,0 +1,15 @@
+package io.beaniejoy.dongnecafe.security
+
+import io.beaniejoy.dongnecafe.security.constant.SecurityConstant.ANONYMOUS_USER
+import io.beaniejoy.dongnecafe.security.constant.SecurityConstant.ROLE_ANONYMOUS
+import org.springframework.security.core.Authentication
+
+fun Authentication.getAuthPrincipal() : String? {
+    if (this.isAnonymous()) return null
+
+    return this.principal.toString()
+}
+
+fun Authentication.isAnonymous(): Boolean {
+    return this.principal == ANONYMOUS_USER || this.authorities.any { it.authority == ROLE_ANONYMOUS }
+}

dongne-common/src/main/kotlin/io/beaniejoy/dongnecafe/security/constant/SecurityConstant.kt

@@ -3,4 +3,7 @@ package io.beaniejoy.dongnecafe.security.constant
 object SecurityConstant {
     const val BEARER = "Bearer"
     const val WHITESPACE = " "
+
+    const val ANONYMOUS_USER = "anonymousUser"
+    const val ROLE_ANONYMOUS = "ROLE_ANONYMOUS"
 }

dongne-service-api/src/main/kotlin/io/beaniejoy/dongnecafe/common/config/AuditingConfig.kt

@@ -1,8 +0,0 @@
-package io.beaniejoy.dongnecafe.common.config
-
-import org.springframework.context.annotation.Configuration
-import org.springframework.data.jpa.repository.config.EnableJpaAuditing
-
-@Configuration
-@EnableJpaAuditing
-class AuditingConfig 

dongne-service-api/src/main/kotlin/io/beaniejoy/dongnecafe/common/config/SecurityConfig.kt

@@ -21,10 +21,10 @@ class SecurityConfig {
     @Bean
     fun filterChain(http: HttpSecurity): SecurityFilterChain {
         return http
+            // only api 방식 인증 & 인가 적용 위해 csrf & formLogin 비활성화
             .csrf().disable()
             .formLogin().disable()
 
-            // FIXME 임시 permitAll 설정
             .authorizeRequests()
             .anyRequest().authenticated()
 
@@ -43,6 +43,7 @@ class SecurityConfig {
             .jwtTokenUtils(jwtTokenUtils)
     }
 
+    // Security Filter 미적용 자원 설정
     @Bean
     fun webSecurityCustomizer(): WebSecurityCustomizer {
         return WebSecurityCustomizer { web ->

dongne-service-api/src/main/kotlin/io/beaniejoy/dongnecafe/common/entity/BaseEntityAuditorAware.kt

@@ -1,13 +0,0 @@
-package io.beaniejoy.dongnecafe.common.entity
-
-import org.springframework.data.domain.AuditorAware
-import org.springframework.stereotype.Component
-import java.util.*
-
-@Component
-class BaseEntityAuditorAware: AuditorAware<String> {
-    override fun getCurrentAuditor(): Optional<String> {
-        // TODO 추후 사용자 로그인 기능 추가되면 실제 등록한 사용자를 DB에 저장하는 방향으로 수정
-        return Optional.of("system")
-    }
-}

dongne-service-api/src/main/kotlin/io/beaniejoy/dongnecafe/security/filter/JwtAuthenticationFilter.kt

@@ -24,9 +24,11 @@ class JwtAuthenticationFilter(
         val httpRequest = request as HttpServletRequest
         log.info { "[JwtAuthenticationFilter][${request.dispatcherType}] uri: ${request.requestURI}" }
 
+        // 인증 헤더에 토큰값 없는 경우 pass
         getAccessToken(httpRequest)?.let {
             jwtTokenUtils.getAuthentication(it)
         }?.also {
+            // 유효한 인증 토큰 존재하는 경우 SecurityContext 토큰값 저장
             SecurityContextHolder.getContext().authentication = it
             log.info { "Valid Access Token [${it.name}]" }
         }
@@ -34,6 +36,10 @@ class JwtAuthenticationFilter(
         chain.doFilter(request, response)
     }
 
+    /**
+     * 인증 토큰 획득
+     * Authorization : Bearer [AUTH_TOKEN]
+     */
     private fun getAccessToken(request: HttpServletRequest): String? {
         val bearer = request.getHeader(HttpHeaders.AUTHORIZATION)
             ?: return null

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

@@ -1,7 +1,6 @@
 package io.beaniejoy.dongnecafe.domain.cafe.repository
 
 import io.beaniejoy.dongnecafe.common.config.AuditingConfig
-import io.beaniejoy.dongnecafe.common.entity.BaseEntityAuditorAware
 import io.beaniejoy.dongnecafe.domain.cafe.entity.Cafe
 import io.beaniejoy.dongnecafe.domain.cafe.utils.CafeTestUtils
 import mu.KLogging
@@ -17,7 +16,6 @@ import org.springframework.data.repository.findByIdOrNull
 @DataJpaTest(
     includeFilters = [
         ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, classes = [AuditingConfig::class]),
-        ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, classes = [BaseEntityAuditorAware::class])
     ]
 )
 internal class CafeRepositoryTest {

script/db_migration.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 
-cd ..
+echo "================ 1. Flyway Info ================"
+./gradlew :db:flywayInfo -Dconfig=$1
 
-./gradlew :db:flywayInfo
+echo "================ 2. Flyway Validate ============"
+./gradlew :db:flywayValidate -Dconfig=$1
 
-./gradlew :db:flywayValidate
+echo "================ 3. Flyway Migrate ============="
+./gradlew :db:flywayMigrate -Dconfig=$1