refactor: 테스트 코드 내 로그인 중복 제거 #453

kong-hana01 · 2024-01-29T10:34:13Z

작업 사항

테스트용 profile 분리
- 기본(default): 매 테스트마다 모든 테이블 정보 초기화
- 로그인 활용(auth): 매 테스트마다 멤버/세션 관련 테이블을 제외한 모든 테이블 정보 초기화
MockServer 구현
- 로그인 요청에 대한 응답을 캐싱하여 다른 테스트에서 로그인 요청시 캐싱한 정보 반환
- MockLogin 객체를 추상화하여 세션 로그인 -> 쿠키 로그인 방식으로 변환될 때 구현체만 만들고 갈아끼울 수 있도록 구현
- auth profile 사용하여 로그인이 필요한 Test에서만 활용
- 빈 스코프를 prototype으로 설정하여 각 컨트롤러 테스트마다 새로 생성하여 사용
TestInstance를 method -> class로 변경
- 기존: 매 테스트 메소드마다 새로운 인스턴스 생성 -> MockServer를 매 테스트마다 생성하기에 캐싱 효과가 없음
- 변경 이후: 매 테스트 클래스마다 하나의 인스턴스 생성 -> MockServer를 캐싱해서 사용
- 이미 DatabaseCleaner를 사용해 매 테스트 마다 db를 비워주기에 테스트 간의 격리가 보장되기에 TestInstance를 class 단위로 변경

기타 사항

조금 더 속도 개선이 있을 줄 알았지만...! 기껏해야 1~2초 정도 개선되었습니다. 😢
개선할 수 있는 지점이 더 있어보이긴 하지만 댓글 <-> 멤버 간의 격리가 이뤄지고나서 개선해볼 수 있을 것 같아요.

* feat: id를 사용하는 entity는 BaseEntity를 상속하도록 수정 * refactor: flyway 사용 규칙에 따라 스크립트 수정

* refactor: 패키지 및 클래스 명 수정 * feat: 카카오 소셜로그인 idToken 검증 및 payload 추출 기능 구현 * feat: 카카오 소셜로그인 기능 구현 * refactor: jwkProvider를 static 변수로 가지도록 수정 * refactor: 구글 소셜로그인 검증 방식 통일 * refactor: 구글 소셜로그인 검증 방식 추상화 * feat: 멤버 객체 내 nickname 필드 추가 * feat: 닉네임 객체 구현 * refactor: 클래스 네이밍 변경 * feat: JwkProvider를 찾지 못할 때 예외 구현 및 record -> class로 변경 * refactor: final 키워드 추가 * chore: 닉네임 추가 sql 버전 변경 5.3 -> 5.4 --------- Co-authored-by: thdwoqor <celebarte01@gmail.com>

* feat: IdTokenResolver가 Provider에 맞게 동작한다 * test: 지원하지 않는 Issuer 예외 테스트 추가 * refactor: 유지보수가 용이하도록 구조 개선 * refactor: 누락된 final 추가

* feat: 게스트로 로그인한다 * feat: 빈 패스워드는 어떤 문자열과도 일치하지 않는다 * refactor: Member 클래스 내 생성자를 정적 팩토리 메소드로 변경 * refactor: final 키워드 추가 * fix: 머지 중 누락 --------- Co-authored-by: Kong-hana01 <gksqlsl11@khu.ac.kr>

…iggin-room

…iggin-room into backend

0chil

코드가 100만줄은 줄어든 것 같네요!
고생하셨고, 남긴 커멘트 한번 읽어주십쇼!

0chil · 2024-02-14T09:46:53Z

backend/src/main/java/com/digginroom/digginroom/feedback/controller/FeedbackController.java


-    @GetMapping("/feedbacks")
+    @GetMapping


제가 싼 💩을 치워주셨군요..👍

0chil · 2024-02-14T09:50:56Z

backend/src/test/java/com/digginroom/digginroom/config/ControllerTestConfig.java

+    public DatabaseCleaner getAuthDatabaseCleanerBean() {
+        return new DatabaseCleaner(Set.of(MEMBER, MEMBER_GENRE, SPRING_SESSION, SPRING_SESSION_ATTRIBUTES));
+    }
+


명확해서 좋습니다!
하나 마음에 걸리는 건 테이블 이름에 종속적이라는 것이네요.
하지만 그런 일은 잘 안생기니까 당장은 괜찮다고 생각합니다.

인정합니다!
flyway로 관리하니까 잘하면 어찌저찌해볼 순 있겠지만 어떻게 해야할지는 잘 모르겠네요 ㅎㅎ..

0chil · 2024-02-14T09:54:56Z

backend/src/test/java/com/digginroom/digginroom/controller/mock/MockLoginServer.java

+        this.mockLogins.add(webClientBuilder.baseUrl(HOST + port + PATH)
+                .build()
+                .post()
+                .exchangeToMono(response -> Mono.just(new MockSessionLogin(response)))
+                .block());
+    }


예전에 파워가 작업해 주셨던 거랑 마찬가지로 WebClient 및 Mono가 쓰였네요!
당시엔 익숙하지 않아서 좀 어려웠지만 지금은 무슨일이 일어나는지 대략 알겠네요 ㅎㅎ

0chil · 2024-02-14T09:56:20Z

backend/src/test/java/com/digginroom/digginroom/controller/RoomControllerTest.java

+        this.memberRepository = memberRepository;
+        this.roomRepository = roomRepository;
+        this.mockLoginServer = mockLoginServerObjectProvider.getObject();
+        System.out.println(123123);


123123 👍
디버깅의 흔적인가요 😂

ㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋ 제가 싼 💩 을 알려주셨군요

0chil · 2024-02-14T10:04:45Z

backend/src/test/java/com/digginroom/digginroom/controller/MemberArgumentResolverTest.java


+@ActiveProfiles("default")


테스트들이 기본적으로 'default' 프로파일로 동작하기를 원하시는 것 같네요.

최근에 찾아낸 꿀팁 하나 공유해볼게요.
build.gradle 에 다음과 같은 설정을 하면 테스트들에 기본 프로파일을 지정해 줄 수 있어 편리하더라구요.!
필요하다면 이렇게 적용해봐도 괜찮을 것 같습니다.

... tasks.named('test') { useJUnitPlatform() systemProperty("spring.profiles.active", "test") }

오 좋은데요?

아! 이 방식 적용하려고 했었는데 auth 프로필인 경우에는 default 프로필을 내려야하는데, 그 설정하는게 안되더라고요 ㅠ

아무튼 꿀팁 감사합니다 ㅎㅎ

0chil · 2024-02-14T10:08:17Z

backend/src/test/java/com/digginroom/digginroom/feedback/controller/FeedbackControllerTest.java

    private String cookie;

+    @Autowired
+    public FeedbackControllerTest(FeedbackRepository feedbackRepository,
+                                  ObjectProvider<MockLoginServer> mockLoginServerObjectProvider


최근에 비슷한 코드를 리뷰한 적이 있는데, 생성자에 Autowired가 없어도 주입이 잘 된다라는 리뷰를 남겼었거든요.
제가 잘못된 지식을 알려준건지 의심되네요 ㄷㄷ
어떻게 붙이게 되었는지 계기가 궁금합니다.

저두 확인해봤었는데요.
운영 환경에서는 땡칠이 말씀해주신 내용이 맞아요!

근데 테스트 환경에서는 spring이 빈 주입을 담당하는게 아니라 JUnit 패키지의 ParameterResolver가 빈 주입을 담당하더라고요. 그리고 SpringExtension이 ParameterResolver를 상속받아서 빈 주입을 시켜주는데, 이 친구는 autowired를 직접 명시해야지 resolve할 수 있다고 판단하더라고요. 그래서 autowired를 직접 작성해야지 잘 동작합니다!

아 저번에 말씀해주신게 이 내용이었군요.!
테스트 클래스는 스프링의 의존성 관리 대상이 아니므로 자동으로 의존성이 주입되지 않는다.
따라서 @Autowired 어노테이션을 통해 명시해줘야 SpringExtension이 동작하며 빈을 생성, 주입시킬 수 있다.
라고 이해했는데 맞을까요?

thdwoqor and others added 26 commits September 21, 2023 15:02

feat: id를 사용하는 entity는 BaseEntity를 상속하도록 수정 (#293)

773a0c9

* feat: id를 사용하는 entity는 BaseEntity를 상속하도록 수정 * refactor: flyway 사용 규칙에 따라 스크립트 수정

refactor: 룸 업로드 페이지 리팩터링 (#307)

83c6004

refactor: 룸, 트랙, 미디어소스 역정규화 (#309)

3f6489b

chore: 데이터 베이스 테이블 컬럼 수정 (#311)

07c88f8

feat: IdTokenResolver가 Provider에 맞게 동작한다 (#314)

a1b2d4f

* feat: IdTokenResolver가 Provider에 맞게 동작한다 * test: 지원하지 않는 Issuer 예외 테스트 추가 * refactor: 유지보수가 용이하도록 구조 개선 * refactor: 누락된 final 추가

chore: 중복된 ci 파일 제거 (#323)

009f9fd

Merge branch 'backend' of https://github.com/woowacourse-teams/2023-d…

c817a18

…iggin-room

Merge branch 'backend' of https://github.com/woowacourse-teams/2023-d…

9abac13

…iggin-room into backend

Merge branch 'backend' of https://github.com/woowacourse-teams/2023-d…

dddb165

…iggin-room into backend

fix: 피드백 검증을 하지 않는 문제 해결

9ab764f

chore: 컨벤션 통일

fc5acb1

refactor: DatabaseCleaner 인터페이스 및 구현체 구현

9dea15a

refactor: AuthDatabaseCleaner 구현

8760bed

refactor: 외부에서 값을 주입받아 빈을 생성하도록 변경

3c3a33f

chore: 패키지 구조 변경(util -> config)

c5eb0da

refactor: ControllerTest의 profile 설정

ce345b8

feat: MockLogin 객체 구현

ca9faac

feat: MockLogin 객체 구현

6bfa6b3

refactor: default 환경을 구성하는 컨트롤러 테스트 격리

cbe2ec2

feat: 로그인을 담당하는 mock 서버 구현

f7ca27f

refactor: 로그인 환경을 설정하는 ControllerTestConfig 객체 구현

8271418

refactor: 멤버 정보를 재사용해서 테스트를 하도록 변경

b05d9c9

fix: FeedbackControllerTest에서 캐싱사용하도록 변경

44ba455

docs: 예외 로그 확인 ci 파일 추가

c619ef4

kong-hana01 force-pushed the refactor/452 branch from 8fe4cad to c619ef4 Compare January 31, 2024 11:23

kong-hana01 added 3 commits February 5, 2024 20:29

refactor: TestInstance 단위를 class로 변경

17fe93a

refactor: MockLoginServer의 빈 스코프를 프로토타입으로 변경

2a8bb20

docs: ci 파일 복구

403e93e

refactor: 테스트 내 환경을 @TestConfiguration으로 변경

5f2fe81

kong-hana01 changed the title ~~Refactor/452~~ refactor: 테스트 코드 내 로그인 중복 제거 Feb 14, 2024

kong-hana01 requested review from 0chil, thdwoqor and Songusika February 14, 2024 06:07

kong-hana01 self-assigned this Feb 14, 2024

kong-hana01 added backend 백엔드 분야 feat 기능 개발 labels Feb 14, 2024

0chil approved these changes Feb 14, 2024

View reviewed changes

chore: 사용하지 않는 콘솔 출력 제거

327601f

kong-hana01 merged commit 0d258d2 into backend Mar 4, 2024
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: 테스트 코드 내 로그인 중복 제거 #453

refactor: 테스트 코드 내 로그인 중복 제거 #453

kong-hana01 commented Jan 29, 2024 •

edited

Loading

0chil left a comment

0chil Feb 14, 2024

0chil Feb 14, 2024

kong-hana01 Feb 24, 2024

0chil Feb 14, 2024

0chil Feb 14, 2024

kong-hana01 Feb 24, 2024

0chil Feb 14, 2024

kong-hana01 Feb 24, 2024

kong-hana01 Mar 4, 2024 •

edited

Loading

0chil Feb 14, 2024

kong-hana01 Feb 24, 2024

0chil Mar 5, 2024


		@ActiveProfiles("default")

refactor: 테스트 코드 내 로그인 중복 제거 #453

refactor: 테스트 코드 내 로그인 중복 제거 #453

Conversation

kong-hana01 commented Jan 29, 2024 • edited Loading

관련 이슈번호

작업 사항

기타 사항

0chil left a 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

kong-hana01 Mar 4, 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

kong-hana01 commented Jan 29, 2024 •

edited

Loading

kong-hana01 Mar 4, 2024 •

edited

Loading