Clean Code 요약해보기 (8)
9장 단위 테스트
TDD 법칙 세 가지
- 첫째 법칙: 실패하는 단위 테스트를 작성할 때까지 실제 코드를 작성하지 않는다.
- 둘째 법칙: 컴파일은 실패하지 않으면서 실행이 실패하는 정도로만 단위 테스트를 작성한다.
- 셋째 법칙: 현재 실패하지 테스트를 통과할 정도로만 실제 코드를 작성한다.
이렇게 일하면 실제 코드를 사실상 전부 테스트하는 테스트 케이스가 나온다.
하지만 실제 코드와 맞먹을 정도로 방대한 테스트 코드는 심각한 관리 문제를 유발하기도 한다.
깨끗한 테스트 코드 유지하기
지저분한 테스트 코드는 테스트를 안하느니만도 못하다.
테스트 코드가 복잡하면 실제 코드를 짜는 시간보다 테스트 케이스를 추가하는 시간이 더 걸리기 쉽상이다.
이 상황이 유지하자보면 결국 테스크 슈트를 폐기하고, 코드가 망가지고, 결함율이 높아진다.
테스트는 유연성, 유지보수성, 재사용성을 제공한다
테스트 케이스가 없다면 모든 변경이 잠정적인 버그다. 하지만 테스트 케이스가 있다면
변경했을 때 버그가 생길 거라는 공포가 사라진다. 안심하고 아키텍처와 설계를 개선할 수 있다.
그러므로 실제 코드를 점검하는 자동화된 단위 테스트 슈트는 설계와 아키텍처를 최대한 깨끗하게 보존하는 열쇠다.
깨끗한 테스트 코드
깨끗한 테스트 코드에는 세 가지가 필요하다. 가독성, 가독성, 가독성.
명료하고 단순하며 풍부한 표현력이 필요하다.
아래 SerializedPageResponderTest.java 코드를 보자.
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);
}PathParser 호출을 살펴보자. PathParser는 문자열을 pagePath 인스턴스로 변환한다.
pagePath는 웹 로봇(crawler)이 사용하는 객체다. 이 코드는 테스트 코드와 무관하며 테스트 코드의 의도만 흐린다.
responser 객체를 생성하는 코드와 response를 수집해 변환하는 코드 역시 필요 없다.
resources와 인수에서 요청 URL을 만드는 어설픈 코드도 보인다.
마지막으로 이 코드는 읽는 사람을 고려하지 않는다. 온갖 잡다하고 무관한 코드를 이해한 후에야 간신히 테스트 케이스를 이해한다.
이를 개선한 코드를 보자.
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 패턴이 위와 같은 테스트 구조에 적합하다.
각 테스트는 명확히 세 부분으로 나눠진다.
첫 부분은 테스트 자료를 만든다.
두 번째는 테스트 자료를 조작한다.
세 번째는 조작한 결과가 올바른지 확인한다.
도메인에 특화된 테스트 언어
위 코드는 도메인에 특화된 언어(DSL)로 테스트 코드를 구현하는 기법을 보여준다.
흔히 쓰는 시스템 조작 API를 사용하는 대신 API 위에다 함수와 유틸리티를 구현한 후
그 함수와 유틸리티를 사용하므로 테스트 코드를 짜기도 읽기도 쉬워진다.
이렇게 구현한 함수와 유틸리티는 테스트 코드에서 사용하는 특수 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());
}이 코드는 세세하게 설명은 없지만 온도가 '급격하게 떨어지면' 경보, 온풍기, 송풍기가
모두 가동되는지 확인하는 코드라는 사실이 드러난다.
근데 위 코드는 상태 이름과 상태 값을 확인하느라 읽는 것이 자연스럽지 않다.
heaterState라는 상태를 보고나서 왼쪽으로 눈길을 돌려 assertTrue를 보게 된다.
그래서 이것도 수정해보자
@Test
public void turnOnLoTempAlarmAtThreshold() throws Exception {
wayTooCold();
assertEquals("HBchL", hw.getState());
}앞서 있던 (무슨 역할인지 알 수 없던) tic 함수는 wayTooCold 안에 숨겼다.
assertEquals에 있는 HBchL은 무엇일까?
대문자는 켜짐(on)이고, 소문자는 꺼짐(off)를 씃한다. 각각 heater, blower, cooler, hi-temp-alarm, lo-temp-alarm의 앞글자다.
이 방식은 그릇된 정보를 피하라는 규칙의 위반에 가깝지만 여기서는 적절해 보인다.
의미만 안다면 눈길이 문자열을 따라 움직이며 결과를 재빨리 판단한다.
다음 코드를 보면 이 테스트 코드를 이해하기 너무도 쉽다는 사실이 분명히 드러난다.
@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());
}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는 보기에 흉하다. 글쓴이는 실제 코드에서도 크게 무리가 아니라면 StringBuffer를 피한다.
또한 테스트 케이스에서는 자원이 제한적일 가능성이 낮아 큰 무리가 없다.
이것이 이중 표준의 본질이다. 실제 환경에서는 절대로 안 되지만 테스트 환경에서는 전혀 문제 없는 방식이 있다.
테스트 당 assert 하나
JUnit으로 테스트 코드를 짤 때마다 함수마다 assert 문을 단 하나만 사용해야 한다고 주장하는 학파가 있다.
가혹한 규칙이라 여길지도 모르지만, 아까 turnOnCooler~ 와 같은 테스트 코드를 보면 확실히 장점이 있다.
하지만 위 내용 중 (개선했던)SerializedPageResponderTest.java 코드를 보자.
"출력이 XML이다" 라는 assert문과 "특정 문자열을 포함한다"는 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>"
);
}위에서 함수 이름을 바꿔 given-when-then이라는 관례를 사용했다는 사실에 주목하자.
이를 이용해 코드 읽기가 편해진다.
하지만 중복된 코드도 많아진다.
Template Method 패턴을 사용하면 중복을 제거할 수 있다.
iven/when 부분을 부모 클래스에 두고 then 부분을 자식 클래스에 두면 된다.
아니면 완전히 독자적인 클래스를 만들어 @Before 함수에 given/when 부분을 넣고
@Test 함수에 then 부분을 넣어도 된다. 하지만 모두가 배보다 배꼽이 크다.
이것저것 감안하면 기존의 (개선했던) SerializedPageResponderTest.java 코드가 좋은 면도 있다.
따라서 단일 assert 문이라는 규칙은 좋지만 때로는 여러 개를 넣어도 좋다.
되도록 assert문은 줄이는 방향으로 코드를 작성해보자.
테스트 당 개념 하나
어쩌면 "테스트 함수마다 한 개념만 테스트하라" 라는 규칙이라고 봐도 된다.
이것저것 잡다한 개념을 연속으로 테스트하는 긴 함수는 피하자.
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());
}위 코드 같은 경우 개념 세 개를 테스트하므로 독자적인 테스트 세 개로 쪼개는 것이 좋다.
몰아넣어져 있으면 독자가 각 절이 거기에 존재하는 이유와 각 절이 테스트하는 개념을 모두 이해해야한다.
셋으로 분리한 테스트 함수는 각각 다음 기능을 수행한다.
- (5월처럼) 31일로 끝나는 달의 마지막 날짜가 주어지는 경우
- (6월처럼) 30일로 끝나는 한 달을 더하면 날짜는 30일이 되어야지 31일이 되어서는 안 된다.
- 두 달을 더하면 그리고 두 번째 달이 31일로 끝나면 날짜는 31일이 되어야 한다.
- (6월처럼) 30일로 끝나는 달의 마지막 날짜가 주어지는 경우
- 31일로 끝나는 한 달을 더하면 날짜는 30일이 되어야지 31일이 되면 안 된다.
이렇게 표현하면 장황한 테스트 코드 속에 감춰진 일반적인 규칙이 보인다.
날짜에 어떤 달을 더하면 날짜는 그 달의 마지막 날짜보다 커지지 못한다.
즉, 2월 28일에 한 달을 더하면 3월 28일이 나와야 한다는 말이다. 여기서는 바로 이런 테스트가 빠졌으므로 채워 넣으면 좋다.
따라서 위 테스트 코드는 assert문이 여러 개라는 점은 문제가 되지 않는다.
한 테스트 함수에서 여러 개념을 테스트한다는 사실이 문제다.
따라서 가장 좋은 규칙은
- 개념 당 assert 문 수를 최소로 줄여라
- 테스트 함수 하나는 개념 하나만 테스트 하라
라 할 수 있다.
F.I.R.S.T
깨끗한 테스트는 다섯 가지 규칙이 있다.
- Fast : 테스트는 빨라야 한다. 느리면 자주 돌릴 염두를 못 낸다. 자주 돌리지 못하면 문제를 찾지 못하고 품질이 망가진다.
- Independent: 각 테스트는 서로 의존하면 안 된다. 의존하면 하나가 실패할 때 나머지도 실패하면서 결함을 찾기 어려워진다.
- Repeatable: 어떤 환경에서도 반복 가능해야 한다. 테스트가 돌아가지 않는 환경이 하나라도 있다면 테스트가 실패한 이유를 둘러댈 변명이 생긴다.
- Self-Validating: 테스트는 bool 값으로 결과를 내야 한다. 성공 아니면 실패다. 통과 여부를 알려고 로그 파일을 읽게 만들어서는 안 된다. 테스트가 스스로 성공과 실패를 가늠하지 않는다면 판단은 주관적이 되며 지루한 수작업 평가가 필요하게 된다.
- Timely(적시에): 테스트는 적시에 작성해야 한다. 단위 테스트는 테스트하려는 실제 코드를 구현하기 직전에 구현한다. 실제 코드를 구현한 다음에 테스트 코드를 만들면 실제 코드가 테스트하기 어렵다는 사실을 발견할지도 모른다. 어떤 실제 코드는 테스트하기 너무 어렵다고 판명날지 모른다. 테스트가 불가능하도록 실제 코드를 설계할지도 모른다.
결론
사실상 깨끗한 테스트 코드라는 주제는 책 한 권을 할애해도 모자랄 주제다.
테스트 코드는 실제 코드만큼이나 프로젝트 건강에 중요하다. 테스트 코드를 꺠끗하게 유지하자.