merge: (#78) 이메일 인증 정책 설계

build.gradle.kts

@@ -24,6 +24,7 @@ subprojects {
 
         // test
         implementation(Dependencies.SPRING_TEST)
+        testImplementation(Dependencies.MOCKITO_KOTLIN)
     }
 }
 

buildSrc/src/main/kotlin/Dependencies.kt

@@ -46,6 +46,7 @@ object Dependencies {
 
     // test
     const val SPRING_TEST = "org.springframework.boot:spring-boot-starter-test:${PluginVersions.SPRING_BOOT_VERSION}"
+    const val MOCKITO_KOTLIN = "org.mockito.kotlin:mockito-kotlin:${PluginVersions.MOCKITO_KOTLIN_VERSION}"
 
     // s3 test
     const val S3MOCK = "io.findify:s3mock_2.12:${DependencyVersions.S3MOCK}"

buildSrc/src/main/kotlin/PluginVersions.kt

@@ -6,4 +6,5 @@ object PluginVersions {
     const val JPA_PLUGIN_VERSION = "1.6.21"
     const val KAPT_VERSION = "1.7.10"
     const val ALLOPEN_VERSION = "1.6.21"
+    const val MOCKITO_KOTLIN_VERSION = "4.0.0"
 }

simtong-application/src/main/kotlin/team/comit/simtong/domain/auth/spi/AuthCodeLimitPort.kt

@@ -10,4 +10,4 @@ import team.comit.simtong.domain.user.spi.UserQueryAuthCodeLimitPort
  * @date 2022/09/18
  * @version 1.0.0
  **/
-interface AuthCodeLimitPort : UserQueryAuthCodeLimitPort
+interface AuthCodeLimitPort : UserQueryAuthCodeLimitPort, QueryAuthCodeLimitPort, CommandAuthCodeLimitPort

simtong-application/src/main/kotlin/team/comit/simtong/domain/auth/spi/AuthCodePort.kt

@@ -0,0 +1,11 @@
+package team.comit.simtong.domain.auth.spi
+
+/**
+ *
+ * AuthCode에 관한 요청을 하는 AuthCodePort
+ *
+ * @author Chokyunghyeon
+ * @date 2022/09/25
+ * @version 1.0.0
+ **/
+interface AuthCodePort : QueryAuthCodePort, CommandAuthCodePort

simtong-application/src/main/kotlin/team/comit/simtong/domain/auth/spi/CommandAuthCodeLimitPort.kt

@@ -0,0 +1,17 @@
+package team.comit.simtong.domain.auth.spi
+
+import team.comit.simtong.domain.auth.model.AuthCodeLimit
+
+/**
+ *
+ * AuthCodeLimit의 저장을 요청하는 CommandAuthCodeLimitPort
+ *
+ * @author Chokyunghyeon
+ * @date 2022/09/24
+ * @version 1.0.0
+ **/
+interface CommandAuthCodeLimitPort {
+
+    fun save(authCodeLimit: AuthCodeLimit): AuthCodeLimit
+
+}

simtong-application/src/main/kotlin/team/comit/simtong/domain/auth/spi/CommandAuthCodePort.kt

@@ -0,0 +1,17 @@
+package team.comit.simtong.domain.auth.spi
+
+import team.comit.simtong.domain.auth.model.AuthCode
+
+/**
+ *
+ * AuthCode의 저장을 요청하는 CommandAuthCodePort
+ *
+ * @author Chokyunghyeon
+ * @date 2022/09/24
+ * @version 1.0.0
+ **/
+interface CommandAuthCodePort {
+
+    fun save(authCode: AuthCode): AuthCode
+
+}

simtong-application/src/main/kotlin/team/comit/simtong/domain/auth/usecase/CheckAuthCodeUseCase.kt

@@ -0,0 +1,35 @@
+package team.comit.simtong.domain.auth.usecase
+
+import team.comit.simtong.domain.auth.exception.AuthCodeMismatchException
+import team.comit.simtong.domain.auth.model.AuthCodeLimit
+import team.comit.simtong.domain.auth.spi.CommandAuthCodeLimitPort
+import team.comit.simtong.domain.auth.spi.QueryAuthCodePort
+import team.comit.simtong.global.annotation.UseCase
+
+/**
+ *
+ * 이메일 인증 코드 확인을 담당하는 CheckAuthCodeUseCase
+ *
+ * @author Chokyunghyeon
+ * @date 2022/09/24
+ * @version 1.0.0
+ **/
+@UseCase
+class CheckAuthCodeUseCase(
+    private val commandAuthCodeLimitPort: CommandAuthCodeLimitPort,
+    private val queryAuthCodePort: QueryAuthCodePort
+) {
+
+    fun execute(email: String, code: String) {
+        val authCode = queryAuthCodePort.queryAuthCodeByEmail(email)
+
+        if (authCode?.code != code) {
+            throw AuthCodeMismatchException.EXCEPTION
+        }
+
+        commandAuthCodeLimitPort.save(
+            AuthCodeLimit.certified(email)
+        )
+    }
+
+}

simtong-application/src/main/kotlin/team/comit/simtong/domain/auth/usecase/SendAuthCodeUseCase.kt

@@ -0,0 +1,43 @@
+package team.comit.simtong.domain.auth.usecase
+
+import team.comit.simtong.domain.auth.exception.CertifiedEmailException
+import team.comit.simtong.domain.auth.model.AuthCode
+import team.comit.simtong.domain.auth.model.AuthCodeLimit
+import team.comit.simtong.domain.auth.spi.CommandAuthCodeLimitPort
+import team.comit.simtong.domain.auth.spi.CommandAuthCodePort
+import team.comit.simtong.domain.auth.spi.QueryAuthCodeLimitPort
+import team.comit.simtong.domain.auth.spi.SendEmailPort
+import team.comit.simtong.global.annotation.UseCase
+
+/**
+ *
+ * 이메일 인증 코드 전송을 담당하는 SendAuthCodeUseCase
+ *
+ * @author Chokyunghyeon
+ * @date 2022/09/24
+ * @version 1.0.0
+ **/
+@UseCase
+class SendAuthCodeUseCase(
+    private val commandAuthCodeLimitPort: CommandAuthCodeLimitPort,
+    private val commandAuthCodePort: CommandAuthCodePort,
+    private val queryAuthCodeLimitPort: QueryAuthCodeLimitPort,
+    private val sendEmailPort: SendEmailPort
+) {
+
+    fun execute(email: String) {
+        val authCodeLimit = queryAuthCodeLimitPort.queryAuthCodeLimitByEmail(email)
+            ?: AuthCodeLimit(email)
+
+        if(authCodeLimit.isVerified) {
+            throw CertifiedEmailException.EXCEPTION
+        }
+
+        commandAuthCodeLimitPort.save(authCodeLimit.increaseCount())
+
+        val authCode = commandAuthCodePort.save(AuthCode(email))
+
+        sendEmailPort.sendAuthCode(authCode.code, email)
+    }
+
+}

simtong-application/src/test/kotlin/team/comit/simtong/domain/auth/usecase/CheckAuthCodeUseCaseTests.kt

@@ -0,0 +1,91 @@
+package team.comit.simtong.domain.auth.usecase
+
+import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.assertDoesNotThrow
+import org.junit.jupiter.api.assertThrows
+import org.junit.jupiter.api.extension.ExtendWith
+import org.mockito.BDDMockito.given
+import org.springframework.boot.test.mock.mockito.MockBean
+import org.springframework.test.context.junit.jupiter.SpringExtension
+import team.comit.simtong.domain.auth.exception.AuthCodeMismatchException
+import team.comit.simtong.domain.auth.model.AuthCode
+import team.comit.simtong.domain.auth.spi.CommandAuthCodeLimitPort
+import team.comit.simtong.domain.auth.spi.QueryAuthCodePort
+
+@ExtendWith(SpringExtension::class)
+class CheckAuthCodeUseCaseTests {
+
+    @MockBean
+    private lateinit var queryAuthCodePort: QueryAuthCodePort
+
+    @MockBean
+    private lateinit var commandAuthCodeLimitPort: CommandAuthCodeLimitPort
+
+    private lateinit var checkAuthCodeUseCase: CheckAuthCodeUseCase
+
+    private val email = "[email protected]"
+
+    private val code = "123456"
+
+    private val authCodeStub: AuthCode by lazy {
+        AuthCode(
+            key = email,
+            code = code,
+            expirationTime = AuthCode.EXPIRED
+        )
+    }
+
+    private val differentAuthCodeStub by lazy {
+        AuthCode(
+            key = email,
+            code = "654321",
+            expirationTime = AuthCode.EXPIRED
+        )
+    }
+
+    @BeforeEach
+    fun setUp() {
+        checkAuthCodeUseCase = CheckAuthCodeUseCase(
+            commandAuthCodeLimitPort,
+            queryAuthCodePort
+        )
+    }
+
+    @Test
+    fun `이메일 인증 확인 성공`() {
+        // given
+        given(queryAuthCodePort.queryAuthCodeByEmail(email))
+            .willReturn(authCodeStub)
+
+        // when & then
+        assertDoesNotThrow {
+            checkAuthCodeUseCase.execute(email, code)
+        }
+    }
+
+    @Test
+    fun `이메일 인증 코드 찾지 못함`() {
+        // given
+        given(queryAuthCodePort.queryAuthCodeByEmail(email))
+            .willReturn(null)
+
+        // when & then
+        assertThrows<AuthCodeMismatchException> {
+            checkAuthCodeUseCase.execute(email, code)
+        }
+    }
+
+    @Test
+    fun `이메일 인증 코드 불 일치`() {
+        // given
+        given(queryAuthCodePort.queryAuthCodeByEmail(email))
+            .willReturn(differentAuthCodeStub)
+
+        // when & then
+        assertThrows<AuthCodeMismatchException> {
+            checkAuthCodeUseCase.execute(email, code)
+        }
+    }
+
+}

simtong-application/src/test/kotlin/team/comit/simtong/domain/auth/usecase/SendAuthCodeUseCaseTests.kt

@@ -0,0 +1,120 @@
+package team.comit.simtong.domain.auth.usecase
+
+import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.assertDoesNotThrow
+import org.junit.jupiter.api.assertThrows
+import org.junit.jupiter.api.extension.ExtendWith
+import org.mockito.BDDMockito.given
+import org.mockito.BDDMockito.willDoNothing
+import org.mockito.kotlin.any
+import org.springframework.boot.test.mock.mockito.MockBean
+import org.springframework.test.context.junit.jupiter.SpringExtension
+import team.comit.simtong.domain.auth.exception.CertifiedEmailException
+import team.comit.simtong.domain.auth.exception.ExceededSendAuthCodeRequestException
+import team.comit.simtong.domain.auth.model.AuthCode
+import team.comit.simtong.domain.auth.model.AuthCodeLimit
+import team.comit.simtong.domain.auth.spi.CommandAuthCodeLimitPort
+import team.comit.simtong.domain.auth.spi.CommandAuthCodePort
+import team.comit.simtong.domain.auth.spi.QueryAuthCodeLimitPort
+import team.comit.simtong.domain.auth.spi.SendEmailPort
+
+@ExtendWith(SpringExtension::class)
+class SendAuthCodeUseCaseTests {
+
+    @MockBean
+    private lateinit var queryAuthCodeLimitPort: QueryAuthCodeLimitPort
+
+    @MockBean
+    private lateinit var commandAuthCodeLimitPort: CommandAuthCodeLimitPort
+
+    @MockBean
+    private lateinit var commandAuthCodePort: CommandAuthCodePort
+
+    @MockBean
+    private lateinit var sendEmailPort: SendEmailPort
+
+    private lateinit var sendAuthCodeUseCase: SendAuthCodeUseCase
+
+    private val email = "[email protected]"
+
+    private val code = "123456"
+
+    private val verifiedAuthCodeLimitStub by lazy {
+        AuthCodeLimit(
+            key = email,
+            expirationTime = AuthCodeLimit.EXPIRED,
+            attemptCount = 1,
+            isVerified = true
+        )
+    }
+
+    private val exceedAuthCodeLimitStub by lazy {
+        AuthCodeLimit(
+            key = email,
+            expirationTime = AuthCodeLimit.EXPIRED,
+            attemptCount = AuthCodeLimit.MAX_ATTEMPT_COUNT,
+            isVerified = false
+        )
+    }
+
+    private val authCodeStub by lazy {
+        AuthCode(
+            key = email,
+            code = code,
+            expirationTime = AuthCode.EXPIRED
+        )
+    }
+
+    @BeforeEach
+    fun setUp() {
+        sendAuthCodeUseCase = SendAuthCodeUseCase(
+            commandAuthCodeLimitPort,
+            commandAuthCodePort,
+            queryAuthCodeLimitPort,
+            sendEmailPort
+        )
+    }
+
+    @Test
+    fun `이메일 인증 코드 발송`() {
+        // given
+        given(queryAuthCodeLimitPort.queryAuthCodeLimitByEmail(email))
+            .willReturn(null)
+
+        given(commandAuthCodePort.save(any()))
+            .willReturn(authCodeStub)
+
+        willDoNothing().given(sendEmailPort).sendAuthCode(code, email)
+
+        // when & then
+        assertDoesNotThrow {
+            sendAuthCodeUseCase.execute(email)
+        }
+    }
+
+    @Test
+    fun `이미 인증된 이메일`() {
+        // given
+        given(queryAuthCodeLimitPort.queryAuthCodeLimitByEmail(email))
+            .willReturn(verifiedAuthCodeLimitStub)
+
+        // when & then
+        assertThrows<CertifiedEmailException> {
+            sendAuthCodeUseCase.execute(email)
+        }
+    }
+
+    @Test
+    fun `이메일 인증 코드 전송 횟수 초과`() {
+        // given
+        given(queryAuthCodeLimitPort.queryAuthCodeLimitByEmail(email))
+            .willReturn(exceedAuthCodeLimitStub)
+
+        // when & then
+        assertThrows<ExceededSendAuthCodeRequestException> {
+            sendAuthCodeUseCase.execute(email)
+        }
+    }
+
+}

simtong-domain/src/main/kotlin/team/comit/simtong/domain/auth/error/AuthErrorCode.kt

@@ -16,11 +16,16 @@ enum class AuthErrorCode(
 ): ErrorProperty {
 
     // 401
+    AUTHCODE_MISMATCH(401, "인증 코드 불일치"),
     UNCERTIFIED_EMAIL(401, "인증되지 않은 이메일"),
     REFRESH_TOKEN_NOT_FOUND(401, "토큰을 찾을 수 없음"),
 
     // 409
-    ALREADY_USED_EMAIL(409, "이미 사용된 이메일");
+    ALREADY_USED_EMAIL(409, "이미 사용된 이메일"),
+    ALREADY_CERTIFIED_EMAIL(409, "이미 인증된 이메일"),
+
+    // 429
+    EXCEEDED_SEND_AUTHCODE_REQUEST(429, "인증 코드 발송 횟수 초과");
 
     override fun message(): String = message
     override fun status(): Int = status