JUnit에 관하여

🧪 단위 테스트(Unit Test)란 ?

JUnit은 Java 에서 독립된 단위테스트를 지원해주는 프레임워크이기 때문에
단위 테스트에 대해 먼저 알아보겠습니다 💡

 

테스트 대상 단위가 엄격하게 정해져있지는 않지만, 일반적으로 클래스 또는 메소드 수준으로 정해집니다. 단위의 크기가 작을수록 단위의 복잡성이 낮아지고, 실행하려는 기능을 표현하기 더 쉬워지는게 당연하겠죠?

 

단위테스트란 특정 소스코드의 모듈이 의도한 대로 잘 작동하는지 검증하는 테스트입니다.
즉, 함수 및 메소드에 대한 테스트를 하는 작업으로써, Spring에서 단위테스트는 Spring Container에 올라와 있는 Bean 을 테스트 하는 것입니다.

 

💡 단위 테스트의 장점

단위 테스트는 해당 부분만 독립적으로 테스트하기 때문에 어떤 코드를 리팩토링하여도 빠르게 문제 여부를 파악할 수 있습니다.
또한, 개발자는 작성한 테스트 코드를 수시로 빠르게 돌리면서 문제점을 파악할 수 있습니다.
단위 테스트를 진행하는 동안에는 실제 어플리케이션을 동작시킬 때와 마찬가지로 Bean을 테스트 할 수 있습니다 🧑🏼‍💻

 

🧪 JUnit 이란?

• 자바 개발자가 가장 많이 사용하는 테스팅 기반 프레임워크 입니다.
• 현재 가장 많이 사용되고 있는 버전은 JUnit 5 입니다.
• 기본 Junit 4에 비해 JUnit 5는 3가지 모듈로 구성됩니다.
• JUnit5는 테스트 작성자를 위한 API 모듈과 테스트 실행을 위한 API가 분리되어 있습니다.
• 자바 8 이상을 필요로 합니다.

🧪 JUnit 구조

해당 구조에 대해 간단히 알아보겠습니다 💡
기존 버전인 JUnit4에서는 vintage-engine 모듈을 사용해서 테스팅을 진행했습니다.
그러나 이와 달리, JUnit5는 크게 3가지 모듈로 구성됩니다.

JUnit5 = JUnit Platform + JUnit Jupiter + JUnit Vintage

JUnit Jupiter API : JUnit5에 새로 추가된 테스트 코드용 API

• JUnit Platform : 테스트를 발견하고 테스트 계획을 생성하는 TestEngine 인터페이스를 정의 합니다.
  즉, 기초적인 역할을 수행하며 TestEngine API 를 제공합니다.
• JUnit Jupiter : JUnit5에서 테스트 및 Extension을 작성하기 위한 새로운 프로그래밍 모델과 확장 모델의 조합이며, TestEngine API 구현체 입니다.
  JUpiter 는 테스트 코드 작성에 필요한 junit-jupiter-api 모듈과 테스트 실행을 위한 junit-jupiter-engine 모듈로 분리되어 있다.
  • JUnit Jupiter = junit-jupiter-api + junit-jupiter-engine
• JUnit Vintage : JUnit3, JUnit4 를 실행할 수 있는 TestEngine 입니다. 하위 호환성을 위해서 존재합니다.
  TestEngine의 실제 구현체는 별도 모듈로 존재하는데, 이 중 하나가 jupiter-engine 입니다.

🧪 테스트의 Class & Method 어노테이션

Test 역시 자바의 객체로 구성됩니다.
따라서 클래스로 구현을 하기 때문에 Class + Method 형태로 구성됩니다.

• Class : 최상위 클래스, static member class, @Nested class 중 적어도 하나의 메소드를 포함하는 클래스
  • Test Class 는 absctract 이면 안되며, 기본 생성자를 포함해야 합니다 💪
• Test Method : @Test, @RepeatedTest, @TestFactory 등의 어노테이션이 선언되어 있는 메서드로 실제 테스트하고자 하는 내용을 넣습니다.
  • @Test
    : 해당 메소드가 테스트 메소드임을 나타냅니다.
  • @ParametherizedTest
    : 해당 메소드가 매개변수가 있는 테스트임을 나타냅니다.
  • @RepeatedTest
    : 반복되는 테스트 메소드를 나타냅니다. -> @RepeatedTest(3)

• LifeCycle Method : @BeforeAll, @BeforeEach, @AfterAll, @AfterEach 가 선언되어 있는 메서드로 Test 의 Life Cycle에 따라 실행되는 메소드 입니다.
  • @BeforeAll
    : 테스트 Class 기준으로 테스트 메서드들이 실행되기 전 실행
    즉, 테스트 시작 시점에 딱 한번 실행(static 메소드만 가능)
  • @BeforeEach
    : 각 테스트 메서드가 실행되기 전 실행
    일반적으로 Mock 데이터를 미리 세팅하기 위해 사용
  • @AfterAll
    : 테스트 Class 기준을 테스트 메서드들이 실행된 후 실행
    즉, 테스트 종료 시점에 딱 한번 실행(static 메소드만 가능)
  • @AfterEach
    : 각 테스트 메서드가 실행되기 전 실행

🔄 전체적인 Life Cycle
BeforeAll -> BeforeEach -> Test -> AfterEach -> AfterAll

🧪 기타 어노테이션

• @Tag : 테스트 클래스, 메소드에 테스트 구분을 태킹하기 위해 사용
• @Disabled : 해당 클래스나 테스트를 사용하지 않음
• @Timeout : 테스트 실행 시간 선언, 초과되면 실패하도록 설정
• @ExtendWith : 확장을 선언적으로 등록할 때 사용
• @TempDir : 필드 주입 혹은 매개변수 주입을 통해 임시 디렉토리 제공
• @DispayName : 테스트 메소드 이름 설정(기본값 -> 메소드 이름)

🧪 Assertions

org.junit.jupiter.api.Assertions 패키지를 통해 사용 가능

assertArrayEquals

예상 배열(expected)과 실제 배열(actual))이 동일한지 확인합니다.

두 배열이 일치 하지 않다면, 마지막 인자인 메세지가 출력됩니다.

	@Test
	public void whenAssertingArraysEquality_thenEqual() {
	char[] expected = { 'J', 'u', 'p', 'i', 't'};
	char[] actual = "Jupiter".toCharArray();
	assertArrayEquals(expected, actual, "두 배열이 일치하지 않습니다.");
	}

 

assertEquals

두 값을 비교하여 일치하는지 확인합니다.

	@Test
	public void whenAssertingEquality_thenEqual() {
	float square = 2 * 2;
	float rectangle = 2 * 2;
	assertEquals(square, rectangle);
	}

 

실제 값이 예상 값의 차이가 있을 경우, 세 번째 인자로 차이가 나는 값을 가진 delta를 추가합니다

	@Test
	void whenAssertingEqualityWithDelta_thenEqual() {
	float square = 2 * 2;
	float rectangle = 3 * 2;
	float delta = 2;
	assertEquals(square, rectangle, delta);
	}

assertNotEquals

예상 값과 실제 값이 다른지 확인 합니다.

같을 경우 메시지를 출력합니다.

	@Test
	void whenAssertingEquality_thenNotEqual() {
	Integer value = 5;
	assertNotEquals(0, value, "The result cannot be 0");
	}

assertTrue and assertFalse

assertTrue는 주어진 조건이 참인지 확인합니다.

조건이 거짓일 경우 마지막 인자인 메시지를 출력합니다.

	@Test
	void whenAssertingConditions_thenVerified() {
	assertTrue(5 > 4, "5 is greater the 4");
	assertTrue(null == null, "null is equal to null");
	}

 

assertFalse는 주어진 조건이 거짓인지 확인 합니다.

조건이 참일 경우 마지막 인자인 메시지를 출력합니다.

	@Test
	public void givenBooleanSupplier_whenAssertingCondition_thenVerified() {
	assertFalse(5 > 6, "5 is not greater then 6");
	}

assertNull and assertNotNull

assertNull은 객체의 null 여부를 확인 합니다.

객체가 Null이 아닐 경우 메시지를 출력 합니다.

	@Test
	public void whenAssertingNull_thenTrue() {
	Object cat = null;
	assertNull(cat, "The cat should be null");
	}

 

assertNotNull은 객체가 Null이 아닌지를 확인 합니다.

객체가 Null일 경우 메시지를 출력 합니다.

	@Test
	void whenAssertingNotNull_thenTrue() {
	Object dog = new Object();
	assertNotNull(dog, "The dog should not be null");
	}

assertSame and assertNotSame

assertSame은 예상 값과 실제 값이 동일한 객체를 참조하는지 확인 합니다.

	@Test
	public void whenAssertingSameObject_thenSuccessfull() {
	String language = "Java";
	String MyLanguage = "Java";
	assertSame(language, MyLanguage);
	}

 

반대로, assertNotSame은 예상 값과 실제 값이 다른 객체를 참조하는지 확인합니다.

	@Test
	public void whenAssertingSameObject_thenSuccessfull() {
	String language = "Java";
	String anotherLanguage = "JavaScript";
	assertNotSame(language, anotherLanguage);
	}

fail

테스트를 실패 처리하며 실패 메시지를 함께 출력합니다.

개발이 완료되지 않은 테스트를 표시할 때 유용

	@Test
	public void whenFailingATest_thenFailed() {
	// Test not completed
	fail("FAIL - test not completed");
	}

assertAll

assertAll안에 작성된 모든 Assertion이 실행됩니다.

 

한 메소드에 assert함수를 여러개 선언 후 테스트를 진행할 시 상단 assert함수에서 오류가 발생하면 그 밑 함수들을 실행되지가 않습니다.
하지만, assertAll()로 해당 수들을 묶을 시 중간에 assert함수가 실행이 되지 않더라도 assert의 모든 함수를 실행할 수 있습니다.

단, 실행 중 예외(Out Of Memory Error 등)를 발생시키는 경우에만 중단됩니다.

	@Test
	void givenMultipleAssertion_whenAssertingAll_thenOK() {
	Object obj = null;
	assertAll(
	"heading",
	() -> assertEquals(4, 2 * 2, "4 is 2 times 2"),
	() -> assertEquals("java", "JAVA".toLowerCase()),
	() -> assertNull(obj, "obj is null")
	);
	}

assertIterableEquals

예상된 반복 가능 항목과 실제 반복 가능 항목이 완전히 동일한지 확인합니다.

두 Iterable은 동일한 순서로 동일한 요소를 반환해야 하며, 두 Iterable이 동일한 유형일 필요는 없습니다.

	@Test
	void givenTwoLists_whenAssertingIterables_thenEquals() {
	Iterable<String> al = new ArrayList<>(asList("Java", "Junit", "Test"));
	Iterable<String> ll = new LinkedList<>(asList("Java", "Junit", "Test"));
	assertIterableEquals(al, ll);
	}

assertLinesMatch

예상 목록이 실제 목록과 일치하는지 확인합니다.

이 메서드는 assertEquals 및 assertItableEquals와는 다릅니다.

1. 예상 라인이 실제 라인과 동일한지 확인. 동일할 경우 다음 쌍으로 계속 진행
2. 예상되는 행을 정규 표현으로 처리하여 String.matches() 메서드를 사용하여 체크를 수행. 동일할 경우 다음 쌍으로 계속 진행
3. 예상되는 라인이 fast-forward marker  확인.동일할 경우 fast-forward를 적용하고 스텝1부터 알고리즘을 반복

	@Test
	void whenAssertingEqualityListOfStrings_thenEqual() {
	List<String> expected = asList("Java", "\\d+", "JUnit");
	List<String> actual = asList("Java", "11", "JUnit");
	assertLinesMatch(expected, actual);
	}

assertThrows

특정 예외가 발생했는지 확인합니다.

첫 번째 인자는 "확인할 예외 클래스", 두 번째 인자는 "테스트하려는 코드"를 입력합니다.

	@Test
	void whenAssertingException_thenThrown() {
	Throwable exception = assertThrows(
	IllegalArgumentException.class,
	() -> {
	throw new IllegalArgumentException("Exception message");
	}
	);
	assertEquals("Exception message", exception.getMessage());
	}

assertTimeout and assertTimeoutPreemptively

assertTimeout은 특정 시간 안에 실행이 끝나는지 확인 합니다.

assertTimeoutPreemptively은 지정한 시간 내 끝나지 않으면 바로 종료합니다.

 

아래 코드는 2초 이내에 그 다음 인자인 "Executable 코드"가 실행완료 되어야 합니다.

여기서 실행한 코드는 Thread.sleep(1000) 으로, 1초동안 일시 정지 상태가 됩니다.

그렇기 때문에 2초 이내에 코드가 실행되어 테스트는 통과하게 됩니다. 

만약 Thread.sleep(2000), Thread.sleep(3000) 으로 실행하게 된다면 2초 이내인 조건을 만족하지 못하므로 실패하게 됩니다.

	@Test
	void whenAssertingTimeout_thenNotExceeded() {
	assertTimeout(
	ofSeconds(2),
	() -> {
	Thread.sleep(1000);
	}
	);
	}

🧪 AssertJ 라이브러리

AssertJ 는 JUnit Assertions을 사용함에 있어 더 우아한(?) 테스트 작성을 도와주는 라이브러리 입니다 👍
spring-boot-starter-test 에 포함되어 있습니다 💪

Hamcrest와 비슷한 기능의 메소드를 제공합니다.
또한 핵심 메소드는 assertThat 1️⃣ 개 이며 메소드 체이닝 방식을 사용합니다.

💡 Object Assertions

두 객체의 동일성이나 객체의 필드를 조사하기 위해 사용

Example

public class Dog {

	private String name;
    private Double weight;
    
}

@Test
public class DogTest() { 

	Dog dog01 = new Dog("진돗개", 3.45);
    Dog dog02 = new Dog("시추" , 1.23);
    
    assertThat(dog01).isEqualTo(dog02);

}

isEqualsTo() 는 객체의 동일성을 비교하므로 해당 테스트는 fail입니다 🥲
동등성을 비교하기 위해서는 isEqualToComparingFieldByFieldRecursively() 을 사용합니다.

💡 Boolean Assertions

두 객체의 Boolean 값 비교를 위해 사용

• isTrue()
• isFalse()

Example

assertThat("".isEmpty()).isTrue(); // true

💡 Iterable/Array Assertions

Iterable/Array 에 특정 요소가 존재하는지 확인 등의 다양한 목적으로 사용

List<String> list = Arrays.asList("1","2","3");

assertThat(list).contains("1"); // 포함되었는지 확인

assertThat(list).isNotEmpty(); // 비어있는지 확인

assertThat(list).startsWith("1"); // 해당 요소로 시작하는지 확인

assertThat(list).doesNotContainNull() // null 포함 하지 않는지 확인
 

이외에도 AssertJ 를 이용해서 다양한 Case를 직관적으로 테스트 할 수 있습니다 💪

 

🧪 마무리

JUnit5는 자바를 이용하는 개발자라면 당연히 숙지해야할 테스팅 기법입니다 📚
특히 요즘 개발 문화에 TDD 는 중요한 요소로 자리 잡았기에 더욱 필수적으로 익혀야 한다고 생각합니다 🙆🏻