• 클린코드

TDD 법칙 세 가지

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

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

• 지저분한 테스트 코드를 계속해서 만들면, 변경이 어려워지고, 이는 테스트를 추가하는 비용을 증가시킨다.
  • 또한 실제 코드보다 테스트 케이스를 추가하는 시간이 더 걸리게 됨.
• 그렇다고 테스트 코드를 짜지 않으면 개발자는 자신이 수정한 코드가 제대로 도는지 확인할 방법이 없게 된다.
• 결론은 테스트 코드는 실제 코드 못지 않게 중요하기 때문에, 실제 코드 못지 않게 깨끗하게 짜야 한다는 것.

---

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

• 코드에 유연성, 유지보수성, 재사용성을 제공하는 버팀목은 단위 테스트다.
  테스트 케이스가 있다면 변경이 두렵지 않기 때문이다.
  설계를 아무리 잘나누고, 아키텍쳐가 아무리 유연해도, 테스트 케이스가 없으면 개발자는 변경을 주저하게 된다.
• 실제 코드를 점검하는 자동화된 단위 테스트 슈트는 설계와 아키텍처를 최대한 깨끗하게 보존하는 열쇠다.

---

깨끗한 테스트 코드

• 깨끗한 테스트 코드를 만들기 위해 필요한 것은 가독성.
• 가독성을 높이려면 명료성, 단순성, 풍부한 표현력이 필요하다.
• BUILD-OPERATE-CHECK 패턴
  • 첫부분, 테스트 자료 생성
  • 테스트 자료 조작
  • 결과 올바른지 체크
    -> given when then과 비슷해보이네요

---

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

• 도메인 특화 언어(DSL)로 테스트 코드를 구현하라.
  • 흔히 쓰는 시스템 조작 API를 사용하는 대신 API 위에다 함수와 유틸리티를 구현하고 그 함수와 유틸리티를 사용하므로 테스트코드를 짜기도 읽기도 쉬워짐.
    • 여기서 구현한 것들은 테스트 코드에서 사용하는 특수 API가 됨.
    • 이 테스트 API들은 리팩터링 하면서 진화하는 것들임.

---

이중 표준

• 테스트 API에 적용하는 표준은 실제 코드에 적용하는 표준과 확실히 다르다.
  • 간결하고 표현력이 풍부해야하지만 실제 코드만큼 효율적일 필요는 없다.
    실제 환경과 테스트 환경은 요구사항이 판이하게 다르다
    아래 코드를 보자.

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

코드 가독성을 올리기 위해 다시 코드를 바꿔보자
여기서 대문자는 켜짐, 소문자는 꺼짐이다.
-> hBChl -> Heater Off, Blower on, Cooler On, HiTempAlarm Off, loTempAlarm Off

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

@Test
public void turnOnHeaterAndBlowerIfTooCold() throws Exception {
	tooCold();
    assertEquals("hBChl", hw.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" : "l";
    return state;
  }

  메모리나 CPU 효율이 중요한 실제 환경에서는 StringBuffer를 사용할것.
  -> 하지만 마틴님은 크게 무리가 아니면 피한다고 하십니다.

---

테스트 당 assert 하나

• assert문이 하나인 함수는 결론이 하나라서 코드를 이해하기 쉽고 빠르다.
• 하지만 필요한 경우 assert 문 여러개 담아도 괜찮다.
• 최대한 적게 하려고 노력은 해보자.

테스트 당 개념 하나

• 테스트 함수마다 한 개념만 테스트하라는 규칙이 더 나을지도 모르겠다.
• 이것저것 잡다한 개념을 연속으로 테스트하는 긴 함수는 피하라.

---

F.I.R.S.T. principle

• 로버트 C.마틴의 클린코드에 나와있는 깨끗한 테스트를 위한 다섯 가지 규칙.

F - Fast

• 테스트는 빨라야 한다.
  즉, 테스트는 빨리 돌아야 한다는 말.
  테스트가 느리면 자주 돌릴 엄두를 낼 수 없고, 이는 문제를 찾아내 고치기 힘들게 만들어 코드의 품질을 망가지게 한다.

I - Independent

• 각 테스트는 서로 의존해선 안된다.
  한 테스트가 다음 테스트가 실행될 환경을 준비해서는 안된다.
• 테스트가 서로에게 의존하게 되면 하나가 실패할 때 잇달아 실패하므로 후반 테스트가 찾아내야 할 결함이 숨겨진다.

R - Repeatable

• 테스트는 어떤 환경에서도 반복 가능해야 한다.
  실제 환경, QA 환경, 노트북 환경에서도 실행할 수 있어야 한다.
  테스트가 돌아가지 않는 환경이 하나라도 있으면 안됨.

S - Self-Validating

• 테스트는 bool 값으로 결과를 내야한다. 성공 아니면 실패다. 통과 여부를 알기 위해 로그 파일을 읽게 만들어서는 안된다. 테스트가 스스로 성공과 실패를 가늠하지 않는다면 판단은 주관적이 되며 지루한 수작업 평가가 필요하게 된다.

T - Timely

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

---

Isolate the functionality to be tested

• 아래 예제 코드를 보자

import org.junit.Test;

import static org.junit.Assert.assertEquals;

public class MapRepositoryTest {

	private MapRepository mapRepository = new MapRepository();

	@Test
	public void shouldReturnJurisdictionForZip() {
    	final String expectedJurisdiction = "NJ";
    	assertEquals(expectedJurisdiction, mapRepository.findByZip("07677"));
	}
}

이 코드에서는 database에 대한 접근 코드가 존재하지 않는다.
또한 MapRepository 는 classpath로부터 데이터를 불러온다.

참고

• 클린코드
• https://tanzu.vmware.com/developer/guides/spring-boot-testing/