클린코드 9장 - 단위 테스트

1997년만 해도 TDD(test driven development)라는 개념을 아무도 몰랐다.

우리들 대다수에게 단위 테스트란 자기 프로그램이 '돌아간다'는 사실만 확인하는 일회성 코드에 불과했다. 

돌아간다는 사실을 확인하고 동료들에게도 보여줬다. 그리고 나서는 테스트 코드를 버렸다. 

 

애자일과 TDD 덕택에 단위 테스트를 자동화하는 프로그래머들이 이미 많아졌으며 점점 더 늘어나는 추세다.

하지만, 테스트를 추가하려고 급하게 서두르는 와중에 많은 프로그래머들이 제대로 된 테스트 케이스를 작성해야 한다는 좀 더 미묘한 ( 그리고 더욱 중요한 ) 사실을 놓쳐버렸다.

 

TDD 법칙 세 가지

 TDD가 실제 코드를 짜기 전에 단위 테스트부터 짜라고 요구한다는 사실을 모르는 사람은 없으리라. 하지만 이 규칙은 빙산의 일각에 불과하다. 다음 세 가지 법칙을 살펴보자.

 

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

이렇게 일하면 매일 수십 개, 매달 수백 개, 매년 수천 개에 달하는 테스트 케이스가 나온다. 이렇게 일하면 실제 코드를 사실상 전부 테스트하는 테스트 케이스가 나온다. 

하지만 실제 코드와 맞먹을 정도로 방대한 테스트 코드는 심각한 관리 문제를 유발하기도 한다.

 

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

 저자가 코치했던 팀은, 예전에 돌아만 가는 실제 코드를 테스트만 할 수 있는 테스트 코드를 작성하였다. 테스트를 안하느니 지저분한 테스트 코드라도 있는 편이 좋다고 판단했을지도 모르겠다.

하지만, 팀은 지저분한 테스트 코드를 내놓으나 테스트를 안 하나 오십보 백보라는, 아니 오히려 더 못한다는 사실을 깨닫지 못했다. 

  테스트 코드가 지저분할수록 변경하기 어려워진다. 테스트 코드가 복잡할수록 실제 코드를 짜는 시간보다 테스트 케이스를 추가하는 시간이 더 걸리기 십상이다. 실제 코드를 변경해 기존 테스트 케이스가 실패하기 시작하면, 지저분한 코드로 인해, 실패하는 테스트 케이스를 점점 더 통과시키기 어려워진다. 그래서 테스트 코드는 계속해서 늘어나는 부담이 되버린다.
  새 버전을 출시할 때마다 팀이 테스트 케이스를 유지하고 보수하는 비용도 늘어난다. 점차 테스트 코드는 개발자 사이에서 가장 큰 불만으로 자리잡는다. 결국 테스트 슈트를 폐기하지 않으면 안 되는 상황에 처한다. 

  하지만, 테스트 슈트가 없으면 결국 결함율이 높아지기 시작한다. 의도하지 않은 결함 수가 많아지면 개발자는 변경을 주저한다. 변경하면 득보다 해가 크다 생각해 더 이상 코드를 정리하지 않고, 코드가 망가지기 시작한다.

  테스트 코드를 깨끗하게 짰다면 테스트에 쏟아 부은 노력은 허사로 돌아가지 않았을 터이다. 

테스트 코드는 실제 코드 못지 않게 중요하다. 실제 코드 못지 않게 깨끗하게 짜야 한다.

 

테스트는 유연성, 유지보수성, 재사용성을 제공한다

  코드에 유연성, 유지보수성, 재사용성을 제공하는 버팀목이 바로 단위테스트다. 테스트 케이스가 있으면 변경이 두렵지 않으니까! 테스트 케이스가 있다면 공포는 사실상 사라진다. 커버리지가 높을수록 공포는 줄어든다. 

  테스트 케이스가 있으면 변경이 쉬워진다. 따라서 테스트 코드가 지저분하면 코드를 변경하는 능력이 떨어지며 코드 구조를 개선하는 능력도 떨어진다. 

 

 

깨끗한 테스트 코드

   깨끗한 테스트 코드를 만들려면? 세 가지가 필요하다. 가독성, 가독성, 가독성.

테스트 코드에서 가독성을 높이려면? 여느 코드와 마찬가지다. 명료성, 단순성, 풍부한 표현력이 필요하다. 테스트 코드는 최소의 표현으로 많은 것을 나타내야 한다. 

목록 9-1 은, 9-2와 같이 개선되게 된다. 

 

  각 테스트는 명확히 세 부분으로 나눠진다. 첫 부분은 테스트 자료를 만든다. 두 번째 부분은 테스트 자료를 조작하며, 세 번째 부분은 조작한 결과가 올바른지 확인한다. 

  테스트 코드는 본론에 돌입해 진짜 필요한 자료 유형과 함수만 사용한다. 읽는 사람은 온갖 잡다하고 세세한 코드에 주눅들고 헷갈릴 필요 없이 코드가 수행하는 기능을 재빨리 이해한다.

 

이중 표준

  테스트 API 코드에 적용하는 표준은 실제 코드에 적용하는 표준과 확실히 다르다. 단순하고, 간결하고, 표현력이 풍부해야 하지만, 실제 코드만큼 효율적일 필요는 없다. 실제 환경이 아니라 테스트 환경에서 돌아가는 코드이기 때문이다. 

목록 9-6을 보아도, StringBuffer가 더 효율적일 것이지만, 테스트 환경은 자원이 제한적일 가능성이 낮다 ( 실제로는 실시간 임베디드 시스템일지라도 ). 

 이것이 이중 표준의 본질이다. 실제 환경에서는 절대로 안 되지만 테스트 환경에서는 전혀 문제없는 방식이 있다. 대게 메모리나 CPU 효율과 관련 있는 경우다. 코드의 깨끗함과는 철저히 무관하다.

 

테스트 당 assert 하나

  가혹한 규칙이라 여길지도 모르지만, assert 문이 단 하나인 함수는 결론이 하나라서 코드를 이해하기 쉽고 빠르다. 하지만, 중복을 제거하는 여러 가지 기법들은 결국, 배보다 배꼽이 더 크다. 

  저자는 '단일 assert 문' 이라는 규칙이 훌륭한 지침이라 생각한다. 하지만 때로는 주저 없이 함수 하나에 여러 assert 문을 넣기도 한다. 단지 assert 문 개수는 최대한 줄여야 좋다는 생각이다. 

 

테스트 당 개념 하나

  '테스트 함수마다 한 개념만 테스트하라'는 규칙이다. 이것저것 잡다한 개념을 연속으로 테스트하는 긴 함수는 피한다. 

/**
* addMonths() 메서드를 테스트하는 장황한 코드
*/
public void testAddMonths() {
   SerialDate d1 = SerialDate.createInstance(31, 5, 2004);
   
   SerialDate d2 = SerialDate.addMonths(1, d1);
   assertEquals(30, d2.getDayOfMonth());
   assertEquals(6, d2.getMonth());
   assertEquals(2004, d2.getYYYY());
   
   SerialDate d3 = SerialDate.addMonths(2, d1);
   assertEquals(31, d3.getDayOfMonth());
   assertEquals(7, d3.getMonth());
   assertEquals(2004, d3.getYYYY());
   
   SerialDate d4 = SerialDate.addmOnths(1, SerialDate.addMonths(1, d1));
   assertEquals(30, d4.getDayOfMonth());
   assertEquals(7, d4.getMonth());
   assertEquals(2004, d4.getYYYY());
   
}

위의 코드는 독자적인 개념 세 개를 테스트하므로 독자적인 테스트 세 개로 쪼개야 마땅하다. 세 개념을 한 함수로 몰아넣으면 독자가 각 절이 거기에 존재하는 이유와 각 절이 테스트하는 개념을 모두 이해해야 한다. 

 

위의 코드는 각 절에 assert문이 여럿이라는 사실이 문제가 아니다. 한 테스트 함수에서 여러 개념을 테스트한다는 사실이 문제다. 그러므로 가장 좋은 규칙은 "개념 당 assert문 수를 최소로 줄여라"와 "테스트 함수 하나는 개념 하나만 테스트하라"라 하겠다.

 

F.I.R.S.T

  깨끗한 테스트는 다음 다섯 가지 규칙을 따른다. 각 규칙에서 첫 글자를 따오면 FIRST가 된다.

 

빠르게 : 테스트는 빨라야 한다. 테스트는 빨리 돌아야 한다는 말이다. 느리면 자주 돌릴 엄두를 못 낸다. 자주 돌리지 않으면 초반에 문제를 찾아내 고치지 못한다. 

 

독립적으로 : 각 테스트는 서로 의존하면 안 된다. 한 테스트가 다음 테스트가 실행될 환경을 준비해서는 안 된다. 각 테스트는 독립적으로 그리고 어떤 순서로 실행해도 괜찮아야 한다. 테스트가 서로에게 의존하면 하나가 실패할때 나머지도 잇달아 실패하므로 원인을 진단하기 어려워진다.

 

반복가능하게 : 테스트는 어떤 환경에서도 반복 가능해야 한다. 실제 환경, QA 환경, 노트북 환경에서도 실행할 수 있어야 한다.

 

자가검증하는 : 테스트는 bool 값으로 결과를 내야 한다. 성공 아니면 실패다. 로그 파일을 읽거나 수작업으로 비교하게 만들어서도 안 된다. 테스트가 스스로 성공과 실패를 가늠하지 않는다면 판단은 주관적이 되며 지루한 수작업 평가가 필요하게 된다.

 

적시에(Timely) : 테스트는 적시에 작성해야 한다. 단위 테스트는 테스트하려는 실제 코드를 구현하기 직전에 구현한다. 실제 코드를 구현한 다음에 테스트 코드를 만들면 실제 코드가 테스트하기 어렵다는 사실을 발견할지도 모른다. 테스트가 불가능하도록 실제 코드를 설계할지도 모른다.

 

 

결론

  테스트 코드는 지속적으로 깨끗하게 관리하자. 표현력을 높이고 간결하게 정리하자.