제대로 된 테스트 케이스를 작성해야 한다는 사실을 잊지말자
과거 1997년까지만 하더라도 TDD라는 개념을 아무도 몰랐다.
대다수의 프로그래머들은 '단위 테스트' 를 돌아가는지 확인하기 위한 일회용 코드라 여겼다.
시간이 지나면서 '테스트 코드'는 눈부신 성장을 이뤘고
애자일과 TDD 덕택에 단위 테스트를 자동화하는 프로그래머들이 많아지고 있다.
하지만, 많은 프로그래머들이 단위 테스트를 도입하려고 급하게 서두르면서도
제대로 된 테스트 케이스를 작성해야 한다는 좀 더 미묘한 사실을 놓치고 있는 중이다.
TDD, 실제 코드를 작성하기 전에 단위 테스트를 작성하자
- 첫 번째 법칙 : 실패하는 단위 테스트를 작성할 때까지 실제 코드를 작성하지 않는다.
- 두 번째 법칙 : 컴파일은 실패하지 않으면서 실행이 실행이 실패하는 정도로만 단위 테스트를 작성한다.
- 세 번째 법칙 : 현재 실패하는 테스트를 통과할 정도로만 실제 코드를 작성한다.
위 3가지 규칙을 따른다면
- 테스트 코드와 실제 코드가 함께 나온다.
- 실제 코드를 사실상 전부 테스트하는 수천 개의 테스트 코드가 나온다.
- 단, 너무 많은 테스트 코드는 오히려 심각한 관리 문제를 유발한다.
대부분의 프로그래머들은 시간에 쫒긴다.
그러다보니 테스트 코드도 '지저분해도 빨리'라는 생각을 한다.
하지만, 실제 코드가 진화하면 테스트 코드도 진화(변화)해야한다.
그렇기 때문에...
- 새 버전을 출시할 때마다 팀이 테스트 케이스를 유지하고 보수하는 비용이 늘어남
- 개발자 사이에서 테스트 코드가 가장 큰 불만으로 자리 잡는다.
- 관리자가 예측값이 너무 큰 이유를 물어보면 팀은 테스트 코드를 비난한다.
- 테스트 슈트를 폐기한다.
- 테스트 코드의 부재로 개발자는 수정한 코드가 제대로 도는지 확인할 방법이 없다.
- 결함률이 높아진다.
- 의도하지 않은 결함 수가 많아지면 개발자는 변경을 주저한다.
- 변경하면 득보다 해가 크다 생각해 더 이상 코드를 정리하지 않는다.
- 코드가 망가진다.
- 테스트 슈트도 없고, 얼기설기 뒤섞인 코드에, 좌절한 고객과,
테스트에 쏟아 부은 노력이 허사였다는 실망감만 남는다.
반면에, 테스트 코드를 깨끗하게 짰다면 위와 같은 문제는 나오지 않을 것이다.
테스트 코드는 사고와 설계와 주의가 필요하므로 실제 코드 못지 않게 깨끗하게 짜야한다.
단위 테스트 : 코드에 우연성, 유지보수성, 재사용성을 제공하는 버팀목
테스트 케이스가 없다면?
- 코드를 변경하면 어떤 에러가 생길지 모른다는 두려움이 생긴다.
- 아키텍처가 아무리 유연하더라도, 설계를 아무리 잘 나눴더라도 마찬가지이다.
- 코드를 변경했을 때 그에 맞는 테스트를 진행하지 않으므로 '검증'이 안 된다.
테스트 케이스가 있다면?
- 테스트 커버리지가 높을수록 공포는 줄어든다.
- 아키텍처가 부실하거나 설계가 모호하고 엉망인 코드도 우려 없이 변경할 수 있다.
- 코드를 변경했을 때 그에 맞는 테스트를 진행하므로 '검증'이 된다.
실제 코드를 점검하는 '자동화된 단위 테스트 슈트'는 설계와 아키텍처를 깨끗하게 보존하는 열쇠다.
테스트는 유연성, 유지보수성, 재사용성을 제공해주며 코드의 변경을 쉽게 만들어준다.
반대로 테스트 코드가 지저분하면 코드를 변경하는 능력은 떨어진다.
구조를 개선하는 능력도 떨어지며 지저분할수록 실제 코드도 지저분해진다.
결국 테스트 코드를 잃어버리고 실제 코드도 망치는 결과를 만든다.
깨끗한 코드를 만들기 위한 3가지 조건 | 가독성, 가독성, 가독성
테스트 코드의 가독성은 실제 코드보다 더욱 중요할 수 있다.
테스트 코드는 실제 코드와 마찬가지로 명료성, 단순성, 풍부한 표현력이 필요하다.
테스트 코드는 최소의 표현으로 많은 것을 나타내야하기 때문이다.
가독성이 좋지 않은 코드
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);
}- 코드에서 표현하려고 하는 부분이 많고 중복적인 코드가 많다.
- 테스트에서
PathParse는 문자열을pagePath인스턴스로 반환하는 무의미한 코드다. - responder 객체를 생성하는 코드와 response를 수집해 반환하는 코드 역시 잡음이다.
- resource와 인수에서 요청 URL을 만드는 어설픈 코드도 보인다.
- 정확히 말하면 전부 쓸모 없는 코드는 아니지만 코드가 노출됨으로써 가독성을 흐리게 만든다.
테스트 코드에서는 좀 더 테스트에 관련된 중요한 내용이 보이도록 작성하는 것이 좋다.
여기서는 BUILD-OPERATE-CHECK 패턴이 적합하다.
- 테스트 자료를 만든다.
- 테스트 자료를 조작한다.
- 조작한 결과가 올바른지 확인한다.
가독성이 좋은 코드
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");
}- 잡다하고 세세한 코드가 없어졌다.
- 정확히 말하면 이들을 함수로 묶어서 처리해주었다.
- 그러므로 코드를 읽는 사람은 코드가 수행하는 기능을 재빨리 이해할 수 있게 되었다.
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");
}위 코드는 도메인에 특화된 언어(DSL)로 테스트 코드를 구현하는 기법을 보여준다.
시스템 조작 API를 사용하는 대신,
API 위에다 함수와 유틸리티를 구현한 후 사용하므로 테스트 코드를 짜기도 읽기도 쉬워진다.
이렇게 구현한 함수와 유틸리티는 테스트 코드에서 사용하는 특수 API가 된다.
즉, 테스트를 구현하는 당사자와 나중에 테스트를 읽어볼 독자를 도와주는 테스트 언어이다.
이런 테스트 API는 처음부터 설계된 API가 아니다.
잡다하고 세세한 사항으로 범벅된 코드를 리팩토링하다가 진화된 API이다.
숙련된 개발자라면 자기 코드를 좀 더 간결하고 표현력이 풍부한 코드로 리팩토링해야 한다.
테스트 API 코드에 적용하는 표준은 실제 코드에 적용하는 표준과 확실히 다르다.
단순하고, 간결하고, 표현력이 풍부해야 하지만, 실제 코드만큼 효율적일 필요는 없다.
실제 환경이 아닌 테스트 환경에서 돌아가기 때문이다.
// Bad
@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());
}
// Good
@Test
public void turnOnLoTempAlarmAtThreshold() throws Exception {
wayTooCold();
assertEquals("HBchL", hw.getState());
// HBchL : heater, blower, cooler, hiTempAlarm, loTempAlarm
// getState() : 는 추상화기법으로 직접적인 값이 아닌 기기의 상태에 따라 철자만 붙여 리턴한다.
// 대문자 : 켜짐
// 소문자 : 꺼짐
}- 온도가 급격하게 떨어지면 경보, 온풍기, 선풍기가 모두 가동되는지 확인하는 코드다.
- 우리는 '온도가 급격하게 떨어졌는지'에 대해서 확인해볼 것이다.
- BAD 코드는 클린 코드 규칙에 맞게 작성했지만 따분하고 읽기 어렵다.
- GOOD 코드는
그릇된 정보를 피하라규칙을 어겼지만 코드가 간결해보인다.- 의미를 찾기 힘들지만 의미만 찾으면 결과를 재빨리 판단할 수 있다.
의미를 이해했다면..
@Test
public void turnOnCoolerAndBlowerIfTooHot() throws Exception {
tooHot();
assertEquals("hBChl", hw.getState());
}
@Test
public void turnOnHeaterAndBlowerIfTooCoold() 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()
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;
}getState()는 전원이 켜졌는지 유무에 따라서 대소문자 철자를 붙인다.- 사실
String의+연산자는 좋지 않다. String은immutable instance로 새로운 메모리를 할당하고 만들기 때문이다.StringBuffer는immutable instance로 메모리를 새로 할당하지 않고 만들 수 있다.- 즉,
StringBuffer를 이용하는 것이 훨씬 더 효율적이다. - 더군다나 이 애플리케이션은
임베디드 시스템에서 사용되므로 메모리와 저원이 제한적이다. - 하지만, 테스트 환경은 메모리와 자원이 제한적일 가능성이 낮아서 괜찮다.
이것이 '이중 표준'의 본질이다.
실제 환경에서는 절대 안 되지만 테스트 환경에서는 전혀 문제 없는 방식이 있다.
대개 메모리나 CPU 효율과 관련 있는 경우다.
코드의 깨끗함과는 철처히 무관하다.
함수마다 assert 문을 단 하나만 사용 해야 한다고 주장하는 학파가 있다.
가혹한 규칙이라 여길지는 몰라도 함수의 결론이 하나라 이해가 쉽고 빠르다는 장점이 있다.
이는 마치, 함수의 기능은 한 개만 수행하자는 것과 같은 의미이다.
병합된 테스트 코드
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>");
}- '출력이 XML이다'라는 assert 문
- '특정 문자열을 포함한다'라는 assert 문
- 함수는 한 가지 기능을 수행하는 것이 좋듯이 2개의 assert문은 불합리해 보인다.
분리된 테스트 코드
public void testGetPageHierarchyAsXml() throws Exception {
// given
givenPages("PageOne", "PageOne.ChildOne", "PageTwo");
// when
whenRequestIsIssued("root", "type:pages");
// then
thenResponseShouldBeXML();
}
public void testGetPageHierarchyHasRightTags() throws Exception {
// given
givenPages("PageOne", "PageOne.ChildOne", "PageTwo");
// when
whenRequestIsIssued("root", "type:pages");
// then
thenResponseShouldContain(
"<name>PageOne</name>", "<name>PageTwo</name>", "<name>ChildOne</name>"
);
}- 기존 코드에서 한 번에 사용되는 'assert 문'을 2가지 메서드로 분리했다.
- 또한,
given-when-then이라는 관례를 사용하여 이름을 바꾸었다. given-when-then참고 : https://brunch.co.kr/@springboot/292- 테스트 메서드는 한 가지 결론(기능)을 가지고 있어 코드가 보다 읽기 쉬워졌다.
하지만, 테스트를 분리하면서 중복되는 코드가 생겼다.
이를 해결하기 위한 방법은 2가지가 있다.
-
TEMPLATE METHOD 패턴을 사용하여 해결 할 수 있다.
given/when부분을 부모 클래스에 두고
then부분을 자식 클래스에 두는 방식으로 해결
TEMPLATE METHOD 패턴참고 : https://velog.io/@kwj1270/Template-Method-Pattern -
완전히 독자적인 테스트 클래스를 만든다.
@Before함수에서 클래스 값으로given/when부분을 넣고
@Test함수에서given/when은 클래스로 사용하고then부분을 넣어도 된다.
하지만 모두 배보다 배꼽이 더 크다.
이것저것 감안해 보면 assert문을 여럿 사용하는 편이 좋다.
때로는 주저 없이 함수 하나에 여러 assert문을 넣기도 해야 한다.
단, assert문 개수는 최대한 줄이도록 노력하는 자세를 가지자.
테스트 함수마다 한 개념만 테스트하라
이것저것 잡다한 개념을 연속으로 테스트하는 긴 함수는 피해야한다.
잡다한 개념 코드
/**
* addMonth() 메서드를 테스트하는 장황한 코드
*/
public void testAddMonths() {
SerialDate d1 = SerialDate.createInstance(31, 5, 2004);
// (6월처럼) 30일로 끝나는 한 달을 더하면 날짜는 30일이 되어야지 31일이 되어서는 안된다.
SerialDate d2 = SerialDate.addMonths(1, d1);
assertEquals(30, d2.getDayOfMonth());
assertEquals(6, d2.getMonth());
assertEquals(2004, d2.getYYYY());
// 두 달을 더하면 그리고 두 번째 달이 31일로 끝나면 날짜는 31일이 되어야 한다.
SerialDate d3 = SerialDate.addMonths(2, d1);
assertEquals(31, d3.getDayOfMonth());
assertEquals(7, d3.getMonth());
assertEquals(2004, d3.getYYYY());
// 31일로 끝나는 한 달을 더하면 날짜는 30일이 되어야지 31일이 되어서는 안된다.
SerialDate d4 = SerialDate.addMonths(1, SerialDate.addMonths(1, d1));
assertEquals(30, d4.getDayOfMonth());
assertEquals(7, d4.getMonth());
assertEquals(2004, d4.getYYYY());
}- 3가지 개념을 한 함수에서 테스트하고 있다.
- 각 절이 존재하는 이유와 테스트 하는 개념을 모두 이해해야 해서 좋지 않다.
결국 테스트 함수와 assert문에 관련된 규칙은 아래 2개가 가장 좋다고 하겠다.
- 개념 당 assert문 수를 최소로 줄여라
- 테스트 함수 하나는 개념 하나만 테스트하라
깨끗한 테스트는 F.I.R.S.T 라는 5가지 규칙을 따른다.
테스트는 빨라야한다.
- 테스트는 빨리 돌아야한다.
- 테스트가 느리면 자주 돌릴 엄두가 나지 않는다.
- 자주 돌리지 않으면 초반에 문제를 찾아 고치지 못한다.
- 코드를 마음껏 정리하지도 못한다.
- 결국, 코드 품질이 망가지기 시작한다.
각 테스트는 서로 의존하면 안 된다.
- 한 테스트가 다음 테스트가 실행될 환경을 준비하면 안 된다.
- 각 테스트는 독립적으로 그리고 어떤 순서로 실행해도 괜찮아야한다.
- 테스트가 서로에게 의존하면 하나가 실패할 때
- 나머지도 잇달아 실패하므로 원인을 진단하기 어려우며 후반 테스트가 찾아내야 할 결함이 숨겨진다.
테스트는 어떤 환경에서도 반복 가능해야 한다.
- 실제 환경, QA 환경, 네트워크에 연결되지 않은 노트북에서도 실행할 수 있어야 한다.
- 테스트가 돌아가지 않는 환경이 하나라도 있다면 테스트 실패의 이유가 될 수 있다.
- 환경이 지원되지 않기에 테스트를 수행하지 못하는 상황에 직면할 수 있다.
테스트는 Boolean 값으로 결과를 내야 한다.
- 성공이 아니면 실패다.
- 통과 여부를 알려고 로그 파일을 읽게 만들어서는 안 된다.
- 통과 여부를 보려고 텍스트 파일 2개를 수작업으로 비교하게 만들어서도 안 된다.
- 테스트가 스스로 성공과 실패를 가늠하지 않는다면 판단은 주관적이 되며 지루한 수작업 평가가 필요하게 된다.
테스트는 적시에 작성해야 한다.
- 단위 테스트는 테스트 하려는 실제 테스트 코드를 구현하기 직전에 구현한다.
- 실제 코드를 구현한 다음에 테스트 코드를 만들면
- 실제 코드가 테스트하기 어렵다는 사실을 발견할지 모른다.
- 어떤 실제 코드는 테스트하기 너무 어렵다고 판명날지 모른다.
- 테스트가 불가능하도록 실제 코드를 설계할지도 모른다.
깨끗한 테스트 코드라는 주제는 책 한 권을 할애해도 모자랄 주제다.
테스트 코드는 실제 코드만큼이나 프로젝트 건강에 중요하다.
테스트 코드는 실제 코드의 유연성, 유지보수성, 재사용성을 보존하기 강화하기 때문에
어쩌면 실제 코드보다 더 중요할지도 모른다.
그러므로 테스트 코드를 지속적으로 깨끗하게 관리하자.
표현력을 높이고 간결하게 정리하자
테스트 API를 구현해 도메인 특화 언어(DSL)를 만들자.
그러면 그만큼 테스트 코드를 짜기가 쉬워진다.
테스트 코드가 방치되어 망가지면 실제 코드도 망가진다. 테스트 코드를 깨끗하게 유지하자.