로버트 C.마틴의 클린 코드를 읽고 정리한 포스트입니다.
TDD 법칙 세 가지
- 실패하는 단위 테스트를 작성할 때까지 실제 코드를 작성하지 않는다
- 컴파일은 실패하지 않으면서 실행이 실패하는 정도로만 단위 테스트를 작성한다
- 현재 실패하는 테스트를 통과할 정도로만 실제 코드를 작성한다
위 세가지 법칙을 따르면 테스트 코드와 실제 코드가 함께 나올뿐더러 테스트 코드가 실제 코드보다 불과 몇 초 전에 나온다.
이렇게 일하면
- 매일 수십 개, 매달 수백 개, 매년 수천 개에 달하는 테스트 케이스가 나온다.
- 실제 코드를 사실상 전부 테스트하는 테스트 케이스가 나온다
하지만 실제 코드와 맞먹을 정도로 방대한 테스트 코드는 심각한 관리 문제를 유발하기도 하는데…
깨끗한 테스트 코드 유지하기
테스트 코드가 지저분할수록 변경하기 어려워진다. 지저분한 코드로 인해, 실패하는 테스트 케이스를 점점 통과시키기 어려워진다.
새 버전을 출시할 때마다 팀이 테스트 케이스를 유지하고 보수하는 비용도 늘어난다. 점차 테스트 코드는 개발자 사이에서 가장 큰 불만으로 자리잡는다.
테스트 슈트가 없으면 개발자는 자신이 수정한 코드가 제대로 도는지 확인할 방법이 없다. 결함율이 높아지기 시작한다. 개발자는 변경을 주저한다. 결국 테스트 코드도, 개발도 엉망이 되버린다.
테스트 코드를 애초에 깔끔하게 짰더라면 이런 일이 발생하지 않았을텐데…
테스트 코드는 사고와 설계와 주의가 필요하다. 실제 코드 못지 않게 중요하며 깨끗하게 짜야 한다.
- 테스트는 유연성, 유지보수성, 재사용성을 제공한다
- 테스트 코드를 깨끗하게 유지하지 않으면 결국은 잃어버린다
- 테스트 케이스가 없으면 실제 코드를 유연하게 만드는 버팀목도 사라진다
- 테스트 케이스가 있으면 변경이 두렵지 않다
- 테스트 케이스가 없다면 모든 변경이 잠정적인 버그다
- 아키텍처가 아무리 훌륭하더라도 테스트 케이스가 없으면 개발자는 변경을 주저한다
그러므로 자동화된 단위 테스트 슈트는 설계와 아키텍처를 최대한 깨끗하게 보존하는 열쇠이다.
깨끗한 테스트 코드
가독성
은 테스트 코드에 더더욱 중요하다.
- 중복되는 코드는 함수를 만들어 숨긴다
- 이중 표준
- 테스트 코드는 단순&간결&표현력이 풍부해야 하지만, 실제 코드만큼 효율적인 필요는 없다
- 실제 환경에서는 안되지만 테스트 환경에서는 비효율적이어도 된다(자원이 한정적일 경우)
테스트 당 개념 하나
이것저것 잡다한 개념을 연속으로 테스트하는 긴 함수는 피하자.
- 개념 당 assert 문 수를 최소로 줄여라
- 테스트 함수 하나는 개념 하나만 테스트하라
F.I.R.S.T.
- Fast : 테스트는 빨리 돌아야 한다. 테스트가 느리면 자주 돌릴 엄두를 못 낸다. 자주 돌리지 않으면 초반에 문제를 찾아내지 못한다. 코드를 마음껏 정리하지도 못하여 결국 코드 품질이 망가지기 시작한다.
- Independent : 각 테스트는 서로 의존하면 안 된다. 테스트가 서로에게 의존하면 하나가 실패할 때 나머지도 잇달아 실패하므로 원인을 진단하기 어려워지며 후반 테스트가 찾아내야 할 결함이 숨겨진다.
- Repeatable : 테스트는 어떤 환경에서도 반복 가능해야 한다. 실제 환경, QA 환경, 노트북 환경에서도 실행할 수 있어야 한다. 테스트가 돌아가지 않는 환경이 하나라도 있다면 테스트가 실패한 이유를 둘러댈 변경이 생긴다.
- Self-Validating : 테스트는 bool값으로 결과를 내야 한다. 통과 여부를 알려고 로그 파일을 읽게 만들어서는 안 된다. 테스트가 스스로 성공과 실패를 가늠하지 않는다면 판단은 주관적이 되며 지루한 수작업 평가가 필요하게 된다.
- Timely : 테스트는 적시에 작성해야 한다. 단위 테스트는 테스트하려는 실제 코드를 구현하기 직전에 구현한다. 실제 코드를 구현한 다음에 테스트 코드를 만들면 실제 코드가 테스트하기 어렵다는 사실을 발견할지도 모른다.
결론
테스트 코드는 실제 코드만큼이나 프로젝트 건강에 중요하다. 어쩌면 실제 코드보다 더 중요할지도 모른다. 테스트 코드는 실제 코드의 유연성, 유지보수성, 재사용성을 보존하고 강화하기 때문이다. 그러므로 테스트 코드는 지속적으로 깨끗하게 관리하자. 표현력을 높이고 간결하게 정리하자. 테스트 API를 구현해 특화 언어(DSL, Domain Specific Language)를 만들자. 그러면 테스트 코드를 짜기가 쉬워진다.
테스트 코드가 방치되어 망가지면 실제 코드도 망가진다.
Previous
‘[클린 코드 리뷰] 경계 8장’ -> Previous
Next
‘[클린 코드 리뷰] 클래스 10장’ -> Next