Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,13 @@
import com.example.solidconnection.admin.service.AdminGpaScoreService;
import com.example.solidconnection.admin.service.AdminLanguageTestScoreService;
import com.example.solidconnection.custom.response.PageResponse;
import com.example.solidconnection.util.PagingUtils;
import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Pageable;
import org.springframework.data.web.PageableDefault;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.PatchMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
Expand All @@ -35,15 +31,15 @@ public class AdminScoreController {
private final AdminGpaScoreService adminGpaScoreService;
private final AdminLanguageTestScoreService adminLanguageTestScoreService;

// todo: 추후 커스텀 페이지 객체 & argumentResolver를 적용 필요
@GetMapping("/gpas")
public ResponseEntity<PageResponse<GpaScoreSearchResponse>> searchGpaScores(
@Valid @ModelAttribute ScoreSearchCondition scoreSearchCondition,
@PageableDefault(page = 1) Pageable pageable
Pageable pageable
) {
PagingUtils.validatePage(pageable.getPageNumber(), pageable.getPageSize());
Pageable internalPageable = PageRequest.of(pageable.getPageNumber() - 1, pageable.getPageSize());
Page<GpaScoreSearchResponse> page = adminGpaScoreService.searchGpaScores(scoreSearchCondition, internalPageable);
Page<GpaScoreSearchResponse> page = adminGpaScoreService.searchGpaScores(
scoreSearchCondition,
pageable
);
return ResponseEntity.ok(PageResponse.of(page));
}

Expand All @@ -56,15 +52,15 @@ public ResponseEntity<GpaScoreResponse> updateGpaScore(
return ResponseEntity.ok(response);
}

// todo: 추후 커스텀 페이지 객체 & argumentResolver를 적용 필요
@GetMapping("/language-tests")
public ResponseEntity<PageResponse<LanguageTestScoreSearchResponse>> searchLanguageTestScores(
@Valid @ModelAttribute ScoreSearchCondition scoreSearchCondition,
@PageableDefault(page = 1) Pageable pageable
Pageable pageable
) {
PagingUtils.validatePage(pageable.getPageNumber(), pageable.getPageSize());
Pageable internalPageable = PageRequest.of(pageable.getPageNumber() - 1, pageable.getPageSize());
Page<LanguageTestScoreSearchResponse> page = adminLanguageTestScoreService.searchLanguageTestScores(scoreSearchCondition, internalPageable);
Page<LanguageTestScoreSearchResponse> page = adminLanguageTestScoreService.searchLanguageTestScores(
scoreSearchCondition,
pageable
);
return ResponseEntity.ok(PageResponse.of(page));
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package com.example.solidconnection.config.web;


import com.example.solidconnection.custom.resolver.AuthorizedUserResolver;
import com.example.solidconnection.custom.resolver.CustomPageableHandlerMethodArgumentResolver;
import com.example.solidconnection.custom.resolver.ExpiredTokenResolver;
import lombok.RequiredArgsConstructor;
import org.springframework.context.annotation.Configuration;
Expand All @@ -16,12 +16,14 @@ public class WebMvcConfig implements WebMvcConfigurer {

private final AuthorizedUserResolver authorizedUserResolver;
private final ExpiredTokenResolver expiredTokenResolver;
private final CustomPageableHandlerMethodArgumentResolver customPageableHandlerMethodArgumentResolver;

@Override
public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
resolvers.addAll(List.of(
authorizedUserResolver,
expiredTokenResolver
expiredTokenResolver,
customPageableHandlerMethodArgumentResolver
));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,6 @@ public enum ErrorCode {
USER_DO_NOT_HAVE_GPA(HttpStatus.BAD_REQUEST.value(), "해당 유저의 학점을 찾을 수 없음"),
REJECTED_REASON_REQUIRED(HttpStatus.BAD_REQUEST.value(), "거절 사유가 필요합니다."),

// page
INVALID_PAGE(HttpStatus.BAD_REQUEST.value(), "페이지 번호는 1 이상 50 이하만 가능합니다."),
INVALID_SIZE(HttpStatus.BAD_REQUEST.value(), "페이지 크기는 1 이상 50 이하만 가능합니다."),

// general
JSON_PARSING_FAILED(HttpStatus.BAD_REQUEST.value(), "JSON 파싱을 할 수 없습니다."),
JWT_EXCEPTION(HttpStatus.BAD_REQUEST.value(), "JWT 토큰을 처리할 수 없습니다."),
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
package com.example.solidconnection.custom.resolver;

import org.springframework.data.domain.PageRequest;
import org.springframework.data.web.PageableHandlerMethodArgumentResolver;
import org.springframework.stereotype.Component;

@Component
public class CustomPageableHandlerMethodArgumentResolver extends PageableHandlerMethodArgumentResolver {

private static final int DEFAULT_PAGE = 0;
private static final int MAX_SIZE = 50;
private static final int DEFAULT_SIZE = 10;

public CustomPageableHandlerMethodArgumentResolver() {
setMaxPageSize(MAX_SIZE);
setOneIndexedParameters(true);
setFallbackPageable(PageRequest.of(DEFAULT_PAGE, DEFAULT_SIZE));
}
}
26 changes: 0 additions & 26 deletions src/main/java/com/example/solidconnection/util/PagingUtils.java

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
package com.example.solidconnection.custom.resolver;

import com.example.solidconnection.support.TestContainerSpringBootTest;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.MethodParameter;
import org.springframework.data.domain.Pageable;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.context.request.ServletWebRequest;

import java.lang.reflect.Method;
import java.util.stream.Stream;

import static org.assertj.core.api.Assertions.assertThat;

@TestContainerSpringBootTest
@DisplayName("커스텀 페이지 요청 argument resolver 테스트")
class CustomPageableHandlerMethodArgumentResolverTest {

private static final String PAGE_PARAMETER = "page";
private static final String SIZE_PARAMETER = "size";
private static final int DEFAULT_PAGE = 0;
private static final int DEFAULT_SIZE = 10;
private static final int MAX_SIZE = 50;

@Autowired
private CustomPageableHandlerMethodArgumentResolver customPageableHandlerMethodArgumentResolver;

private MockHttpServletRequest request;
private NativeWebRequest webRequest;
private MethodParameter parameter;

@BeforeEach
void setUp() throws NoSuchMethodException {
request = new MockHttpServletRequest();
webRequest = new ServletWebRequest(request);
Method method = TestController.class.getMethod("pageableMethod", Pageable.class);
parameter = new MethodParameter(method, 0);
}

@Test
void 유효한_페이지_파라미터가_있으면_해당_값을_사용한다() {
// given
int expectedPage = 2;
request.setParameter(PAGE_PARAMETER, String.valueOf(expectedPage));

// when
Pageable pageable = customPageableHandlerMethodArgumentResolver
.resolveArgument(parameter, null, webRequest, null);

// then
assertThat(pageable.getPageNumber()).isEqualTo(expectedPage - 1);
assertThat(pageable.getPageSize()).isEqualTo(DEFAULT_SIZE);
}

@Test
void 유효한_사이즈_파라미터가_있으면_해당_값을_사용한다() {
// given
int expectedSize = 20;
request.setParameter(SIZE_PARAMETER, String.valueOf(expectedSize));

// when
Pageable pageable = customPageableHandlerMethodArgumentResolver
.resolveArgument(parameter, null, webRequest, null);

// then
assertThat(pageable.getPageNumber()).isEqualTo(DEFAULT_PAGE);
assertThat(pageable.getPageSize()).isEqualTo(expectedSize);
}

@Test
void 사이즈_파라미터가_최대값을_초과하면_최대값을_사용한다() {
// given
request.setParameter(SIZE_PARAMETER, String.valueOf(MAX_SIZE + 1));

// when
Pageable pageable = customPageableHandlerMethodArgumentResolver
.resolveArgument(parameter, null, webRequest, null);

// then
assertThat(pageable.getPageSize()).isEqualTo(MAX_SIZE);
}

@ParameterizedTest(name = "{0}")
@MethodSource("provideInvalidParameters")
void 페이지_파라미터가_유효하지_않으면_기본_값을_사용한다(String testName, String pageParam) {
// given
request.setParameter(PAGE_PARAMETER, pageParam);

// when
Pageable pageable = customPageableHandlerMethodArgumentResolver
.resolveArgument(parameter, null, webRequest, null);

// then
assertThat(pageable.getPageNumber()).isEqualTo(DEFAULT_PAGE);
}

@ParameterizedTest(name = "{0}")
@MethodSource("provideInvalidParameters")
void 사이즈_파라미터가_유효하지_않으면_기본_값을_사용한다(String testName, String sizeParam) {
// given
request.setParameter(SIZE_PARAMETER, sizeParam);

// when
Pageable pageable = customPageableHandlerMethodArgumentResolver
.resolveArgument(parameter, null, webRequest, null);

// then
assertThat(pageable.getPageSize()).isEqualTo(DEFAULT_SIZE);
}

static Stream<Arguments> provideInvalidParameters() {
Copy link
Collaborator

@nayonsoso nayonsoso Apr 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(이 부분을 짚을까 고민이 되었지만..!
규혁님이 앞으로도 테스트 코드 리팩터링을 할 예정이니, 생각해볼만한 지점이 될것 같다 생각해서 말씀드립니다.
다만 이 부분은 제가 너무 과하게 생각하는걸수도 있어요..😓 아니다 싶으면 규혁님 의견대로 가도 됩니다!)

제 생각에 이 테스트 코드는 "페이지와 사이즈의 정책을 동시에 테스트하는 함수" 같아요.
테스트 코드는 작은 영역을 테스트할수록 좋아요.
그 목적이 명확해질 뿐 아니라, 변경에도 유연하게 대처할 수 있기 때문입니다.
예를 들어, '페이지는 기본 값으로 대체되지만, 사이즈는 예외를 던지게 한다' 처럼 정책이 수정된다면,
이 함수는 두개로 나뉘어야 할거예요.
그래서 저라면 '페이지_파라미터가_유효하지_않으면' 함수와 '사이즈_파라미터가_유효하지_않으면' 함수 둘로 나눌 것 같아요.
그렇게 되면 95~100 라인은 중복되는 테스트이니 없앨 수도 있고요!

그리고 동시에 두가지를 테스트하려고하니, 테스트 함수에 전해줘야 하는 인자도
(String testName, String pageParam, String sizeParam, int expectedPage, int expectedSize)
이렇게 다섯개나 되어 가독성이 떨어진다는 점도 생각해볼만 한 것 같아요~

cf. 만약에 "유효하지 않은 경우"를 두개로 분리하시기로 했다면, "유효한 경우"도 분리하는게 통일감있을 것 같습니다.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

저도 통일성이 있어야할 거 같다고 생각합니다!
사실 그래서 성공 케이스에서 페이지랑 사이즈를 동시에 확인하고 있으니 실패 케이스도 그렇게 하는 게 통일감이 있겠다 싶어서 그랬습니다. 😓 그러다보니 자연스레 인자도 늘어나버렸네요.

말씀해주신 대로 분리를 하는 게 나중에 정책이 바뀌었을 때 더 유연하게 대처할 수 있을 거 같다고 생각해요! 반영해놓겠습니다!

return Stream.of(
Arguments.of("null", null),
Arguments.of("빈 문자열", ""),
Arguments.of("0", "0"),
Arguments.of("음수", "-1"),
Arguments.of("문자열", "invalid")
);
}

private static class TestController {

public void pageableMethod(Pageable pageable) {
}
}
}

This file was deleted.

Loading