프리온보딩 BE 챌린지 8월 사전 과제 - API 통합 테스트
JUnit5와 WebTestClient을 활용한 API 통합 테스트
프리온보딩 BE 챌린지 8월 사전 과제 - API 통합 테스트
테스트 케이스 설계
API 통합 테스트는 API의 동작을 검증하는 중요한 과정입니다.
API 통합 테스트는 실제로 API를 호출하여 응답을 확인하는 방식으로 진행됩니다.
API 통합 테스트 시나리오
API 통합테스트를 진행할 때에는, 내가 어떤 API를 호출하고, 어떤 응답을 기대하는지에 대한 시나리오를 작성해야 합니다.
다음은 제가 생각하는 API 통합 테스트 시나리오 중 일부입니다.
회원 API
- 회원 생성 API - POST :
/api/v1/auth/signup- 201 Created - 회원 등록 성공
- 400 Bad Request - 회원 등록 실패 (이름, 이메일, 비밀번호 없음 등)
- 회원 로그인 API - POST :
/api/v1/auth/signin- 200 OK - 로그인 성공
- 400 Bad Request - 로그인 실패 (이메일, 비밀번호 없음 등)
게시글 API
- 게시글 목록 조회 API - GET :
/api/v1/posts- 200 OK - 게시글 조회 성공
- 404 Not Found - 게시글 없음
- 게시글 생성 API - POST :
/api/v1/posts- 201 Created - 게시글 등록 성공
- 400 Bad Request - 게시글 등록 실패 (제목, 내용, 작성자 없음 등)
- 401 Unauthorized - 로그인 필요
- 게시글 수정 API - PATCH :
/api/v1/posts/{postId}- 200 OK - 게시글 수정 성공
- 400 Bad Request - 게시글 수정 실패 (제목, 내용, 작성자 없음 등)
- 401 Unauthorized - 로그인 필요
- 403 Forbidden - 권한 없음 (작성자와 수정자가 다를 경우)
- 404 Not Found - 게시글 없음
API 통합 테스트 코드 작성
Fixtures를 활용한 테스트 데이터 생성
Fixtures는 테스트에서 사용할 데이터를 미리 정의해두고, 테스트 실행 시 해당 데이터를 불러와 사용하는 방법입니다.
Fixtures를 사용하면 테스트 코드가 간결해지고, 데이터 생성 로직을 재사용할 수 있어 유지보수성이 향상됩니다.
Testing in Java & JVM projects
Testing on the JVM is a rich subject matter. There are many different testing libraries and frameworks, as well as many different types of test. All need to be part of the build, whether they are executed frequently or infrequently. This chapter is dedicated to explaining how Gradle handles differing requirements between and within builds, with significant coverage of how it integrates with the two most common testing frameworks: JUnit and TestNG.
Fixture-Monkey게시글을 참고하시면 더미데이터를 생성하는 방법을 확인할 수 있습니다.
JUnit5와 MockMvc를 활용한 API 통합 테스트
JUnit5와 MockMvc를 활용하여 API 통합 테스트를 진행합니다.
스프링의 전체 컨테이너가 구성되기 위해 @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) 어노테이션을 사용합니다.
RestFul API의 경우 Json 형식으로 요청과 응답을 주고받기 때문에, 반환값을 검사하기 위해 주로 JsonPath를 사용합니다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
@Transactional
@DirtiesContext
@DisplayName("Articles API 테스트")
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@AutoConfigureMockMvc
class AuthApiTest(
private val mockMvc: MockMvc,
private val authService: AuthService,
) : DescribeSpec(
{
extensions(SpringExtension)
describe("POST /api/v1/auth/register - 회원가입 API") {
it("200 OK") {
// given
val registerRequest = UsersFixture.getRandomRegisterRequest().let {
logger.info { "회원가입 요청 정보: ${it.prettyJson()}" }
it
}
// when & then
mockMvc.post("/api/v1/auth/register") {
contentType = MediaType.APPLICATION_JSON
content = jacksonObjectMapper().writeValueAsString(registerRequest)
}.andExpect {
status().isCreated
content().contentType(MediaType.APPLICATION_JSON)
jsonPath("$.token").isNotEmpty
}
}
it("400 Bad Request (@Valid)") {
// given
val invalidRegisterRequest = RegisterRequest(
email = "invalid-email",
password = "invalid-password",
name = "invalid-name",
phone = "invalid-phone",
)
logger.info { "회원가입 요청 정보: ${invalidRegisterRequest.prettyJson()}" }
// when & then
mockMvc.post("/api/v1/auth/register") {
contentType = MediaType.APPLICATION_JSON
content = jacksonObjectMapper().writeValueAsString(invalidRegisterRequest)
}.andExpect {
status().isBadRequest
content().contentType(MediaType.APPLICATION_JSON)
}
}
it("409 Conflict (이미 존재하는 이메일)") {
// given
val alreadyRegisteredUser = UsersFixture.getRandomRegisterRequest().let {
logger.info { "회원가입 요청 정보: ${it.prettyJson()}" }
authService.register(it)
it
}
// when & then
mockMvc.post("/api/v1/auth/register") {
contentType = MediaType.APPLICATION_JSON
content = jacksonObjectMapper().writeValueAsString(alreadyRegisteredUser)
}.andExpect {
status().isConflict
content().contentType(MediaType.APPLICATION_JSON)
}
}
}
describe("POST /api/v1/auth/login - 로그인 API") {
it("200 OK") {
// given
val alreadyRegisteredUser = UsersFixture.getRandomRegisterRequest().let {
logger.info { "회원가입 요청 정보: ${it.prettyJson()}" }
authService.register(it)
it
}
// when & then
mockMvc.post("/api/v1/auth/login") {
contentType = MediaType.APPLICATION_JSON
content = jacksonObjectMapper().writeValueAsString(
mapOf(
"email" to alreadyRegisteredUser.email,
"password" to alreadyRegisteredUser.password,
),
)
}.andExpect {
status().isOk
content().contentType(MediaType.APPLICATION_JSON)
jsonPath("$.token").isNotEmpty
}
}
it("400 Bad Request (잘못된 요청)") {
// given
val alreadyRegisteredUser: RegisterRequest = UsersFixture.getRandomRegisterRequest().let {
logger.info { "회원가입 정보: ${it.prettyJson()}" }
authService.register(it)
it
}
val invalidLoginRequest = UsersFixture.getRandomRegisterRequest().let {
logger.info { "잘못된 로그인 요청 정보: ${it.prettyJson()}" }
authService.register(it)
it
}
// when & then
mockMvc.post("/api/v1/auth/login") {
contentType = MediaType.APPLICATION_JSON
content = jacksonObjectMapper().writeValueAsString(
mapOf(
"email" to alreadyRegisteredUser.email,
"password" to invalidLoginRequest.password,
),
)
}.andExpect {
status().isBadRequest
content().contentType(MediaType.APPLICATION_JSON)
}
}
}
},
) {
companion object {
val logger: KLogger = KotlinLogging.logger {}
}
}
원티드 8월 프리온보딩 백엔드 챌린지 (게시글 CRUD). Contribute to cmsong111/Wanted-PreOnBoarding-Backend-Challenge development by creating an account on GitHub.
This post is licensed under CC BY 4.0 by the author.