[개발서적] Clean Code 9. 단위 테스트

Book Notes

[개발서적] Clean Code 9. 단위 테스트

feel2 2025. 10. 24. 22:35

[TDD 법칙 세가지]

다음 세 가지 법칙을 살펴보자.

실패하는 단위 테스트를 작성할 때까지 실제 코드를 작성하지 않는다.
컴파일은 실패하지 않으면서 실행히 실패하는 정도로만 단위 테스트를 작성한다.
현재 실패하는 테스트를 통과할 정도로만 실제 코드를 작성한다.

위 세 가지 규칙을 따르면 개발과 테스트가 대략 30초 주기로 묶인다.

이렇게 일하면 매일 수십 개, 매달 수백 개, 매년 수천 개에 달하는 테스트 케이스가 나온다.

하지만, 실제 코드와 맞먹을 정도로 방대한 테스트 코드는 심각한 관리 문제를 유발하기도 한다.

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

테스트 코드는 지저분할수록 변경이 어려워진다.

테스트 코드는 실제 코드 못지 않게 중요하다. 테스트 코드는 이류 시민이 아니다.

테스트 코드는 사고와 설계와 주의가 필요하다!

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

테스트 코드를 깨끗하게 유지하지 않으면 결국은 잃어버린다.

그리고 테스트 케이스가 없으면 실제 코드를 유연하게 만드는 버팀목도 사라진다.

결국 코드에 유연성, 유지보수성, 재사용성을 제공하는 버팀목이 바로 단위테스트다.

왜냐하면 테스트 케이스가 있으면 변경이 두렵지 않기 때문이다!

그러므로 실제 코드를 점검하는 자동화된 단위 테스트 슈트는 설계와 아키텍처를 최대한 깨끗하게 보존하는 열쇠다.

테스트 케이스가 있으면 변경이 쉬워지기 때문이다.

[깨끗한 테스트 코드]

깨끗한 테스트 코드를 만들려면? 세 가지가 필요하다. 가독성, 가독성, 가독성…

테스트 코드에서 가독성을 높이려면? 명료성, 단순성, 풍부한 표현력이 필요하다.

목록 9-1은 FitNess에서 가져온 코드다. 아래 테스트 케이스 세 개는 이해하기 어려워 개선할 여지가 충분하다.

목록 9-1 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);
}

일단 위 코드를 보면 중복되는 코드가 매우 많다.

또한 pagePath는 웹 로봇(crawler)이 사용하는 객체다. 이 코드는 테스트 코드와 무관하다.

response 객체를 생성하는 코드와 response를 수집해 변환하는 코드 역시 잡음에 불과하다.

이제 목록 9-2를 살펴보자.

목록 9-2 SerializedPageResponderTest.java (리팩터링한 코드)

public void testGetPageHieratchyAsXml() throws Exception {
  makePages("PageOne", "PageOne.ChildOne", "PageTwo");
  
  submitRequest("root", "type:pages");
  
  assertResponseIsXML();
  assertResponseContains(
    "<name>PageOne</name>", "<name>PageTwo</name>", "<name>ChildOne</name>"
  );
}

public void testGetPageHieratchyAsXmlDoesntContainSymbolicLinks()
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 testGetDataAsHtml() throws Exception {
  makePageWithContent("TestPageOne", "test page");
  
  submitRequest("TestPageOne", "type:data");
  
  assertResponseIsXML();
  assertResponseContains("test page", "<Test");
}

BUILD-OPERATE-CHECK 패턴이 위와 같은 테스트 구조에 적합하다.

각 테스트는 명확히 세 부분으로 나뉜다.

첫 부분은 테스트 자료를 만들고
두 번째 부분은 테스트 자료를 조작하며
세 번째 부분은 조작한 결과가 올바른지 확인한다.

도메인에 특화된 언어

목록 9-2는 도메인에 특화된 언어(DSL)로 테스트 코드를 구현하는 기법을 보여준다.

흔히 쓰는 시스템 조작 API 대신 API 위에다 함수와 유틸리티를 구현한 후 그 함수와 유틸리티를 사용하므로 테스트 코드를 짜기도 읽기도 쉬워진다.

이렇게 구현한 함수와 유틸리티는 테스트 코드에서 사용하는 특수 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을 읽으면 코드에서 점검하는 상태 이름과 상태 값을 확인하느라 눈길이 이리저리 흩어진다.

그래서 목록 9-4로 변환해 코드 가독성을 높였다.

목록 9-4 EnvironmentControllerTest.java (리팩터링)

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

당연히 tic 함수는 wayTooCold 라는 함수를 만들어 숨겼다.

assertEquals에 들어가는 문자열의 의미는 대문자는 켜짐(on)이고, 소문자는 꺼짐(off)의 뜻이다.

문자는 항상 {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 MockControllerHardware.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;
}

StringBuffer는 보기 흉하다. 나는 실제 코드에서도 크게 무리가 아니라면 StringBuffer를 피한다.

StringBuffer를 안 써서 치르는 대가는 미미하다.

하지만 이 애플리케이션은 확실히 실시간 임베디드 시스템이다.

즉, 컴퓨터 자원과 메모리가 제한적일 가능성이 높다.

하지만 테스트 환경에서는 자원이 제한적일 가능성이 낮다.

이것이 이중 표준의 본질이다. 실제 환경에서는 절대로 안 되지만, 테스트 환경에서는 문제가 없다.

[테스트당 assert 하나]

JUnit으로 테스트 코드를 짤 때 함수마다 assert 문을 하나만 사용해야 한다고 주장하는 학파가 있다.

나는 ‘단일 assert 문’이라는 규칙이 훌륭한 지침이라 생각한다.

대체로 나는 단일 assert를 지원하는 해당 분야 테스트 언어를 만들려 노력한다.

하지만 때로는 주저 없이 함수 하나에 여러 assert 문을 넣기도 한다.

단지 assert 문 개수는 최대한 줄여야 좋다고 생각한다.

테스트당 개념 하나

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

목록 9-8은 바람직하지 못한 테스트 함수다. 독자적인 테스트 세 개로 쪼개야 마땅하다.

목록 9-8

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

셋으로 분리한 테스트 함수는 각각 다음 기능을 수행한다.

(5월처럼) 31일로 끝나는 달의 마지막 날짜가 주어지는 경우
- (6월처럼) 30일로 끝나는 한 달을 더하면 날짜는 30일이 되어야지 31일이 되어서는 안 된다.
- 두 달을 더하면 그리고 두 번째 달이 31일로 끝나면 날짜는 31일이 되어야 한다.
(6월처럼) 30일로 끝나는 달의 마지막 날짜가 주어지는 경우
- 31일로 끝나는 한 달을 더하면 날짜는 30일이 되어야지 31일 되면 안 된다.

목록 9-8은 각 절에 assert문이 여럿이라 문제가 아니다.

한 테스트 함수에서 여러 개념을 테스트한다는 사실이 문제다.

그러므로 가장 좋은 규칙은

“개념 당 assert 문 수를 최소로 줄여라”
“테스트 함수 하나는 개념 하나만 테스트하라”

라고 볼 수 있겠다.

[FIRST]

깨끗한 테스트는 다음 다섯 가지 규칙을 따르는데, 각 규칙의 첫 글자를 따면 FIRST가 된다.

빠르게(Fast)

테스트는 빨라야 한다.

자주 돌리지 못하면 초반에 문제를 찾아내 고치지 못한다. 결국 코드 품질이 망가진다.

독립적으로(Independent)

각 테스트는 서로 의존하면 안 된다. 한 테스트가 다음 테스트가 실행될 환경을 준비해서는 안 된다.

각 테스트는 독립적으로 그리고 어떤 순서로 실행해도 괜찮아야 한다.

반복가능하게(Repeatable)

테스트는 어떤 환경에서도 반복 가능해야 한다.

실제 환경, QA 환경, 버스를 타고 집으로 가는 길에 사용하는(네트워크 X) 환경에서도 되어야 한다.

자가검증하는(Self-Validating)

테스트는 부울(bool) 값으로 결과를 내야 한다. 성공 아니면 실패다.

통과 여부를 알려고 로그 파일을 읽게 만들어서는 안 된다.

적시에(Timely)

테스트는 적시에 작성해야 한다.

단위 테스트는 테스트하려는 실제 코드를 구현하기 전에 구현한다.

실제 코드를 구현한 다음에 테스트 코드를 만들면 실제 코드가 테스트하기 어렵다는 사실을 발견할지 모른다.

[결론]

테스트 코드는 실제 코드만큼이나 프로젝트 건강에 중요하다.

테스트 코드는 실제 코드의 유연성, 유지보수성, 재사용성을 보존하고 강화하기 때문이다.

그러므로 테스트 코드는 지속적으로 깨끗하게 관리하자.

'Book Notes' 카테고리의 다른 글

[개발서적] Clean Code 11. 시스템 (0)	2025.10.28
[개발서적] Clean Code 10. 클래스 (0)	2025.10.28
[개발서적] Clean Code 8. 경계 (0)	2025.10.24
[개발서적] Clean Code 7. 오류 처리 (0)	2025.10.23
[개발서적] Clean Code 6. 객체와 자료 구조 (1)	2025.10.22

현재글[개발서적] Clean Code 9. 단위 테스트

feel_2

안녕하세요, 대체 불가능한 개발자(NFE) 박경태입니다.

테스트코드, 백엔드, 코딩테스트 준비, 개발서적, Til, cleancode, 클린아키텍처, 개발자, 필독서, it, 바닐라코딩, Spring, 항해99, 개발자 취업, CleanArchitecture, backend, 개발, 클린코드, 학습 후기, 99클럽,

Today :
Yesterday :

feel_2