[Clean Code] 9장 단위테스트

애자일과 TDD덕택에 단위 테스트를 자동화하는 프로그래머들이 이미 많아졌으며 점점 더 늘어나는 추세다. 하지만 우리 분야에 테스트를 추가하려고 급하게 서두르는 와중에 많은 프로그래머들이 제대로 된 테스트 케이스를 작성해야 한다는 좀 더 미묘한 사실을 놓쳐버렸다.

 

 

 

 

 

 

 

---

TDD 법칙 세가지

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

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

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

---

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

테스트를 안 하느니 지저분한 테스트 코드라도 있는 편이 좋다고 판단하면 안된다.

나중에 실제 코드가 진화하거나 변화가 생기면 그에 따른 테스트 코드도 변해야 한다. 테스트 코드가 복잡할수록 실제 코드를 짜는 시간보다 테스트 케이스를 추가하는 시간이 더 걸리기 십상이다.

이는 악순환의 반복이다. 결국 테스트를 포기하게 되고 개발자는 자신의 코드가 잘 작동하는지 알 길이 없어진다.

결국 테스트 코드는 실제 코드 못지 않게 중요하다. 

테스트 코드는 이류 시민이 아니다. 테스트 코드는 사고와 설계와 주의가 필요하다. 실제 코드 못지 않게 깨끗하게 짜야 한다.

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

테스트 케이스가 있으면 버그에 대한 공포가 사라지고 변경이 쉬워진다. 따라서 테스트 코드가 지저분하면 코드를 변경하는 능력이 떨어지며 코드 구조를 개선하는 능력도 떨어진다. 테스트 코드가 지저분할수록 실제 코드도 지저분해진다. 결국 테스트 코드를 잃어버리고 실제 코드도 망가진다.

---

깨끗한 테스트 코드

깨끗한 테스트 코드는 3가지가 필요하다. 가독성, 가독성, 가독성!

명료성, 단순성, 풍부한 표현력이 필요하다.

public void testGetPageHieratchyAsXml() throws Exception
{
 crawler.addPage(root, PathParser.parse("PageOne"));
 crawler.addPage(root, PathParser.parse("PageOne.ChildOne"));
 crawler.addPage(root, PathParser.parse("PageTwo"));
 request.setResource("root");
 request.addInput("type", "pages");
 Responder responder = new SerializedPageResponder();
 SimpleResponse response =
 (SimpleResponse) responder.makeResponse(
 new FitNesseContext(root), request);
 String xml = response.getContent();
 assertEquals("text/xml", response.getContentType());
 assertSubString("<name>PageOne</name>", xml);
 assertSubString("<name>PageTwo</name>", xml);
 assertSubString("<name>ChildOne</name>", xml);
}
public void testGetPageHieratchyAsXmlDoesntContainSymbolicLinks()
throws Exception
{
 WikiPage pageOne = crawler.addPage(root, PathParser.parse("PageOne"));
 crawler.addPage(root, PathParser.parse("PageOne.ChildOne"));
 crawler.addPage(root, PathParser.parse("PageTwo"));
  PageData data = pageOne.getData();
 WikiPageProperties properties = data.getProperties();
 WikiPageProperty symLinks = properties.set(SymbolicPage.PROPERTY_NAME);
 symLinks.set("SymPage", "PageTwo");
 pageOne.commit(data);
 request.setResource("root");
 request.addInput("type", "pages");
 Responder responder = new SerializedPageResponder();
 SimpleResponse response =
 (SimpleResponse) responder.makeResponse(
 new FitNesseContext(root), request);
 String xml = response.getContent();
 assertEquals("text/xml", response.getContentType());
 assertSubString("<name>PageOne</name>", xml);
 assertSubString("<name>PageTwo</name>", xml);
 assertSubString("<name>ChildOne</name>", xml);
 assertNotSubString("SymPage", xml);
}
public void testGetDataAsHtml() throws Exception
{
 crawler.addPage(root, PathParser.parse("TestPageOne"), "test page");
 request.setResource("TestPageOne");
 request.addInput("type", "data");
 Responder responder = new SerializedPageResponder();
 SimpleResponse response =
 (SimpleResponse) responder.makeResponse(
 new FitNesseContext(root), request);
 String xml = response.getContent();
 assertEquals("text/xml", response.getContentType());
 assertSubString("test page", xml);
 assertSubString("<Test", xml);
}

위 코드는 너무 복잡하며 테스트 코드의 의도만 흐린다. 또 잡다하고 무관한 코드까지 이해해야 테스트 케이스를 이해한다.

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");
}

위의 코드가 깔끔하고 명료하며 더 이해하기 쉽다.

 

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

이는 처음부터 설계된 API가 아니고 잡다하고 세세한 사항으로 범벅된 코드를 계속 리팩터링하다가 진화된 API다.

숙련된 개발자라면 자기 코드를 좀 더 간결하고 표현력이 풍부한 코드로 리팩터링해야 마땅하다.

 

-이중 표준

실제 환경과 테스트 환경은 요구사항이 다른만큼 판이하게 개발하는 방법이 다르다.

@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());
 }

위 코드는 이것 저것 너무 많이 체크 한다.

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

---

테스트 당 assert 하나

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>"
 );
}

하지만 이는 중복 코드를 야기하고 중복 코드를 우회하려면 다른 복잡성을 유발한다.

 

-결국 테스트 당 개념 하나

/**
 * 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.R.I.S.T

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

 

Fast(빠르게) : 테스트는 빨리 돌아야 한다.

 

Independent(독립적으로) : 각 테스트는 서로 의존하면 안 된다.

 

Repeatable(반복가능하게) : 테스트는 어떠 환경에서도 반복 가능해야 한다.

 

Self-Validating(자가 검증하는) : 성공 아니면 실패다.

 

Timely(적시에) : 테스트는 적시에 작성해야 한다.

---

결론

테스트 코드는 지속적으로 깨끗하게 관리하자. 표현력을 높이고 간결하게 정리하자. 테스트 API를 구현해 도메인 특화 언어를 만들자.