Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions src/docs/asciidoc/_product_image.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
== ์ƒํ’ˆ ์ด๋ฏธ์ง€ (Product Image) API

=== 1. ์ƒํ’ˆ ์ด๋ฏธ์ง€ ์—…๋กœ๋“œ
`POST /products/{productId}/images`

์š”์ฒญ ๊ฒฝ๋กœ ํŒŒ๋ผ๋ฏธํ„ฐ:
include::{snippets}/product-image-upload/path-parameters.adoc[]

์š”์ฒญ ๋ณธ๋ฌธ (Multipart):
include::{snippets}/product-image-upload/request-parts.adoc[]

์‘๋‹ต:
include::{snippets}/product-image-upload/http-response.adoc[]


=== 2. ์ƒํ’ˆ ์ด๋ฏธ์ง€ ์กฐํšŒ
`GET /products/{productId}/images`

์š”์ฒญ ๊ฒฝ๋กœ ํŒŒ๋ผ๋ฏธํ„ฐ:
include::{snippets}/product-image-list-get/path-parameters.adoc[]

์‘๋‹ต ๋ณธ๋ฌธ:
include::{snippets}/product-image-list-get/response-fields.adoc[]

์‘๋‹ต:
include::{snippets}/product-image-list-get/http-response.adoc[]


=== 3. ๋Œ€ํ‘œ ์ด๋ฏธ์ง€ ๋ณ€๊ฒฝ
`PATCH /products/{productId}/images/{imageId}/default`

์š”์ฒญ ๊ฒฝ๋กœ ํŒŒ๋ผ๋ฏธํ„ฐ:
include::{snippets}/product-image-change-default/path-parameters.adoc[]

์‘๋‹ต:
include::{snippets}/product-image-change-default/http-response.adoc[]


=== 4. ์ƒํ’ˆ ์ด๋ฏธ์ง€ ์‚ญ์ œ
`DELETE /products/{productId}/images/{imageId}`

์š”์ฒญ ๊ฒฝ๋กœ ํŒŒ๋ผ๋ฏธํ„ฐ:
include::{snippets}/product-image-delete/path-parameters.adoc[]

์‘๋‹ต:
include::{snippets}/product-image-delete/http-response.adoc[]
1 change: 1 addition & 0 deletions src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@ include::_discount.adoc[]

include::_deliverypolicy.adoc[]
// include::_product.adoc[]
include::_product_image.adoc[]

Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
package com.irum.come2us.domain.product;

import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.doNothing;
import static org.mockito.Mockito.when;
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
import static org.springframework.restdocs.payload.PayloadDocumentation.*;
import static org.springframework.restdocs.request.RequestDocumentation.*;
import static org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors.csrf;
import static org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors.user;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.irum.come2us.domain.product.application.service.ProductImageService;
import com.irum.come2us.domain.product.presentation.controller.ProductImageController;
import com.irum.come2us.domain.product.presentation.dto.response.ProductImageResponse;
import com.irum.come2us.global.config.SecurityTestConfig;
import com.irum.come2us.global.config.TestConfig;
import java.util.List;
import java.util.UUID;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.restdocs.AutoConfigureRestDocs;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.context.annotation.Import;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.mock.web.MockMultipartFile;
import org.springframework.test.web.servlet.MockMvc;

@WebMvcTest(ProductImageController.class)
@AutoConfigureRestDocs
@Import({SecurityTestConfig.class, TestConfig.class})
public class ProductImageControllerTest {

@Autowired private MockMvc mockMvc;
@Autowired private ProductImageService productImageService;
@Autowired private ObjectMapper objectMapper;

private final UUID mockProductId = UUID.randomUUID();
private final UUID mockImageId = UUID.randomUUID();

@Test
@DisplayName("์ƒํ’ˆ ์ด๋ฏธ์ง€ ์—…๋กœ๋“œ API (์‚ฌ์žฅ๋‹˜ ๊ถŒํ•œ)")
void uploadProductImagesApiTest() throws Exception {
MockMultipartFile file =
new MockMultipartFile(
"images", "test.jpg", MediaType.IMAGE_JPEG_VALUE, "dummy".getBytes());

doNothing().when(productImageService).uploadProductImages(eq(mockProductId), any());

mockMvc.perform(
multipart("/products/{productId}/images", mockProductId)
.file(file)
.with(csrf())
.with(user("100").roles("OWNER")))
.andExpect(status().isCreated())
.andExpect(jsonPath("$.success").value(true))
.andExpect(jsonPath("$.status").value(HttpStatus.CREATED.value()))
.andDo(
document(
"product-image-upload",
pathParameters(parameterWithName("productId").description("์ƒํ’ˆ ID")),
requestParts(
partWithName("images").description("์—…๋กœ๋“œํ•  ์ƒํ’ˆ ์ด๋ฏธ์ง€ ํŒŒ์ผ๋“ค"))));
}

@Test
@DisplayName("๋Œ€ํ‘œ ์ด๋ฏธ์ง€ ๋ณ€๊ฒฝ API (์‚ฌ์žฅ๋‹˜ ๊ถŒํ•œ)")
void changeDefaultImageApiTest() throws Exception {
doNothing()
.when(productImageService)
.changeDefaultImage(eq(mockProductId), eq(mockImageId));

mockMvc.perform(
patch(
"/products/{productId}/images/{imageId}/default",
mockProductId,
mockImageId)
.with(csrf())
.with(user("100").roles("OWNER")))
.andExpect(status().isNoContent())
.andExpect(jsonPath("$.success").value(true))
.andExpect(jsonPath("$.status").value(HttpStatus.NO_CONTENT.value()))
.andDo(
document(
"product-image-change-default",
pathParameters(
parameterWithName("productId").description("์ƒํ’ˆ ID"),
parameterWithName("imageId")
.description("๋Œ€ํ‘œ๋กœ ๋ณ€๊ฒฝํ•  ์ด๋ฏธ์ง€ ID"))));
}

@Test
@DisplayName("์ƒํ’ˆ ์ด๋ฏธ์ง€ ์‚ญ์ œ API (์‚ฌ์žฅ๋‹˜ ๊ถŒํ•œ)")
void deleteProductImageApiTest() throws Exception {
doNothing()
.when(productImageService)
.deleteProductImage(eq(mockProductId), eq(mockImageId));

mockMvc.perform(
delete("/products/{productId}/images/{imageId}", mockProductId, mockImageId)
.with(csrf())
.with(user("100").roles("OWNER")))
.andExpect(status().isNoContent())
.andExpect(jsonPath("$.success").value(true))
.andExpect(jsonPath("$.status").value(HttpStatus.NO_CONTENT.value()))
.andDo(
document(
"product-image-delete",
pathParameters(
parameterWithName("productId").description("์ƒํ’ˆ ID"),
parameterWithName("imageId").description("์‚ญ์ œํ•  ์ด๋ฏธ์ง€ ID"))));
}

@Test
@DisplayName("์ƒํ’ˆ ์ด๋ฏธ์ง€ ๋ชฉ๋ก ์กฐํšŒ API")
void getProductImagesApiTest() throws Exception {
List<ProductImageResponse> responseList =
List.of(
new ProductImageResponse(
mockImageId, "https://cdn.example.com/img.jpg", true));

when(productImageService.getProductImages(eq(mockProductId))).thenReturn(responseList);

mockMvc.perform(
get("/products/{productId}/images", mockProductId)
.with(csrf())
.with(user("1").roles("CUSTOMER")))
.andExpect(status().isOk())
.andExpect(jsonPath("$.success").value(true))
.andExpect(jsonPath("$.data[0].id").value(mockImageId.toString()))
.andExpect(jsonPath("$.data[0].isDefault").value(true))
.andDo(
document(
"product-image-list-get",
pathParameters(parameterWithName("productId").description("์ƒํ’ˆ ID")),
responseFields(
fieldWithPath("success").description("์š”์ฒญ ์„ฑ๊ณต ์—ฌ๋ถ€"),
fieldWithPath("status").description("HTTP ์ƒํƒœ ์ฝ”๋“œ"),
fieldWithPath("data[].id").description("์ƒํ’ˆ ์ด๋ฏธ์ง€ ์‹๋ณ„ ID"),
fieldWithPath("data[].imageUrl").description("์ด๋ฏธ์ง€ URL"),
fieldWithPath("data[].isDefault").description("๋Œ€ํ‘œ ์ด๋ฏธ์ง€ ์—ฌ๋ถ€"),
fieldWithPath("timestamp").description("์‘๋‹ต ์‹œ๊ฐ„"))));
}
}
6 changes: 6 additions & 0 deletions src/test/java/com/irum/come2us/global/config/TestConfig.java
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import com.irum.come2us.domain.discount.application.service.DiscountService;
import com.irum.come2us.domain.member.application.service.ManagerService;
import com.irum.come2us.domain.member.application.service.MemberService;
import com.irum.come2us.domain.product.application.service.ProductImageService;
import com.irum.come2us.domain.refund.application.service.RefundService;
import com.irum.come2us.global.util.CookieUtil;
import org.mockito.Mockito;
Expand Down Expand Up @@ -53,4 +54,9 @@ public RefundService refundService() {
public DiscountService discountService() {
return Mockito.mock(DiscountService.class);
}

@Bean
public ProductImageService productImageService() {
return Mockito.mock(ProductImageService.class);
}
}