CS CleanCode - 단위 테스트

1997년만 해도 TDD라는 개념을 몰랐다. 대다수가 단위 테스트란 프로그램이 '돌아간다'는 사실만 확인하는 일회성 코드에 불과했다. 직접 수동으로 테스트를 수행하고, 그로고 나서는 테스트 코드를 버렸다.

우리 분야는 지금까지 눈부신 성장을 이뤘지만 앞으로 갈 길은 여전히 멀다. 에자일과 TDD 덕택에 단위 테스트를 자동화하는 프로그래머들이 이미 많아졌으며 점점 늘어나는 추세다. 하지만 테스트를 추가하려고 급하게 서두르는 와중에 제대로된 테스트 케이스를 작성해야 한다는 사실을 놓쳐버렸다.

 

TDD 법칙 세 가지

1. 실패하는 단위 테스트를 작성할 때까지 실제 코드를 작성하지 않는다.
2. 컴파일은 실패하지 않으면서 실행이 실패하는 정도로만 단위 테스트를 작성한다.
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);
}

위 코드는 읽는 사람을 고려하지 않는다. 불쌍한 독자들은 온갖 잡다하고 무관한 코드를 이해한 후에 테스트 코드를 이해한다.

• addPage, assertSubString을 부르느라 중복되는 코드가 매우 많다.
• PathParser가 pagePath를 만들고, crawler가 pagePath를 사용한다. 이 코드는 테스트와 무관하며, 의도만 흐린다.
• responder 객체를 생성하는 코드와 response를 수집해 변환하는 코드 역시 잡음에 불과하다.

 

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 패턴이 위와 같은 테스트 구조에 적합하다.

• BUILD : 테스트 자료를 만든다.
• OPERATE : 자료를 조작한다.
• CHECK : 조작한 결과가 올바른지 확인한다.

잡다하고 세세한 코드를 거의 다 없앴다는 사실에 주목한다. 테스트 코드는 본론에 돌입해 진짜 필요한 자료 유형과 함수만 사용한다.

 

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

시스템 조작 API를 사용하는 대신 API 위에다 함수와 유틸리티를 구현하여 사용하면 테스트 코드를 짜거나 읽기에 쉬워진다. 즉 테스트를 구현하는 당사자와 나중에 테스트를 읽어볼 독자를 도와주는 테스트 언어다.

이런 테스트 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를 읽고, coolerState를 보고 assertFalse를 읽는다. 따분하고 미덥잖다. 테스트 코드를 읽기가 어렵다.

 

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

@Test
public void turnOnCoolerAndBlowerIfTooHot() throws Exception {
    tooHot();
    assertEquals("hBChl", hw.getState()); 
}

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

일단 의미만 안다면 눈길이 문자열을 따라 움직이며 결과를 재빨리 판단한다. 테스트 코드를 읽기가 사뭇 즐거워진다.

비트마스크로 표현하면 유지보수 측면에서 더 이득일 수도 있고, String을 StringBuilder로 바꾸면 성능상 이점이 있을 수 있습니다. 하지만 가독성 측면에서 String이 훨씬 보기 편하기 때문에 테스트 상황 한해서 이득일 수 있습니다.

 

테스트 당 assert 하나

JUnit으로 테스트 코드를 작성할 때 함수마다 assert 문을 단 하나만 사용해야 한다고 주장하는 학파가 있다. 가혹한 규칙이라 여길지도 모르지만 확실히 장점이 있다. assert 문이 단 하나인 함수는 코드를 이해하기 쉽고 빠르다. 하지만 불행하게도 테스트 케이스를 분리하면 중복되는 코드가 많아진다. Template Method 패턴을 이용하거나 클래스를 만들어 @Before 함수에 사용하면 중복을 줄일 수 있다. 하지만 모두 배보다 배꼽이 크다.

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

 

테스트 당 개념 하나

이것저것 잡다한 개념을 연속으로 테스트하는 긴 함수는 피한다. 여러 개념이 한 함수로 몰아넣으면 독자가 각 절이 존재하는 이유와 각 절이 테스트 하는 개념을 모두 이해해야 한다. 그러므로 가장 좋은 규칙은 "개념 당 assert 문 수를 최소로 줄여라"와 "테스트 함수 하나는 개념 하나만 테스트하라"라 하겠다.

 

F.I.R.S.T.

• 빠르게(Fast) : 테스트는 빨라야 한다. 테스트가 느리면 자주 돌릴 엄두를 못 낸다. 결국 코드 품질이 망가지기 시작한다.
• 독립적으로(Independent) : 각 테스트는 독립적으로 그리고 어떤 순서로 실행되도 괜찮아야 한다. 테스트가 서로에게 의존하면 하나가 실패할 때 잇달아 실패하므로 원인을 진단하기 어려워진다.
• 반복가능하게(Repeatable) : 테스트는 어떤 환경에서도 반복 가능해야 한다. 실제 환경, QA 환경, 네트워크가 안되는 환경에서도 실행할 수 있어야 한다. 테스트가 돌아가지 않는 환경이 있다면 실패한 이유를 둘러댈 변명이 생기고, 환경이 지원하지 않기에 테스트를 수행할 수 없는 상황에 직면한다.
• 자가검증하는(Self-Validating) : 테스트는 부울값으로 결과를 내야 한다. 성공 아니면 실패다. 테스트가 스스로 성공과 실패를 가늠하지 않는다면 판단은 주관적이 되며 지루한 수작업 평가가 필요하게 된다.
• 적시에(Timely) : 테스트는 적시에 작성해야 한다. 단위 테스트는 테스트하려는 실제 코드를 구현하기 직전에 구현한다. 실제 코드를 구현한 다음에 테스트 코드를 만들면 실제 코드가 테스트하기 어렵다는 사실을 발견할지도 모른다.

 

결론

테스트 코드가 방치되어 망가지면 실제 코드도 망가진다. 테스트 코드를 개끗하게 유지하자. 테스트 코드는 실제 코드만큼이나 프로젝트 건강에 중요하다. 어쩌면 실제 코드보다 더 중요할지도 모르겠다.

• 표현력을 높이고 간결하게 정리하기
• DSL 만들어서 사용하기