TypeSafeMatcher를 이용한 커스텀 매처 구현

14 Oct 2024

테스트 관련 서적을 읽다보면 Hamcrest를 이용한 커스텀 매처를 구현해서 사용하는 경우를 볼 수 있는데, 직접 구현해보자.

TypeSafeMatcher는 주로 JUnit이나 다른 테스트 프레임워크에서 사용되는 Matcher 클래스의 특수한 유형으로, 특정 객체의 타입에 안전한 비교를 제공하는 기능을 한다.

주로 Hamcrest 라이브러리와 함께 사용되며, 타입이 안전하게 매칭될 수 있도록 보장한다.

TypeSafeMatcher : TypeSafeMatcher 클래스는 T 타입의 객체를 안전하게 처리할 수 있게 한다. 매칭을 수행할 때 T 타입을 명시하여 타입 안전성을 보장한다.

matchesSafely : 실제 매칭 로직을 구현한다.

describeTo : 매칭 실패 시 출력될 설명을 제공

유저 이름이 일치하는지 확인하는 테스트 코드를 작성해보자.

먼저 TypeSafeMatcher 를 구현한다.

	import org.hamcrest.Description;
	import org.hamcrest.TypeSafeMatcher;

	public class UserNameMatcher extends TypeSafeMatcher<User> {

	private final String name;

	public UserNameMatcher(String name) {
	this.name = name;
	}

	// 실제 매칭 로직
	@Override
	protected boolean matchesSafely(User user) {
	return user.getName().equals(name);
	}

	// 매칭 실패 시 출력될 설명
	@Override
	public void describeTo(Description description) {
	description.appendText("유저 이름은 [").appendValue(name).appendText("] 이어야 한다.");
	}

	public static UserNameMatcher hasName(String name) {
	return new UserNameMatcher(name);
	}

	}

view raw 20241014-1.java hosted with ❤ by GitHub

테스트 코드

	public class TypeSafeMatcherTest {

	@Test
	public void testNameMatch() {
	User user = new User("test");

	// assertThat(user, UserNameMatcher.hasName("test")); static import해서 간단하게 표시
	assertThat(user, hasName("test")); // 성공
	}
	}

view raw 20241014-2.java hosted with ❤ by GitHub

실패 메시지 확인

	public class TypeSafeMatcherTest {

	@Test
	public void testNameMatch() {
	User user = new User("test2");

	assertThat(user, hasName("test"));
	}
	}


	// 메시지
	Expected: 유저 이름은 ["test"] 이어야 한다.
	but: was <org.ghosttrio.User@4b8729ff>
	java.lang.AssertionError:
	Expected: 유저 이름은 ["test"] 이어야 한다.

view raw 20241014-3.java hosted with ❤ by GitHub