[Clean Code] 9. 단위 테스트 - 클린 코드 정독하기

TDD 법칙 세 가지

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

 

위 세 규칙을 따르면 테스트 코드와 실제 코드가 함께 나올 뿐만 아니라 매일 수십 개에 달하는 테스트 케이스가 나온다. 실제 코드를 사실상 전부 테스트하는 테스트 케이스가 나온다.

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

 

 

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

지저분한 테스트 코드는 테스트를 안 하는 것보다 못하다. 실제 코드가 진화하면 테스트 코드도 변해야 한다.

• 테스트 코드가 지저분할수록 변경하기 어려워진다.
• 테스트 코드가 복잡할수록 실제 코드를 짜는 시간보다 테스트 케이스를 추가하는 시간이 더 걸리기 십상이다.
• 실제 코드를 변경해 기존 테스트 케이스가 실패하기 시작하면, 지저분한 코드로 인해 실패하는 테스트 케이스를 점점 더 통과시키기 어려워진다.

 

새 버전을 출시할 때마다 팀이 테스트 케이스를 유지하고 보수하는 비용도 늘어난다. 점차 테스트 코드는 개발자 사이에서 가장 큰 불만으로 자리 잡는다. 이는 결국 테스트 슈트를 폐기하지 않으면 안 되는 상황에 처한다.

하지만 테스트 슈트가 없으면 개발자는 자신이 수정한 코드가 제대로 도는지 확인할 방법이 없다. 시스템의 한 곳을 수정해도 다른 곳이 안전하다는 사실을 검증하지 못한다.

• 결함률이 높아지기 시작하며 의도하지 않은 결함 수가 많아지면 변경을 주저하게 된다.
• 변경하면 득 보다 해가 크다 생각해 더 이상 코드를 정리하지 않는다.

 

이러한 실패를 초래한 원인은 테스트 코드를 깨끗하게 유지하지 못했기 때문이다. 테스트 코드를 깨끗하게 짰다면 테스트에 쏟아부은 노력은 허사로 돌아가지 않을 것이다.

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

 

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

코드에 유연성, 유지보수성, 재사용성을 제공하는 버팀목이 바로 단위 테스트다. 테스트 케이스가 있으면 변경이 두렵지 않기 때문이다. 만약, 테스트 케이스가 없다면 모든 변경이 잠정적인 버그다. 아무리 아키텍처가 유연하더라도, 설계를 아무리 잘 나눴더라도, 테스트 케이스가 없으면 개발자는 변경을 주저한다.

 

하지만 테스트 케이스가 있다면 공포는 사실상 사라진다. 테스트 커버리지가 높을수록 공포는 줄어든다. 아키텍처가 부실한 코드나 설계가 모호하고 엉망인 코드라도 별다른 우려 없이 변경할 수 있으며, 오히려 안심하고 아키텍처와 설계를 개선할 수 있다.

• 실제 코드를 점검하는 자동화된 단위 테스트 슈트는 설계와 아키텍처를 최대한 깨끗하게 보존하는 열쇠다.
• 테스트는 유연성, 유지보수성, 재사용성을 제공한다.

 

따라서 테스트 코드가 지저분하면 코드를 변경하는 능력이 떨어지며 코드 구조를 개선하는 능력도 떨어진다. 테스트 코드가 지저분할수록 실제 코드도 지저분해진다.

결국 테스트 코드를 잃어버리고 실제 코드도 망가진다.

 

 

깨끗한 테스트 코드

깨끗한 테스트 코드를 만들기 위해 가장 중요한 것은 가독성이다. 어쩌면 가독성은 실제 코드보다 테스트 코드에 더욱 중요하다.

테스트 코드에서 가독성을 높이기 위해서는 명료성, 단순성, 풍부한 표현력이 필요하다. 테스트 코드는 최소의 표현으로 많은 것을 나타내야 한다.

 

다음은 FitNess에서 가져온 코드다. 아래 코드 세 개의 테스트 케이스는 개선의 여지가 많다.

• addPage와 assertSubString을 부르는 중복되는 코드가 매우 많다.
• 자질구레한 사항이 너무 많아 테스트 코드의 표현력이 떨어진다.

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

예를 들어, PathParser의 호출을 살펴보자. PathParser는 문자열을 pagePath 인스턴스로 변환한다. pagePath는 웹 로봇(crawler)이 사용하는 객체다. 이 코드는 테스트와 무관하며 테스트 코드의 의도만 흐린다.

responder 객체를 생성하는 코드와 response를 수집해 변환하는 코드 역시 잡음에 불과하다. 게다가 resource와 인수에서 요청 URL을 만드는 어설픈 코드도 보인다.

마지막으로 위 코드는 읽는 사람을 고려하지 않는다. 위 코드를 읽는 사람은 온갖 잡다하고 무관한 코드를 이해한 후에야 간신히 테스트 케이스를 이해한다.

 

다음은 위 코드를 개선한 코드로 정확히 동일한 테스트를 수행한다.

[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 패턴이 적합하다. 각 테스트는 명확히 세 부분으로 나눠진다.

1. 테스트자료를 만든다.
2. 테스트 자료를 조작한다.
3. 조작한 결과가 올바른지 확인한다.

잡다하고 세세한 코드를 거의 다 없앴다는 사실에 주목한다. 테스트 코드는 본론에 돌입해 진짜 필요한 자료 유형과 함수만 사용한다. 그러므로 코드를 읽는 사람은 온갖 잡다하고 세세한 코드에 주눅 들고 헷갈릴 필요 없이 코드가 수행하는 기능을 재빨리 이해한다.

 

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

위에서 살펴본 코드는 도메인에 특화된 언어(DSL)로 테스트 코드를 구현하는 기법을 보여준다. 흔히 쓰는 시스템 조작 API를 사용하는 대신 API 위에다 함수와 유틸리티를 구현한 후 그 함수와 유틸리티를 사용하므로 테스트 코드를 짜기도 읽기도 쉬워진다. 이렇게 구현한 함수와 유틸리티는 테스트 코드에서 사용되는 특수 API가 된다. 즉, 테스트를 구현하는 당사자와 나중에 테스트를 읽어볼 독자를 도와주는 테스트 언어다.

이런 테스트 API는 처음부터 설계된 API가 아니다. 잡다하고 세세한 사항으로 범벅된 코드를 계속 리팩토링 하다가 진화된 API다. 숙련된 개발자라면 자기 코드를 좀 더 간결하고 표현력이 풍부한 코드로 리팩토링해야 마땅하다.

 

이중 표준

테스트 API 코드에 적용하는 표준은 실제 코드에 적용하는 표준과 다르다. 단순하고, 간결하고, 표현력이 풍부해야 하지만, 테스트 환경에서 돌아가는 코드이기 때문에 실제 코드만큼 효율적일 필요는 없다. 실제 환경과 테스트 환경은 요구사항이 매우 다르다.

 

다음 코드는 저자가 프로토타입으로 제작하던 환경 제어 시스템에 속한 테스트 코드다.

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

세세하게 설명하지 않더라도 온도가 ‘급격하게 떨어지면’ 경보, 온풍기, 송풍기가 모두 가동되는지 확인하는 코드라는 사실이 드러난다.

• tic() 메서드가 무엇 인지 지금은 신경 쓰지 말자.
• heaterState라는 상태 이름을 확인하고 assertTrue를 읽는다.
• 이런 식으로 모든 상태를 확인해야 하면 읽기가 어렵다.

 

위 코드를 다음과 같이 변환하여 코드 가독성을 크게 높일 수 있다.

[9-4] EnvironmentControllerTest.java (리팩토링)

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

• wayTooCold라는 함수를 만들어 tic 함수를 숨겼다. assertEquals에 들어 있는 문자열에 주목하자.
• 대문자는 항상 ‘켜짐’이고 소문자는 ‘꺼짐’을 뜻한다.
• 문자는 항상 [heater, blower, cooler, hi-temp-alarm, lo-temp-alarm] 순서다.

이 방식의 코드는 그릇된 정보를 피하라는 규칙의 위반에 가깝지만 여기서는 적절해 보인다. 의미만 안다면 눈길이 문자열을 따라 움직이며 결과를 재빨리 판단할 수 있다.

 

다음 코드를 살펴보면 테스트 코드를 이해하기 너무도 쉽다는 사실이 분명히 드러난다.

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

 

다음은 getState 함수를 보여준다.

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

코드가 그리 효율적이지 못하다는 사실에 주목한다. 효율을 높이려면 StringBuffer가 더 적합하다.

하지만 저자는 StringBuffer는 코드의 가독성을 해치기 때문에 실제 코드에서도 크게 무리가 아니라면 StringBuffer를 피한다고 한다. 또한 컴퓨터 자원과 메모리가 제한적일지라도 테스트 환경은 자원이 제한적일 가능성이 낮다.

 

이것이 이중 표준의 본질이다. 실제 환경에서는 절대로 안 되지만 테스트 환경에서는 전혀 문제없는 방식이 있다. 대게 메모리나 CPU 효율과 관련 있는 경우다. 코드의 깨끗함과는 철저히 무관하다.

 

 

테스트 당 assert 하나

JUnit으로 테스트 코드를 짤 때는 함수마다 assert 문을 단 하나만 사용해야 한다고 주장하는 학파가 있다. 가혹한 규칙이라 여길지도 모르지만, 확실히 장점이 있다. assert 문이 단 하나인 함수는 결론이 하나라서 코드를 이해하기 쉽고 빠르다.

 

[9-2] 코드는 “출력이 XML이다”라는 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이라는 관례를 사용했다. 이는 테스트 코드를 읽기가 쉬워진다. 하지만 불행하게도 테스트를 분리하면 중복되는 코드가 많아진다.

TEMPLETE METHOD 패턴을 사용하면 중복을 제거할 수 있다. given, when 부분을 부모 클래스에 두고 then 부분을 자식 클래스에 두거나, 완전히 독자적인 클래스를 만들어 @Before 함수에 given, when 부분을 넣고 @Test 함수에 then 부분을 넣어도 된다.

 

이 책의 저자는 단일 assert 문이라는 규칙이 훌륭한 지침이라 생각한다. 대체로 단일 assert를 지원하는 테스트 언어를 만들려고 노력한다. 하지만 때로는 주저 없이 함수 하나에 여러 assert 문을 넣기도 한다. 단지 assert 문 개수는 최대한 줄여야 좋다는 생각이다.

 

테스트 당 개념 하나

어쩌면 “테스트 함수마다 한 개념만 테스트하라”는 규칙이 더 낫겠다. 이것저것 잡다한 개념을 연속으로 테스트하는 긴 함수는 피한다.

 

[9-8] 다음은 바람직하지 못한 테스트 함수의 예시다.

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

• 독자적인 개념 3개를 테스트하므로 독자적인 테스트 3개로 쪼개야 마땅하다.
• 세 개념을 한 함수로 몰아넣으면 독자가 각 절이 거기에 존재하는 이유와 각 절이 테스트하는 개념을 모두 이해해야 한다.

 

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

(5월처럼) 31일로 끝나는 달의 마지막 날짜가 주어지는 경우

1. (6월처럼) 30일로 끝나는 한 달을 더하면 날짜는 30일이 되어야지 31일이 되어서는 안 된다.
2. 두 달을 더하면 그리고 두 번째 달이 31일로 끝나면 날짜는 31일이 되어야 한다.

(6월처럼) 30일로 끝나는 달의 마지막 날짜가 주어지는 경우

1. 31일로 끝나는 한 달을 더하면 날짜는 30일이 되어야지 31일이 되면 안 된다.

 

이렇게 표현하면 장황한 테스트 코드 속에 감춰진 일반적인 규칙이 보인다. [9-8]은 각 절에 assert 문이 여럿이라는 사실이 문제가 아니다. 한 테스트 함수에서 여러 개념을 테스트한다는 사실이 문제다.

그러므로 가장 좋은 규칙은 “개념 당 assert 문 수를 최소로 줄여라”와 “테스트 함수 하나는 개념 하나만 테스트하라”라고 하겠다.

 

 

F.I.R.S.T.

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

Fast(빠르게)

테스트는 빨라야 한다. 테스트가 느리면 자주 돌릴 엄두를 내지 못한다. 테스트를 자주 돌리지 않으면 초반에 문제를 찾아내 고치지 못한다. 코드를 마음껏 정리하지도 못한다. 결국 코드 품질이 망가지기 시작한다.

 

Independent(독립적으로)

각 테스트는 서로 의존하면 안 된다. 한 테스트가 다음 테스트가 시행될 환경을 준비해서는 안 된다. 각 테스트는 독립적으로 그리고 어떤 순서로 실행해도 괜찮아야 한다. 테스트가 서로에게 의존하면 하나가 실패할 때 나머지도 잇달아 실패하므로 원인을 진단하기 어려워지며 후반 테스트가 찾아내야 할 결함이 숨겨진다.

 

Repeatable(반복가능하게)

테스트는 어떤 환경에서도 반복 가능해야 한다. 실제 환경, QA 환경, 네트워크에 연결되지 않은 환경에서도 실행할 수 있어야 한다. 테스트가 돌아가지 않는 환경이 하나라도 있다면 테스트가 실패한 이유를 둘러댈 변명이 생긴다. 게다가 환경이 지원되지 않기에 테스트를 수행하지 못하는 상황에 직면한다.

 

Self-Validating(자가 검증하는)

테스트는 부울(bool) 값으로 결과를 내야 한다. 성공 아니면 실패다. 통과 여부를 알려고 로그 파일을 읽게 만들어서는 안 된다. 통과 여부를 보려고 텍스트 파일 두 개를 수작업으로 비교하게 만들어서도 안된다. 테스트가 스스로 성공과 실패를 가늠하지 않는다면 판단은 주관적이 되며 지루한 수작업 평가가 필요하게 된다.

 

Timely(적시에)

테스트는 적시에 작성해야 한다. 단위 테스트는 테스트하려는 실제 코드를 구현하기 직전에 구현한다. 실제 코드를 구현한 다음에 테스트 코드를 만들려면 실제 코드가 테스트하기 어렵다는 사실을 발견할지도 모른다. 어떤 실제 코드는 테스트하기 너무 어렵다고 판명 날지 모른다. 테스트가 불가능하도록 실제 코드를 설계할지도 모른다.

 

 

결론

깨끗한 테스트 코드라는 주제는 책 한 권을 할애해도 모자랄 주제다. 테스트 코드는 실제 코드만큼이나 프로젝트 건강에 중요하다. 어쩌면 실제 코드보다 더 중요할지도 모르겠다. 테스트 코드는 실제 코드의 유연성, 유지보수성, 재사용성을 보존하고 강화하기 때문이다.

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

테스트 코드가 방치되어 망가지면 실제 코드도 망가진다. 테스트 코드를 깨끗하게 유지하자.

 

https://link.coupang.com/a/7cg9l

Clean Code(클린 코드):애자일 소프트웨어 장인 정신

 

https://link.coupang.com/a/7chbT

클린 코드 + 클린 아키텍처 세트

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."