[Share] 문서화를 위한 테스트 작성시 컨트롤러 단위 테스트로 사용

[pbg0205]

🙋🏻‍♂️ 공유 사항

(기록용으로 남겨둡니다 😃)

Spring Rest Doc 을 통한 API 문서화 작성시 컨트롤러 단위 테스트로 진행합니다!

[협의 내용]

• mockMvc 를 이용해 컨트롤러 단위 테스트하는 것으로 협의

이유는 아래와 같습니다.

• 프로젝트에 통합 테스트 형태로 인수 테스트를 적용하고 있어 컨트롤러 단위 테스트 수준으로 문서화 시켜도 적절하다고 판단됩니다.

📖 참고 사항

• 통합 테스트로 작성 시, 인증 객체에 관한 문제에 대해 검토한 @withSecurityContext 내용 : [Tecoble] Spring Security가 적용된 곳을 효율적으로 테스트하자.
  • @withSecurityContext 을 선언하고 WithSecurityContextFactory의 구현체인 WithMockCustomUserSecurityContextFactory 를 작성하면 테스트가 동작하기 이전에 SecurityContext 에 인증 객체를 주입하기 하기 때문에 로그인 사용자의 인증이 필요한 비즈니스 로직을 작성하는데 도움된다. 또한 프로덕트 코드에 영향을 주지 않고 어노테이션 기반이기 때문에 코드 라인이 간결해진다.
  • 현재 프로젝트 구조상 access token 을 통해 인증 객체를 조회하고 있기 때문에 통합 테스트로 작성할 경우 별도의 access token 을 생성하는 별도의 코드 작업이 필요해 보입니다.