[#4] Controller 및 테스트 코드 작성 #6

sssukho · 2024-11-19T16:38:01Z

Shop Controller 일부(Shop 등록, Shop 리스트 조회)와 그에 해당하는 테스트 코드 작성하였습니다.

아래와 같이 테스트 해야 할 항목들을 정해서 테스트 코드를 작성해 나갔습니다.

controller 로 들어오는 input 이 원하는 java object 로 잘 serialization 되는지 확인
input validation check 가 잘 동작하는지 확인
controller 에서 나가는 http 응답 본문에 유효한 값들이 포함되어 있는지 확인
exception handler 가 의도한 바와 같이 잘 동작하는지 확인

Shop Controller 뿐만 아니라 다른 테스트 코드들도 계속해서 작성해 나갈 예정입니다.😅

이외에 추가로 궁금한 부분이 있습니다.

차후 가까운 거리별 샵 조회 기능을 위해 샵의 주소나 위치 정보를 가지고 있어야 할 것 같은데, bp-dto 모듈 아래에 있는 ShopRegistrationRequest.Address 의 멤버 변수들이면 충분할까요? => 오픈 API - 주소기반산업지원서비스를 참고해서 일단 필요할 것 같은 데이터들을 구성해보았습니다.)
Test 메서드명은 공식적인 Convention 이 있을까요? 아니면 개인적인 기준을 세워 작성하면 되는걸까요?
주석은 보통 어떻게 작성하시는지 좋은 레퍼런스 추천해주실 수 있으실까요?
멘토님께서는 Java 코드 formatter를 어떤걸 쓰고 계시나요? GoogleStyle formatter 를 쓰고 있는데 개인적으로 안이쁘게 포멧팅이 되는 것 같아서요 😂

f-lab-lyan · 2024-11-20T10:10:56Z

build.gradle

@@ -41,4 +41,8 @@ subprojects {
 	test {
 		useJUnitPlatform()
 	}
+
+	bootJar {


내일 이 얘기를 할 때가 된 것 같군요!! :-)

f-lab-lyan · 2024-11-21T01:20:24Z

api 모둘과 dto 모듈을 나눈 이유에 대해서

f-lab-lyan · 2024-11-24T13:42:13Z

bp-app-api/build.gradle

+
+    implementation 'org.apache.commons:commons-lang3:3.14.0'


요건 뭐 .. 특별히 안된다고 보기는 어렵지만, 스프링에도 비슷한 기능을 하는 클래스들이 있지 않을까요? ㅎㅎ

spring-core 에도 비슷한 역할을 클래스가 있기는 한데, apache의 라이브러리를 계속 사용해왔던지라 사용하게 되었습니다.

혹시 관련해서 비추천 하는 이유가 있으실까요?

sssukho · 2024-11-24T17:43:32Z

7주차 리뷰에서 말씀해주신 내용은 크게 다음과 같습니다.

모듈 구성에 명확한 의도가 드러나지 않는다.
컨트롤러 테스트 코드에서 어떤 점을 테스트하려고 했는지 불분명하다.

관련해서 다음과 같은 방향으로 수정했습니다.

1. 모듈 구성에 명확한 의도가 드러나지 않는다.

각 모듈에 대한 목적은 다음과 같습니다.

bp-app-api: 하위 모듈들(bp-domain-rdb, bp-kafka-xxx, bp-utils)을 조립하여 api 서버 역할
bp-app-batch: 배치 작업이나 스케줄러 등을 실행하는 배치 서버 역할
bp-domain-rdb: 모든 도메인들의 entity가 위치하고, db와 통신만 담당
bp-kafka-event-consumer, bp-kafka-event-publisher: 카프카 publisher, consumer 역할
bp-utils: util 성 로직 처리 역할

삭제한 모듈의 목적과 그 이유는 다음과 같습니다.

bp-dto: dto 클래스들만 모여있는 모듈이었으나 기본 4개 도메인에 대한 dto(샵, 예약, 회원, 리뷰) + 차후 추가될 dto 들이 몇 가지가 있어 초기 단계에서 불필요하게 크게 나눌 필요가 없다고 생각하여 삭제하였습니다.
bp-core-web: 초기 웹 설정 등을 담당할 목적으로 두었으나 아직 그렇게까지 프로젝트 사이즈가 크지 않아 삭제하였습니다.

2. 컨트롤러 테스트 코드에서 어떤 점을 테스트하려고 했는지 불분명하다.

최초 테스트 코드 작성시 input 과 output 에 대한 테스트 즉, API 스펙에 따른 요청/응답 메시지의 형태가 정확히 구현이 되었는지에 대한 테스트를 하는 코드를 작성했으나 의도가 불분명해진 것 같습니다.

따라서 다음 클래스들을 통해서 그 의도를 명확하고자 하였으며, 그 외 테스트 코드들은 부가적인(주로 validation) 테스트를 진행한 코드라고 보시면 될 것 같습니다.

ShopIntegrationTest: Shop 관련 API 들에 대한 통합 테스트들이 위치해있으며, 추후 구현해야 할 API 들도 추가할 예정입니다.
ReviewIntegrationTest: Review 관련 API 들에 대한 통합 테스트들이 위치해있으며, 추후 구현해야 할 API 들도 추가할 예정입니다.

f-lab-lyan · 2024-11-26T12:57:05Z

bp-app-api/src/main/java/com/beautify_project/bp_app_api/exception/GlobalExceptionHandler.java


-        ErrorResponseMessage errorResponseMessage = createErrorResponseMessage(
-            MSG_FORMAT_PARAMETER_INVALID, exception.getParameterName(), ErrorCode.BR001);
+        log.error("", exception);


메세지에 뭘 넣을 수 있을지에 대해서도 추후에 고민해보시면 좋을 것 같네요.

기본적인 메시지는 ErrorCode 라는 enum 에 정의를 해두었습니다만, 말씀주신대로 어떤걸 더 넣을 수 있을지는 추후에 고민해보도록 하겠습니다!

f-lab-lyan · 2024-11-27T02:06:05Z

bp-app-api/src/test/java/com/beautify_project/bp_app_api/fixtures/CommonTestFixture.java

+
+public class CommonTestFixture {
+
+    public static ObjectMapper OBJECT_MAPPER = new ObjectMapper().registerModule(new JavaTimeModule());


이건 JavaTimeModule 때문에 넣으신건가요? 그렇다면, 이건 Test범위에서만 필요한 것인가요? 아니면, 모든 비지니스에서 필요한건아닌가요?

모든 비즈니스에서 필요할 것 같긴한데, 아직 실제로 사용되지는 않아서 테스트 코드에서만 사용할 수 있도록 위와 같이 작성하였습니다. 추후 비즈니스에서 실제로 사용할 때 테스트 코드도 비즈니스에서 사용하는 object mapper bean 으로 가져오도록 수정할 예정입니다. 😎

f-lab-lyan · 2024-11-27T02:06:32Z

bp-app-api/src/test/java/com/beautify_project/bp_app_api/integration/ShopIntegrationTest.java

+
+@SpringBootTest
+@AutoConfigureMockMvc
+@Tag("integration-test")


이 Tag는 나중에 어떤 역할을 하게 되나요? (아직 전부다 보지 않아서 ㅜㅠ)

빌드시 통합 테스트는 테스트에서 제외하기 위해 Tag를 사용하였습니다.
현재도 bp-app-api 모듈의 build.gradle 에 적용해 두었습니다!

f-lab-lyan · 2024-11-27T02:08:28Z

bp-app-api/src/main/java/com/beautify_project/bp_app_api/controller/ReviewController.java

+        @RequestParam(name = "sort", required = false, defaultValue = "registeredDate") final String sort,
+        @RequestParam(name = "page", required = false, defaultValue = "0") final int page,
+        @RequestParam(name = "count", required = false, defaultValue = "10") final int count,
+        @RequestParam(name = "order", required = false, defaultValue = "asc") final String order)


asc, desc 말고, lastest, oldest 같은 것들이 좀 더 의미를 잘 전달하지 않을까요?

항상 registeredDate(등록일자) 기준으로 정렬하는건 아닙니다. rate(평점) 순으로 정렬할 수도 있고, 추후에 정렬이 될 수 있는 기준이 추가될 수 있기 때문에 asc, desc 를 사용하였습니다.

f-lab-lyan · 2024-11-27T02:09:00Z

...rc/main/java/com/beautify_project/bp_app_api/dto/review/FindReviewListRequestParameters.java

+    }
+
+    private void validateCount(Integer count) {
+        if (count > 100 || count < 0) {


만약에 validation로직이 복잡해 진다면?

f-lab-lyan · 2024-11-27T02:17:27Z

bp-app-api/src/test/java/com/beautify_project/bp_app_api/controller/ReviewControllerTest.java

+    @Autowired
+    private MockMvc mockMvc;
+
+    @MockBean


ReviewService를 구현했는데, 굳이 Mocking할 필요가 있을까요?

맞습니다. 이 부분은 다음 PR 떄 수정하도록 하겠습니다. 🙏

f-lab-lyan

몇 가지 이야기거리들이 있지만, 대체로 좋은 것 같습니다! :-) 고생하셨습니다.

sssukho added 6 commits November 19, 2024 02:58

feat: 샵 등록 컨트롤러 추가

a96e668

test: 샵 등록 컨트롤러 테스트 코드 추가

f3d0722

fix: 누락사항 반영 및 불필요 파일 삭제

bccdae6

feat: Shop 리스트 조회 컨트롤러 추가

e6789eb

test: Shop 리스트 조회 테스트 코드 추가

999f389

test: ShopList 조회 실패 테스트에서 데이터 타입이 맞지 않는 케이스 추가

b42f273

sssukho added the enhancement New feature or request label Nov 19, 2024

sssukho requested a review from f-lab-lyan November 19, 2024 16:38

sssukho self-assigned this Nov 19, 2024

sssukho linked an issue Nov 19, 2024 that may be closed by this pull request

Controller 코드 작성 및 테스트 코드 작성 #4

Closed

f-lab-lyan reviewed Nov 20, 2024

View reviewed changes

feat: bp-dto 모듈에 java-test-fixtures 플러그인 적용

c59e8fb

sssukho added 3 commits November 21, 2024 17:20

refactor: 하위 모듈에서 gradle 관련 설정 중복되지 않도록 수정

cf0f57f

refactor: 목적이 명확하도록 테스트 코드 변경 및 Controller 에서의 return type 변경

d7a13d3

refactor: 불필요 모듈(bp-dto, bp-core-web) 제거 및 통합

31a5a06

f-lab-lyan reviewed Nov 24, 2024

View reviewed changes

sssukho added 4 commits November 25, 2024 00:49

feat: shop 등록 API, shop 리스트 조회 API 통합 테스트 추가

9cc2054

commit#9cc2054 누락사항 반영

c6f027a

test: review controller 통합테스트 추가

7c2329e

chore: 빌드시 통합테스트는 제외 및 테스트 결과들이 콘솔에 출력되게끔 로깅 처리

39173fa

f-lab-lyan reviewed Nov 26, 2024

View reviewed changes

f-lab-lyan reviewed Nov 27, 2024

View reviewed changes

f-lab-lyan approved these changes Nov 27, 2024

View reviewed changes

sssukho merged commit adb5b83 into main Nov 27, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[#4] Controller 및 테스트 코드 작성 #6

[#4] Controller 및 테스트 코드 작성 #6

sssukho commented Nov 19, 2024 •

edited

Loading

f-lab-lyan Nov 20, 2024

f-lab-lyan commented Nov 21, 2024 •

edited

Loading

f-lab-lyan Nov 24, 2024

sssukho Nov 24, 2024

sssukho commented Nov 24, 2024 •

edited

Loading

f-lab-lyan Nov 26, 2024

sssukho Nov 26, 2024

f-lab-lyan Nov 27, 2024

sssukho Nov 27, 2024

f-lab-lyan Nov 27, 2024

sssukho Nov 27, 2024

f-lab-lyan Nov 27, 2024

sssukho Nov 27, 2024

f-lab-lyan Nov 27, 2024

f-lab-lyan Nov 27, 2024

sssukho Nov 27, 2024

f-lab-lyan left a comment


		public class CommonTestFixture {

		public static ObjectMapper OBJECT_MAPPER = new ObjectMapper().registerModule(new JavaTimeModule());

[#4] Controller 및 테스트 코드 작성 #6

[#4] Controller 및 테스트 코드 작성 #6

Conversation

sssukho commented Nov 19, 2024 • edited Loading

Choose a reason for hiding this comment

f-lab-lyan commented Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sssukho commented Nov 24, 2024 • edited Loading

1. 모듈 구성에 명확한 의도가 드러나지 않는다.

2. 컨트롤러 테스트 코드에서 어떤 점을 테스트하려고 했는지 불분명하다.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

f-lab-lyan left a comment

Choose a reason for hiding this comment

sssukho commented Nov 19, 2024 •

edited

Loading

f-lab-lyan commented Nov 21, 2024 •

edited

Loading

sssukho commented Nov 24, 2024 •

edited

Loading