[Clean Code] 9. 단위 테스트

 

TDD 법칙 세 가지

첫째 법칙: 실패하는 단위 테스트를 작성할  때까지 실제 코드를 작성하지 않는다.

둘째 법칙: 컴파일은 실패하지 않으면서 실행이 실패하는 정도로만 단위 테스트를 작성한다.

셋째 법칙: 현재 실패하는 테스트를 통과할 정도로만 실제 코드를 작성한다.

이렇게 하면 실제 코드를 전부 테스트하는 테스트 케이스가 나온다. 하지만 실제 코드와 맞먹을 정도로 방대한 테스트 코드는 심각한 관리 문제를 유발하기도 한다.

 

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

만약 테스트 코드가 더럽다면, 실제 코드를 변경해 기존 테스트 케이스가 실패했을 때, 지저분한 코드로 인해 변경하기 어려워진다. 테스트 코드는 실제 코드 못지 않게 중요하다. 

 

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

테스트 케이스가 있으면 변경이 두렵지 않다. 테스트 케이스가 없다면 모든 변경이 잠정적인 버그다.

 

깨끗한 테스트 코드

깨끗한 테스트 코드는 가독성이 매우 중요하다. 가독성을 높이려면? 명료성, 단순성, 풍부한 표현력이 필요하다. 테스트 코드는 최소의 표현으로 많은 것을 나타내야 한다. 잡다하고 세세한 코드는 거의 다 없애야 한다. BUILD-OPERATE-CHECK 패턴이 테스트 구조에 적합하다. 첫 부분은 테스트 자료를 만들고, 두 번째 부분은 테스트 자료를 조작하며, 세 번째 부분은 조작한 결과가 올바른지 확인한다. 

 

<도메인에 특화된 테스트 언어>

흔히 쓰는 시스템 API를 사용하는 대신 API 위에다 함수와 유틸리티를 구현해서 테스트 코드를 짜기도 읽기도 쉽게 한다. 이는 도메인에 특화된 언어(DSL)로 테스트 코드를 구현하는 기법이다. 이렇게 구현한 함수와 유틸리티는 테스트 코드에서 사용하는 특수 API가 된다.

 

<이중 표준>

테스트 API 코드에 적용하는 표준은 실제 코드에 적용하는 표준과 확실히 다르다. 단순하고, 간결하고, 표현력이 풍부해야 하지만, 실제 코드만큼 효율적일 필요는 없다. 다음은 온도가 '급격하게 떨어지면' 경보, 온풍기, 송풍기가 모두 가동되는지 확인하는 코드다.

@Test
void turnOnLoTempAlarmAtThreshold() throws Exception {
    hw.setTemp(WAY_TOO_COLD);
    controller.tic();
    assertTrue(hw.heaterState());
    assertTrue(hw.blowerState());
    assertFalse(hw.coolerState());
    assertFalse(hw.hiTempAlarm());
    assertTrue(hw.loTempAlarm());
}

위 코드는 세세한 사항이 많다. 예를 들어, 도대체 tic 함수가 무엇일까? 또한 코드에서 점검하는 상태 이름과 상태 값을 확인하느라 눈길이 이러지리 흩어진다.

그래서 다음 예제를 통해 가독성을 크게 높였다.

@Test
void turnOnLoTempAlarmAtThreshold() throws Exception {
    wayTooCold();
    assertEquals("HBchL", hw.getState());
}

tic 함수는 wayTooCold함수를 만들어 숨겼다. assertEquals에 들어있는 이상한 문자열에서 대문자는 '켜짐'이고 소문자는 '꺼짐'을 뜻한다. 비록 위 방식이 "그릇된 정보를 피하라(클린코드 2장)"는 규칙의 위반에 가깝지만 여기서는 적절해 보인다. 일단 의미만 안다면 테스트 코드를 읽기가 사뭇 즐거워진다.

다음은 getState 함수를 보여준다. 코드가 그리 효율적이지 못하다는 사실에 주목한다. 효율을 높이려면 StringBuffer가 더 적합하다.

public String getState() {
    String state = "";
    state += heater ? "H" : "h";
    state += blower ? "B" : "b";
    state += cooler ? "C" : "c";
    state += hiTempAlarm ? "H" : "h";
    state += loTempAlarm ? "L" : "l";
    return state;
}

그러나 StringBuffer는 보기에 흉하다. 테스트 코드에서는 위와 같이 코드를 명확하고, 단순하게 표현하면 좋다. 또한 테스트 환경은 자원이 제한적일 가능성이 낮아 성능에 크게 신경을 쓸 필요가 없다.

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

 

테스트 당 assert 하나

JUnit으로 테스트 코드를 짤 때는 함수마다 assert 문을 단 하나만 사용해야 한다고 주장하는 학파가 있다. 가혹한 규칙이라 여길지도 모르지만 확실히 장점이 있다. 위 예제에서도 assertTrue, assertFalse 들로 구성된 assert 문들을 assertEquals로 합치니 이해하기 쉽다. 하지만 전혀 다른 성질의 assert 문을 병합하는 데 불합리할 때가 있다.이런 경우 각 assert 문마다 테스트 코드를 쪼개는 방법이 있지만, given, when 절이 중복되는 문제가 생긴다. @Before 함수에 given, when 부분을 넣고 @Test 함수에 then 부분을 넣는 등 많은 방법이 있지만 이 역시 배보다 배꼽이 더 크다.

이것저것 감안해보면 단일 assert문은 훌륭한 지침이지만 상황에 따라 결국 assert 문을 여럿 사용하는 편이 좋다.

 

<테스트 당 개념 하나>

어쩌면 "테스트 함수마다 한 개념만 테스트하라"는 규칙이 더 낫겠다.

 

F.I.R.S.T

깨끗한 테스트는 다음 다섯 가지 규칙을 따른다.

빠르게(Fast): 테스트는 빨라야 한다. 테스트가 느리면 자주 돌릴 엄두를 못 낸다.

독립적으로(Independent): 각 테스트는 서로 의존하면 안 된다. 한 테스트가 다음 테스트가 실행될 환경을 준비해서는 안 된다.

반복가능하게(Repeatable): 테스트는 어떤 환경에서도 반복 가능해야 한다. 실제 환경, QA 환경, 네트워크에 연결되지 않은 환경에서도 실행될 수 있어야 한다.

자가검증하는(Self-Validating): 테스트는 부울(bool) 값으로 결과를 내야 한다. 성공 아니면 실패다. 통과 여부를 알려고 로그 파일을 읽게 만들어서는 안 된다.

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

 

결론

테스트 코드는 실제 코드만큼이나 프로젝트 건강에 중요하다. 테스트 코드는 실제 코드의 유연성, 유지보수성, 재사용성을 보존하고 강화한다. 그러므로 테스트 코드는 지속적으로 깨끗하게 관리하자. 표현력을 높이고 간결하게 정리하자. 테스트 API를 구현해 도메인 특화 언어를 만들자.