[Exception 정리] Spring Security PasswordEncoder Test NPE(Null Pointer Exception)

🚀 Code Content

 

Spring Security를 사용해서 회원가입, 로그인 등을 처리하려고 하는 것이에요.

먼저 회원이 잘 만들어지는지 Test를 해야 하기 때문에 아래와 같이 Test Code를 작성한 것이에요.

 

package com.hongga.repository;

import com.hongga.entity.Member;
import com.hongga.entity.MemberRole;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.security.crypto.password.PasswordEncoder;

import java.util.stream.IntStream;

/**
 * 회원 관리 Test Code
 * <pre>
 * <b>History:</b>
 *    주니하랑, 1.0, 2022.01.26 최초 작성
 * </pre>
 *
 * @author 주니하랑
 * @version 1.0, 2022.01.26 최초 작성
 * @See "코드로 배우는 스프링 부트 웹 프로젝트"
 * @see <a href=""></a>
 */

@SpringBootTest
public class MemberRepositoryTest {

    @Autowired private MemberRepository repository;

    @Autowired private PasswordEncoder passwordEncoder;

    @Test public void 테스트용_회원_생성() {
        // 1명만 Admin 지정
        // 2 ~ 90 까지 Guest 지정
        // 91 ~ 100 까지 Family 지정

        String rowPwd = "1111";

        IntStream.rangeClosed(1, 100).forEach(memberRoleCnt -> {
            Member member = Member.builder()
                    .email("hongga"+memberRoleCnt+"@hongga.com")
                    .name("테스트 이용자"+memberRoleCnt)
                    .nickName("테스트 이용자"+memberRoleCnt)
                    .password(passwordEncoder.encode(rowPwd))
                    .aboutMe("안녕하세요? 우리 가족에게 언제나 행복이 가득하길 바랍니다!"+memberRoleCnt)
                    .build();

            // Admin 역할
            if (memberRoleCnt == 1) {
                member.addMemberRole(MemberRole.ADMIN);
            } // if문 끝

            if (memberRoleCnt > 90) {
                member.addMemberRole(MemberRole.GUEST);
            } // if문 끝

            if (memberRoleCnt >= 100) {
                member.addMemberRole(MemberRole.FAMILY);
            }

            repository.save(member);
        });
    } // 테스트용_회원_생성() 끝

} // class 끝

⚠️ 문제 발생!

 

위의 Test Code를 실행하니 다음과 같이 Null Pointer Exception이 발생한 것이에요!

빌드 패턴으로 .password에 분명히 값을 집어넣어 줬는데, 왜? 때문에? 이러는지 전혀 모르겠는데, 드디어 답을 알았답니다!

 

🍻 문제 해결!

 

package com.hongga.repository;

import com.hongga.entity.Member;
import com.hongga.entity.MemberRole;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.security.crypto.password.PasswordEncoder;
import org.springframework.test.context.junit4.SpringRunner;

import java.util.stream.IntStream;

/**
 * 회원 관리 Test Code
 * <pre>
 * <b>History:</b>
 *    주니하랑, 1.0, 2022.01.26 최초 작성
 * </pre>
 *
 * @author 주니하랑
 * @version 1.0, 2022.01.26 최초 작성
 * @See "코드로 배우는 스프링 부트 웹 프로젝트"
 * @see <a href=""></a>
 */

@SpringBootTest @RunWith(SpringRunner.class)
public class MemberRepositoryTest {

    @Autowired private MemberRepository repository;

    @Autowired private PasswordEncoder passwordEncoder;

    @Test public void 테스트용_회원_생성() {
        // 1명만 Admin 지정
        // 2 ~ 90 까지 Guest 지정
        // 91 ~ 100 까지 Family 지정

        String rowPwd = "1111";

        IntStream.rangeClosed(1, 100).forEach(memberRoleCnt -> {
            Member member = Member.builder()
                    .email("hongga"+memberRoleCnt+"@hongga.com")
                    .name("테스트 이용자"+memberRoleCnt)
                    .nickName("테스트 이용자"+memberRoleCnt)
                    .password(passwordEncoder.encode(rowPwd))
                    .aboutMe("안녕하세요? 우리 가족에게 언제나 행복이 가득하길 바랍니다!"+memberRoleCnt)
                    .build();

            // Admin 역할
            if (memberRoleCnt == 1) {
                member.addMemberRole(MemberRole.ADMIN);
            } // if문 끝

            if (memberRoleCnt > 90) {
                member.addMemberRole(MemberRole.GUEST);
            } // if문 끝

            if (memberRoleCnt >= 100) {
                member.addMemberRole(MemberRole.FAMILY);
            }

            repository.save(member);
        });
    } // 테스트용_회원_생성() 끝

} // class 끝

Class 이름 위에 보시면 @RunWith라는 Annotaion이 추가 된 것을 아실 수 있으실 것이에요.

 

     🔽  다른 해결 방법

 

위에서 원래 코드에 Import를 보시면 Test부분이 'org.junit.Test'로 되어 있는데, 이 부분을 'org.junit.jupiter.api.Test"로 바꿔주면 @RunWith를 붙히지 않아도 문제가 해결 되는 것이에요.

 

 

이렇게 하고 나니 제가 원하는 Test를 정상적으로 수행할 수 있었던 것이에요.

 

반응형

DB를 확인 해 보니 아주 만족스럽게 잘 들어간 것이에요!

 

 

🤔 원인 분석

그렇다면 도대체 왜? 저 Annotaion을 쓰지 않았을 때 문제가 발생했던 것일까요?

 

그것은 바로 SpringBootTest를 사용해서 Test를 진행하려고 하면 JUnit이 상속하려는 SpringRunner Class를 사용해야 하는데, 이를 사용하지 않았기 때문에 Bean으로 등록하려고 했었던 PasswordEncoder가 등록되지 않아 결과적으로 passoword가 NPE가 발생한 것이에요.

 

💡 참고 자료 :

@RunWith(SpringRunner.class)

1. @RunWith는 JUnit Framwork가 Test를 실행할 때 내장된 Runner를 실행.
2. @SpringBootTest를 사용하려면 JUnit SpringJUnit4ClassRunner Class를 상속받는 @RunWith(SpringRunner.class)를 상속 받아서 사용해야 한다.

@SpringBootTest

1. 통합 테스트를 제공하는 기본적인 Annotation.
2. 여러 단위 테스트를 하나의 통합 테스트로 수행하고자 할 때 사용하는데, 어플리케이션의 설정을 모두 Load하기 때문에 어플리케이션 규모가 클수록 느려진다는 단점이 있다.

@DataJpaTest

1. SpringBoot에서 JPA를 테스트 할 수 있도록 제공하는 것.
2. 단위 테스트가 끝날 때 마다 자동으로 DB를 RollBack 해준다.
3. In Memory DB를 사용.
4. 실제 DB에서 테스트를 하려고 한다면 @AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)을 추가 해주어야 한다.

기타

@SpringBootTest : 통합 테스트, 전체 - Bean 전체
@WebMvcTest : 단위 테스트, MVC 테스트, MVC 관련 Bean
@DataJpaTest : 단위 테스트, JPA 테스트 - JPA 관련 Bean
@RestClientTest : 단위 테스트, Rest API 테스트 - 일부 Bean
@JsonTest : 단위 테스트, Json 테스트 - 일부 Bean

 

 

📑 참고 자료

https://n1tjrgns.tistory.com/224