정대화 블로그

2021. 01. 05.

어제 TIL을 작성하기 위해 다른 팀원의 블로그를 염탐하다 테스트 작성에 어려움을 겪고 있다는 글을 보게 됐다. 오늘 낮에 코드 리뷰를 하며 관련해서 얘기하다 설정하는 법을 알려주게 되었다. 덕분에 이래저래 만져봤던 것을 정리해본다.

JUnit

JUnit은 자바 언어용 단위 테스트 프레임워크다. Java 진영에서 가장 많이 쓰이고 있는 테스트 프레임워크이고 JUnit 없이 TDD를 논하기 힘들 것이다.

JUnit5의 ParametizedTest

JUnit의 최신 버전은 JUnit5인데, 테스트용 매개변수 입력을 아주 강력하게 지원해준다. 테스트를 작성할 때 프레임워크의 도움을 받지 않으면 힘든 부분이 여러 가지가 있겠지만, 개인적으로 가장 힘들었던 부분은 아래 같은 경우이다.

class SomeClass {
    public int someFunction(int a, int b) {
      return a + b;
    }
}
class SomeClassTest {
    SomeClass someClass = new SomeClass();
    public test() {
      System.out.println("test 1 : " + someClass.someFunction(1, 1) == 2);
      System.out.println("test 2 : " + someClass.someFunction(2, 2) == 4);
      System.out.println("test 3 : " + someClass.someFunction(3, 3) == 6);
    }
}

JUnit5 는 ParametizedTest 라는 기능을 제공하는데 이를 이용하면 아래와 같이 수정할 수 있다.

class SomeClassTest {
  @ParameterizedTest
  @CSVSource({
    "1, 1, 2",
    "2, 2, 4",
    "3, 3, 6"
  })
  void someFunction(int a, int b, int expected) {
    SomeClass someClass = new SomeClass();
    int result = someClass.someFunction(a, b);

    assertThat(result).isEqualTo(expected);
  }
}

만약 테스트 케이스가 늘어난다면 @CSVSource 어노테이션의 매개변수로 값만 추가해주면 된다.

이외에도 ParameterizedTest 에 매개변수를 넣는 방법이 여러 가지가 있는데 그 중 MethodSource 를 추천한다. @MethodSource - JUnit 5 User Guide 에 나와있는 설명을 보고 따라하면 금방 익힐 수 있을 것이다.

https://www.baeldung.com/parameterized-tests-junit-5 에도 설명이 잘 나와있다.

내 프로젝트에 설정해보기

인텔리J를 기준으로 작성하는데, 이클립스도 크게 다르지 않다.

크게 세 가지 경우가 있다.

Java 프로젝트
Maven 프로젝트
Gradle 프로젝트

하나씩 살펴보자

공통

어떤 프로젝트든 우선적으로 설정해야 할 것이 있다. Test 소스용 root path를 지정해야 한다.

우선 File-Proejct Structure-Modules에 들어간다.

이클립스는 프로젝트의 Java Build Path에서 설정할 수 있다.

그다음 새 폴더를 생성하고 테스트 디렉토리로 설정한다.

Java Project

Alt + Insert 혹은 Shift + Shift 입력 후 검색을 하여 Generate 를 호출하면 Test... 라는 옵션이 있다.

선택하면 아래와 같은 상자가 나온다. OK를 클릭하자.

아래의 Member에서 원하는 테스트 케이스를 함께 생성할 수도 있다.

생성된 클래스에 @Test 어노테이션을 입력 후 Alt + Enter 를 입력하면 아래와 같은 옵션들이 나온다. JUnit5를 사용할 것이니 선택해준다.

이제 설정이 완료됐다. 이후 테스트 코드를 작성해본다.

초록색 재생 버튼이 나오는데 클릭하면 실행시킬 수 있다. 잘 동작하는지 실행시켜보자.

테스트에 성공했다고 하단에 나온다. 성공이다!

Maven 프로젝트

아래 depencency를 pom.xml에 추가해준다. 이후 Java Proejct 를 따라가면 된다.

<dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter</artifactId>
    <version>RELEASE</version>
    <scope>test</scope>
</dependency>

Gradle 프로젝트

아래 dependency를 build.gradle에 추가해준다. 이후 Java Proejct 를 따라가면 된다.

testCompile group: 'org.junit.jupiter', name: 'junit-jupiter', version: 'latest.release'

단위테스트 그리고 TDD

단위 테스트는 특정 모듈이 의도한 대로 동작하는지 검증하는 절차인데 쉽게 말하면 메소드에 대한 테스트 케이스를 작성하고 잘 동작하는지 확인하는 것이다.

메소드 단위로 확인하기 때문에 제대로 작성만 해놓는다면 문제가 발견하면 어디서 잘못되었는지 파악하기 쉽다. 특히 입력과 출력에 대해 정확히 정의하고 테스트하면 side effect(부작용, 부수효과) 를 줄이는 효과를 줄 수 있다.

또한, 테스트 코드가 잘 짜여있으면 리팩토링을 하더라도 이전과 똑같이 동작하는지 지속적으로 확인할 수 있기 때문에 좀 더 편안한 마음으로 리팩토링을 진행할 수 있다.

마지막으로 상향식 개발 방법을 사용하면 더욱 효과적이다. 쉽게 말하면 메소드가 동작하도록 일단 만든 다음 점진적 개선을 해나가며 개발하는 것이다. 예를 들자면, 아래와 같은 일단 동작만 하는 소스를 만들어 놓고 세부 사항을 추가해가며 구현하는 것이다.

class SomeClass {
    public int someFunction() {
      return 0;
    }
}

class SomeClassTest {
    @Test
    void someFunctionTest() {
      int result = new SomeClass().someFunction();
      int expected = 0;
      assertThat(result).isEqualTo(expected);
    }
}