2021년 07월 28일 TIL

오늘은 프로젝트를 진행하면서 단위테스트의 필요성을 느끼고, 단위테스트에 대해 공부하며 프로젝트에 도입해보았다.

라이브 템플릿 양식

@DisplayName("테스트 이름") 
@Test 
void Test() {    
    // given    
    
    // when    
    
    // then 
}

단위 테스트 작성 예시

참조 링크 : https://mangkyu.tistory.com/144

API 단위 테스트

참조 링크 : https://mangkyu.tistory.com/145

망나니 개발자님의 포스팅을 보고 많이 배울 수 있었다. 또한, 프로젝트를 진행하면서 API 문서 자동화의 필요성을 느꼈는데, 기존에는 Swagger를 사용했었지만 Swagger 사용 시에 프로덕션 코드의 오염이 발생한다는 생각을 지울 수가 없었다. 따라서 Spring Rest Docs를 선택하기로 했다.

참고 자료

우아한 형제들 기술 블로그 : https://techblog.woowahan.com/2597/

Spring Rest Docs 공식 문서 : https://docs.spring.io/spring-restdocs/docs/current/reference/html5/#getting-started-using-the-snippets

우아한 형제들의 기술 블로그와 공식문서를 참고하여 도입을 진행하였다. 발생했던 자잘자잘한 오류로는 Gradle이 상위버전으로 업데이트되면서 공식문서에서 지시하는 바와 다르게 적용해야하는 부분들이 있었고, 그러한 부분들을 수정하니 성공적으로 문서화를 시행할 수 있었다. 추후 모든 적용이 완료되면 에러났던 상황들에 대해 정리해서 올려볼까한다.