테스트/0+ JUnit

[JUnit] 회원가입 API 컨트롤러, 서비스, 리포지토리 테스트 예제

힘들면힘을내는쿼카 2023. 6. 9. 22:21

728x90

[JUnit] 회원가입 API 컨트롤러, 서비스, 리포지토리 테스트 예제

인프런에서 박우빈님의 [Practical Testing: 실용적인 테스트 가이드] 강좌를 들으면서
강의 내용을 복습할 겸 테스팅하는 방법에 대하여 공유하고자 합니다.

좋은 강의 만들어주신 우빈님 감사합니다.^^

들어가기에 앞서

여러분은 테스트 하면 어떤 생각이 떠오르나요?
라는 질문을 받았습니다.

저의 머리속에는 “귀찮다.” 라는 생각이 떠올랐습니다.

그런데 강의에서도 귀찮다. 라고 소개했습니다. 😲
(독심술이 있으신건가…?)

그렇습니다.

테스트는 매우 귀찮은 작업입니다.
기능 구현하는데 시간이 모자른데 테스트 코드까지 작성해야 한다?
에바지~ 라는 생각이 먼저 듭니다.

그리고 무엇보다 테스트는 귀찮습니다.
(일반적으로 개발자는 귀찮은 일을 싫어 합니다.~)

그런데 테스트 코드를 작성하지 않으면 어떻게 될까요? 🤔
소규모 프로젝트에서는 상관 없을 수도 있습니다.
하지만, 프로젝트 규모가 점점 커져 프로젝트 인원이 감당할수 없는 규모로 성장하게 되면 더 귀찮은 일이 발생 합니다.

더 귀찮은 일

변화가 생기는 순간마다 발생할 수 있는 모든 상황을 고려해야함
빠르게 변화하는 소프트웨어의 안정성을 보장할 수 없음

저는 이런 생각을 여러분들께 던지고 싶습니다.

지금 당장 조금 편할것인가?

아니면 나중에 더더더더더 귀찮은 일을 맞이할 것인가?

프로젝트 설명

회원가입 기능이 있는 간단한 API 입니다.

회원가입 정책은 1개의 아이디만 존재할 수 있습니다.
회원의 정보는 DB에 저장되어 관리 되고, 데이터 접근 기술로는 Spring Data JPA를 사용했습니다.

전체 코드는 아래에서 다운받으시고 로그인 구현 커밋(28aeead)을 확인하시면 됩니다.

GitHub - ssosee/jwt-login-example: jwt 로그인 예제

Request

# 회원 가입
POST http://localhost:8080/api/v1/member/new
Content-Type: application/json

{
  "userId" : "user1",
  "password1": "123",
  "password2": "123"
}

Response

POST http://localhost:8080/api/v1/member/new

HTTP/1.1 200 
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Fri, 09 Jun 2023 09:23:42 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "message": "회원가입 성공",
  "status": "OK",
  "data": {
    "id": 1,
    "userId": "user1"
  }
}

Repository Test

회원가입 정책은 1개의 아이디만 허용 합니다.
따라서 클라이언트가 입력한 아이디가 중복인지 체크하는 로직이 필요합니다.

테스트 목적
의도한 쿼리가 발생하는지 확인하는 것이 주된 목적입니다.

MemberRepository

public interface MemberRepository extends JpaRepository<Member, Long> {
    Optional<Member> findMemberByUserId(String userId);
}

findMemberByUserId()가 우리가 의도한 쿼리를 사용하는지 테스트 해봅시다.!

MemberRepositoryTest

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

@DataJpaTest
class MemberRepositoryTest {

    @Autowired
    MemberRepository memberRepository;

    @Test
    @DisplayName("회원 아이디로 회원을 조회한다.")
    void findMemberByUserId() {

        // given
        // 회원 생성
        Member member = Member.create("user1", "123");
        memberRepository.save(member);

        // when
          // 회원 조회
        Member findMember = memberRepository.findMemberByUserId("user1").get();

        // then
          // 검증
        assertAll(
                () -> assertThat(findMember).isNotNull(), // 회원이 null이 아닌지
                () -> assertThat(findMember.getUserId()).isEqualTo("user1") // 회원 아이디가 일치 하는지
        );
    }
}

결과
테스트가 통과되었고, 우리가 의도한 쿼리가 발생한것을 확인할 수 있습니다.

assertAll() 이란? 🤔
만약에 assertThat(findMember).isNotNull();가 통과하지 못했다고 합시다.
그러면 테스트는 assertThat(findMember).isNotNull();에서 멈추게 됩니다.
assertThat(findMember.getUserId()).isEqualTo("user1”);을 실행하지 않은 채로 말이죠!!

assertThat(findMember).isNotNull();
assertThat(findMember.getUserId()).isEqualTo("user1");

assertAll을 사용할 경우
assertThat(findMember).isNotNull() 가 통과하지 못했더라도 테스트가 멈추지 않고,
assertAll에 있는 모든 테스트를 수행할 수 있습니다.

assertAll(
        () -> assertThat(findMember).isNotNull(),
        () -> assertThat(findMember.getUserId()).isEqualTo("user1")
);

Service Test

MemberRepository를 활용하여 MemberService를 구현하고 테스트 해봅시다.!

테스트 목적
상위 레이어에서 검증하지 못한 사항이 발생해도
서비스의 핵심 비지니스 로직이 정상적으로 동작하는지 확인하는 것이 주된 목적 입니다.

MemberService에서는 2가지 상황을 검증하는 로직이 포함되어 있습니다.

회원 아이디 중복 확인
비밀번호가 일치하는지 확인

위 2가지 예외사항이 발생하지 않는다면 회원가입이 완료 됩니다.

MemberException

public class MemberException extends IllegalArgumentException {
    public MemberException(String s) {
        super(s);
    }
}

MemberService
인터페이스를 생성하였습니다.

public interface MemberService {
    MemberResponse register(MemberRegisterService request);
}

MemberServiceImpl

@Service
@Transactional(readOnly = true)
@RequiredArgsConstructor
public class MemberServiceImpl implements MemberService {

    private final MemberRepository memberRepository;
    private final PasswordEncoder passwordEncoder;

    @Transactional
    @Override
    public MemberResponse register(MemberRegisterService request) {
          // 회원 아이디가 존재하면
        boolean isMember = memberRepository.findMemberByUserId(request.getUserId()).isPresent();
        if(isMember) throw new MemberException("이미 존재하는 아이디 입니다.");
           // 비밀번호가 일치하지 않으면
        boolean passwordIsEq = request.getPassword1().equals(request.getPassword2());
        if(!passwordIsEq) throw new MemberException("비밀번호가 일치하지 않습니다.");

        // 회원 생성 및 저장
        Member member = Member.create(request.getUserId(), passwordEncoder.encode(request.getPassword1()));
        Member savedMember = memberRepository.save(member);

          // 응답 생성
        return MemberResponse.of(savedMember);
    }
}

PasswordEncoder를 사용하였는데, 암호화 알고리즘 객체입니다.
이 포스팅에서 중요한 부분은 아닙니다.😃

코드를 보면 2가지 사항을 검증합니다.

회원 아이디 중복 확인
비밀번호가 일치하는지 확인

테스트 코드를 작성하여 2가지 예외 사항과 정상 동작을 확인해 봅시다.

MemberServiceImplTest

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

@SpringBootTest
@ActiveProfiles("test")
@Transactional
class MemberServiceImplTest {

    @Autowired
    MemberServiceImpl memberService;
    @Autowired
    MemberRepository memberRepository;

    @Test
    @DisplayName("회원정보를 받으면 회원을 저장하고 회원가입이 된다.")
    void registerMember() {
        // given
        // 회원가입 요청 데이터 생성
        MemberRegisterService memberRegisterService = MemberRegisterService.builder()
                .userId("user1")
                .password1("123")
                .password2("123")
                .build();

        // when
        // 회원가입
        MemberResponse response = memberService.register(memberRegisterService);

        // then
        // 회원가입 리턴값으로 검증
        assertAll(
                () -> assertThat(response.getId()).isNotNull(),
                () -> assertThat(response.getUserId()).isEqualTo("user1")
        );
    }

    @Test
    @DisplayName("회원가입시 회원 아이디가 중복되면 예외가 발생한다.")
    void registerMemberDuplicateUserId() {
        // given
        String userId = "user1";

        // 회원아이디 중복 상황을 만들기 위해 DB에 저장한다.
        Member member = Member.create(userId, "123");
        memberRepository.save(member);

        // 회원가입 요청데이터 생성
        MemberRegisterService memberRegisterService = MemberRegisterService.builder()
                .userId(userId)
                .password1("123")
                .password2("123")
                .build();

        // when // then
        // 회원가입 시 검증
        assertThatThrownBy(() -> memberService.register(memberRegisterService))
                .isInstanceOf(MemberException.class)
                .hasMessage("이미 존재하는 아이디 입니다.");
    }

    @Test
    @DisplayName("회원가입시 비밀번호가 일치하지 않으면 예외가 발생한다.")
    void registerMemberNotEqualsPassword() {
        // given
        // 비밀번호가 다른 회원가입 요청 데이터 생성
        String userId = "user1";
        String password1 = "123";
        String password2 = "321";

        MemberRegisterService memberRegisterService = MemberRegisterService.builder()
                .userId(userId)
                .password1(password1)
                .password2(password2)
                .build();

        // when // then
        // 회원가입시 검증
        assertThatThrownBy(() -> memberService.register(memberRegisterService))
                .isInstanceOf(MemberException.class)
                .hasMessage("비밀번호가 일치하지 않습니다.");
    }
}

갑자기 3개의 메소드가 나왔는데,
겁먹지 말고 차근차근 1개씩 살펴 봅시다. ☺️

회원정보를 받으면 회원을 저장하고 회원가입이 된다.

@Test
@DisplayName("회원정보를 받으면 회원을 저장하고 회원가입이 된다.")
void registerMember() {
    // given
    // 회원가입 요청 데이터 생성
    MemberRegisterService memberRegisterService = MemberRegisterService.builder()
            .userId("user1")
            .password1("123")
            .password2("123")
            .build();

    // when
    // 회원가입
    MemberResponse response = memberService.register(memberRegisterService);

    // then
    // 회원가입 리턴값으로 검증
    assertAll(
            () -> assertThat(response.getId()).isNotNull(),
            () -> assertThat(response.getUserId()).isEqualTo("user1")
    );
}

MemberRepositoryTest와 거의 비슷합니다.
MemberRepositoryTest에서는 회원가입을 시키고 회원을 조회결과를 테스트 했습니다.

registerMember()에서는 회원가입에 필요한 요청데이터를 넘겼을때 회원가입이 정상적으로 되었는지 확인하는 과정 입니다.
register(memberRegisterService)으로 리턴되는 값으로 검증을 시도했습니다.

회원가입시 회원 아이디가 중복되면 예외가 발생한다.

@Test
@DisplayName("회원가입시 회원 아이디가 중복되면 예외가 발생한다.")
void registerMemberDuplicateUserId() {
    // given
    String userId = "user1";

    // 회원 아이디 중복 상황을 만들기 위해 DB에 저장한다.
    Member member = Member.create(userId, "123");
    memberRepository.save(member);

    // 회원가입 요청데이터 생성
    MemberRegisterService memberRegisterService = MemberRegisterService.builder()
            .userId(userId)
            .password1("123")
            .password2("123")
            .build();

    // when // then
    // 회원가입 시 검증
    assertThatThrownBy(() -> memberService.register(memberRegisterService))
            .isInstanceOf(MemberException.class)
            .hasMessage("이미 존재하는 아이디 입니다.");
}

회원 아이디(user1) 중복 상황을 만들기 위해서 DB에 회원을 저장했습니다.
그 다음 user1을 포함하는 회원가입 요청데이터를 생성하여 회원가입을 시도합니다.
이미 가입한 회원이 있다면 ”이미 존재하는 아이디 입니다.” 예외를 발생해야 합니다.

회원가입시 비밀번호가 일치하지 않으면 예외가 발생한다.

@Test
@DisplayName("회원가입시 비밀번호가 일치하지 않으면 예외가 발생한다.")
void registerMemberNotEqualsPassword() {
    // given
    // 비밀번호가 다른 회원가입 요청 데이터 생성
    String userId = "user1";
    String password1 = "123";
    String password2 = "321";

    MemberRegisterService memberRegisterService = MemberRegisterService.builder()
            .userId(userId)
            .password1(password1)
            .password2(password2)
            .build();

    // when // then
    // 회원가입시 검증
    assertThatThrownBy(() -> memberService.register(memberRegisterService))
            .isInstanceOf(MemberException.class)
            .hasMessage("비밀번호가 일치하지 않습니다.");
}

이번에는 password1과 password2의 비밀번호를 다르게 설정하여 회원가입 요청 데이터를 생성했습니다.
비밀번호가 다르다면 “비밀번호가 일치하지 않습니다.”예외가 발생해야 합니다.

결과

Controller Test

거의 다왔습니다! 👍
이제 비지니스 로직을 실행할 수 있는 컨트롤러를 구현해보고 테스트 코드를 작성해봅시다.!!

테스트 목적
컨트롤러에서 테스트의 주된 목적은 요청 데이터 검증에 있습니다.

ApiControllerAdvice

@RestControllerAdvice
public class ApiControllerAdvice {

    // 서비스 레이어의 예외가 발생하면 아래 메소드가 실행된다.
    @ExceptionHandler(MemberException.class)
    public ResponseEntity<ApiResponse<Integer>> memberExceptionHandler(MemberException e) {
        int code = 1000;
        return new ResponseEntity<>(
                ApiResponse.of(e.getMessage(), HttpStatus.BAD_REQUEST, code),
                HttpStatus.BAD_REQUEST);
    }

      // 컨트롤러의 검증 데이터에 오류가 BindException 예외가 발생하고 아래 메소드가 실행된다.
    @ExceptionHandler(BindException.class)
    public ResponseEntity<ApiResponse<Integer>> bindExceptionHandler(BindException e) {
        int code = 100;
        return new ResponseEntity<>(
                ApiResponse.of(e.getBindingResult().getAllErrors().get(0).getDefaultMessage(), HttpStatus.BAD_REQUEST, code),
                HttpStatus.BAD_REQUEST);
    }
}

MemberRegisterRequest

@Data
@NoArgsConstructor
public class MemberRegisterRequest {
    @NotBlank(message = "아이디는 필수 값 입니다.")
    private String userId;
    @NotBlank(message = "패스워드는 필수 값 입니다.")
    private String password1;
    @NotBlank(message = "패스워드는 필수 값 입니다.")
    private String password2;

    @Builder
    private MemberRegisterRequest(String userId, String password1, String password2) {
        this.userId = userId;
        this.password1 = password1;
        this.password2 = password2;
    }

    public MemberRegisterService toService() {
        return MemberRegisterService.builder()
                .userId(userId)
                .password1(password1)
                .password2(password2)
                .build();
    }
}

MemberController

@RestController
@RequiredArgsConstructor
@RequestMapping("/api/v1/member")
public class MemberController {

    private final MemberService memberService;

    @PostMapping("/new")
    public ResponseEntity<ApiResponse<MemberResponse>> register(@Valid @RequestBody MemberRegisterRequest request) {
        MemberResponse register = memberService.register(request.toService());

        return new ResponseEntity<>(ApiResponse.of("회원가입 성공", HttpStatus.OK, register), HttpStatus.OK);
    }
}

테스트 코드를 작성하기 전에 인텔리제이에서 http 요청을 통해서 간단하게 확인해봅시다.^^
프로젝트 하위 폴더에 http 폴더를 생성하고 member-new.http를 생성합니다.

member-new.http

# 회원 가입
POST http://localhost:8080/api/v1/member/new
Content-Type: application/json

{
  "userId" : "user1",
  "password1": "123",
  "password2": "123"
}

서버를 실행하고 빨간색 네모 박스에 있는 버튼을 클릭합니다.

결과
제대로 동작하는 것을 확인할 수 있습니다.!!!

MemberControllerTest

@SpringBootTest
@AutoConfigureMockMvc
@ActiveProfiles("test")
class MemberControllerTest {

    @Autowired
    MockMvc mockMvc;
    @Autowired
    ObjectMapper om;

    @Test
    @DisplayName("회원가입을 한다.")
    void registerMember() throws Exception{
        // given
        // 요청 데이터 생성
        MemberRegisterRequest request = MemberRegisterRequest.builder()
                .userId("user1")
                .password1("123")
                .password2("123")
                .build();

        // when // then
        // 회원가입 요청시 성공 응답
        mockMvc.perform(MockMvcRequestBuilders.post("/api/v1/member/new")
                .contentType(MediaType.APPLICATION_JSON)
                .content(om.writeValueAsString(request)))
                .andDo(MockMvcResultHandlers.print())
                .andExpect(MockMvcResultMatchers.status().isOk()) // 200 ok
                .andExpect(MockMvcResultMatchers.jsonPath("$.message").value("회원가입 성공"))
                .andExpect(MockMvcResultMatchers.jsonPath("$.status").value("OK"))
                .andExpect(MockMvcResultMatchers.jsonPath("$.data").isNotEmpty())
                .andExpect(MockMvcResultMatchers.jsonPath("$.data.id").isNumber())
                .andExpect(MockMvcResultMatchers.jsonPath("$.data.userId").value("user1"))
                ;
    }

    @Test
    @DisplayName("회원가입시 아이디가 없으면 예외가 발생한다.")
    void registerMemberValidationUserId() throws Exception{
        // given
        // 아이디가 없는 요청 데이터 생성
        MemberRegisterRequest request = MemberRegisterRequest.builder()
                .password1("123")
                .password2("123")
                .build();

        // when // then
        // 회원가입 요청시 실패 응답
        mockMvc.perform(MockMvcRequestBuilders.post("/api/v1/member/new")
                        .contentType(MediaType.APPLICATION_JSON)
                        .content(om.writeValueAsString(request)))
                .andDo(MockMvcResultHandlers.print())
                .andExpect(MockMvcResultMatchers.status().isBadRequest()) // 400 error
                .andExpect(MockMvcResultMatchers.jsonPath("$.message").value("아이디는 필수 값 입니다."))
                .andExpect(MockMvcResultMatchers.jsonPath("$.status").value("BAD_REQUEST"))
                .andExpect(MockMvcResultMatchers.jsonPath("$.data").value(100))
        ;
    }

    @Test
    @DisplayName("회원가입시 비밀번호가 없으면 예외가 발생한다.")
    void registerMemberValidationPassword() throws Exception{
        // given
        // 비밀번호가 없는 요청 데이터 생성
        MemberRegisterRequest request = MemberRegisterRequest.builder()
                .userId("user1")
                .build();

        // when // then
        // 회원가입 요청시 실패 응답
        mockMvc.perform(MockMvcRequestBuilders.post("/api/v1/member/new")
                        .contentType(MediaType.APPLICATION_JSON)
                        .content(om.writeValueAsString(request)))
                .andDo(MockMvcResultHandlers.print())
                .andExpect(MockMvcResultMatchers.status().isBadRequest()) // 400 error
                .andExpect(MockMvcResultMatchers.jsonPath("$.message").value("패스워드는 필수 값 입니다."))
                .andExpect(MockMvcResultMatchers.jsonPath("$.status").value("BAD_REQUEST"))
                .andExpect(MockMvcResultMatchers.jsonPath("$.data").value(100))
        ;
    }
}

테스트 케이스에 맞게 요청 데이터를 생성합니다.
컨트롤러에서 테스트의 주된 목적은 validation을 확인하는 과정입니다.
정상적인 회원가입 테스트 코드와 MemberRegisterRequest에 설정한 validation을 검증하는 테스트 코드를 작성합니다.

결과

마치며

테스트 코드를 작성하면 소프트웨어에 오류가 없을까요?
테스트 코드를 작성했다고 해서 소프트웨어에 오류가 없다는 것을 증명할 수는 없습니다.

응? 😵
그러면 귀찮게 왜 작성한거지?

테스트 코드를 작성함으로써 우리는 해당 기능에 오류가 없다는 것을 증명할 수 있습니다.

소프트웨어의 오류가 없다는 것은 증명할 수 없지만,
최소한 여러분이 구현한 기능에 대해서 오류가 없다는 것을 증명하는 것이
사용자 또는 동료 개발자에게 할 수 있는 최소한의 배려 아닐까요?

개발자라면 귀찮다고 테스트 코드를 등한시 하지맙시다!!
(나부터 잘하자…!! ㅎㅎ)

참고

Practical Testing: 실용적인 테스트 가이드 - 인프런 | 강의

728x90

저작자표시 비영리 변경금지

'테스트 > 0+ JUnit' 카테고리의 다른 글

[JUnit5] 인스턴스 테스트와 테스트 순서대로 실행하는 방법 (0)	2023.05.17
[JUnit5] 테스트 인자 값 타입 변환하는 방법 (0)	2023.05.17
[JUnit5] 환경변수 조건에 따라 테스트 실행하는 방법 (0)	2023.05.05
[JUnit5] Assertions 기본 사용법 (0)	2023.05.05
[JUnit5] JUnit5 기본 어노테이션 (0)	2023.05.04

현재글[JUnit] 회원가입 API 컨트롤러, 서비스, 리포지토리 테스트 예제

250x250

어제 보다 나은 내일은 토요일이다.

머신러닝, 스프링 MVC, 운영체제, spring boot, 패스트캠퍼스, java, jpa, 스프링, 기계학습, 정보처리기사, ElasticSearch, 스프링 시큐리티, 디자인 패턴, 컴퓨터 구조, udp, 정보처리기사 실기, 스프링 AOP, JUnit5, 헤드퍼스트 디자인 패턴, dfs,

Today :
Yesterday :

힘들면 힘을내자!