Merge pull request #58 from le2sky/develop

[배포] v0.3.0(PR#55, PR#57)

codecov.yml

@@ -7,10 +7,7 @@ comment:
 
 coverage:
     status:
-        patch:
-            default:
-                target: auto
-                threshold: 0.1%
+        patch: off
         project:
             default:
                 target: auto

gradle.properties

@@ -6,7 +6,7 @@ ktlintVersion=11.0.0
 springBootVersion=2.7.11
 springDependencyManagementVersion=1.0.15.RELEASE
 # project
-applicationVersion=0.2.0
+applicationVersion=0.3.0
 projectGroup=com.mealkitary
 # test
 kotestVersion=4.4.3

mealkitary-api/src/docs/asciidoc/reservation.adoc

@@ -26,6 +26,20 @@ include::{snippets}/reservation-post/http-response.adoc[]
 
 include::{snippets}/reservation-post/response-headers.adoc[]
 
+==== 예약 상세 조회
+
+예약에 대한 상세 정보를 조회합니다.
+
+===== 요청
+
+include::{snippets}/reservation-get/curl-request.adoc[]
+include::{snippets}/reservation-get/http-request.adoc[]
+include::{snippets}/reservation-get/path-parameters.adoc[]
+
+===== 응답
+
+include::{snippets}/reservation-get/http-response.adoc[]
+
 ==== 예약 결제
 
 미결제 상태의 예약에 대해 결제를 생성/승인합니다.
@@ -52,7 +66,8 @@ include::{snippets}/reservation-post-pay/response-headers.adoc[]
 
 ==== 예약 승인
 
-결제된 예약에 대해서 예약 승인 처리합니다. 결제된 예약이 아닌 경우, 승인 처리할 수 없습니다.
+결제된 예약에 대해서 예약 승인 처리합니다.
+결제된 예약이 아닌 경우, 승인 처리할 수 없습니다.
 
 ===== 요청
 

mealkitary-api/src/main/kotlin/com/mealkitary/common/config/WebConfig.kt

@@ -1,6 +1,7 @@
 package com.mealkitary.common.config
 
 import org.springframework.context.annotation.Configuration
+import org.springframework.http.HttpHeaders
 import org.springframework.web.servlet.config.annotation.CorsRegistry
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer
 
@@ -10,5 +11,6 @@ class WebConfig : WebMvcConfigurer {
     override fun addCorsMappings(registry: CorsRegistry) {
         registry.addMapping("/**")
             .allowedOrigins("*")
+            .exposedHeaders(HttpHeaders.LOCATION)
     }
 }

mealkitary-api/src/main/kotlin/com/mealkitary/reservation/adapter/input/web/GetReservationController.kt

@@ -0,0 +1,19 @@
+package com.mealkitary.reservation.adapter.input.web
+
+import com.mealkitary.common.utils.UUIDUtils
+import com.mealkitary.reservation.application.port.input.GetReservationQuery
+import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.PathVariable
+import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RestController
+
+@RestController
+@RequestMapping("/reservations")
+class GetReservationController(
+    private val getReservationQuery: GetReservationQuery
+) {
+
+    @GetMapping("/{reservationId}")
+    fun getOneReservation(@PathVariable("reservationId") reservationId: String) =
+        getReservationQuery.loadOneReservationById(UUIDUtils.fromString(reservationId))
+}

mealkitary-api/src/test/kotlin/com/docs/reservation/GetReservationControllerDocsTest.kt

@@ -0,0 +1,88 @@
+package com.docs.reservation
+
+import com.docs.RestDocsSupport
+import com.mealkitary.reservation.adapter.input.web.GetReservationController
+import com.mealkitary.reservation.application.port.input.GetReservationQuery
+import com.mealkitary.reservation.application.port.input.ReservationResponse
+import com.mealkitary.reservation.application.port.input.ReservedProduct
+import io.mockk.every
+import io.mockk.mockk
+import org.springframework.http.MediaType
+import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document
+import org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
+import org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessRequest
+import org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessResponse
+import org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint
+import org.springframework.restdocs.payload.JsonFieldType
+import org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath
+import org.springframework.restdocs.payload.PayloadDocumentation.responseFields
+import org.springframework.restdocs.request.RequestDocumentation.parameterWithName
+import org.springframework.restdocs.request.RequestDocumentation.pathParameters
+import org.springframework.test.web.servlet.result.MockMvcResultMatchers.content
+import org.springframework.test.web.servlet.result.MockMvcResultMatchers.status
+import java.time.LocalDateTime
+import java.util.UUID
+
+class GetReservationControllerDocsTest : RestDocsSupport() {
+
+    private val getReservationQuery = mockk<GetReservationQuery>()
+
+    @Test
+    fun `api docs test - getOneReservation`() {
+        val reservationId = UUID.randomUUID()
+        val reserveAt = LocalDateTime.now()
+        every { getReservationQuery.loadOneReservationById(reservationId) } answers {
+            ReservationResponse(
+                reservationId,
+                "집밥뚝딱 안양점",
+                "부대찌개 외 1건",
+                reserveAt,
+                "PAID",
+                listOf(
+                    ReservedProduct(
+                        1L,
+                        "부대찌개",
+                        20000,
+                        2
+                    ),
+                    ReservedProduct(
+                        2L,
+                        "김치찌개",
+                        20000,
+                        1
+                    )
+                )
+            )
+        }
+
+        mvc.perform(RestDocumentationRequestBuilders.get("/reservations/{reservationId}", reservationId))
+            .andExpect(status().isOk())
+            .andExpect(content().contentType(MediaType.APPLICATION_JSON))
+            .andDo(
+                document(
+                    "reservation-get",
+                    preprocessRequest(prettyPrint()),
+                    preprocessResponse(prettyPrint()),
+                    pathParameters(
+                        parameterWithName("reservationId").description("조회 대상 예약의 식별자")
+                    ),
+                    responseFields(
+                        fieldWithPath("reservationId").type(JsonFieldType.STRING).description("예약 식별자"),
+                        fieldWithPath("shopName").type(JsonFieldType.STRING).description("예약 대상 가게의 이름"),
+                        fieldWithPath("description").type(JsonFieldType.STRING).description("예약 개요"),
+                        fieldWithPath("reserveAt").type(JsonFieldType.STRING).description("예약 시간(yyyy-mm-ddThh:mm:ss)"),
+                        fieldWithPath("status").type(JsonFieldType.STRING).description("예약 상태"),
+                        fieldWithPath("reservedProduct.[].productId").type(JsonFieldType.NUMBER)
+                            .description("예약 상품 식별자"),
+                        fieldWithPath("reservedProduct.[].name").type(JsonFieldType.STRING)
+                            .description("예약 상품명"),
+                        fieldWithPath("reservedProduct.[].price").type(JsonFieldType.NUMBER)
+                            .description("예약 상품 가격"),
+                        fieldWithPath("reservedProduct.[].count").type(JsonFieldType.NUMBER).description("예약 수량")
+                    )
+                )
+            )
+    }
+
+    override fun initController() = GetReservationController(getReservationQuery)
+}

mealkitary-api/src/test/kotlin/com/mealkitary/WebIntegrationTestSupport.kt

@@ -2,9 +2,11 @@ package com.mealkitary
 
 import com.fasterxml.jackson.databind.ObjectMapper
 import com.mealkitary.reservation.adapter.input.web.AcceptReservationController
+import com.mealkitary.reservation.adapter.input.web.GetReservationController
 import com.mealkitary.reservation.adapter.input.web.PayReservationController
 import com.mealkitary.reservation.adapter.input.web.ReserveProductController
 import com.mealkitary.reservation.application.port.input.AcceptReservationUseCase
+import com.mealkitary.reservation.application.port.input.GetReservationQuery
 import com.mealkitary.reservation.application.port.input.PayReservationUseCase
 import com.mealkitary.reservation.application.port.input.ReserveProductUseCase
 import com.mealkitary.shop.adapter.input.web.GetProductController
@@ -25,6 +27,7 @@ import org.springframework.test.web.servlet.MockMvc
         ReserveProductController::class,
         PayReservationController::class,
         AcceptReservationController::class,
+        GetReservationController::class,
         GetShopController::class,
         GetReservableTimeController::class,
         GetProductController::class
@@ -49,6 +52,9 @@ abstract class WebIntegrationTestSupport : AnnotationSpec() {
     @MockkBean
     protected lateinit var acceptReservationUseCase: AcceptReservationUseCase
 
+    @MockkBean
+    protected lateinit var getReservationQuery: GetReservationQuery
+
     @MockkBean
     protected lateinit var getShopQuery: GetShopQuery
 

mealkitary-api/src/test/kotlin/com/mealkitary/reservation/adapter/input/web/GetReservationControllerTest.kt

@@ -0,0 +1,84 @@
+package com.mealkitary.reservation.adapter.input.web
+
+import com.mealkitary.WebIntegrationTestSupport
+import com.mealkitary.common.exception.EntityNotFoundException
+import com.mealkitary.reservation.application.port.input.ReservationResponse
+import com.mealkitary.reservation.application.port.input.ReservedProduct
+import io.mockk.every
+import org.springframework.http.MediaType
+import org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get
+import org.springframework.test.web.servlet.result.MockMvcResultMatchers.content
+import org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath
+import org.springframework.test.web.servlet.result.MockMvcResultMatchers.status
+import java.time.LocalDateTime
+import java.util.UUID
+
+class GetReservationControllerTest : WebIntegrationTestSupport() {
+
+    @Test
+    fun `api integration test - getOneReservation`() {
+        val reservationId = UUID.randomUUID()
+        val reserveAt = LocalDateTime.now()
+        every { getReservationQuery.loadOneReservationById(reservationId) } answers {
+            ReservationResponse(
+                reservationId,
+                "집밥뚝딱 안양점",
+                "부대찌개 외 1건",
+                reserveAt,
+                "PAID",
+                listOf(
+                    ReservedProduct(
+                        1L,
+                        "부대찌개",
+                        20000,
+                        2
+                    ),
+                    ReservedProduct(
+                        2L,
+                        "김치찌개",
+                        20000,
+                        1
+                    )
+                )
+            )
+        }
+
+        mvc.perform(get("/reservations/{reservationId}", reservationId))
+            .andExpect(status().isOk())
+            .andExpect(content().contentType(MediaType.APPLICATION_JSON))
+            .andExpect(jsonPath("$.reservationId").value(reservationId.toString()))
+            .andExpect(jsonPath("$.shopName").value("집밥뚝딱 안양점"))
+            .andExpect(jsonPath("$.reserveAt").value(reserveAt.toString()))
+            .andExpect(jsonPath("$.status").value("PAID"))
+            .andExpect(jsonPath("$.reservedProduct[0].productId").value(1L))
+            .andExpect(jsonPath("$.reservedProduct[0].name").value("부대찌개"))
+            .andExpect(jsonPath("$.reservedProduct[0].price").value(20000))
+            .andExpect(jsonPath("$.reservedProduct[0].count").value(2))
+            .andExpect(jsonPath("$.reservedProduct[1].productId").value(2L))
+            .andExpect(jsonPath("$.reservedProduct[1].name").value("김치찌개"))
+            .andExpect(jsonPath("$.reservedProduct[1].price").value(20000))
+            .andExpect(jsonPath("$.reservedProduct[1].count").value(1))
+    }
+
+    @Test
+    fun `api integration test - 예약 식별자가 UUID 형태가 아니라면 400 에러를 발생한다`() {
+        mvc.perform(
+            get("/reservations/{reservationId}", "invalid-uuid-test")
+        )
+            .andExpect(status().isBadRequest)
+            .andExpect(jsonPath("$.status").value("400"))
+            .andExpect(jsonPath("$.message").value("잘못된 UUID 형식입니다."))
+    }
+
+    @Test
+    fun `api integration test - 내부에서 EntityNotFound 에러가 발생하면 404 에러를 발생한다`() {
+        every { getReservationQuery.loadOneReservationById(any()) }
+            .throws(EntityNotFoundException("존재하지 않는 예약입니다."))
+
+        mvc.perform(get("/reservations/{reservationId}", UUID.randomUUID()))
+            .andExpect(status().isNotFound())
+            .andExpect(content().contentType(MediaType.APPLICATION_JSON))
+            .andExpect(jsonPath("$.status").value(404))
+            .andExpect(jsonPath("$.message").value("존재하지 않는 예약입니다."))
+    }
+}

mealkitary-application/src/main/kotlin/com/mealkitary/reservation/application/port/input/GetReservationQuery.kt

@@ -0,0 +1,8 @@
+package com.mealkitary.reservation.application.port.input
+
+import java.util.UUID
+
+interface GetReservationQuery {
+
+    fun loadOneReservationById(reservationId: UUID): ReservationResponse
+}

mealkitary-application/src/main/kotlin/com/mealkitary/reservation/application/port/input/ReservationResponse.kt

@@ -0,0 +1,13 @@
+package com.mealkitary.reservation.application.port.input
+
+import java.time.LocalDateTime
+import java.util.UUID
+
+data class ReservationResponse(
+    val reservationId: UUID,
+    val shopName: String,
+    val description: String,
+    val reserveAt: LocalDateTime,
+    val status: String,
+    val reservedProduct: List<ReservedProduct>
+)

mealkitary-application/src/main/kotlin/com/mealkitary/reservation/application/port/output/LoadReservationPort.kt

@@ -1,9 +1,12 @@
 package com.mealkitary.reservation.application.port.output
 
+import com.mealkitary.reservation.application.port.input.ReservationResponse
 import com.mealkitary.reservation.domain.reservation.Reservation
 import java.util.UUID
 
 interface LoadReservationPort {
 
     fun loadOneReservationById(reservationId: UUID): Reservation
+
+    fun queryOneReservationById(reservationId: UUID): ReservationResponse
 }

mealkitary-application/src/main/kotlin/com/mealkitary/reservation/application/service/GetReservationService.kt

@@ -0,0 +1,17 @@
+package com.mealkitary.reservation.application.service
+
+import com.mealkitary.reservation.application.port.input.GetReservationQuery
+import com.mealkitary.reservation.application.port.output.LoadReservationPort
+import org.springframework.stereotype.Service
+import org.springframework.transaction.annotation.Transactional
+import java.util.UUID
+
+@Service
+@Transactional(readOnly = true)
+class GetReservationService(
+    private val loadReservationPort: LoadReservationPort
+) : GetReservationQuery {
+
+    override fun loadOneReservationById(reservationId: UUID) =
+        loadReservationPort.queryOneReservationById(reservationId)
+}

mealkitary-application/src/test/kotlin/com/mealkitary/reservation/application/service/GetReservationServiceTest.kt

@@ -0,0 +1,39 @@
+package com.mealkitary.reservation.application.service
+
+import com.mealkitary.reservation.application.port.input.ReservationResponse
+import com.mealkitary.reservation.application.port.output.LoadReservationPort
+import io.kotest.core.spec.style.AnnotationSpec
+import io.kotest.matchers.booleans.shouldBeTrue
+import io.kotest.matchers.shouldBe
+import io.mockk.every
+import io.mockk.mockk
+import java.time.LocalDateTime
+import java.util.UUID
+
+class GetReservationServiceTest : AnnotationSpec() {
+
+    private val loadReservationPort = mockk<LoadReservationPort>()
+    private val getReservationService = GetReservationService(loadReservationPort)
+
+    @Test
+    fun `service unit test - 예약의 상세 정보를 조회한다`() {
+        val reservationId = UUID.randomUUID()
+        every { loadReservationPort.queryOneReservationById(any()) } answers {
+            ReservationResponse(
+                reservationId,
+                "집밥뚝딱 안양점",
+                "부대찌개 외 1건",
+                LocalDateTime.now(),
+                "PAID",
+                emptyList()
+            )
+        }
+
+        val result = getReservationService.loadOneReservationById(reservationId)
+
+        result.reservationId shouldBe reservationId
+        result.shopName shouldBe "집밥뚝딱 안양점"
+        result.status shouldBe "PAID"
+        result.reservedProduct.isEmpty().shouldBeTrue()
+    }
+}