[Clean Code] Chapter 9 단위 테스트

해당 포스팅 내용은 책 'Clean Code - Robert C. Martin' 출처로 합니다.

 

 

 

---

 

TDD(Test-Driven Development)란?

테스트 작성 후 테스트를 통과하기 위한 실제 코드를 만들고 반복하는 개발 프로세스

 

출처: SAMSUNG SDS 인사이트 리포트 - 코드 품질을 높여주는 테스트 주도 개발 알아보기

 

TDD 법칙 세 가지

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

위 세 가지 규칙을 통해,

실제 코드에 대해 기대되는 바를 보다 명확하게 정의함으로써 불필요한 설계를 피할 수 있고, 정확한 요구 사항에 집중할 수 있다.

 

이렇게 일하면 실제 코드를 사실상 전부 테스트하는 테스트 케이스가 나온다.

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

 

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

테스트 코드에 실제 코드와 동일한 품질 기준을 적용하지 않는다면?

 

• 실제 코드 변경 시 테스트 코드 변경의 어려움
  기존 테스트 케이스가 실패하기 시작하면, 지저분한 코드로 인해, 실패하는 테스트 케이스를 점점 더 통과시키기 어려워진다.
  → 테스트 코드는 계속해서 늘어나는 부담이 되버린다.
• 새 버전을 출시할 때마다 테스트 케이스 유지보수 비용 증가
  → 테스트 슈트를 폐기해야 하는 불가피한 상황에 처한다.
• 테스트 슈트의 부재로 인한 결함율 증가
  → 개발자가 코드 변경을 주저해 정리하지 않아 코드가 망가지기 시작한다.

결국, 테스트 코드는 실제 코드 못지 않게 중요하며 사고와 설계와 주의가 필요하다.

 

실제 코드를 점검하는 자동화된 단위 테스트 슈트는 설계와 아키텍처를 최대한 깨끗하게 보존하는 열쇠다.
테스트는 코드에 유연성, 유지보수성, 재사용성을 제공한다.
테스트 케이스가 있으면 변경이 쉬워지기 때문이다. (테스트 케이스가 없다면 모든 변경이 잠정적인 버그다.)

 

깨끗한 테스트 코드

깨끗한 테스트 코드를 만들려면 가독성을 높여야 한다.

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

 

잡다하고 세세한 코드는 거의 다 없애고, 본론에 돌입해 진짜 필요한 자료 유형과 함수만 사용한다.

→ 코드를 읽는 사람이 코드가 수행하는 기능을 재빨리 이해할 수 있다.

 

이중 표준

테스트 API 코드에 적용하는 표준은 실제 코드에 적용하는 표준과 확실히 다르다.

단순하고, 간결하고, 표현력이 풍부해야 하지만, 실제 코드만큼 효율적일 필요는 없다.

→ 실제 환경과 테스트 환경을 요구사항이 판이하게 다르다.

 

밑의 코드는 환경 제어 시스템에 속한 테스트 코드다.

세세하게 설명하지 않더라도 온도가 '급격하게 떨어지면' 경보, 온풍기, 송풍기가 모두 가동되는지 확인하는 코드라는 것을 알 수 있다.

 

@Test
 public void turnOnLoTempAlarmAtThreashold() throws Exception {
	hw.setTemp(WAY_T00_C0LD);
	controller.tic();
	assertTrue(hw.heaterState());
	assertTrue(hw.blowerState());
	assertFalse(hw.coolerState());
	assertFalse(hw.hiTempAlarm());
	assertTrue(hw.loTempAlarm());
 }

 

위 코드를 읽으면 점검하는 상태 이름과 상태 값을 확인하느라 코드를 많이 확인해야 한다.

그래서 밑의 코드로 리팩토링해 코드 가독성을 높인다.

 

@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" : "I";
	ret나rn state;
}

 

StringBuffer를 사용하지 않아 치르는 대가가 미미하지만, 이 애플리케이션은 실시간 임베디드 시스템이다.

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

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

 

이것이 이중 표준의 본질이다.

실제 환경에서는 절대로 안 되지만 테스트 환경에서는 전혀 문제없는 방식이 있다.

대개 메모리나 CPU 효율과 관련 있는 경우다. 코드의 깨끗함과는 철저히 무관하다.

 

테스트 당 assert 하나

assert 문이 단 하나인 함수는 결론이 하나라서 코드를 이해하기 쉽고 빠르다.

밑의 코드는 assert 문을 하나로 병합하는 방식이 불합리해 보여 테스트를 두 개로 쪼개 각각 assert를 수행한다.

 

public void testGetPageHierarchyAsXml() throws Exception {
	givenPages("PageOne", "PageOne.ChildOne", "PageTwo");
    
        whenRequestlsIssued("root", "type:pages");
    
	thenResponseShouldBeXML();
}

public void testGetPageHierarchyHasRightTags() throws Exception {
	givenPages("PageOne", "PageOne.ChildOne", "PageTwo");
    
	whenRequestlsIssued("root"f "type: pages");
    
	thenResponseShouldContain(
		"<name>PageOne</name>", "<name>PageTwo</name>", "<name>ChildOne</name>"
	);
}

 

위 테스트 코드는 읽기 쉽지만, 테스트 분리로 인해 중복되는 코드가 많아진다.

 

TEMPLATE METHOD 패턴을 사용하면 중복을 제거할 수 있다.

또는, 완전히 독자적인 테스트 클래스를 만들어 @Before 함수와 @Test 함수로 나누어 넣어도 된다.

하지만, 모두 배보다 배꼽이 더 크다.

 

assert 문 개수는 최대한 줄여야 하되, 상황에 따라 함수 하나에 여러 assert 문을 사용하는 편이 좋다고 생각한다.

 

테스트 당 개념 하나

잡다한 개념을 연속으로 테스트하는 긴 함수는 피한다.

독자적인 개념의 테스트를 한 함수로 몰아넣으면 독자가 각 절이 존재하는 이유와 각 절이 테스트하는 개념을 모두 이해해야 한다.

 

개념 당 assert 문 수를 최소로 줄이고, 테스트 함수 하나는 개념 하나만 테스트하라.

 

F.I.R.S.T

• 빠르게(Fast): 테스트는 빨리 돌아가야 한다.
  테스트가 느리면 자주 돌릴 엄두를 못 내고, 자주 돌리지 않으면 초반에 문제를 찾아내 고치지 못한다. 결국 코드를 마음껏 정리하지 못해 코드 품질이 망가지기 시작한다.
• 독립적으로(Independent): 각 테스트는 서로 의존하면 안된다.
  각 테스트는 독립적으로 그리고 어떤 순서로 실행해도 괜찮아야 한다.
• 반복가능하게(Repeatable): 테스트는 어떤 환경에서도 반복 가능해야 한다.
  테스트가 돌아가지 않는 환경이 하나라도 있다면 테스트를 수행하지 못하는 상황에 직면한다.
• 자가검증하는(Self-Validating): 테스트는 부울(bool) 값으로 결과를 내야 한다.
  성공 아니면 실패이다. 테스트가 성공과 실패를 가늠하지 않는다면 판단은 주관적이 된다.
• 적시에(Timely): 테스트는 적시에 작성해야 한다.
  단위 테스트는 테스트하려는 실제 코드를 구현하기 직전에 구현한다.

 

 

테스트 코드는 실제 코드만큼이나 프로젝트 건강에 중요하므로 지속적으로 깨끗하게 관리하자!