클린 코드 (Clean Code) - 9장 단위 테스트

노션 정리

9장 단위 테스트

 

😃 책에서 기억하고 싶은 내용을 써보세요.

TDD 법칙 세 가지

1. 실패하는 단위 테스트를 작성할 때까지 실제 코드를 작성하지 않는다.
2. 컴파일은 실패하지 않으면서 실행이 실패하는 정도로만 단위 테스트를 작성한다.
3. 현재 실패하는 테스트를 통과할 정도로만 실제 코드를 작성한다.

• 위 세 가지 규칙을 따르면 개발과 테스트가 대략 30초 주기로 묶인다.
• 실제 코드와 맞먹을 정도로 방대한 테스트 코드는 심각한 관리 문제를 유발하기도 한다.

깨끗한 테스트 코드 유지하기

• 실제 코드가 진화하면 테스트 코드도 변해야 하는데 테스트 코드가 지저분할 수록 변경하기 어려워진다.
• 테스트 코드가 복잡할수록 실제 코드를 짜는 시간보다 테스트 케이스를 추가하는 시간이 더 걸리기 십상이다.
• 실제 코드를 변경해 기존 테스트 케이스가 실패하기 시작하면 지저분한 코드로 인해 실패하는 테스트 케이스를 점점 통과시키기 어려워진다.
• 테스트 코드는 실제 코드 못지 않게 중요하다. 테스트 코드는 사고와 설계와 주의가 필요하다. 실제 코드 못지 않게 깨끗하게 짜야 한다.
• 테스트는 유연성, 유지보수성, 재사용성을 제공한다.
  • 테스트 코드를 개끗하게 유지하지 않으면 결국은 잃어버린다. 그리고 테스트 케이스가 없으면 실제 코드를 유연하게 만드는 버팀목도 사라진다.
  • 테스트 케이스가 없다면 모든 변경이 잠정적인 버그다.
  • 테스트 케이스가 있으면 변경이 쉬워진다.

깨끗한 테스트 코드

• 가독성은 실제 코드보다 테스트 코드에서 더더욱 중요하다. 테스트 코드에서 가독을을 높이려면 명료성, 단순성, 풍부한 표현력이 필요하다. 테스트 코드는 최소의 표현으로 많은 것을 나타내야 한다.
• G5: 중복
  • 데이비드 토머스와 앤디 헌트는 이를 DRY(Don’t Repeat Yourself) 원칙이라 부른다. 켄트 벡은 익스트림 프로그래밍의 핵심 규칙 중 하나로 선언한 후 “한 번, 단 한 번만(Once, and only once) 이라 명명했다. 론 제프리스는 이 규칙을 “모든 테스트를 통과한다”는 규칙 다음으로 중요하게 꼽았다.
  • 코드에서 중복을 발견할 때마다 추상화할 기회로 간주하라. 중복된 코드를 하위 루틴이나 다른 클래스로 분리하라.
  • 똑같은 코드가 여러 차례 나오는 중복은 간단한 함수로 교체한다.
  • switch/case나 in/else 문으로 똑같은 조건을 거듭 확인하는 중복은 다형성(polymorphism)으로 대체해야한다.
  • 알고리즘이 유사하나 코드가 서로 다른 중복은 TEMPLATE METHOD 패턴이나 STRATEGY 패턴으로 중복을 제거한다.
  • 어디서든 중복을 발견하면 없애라.
• 테스트 코드는 본론에 돌입해 진짜 필요한 자료 유형과 함수만 사용한다.
• 도메인에 특화된 테스트 언어
  • 흔히 쓰는 시스템 조작 API를 사용하는 대신 API 위에다 함수와 유틸리티를 구현한 후 그 함수와 유틸리티를 사용하므로 테스트 코드를 짜기도 읽기도 쉬워진다. 이렇게 구현한 함수와 유틸리티는 테스트 코드에서 사용하는 특수 API가 된다. 즉, 테스트를 구현하는 당사자와 나중에 테스트를 읽어볼 독자를 도와주는 테스트 언어다.
• 이중 표준
  • 테스트 API 코드에서 적용하는 표준은 실제 코드에 적용하는 표준과 확실히 다르다. 단순하고, 간결하고, 표현력이 풍부해야 하지만, 실제 코드만큼 효율적일 필요는 없다. 실제 환경이 아니라 테스트 환경에서 돌아가는 코드이기 때문이다. 실제 환경과 테스트 환경은 요구사항이 판이하게 다르다.

테스트 당 assert 하나

• ‘단일 assert 문’이라는 규칙이 훌륭한 지침이라 생각한다. 하지만 때로는 주저 없이 함수 하나에 여러 assert 문을 넣기도 한다. 단지 assert 문 개수는 최대한 줄여야 좋다는 생각이다.
• 테스트 당 개념 하나
  • 이것저것 잡다한 개념을 연속으로 테스트하는 긴 함수는 피한다.
  • “개념 당 assert 문 수를 최소로 줄여라”
  • “테스트 함수 하나는 개념 하나만 테스트하라”

F.I.R.S.T

• 깨끗한 테스트는 다음 다섯 가지 규칙을 따르는데, 각 규칙의 첫 글자를 따오면 FIRST가 된다.
• 빠르게 (Fast)
  • 테스트는 빨라야 한다. 테스트가 느리면 자주 돌릴 엄두를 못낸다. 자주 돌리지 못하면 초반에 문제를 찾아내 고치지 못한다.
• 독립적으로 (Independent)
  • 각 테스트는 서로 의존하면 안 된다. 한 테스트가 다음 테스트가 실행될 환경을 준비해서는 안 된다. 각 테스트는 독립적으로 그리고 어떤 순서로 실행해도 괜찮아야 한다.
• 반복가능하게 (Repeatable)
  • 테스트는 어떤 환경에서도 반복 가능해야 한다. 실제 환경, QA 환경, 버스를 타고 집으로 가는 길에 사용하는 (네트워크에 연결되지 않은) 노트북 환경에서도 실행할 수 있어야 한다.
• 자가검증하는 (Self-Validating)
  • 테스트는 부울(bool) 값으로 결과를 내야 한다. 성공 아니면 실패다. 통과 여부를 알려고 로그 파일을 읽게 만들어서는 안 된다. 통과 여부를 알려고 텍트스 파일 두 개를 수작업으로 비교하게 만들어서도 안 된다.
• 적시에 (Timely)
  • 테스트는 적시에 작성해야 한다. 단위 테스트는 테스트하려는 실제 코드를 구현하기 직전에 구현한다. 실제 코드를 구현한 다음에 테스트 코드를 만들면 실제 코드가 테스트하기 어렵다는 사실을 발견할지도 모른다.

결론

• 테스트 코드는 실제 코드만큼이나 프로젝트 건강에 중요하다. 어쩌면 실제 코드보다 더 중요할지도 모르겠다. 테스트 코드는 실제 코드의 유연성, 유지보수성, 재사용성을 보존하고 강화하기 때문이다.
• 테스트 코드는 지속적으로 깨끗하게 관리하자. 표현력을 높이고 간결하게 정리하자.
• 테스트 API를 구현해 도메인 특화 언어(Domain Specific Language, DSL)을 만들자. 그러면 그만큼 테스트 코드를 짜기가 쉬워진다.

 

🤔 오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요.

• 항상 코드를 작성하면서 테스트 코드는 어떤 식으로 작성해야 하는 지 잘 몰랐었다. 이번 기회에 테스트 코드를 작성하는 방법과 테스트 코드를 어떻게 관리해야 하는 지 공부해야겠다.

 

🔎 궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.

• 도입부
  • ScheduleCommand 함수를 테스트 하는 방법의 문제점
• 깨끗한 테스트 코드
  • BUILD-OPERATE-CHECK 패턴
  • TEMPLATE METHOD 패턴
  • STRATEGY 패턴
• 테스트 당 assert 하나
  • given-when-then