[4기 이현호] Week2-1 : 바우처 서비스에 대한 테스트 코드 구현 by charlesuu · Pull Request #794 · prgrms-be-devcourse/springboot-basic

charlesuu · 2023-07-10T08:23:43Z

📌 과제 설명

1주차에 진행한 과제에 대한 테스트 코드입니다.
바우처 서비스, 도메인, 레포지토리에 관련된 테스트 코드를 작성했습니다.
아직 고객과 관련된 구현은 못했습니다. 2주차에 고객 관련된 구현이 추가되면, 테스트 코드 역시 작성할 예정입니다.

요구 사항

기본

바우처 관리 애플리케이션에 단위테스트를 작성해보세요.
- 가능한 많은 단위 테스트코드를 작성하려고 노력해보세요.
- 엣지 케이스(예외 케이스)를 고려해서 작성해주세요..
바우처 관리 애플리케이션에서도 과정에서 다루었던 고객을 적용해보세요.
- customers 테이블 정의 및 추가
- CustomerRepository 추가 및 JdbcTemplate을 사용해서 구현
(1주차엔 파일로 관리하게 했다.) 바우처 정보를 DB로 관리해보세요.
- 바우처에 엔터티에 해당하는 vouchers 테이블을 한번 정의해보세요.
- 바우처 레포지토리를 만들어보세요. (JdbcTemplate을 사용해서 구현)
- 기존의 파일에서 바우처를 관리한 것을 vouchers 테이블을 통해서 CRUD가 되게 해보세요.

✅ 구조

✅ 실행화면

=== Voucher Program ===
Type exit to exit the program.
Type create to create a new voucher.
Type list to list all vouchers.
명령어를 입력해주세요 >> (exit, create, list): list
저장되어 있는 쿠폰이 없습니다.
명령어를 입력해주세요 >> (exit, create, list): create
    Fixed Voucher를 발행하려면 fix를 입력해주세요.
    Percent Voucher를 발행하려면 percent를 입력해주세요.
    명령어를 입력해주세요 >> (fix, percent): fix
할인 금액을 입력해주세요 >> 5300
    Fixed Voucher, Discount Amount: 5300 할인권이 생성되었습니다.
명령어를 입력해주세요 >> (exit, create, list): create
    Fixed Voucher를 발행하려면 fix를 입력해주세요.
    Percent Voucher를 발행하려면 percent를 입력해주세요.
    명령어를 입력해주세요 >> (fix, percent): percent
    1 이상 100 이하로 입력해주세요.
    할인 비율을 입력해주세요 >> 60
    Percent Voucher, Discount Percent Amount: 60 할인권이 생성되었습니다.
명령어를 입력해주세요 >> (exit, create, list): create
    Fixed Voucher를 발행하려면 fix를 입력해주세요.
    Percent Voucher를 발행하려면 percent를 입력해주세요.
    명령어를 입력해주세요 >> (fix, percent): percent
    1 이상 100 이하로 입력해주세요.
    할인 비율을 입력해주세요 >> 24
    Percent Voucher, Discount Percent Amount: 24 할인권이 생성되었습니다.
명령어를 입력해주세요 >> (exit, create, list): list
    Fixed Voucher, Discount Amount: 5300 할인권이 생성되었습니다.
    Percent Voucher, Discount percent Amount: 60 할인권이 생성되었습니다.
    Percent Voucher, Discount percent Amount: 24 할인권이 생성되었습니다.
명령어를 입력해주세요 >> (exit, create, list): exit

Process finished with exit code 0

✅ 궁금한 점

바우처의 로직이 틀린 부분, 메서드 네이밍이 잘 못된 부분 등이 있어서 수정했습니다. 따라서 테스트 코드가 아닌 일반 코드 영역에 수정된 부분이 있을 수 있으나, Files changed에서는 Test파일 위주로 봐주시면 될 것 같습니다!!

charlesuu · 2023-07-10T08:25:59Z

+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+
+class VoucherServiceTest {


이 부분에서 Mock을 쓰는게 더 좋을지 고민이 되었는데,
생성자로 의존성을 간단하게 주입할 수 있는 것 같아서 그냥 쓰지 않았습니다.

뭔가 Mock을 꼭 써야만 하는 상황이 없을 수도 있겠다는 생각도 드는데(생성자로 주입받는 클래스라면)
꼭 Mocking을 써야만 해결되는 테스트가 있나요??

우선 '단위테스트'의 개념부터 잘 이해하셔야 할것 같습니다.
현재는 service 레이어의 단위테스트이기 때문에 해당 클래스가 가지는 의존성을 제거하고 서비스 로직 자체에만 집중해야합니다.
따라서 의존성들을 모두 mocking시켜주는 것이죠.

또 현재는 메모리 repository라서 매우 가볍기 때문에 이렇게 해도 큰 문제는 없다고 생각할 수 있습니다.
(다만 빡빡한 기준으로 보면 service의 단위테스트라고 할 수는 없습니다)
하지만 jdbc repository라고 생각한다면.. repository에서는 spring의 도움을 받아 datasource bean까지 주입받아야 합니다.
service 레이어 단위테스트에서 이런 의존성까지 신경쓰고 싶지 않기 때문에 mocking을 한다고 생각하시면 될것 같네요~

지금 테스트는 그냥 두고, jdbc 적용 후에 mocking으로 테스트해주세요~!

참고 : https://kukim.tistory.com/107

(2-3) PR에 mocking 적용한 단위 테스트 작성해보았습니다~! mockito는 처음 써봤는데 정말 좋은 공부가 되었습니다.

단위 테스트의 격리를 바라보는 관점이 두 가지 있다는 걸 처음 알게 되었습니다. 개인적으로 동작 단위로 격리하는 고전파 의견이 좀 더 실용적이라 느껴졌습니다. 의존하고 있는 객체의 문제로 클래스가 실패하더라도, 그것을 발견하는데 의의가 있다는 의견에서 특히 그랬구요. 팀원들과 두 방식의 장단점에 대해서 이야기 나눠봐야겠습니다~~

hanjo8813

현호님 수고하셨습니다~~

hanjo8813 · 2023-07-11T17:36:01Z

+
+    private static void validatePositiveNumber(String input) {
+        if (!IS_NUMERIC_REGEX.matcher(input).matches()) {
+            throw new IllegalArgumentException(ERROR_MESSAGE_NOT_POSITIVE_INTEGER_VALUE);


에러를 유발시킨 값도 에러 메시지에 포함시켜주세요~!

브랜치 (2-3) 에서 포함 시켰습니다~

hanjo8813 · 2023-07-11T17:42:31Z

+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+
+class VoucherServiceTest {


우선 '단위테스트'의 개념부터 잘 이해하셔야 할것 같습니다.
현재는 service 레이어의 단위테스트이기 때문에 해당 클래스가 가지는 의존성을 제거하고 서비스 로직 자체에만 집중해야합니다.
따라서 의존성들을 모두 mocking시켜주는 것이죠.

또 현재는 메모리 repository라서 매우 가볍기 때문에 이렇게 해도 큰 문제는 없다고 생각할 수 있습니다.
(다만 빡빡한 기준으로 보면 service의 단위테스트라고 할 수는 없습니다)
하지만 jdbc repository라고 생각한다면.. repository에서는 spring의 도움을 받아 datasource bean까지 주입받아야 합니다.
service 레이어 단위테스트에서 이런 의존성까지 신경쓰고 싶지 않기 때문에 mocking을 한다고 생각하시면 될것 같네요~

지금 테스트는 그냥 두고, jdbc 적용 후에 mocking으로 테스트해주세요~!

hanjo8813 · 2023-07-11T17:46:17Z

+    @DisplayName("정액 바우처 읽어오기 테스트")
+    @ParameterizedTest
+    @ValueSource(ints = {100, 500, 3340})
+    void 바우처_읽기_테스트1(int amount) {


테스트 메소드명을 한글로 작성하는건 @DisplayName까지 쓰고싶지 않은 이유가 큽니다.
둘 중 하나만 선택해서 하시는걸 추천드립니다. (웬만하면 지금은 정석대로 가시죠!)

또 테스트 설명을 작성할 때는 멘토님께서 말씀하신 것처럼 정확한 내용이 들어가야 합니다.

테스트 코드의 명칭은 3단계로 구성되었으면 좋겠어요.
어떤 상황에서 - 무엇을 하는데 - 어떤걸 기대한다.
여기서 "기대한다" 가 중요합니다.

참고 : #755 (review)

그런 이유가 있었군요! 정석대로 바꾸고, 대부분의 테스트가 3단계로 구성되도록 변경하였습니다.

hanjo8813 · 2023-07-11T17:47:27Z

+class VoucherTypeTest {
+
+    @ParameterizedTest
+    @ValueSource(strings = {"accVoucher", "divideVoucher"})
+    @DisplayName("바우처 타입에 없는 타입이 입력되면 예외를 발생시킨다.")
+    void voucherTypeTest(String input) {
+        assertThatThrownBy(() -> VoucherType.from(input))
+                .isInstanceOf(IllegalArgumentException.class)
+                .hasMessage("입력하신 " + input + "는 유효한 바우처 종류가 아닙니다.\n fix 또는 percent를 입력하세요.\n");


정상 동작도 테스트해주세요!

Enum들 중 후에 값이 추가되서 테스트가 쉽게 깨질만한 파일들이 보여서 Enum에 대한 테스트는 제거 하였습니다.
하지만 다른 테스트들은 모두 정상 동작도 테스트하도록 변경하였습니다~!

hanjo8813 · 2023-07-11T17:50:20Z

+    @ParameterizedTest
+    @ValueSource(strings = {"lists", "lists", "voucher"})
+    @DisplayName("커멘드 명령어에 없는 명령어가 입력되면 예외를 발생시킨다.")
+    void programMenuTest(String input) {
+        assertThatThrownBy(() -> CommandType.from(input))
+                .isInstanceOf(IllegalArgumentException.class)
+                .hasMessage("입력하신 " + input + "는 유효한 커멘드가 아닙니다. \n exit, create, list 중 하나를 입력하세요.\n");
+    }


given / when / then 주석은 웬만하면 항상 적용시켜주세요!~ (다른 테스트들도..)

when then이 겹친다 싶으면 // when + then 이런식으로라도 적어주세요.

주석 적는것 마저도 귀찮으시다면 https://siyoon210.tistory.com/176 강력추천 합니다.

대부분의 테스트가 3단계로 구성되도록 변경하였습니다!

꿀팁 감사합니다~!!

hanjo8813 · 2023-07-11T17:51:20Z

+        voucherRepository.save(voucher4);
+
+        // then
+        Assertions.assertThat(voucherRepository.findAll()).isEqualTo(vouchers);


내부 객체 동등성까지 모두 비교해주나요? (동일성과 동등성 차이를 모른다면 검색해보세요~!)

usingRecursiveFieldByFieldElementComparator() 메서드 사용해서 객체 순회하면서 내부 필드 동등성 비교하도록 변경했습니다!

mentor-tyler

수고하셨습니다.

mentor-tyler · 2023-07-14T04:09:55Z


-    public VoucherDto readVoucher(UUID id) {
-        return voucherService.readAll(id);
+    public VoucherDto read(UUID id) {


메서드 네이밍에 대해 고민해보면 좋을것 같아요.
https://cocobi.tistory.com/27

클래스명에 Voucher이 포함된 상황에 메서드명까지 중복될 필요가 없는 것 같습니다. Voucher은 제거하겠습니다!

mentor-tyler · 2023-07-14T04:11:11Z

+            logger.warn("고객이 save되지 않았음. 잘 못된 입력 {}", customer);
+            throw new IllegalArgumentException(String.format("고객이 save되지 않았음. 잘 못된 입력 : %s", customer));


메소드가 동일하다면 추출

mentor-tyler · 2023-07-14T04:12:35Z

+
+class VoucherTest {
+
+    @DisplayName("<정액 할인 바우처> 할인 테스트")


뭘 테스트 하는 걸까요? 기대값을 적어주세요.

"고정된 값을 입력하여 고정 할인을 진행할 수 있다." 라고 이름을 바꾸었습니다.

기대값을 명시해야 테스트의 구체적인 목적을 파악할 수 있겠다는 생각이 들었습니다.

mentor-tyler · 2023-07-14T04:13:33Z

+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+
+class VoucherServiceTest {


참고 : https://kukim.tistory.com/107

mentor-tyler · 2023-07-14T04:16:38Z

+    @ParameterizedTest
+    @ValueSource(strings = {"lists", "lists", "voucher"})
+    @DisplayName("커멘드 명령어에 없는 명령어가 입력되면 예외를 발생시킨다.")
+    void programMenuTest(String input) {
+        assertThatThrownBy(() -> CommandType.from(input))
+                .isInstanceOf(IllegalArgumentException.class)
+                .hasMessage("입력하신 " + input + "는 유효한 커멘드가 아닙니다. \n exit, create, list 중 하나를 입력하세요.\n");
+    }


주석 적는것 마저도 귀찮으시다면 https://siyoon210.tistory.com/176 강력추천 합니다.

charlesuu added 9 commits July 8, 2023 00:34

refactor: 상수 네이밍 변경, 메서드 순서 변경

b53f789

test: 바우처 금액 검증 로직 관련 테스트 추가

5f8b2d8

test: 바우처 금액 검증 로직 관련 테스트 추가(성공하는 경우)

036b018

fix: 할인율 적용 방식 수정

838cf62

test: 바우처 할인 적용 테스트

b651241

refactor: 바우처 1개 읽는 메서드 네이밍 변경

d9819f5

test: Enum 클래스 관련 테스트 추가

6c138d4

refactor: 각 Enum에 대한 테스트를 타입별로 분리

b8554da

test: 레포지토리 테스트 추가

2a93c0b

charlesuu commented Jul 10, 2023

View reviewed changes

charlesuu changed the title ~~Week2 1~~ Week2-1 : 바우처 서비스에 대한 테스트 코드 구현 Jul 10, 2023

charlesuu requested review from hanjo8813 and mentor-tyler July 10, 2023 08:59

charlesuu self-assigned this Jul 10, 2023

charlesuu added Team-Tyler 🔥 매운맛 labels Jul 10, 2023

charlesuu changed the title ~~Week2-1 : 바우처 서비스에 대한 테스트 코드 구현~~ [4기 이현호] Week2-1 : 바우처 서비스에 대한 테스트 코드 구현 Jul 10, 2023

hanjo8813 reviewed Jul 11, 2023

View reviewed changes

charlesuu added 2 commits July 12, 2023 15:56

chore: DB설정 파일 업로드

f4ffb93

feat: customer Repository 구현

dd58fb1

mentor-tyler reviewed Jul 14, 2023

View reviewed changes

charlesuu merged commit b3206ed into prgrms-be-devcourse:charlesuu Jul 18, 2023

		logger.warn("고객이 save되지 않았음. 잘 못된 입력 {}", customer);
		throw new IllegalArgumentException(String.format("고객이 save되지 않았음. 잘 못된 입력 : %s", customer));


		class VoucherTest {

		@DisplayName("<정액 할인 바우처> 할인 테스트")

Conversation

charlesuu commented Jul 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📌 과제 설명

요구 사항

✅ 구조

✅ 실행화면

✅ 궁금한 점

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hanjo8813 Jul 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

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!

hanjo8813 Jul 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

charlesuu Jul 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

hanjo8813 Jul 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

charlesuu commented Jul 10, 2023 •

edited

Loading

hanjo8813 Jul 11, 2023 •

edited

Loading

hanjo8813 Jul 11, 2023 •

edited

Loading

charlesuu Jul 18, 2023 •

edited

Loading

hanjo8813 Jul 11, 2023 •

edited

Loading