Java Gradle Project에서 Unit Test코드 작성하기

Test 코드 작성하기

먼저 다음과 같이 간단한 클래스를 만든다. 

public class Calculator {
    public int plus(int x, int y) {
        return x + y;
    }
}

Intellij에서는 클래스 이름(Calculator)에서 Code Generate를 실행하면 Test코드를 작성할 수 있다. 


이때 Destination package는 소스 코드와 동일하게 지정해야 추후 관리하기 쉽다. 

테스트 이름 명명법

given, when, then 으로 이름을 구성한다. 그러면 해당 테스트에 대한 입력, 실행, 출력을 쉽게 파악할 수 있다.
그리고 테스트 코드도 given, when, then의 영역으로 나누어 구성한다. given에서는 입력 데이터, 객체들, 목(mock)을 준비하고, When에서는 실행될 함수들을 기술한다. 그리고 Then에서는 assertion을 사용하여 출력값과 기대값을 확인한다. 

테스트는 반드시 기대값과 실제값을 확인해야 한다. 이를 위해 Assertion.assertEquals와 같은 함수를 사용한다. 다음은 이와 같은 규칙에 의해 작성한 테스트 코드다.

class CalculatorTest {
    @Test
    void givenTwoIntegers_whenPlus_thenReturnSum() {
        // given
        Calculator calculator = new Calculator();
        int inputX = 1;
        int inputY = 2;

        // when
        int actual = calculator.plus(inputX, inputY);
        int expected = 3;

        // then
        assertEquals(expected, actual);
    }
}

테스트 코드 작성 요령

1. 하나의 테스트에서는 하나의 동작만을 테스트한다. 

어디서 문제가 발생했는지 알기 쉽고, 해당 테스트의 목적을 이해하기 쉽다. 

2. 외부 서비스 Mock하기 

외부 서비스와 연동되는 경우에는 Mockito, EasyMock, JMockit과 같은 프레임워크를 사용하여 외부 서비스를 직접 호출하지 않고도 입력/출력 데이터를 지정하여 테스트 코드를 작성할 수 있다. 

3. 80% 커버리지 

커버리지는 높을 수록 좋지만 100%를 추구하는 것이 언제나 적합하지는 않을 수 있다. JaCoCo나 Cobertura와 같은 코드 커버리지 레포트 도구를 사용하여 80% 이상을 목표로 삼는 것이 일반적으로 적합하다. 

4. TDD 

Test-Driven Development는 기능 개발 전에 테스트 코드부터 작성하는 개발 방법론이다. 일견 상식을 뒤집는 개발 방법론 같지만 테스트 코드부터 작성하는 것이 가져다주는 혜택은 곱씹어 볼만하다. 그 첫 번째 혜택은 개발을 시작하기 전에 올바른 입출력 패턴을 먼저 생각하게 해준다는 점이다. 막연하게 구현부터 하다가 예상치 못한 입출력 패턴을 뒤늦게 깨닫게 되어 버그를 만들거나 다시 작성하는 사태를 미연에 방지해 준다. 두 번째 혜택은 테스트하기 쉬운 코드를 작성하게 해준다는 점이다. 구현을 다 마치고 나서 테스트를 작성하려고 하면 크게 수정해야 할 수도 있는데 TDD는 이를 사전에 방지하는 개발 방법론인 것이다. 그리고 테스트하기 쉬운 코드란 곧 가독성이 좋은 코드라고도 볼 수 있다. 테스트 코드를 작성하기 위해서는 메서드 단위로 입출력 관계가 명확해야 하기 때문이다.

코드테스트 코드가 충실히 갖춰져 있다면 나중에 기능 수정을 하거나 리팩토링을 할 때도 안심하고 수정할 수 있어 개발 생산성이 증대된다. 

5. 자동화 

유닛 테스트의 실행은 CI-CD를 통해 자동화되어야 한다. 어떠한 수정 사항이 기존 기능에 문제를 불러일으키지는 않는지를 사람의 논리로는 일일이 다 헤아릴 수가 없다. 자동화된 검증이 필요하다. 

댓글

댓글 쓰기

이 블로그의 인기 게시물

Java의 Matcher를 활용한 정규식 검색 및 추출

Java에서는 정규식 패턴 확인 및 추출을 위해 Matcher class의 find()나 matches() 메소드를 사용하게 된다. find()는 하나의 문자열 안에 여러 개의 정규식 패턴을 찾을 때 사용하며, matches()는 하나의 문자열과 하나의 정규식 표현이 일치하는지를 확인할 때 사용한다.  find() 메소드 Matcher.find()는 하나의 문자에 여러 개의 정규식 패턴을 찾을 때 사용한다. 주어진 문자열에 정규식에 해당하는 n개의 패턴이 있다면 find()를 n번째 호출할 때까지는 true가 반환되며 이후 false가 반환된다. find()가 true일때는 start(), group(), end()메소드를 호출할 수 있다. start는 문자열 내에서 정규식 패턴이 발견된 문자열의 시작 index, end는 끝 index를 의미한다. gruop은 정규식 패턴에 해당하는 문자열 자체를 반환한다. Pattern stringPattern = Pattern.compile("[a-zA-Z]+"); Matcher m = stringPattern.matcher("hello there how are you"); while (m.find()) { int start = m.start(); String group = m.group(); int end = m.end(); System.out.println("position [%d, %d] = %s".formatted(start, end, group)); } 위 코드를 실행하면 다음과 같이 출력된다. position [0, 5] = hello position [6, 11] = there position [12, 15] = how position [16, 19] = are position [20, 23] = you find(int start) find를 호출할 때 int start라는 인자를 지정하면 해당 인덱스로부터 정규식...
자세한 내용 보기

Java8 Stream API

  개요 Java8에서 도입된 Stream API에 대해 알아보자. Stream API는 lambda식, Optional등과 함께 반드시 알아야 할 Java8의 기능이다. Stream생성 Stream을 만드는 방법은 다양하다. 한 가지 중요한 특징은  stream을 만들어서 연산을 적용하더라도 원본 데이터는 변하지 않는다 는 점이다. 따라서 하나의 원본 데이터에서 여러 개의 stream을 만들어서 사용해도 무방하다.   빈 Stream 생성 Stream<String> emtpyStream = Stream.empty();   Collection으로부터 생성 List나 Set과 같은 Collection으로부터 Stream을 만들 수 있다. Collection<String> list = Arrays.asList("s1", "s2", "s3"); Stream<String> streamFromList = list.stream(); Set<String> set = new HashSet<>(Arrays.asList("a", "b", "b")); Stream<String> streamFromSet = set.stream();   배열로부터 생성 String[] arr = new String[]{"s1", "s2", "s3"}; Stream<String> stream = Arrays.stream(arr);   builder를 사용하여 생성 Stream<String> stream = S...
자세한 내용 보기