[Java] JUnit, AssertJ의 개념 및 기초적인 사용법 (단정문, 어노테이션)

JUnit의 개념 및 assert 메소드(단정문), 어노테이션

출처 : 링크1, 링크2, 링크3, 링크4. 감사합니다🙇‍♀️🙇‍♀️

JUnit이란?

자바를 위한 단위 테스트 라이브러리(오픈소스)이다.

자바 애플리케이션에 대한 단위 테스트를 쉽게 해 주는 테스트용 프레임워크라고 이해하면 된다.

org.junit

• 단정문 (assert...())으로 테스트 케이스의 수행결과를 판별해 알려준다.
• 어노테이션으로 테스트가 간결해지도록 지원한다.
• 테스트 결과를 Test클래스로 남김으로써 테스트 history를 저장할 수 있다.

단위 테스트 Unit Test란?

모든 함수와 메소드에 대한 테스트 케이스 test cate를 작성하는 절차.

소스코드의 특정 모듈이 의도대로 정확히 동작하는지 검증한다.

System.out.println()로 매번 사람이 동작 결과를 확인해야 하는 테스트 및 디버깅 과정을 쉽게 한다.

JUnit의 assert 메소드들

• assertEquals(A, B) : 객체 A와 B가 같은 값을 가지는지 확인한다.
• assertEquals(A, B, C) : 객체 A와 B가 같은 값을 가지는지 확인한다. C는 오차범위.
• assertArrayEquals(A, B) : 배열 A와 B가 일치하는지 확인한다.
• assertSame(A, B) : 객체 A와 B가 같은 객체인지 확인한다.
• assertTrue(A) : 조건 A가 참인지 확인한다.
• assertNull(A) : 객체A가 Null인지 확인한다.
• assertNotNull(A) 객체 A가 Null이 아닌지 확인한다.

assertThat()도 있지만, AssertJ의 사용법이 더 쉬운 것 같아 나중에 AssertJ 공부할 때 더 자세히 알아보고 같이 정리해야겠다.

JUnit의 어노테이션

• @Test
  : 메소드 위에 해당 어노테이션을 선언해, 테스트 대상 메소드임을 지정할 수 있다.
• @Test(timeout=밀리초)
  : 테스트 메소드 수행 시간을 제한할 수 있다.
  테스트메소드가 리턴값을 반환하는 데에 걸리는 시간이 지정된 밀리초를 넘긴다면 해당 테스트는 실패로 판별한다.
• @Test(expected=예외)
  : 해당 테스트 메소드 예외 발생 여부에 따라 성공/실패를 판별할 수 있다.
  expected=에 지정된 예외가 발생해야 테스트가 성공한 것으로 판별한다.
• @Ignore
  : 해당 어노테이션이 선언된 테스트 메소드를 실행하지 않도록 지정한다.
• @BeforeEach == (구)@Before
  : 모든 @Test메소드가 실행되기 전에 실행되는 메소드를 지정하는 어노테이션이다.
  • 각 테스트 시작 전에 각각 호출된다.
  • @Test메서드에서 공통으로 사용되는 코드를 @Before메서드에 선언해 사용하면 좋다.
  • 테스트마다 공통으로 쓰이면서, 테스트 전에 리셋되어야 할 항목이 들어간다
• @AfterEach == (구)@After
  : 모든 @Test메소드의 실행이 끝난 뒤에 실행되는 메소드를 지정하는 어노테이션이다.
  • 각 테스트가 끝나고 각각 호출된다.
• @BeforeAll == (구)@BeforeClass
  : 해당 테스트 클래스가 실행될 때 딱 한 번만 수행되는 테스트 메소드를 지정하는 어노테이션이다.
• @AfterAll == (구)@AfterClass
  : 해당 테스트 클래스가 실행이 끝난 뒤에 딱 한 번만 수행되는 테스트 메소드를 지정하는 어노테이션이다.
  • 테스트클래스의 모든 테스트가 완료된 뒤 한 번 호출된다.

---

AssertJ

출처 : AssertJ , AssertJ 공식 가이드, AssertJ API 감사합니다🙇‍♀️🙇‍♀️

AssertJ란

자바 JUnit의 테스트코드에 사용되어, 테스트코드의 가독성과 편의성을 높여 주는 라이브러리.

• 메서드 체이닝을 지원해, 더 직관적이고 읽기 쉬운 테스트코드 작성 가능
• 테스트에 필요한 풍부한 메소드들을 제공함

자바 8 이상은 AssertJ 3.x버전을 사용해야 한다.

• 자바 8 기준, Gradle에서는 testCompile 'org.assertj:assertj-core:3.6.2'로 사용한다

AssertJ 메소드 임포트

import static org.assertj.core.api.Assertions.*;
import org.junit.jupiter.api.Test;

static 임포트를 통해 AssertJ의 다양한 API를 클래스 이름 없이 사용 가능함.

AssertJ의 assert 메소드

AssertJ에서 모든 테스트 코드는 assertThat()으로 시작함.

• assertThat(테스트 타겟).메소드1().메소드2().메소드3()'
  이런 포맷으로 AssertJ의 여러 메소드들을 연쇄적으로 호출해 코드를 작성할 수 있다.
  (메서드 체이닝)

예제 - 문자열 테스트

isNotEmpty(), contains(e), doesNotContain(e), startsWith(e), endsWith(e), isEqualTo(e)

assertThat("Hello, world! Nice to meet you.") // 주어진 "Hello, world! Nice to meet you."라는 문자열은
                .isNotEmpty() // 비어있지 않고
                .contains("Nice") // "Nice"를 포함하고
                .contains("world") // "world"도 포함하고
                .doesNotContain("ZZZ") // "ZZZ"는 포함하지 않으며
                .startsWith("Hell") // "Hell"로 시작하고
                .endsWith("u.") // "u."로 끝나며
                .isEqualTo("Hello, world! Nice to meet you."); // "Hello, world! Nice to meet you."과 일치합니다.

예제 - 숫자 테스트

assertThat(3.14d) // 주어진 3.14라는 숫자는
                .isPositive() // 양수이고
                .isGreaterThan(3) // 3보다 크며
                .isLessThan(4) // 4보다 작습니다
                .isEqualTo(3, offset(1d)) // 오프셋 1 기준으로 3과 같고
                .isEqualTo(3.1, offset(0.1d)) // 오프셋 0.1 기준으로 3.1과 같으며
                .isEqualTo(3.14); // 오프셋 없이는 3.14와 같습니다

AssertJ의 메서드들

우선은 현재 사용하고 있는 org.assertj.core.api 패키지의 메서드들 중심으로 정리했다.

메서드들이 너무 많아서 당장 쓸 수 있을 만한 것으로 추려서 정리했다.

(영어를 잘 하지 않습니다. 이해되는 부분만 정리했습니다.)

출처 : assertJ 공식 웹페이지 - Package org.assertj.core.api

일반

Assert 인터페이스
: 모든 Assertion 객체가 기본적으로 제공함

• isEqualTo(Object o) : 실제 값이 주어진 값과 같은지 확인
  isNotEqualTo(Object o) : 실제 값이 주어진 값과 같지 않은지 확인

• isInstanceOf(Class<?> type) , isInstanceOfAny(Class<?> ... types)
  : 실제 값이 주어진 유형의 인스턴스인지 확인
  isNotInstanceOf(Class<?> type), isNotInstanceOfAny(Class<?> ... types)는 그 반대.

• isExactlySameInstanceOf(Class<?> type)
  : 실제 값이 정확히 주어진 유형의 인스턴스인지 확인
  isNotExactlyInstanceOf(Class<?> type) 는 그 반대.

• asList() : 실제 값이 List의 인스턴스인지 확인하고 list Assertion을 반환

• asString() : toString()으로 실제 값에 대한 문자열을 반환

• hasSameClassAs(Object o), doesNotHaveSameClassAs(Object o)
hasSameHashCodeAs(Object o), doesNotHaveSameHashCodeAs(Object o)

  : 실제 값 / 객체가 주어진 객체와 동일한 클래스 / 해시코드를 가지고 있는지 확인
  doesNot이 붙은 메소드는 반대로, 가지고 있지 않은지를 확인

• hasToString(String str), doesNotHaveToString(String str)
  : 실제 actual.toString()값이 주어진 String과 같은지 확인
  doesNot이 붙은 메소드는 반대로, 같지 않은지 확인

• isIn(Iterable<?> v), isIn(Object ... v)
  : 주어진 iterable 또는 값 배열에 실제 값이 있는지 확인
  isNotIn(Iterable<?> v), isNotIn(Object ... v)은 그 반대.

• isNull() : 실제 값이 null인지 확인.
  isNotNull()은 그 반대.

• isSameAs(Object o) : ==비교를 사용해 실제 값이 주어진 값과 동일한지 확인.
  isNotSameAs(Object o)는 그 반대.

그 외..

• as("설명") : Assertion을 설명하는 메서드. "설명"의 내용이 테스트 결과에 출력되도록 할 수 있다.

숫자 관련 메서드

NumberAssert인터페이스

• isBetween(start, end)
  : 실제 값이 start에서 end 값 사이에 있는지 확인함. (start, end 값을 포함함)
• isStrictlyBetween(start, end)
  : 실제 값이 start에서 end 값 사이에 있는지 확인함. (start, end 값을 포함하지 않음)
• isCloseTo(expected, offset) , isCloseTo(expected, percentage)
  : 실제 숫자가 주어진 offset / percentage 내에서 expected에 가까운지 확인.
  차이가 offset / percentage와 같으면 Assertion은 유효한 것으로 간주함.
• isNotCloseTo(expected, offset) , isNotCloseTo(expected, percentage)
  : 실제 숫자가 주어진 offset / percentage 내에서 expected에 가깝지 않은지 확인.
  차이가 offset / percentage와 같으면 Assertion은 실패한 것으로 간주함.
• isPositive(), isNegative()
  : 실제 값이 양수인지 / 음수인지 확인함.
• isNotPositive(), isNotNegative()
  : 실제 값이 양수가 아닌지 (음수이거나 0인지) / 음수가 아닌지 (양수이거나 0인지) 확인함.
• isZero() : 실제 값이 0인지 확인.
  isNotZero() :실제 값이 0이 아닌지 확인.
• isOne() : 실제 값이 1과 같은지 확인

부동소수점 숫자 관련 메서드

FloatingPointNumberAssert 인터페이스

숫자 관련 메서드에 더해, 아래의 메소드를 추가적으로 사용 가능하다.

• isNaN() : 실제 값이 NaN과 같은지 확인.

  isNotNaN() : 실제 값이 NaN과 같지 않은지 확인.

• isFinite(), isInfinite()

AssertJ 사용시 주의점

• assertThat(Object o)로 테스트할 객체를 호출한 다음 메서드들을 사용해야 한다.

  • BAD : assertThat(actual.equals(expected));
    GOOD : assertThat(actual).isEqualTo(expected);
  • BAD : assertThat(1 == 2);
    GOOD : assertThat(1).isEqualTo(2);

• as()는 assertion 메소드들을 호출하기 전에 사용해야 한다.

  • BAD

    // DON'T DO THIS ! as/describedAs have no effect after the assertion
    assertThat(actual).isEqualTo(expected).as("description");
    assertThat(actual).isEqualTo(expected).describedAs("description");

  • GOOD

    // DO THIS: use as/describedAs before the assertion
    assertThat(actual).as("description").isEqualTo(expected);
    assertThat(actual).describedAs("description").isEqualTo(expected);

https://steady-coding.tistory.com/349?category=861122 JUnit 정리
https://steady-coding.tistory.com/351 AssertJ 정리
나중에 참고해서 공부 후 정리하기!