🔥 TIL - Day 56

3차 프로젝트 때는 Spring Rest Docs를 이용해서 API문서를 자동화해야 한다.
Spring Rest Docs를 사용하기 위해서는 필수로 테스트 코드를 작성해야 한다. 테스트가 모두 성공해야 API문서가 작성되는 것이다.

Spring Rest Docs를 바로 적용해보기 전에 Spring에서 가장 많이 쓰는 테스트 프레임워크인 Junit5에 대해 알아보자.

📌 일단 어노테이션부터 살짝 알아보자

@Test

• 테스트 메서드 정의
• @DisplayName 으로 테스트 메서드에 대한 이름을 정의할 수 있다.
• @RepeatedTest, @ParameterizedTest, @TestFactory, @TestTemplate 이 붙은 메서드도 테스트 메서드로 취급된다. 일단 이름만 알아두자.
• @Disabled: 테스트 클래스 or 메서드 비활성화

@BeforeEach, @AfterEach

• 테스트 전,후로 실행
• 각 테스트 메서드가 실행되기 전,후로 매번 호출된다.

@BeforeAll, @AfterAll

• 테스트 전,후로 실행
• 테스트 전,후로 단 한 번만 호출된다.

@SpringBootTest

• 무거운 테스트
• 필요한 모든 빈을 IoC에 올려놓고 테스트를 수행한다. (통합 테스트)

@WebMvcTest

• Controller를 대상으로 테스트
• Controller 계층의 빈만 빈으로 올리고 수행하는 테스트이다. 보통 Controller이하 Service계층은 Mocking해서 사용한다.

@ExtendWith

• @SpringBootTest가 아닌 @WebMvcTest에서 Mockito를 쓰고 싶다면?

@WebMvcTest(TestController.class)
@ExtendWith(MockitoExtension.class)

---

📌 테스트 실행순서

특정 순서를 기준으로 테스트의 순서를 지정할 수 있다.

@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
public class TestClass {
    
    @Test
    @Order(1)
    void 테스트1() { ... }
    
    @Test
    @Order(2)
    void 테스트2() { ... }
}

---

📌 테스트 반복실행

테스트 메서드를 반복해서 실행해야 할 때,

public class TestClass {
    
    @RepeatedTest(10)
    void 테스트1() { ... }
}

---

📌 파라미터를 받은 테스트 메서드

csv 형식 데이터를 파라미터로 받기

@ParameterizedTest
@CsvSource({
    "key1, 1",
    "key2, 2",
    "key3, 3",
})
void 테스트(String key, int value) { ... }

csv파일의 데이터를 파라미터로 받기

@ParameterizedTest
@CsvFileSource(resources="/filename.csv")
void 테스트(String key, int value) { ... }

언젠간 쓸 일이 있을지도.. ?

📌 회원가입 테스트 연습

@MockBean(JpaMetamodelMappingContext.class)
@WebMvcTest(UserController.class)
@ExtendWith({MockitoExtension.class})
class UserControllerTest {

    @MockBean
    UserService userService;
    @MockBean
    UserDetailsServiceImpl userDetailsService;
    @Autowired
    MockMvc mockMvc;

    @Test
    @DisplayName("일반 회원가입 테스트")
    void 일반_회원가입() throws Exception {

        // Given
        SignupRequestDto dto = SignupRequestDto.builder()
                .username("test")
                .password("password")
                .reviewer(false)
                .build();

        // When
        doReturn(new User(1L, dto.getUsername(), dto.getPassword(), UserRole.ROLE_USER, 0, new ArrayList<>()))
                .when(userService).saveUser(dto);

        Gson gson = new Gson();


        // Then
        mockMvc.perform(MockMvcRequestBuilders.post("/user/signup")
                        .contentType(MediaType.APPLICATION_JSON)
                        .content(gson.toJson(dto)))
                .andDo(print())
                .andExpectAll(
                        status().isOk(),
                        jsonPath("$.result").value("success")
                );
    }
}

---

참고
https://donghyeon.dev/junit/2021/04/11/JUnit5-%EC%99%84%EB%B2%BD-%EA%B0%80%EC%9D%B4%EB%93%9C/