[노개북 1기] TIL (2022.02.07)

yourjin·2022년 2월 26일
클린코드
0

read.log

목록 보기
19/37
post-thumbnail

TIL (2022.02.07)

DAY 16

🔖 오늘 읽은 범위 : 9장, 단위 테스트

😃 책에서 기억하고 싶은 내용을 써보세요.

  • 깨끗한 테스트 코드

    이전 내용 복습

    • 깨끗한 테스트 코드를 만들려면? 세 가지가 필요하다. 가독성,가독성,가독성
    • 테스트 코드는 최소의 표현으로 많은 것을 나타내야 한다.*
    • SerializedPageResponderTest.java
      public void testGetPageHieratchyAsXml() throws Exception
{
	// PathParser는 문자열을 pagePath 인스턴스로 변환한댜.
	// pagePathsms 웹 로봇(crawler)이 사용하는 객체다.
	crawler.addPage(root, PathParser.parse("PageOne") ) ;
	crawler.addPage(root, PathParser.parse("PageOne.ChildOne") ) ;
	crawler.addPage(root, PathParser.parse("PageTwo") ) ;

	request.setResource("root") ;
	request.addlnput("type", "pages");
	// 이 영역도 PathParser와 마찬가지로 잡음에 불과하다
	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);
}
      • 위 코드의 문제점
        1. (하이라이팅 한 코드들과 같이) 중복되는 코드들이 많다.
        2. 이 코드는 테스트와 무관하며 테스트 코드의 의도만 흐린다.
        3. 위 코드는 읽는 사람을 고려하지 않는다. (불쌍한 독자들은 온갖 잡다하고 무관한 코드를 이해한 후라야 간신히 테스트 케이스를 이해한다.)
    • SerializedPageResponderTest.java (리팩터링한 코드)
      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 testSymboliclinksAreNotlnXmlPageHierarchy( ) 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. 세 번째 부분은 조작한 결과가 올바른지 확인한다.
    • 테스트 코드는 본론에 돌입해 진짜 필요한 자료 유형과 함수만 사용한다.
    • 도메인에 특화된 테스트 언어
      • 위의 “SerializedPageResponderTest.java (리팩터링한 코드)”는 도메인에 특화된 언어(DSL)로 테스트 코드를 구현하는 기법을 보여준다
      • 흔히 쓰는 시스템 조작 API를 사용하는 대신 API 위에다 함수와 유틸리티를 구현한 후 그 함수와 유틸리티를 사용하므로 테스트 코드를 짜기도 읽기도 쉬워진다.
        • 이렇게 구현한 함수와 유틸리티는 테스트 코드에서 사용하는 특수 API가 된다. 즉, 테스트를 구현하는 당사자와 나중에 테스트를 읽어볼 독자를 도와주는 테스트 언어다.
      • 이런 테스트 API는 처음부터 설계된 API가 아니다. 잡다하고 세세한 사항으로 범벅된 코드를 계속 리팩터링하다가 진화된 API다.
    • 이중 표준
      • 테스트 API에 적용하는 표준은 실제 코드에 적용하는 표준과 확실히 다르다. 단순하고, 간결하고, 표현력이 풍부해야 하지만, 실제 코드만큼 효율적인 필요는 없다. 실제 환경이 아니라 테스트 환경에서 돌아가는 코드이기 때문이다.
      • EnvironmentControllerTest.java
        @Test
public void turnOnLoTempAlarmAtThreashold() throws Exception {
	hw.setTemp(WAY_TO_COLD);
	// 문제점1. tic() 함수가 무엇일까? 궁금하게 함
	controller.tic();
	// 문제점2. 코드를 점검하는 상태 이름과 상태 값을 확인하느라 눈길이 여기저기 흩어진다.
	assertTrue(hw.heaterState());
	assertTrue(hw.blowerState());
	assertFalse(hw.coolerState());
	assertFalse(hw.hiTempAlarm());
	assertTrue(hw.loTempAlarm());
}
      • EnvironmentControllerTest.java (리펙터링)
        @Test
public void turnOnLoTempAlarmAtThreshold() throws Exception {
	wayTooCold();
  // 실제 환경에서는 안되지만, 테스트 환경에서는 문제 없는 코드!
  // 일단 "HBchL"이 의미하는 바만 안다면 눈길이 문자열을 따라 움직이며 결과를 재빨리 판단한다.
	assertEquals("HBchL", hw.getState());
}
      • 하지만 이 애플리케이션은 확실히 실시간 임베디드 시스템이다. 즉, 컴퓨터 자원과 메모리가 제한적일 가능성이 높다. 하지만 테스트 환경은 자원이 제한적일 가능성이 낮다.
      • 실제 환경에서는 절대로 안 되지만 테스트 환경에서는 전혀 문제없는 방식이 있다. 대개 메모리나 CPU 효율과 관련 있는 경우다. 코드의 깨끗함과는 철저히 무관하다.
  • 테스트 당 assert 하나
    • JUnit으로 테스트 코드를 짤 때는 함수마다 assert 문을 단 하나만 사용해야 한다고 주장하는 학파가 있다.
    • assert 문이 단 하나인 함수는 결론이 하나라서 코드를 이해하기 쉽고 빠르다.
    • SerializedPageResponderTest.java
      public void testGetPageHierarchyAsXml( ) throws Exception {
	givenPages("PageOne", "PageOne.ChildOne", "PageTwo");
	
	whenRequestIsissued("root", "type:pages");
	
	// assert1. 출력이 XML이다.
	thenResponseShouldBeXML();
}

public void testGetPageHierarchyHasRightTags( ) throws Exception {
	givenPages("PageOne", "PageOne.ChildOne", "PageTwo");
	
	whenRequestIsIssued("root", "type: pages") ;
	
// assert2. 특정 문자열을 포함한다.
	thenResponseShouldContain(
		"<name>PageOne</name>", "<name>PageTwo</name>", "<name>ChildOne</name>"
	);
}
      • 2개의 assert 문을 하나로 병합하는 방식이 불합리해 보인다. 이 경우 테스트를 두 개로 쪼개 각자가 assert를 수행하면 된다.
      • 위에서 함수 이름을 바꿔 given-when-then 이라는 관례를 사용했다는 사실에 주목한다. 그러면 테스트 코드를 읽기가 쉬워진다.
      • 불행하게도, 위에서 보듯이, 테스트를 분리하면 중복되는 코드가 많아진다.
      • TEMPLATE METHOD 패턴을 사용하면 중복을 제거할 수 있다. (...) 하지만 모두가 배보다 배꼽이 더 크다.
    • 이것저것 감안해 보면 결국 assert 문을 여럿 사용하는 편이 좋다고 생각한다.
    • 대체로 나는 단일 assert를 지원하는 해당 분야 테스트 언어를 만들려 노
      력한다. 하지만 때로는 주저 없이 함수 하나에 여러 assert 문을 넣기도 한다. 단지 assert 문 개수는 최대한 줄여야 좋다는 생각이다.
  • 테스트 당 개념 하나
    • 어쩌면 “테스트 함수마다 한 개념만 테스트하라”는 규칙이 더 낫겠다.
    • 목록 9-8은 독자적인 개념 세 개를 테스트하므로 독자적은 테스트 세 개로 쪼개야 마땅하다. 세 개념을 한 함수로 몰아 넣으면 독자가 각 절이 거기에 존재하는 이유와 각 절이 테스트하는 개념을 모두 이해해야 한다.
    • 그러므로 가장 좋은 규칙은 “개념 당 assert 문 수를 최소로 줄여라”와 “테스트 함수 하나는 개념 하나만 테스트하라” 라 하겠다.
  • F.I.R.S.T
    • 깨끗한 테스트는 다음 다섯 가지 규칙을 따르는데, 각 규칙 에서 첫 글자를 따오면 FIRST가 된다.
    1. Fast(빠르게)
      • 테스트는 빨라야 한다.
      • 테스트가 느리면 자주 돌릴 엄두를 못 낸다.
    2. Independent(독립적으로)
      • 각 테스트는 서로 의존하면 안 된다.
      • 테스트가 서로에게 의존하면 하나가 실패할 때 나머지도 잇달아 실패하므로 원인을 진단하기 어려워지며 후반 테스트가 찾아내야 할 결함이 숨겨진다.
    3. Repeatable(반복가능하게)
      • 테스트는 어떤 환경에서도 반복 가능해야 한다.
      • 테스트가 돌아가지 않는 환경이 하나라도 있다면 테스트가 실패한 이유를 둘러댈 변명이 생긴다.
    4. Self-Validating(자가검증하는)
      • 테스트는 부울(bool) 값으로 결과를 내야 한다. 성공 아니면 실패다.
      • 통과 여부를 알려고 로그 파일을 읽게 만들어서는 안 된다.
      • 테스트가 스스로 성공과 실패를 가늠하지 않는다면 판단온 주관적이 되며 지루한 수작업 평가가 필요하게 된다.
    5. Timely(적시에)
      • 테스트는 적시에 작성해야 한다.
      • 단위 테스트는 테스트하려는 실제 코드를 구현하기 직전에 구현한다.
      • 실제 코드를 구현한 다음에 테스트 코드를 만들면 실제 코드가 테스트하기 너무 어렵다는 사실을 발견할지도 모른다. 테스트가 불가능하도록 실제 코드를 설계할지도 모른다.
  • 결론
    • 테스트 코드는 실제 코드만큼이나 프로젝트 건강에 중요하다. 테스트 코드는 실제 코드의 유연성 , 유지보수성 , 재사용성을 보존하고 강화하기
      때문이다.
    • 그러므로 테스트 코드는,
      • 지속적으로 깨끗하게 관리하자.
      • 표현력을 높이고 간결하게 정리하자.
      • 테스트 API를 구현해 도메인 특화 언어(Domain Specific Language, DSL)를 만들자.

🤔 오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요

  • 문득 단위 테스트를 작성할 때, 패턴을 적용하는 이유가 뭔지 궁금해졌다. 아무래도 패턴을 적용하면 효율적으로 작성이 가능하겠지만, 패턴을 적용하지 않는다고 해서 깨끗한 테스트 코드를 유지할 수 없는지도 의문이었다. 같은 팀에서 서로 다른 테스트 규칙을 사용하는 경우도 있나? 아니면 테스트에서도 팀 규칙을 적용해 특정 패턴으로 통일하나? 주변 개발자들과 이런 부분에 대해 이야기 나눠볼 수 있으면 좋겠다!

🔎 궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.

  • 단위 테스트 작성 패턴
    • BUILD-OPERATE-CHECK (= Arrange - Act - Assert (AAA))
    • given-when-then
      • Given: 테스트에서 구체화하고자 하는 행동을 시작하기 전에 테스트 상태를 설명하는 부분
      • When: 구체화하고자 하는 그 행동
      • Then: 어떤 특정한 행동 때문에 발생할 것 이라고 예상되는 변화에 대한 설명
      • 참고 링크: Given-When-Then 패턴
  • TEMPLATE METHOD 패턴
  • API 위에다 함수와 유틸리티를 구현한다(= 테스트 API를 구현한다) ?
    • 이것이 무슨 의미인가...

소감 3줄 요약

  • 테스트 코드는 지속적으로 깨끗하게 관리하자.
  • 테스트 코드는 표현력을 높이고 간결하게 정리하자.
  • 테스트 API를 구현해 도메인 특화 언어(Domain Specific Language, DSL)를 만들자.
profile
yourjin
make it mine, make it yours
이전 포스트

[노개북 1기] TIL (2022.02.06)

다음 포스트

[노개북 1기] TIL (2022.02.08)

0개의 댓글