[#7] Service 및 테스트 코드 작성 #8

sssukho · 2024-11-26T12:27:49Z

ShopService 일부 테스트 코드 작성하였으며, 추후에 계속해서 다른 기능들의 테스트 코드도 작성해 나갈 예정입니다 😎

file changed 가 좀 많은데, ShopService, ShopServiceTest 클래스 위주로 리뷰 부탁드리겠습니다. 🙏

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

Shop 등록에서는 이미지 파일을 최대 5개까지 요청할 수 있도록 API 스펙에 작성하였습니다. 관련해서 Shop 등록 API 요청 한 번에 이미지 파일과 Shop 관련 텍스트 정보들을 한 요청에 다 받는게 적절한 API 설계인지 궁금합니다.

- 생성자 주입 방식이기 때문에 멤버 변수에 final 필요

f-lab-lyan · 2024-11-28T00:47:49Z

bp-app-api/src/main/java/com/beautify_project/bp_app_api/config/StorageServiceBeanConfig.java

+    private static final String STORAGE_IMPLEMENTATION_FILE_SYSTEM = "FILESYSTEM";
+    private static final String STORAGE_IMPLEMENTATION_S3 = "S3";
+
+    @Value("${storage.implementation:null}")


@ConfigurationProperties

추후 서비스 프로덕션/테스트 코드 리팩토링 PR에 반영하겠습니다!

f-lab-lyan · 2024-11-28T01:29:24Z

bp-app-api/src/main/java/com/beautify_project/bp_app_api/service/S3StorageService.java

https://docs.aws.amazon.com/AmazonS3/latest/userguide/ShareObjectPreSignedURL.html

추후 �API 스펙 변경 PR에 반영하도록 하겠습니다!

f-lab-lyan · 2024-11-28T01:42:23Z

bp-app-api/src/main/java/com/beautify_project/bp_app_api/service/ShopService.java

+    private final StorageService storageService;
+    private final FacilityRepository facilityRepository;
+    private final OperationRepository operationRepository;
+    private final CategoryRepository categoryRepository;


Suggested change

private final StorageService storageService;

private final FacilityRepository facilityRepository;

private final OperationRepository operationRepository;

private final CategoryRepository categoryRepository;

private final StorageService storageService;

private final FacilityRepository facilityRepository;

private final OperationRepository operationRepository;

private final CategoryRepository categoryRepository;

ShopService에서 다른 리포지토리들을 보는 것에 대해서

서비스를 만들어서 분리하는 것으로

해당 내용은 8주차 화상 멘토링에서 말씀드렸다시피 아직 구현하지 않아 위와 같이 작성했었습니다.
추후 서비스 프로덕션/테스트 코드 리팩토링 PR에 반영하겠습니다!

f-lab-lyan · 2024-11-28T15:15:16Z

bp-app-api/src/main/java/com/beautify_project/bp_app_api/service/FileSystemStorageService.java

+import org.springframework.web.multipart.MultipartFile;
+
+@Slf4j
+public class FileSystemStorageService implements StorageService {


이 코드는 좋은데, 일단 가장 큰 문제는 단일 머신에서밖에 쓸 수 없다는 문제가 있긴하겠죠? ㅎㅎ 만약 테스트에서 사용하려고 하신다면, 코드는 test쪽으로 옮겨두시는 것도 좋은 판단일 것 같습니다. (물론 mocking을 하신다면, 그 쪽을 더 추천하긴 합니다. 😁 )

테스트 코드를 위한 prdocut 코드의 변경이 없도록 해당 코드 삭제하여 서비스 프로덕션/테스트 코드 리팩토링 PR에 반영하겠습니다!

f-lab-lyan · 2024-11-28T15:15:59Z

bp-app-api/src/main/java/com/beautify_project/bp_app_api/service/ReviewService.java

@@ -23,8 +32,14 @@ public ResponseMessage findReviewList(final FindReviewListRequestParameters para
            createFindReviewListDummySuccessResponseBody());
    }

+    @Transactional


이게 필요한 이유는 혹시 delete가 실패할까봐 이신거죠?

의도한 바는 말씀하신 부분이 맞습니다.

그렇군요. 그런 의도라면, 괜찮은 것 같습니다. :-)

f-lab-lyan · 2024-11-28T15:18:12Z

bp-app-api/src/main/java/com/beautify_project/bp_app_api/service/ShopService.java

    public ResponseMessage registerShop(final ImageFiles images,
        final ShopRegistrationRequest shopRegistrationRequest) {

-        return ResponseMessage.createResponseMessage(new ShopRegistrationResult("732e934"));
+        // TODO: ShopRegistrationRequest 내 IdName 제거하고 id 값만 string 으로 받을 수 있게 수정


f-lab-lyan · 2024-11-28T15:18:54Z

bp-app-api/src/main/java/com/beautify_project/bp_app_api/service/ShopService.java

+        List<Operation> operations = operationRepository.findByIdIn(operationIds);
+        List<Facility> facilities = facilityRepository.findByIdIn(facilityIds);


이 부분은 validation을 해야하는게 아니라면, 그냥 id를 믿고 넣을 수 있으면 좋을텐데 말이죠...

f-lab-lyan · 2024-11-28T15:19:39Z

bp-app-api/src/main/java/com/beautify_project/bp_app_api/service/ShopService.java

+        Page<ShopListFindResult> page = shopRepository.findAll(pageable)
+            .map(foundShop ->
+                ShopListFindResult.createShopListFindResult(foundShop,
+                    new String(Base64.getEncoder().encode(storageService.loadThumbnail(


오 ... 섬네일을 base64로 내려줄 생각이셨던 거군요!!!!!! 두둥!!

presignedurl 에 대한 내용을 전혀 알지 못한 상태에서 API 스펙을 작성해버려서 생각해낸게 요정도였습니다 😂

추후 Shop API 스펙 변경 PR 에서 수정하여 반영하도록 하겠습니다!

f-lab-lyan · 2024-11-28T15:21:08Z

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

-    void given_e() throws Exception {
-
-    }
+//    @Test


필요없는 코드는 지우는게 어떨까요? 😄

f-lab-lyan · 2024-11-28T15:24:32Z

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

@@ -84,10 +110,12 @@ void given_shopRegistrationRequest_when_failed_then_getErrorResponseMessage() th

    @Test
    @DisplayName("Shop 리스트 조회 요청 성공시 value 가 JSON Array 인 ResponseMessage 객체 응답을 받는다.")
+    @Transactional


테스트 코드에 @transactional을 붙여서 얻을 수 있는 이득은 어떤 것이 있나요?

제가 기존에 인지하고 있던 이점은 테스트 코드에서 @Trasnactional 을 사용할 경우 'DB에 commit 된 내용들을 rollback 시켜줄 수 있다.' 였습니다.

근데 코멘트 달아주신 내용 보고 다시 한번 찾아보았더니, 아래와 같은 상황에서 production 코드에서 예상치 못한 문제들이 발생하는 사례들이 있는 것을 확인했습니다.

테스트 코드에만 @transactional 어노테이션이 존재하고, production 코드에는 @transactional 어노테이션이 붙지 않은 경우

production 코드에는 @transactional (readOnly=true) 로, 테스트 코드에는 @Transactionl 로 작성된 경우

테스트 코드에서 @transactional 에 적용된 정책(=rollback 이 기본이기 때문에 변경 감지(dirty checking)가 정상적으로 동작하지 않는)으로 인한 예상치 못한 문제 발생

테스트 코드는 기본적으로 최대한 production 환경을 구성하여 작성해야 한다고 생각하기 때문에 앞으로 테스트 코드에서의 @transactional 사용은 최대한 지양하는 방향으로 작성해야 할 것 같습니다.

관련된 수정은 차후 서비스 프로덕션/테스트 코드 리팩토링 PR 에서 진행하도록 하겠습니다!

f-lab-lyan · 2024-11-28T15:26:01Z

bp-app-api/src/test/java/com/beautify_project/bp_app_api/service/ReviewServiceTest.java

+    @DisplayName("Review 삭제 처리시 이상없이 메서드가 종료된다.")
+    void given_deleteReview_when_succeed_then_nothing() throws Exception {
+        // given
+        final String deleteTargetId = ReviewTestFixture.MOCKED_VALID_REVIEW_ENTITIES[0].getId();


요기를 위해서 Fixture를 사용하셨다면, 이정도는 그냥 hardcoded해도 되지 않았을까요?

넵 맞습니다. 해당 내용은 추후 PR 에 반영하도록 하겠습니다.

f-lab-lyan

👍 고생하셨어요! 추후 작업은 다른 PR로 하시면 좋을 것 같아요! 😄

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

sssukho requested a review from f-lab-lyan November 26, 2024 12:27

sssukho self-assigned this Nov 26, 2024

sssukho added 15 commits November 27, 2024 23:02

remove: 불필요 모듈 삭제 및 bp-app-api 모듈로 통합

0384272

commit#2d0d1c2 누락사항 반영

7ee607d

chore: postgresql 컨테이너를 실행하기 위한 docker-compose 파일 생성

91a0b32

feat: 환경별 application.yml 생성 및 logback 설정 파일 생성

8c6ac71

feat: Shop 관련 entity 코드 추가

ef47cec

feat: Shop repository 추가

f8d7269

feat: Storage 서비스 관련 코드 추가

4124b46

test: 테스트 코드 리팩토링

d1d1bc5

feat: Shop 등록 요청시 누락되었던 url 필드 추가

c87ad5c

test: Shop 서비스 테스트 코드 추가

4cfdef1

feat: 엔티티 연관관계 변경 및 그에 따른 엔티티 추가

fd5922a

feat: Shop 서비스 및 Storage 서비스 구현

b9ef52c

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

61d47e0

feat: FileStoreException 핸들러 추가

61741e0

refactor: 테스트 코드 리팩터링

7556b77

sssukho force-pushed the feature/7 branch from 4752816 to 7556b77 Compare November 27, 2024 14:05

sssukho added 4 commits November 28, 2024 06:28

refactor: 불필요 주석 삭제

cd8c776

feat: 리뷰 삭제 구현

c81825b

test: 리뷰 삭제 테스트 추가 및 테스트 코드 리팩토링

95065f3

fix: bean 주입이 되지 않는 문제 수정

f908755

- 생성자 주입 방식이기 때문에 멤버 변수에 final 필요

f-lab-lyan reviewed Nov 28, 2024

View reviewed changes

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

View reviewed changes

sssukho merged commit d1fb84e into main Nov 29, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[#7] Service 및 테스트 코드 작성 #8

[#7] Service 및 테스트 코드 작성 #8

sssukho commented Nov 26, 2024 •

edited

Loading

f-lab-lyan Nov 28, 2024

sssukho Nov 29, 2024

f-lab-lyan Nov 28, 2024

sssukho Nov 29, 2024

f-lab-lyan Nov 28, 2024

f-lab-lyan Nov 28, 2024

sssukho Nov 29, 2024

f-lab-lyan Nov 28, 2024

sssukho Nov 29, 2024

f-lab-lyan Nov 28, 2024

sssukho Nov 29, 2024

f-lab-lyan Dec 1, 2024

f-lab-lyan Nov 28, 2024

f-lab-lyan Nov 28, 2024

f-lab-lyan Nov 28, 2024

sssukho Nov 29, 2024

f-lab-lyan Nov 28, 2024

f-lab-lyan Nov 28, 2024

sssukho Nov 29, 2024

f-lab-lyan Nov 28, 2024

sssukho Nov 29, 2024

f-lab-lyan left a comment

		List<Operation> operations = operationRepository.findByIdIn(operationIds);
		List<Facility> facilities = facilityRepository.findByIdIn(facilityIds);

[#7] Service 및 테스트 코드 작성 #8

[#7] Service 및 테스트 코드 작성 #8

Conversation

sssukho commented Nov 26, 2024 • edited Loading

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

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 26, 2024 •

edited

Loading