AssertJ 핵심 기능 알아보기

AssertJ란?

⭐️ 테스트에 관련된 많은 기능을 제공하고 메서드 체이닝으로 가독성 높은 테스트 코드 작성을 지원하는 오픈 라이브러리입니다.
⭐️ assertThat(검증대상)로 시작하며 메서드 체이닝을 이용하여 검증 메서드를 연쇄적으로 더 깔끔하고 가독성 있게 테스트 코드를 작성할 수 있습니다.

---

 

학습 환경

plugins {
	id 'org.springframework.boot' version '2.7.2'
	id 'io.spring.dependency-management' version '1.0.12.RELEASE'
	id 'java'
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'

configurations {
	compileOnly {
		extendsFrom annotationProcessor
	}
}

repositories {
	mavenCentral()
}

dependencies {
	compileOnly 'org.projectlombok:lombok'
	annotationProcessor 'org.projectlombok:lombok'
	testImplementation 'org.springframework.bo	ot:spring-boot-starter-test'
}

tasks.named('test') {
	useJUnitPlatform()
}

---

 

1. Test Fail Message

@Test
public void test1() {
    String str = "가위";
    assertThat(str).as("기대값 {바위}와 현재값 {%s}가 일치하지 않습니다.", str)
            .isEqualTo("바위");
}

⭐️ as(String description, Object... args)를 사용하여 테스트 코드의 실패 메시지를 설정할 수 있습니다.
⭐️ as는 검증 문보다 앞에 작성해야 하며, 그렇지 않을 경우 검증 문 이후 호출이 중단됨으로 무시됩니다.

---

 

2. Collection Filtering과 Assertions

import org.assertj.core.util.Lists;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.not;
import static org.assertj.core.api.AssertionsForClassTypes.in;
import static org.assertj.core.api.AssertionsForClassTypes.notIn;


@SpringBootTest
class MemberTest {
    public Member member1, member2, member3;
    public List<Member> members;

    @BeforeEach
    public void createMember() {
        member1 = new Member("Kim", 20, MemberRole.ADMIN);
        member2 = new Member("Ahn", 20, MemberRole.BASIC);
        member3 = new Member("Park", 21, MemberRole.VIP);
        members = Lists.list(member1, member2, member3);
    }


    /**
     * 리스트 중 나이가 20살인 멤버들은 member1과 member2만이 유일하다.
     */
    @Test
    public void test1() {
        assertThat(members)
                .filteredOn("age", 20)
                .containsOnly(member1, member2);
    }

    /**
     * 리스트 중 나이 19,20를 포함하지 않은 멤버는 member3이 유일하다.
     */
    @Test
    public void test2() {
        assertThat(members)
                .filteredOn("age", notIn(19, 20))
                .containsOnly(member3);
    }

    /**
     * 리스트 중 나이가 20인 사람은 member1과 member2가 유일하다.
     */
    @Test
    public void test3() {
        assertThat(members)
                .filteredOn("age", in(20))
                .containsOnly(member1, member2);
    }

    /**
     * 리스트 중 이름이 Lee가 아닌 멤버들은 member1, member2, member3이 유일하다.
     */
    @Test
    public void test4() {
        assertThat(members)
                .filteredOn("name", not("Lee"))
                .containsOnly(member1, member2, member3);
    }

    /**
     * 체이닝으로 필터링을 이어갈 수도 있다.
     */
    @Test
    public void test5() {
        assertThat(members)
                .filteredOn("age", 21)
                .filteredOn("name", not("Park"))
                .isEmpty();
    }
    
     /**
     * 람다식으로 조건도 줄 수 있다.
     */
    @Test
    public void test6() {
        assertThat(members)
                .filteredOn("age", 20)
                .filteredOn(member -> member.age > 20)
                .isEmpty();
    }
    
}

---

 

3. Collection Data Extracting

 /**
 * members의 name을 테스트할 때 아래와 같은 번거로운 방식으로 테스트 할 수 있다.
 */
@Test
public void test7() {
    List<String> names = new ArrayList<>();
    for (Member member : members) {
        names.add(member.getName());
    }
    assertThat(names).containsOnly("Kim", "Ahn", "Park");
}

/**
 * 테스트 7번을 개선한 코드
 * extracting을 사용하면 간결하게 테스트할 수 있다.
 */
@Test
public void test8() {
    assertThat(members)
            .extracting("name")
            .containsOnly("Kim", "Ahn", "Park");
}

/**
 * members의 member 이름들은 Kim과 Ahn을 포함하고 Lee는 포함하지 않는다.
 */
@Test
public void test8_1() {
    assertThat(members)
            .extracting("name")
            .contains("Kim", "Ahn")
            .doesNotContain("Lee");
}

---

 

4. Soft Assertions

⭐️ 보통 테스트를 진행할 때 앞의 검증이 실패하면 해당 테스트는 전부 중지됩니다.

@SpringBootTest
class MemberTest { 
    public Member member1, member2, member3;
    public List<Member> members;

    @BeforeEach
    public void createMember() {
        member1 = new Member("Kim", 20, MemberRole.ADMIN);
        member2 = new Member("Ahn", 20, MemberRole.BASIC);
        member3 = new Member("Park", 21, MemberRole.VIP);
        members = Lists.list(member1, member2, member3);
    }

	
     /**
     * 첫 번째 assert에서 실패하여 다음 assert는 수행하지 않는다.
     */
    @Test
    public void noSoftAssertionTest() {
        assertThat(members).as("크기가 일치하지 않습니다.").size().isEqualTo(1);
        assertThat(members).as("위 검증에서 멈춰 여기까지 오지 않습니다.").size().isEqualTo(2);
    }
}

위 코드는 첫 번째 assert에서 실패하여 아래의 두 번째 assert는 수행하지 않습니다.
⭐️ 아래와 같이 Soft Assertions을 이용하면 이전의 실패와 상관없이 모든 asserThat를 실행한 뒤 실패 내역을 전부 확인할 수 있습니다.

@SpringBootTest
class MemberTest { 
    public Member member1, member2, member3;
    public List<Member> members;

    @BeforeEach
    public void createMember() {
        member1 = new Member("Kim", 20, MemberRole.ADMIN);
        member2 = new Member("Ahn", 20, MemberRole.BASIC);
        member3 = new Member("Park", 21, MemberRole.VIP);
        members = Lists.list(member1, member2, member3);
    }

     /**
     * 첫 번째 assert가 실패하더라도 모든 assert를 수행한다.
     */
    @Test
    public void softAssertionTest() {
        SoftAssertions softAssertions = new SoftAssertions();
        softAssertions.assertThat(members).as("크기가 일치하지 않습니다.").size().isEqualTo(1);
        softAssertions.assertThat(members).as("위 검증에서 실패하더라도 모든 assert를 수행합니다.").size().isEqualTo(2);
        softAssertions.assertAll(); // assertAll()을 통해 실행합니다.
    }
}

---

⭐️ 아래와 같이 assertSoftly를 사용해 람다식으로 따로 assertAll을 호출할 필요 없이 사용할 수도 있습니다.

@SpringBootTest
class MemberTest { 
    public Member member1, member2, member3;
    public List<Member> members;

    @BeforeEach
    public void createMember() {
        member1 = new Member("Kim", 20, MemberRole.ADMIN);
        member2 = new Member("Ahn", 20, MemberRole.BASIC);
        member3 = new Member("Park", 21, MemberRole.VIP);
        members = Lists.list(member1, member2, member3);
    }


    /**
     * assertSoftly를 사용해 람다식으로 따로 assertAll을 호출할 필요 없이 사용할 수 있다.
     */
    @Test
    public void softAssertionTest_2() {
        SoftAssertions.assertSoftly(softAssertions -> {
            softAssertions.assertThat(members).as("크기가 일치하지 않습니다.").size().isEqualTo(1);
            softAssertions.assertThat(members).as("위 검증에서 실패하더라도 모든 assert를 수행합니다.").size().isEqualTo(2);
        });
    }
}

---

 

5. Exception Assertions

⭐️ 예외가 발생했다고 가정하고, 예상한 예외인지 검증하는 방법은 아래와 같습니다.

Java 8에서 Assertion을 테스트하는 것은 편리한데, assertThatThrownBy(ThrowingCallable)를 사용하면 아래와 같이 가독성 있고 편리하게 예외를 던지고 검증할 수 있기 때문입니다.

    /**
     * 예외 발생!이라는 예외를 던지고, hasMessageContaining에서 해당 예외 메시지와 일치한지 검증한다.
     */
    @Test
    public void testException_01() {
        assertThatThrownBy(() -> {
            throw new Exception("예외 발생!");
        })
                .isInstanceOf(Exception.class)
                .hasMessageContaining("예외 발생!");
    }

⭐️ AssertJ에서는 자주 발생하는 예외들에 대해서 정의된 함수를 제공하며. 대표적으로 4가지가 있습니다.

1. assertThatNullPointerException
2. assertThatIllegalArgumentException
3. assertThatIllegalStateException
4. assertThatIOException

⭐️ 만약 위의 대표적인 네 가지 예외를 사용한다면 아래와 같이 작성할 수 있습니다.

    /**
     * 대표적인 4가지 예외에 포함 되었다면 아래와 같이 작성할 수 있다.
     */
    @Test
    public void testException_02() {
        assertThatIOException().isThrownBy(() -> {
                    throw new IOException("예외 발생!");
                })
                .withMessage("%s!", "예외 발생!")
                .withMessageContaining("예외 발생!")
                .withNoCause();
    }

---

⭐️ 만약 위 네 가지 예외에 포함되지 않았다면 아래와 같이 작성하면 됩니다.

    /**
     * 대표적인 4가지 예외에 포함되지 않았다면 아래와 같이 작성하면 된다.
     */
    @Test
    public void testException_03() {
        assertThatExceptionOfType(IOException.class)
                .isThrownBy(() -> {
                    throw new IOException("예외 발생!");
                })
                .withMessage("%s", "예외 발생!")
                .withMessageContaining("예외 발생!")
                .withNoCause();
    }

---

⭐️ BDD(행동 주도 개발) 방식으로는 아래와 같이 작성할 수 있습니다.

 /**
     * BDD(행동 주도 개발) 방식으로 작성하면 아래와 같다.
     */
    @Test
    public void testException_04() {
        //given

        //when
        Throwable thrown = catchThrowable(() -> {
            throw new Exception("예외 던지기!");
        });

        //then
        assertThat(thrown)
                .isInstanceOf(Exception.class)
                .hasMessageContaining("예외 던지기!");
    }

---

 

참고

• https://joel-costigliola.github.io/assertj/assertj-core-features-highlight.html
• https://sun-22.tistory.com/86

 

테스트 관련 같이 보면 좋은 글

• AssertJ 핵심 기능 알아보기
• Junit5 자세히 알아보기
• TestContainer로 통합 테스트 환경 구축하기
• LocalStack을 활용한 AWS S3 테스트 환경 구축하기
• ArchUnit으로 아키텍처 검사하기