[4기 - 소재훈] Week2-1 바우처 관리 애플리케이션 테스트 코드 작성(재 PR 작업) by jay-so · Pull Request #775 · prgrms-be-devcourse/springboot-basic

jay-so · 2023-07-08T09:49:27Z

📌 과제 설명

바우처 관리 어플리케이션에서의 단위테스트를 작성하였습니다.
1주차 미션 당시, 고정 할인 바우처(FixedDiscountVoucher), 비율 할인 바우처(PercentDiscountVoucher)의 금액(discount)에 대한 범위 설정이 없어 해당 부분을 추가로 구현한 다음, 테스트를 작성했습니다.

👩‍💻 요구 사항과 구현 내용

바우처 관리 애플리케이션에 단위테스트를 작성해보세요.
가능한 많은 단위 테스트코드를 작성하려고 노력해보세요.

✅ 피드백 반영사항

📁 test/domain 패키지

FixedDiscountVoucherTest

1. 고정할인 바우처 도메인 생성 테스트(createFixedVoucherTest) - 고정 할인 바우처 도메인이 정상적으로 생성되는지 테스트를 한다.
2. 여러 개의 고정 할인 바우처 도메인 생성 확인 테스트(createdFixDiscountVoucherEquals) - 여러 개의 고정 할인 바우처의 도메인이 생성되었을때, 설정한 금액과 맞는지 테스트 한다.

PercentDiscountVoucherTest

1. 퍼센트 할인 바우처 도메인 생성 테스트(createPercentDiscountVoucher) - 퍼센트 할인 바우처 도메인이 정상적으로 생성되는지 테스트를 한다.
2. 여러 개의 퍼센트 할인 바우처 도메인 생성 확인 테스트(createdPercentDiscountVoucherEquals) - 여러 개의 퍼센트 할인 바우처 도메인이 생성되었을땨, 설정한 금액과 맞는지 테스트 한다.

📁 test/view 패키지

ConsoleApplicationTest

1. 바우처 생성 출력 테스트(createVoucherTest) - 바우처가 정상적으로 생성되었을 때, 콘솔 화면에서 정상적으로 출력되는지 테스트 한다.
2. 바우처 목록 출력 테스트(getVoucherListTest) - 생성된 바우처의 목록을 콘솔에 정상적으로 출력되는지 테스트 한다.

📁 test/service 패키지

VoucherServiceTest

1. 고정 할인 바우처 생성 테스트(createFixedDiscountVoucherTest) - 고정 할인 바우처가 정상적으로 생성되는지 테스트를 합니다.
2. 비율 할인 바우처 생성 테스트(createPercentDiscountVoucherTest) - 비율 할인 바우처가 정상적으로 생성되는지 테스트를 합니다.
3. 고정 할인 바우처 생성 시 지정 범위를 넘어설 경우(0이하의 금액이 입력)  예외 발생 테스트(createFixedDiscountVoucherWithInvalidDiscountTest) - 입력된 discount가 0이하일 때, 정상적으로 오류 메시지가 출력되는지 테스트 합니다.
4. 비율 할인 바우처 생성 시 지정 범위(1~99)를 넘어설 경우 예외 발생 테스트(createPercentDiscountVoucherWithInvalidDiscountTest) - 입력된 discount가 지정 범위(1~99)를 넘어설 경우, 정상적으로 오류 메시지가 출력되는지 테스트를 합니다.
5. 생성된 모든 바우처 목록을 조회하는 테스트(fetchAllVouchersTest) - 생성된 모든 바우처를 조회하는 테스트입니다.

✅ PR 포인트 & 궁금한 점

고정 할인 바우처(FixedDiscountVoucher), 비율 할인 바우처(PercentDiscountVoucher) 생성 시 지정 범위를 설정하는 부분이 없어 VoucherService에 isValidDiscount 메소드를 별도로 설정하여 createVoucher 메소드에서 바우처 생성 시 바우처 타입을 확인하고, 금액 지정 범위(고정 할인 바우처라면 - 0이하의 금액은 x, 퍼센트 할인 바우처라면 - 1~99까지 이외의 범위)는 예외를 발생하도록 처리하였습니다.
해당 VoucherService에서 isValidDiscount 메소드로 금액 지정 범위를 구분해도 괜찮은지 궁금합니다.

2. 테스트 작성 시 도메인단 테스트, 서비스 단 테스트, 리포지 테스트단 구분만 생각을 해봤을 뿐, @DisplayName()에 통해 해당 테스트가 보다 어떤 이름을 가지고 명시해야 하는지 이해가 부족한 것 같습니다.
(예시 - BookMark 도메인 테스트, BookMark 서비스단 테스트, BookMark 컨트롤러 단 테스트 등으로 구분을 하여 이해를 하고 있었습니다.) 보다 나은 명시를 위해 작성한 테스트의 @DisplayName()을 보다 알기 쉽게 어떻게 바꿀 수도 있는지 궁금합니다.
항상 감사드리며 리뷰 잘 부탁드립니다!🥰🥰 감사합니다!!

…를 출력하도록 리팩토링

…ntroller, Service, Domain 이동

hanjo8813

재훈님 수고하셨습니다~
리뷰 확인해주세요~!

hanjo8813 · 2023-07-09T14:19:49Z

src/main/java/com/prgrms/springbootbasic/service/voucher/VoucherService.java

+        }
+    }
+
+    public void isValidDiscount(VoucherType type, long discount) {


해당 클래스에서만 사용하는 메소드이니 private이 좋을것 같네요~

그보다 검증의 책임을 각 엔티티 클래스에서 수행하는게 어떨까요?
생성자 부분에서 검증하면 될것 같아요~

hanjo8813 · 2023-07-09T14:21:24Z

src/main/java/com/prgrms/springbootbasic/service/voucher/VoucherService.java

+        } catch (IllegalArgumentException e) {
+            System.out.println(e.getMessage());
+            throw e;
+        }


root 레벨에서 해당 예외를 catch하고 있는데 중간에 한번 더 잡아서 내용을 출력해주는 이유가 있을까요?

hanjo8813 · 2023-07-09T14:22:52Z

src/main/java/com/prgrms/springbootbasic/service/voucher/VoucherService.java

+    public void isValidDiscount(VoucherType type, long discount) {
+        switch (type) {
+            case FIXED:
+                if (discount <= 0) {


매직넘버 잊지 말아주세요~ 적절한 변수명을 가진 상수로 빼주기!

상수로 빼줘도 좋고, 전체 라인을 inlineMethod로 추출해도 좋고

이 내용과 관련해서.. 영주님 PR에서 멘토님께서 남겨주신 리뷰를 꼭 읽어보시면 좋을것 같습니다~
#769 (comment)

hanjo8813 · 2023-07-09T14:24:37Z

src/test/java/com/prgrms/springbootbasic/domain/FixedDiscountVoucherTest.java

+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.CsvSource;
+
+class FixedDiscountVoucherTest {


엣지케이스도 테스트 추가해주세요!!

hanjo8813 · 2023-07-09T14:24:57Z

src/test/java/com/prgrms/springbootbasic/domain/PercentDiscountVoucherTest.java

+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.CsvSource;
+
+class PercentDiscountVoucherTest {


요기도 엣지케이스도 테스트해주세요~~

hanjo8813 · 2023-07-09T15:11:55Z

src/test/java/com/prgrms/springbootbasic/domain/PercentDiscountVoucherTest.java

+    }
+
+    @ParameterizedTest
+    @CsvSource({"10", "30", "50", "70"})


@ValueSource로 테스트해도 될것 같네요~

hanjo8813 · 2023-07-09T15:34:07Z

src/test/java/com/prgrms/springbootbasic/controller/VoucherControllerTest.java

+    private VoucherController voucherController;
+
+    @BeforeEach
+    void setUp() {
+        MockitoAnnotations.openMocks(this);
+        voucherController = new VoucherController(voucherService);
+    }


voucherController 위에 @InjectMocks 어노테이션을 사용하면 따로 객체를 생성해주지 않아도 됩니다~

hanjo8813 · 2023-07-09T15:46:10Z

src/test/java/com/prgrms/springbootbasic/service/VoucherServiceTest.java

+    @Test
+    @DisplayName("고정 할인 바우처 생성 테스트")
+    void createFixedDiscountVoucherTest() {
+        // given
+        long discount = 10000;
+
+        // when
+        voucherService.createVoucher(VoucherType.FIXED, discount);
+
+        // then
+        verify(voucherRepository, times(1)).insert(voucherCaptor.capture());
+        Voucher capturedVoucher = voucherCaptor.getValue();
+
+        assertThat(capturedVoucher).isInstanceOf(FixedDiscountVoucher.class);
+        assertThat(capturedVoucher.getDiscount()).isEqualTo(discount);
+    }


Repository의 insert 메소드가 mocking 되지 않았네요~
given을 활용해 stub을 뱉도록 mocking해주세요.

그리고 ArgumentCaptor를 통해 캡처한 객체는 service에서 repository 메소드를 호출할 때 넘긴 파라미터 값입니다.
즉 중간 결과물만 테스트하고 있는것입니다. repository mocking 후 최종 결과물도 검증해주세요!

mentor-tyler

수고하셨습니다~

mentor-tyler · 2023-07-12T06:35:43Z

src/main/java/com/prgrms/springbootbasic/ConsoleApplication.java

+                log.error("명령어가 잘못 입력되었습니다. ", e.getMessage());
+            } catch (Exception e) {
+                log.error("프로그램에서 오류가 발생하였습니다.", e.getMessage());


stackTrace가 있다면 나중에 로그를 볼때 좀더 빠르게 파악할것 같아요.

mentor-tyler · 2023-07-12T06:46:51Z

src/main/java/com/prgrms/springbootbasic/ConsoleApplication.java

    }

-    private void createVoucher() {
+    public void createVoucher() {


https://shoulditestprivatemethods.com/

ㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋ 처음보네요

mentor-tyler · 2023-07-12T06:47:34Z

src/main/java/com/prgrms/springbootbasic/ConsoleApplication.java

-        console.printMessage("바우처가 생성되었습니다!");
+        try {
+            voucherController.createVoucher(voucherType, voucherDiscount);
+            console.printMessage("바우처가 생성되었습니다!");


과연 생성 되었을까요?

mentor-tyler · 2023-07-12T06:49:06Z

src/main/java/com/prgrms/springbootbasic/service/voucher/VoucherService.java

+    public void isValidDiscount(VoucherType type, long discount) {
+        switch (type) {
+            case FIXED:
+                if (discount <= 0) {


상수로 빼줘도 좋고, 전체 라인을 inlineMethod로 추출해도 좋고

mentor-tyler · 2023-07-12T06:50:53Z

src/test/java/com/prgrms/springbootbasic/controller/VoucherControllerTest.java

+    }
+
+    @Test
+    @DisplayName("바우처 생성 validation 테스트")


다른곳 다 동일합니다. 뭘 테스트 하려는지 기대값,목적이 여기선 보이지 않네요.

jay-so added 20 commits July 4, 2023 00:30

refactor: ConsoleApplication 리팩토링

5e0f655

init: Voucher TestCode 세팅

5f8b98f

feat:Customer 클래스(Customer Domain Class) 구현

02dfa0f

refactor:VoucherType의 오류 메시지 리팩토링

f1f9c5f

refactor:Command enum 리팩토링

10b60ad

feat: VoucherType에 따른 고정 할인 바우처, 퍼센트 비율 할인 바우처의 지정 범위를 벗어나는 경우 에러 메시지…

ce917df

…를 출력하도록 리팩토링

refactor:Console 클래스 리팩토링

2ba1de8

refactor: ConsoleApplication 리팩토링

5c158a1

Rename: 각 Controller, Service, doamin 폴더 안의 Voucher패키지로 Voucher 관련 Co…

0d6236e

…ntroller, Service, Domain 이동

refactor: Output

50faf9e

feat: 고정할인 바우처(FixedDiscountVoucherTest) 테스트

b244133

feat: 비율할인 바우처(PercentDiscountVoucher) 테스트 코드

3561696

feat: ConsoleApplication 테스트 코드

65775ed

feat:VoucherService 테스트 코드

7b6afd7

feat:VoucherController 테스트 코드 작성

fac02cf

refactor:불 필요한 주석 제거

85a7f28

rename: Voucher Controller,Service,repository 폴더 위치 변경

b4d1d4d

refactor: VoucherService의 공백 제거

b253bc7

refactor:ConsoleApplication 리팩토링

64686ea

refactor: origin/w2-1 브랜치와 차이가 나는 로컬 w2-1 브랜치 수정

eff8ead

jay-so added 🔥 매운맛 Team-Tyler labels Jul 8, 2023

jay-so requested review from hanjo8813 and mentor-tyler July 8, 2023 09:49

jay-so self-assigned this Jul 8, 2023

hanjo8813 reviewed Jul 9, 2023

View reviewed changes

mentor-tyler reviewed Jul 12, 2023

View reviewed changes

hanjo8813 mentioned this pull request Jul 20, 2023

[4기 - 소재훈] SpringBoot Part2 Weekly Mission 제출합니다. #852

Open

9 tasks

Conversation

jay-so commented Jul 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📌 과제 설명

👩‍💻 요구 사항과 구현 내용

✅ 피드백 반영사항

📁 test/domain 패키지

📁 test/view 패키지

📁 test/service 패키지

✅ PR 포인트 & 궁금한 점

Uh oh!

hanjo8813 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mentor-tyler left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jay-so commented Jul 8, 2023 •

edited

Loading