9장: 단위 테스트

1997년만 해도 TDD(Test Driven Development)라는 개념을 아무도 몰랐다. 단위 테스트란 자기 프로그램이 돌아간다는 사실만 확인하고 버리는 일회성 코드였다.

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

TDD 법칙 세 가지 (155p)

• TDD의 기본 요구사항 - 실제 코드를 짜기 전에 단위 테스트부터 짜라! (그러나 이것은 빙산의 일각)

• TDD의 세 가지 법칙

  1. 실패하는 단위 테스트를 작성할 때까지 실제 코드를 작성하지 않는다.

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

  3. 현재 실패하는 테스트를 통과할 정도로만 실제 코드를 작성한다.

• 이 규칙을 따르면 개발과 테스트가 대략 30초 주기로 묶인다. 테스트 코드와 실제 코드가 함께 나올 뿐더러 테스트 코드가 실제 코드보다 불과 몇 초 전에 나온다.

• 이렇게 일하면 엄청나게 방대한 테스트 케이스가 나오고, 이는 관리 문제를 유발한다!

깨끗한 테스트 코드 유지하기 (156p)

• 저자는 과거 본인이 몸 담은 팀의 팀원들이 서로 단위 테스트에서 규칙을 깨도 좋다는 허가장을 줬다.

• "지저분해도 빨리": 변수 이름 신경 X, 테스트 함수는 간결하거나 서술적일 필요가 없었고, 테스트 코드는 잘 설계하거나 주의해서 분리할 필요가 없었음. 돌아가기만 하면 그만!

• 그러나 실제 코드를 변경해 기존 테스트 케이스가 실패하기 시작하면, 지저분한 코드로 인해 이를 통과시키기 어려워진다!

• 테스트 코드는 실제 코드 못지 않게 중요하다. 테스트 코드 역시 깨끗하게 짜야 한다!

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

• 테스트 코드를 깨끗하게 유지하지 않으면 결국은 잃어버린다. 그리고 테스트 케이스가 없으면 실제 코드를 유연하게 만드는 버팀목도 사라진다.

• 코드에 유연성, 유지보수성, 재사용성을 제공하는 버팀목이 바로 단위 테스트이다! 왜? 테스트 케이스가 있으면 변경이 두렵지 않으니까!

깨끗한 테스트 코드 (158p)

• 깨끗한 테스트 코드를 만드려면? 중요한 건 가독성이다!

• 가독성을 높이려면? 명료성, 단순성, 풍부한 표현력이 필요하다! 최소의 표현으로 많은 것을 나타내야 한다.

초기 코드

  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는 문자열을 pagePath 인스턴스로 변환한다. pagePath는 크롤러가 사용하는 객체이므로, 테스트와는 무관하다.

• Responder 객체를 생성하고 response를 수직해 변환하는 코드 역시 잡음에 불과하다.

• 결정적으로 위 코드는 읽는 사람을 고려하지 않는다!

리팩터링한 코드 (160p)

  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. 조작한 결과가 올바른 지 확인한다.

• 테스트 코드는 본론에 돌입해 진짜 필요한 자료 유형과 함수만 사용한다.

• 위의 예시는 도메인에 특화된 언어로 테스트 코드를 구현하는 기법을 보여준다. 흔히 쓰는 시스템 조작 API 대신, API 위에다 함수와 유틸리티를 구현한 후 그 함수와 유틸리티를 사용하는 것!

• 이런 형식은 처음부터 설계된 API가 아니며, 잡다하고 세세한 사항으로 범벅된 코드를 계속 리팩터링하다가 진화된 API이다!

• 테스트 코드에 적용하는 표준은 실제 코드에 적용하는 표준과 확실히 다르다! 실제 코드에서는 절대로 안되지만 테스트 환경에서는 문제가 없는 코드 방식이 있다.

테스트 당 assert 하나 (164p)

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

• 장점이 있는 방식이며, assert문이 단 하나인 함수는 결론이 하나라서 이해하기 쉽고 빠르다.

• 하지만 때로는 주저 없이 함수 하나에 여러 assert문을 넣기도 한다. 그러나 문의 개수를 최대한 줄여야 하는 것이 맞다!

테스트 당 개념 하나 (166p)

예시 코드

  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원칙 F.I.R.S.T (167p)

• Fast(빠르게): 테스트는 빨라야 한다. 테스트는 빨리 돌아야 한다는 말이다. 느리면 자주 돌릴 엄두를 못 내고, 자주 돌리지 않으면 초반에 문제를 찾아내 고치지 못한다.

• Independent(독립적으로): 각 테스트는 서로 의존하면 안 된다. 한 테스트가 다음 테스트가 실행될 환경을 준비해서는 안 된다. 각 테스틑 독립적으로, 어떤 순서로 실행해도 괜찮아야 한다!

• Repeatable(반복 가능하게): 테스트는 어떤 환경에서도 반복 가능해야 한다. 테스트가 돌아가지 않는 환경이 하나라도 있다면 테스트가 실패한 이유를 둘러댈 변명이 생긴다.

• Self-Validating(자가검증하는): 테스트는 bool 값으로 결과를 내야한다. 성공 아니면 실패!

• Timely(적시에): 테스트는 적시에 작성해야 한다. 단위 테스트는 테스트하려는 실제 코드를 구현하기 직전에 구현한다.