1. TDD 법칙 세 가지
- 실패하는 단위 테스트를 작성할 때까지 실제 코드를 작성하지 않습니다.
- 컴파일은 실패하지 않으면서 실행이 실패하는 정도로만 단위 테스트를 작성합니다.
- 현재 실패하는 테스트를 통과할 정도로만 실제 코드를 작성합니다.
이렇게 이랗면 실제 코드를 사실상 전부 테스트하는 테스트 케이스가 나옵니다. 하지만 실제 코드와 맞먹을 정도로 방대한 테스트 코드는 심각한 관리 문제를 유발하기도 합니다.
2. 깨끗한 테스트 코드 유지하기
실제 코드가 진화하면 테스트 코드도 변해야 합니다. 그런데 테스트 코드가 지저분할 수록 변경하기 어려워집니다. 새 버전을 출시할 때마다 팀이 테스트 케이스르 유지하고 보수하는 비용이 늘어나고, 결국 테스트 슈트를 폐기하지 않으면 안 되는 상황에 처합니다.
코드에 유연성, 유지보수성, 재사용성을 제공하는 버팀목이 바로 단위 테스트입니다. 테스트 케이스가 있다면 버그가 숨어드는 것에 대한 공포가 사라지기 때문입니다. 테스트 커버리지가 높을수록 공포는 줄어듭니다. 아키텍처가 부실한 코드나 설계가 모호하고 엉망인 코드라도 별다른 우려 없이 변경할 수 있습니다. 따러서 테스트 케이스가 있으면 변경이 쉬워집니다.
3. 깨끗한 테스트 코드
어쩌면 가독성은 실제 토그보다 테스트 코드에 더더욱 중요합니다. 테스트 코드에서 가독성을 높이려면 여느 코드와 마찬가지로 명료성, 단순성, 풍부한 표현력이 필요합니다. 테스트 코드는 최소의 표현으로 많은 것을 나타내야 합니다.
describe("Serialize Page Resoponder Test", () => {
beforeAll(() => {
context = FitNesseUtil.makeTestContext();
root = context.getRootPage();
request = new MockRequest();
});
test("Get Page Hieratchy As Xml Test", () => {
WikiPageUtil.addPage(root, PathParser.parse("PageOne"));
WikiPageUtil.addPage(root, PathParser.parse("PageOne.ChildOne"));
WikiPageUtil.addPage(root, PathParser.parse("PageTwo"));
request.setResource("root");
request.addInput("type", "pages");
const responder: Responder = new SerializedPageResponder();
const response: SimpleResponse = responder.makeResponse(context, request) as SimpleResponse;
const xml: string = response.getContent();
expect(response.getContentType()).toBe("text/xml");
expect(xml).toContain("<name>PageOne</name>");
expect(xml).toContain("<name>PageTwo</name>");
expect(xml).toContain("<name>ChildOne</name>");
});
});위 테스트 케이스는 이해하기 어렵기에 개선할 여지가 충분합니다. 첫째, addPage와 expect().toContain을 부르나라 중복되는 코드가 매우 많습니다. 좀 더 중요하게는 자질구레한 사항이 너무 많아 테스트 코드의 표현력이 떨어집니다.
test("Get Page Hieratchy As Xml Test", () => {
makePages("PageOne", "PageOne.ChildOne", "PageTwo");
submitRequest("root", { type: "pages" });
expectResponseIsXml();
expectResoponseContains("<name>PageOne</name>", "<name>PageTwo</name>", "<name>ChildOne</name>");
});BUILD-OPERATE-CHECK 패턴이 위와 같은 테스트 구조에 적합합니다. 각 테스트는 명확히 세 부분으로 나눠집니다. 첫 부분은 테스트 자료를 만듭니다. 두 번쨰 부분은 테스트 자료를 조작하며, 세 번쨰 부분은 조작한 결과가 올바른지 확인합니다.
잡다하고 세세한 코드를 거의 다 없앴다는 사실에 주목합니다. 테스트 코드는 본론에 돌입해 진짜 필요한 자료 유형과 함수만 사용합니다,. 그러므로 코드를 읽는 사람은 온갖 잡다하고 세세한 코드에 주눅들고 헷갈릴 필요 없이 코드가 수행하는 기능을 재빨리 이해합니다.
3.1. 도메인에 특화된 언어
위 리펙토링한 코드는 도메인에 특화된 언어(DSL)로 테스트 코드를 구현하는 기법을 보여줍니다. 흔히 쓰는 시스템 조작 API를 사용하는 대신 API 위에다 함수와 유틸리티를 구현한 후 그 함수와 유틸리티를 사용하므로 테스트 코드를 짜기도 읽기도 쉬워집니다. 이렇게 구현한 함수와 유틸리티는 테스트 코드에서 사용하는 특수 API가 됩니다. 즉, 테스트를 구현하는 당사자와 나중에 테스트를 읽어볼 독자를 도와주는 테스트 언어입니다.
이런 테스트 API는 처음부터 설계된 API가 아닙니다. 잡다하고 세세한 사항으로 범벅된 코드를 계속 리펙터링하다가 진화된 API입니다. 숙련된 개발자라면 자기 코드를 좀 더 간결하고 표현력이 풍부한 코드로 리펙터링해야 마땅합니다.
3.2. 이중 표준
테스트 API 코드에 적용하는 표준은 실제 코드에 적용하는 표준과 확실히 다릅니다. 단순하고, 간결하고 표현력이 풍부해야 하지만, 실제 코드만큼 효율적일 필요는 없습니다. 실제 환경이 아니라 테스트 환경에서 돌아가는 코드이기 때문입니다. 실제 환경과 테스트 환경은 요구사항이 판이하게 다릅니다.
아래 코드는 환경 제어 시스템에 속한 테스트 코드입니다. 세세하게 설명하지 않더라도 온도가 급격하게 떨어지면 경보, 온풍기, 송풍기가 모두 가동되는지 확인하는 코드라는 사실이 드러납니다.
describe("Environment Controller Test", () => {
test("Turn on low temp alarm at threashold", () => {
hw.setTemp(WAT_TOO_COLD);
controller.tic();
expect(hw.heaterState()).toBeTruthy();
expect(hw.blowerState()).toBeTruthy();
expect(hw.coolerState()).toBeFalsy();
expect(hw.hiTempAlarm()).toBeFalsy();
expect(hw.loTempAlarm()).toBeTruthy();
});
});위 코드를 읽으면 코드에서 점검하는 상태 이름과 상태 값을 확인하느라 눈길이 이리저리 흩어집니다. heaterState라는 상태를 보고서 오른으로 눈길을 돌려 toBeTruthy를 읽습니다. coolerState를 보고서는 오른쪼긍로 눈길을 돌려 toBeFalsy를 읽습니다. 테스트 코드를 읽기가 어렵습니다. 그래서 다음과 같이 변환해 코드 가독성을 크게 높였습니다.
test("Turn on low temp alarm at threshold", () => {
wayTooCold();
expect(hw.getState).toBe("HBchL");
});toBe에 들어있는 이상한 문자열에 주목합니다. 대문자는 켜짐(On)이고 소문자는 꺼짐(Off)를 뜻합니다. 문자는 항상 heater, blower, cooler, high-temp-alarm, low-temp-alarm 순서입니다.
비록 위 방식은 그릇된 정보를 피하라는 규칙의 위반에 가깝지만 여기서는 적절해 보입니다. 일단 의미만 안다면 눈길이 문자열을 따라 움직이며 결과를 재빨리 판단합니다. 다음을 살펴보면 테스트 코드를 이해하기 너무 쉽다는 사실이 분명히 드러납니다.
test("Turn on cooler and blower if too hot", () => {
tooHot();
expect(hw.getState).toBe("hBChl");
});
test("Turn on heater and blower if too cold", () => {
wayTooCold();
expect(hw.getState).toBe("HBchl");
});
test("Turn on high temp alarm at threshold", () => {
wayTooCold();
expect(hw.getState).toBe("hBCHl");
});
test("Turn on low temp alarm at threshold", () => {
wayTooCold();
expect(hw.getState).toBe("HBchl");
});다음은 getState 함수를 보여줍니다. 코드가 그리 효율적이지 못하다는 사실에 주목합니다. 컴퓨터 자원과 메모리가 제한적일 가능성은 높습니다. 하지만 테스트 환경은 자원이 제한적일 가능성이 낮습니다.
getState = () => {
state = "";
state += heater ? "H" : "h";
state += blower ? "B" : "b";
state += cooler ? "C" : "c";
state += hiTempAlarm ? "H" : "h";
state += loTempAlarm ? "L" : "l";
return state;
};4. 테스트 당 expect 하나
테스트 코드르 짤 대는 함수마다 expect를 하나만 사용하는 규칙은 가혹한 규칙이라 여길지도 모르지만 확실히 장점이 있습니다. expect 문이 단 하나인 함수는 결론이 하나라서 코드를 이해하기 쉽고 빠릅니다. 다음은 9.3. 깨끗한 테스트 코드에서 리팩토링한 코드를 두 개로 쪼개 각자 expect를 수행한 코드입니다.
test("Get page hierarchy as xml test", () => {
makePages("PageOne", "PageOne.ChildOne", "PageTwo");
submitRequest("root", { type: "pages" });
thenResponseSholdBeXml();
});
test("Get page hierarchy has right tags test", () => {
makePages("PageOne", "PageOne.ChildOne", "PageTwo");
submitRequest("root", { type: "pages" });
thenResponseShouldContain("<name>PageOne</name>", "<name>PageTwo</name>", "<name>ChildOne</name>");
});위에서 함수 이름을 바꿔 give-when-then이라는 관례를 사용했다는 사실에 주목합니다. 그러면 테스트 코드를 읽기가 쉬워집니다. 불행하게도, 테스트를 분리하면 중복되는 코드가 많아집니다. given/when과 then 함수를 어떻게든 분리하면 중복을 제거할 수 있습니다. 하지만 모두 배보다 배꼽이 더 큽니다. 이것저것 감안해 보면 결국 expect를 여러번 사용한 이전 코드가 더 좋습니다.
단일 expect 문이라는 규칙이 훌륭한 지침이라 생각합니다. 대체로 단일 expect를 지원하는 테스트 언어를 만들려 노력합니다. 하지만 때로는 주저 없이 함수 하나에 여러 expect문을 넣기도 합니다. 단지 epect 문 개수를 최대한 줄여야 좋다는 생각입니다.
4.1. 테스트 당 개념 하나
어쩌면 테스트 함수마다 한 개념만 테스트하라는 규칙이 더 낫습니다. 새 개념을 한 함수로 몰아넣으면 독자가 각 절이 거기에 존재하는 이유와 각 절이 테스트하는 개념을 모두 이해해야 합니다.
test("Add month test", () => {
const d1: SerialDate = new SerialDate(31, 5, 2004);
const d2: SerialDate = d1.addMonths(1);
expect(d2.getDayOfMonth()).toBe(30);
expect(d2.getMonth()).toBe(6);
expect(d2.getYYYY()).toBe(2004);
const d3: SerialDate = d1.addMonths(2);
expect(d3.getDayOfMonth()).toBe(31);
expect(d3.getMonth()).toBe(7);
expect(d3.getYYYY()).toBe(2004);
const d4: SerialDate = d1.addMonths(1).addMonths(1);
expect(d4.getDayOfMonth()).toBe(30);
expect(d4.getMonth()).toBe(7);
expect(d4.getYYYY()).toBe(2004);
});위 코드는 날짜에 어떤 달을 더하면 날짜는 그 달의 마지막 날짜보다 커지지 못한다는 것을 테스트합니다. 여기서는 각 절에 expect 문이 여럿이라는 문제가 아닙니다. 한 테스트 함수에서 여러 개념을 테스트한다는 사실이 문제입니다. 그러므로 가장 좋은 규칙은 개념 당 assert 문 수를 최소로 줄여라와 테스트 함수 하나는 개념 하나만 테스트하라입니다.
5. F.I.R.S.T.
빠르게(Fast)
테스트는 빨라야 합니다. 테스트가 느리면 자주 돌릴 엄두를 못 냅니다.
독림적으로(Independent)
각 테스트는 서로 의존하면 안 됩니다. 한 테스트가 다음 테스트가 실행될 환경을 준비해서는 안 됩니다. 각 테스트는 독립적으로 그리고 어떤 순서로 실행해도 괜찮아야 합니다. 테스트가 서로에게 의존하면 하나가 실패할 때 나머지도 잇달아 실패하므로 원인을 진단하기 어려워지며, 후반 테스트가 찾아내야 할 결함이 숨겨집니다.
반복가능하게(Repeatable)
테스트는 어떤 환경에서도 반복 가능해야 합니다. 실제 환경, QA 환경, 버스를 타고 집으로 가는 길에 사용하는 (네트워크에 연결되지 않은) 노트북 환경에서도 실행할 수 있어야 합니다. 테스트가 돌아가지 않는 환경이 하나라도 있다면 테스트가 실패한 이유를 둘러댈 변명이 생깁니다. 게다가 환경이 지원되지 않기에 테스트를 수행하지 못하는 상황에 직면합니다.
자가 검증하는(Self-Validating)
테스트는 부울(bool) 값으로 결과를 내야 합니다. 성공 아니면 실패입니다. 통과 여부를 알려고 로그 파일을 읽게 만들어서는 안 됩니다. 통과 여부를 보려고 텍스트 파일 두 개를 수작업으로 비교하게 만들어서도 안 됩니다.
적시에(Timely)
테스트는 적시에 작성해야 합니다. 단위 테스트는 테스트하려는 실제 코드를 구현하기 직전에 구현합니다. 실제 코드를 구현한 다음에 테스트 코드를 만들면 실제 커드가 테스트하기 어렵다는 사실을 발견할지도 모릅니다.
6. 출처
- 제목: 클린 코드 - 애자일 소프트웨어 장인 정신
- 저자: 로버트 C.마틴
- 옮긴이: 박재호, 이해영
- 출판사: 인사이트
