MockMvc | Vault | 김승찬 블로그

MockMvc는 실제 서버를 배포하지 않고 컨트롤러(Controller) 레이어를 테스트하는 Spring 테스트 프레임워크이다.
Servlet Container를 실제로 띄우지 않고 MVC(Mode View Controller) 동작을 시뮬레이션한다.
JUnit5 + AssertJ와 함께 사용하며, BDD의 Given-When-Then 패턴으로 작성한다.
@WebMvcTest와 함께 사용하면 웹 계층만 로드하여 빠른 테스트가 가능하다.

@WebMvcTest — 컨트롤러 슬라이스 테스트 (권장)

웹 레이어(컨트롤러(Controller), Filter, HandlerInterceptor)만 로드 → @Service, @Repository는 제외.
제외된 의존성은 @MockBean으로 대체한다.

Java

@SpringBootTest + MockMvc — 통합 테스트

전체 스프링 컨테이너(Spring Container)를 로드하므로 무겁지만 실제 환경에 가장 가깝다.

Java

@WebMvcTest vs @SpringBootTest

항목	@WebMvcTest	@SpringBootTest
로드 범위	웹 레이어만	전체 컨텍스트
속도	빠름	느림
실제 DB	X (Mock 사용)	O
@MockBean 필요	O (서비스 레이어)	X (실제 Bean)

jsonPath — JSON 응답 검증

Java

Spring Security 인증 테스트

Java

MockMvc 사용법

컨트롤러를 테스트한다고 가정한다.

Java

MockMvc를 생성한다.
MockMvc에게 요청에 대한 정보를 입력한다.
요청에 대한 응답값을 Expect를 이용하여 테스트한다.
Expect가 모두 통과하면 테스트 통과
Expect가 1개라도 실패하면 테스트 실패

예시

아래 코드는 GET 메서드 테스트이고 Given-When-Then 패턴이 사용되었다.
의존성 주입(DI(Dependency Injection))가 일어나야 함으로 생성자(constructor)에서 @Autowired 어노테이션(Annotation)을 붙였다.

Java

WebAppConfiguration

Controller 및 web 환경에 사용되는 빈을 자동으로 생성하여 등록한다.

standaloneSetup()

단독 실행할 때 쓰이는 메서드(Method)로 MockMvcBuilders 라이브러리에 있어 정적 임포트를 하면 좋다.

Java

"WelcomController"만 테스트한다는 의미이다.
단위 테스트에서 자주 쓰인다.
대상 Controller를 커스텀 할 수 있다.

addFilter()

addFilter()로 필터를 추가할 수 있다.

Java

perform()

MockMvc를 실행할 때는 perform()을 이용하여 설정한 MockMvc를 실행할 수 있다.

Java

perform에 요청 설정 메서드를 통해성 요청에 대한 설정을 할 수 있다.
perform에 Expect 메서드를 통해서 테스트를 진행할 수 있다.

MockMvc Request 설정 메서드

MockMvc는 요청에 대한 설정을 할 수 있다.

param() / params()

쿼리 스트링을 설정한다.

cookie()

쿠키를 설정한다.

requestAttr ()

요청 스코프 객체를 설정한다.

sessionAttr()

세션 스코프 객체를 설정한다.

content()

요청 본문 설정한다.

header() / headers()

요청 헤더 설정한다.

contentType()

본문 타입을 설정한다.

contentTypeCompatibleWith()

본문 타입을 설정하는 뒤에 부가정보를 비교하지 않는다.
예를 들어 :UTF-8과 같은 정보까지 비교하지 않기 때문에 실 개발에서 많이 쓰인다.

Java

MockMvc Response 검증 메서드

이제 응답에 대한 검증 메소드를 살펴본다.

status

상태 코드를 검증한다.

header

응답 header를 검증한다.

content

응답 본문을 검증한다.

cookie

쿠키 상태를 검증한다.

view

컨트롤러(Controller)가 반환한 뷰(View) 이름을 검증한다.

redirectedUrl(Pattern)

리다이렉트(Redirect) 대상의 경로를 검증한다.

model

스프링 MVC(Mode View Controller) 모델 상태를 검증한다.

request

세션 스코프, 비동기 처리, 요청 스코프 상태를 검증한다.

forwardedUrl

이동대상의 경로를 검증한다.

Java

위킈 코드를 실행하면 status 검증 -> conten 검증 -> view 검증 순으로 실시한다.
1개라도 통과되지 않으면 테스트는 fail 하게 된다.

MockMvc 기타 메서드

요청 설정, 검증 설정 메소드가 아닌 기타 메서드도 존재한다.

andDo()

print, log를 사용할 수 있는 메서드이다.

print()

실행결과를 지정해준 대상으로 출력, default = System.out

log()

실행결과를 디버깅 레벨로 출력, 레벨은 org.springframework.test.web.servlet.result이다.

Java

응답 생태코드

isOk() : 상태 코드가 200인지 확인
isNotFount() : 404인지 확인
isMethodNotAllowed() : 405인지 확인
isInternalServerError() : 500인지 확인
is(int status) : 임의로 지정한 상태 코드인지 확인

모델 검증 속성

Java

attributeExists(String key) : key에 해당하는 데이터가 model에 있는지 검증
attribute(String key, Object value1) : key에 해당하는 value가 입력해준 "value1"과 일치한지 확인

뷰 이름 검증

Java

name(String viewName) : 응답된 뷰 이름이 viewName과 일치한지 확인

리다이렉트 검증

Java

MockMvc는 실제 서버를 배포하지 않고 컨트롤러(Controller) 레이어를 테스트하는 Spring 테스트 프레임워크이다.
Servlet Container를 실제로 띄우지 않고 MVC(Mode View Controller) 동작을 시뮬레이션한다.
JUnit5 + AssertJ와 함께 사용하며, BDD의 Given-When-Then 패턴으로 작성한다.
@WebMvcTest와 함께 사용하면 웹 계층만 로드하여 빠른 테스트가 가능하다.

@WebMvcTest — 컨트롤러 슬라이스 테스트 (권장)

웹 레이어(컨트롤러(Controller), Filter, HandlerInterceptor)만 로드 → @Service, @Repository는 제외.
제외된 의존성은 @MockBean으로 대체한다.

Java
@WebMvcTest(PostController.class)
@AutoConfigureMockMvc(addFilters = false)  // 인증 필터 제외
class PostControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @Autowired
    private ObjectMapper objectMapper;  // JSON 변환

    @MockBean
    private PostUseCase postUseCase;   // 서비스 레이어 Mock

    @Test
    @DisplayName("게시글 단건 조회 - 200 OK 반환")
    void getPost_success() throws Exception {
        // Given
        PostResponse response = new PostResponse(1L, "Spring Boot 입문", "PUBLISHED");
        given(postUseCase.findById(1L)).willReturn(response);

        // When & Then
        mockMvc.perform(get("/api/posts/1")
                .contentType(MediaType.APPLICATION_JSON))
            .andExpect(status().isOk())
            .andExpect(jsonPath("$.id").value(1L))
            .andExpect(jsonPath("$.title").value("Spring Boot 입문"))
            .andDo(print());
    }

    @Test
    @DisplayName("게시글 생성 - 201 Created 반환")
    void createPost_success() throws Exception {
        // Given
        CreatePostRequest request = new CreatePostRequest("제목", "내용");
        PostResponse response = new PostResponse(1L, "제목", "DRAFT");
        given(postUseCase.create(any())).willReturn(response);

        // When & Then
        mockMvc.perform(post("/api/posts")
                .contentType(MediaType.APPLICATION_JSON)
                .content(objectMapper.writeValueAsString(request)))
            .andExpect(status().isCreated())
            .andExpect(jsonPath("$.id").value(1L))
            .andDo(print());
    }

    @Test
    @DisplayName("존재하지 않는 게시글 조회 - 404 반환")
    void getPost_notFound() throws Exception {
        // Given
        given(postUseCase.findById(999L))
            .willThrow(new ResourceNotFoundException("Post not found: 999"));

        // When & Then
        mockMvc.perform(get("/api/posts/999"))
            .andExpect(status().isNotFound())
            .andExpect(jsonPath("$.message").value("Post not found: 999"));
    }
}

@SpringBootTest + MockMvc — 통합 테스트

전체 스프링 컨테이너(Spring Container)를 로드하므로 무겁지만 실제 환경에 가장 가깝다.

Java
@SpringBootTest
@AutoConfigureMockMvc
@Transactional
class PostApiIntegrationTest {

    @Autowired
    private MockMvc mockMvc;

    @Autowired
    private PostRepository postRepository;

    @BeforeEach
    void setUp() {
        postRepository.deleteAll();
    }
}

@WebMvcTest vs @SpringBootTest

항목	@WebMvcTest	@SpringBootTest
로드 범위	웹 레이어만	전체 컨텍스트
속도	빠름	느림
실제 DB	X (Mock 사용)	O
@MockBean 필요	O (서비스 레이어)	X (실제 Bean)

jsonPath — JSON 응답 검증

Java
.andExpect(jsonPath("$.id").value(1))
.andExpect(jsonPath("$.title").value("Spring Boot"))
.andExpect(jsonPath("$.items").isArray())
.andExpect(jsonPath("$.items[0].id").value(1))
.andExpect(jsonPath("$.id").exists())
.andExpect(jsonPath("$.deletedAt").doesNotExist())

Spring Security 인증 테스트

Java
@Test
@WithMockUser(username = "user", roles = "USER")   // 인증된 사용자 시뮬레이션
@DisplayName("인증된 사용자는 게시글 조회 가능")
void authenticated_returnsPost() throws Exception {
    given(postUseCase.findById(1L)).willReturn(new PostResponse(1L, "제목", "PUBLISHED"));
    mockMvc.perform(get("/api/posts/1"))
        .andExpect(status().isOk());
}

MockMvc 사용법

컨트롤러를 테스트한다고 가정한다.

Java
class ControllerTest{
	
    @Autowired
    private MockMvc mockMvc; // mockMvc 생성
    // 실제로 생성자에서 주입하는 것이 더 좋음
    
    @Test
    public void testController() throws Exception{
    	
        String jjson = "{\"name\": \"부대찌개\"}";
        
        //mockMvc에게 컨트롤러에 대한 정보를 입력하자.
        
        mockMvc.perform(
        get("test?query=food") //해당 url로 요청을 한다.
        .contentType(MediaType.APPLICATION_JSON) // Json 타입으로 지정
        .content(jjson) // jjson으로 내용 등록
        .andExpect(status().isOk()) // 응답 status를 ok로 테스트
        .andDo(print()); // 응답값 print
        )
        
        }
}

MockMvc를 생성한다.
MockMvc에게 요청에 대한 정보를 입력한다.
요청에 대한 응답값을 Expect를 이용하여 테스트한다.
Expect가 모두 통과하면 테스트 통과
Expect가 1개라도 실패하면 테스트 실패

예시

아래 코드는 GET 메서드 테스트이고 Given-When-Then 패턴이 사용되었다.
의존성 주입(DI(Dependency Injection))가 일어나야 함으로 생성자(constructor)에서 @Autowired 어노테이션(Annotation)을 붙였다.

Java
@DisplayName("View 컨트롤러 - 게시글")  
@WebMvcTest  
class ArticleControllerTest {  
    private final MockMvc mvc;  
	  
    public ArticleControllerTest(@Autowired MockMvc mvc) { // 테스트 패키지에서는 의존성 주입이 필요  
        this.mvc = mvc;  
    }  
	  
    @DisplayName("[view] [GET] 게시글 리스트 (게시판) 페이지 - 정상 호출")  
    @Test  
    public void givenNothing_whenRequestArticlesView_thenReturnsArticlesView() throws Exception {  
        // Given  
	  
        // When & Then        mvc.perform(get("/articles"))  
                .andExpect(status().isOk())  
                .andExpect(content().contentType(MediaType.TEXT_HTML))  
                .andExpect(model().attributeExists("articles"));  
    }  
}

## MockMvc [**메서드(Method)**](/vault/메서드method)

### @ContextHierychy

- 테스트용 [**DI(Dependency Injection)**](/vault/didependency-injection) 컨테이너 만들 때 [**Bean**](/vault/bean-2) 파일을 지정하는 [**어노테이션(Annotation)**](/vault/어노테이션annotation)이다.

```java
@ContextHierarchy({
	@ContextConfiguration(classes = AppConfig.class),
    @ContextConfiguration(classes = WebMvcConfig.class)
})

WebAppConfiguration

Controller 및 web 환경에 사용되는 빈을 자동으로 생성하여 등록한다.

standaloneSetup()

단독 실행할 때 쓰이는 메서드(Method)로 MockMvcBuilders 라이브러리에 있어 정적 임포트를 하면 좋다.

Java
	public class WelcomeControllerTest {
    MockMvc mockMvc;

    @Before
    public void setUpMockMvc() {
        this.mockMvc = MockMvcBuilders.standaloneSetup(new WelcomeController()).build();
    }
}

"WelcomController"만 테스트한다는 의미이다.
단위 테스트에서 자주 쓰인다.
대상 Controller를 커스텀 할 수 있다.

addFilter()

addFilter()로 필터를 추가할 수 있다.

Java
class testt(){
	
    MockMvc mockMvc;
    
	@Before
	public void setUpMockMvc(){
		
		this.mockMvc = MockMvcBuilders
		    			.standaloneSetup(TestController.class)
                        .addFilter(new SessionFilter()) //필터 추가
                        .build();
	}
}

perform()

MockMvc를 실행할 때는 perform()을 이용하여 설정한 MockMvc를 실행할 수 있다.

Java
@Test
public void testController() throws Exception{
	mockMvc.perform(
        get("test?query=food")
        );

perform에 요청 설정 메서드를 통해성 요청에 대한 설정을 할 수 있다.
perform에 Expect 메서드를 통해서 테스트를 진행할 수 있다.

MockMvc Request 설정 메서드

MockMvc는 요청에 대한 설정을 할 수 있다.

param() / params()

쿼리 스트링을 설정한다.

cookie()

쿠키를 설정한다.

requestAttr ()

요청 스코프 객체를 설정한다.

sessionAttr()

세션 스코프 객체를 설정한다.

content()

요청 본문 설정한다.

header() / headers()

요청 헤더 설정한다.

contentType()

본문 타입을 설정한다.

contentTypeCompatibleWith()

본문 타입을 설정하는 뒤에 부가정보를 비교하지 않는다.
예를 들어 :UTF-8과 같은 정보까지 비교하지 않기 때문에 실 개발에서 많이 쓰인다.

Java
@Test
public void testController() throws Exception{
	
    mockMvc.perforem(get("test"))
    	.param("query", "부대찌개")
        .cookie("쿠키 값")
        .header("헤더 값:)
        .contentType(MediaType.APPLICATION.JSON)
        .content("json으로");
}

MockMvc Response 검증 메서드

이제 응답에 대한 검증 메소드를 살펴본다.

status

상태 코드를 검증한다.

header

응답 header를 검증한다.

content

응답 본문을 검증한다.

cookie

쿠키 상태를 검증한다.

view

컨트롤러(Controller)가 반환한 뷰(View) 이름을 검증한다.

redirectedUrl(Pattern)

리다이렉트(Redirect) 대상의 경로를 검증한다.

model

스프링 MVC(Mode View Controller) 모델 상태를 검증한다.

request

세션 스코프, 비동기 처리, 요청 스코프 상태를 검증한다.

forwardedUrl

이동대상의 경로를 검증한다.

Java
@Test
public void testController() throws Exception{
	mockMvc.perform(get("test"))
    	.param("query", "부대찌개")
        .cooke("쿠키 값")
        .header("헤더 값:)
        .contentType(MediaType.APPLICATION.JSON)
        .content("json으로")
        .andExpect(status().isOk()) // 여기부터 검증
        .andExpect(content().string("expect json값"))
        .andExpect(view().string("뷰이름"));

위킈 코드를 실행하면 status 검증 -> conten 검증 -> view 검증 순으로 실시한다.
1개라도 통과되지 않으면 테스트는 fail 하게 된다.

MockMvc 기타 메서드

요청 설정, 검증 설정 메소드가 아닌 기타 메서드도 존재한다.

andDo()

print, log를 사용할 수 있는 메서드이다.

print()

실행결과를 지정해준 대상으로 출력, default = System.out

log()

실행결과를 디버깅 레벨로 출력, 레벨은 org.springframework.test.web.servlet.result이다.

Java
@Test
public void testController() throws Exception{
	
    mockMvc.perforem(get("test"))
    	.param("query", "부대찌개")
        .cookie("쿠키 값")
        .header("헤더 값:)
        .contentType(MediaType.APPLICATION.JSON)
        .content("json으로")
        
        .andExpect(status().isOk()) 
        .andExpect(content().string("expect json값"))
        .andExpect(view().string("뷰이름"))
        
        .andDo(print()) //여기부터 기타 메소드
        .andDo(log());

응답 생태코드

isOk() : 상태 코드가 200인지 확인
isNotFount() : 404인지 확인
isMethodNotAllowed() : 405인지 확인
isInternalServerError() : 500인지 확인
is(int status) : 임의로 지정한 상태 코드인지 확인

모델 검증 속성

Java
.andExpect(model().atrribute("userId", "fly123"))

attributeExists(String key) : key에 해당하는 데이터가 model에 있는지 검증
attribute(String key, Object value1) : key에 해당하는 value가 입력해준 "value1"과 일치한지 확인

뷰 이름 검증

Java
.andExpect(view().name("home"));

name(String viewName) : 응답된 뷰 이름이 viewName과 일치한지 확인

리다이렉트 검증

Java
.andExpect(redirectedUrl("/foodList?name=부대찌개"));

@WebMvcTest — 컨트롤러 슬라이스 테스트 (권장)

@SpringBootTest + MockMvc — 통합 테스트

@WebMvcTest vs @SpringBootTest

jsonPath — JSON 응답 검증

Spring Security 인증 테스트

MockMvc 사용법

예시

WebAppConfiguration

standaloneSetup()

addFilter()

perform()

MockMvc Request 설정 메서드

param() / params()

cookie()

requestAttr ()

sessionAttr()

content()

header() / headers()

contentType()

contentTypeCompatibleWith()

MockMvc Response 검증 메서드

status

header

content

cookie

view

redirectedUrl(Pattern)

model

request

forwardedUrl

MockMvc 기타 메서드

andDo()

print()

log()

응답 생태코드

모델 검증 속성

뷰 이름 검증

리다이렉트 검증

Synapse Map Insight

@WebMvcTest — 컨트롤러 슬라이스 테스트 (권장)

@SpringBootTest + MockMvc — 통합 테스트

@WebMvcTest vs @SpringBootTest

jsonPath — JSON 응답 검증

Spring Security 인증 테스트

MockMvc 사용법

예시

WebAppConfiguration

standaloneSetup()

addFilter()

perform()

MockMvc Request 설정 메서드

param() / params()

cookie()

requestAttr ()

sessionAttr()

content()

header() / headers()

contentType()

contentTypeCompatibleWith()

MockMvc Response 검증 메서드

status

header

content

cookie

view

redirectedUrl(Pattern)

model

request

forwardedUrl

MockMvc 기타 메서드

andDo()

print()

log()

응답 생태코드

모델 검증 속성

뷰 이름 검증

리다이렉트 검증

Synapse Map Insight