💻테스트

테스트 코드와 관련된 내용을 서술한 문서입니다.

테스트

테스트는 왜 해야할까요? 큰 이유로는 버그 발견, 리팩토링 지원, 요구사항 검증, 문서화, 회귀 테스트 등.. 다양한 방향에서의 이점을 얻을 수 있습니다.

테스트는 아래 그림과 같이 3단계가 있습니다.

단위 테스트(Unit Tests)

가장 작은 단위의 테스트입니다. 개별 함수나 메서드의 예상 동작을 검증합니다.

개발 환경에서 검증합니다. API를 개발한다면, KOIN_API_V2에서 test 패키지에 테스트 코드를 작성합니다.

자세한 테스트 코드 작성 방법은 test 패키지를 참고합니다.

통합 테스트(Integration Tests)

여러 모듈이나 컴포넌트가 제대로 상호작용하는지 테스트합니다.

실제 DB나 파일 시스템을 이용하는 등 실제 자원과의 상호작용을 포함합니다.

이 과정에서 Swagger를 이용하여 API를 호출하여 실제 DB를 확인하며 테스트 할 수 있습니다.

프론트엔드와의 협력할 수 있는 부분이고, 백엔드 측에서도 자주 사용하므로 주의할 사항 및 사용 방법은 온보딩 문서를 참고합니다.

UI 테스트(UI Tests)

최종 사용자가 웹/앱 사용 시, UI가 예상 작동을 하는지 테스트합니다.

이 테스트는 Stage 서버나, Production 서버에서 진행하며, 사용자의 입장에서 기능을 테스트하고 오류를 검증합니다.

팀 단위의 스프린트 작업이 종료되어 기능을 배포한 이후, 팀별로 나누어 QA를 진행합니다.

테스트 코드

주로 작성하게 될 부분입니다. 전체적인 구조는 코드를 직접적 뜯어보시는 걸 추천합니다.

테스트 코드의 명명법은 현재 2가지가 있습니다.

해당 컨벤션은 테스트 코드 컨벤션이 확정되면 수정 될 예정입니다.

1. @DisplayName을 이용한다.

기존 사용하던 방법입니다. @Test 어노테이션 아래에 @DisplayName으로 테스트를 설명합니다.

DisplayName 상황에 맞는 영어 메소드 이름을 지어서 사용합니다.

ex) @DisplayName("리뷰를 작성한다") void createReview

2. 한글과 언더바를 이용한다.

최근 적용된 방식입니다. 메소드 이름 자체에 한글과 언더바로 테스트를 설명합니다.

직접적인 설명을 한글 메소드 이름을 지어서 사용합니다.

ex) void 새로운_리뷰를_작성한다