JUnit 사용기 (feat. IntelliJ)

JUnit : 자바 단위 테스트 작성을 위한 테스팅 프레임워크

JUnit 시작하기

Java(no Spring) , IntelliJ (2022.2.3 ver), gradle 사용

 

Junit은  spring-boot-starter-test dependency에 포함되어있기 때문에 따로 의존성을 추가해줄 필요가 없다. Spring Initializr시 자동으로 추가되어진다. 

 

maven dependency

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>

 

프로젝트를 생성하고 gradle 빌드를 마치면 자동으로 test 폴더가 생성된다.

 

테스트 폴더를 우클릭해서 직접 test class 파일을 생성해도 되고 test 원하는 class를 우클릭해서 test 파일을 생성해도된다.

 

testing library에 JUnit을 선택하고 하단에 해당 라이브러리가 포함되어있지 않다는 문구가 나오면 fix를 눌러 추가해 줍니다.

 

---

테스트 코드 작성

테스트 코드를 작성하기 전 단위 테스트(Unit Test)에 대해서 알아보자.

단위 테스트란?

하나의 모듈을 기준으로 독립적으로 진행되는 가장 작은 단위의 테스트. 여기서 모듈은 어플리케이션에서 작동하는 하나의 기능 또는 메소드로 이해할 수 있다.

 

 

단위 테스트 모범

• 1개의 테스트 함수는 1가지 개념 만을 테스트 하라.
• 명확하고 일관된 네이밍 규약을 준수하라
• 데스트 안에 의도와 목적이 들어나게 작성한다. (어떤 조건 - 어떤 수행 - 어떤 결과)
• 어떤 모듈에서 코드 변화가 있는 경우, 반드시 모둘에 대해 상응하는 단위 테스트가 이뤄줘야한다.
• 1개의 테스트 함수에 대해 assert를 최소화 하라.

 

 

좋은 단위 테스트의 속성 (FIRST)

• Fast : 실행이 빨라야한다.
• Independent : 테스트 하고자 하는 단위 기능에 집중되야한다. 독립적이며 다른 테스트에 의존하지 않는다.
• Repeatable : 반복이 가능해야하며, 항상 같은 결과를 반환해야한다.
• Self-Validating : 자체 검증이 가능해야한다. 테스트 자체적으로 결과를 알수있어야한다.
• Timely : 적시에, 실제 구현 직전에 구현되어야 한다.

 

 

주의 사항

• 내가 짠 코드가 아닌것 처럼 테스트 코드를 작성하라.
  • ‘중복이 불가능하게 짰으니까 중복 체크는 안해도 될꺼야’ 라는 생각 버리기. 구현은 언젠가 어떻게든 변할 수 있다. 구현에 대한 테스트가 아닌 설계에 대한 테스트를 해야한다.

 

• private 메소드 테스트
  • private 행위를 가지고 있는 비즈니스 로직(상위 메소드) 테스트만 추가될뿐 우리가 그 안쪽(private 메소드)까지 들여다볼 필요가 없다. 이렇게 구현했을때 뭔가 어설프고 이상하다 싶으면 private함수가 그 안에 있지 않았어야할 확률이 크다. 즉 코드 구현을 잘못했다는 것!

• Non-testable
  • Random, LocalDate.now(),Shuffle
  • 외부 세계 (HTTP, 외부 저장소)
  → Non-testable이 있을 경우 결국 바깥쪽 모든 모듈을 테스트를 할 수 없게된다. 그러면 어떤 식으로 테스트를 해야할까?

 

유튜브에 올라온 스프링캠프 세션을 보고 작성했습니다. 테스트에 관해 좋은 인사이트를 얻을 수 있는 유익한 강의입니다. 꼭 보시길 추천합니다! 출처 → https://www.youtube.com/watch?v=YdtknE_yPk4&ab_channel=springcamp.io

 

 

 

단정문(assert)

적합성을 검증하기 위한 메소드로 ‘~하길 기대한다’ 정도로 해석하면 될것같다.

 

assertEquals(a, b) : 객체 a와 b가 같은 값인지 확인

assertSame(a, b) : 객체 a와 b가 같은 객체인지 확인

assertNull(a) / assertNotNull(a) : a가 null 인지/아닌지 확인

assertTrue(a) / assertFalse(a) : a가 참인지/거짓인지 확인

assertArrayEquals(배열1, 배열2) : 배열a와 b가 같은지 확인

 

assertThat : 검증 값이 특정 상황을 만족하는지 검증

JUnit 4.4부터 asserThat 메소드가 추가됐다. 여러 matcher를 지원하여 좀 더 유연성 있게 단정문을 사용할 수 있다.

참고 → https://jongmin92.github.io/2020/03/31/Java/use-assertthat/

그외 다양한 단정문 확인 → https://junit.sourceforge.net/javadoc/org/junit/Assert.html

 

 

 

이노테이션(@)

 

@Test : 단위 테스트 매소드임을 명시 (static & private X), timeout/exception을 매개변수로 지정 가능

@BeforeClass : 모든 단위 테스트 실행 전 최초 한번 실행 (DB 연결 시 드라이버 로딩 등을 테스트 합니다.)

@AfterClass : 모든 단위 테스트 실행 후 마지막으로 한번 실행

@BeforeEach : 단위 테스트 실행 전마다 실행

@AfterEach : 단위 테스트 실행 후마다 실행

@Disabled : 해단 단위 테스트 실행하지 않음

@DiaplayName : 실행 창에 해당 단위 테스트의 메소드 명 대신 parameter 값을 출력

 

실행순서 : @BeforeClass → @BeforeEach → @Test → @AfterEach → @AfterClass

 

 

계산기 테스트 코드 작성

제가 맘대로 짜봤습니다..^&^

class postfixCalculationTest {
    private static Calculation calculation = new postfixCalculation();

    // 1. 잘못된 표현의 input 테스트
    @DisplayName("숫자와 사칙연산자만 제외한 문자 입력 테스트")
    @Test
    void CalculatorOtherInput(){
        final String input = "4 % 7";
        Optional<String> result = calculation.getResult(input);
        assertSame(Optional.empty(),result);
    }

    @DisplayName("연산자와 숫자 사이의 공백이 포함되지않은 입력 테스트")
    @Test
    void CalculatorNonSpaceInput(){
        final String input = "7+3-1";
        Optional<String> result = calculation.getResult(input);
        assertSame(Optional.empty(),result);
    }

    @DisplayName("피연사자 자연수가 아닌 입력 테스트")
    @Test
    void CalculatorNonNatualNumInput(){
        final String input = "2.2 + 7";
        Optional<String> result = calculation.getResult(input);
        assertSame(Optional.empty(),result);
    }

    // 2. 계산 결과 테스트
    @DisplayName("올바른 계산 - 연산자 우선순위 미포함")
    @Test
    void CalculatorBasicOperator(){
        final String input = "7 * 20 - 9";
        Optional<String> result = calculation.getResult(input);
        assertEquals("131",result.get());
    }

    @DisplayName("올바른 계산 - 연산자 우선순위 포함")
    @Test
    void CalculatorOrderOfOperator(){
        final String input = "82 + 2 * 4";
        Optional<String> result = calculation.getResult(input);
        assertEquals("90",result.get());
    }

}

 

---

 

➕

@ParameterizedTest

중복되는 코드 제거를 위한 이노테이션. 

위 코드와 같이 중복 코드가 많은 코드는 좋은 방식이 아니며 중복 코드를 제거하기 위해 사용하는 방식이다.

 

1. gradle dependency 추가

testImplementation 'org.junit.jupiter:junit-jupiter-params:5.4.2'

2. 사용해보기

class OperatorTest {

    DecimalFormat resultBuffer = new DecimalFormat("#.##");

    @ParameterizedTest(name = "{index}: {0}")
    @MethodSource("calculateParameters")
    @DisplayName("사칙연산 계산")
    void calculate(String name, double num1, double num2, String operator, String result) {
        assertEquals(resultBuffer.format(Operator.of(operator).result(num1,num2)),result);
    }

    private static Stream<Arguments> calculateParameters() {
        return Stream.of(
                Arguments.of("더하기",1,2,"+","3"),
                Arguments.of("빼기",3,5,"-","-2"),
                Arguments.of("곱하기",77,3,"*","231"),
                Arguments.of("나누기",2,7,"/","0.29")
        );
    }

    @ParameterizedTest(name = "{index}: {2}")
    @MethodSource("validParameters")
    @DisplayName("연산자 유효성 검사")
    void validOperator(double num1, double num2, String operator, String errMsg){
        Exception error = assertThrows(Exception.class,()-> Operator.of(operator));
        assertEquals(error.getMessage(),errMsg);
    }

    private static Stream<Arguments> validParameters(){
        return Stream.of(
                Arguments.of(1,2,"%","입력 오류 : 잘못된 연산자 혹은 문자가 포함되어 있습니다."),
                Arguments.of(3,5,"dd","입력 오류 : 잘못된 연산자 혹은 문자가 포함되어 있습니다."),
                Arguments.of(77,3,"&","입력 오류 : 잘못된 연산자 혹은 문자가 포함되어 있습니다.")
        );
    }

}

 

---

테스트 실행

작성을 마친뒤 테스트 class를 Run 시키면 테스트가 실행된다.

 

통과된 목록을 볼 수 있습니다.

 

---

마치며

소프트웨어 테스트에 관해 찾아볼수록 깊게 공부해야할 분야라는 생각이 든다. 다양한 방법론이나 TDD에 관해서도 지속가능한 개발자가 되기 위해선 필수로 익힐 필요가 있어보인다. 그러니 앞으로도 화이팅

 

 

 

reference.

https://mangkyu.tistory.com/143

https://sakjung.tistory.com/33

https://www.youtube.com/watch?v=YdtknE_yPk4&ab_channel=springcamp.io

https://jongmin92.github.io/2020/03/31/Java/use-assertthat/

 

 

잘못된 정보가 있다면 댓글을 통해 알려주세요. 감사합니다.