Clean Code, Chapter 9: Unit tests #789
Description
Chapter 9 단위 테스트
우리 분야는 눈부신 성장을 이뤘다.
코드가 제대로 도는지 확인하는 테스트 코드를 작성한다.
표준 타이밍 함수를 호출하는 대신 운영체제에서 코드를 분리한다.
타이밍 함수를 직접 구현해 시간을 완전히 통제한다.
테스트 케이스를 모두 구현하고 통과한 후에는 내 코드를 사용할 사람들에게도 공개한다.
테스트 코드와 내 코드를 같은 소스 패키지로 확실하게 묶어 체크인한다.
애자일과 TDD 덕분에 단위 테스트를 자동화하는 프로그래머들이 많아지고 있다.
하지만 테스트를 추가하려고 급하게 서두르는 와중에
많은 프로그래머들이 제대로 된 테스트 케이스를 작성해야 한다는 좀 더 미묘한
그리고 중요한 사실을 놓쳐버렸다.
TDD 법칙 세 가지
- 실패하는 단위 테스트를 작성할 때 까지 실제 코드를 작성하지 않는다.
- 컴파일은 실패하지 않으면서 실행이 실패하는 정도로만 단위 테스트를 작성한다.
- 현재 실패하는 테스트를 통과할 정도로만 실제 코드를 작성한다.
위 세 가지 규칙을 따르면 개발과 테스트가 대략 30초 주기로 묶인다.
테스트 코드와 실제 코드가 함께 나오며 테스트 코드가 실제 코드보다 불과 몇 초 전에 나온다.
이렇게 하면 매일 수십 개, 매달 수백 개, 매년 수천 개에 달하는 테스트 케이스가 나온다.
하지만 실제 코드와 맞먹을 정도로 방대한 테스트 코드는 심각한 관리 문제를 유발한다.
깨끗한 테스트 코드 유지하기
일회용 테스트 코드를 짜오다가 자동화된 단위 테스트 스위트를 짜기란 쉽지 않다.
둘 사이는 간극이 아주 크다.
실제 코드가 진화하면 테스트 코드도 변해야 한다.
그런데 테스트 코드가 지저분할수록 변경이 어려워진다.
테스트 코드가 복잡할수록 실제 코드를 짜는 시간보다 테스트 케이스를 추가하는 시간이 더 걸린다.
실제 코드를 변경해 기존 테스트 케이스가 실패하면
지저분한 코드로 인해 실패하는 테스트 케이스를 점점 더 통과시키기 어려워진다.
그래서 테스트 코드는 계속해서 늘어나는 부담이 되버린다.
새 버전을 출시할 때마다 팀이 테스트 케이스를 유지하고 보수하는 비용도 늘어난다.
점차 테스트 코든느 개발자 사이에서 가장 큰 불만으로 자리잡는다.
결국 테스트 스위트를 폐기하지 않으면 안 되는 상황에 처한다.
테스트 스위트가 없으면 개발자는 자신이 수정한 코드가 제대로 도는지 확인할 방법이 없다.
테스트 스위트가 없으면 코드를 수정해도 안전하다는 사실을 검증하지 못한다.
그래서 결함율이 높아지기 시작한다.
결함 수가 많아지면 개발자는 변경을 주저한다.
변경하면 득보다 해가 크다고 생각해 더 이상 코드를 정리하지 않는다.
그러면서 코드가 망가지기 시작한다.
테스트 코드를 깨끗하게 짠다면 테스트에 쏟아 부은 노력은 허사로 돌아가지 않는다.
이 이야기의 교훈은 다음과 같다.
테스트 코드는 실제 코드 못지 않게 중요하다.
테스트 코드는 사고와 설계와 주의가 필요하다.
실제 코드 못지 않게 깨끗하게 짜야 한다.
테스트는 유연성, 유지보수성, 재사용성을 제공한다.
코드에 유연성, 유지보수성, 재사용성을 제공하는 버팀목이 바로 단위 테스트이다.
테스트 케이스가 있으면 변경이 두렵지 않다.
테스트 케이스가 없다면 모든 변경이 잠정적인 버그다.
아키텍처가 유연해도, 설계를 잘 나눠 놨어도 테스트 케이스가 없으면 개발자는 변경을 주저한다.
테스트 케이스가 있으면 공포는 사라진다.
아키텍처가 부실한 코드나 설계가 모호하고 엉망인 코드라도 별다른 우려 없이 변경할 수 있다.
오히려 안심하고 아키텍처와 설계를 개선할 수 있다.
따라서 실제 코드를 점검하는 자동화된 단위 테스트 스위트는 설계와 아키텍처를 최대한 깨끗하게 보존하는 열쇠다.
깨끗한 테스트 코드
깨끗한 테스트 코드를 만들려면 세가지가 필요한데
가독성, 가독성, 가독성이다.
테스트 코드에 가독성을 높이려면 명료성, 단순성, 풍부한 표현력이 필요하다.
목록 9-2는 깨끗하고 이해하기 쉬운 테스트 코드이다.
목록 9-2 SerializedPageResponderTest.java (리팩터링한 코드)
public void testGetPageHierarchyAsXml() throws Exception {
makePages("PageOne", "PageOne.ChildOne", "PageTwo");
submitRequest("root", "type:pages");
assertResponseIsXML();
assertResponseContains(
"<name>PageOne</name>", "<name>PageTwo</name>", "<name>ChildOne</name>");
}
public void testSymbolicLinksAreNotInXmlPageHierarchy() throws Exception {
WikiPage page = makePage("PageOne");
makePages("PageOne.ChildOne", "PageTwo");
addLinkTo(page, "PageTwo", "SymPage");
submitRequest("root", "type:pages");
assertResponseIsXML();
assertResponseContains(
"<name>PageOne</name>", "<name>PageTwo</name>", "<name>ChildOne</name>");
assertResponseDoesNotContain("SymPage");
}
public void testGetDataAsXml() throws Exception {
makePageWithContent("TestPageOne", "test page");
submitRequest("TestPageOne", "type:data");
assertResponseIsXML();
assertResponseContains("test page", "<Test");
}BUILD-OPERATE-CHECK 패턴이 이 같은 테스트 구조에 적합하다.
http://butunclebob.com/FitNesse.BuildOperateCheck
테스트는 세 부분으로 나눠지는데
- 테스트 자료를 만든다
- 테스트 자료를 조작한다
- 조작한 결과가 올바른지 판단한다
테스트 코드는 진짜 필요한 자료 유형과 함수만 사용한다.
코드를 읽는 사람은 코드가 수행하는 기능을 재빨리 이해할 수 있다.
도메인에 특화된 테스트 언어
목록 9-2는 도메인에 특화된 언어DSL로 테스트 코드를 구현하는 기법을 보여준다.
이렇게 구현한 함수와 유틸리티는 테스트 코드에서 사용하는 특수 API가 된다.
테스트를 구현하는 당사자와 나중에 테스트를 읽어볼 독자를 도와주는 테스트 언어이다.
이중 표준
테스트 API 코드에 적용하는 표준은 실제 코드에 적용하는 표준과 확실히 다르다.
단순하고, 간결하고, 표현력이 풍부해야 하지만 실제 코드만큼 효율적일 필요는 없다.
실제 환경과 테스트 환경은 요구사항이 판이하게 다르다.
목록 9-3은 세세하기 설명하지 않아도
온도가 떨어지면 경보, 온풍기, 송풍기가 모두 가동되는지 확인하는 코드라는 사실이 드러난다.
목록 9-3 EnvironmentcontrollerTest.java
@Test
public void turnOnLoTempAlarmAtThreashold() throws Exception {
hw.setTemp(WAY_TOO_COLD);
controller.tic();
assertTrue(hw.heaterState());
assertTrue(hw.blowerState());
assertFalse(hw.coolerState());
assertFalse(hw.hiTempAlarm());
assertTrue(hw.loTempAlarm());
}목록 9-3은 코드에서 점검하는 상태 이름과 상태 값을 확인하느라 눈길이 이리저리 흩어진다.
assetTrue, assertFalse인지 확인해야 하고 State()인지 Alarm()인지도 확인해야 한다.
따분하고 미덥잖은 코드라 읽기가 어렵다.
목록 9-4는 가독성을 크게 높은 코드이다.
목록 9-4 EnvironmentControllerTest.java (리팩터링)
@Test
public void turnOnLoTempAlarmAtThreshold() throws Exception {
wayTooCold();
assertEquals("HBchL", hw.getState());
}assertEquals에 있는 문자열은 다음과 같다.
대분자는 켜짐이고 소문자는 꺼짐이다.
문자는 heater, blower, cooler, hi-temp-alarm, lo-temp-alarm 순서이다.
이미 살펴본 그릇된 정보를 피하라는 규칙 위반에 가깝지만 여기서는 적절해 보인다.
의미를 알고 있다면 결과를 빨리 판단할 수 있다.
목록 9-5 처럼 여러 테스트 케이스를 보면 이해하기 쉽다는 사실이 드러난다.
목록 9-5 EnvironmentControllerTest.java (더 복잡한 선택)
@Test
public void turnOnCoolerAndBlowerIfTooHot() throws Exception {
tooHot();
assertEquals("hBChl", hw.getState());
}
@Test
public void turnOnHeaterAndBlowerIfTooCold() throws Exception {
tooCold();
assertEquals("HBchl", hw.getState());
}
@Test
public void turnOnHiTempAlarmAtThreshold() throws Exception {
wayTooHot();
assertEquals("hBCHl", hw.getState());
}
@Test
public void turnOnLoTempAlarmAtThreshold() throws Exception {
wayTooCold();
assertEquals("HBchL", hw.getState());
}목록 9-6은 getState 함수인데 효율성을 높이려면 StringBuffer가 적합하다.
목록 9-6 MockControlHardware.java
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;
}애플리케이션은 임베디드 시스템이므로 컴퓨터 자원과 메모리가 제한적일 가능성이 높다.
하지만 테스트 환경에서는 절대로 안 되지만 테스트 환경에서는 자원이 제한적일 가능성이 낮다.
이것이 이중 표준의 본질이다.
실제 환경에서는 절대 안 되지만 테스트 환경에서는 문제 없는 방식을 뜻한다.
대게 메모리나 CPU 효율과 관련 잇는 경우다.
코드의 깨끗함과는 철저히 무관하다.
테스트 당 assert 하나
JUnit으로 테스트 코드를 짤 때 함수마다 assert 문을 하나만 사용해야 한다고 주장하는 학파가 있다.
(데이브 아스텔Dave Astel 블로그: https://www.artima.com/weblogs/viewpost.jsp?thread=35578)
목록 9-5를 보면 장점이 보이는데 assert 문이 단 하나인 함수는 결론이 하라나서 코드를 이해하기 쉽고 빠르다.
만약 assert 문을 두개 썼는데 하나로 합치는게 불합리하다면
테스트를 두 개로 쪼개 각자 assert를 수행하면 된다.
목록 9-7 SerializedPageResponderTest.java (단일 assert)
public void testGetPageHierarchyAsXml() throws Exception {
givenPages("PageOne", "PageOne.ChildOne", "PageTwo");
whenRequestIsIssued("root", "type:pages");
thenResponseShouldBeXML();
}
public void testGetPageHierarchyHasRightTags() throws Exception {
givenPages("PageOne", "PageOne.ChildOne", "PageTwo");
whenRequestIsIssued("root", "type:pages");
thenResponseShouldContain(
"<name>PageOne</name>", "<name>PageTwo</name>", "<name>ChildOne</name>"
);
}함수 이름에 given-when-then이라는 관례를 사용했다. 이는 테스트 코드를 읽기 쉽게 해준다.
하지만 테스트를 분리하면 중복 코드가 많아진다.
TEMPLATE METHOD 패턴을 사용하면 중복을 제거할 수 있다.
given/when 부분을 부모 클래스에 then 부분을 자식 클래스에 둔다.
혹은 @before에 given/when을 @test에 then을 둔다.
하지만 단순하게 asset문을 여러번 사용하는 것이 나을 수도 있다.
단일 assert문은 훌륭한 지침이다.
때로는 함수 하나에 여러 assert문을 넣기도 한다.
단지 assert 문 개수는 최대한 줄여야 좋다.
테스트 당 개념 하나
테스트 함수마나 한 개념만 테스트한다 라는 규칙이 더 좋은 표현일 수 있다.
아래 목록 9-8은 바람직하지 못한 테스트 함수다.
독자적인 개념 세 개를 테스트하므로 독자적인 테스트 세 개로 조개야 한다.
목록 9-8
/**
* addMonth() 메서드를 테스트하는 장황한 코드
*/
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());
}목록 9-8은 각 절에 assert 문이 여럿이 문제가 아니라 한 테스트 함수에서 여러 개념을 테스트한다는 사실이 문제다.
이제 가장 좋은 규칙은 아래와 같이 정리할 수 있다.
- 개념 당 assert 문 수를 최소로 줄여라
- 테스트 함수 하나는 개념 하나만 테스트하라
F.I.R.S.T
깨끗한 테스트는 다섯 가지 규칙을 따르는데, 각 규칙의 첫 글자를 따오면 FIRST가 된다.
- 빠르게Fast: 테스트는 빨라야 한다.
- 독립적으로Independent: 각 테스트는 서로 의존하면 안 된다.
- 반복가능하게Repeatable: 테스트는 어떤 환경에서도 반복 가능해야 한다.
- 자가검증하는Self-Validating: 테스트는 부울bool 값인 성공/실패로 결과를 내야 한다.
- 적시에Timely: 테스트는 적시에 작성해야 한다. 단위 테스트는 테스트하려는 실제 코드를 구현하기 직전에 구현한다.
결론
테스트 코드는 실제 코드만큼이나 프로젝트 건강에 중요하다.
테스트 코드는 실제 코드의 유연성, 유지보수성, 재사용성을 보존하고 강화한다.
그러므로 테스트 코드는 지속적으로 깨긋하게 관리하자.
표현력을 높이고 간결하게 정리하자.
테스트 API를 구현해 도메인 특화 언어DSL를 만들자.
그러면 그만큼 테스트 코드를 짜기가 쉬워진다.
참고 문헌
- [RSpec]: RSpec: Behavior Driven Development for Ruby Programmers, Aslak Hellesøy, David Chelimsky, Pragmatic Bookshelf, 2008.
- [GOF]: Design Patterns: Elements of Reusable Object Oriented Software, Gamma et al., Addison-Wesley, 1996.