Chapter 05. 스프링 시큐리티와 OAuth 2.0으로 로그인 기능 구현하기 (7)

5.7 기존 테스트에 시큐리티 적용하기

마지막으로 기존 테스트에 시큐리티 적용으로 문제가 되는 부분들을 해결해보겠다.

문제가 되는 이유는

기존에는 바로 API를 호출할 수 있어 테스트 코드 역시 바로 API를 호출하록 구성하였지만,

시큐리티 옵션이 활성화되면 인증된 사용자만 API를 호출할 수 있다.

-> 기존의 API테스트 코드마다 인증한 사용자가 호출한 것처럼 작동하도록 수정

 

인텔리제이 오른쪽 위 [Gradle] 탭을 클릭 [Tasks -> verification -> test]를 차례로 선택해서 전체 테스트를 수행

test를 실행해 보면 다음과 같이 롬복을 이용한 테스트 외에 스프링을 이용한 테스트는 모두 실패하는 것을 확인할 수 있음.

이유를 하나씩 확인해보자

---

문제1. CustomOAuth2UserService을 찾을 수 없음

 

첫 번째 실패 테스트인 "hello가 리턴된다"의 메시지를 보면 "No qualifying bean of type 'com.jojoldu.book.springboot.config.auth.CustomOAuth2-UserService'"라는 메시지가 등장

이는 CustomOAuth2UserService를 생성하는데 필요한 소셜 로그인 관련 설정값들이 없기 때문에 발생한다. 

분명 application-oauth.properties에 설정값들을 추가했는데 왜 설정이 없다고 할까?

 

이는 src/main환경과 src/test 환경의 차이 때문이다. 둘은 본인만의 환경 구성을 가진다.

다만, src/main/resources/application.properties가 테스트 코드를 수행할 때도 적용되는 이유는 test에 application.properties가 없으면 main의 설정을 그대로 가져오기 때문이다.

다만, 자동으로 가져오는 옵션의 범위는 application.properties 파일까지다.

즉, application-oauth.properties는 test에 파일이 없다고 가져오는 파일이 아니다.

이 문제를 해결하기 위해 테스트 환경을 위한 application.properties를 만든다.

실제로 구글 연동까지 진행할 것은 아니므로 가짜 설정값을 등록한다.

 

application.properties

spring.jpa.show-sql=true
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL5InnoDBDialect
spring.h2.console.enabled=true
spring.session.store-type=jdbc

# Test OAuth
spring.security.oauth2.client.registration.google.client-id=test
spring.security.oauth2.client.registration.google.client-secret=test
spring.security.oauth2.client.registration.google.scope=profile,email

 

 

문제 2. 302 Status Code

 

"Posts_등록된다" 테스트 로그를 확인해보자

Posts_등록된다 실패 로그

응답의 결과로 200(정상 응답) Status Code를 원했는데 결과는 302(리다이렉션 응답) Status Code가 와서 실패.

이는 스프링 시큐리티 설정 때문에 인증되지 않은 사용자의 요청은 이동시키기 때문이다.

그래서 이런 API요청은 임의로 인증된 사용자를 추가하여 API만 테스트해 볼 수 있게 하겠다.

 

스프링 시큐리티 테스트를 위한 여러 도구를 지원하는 Spring-security-test를 build.gradle에 추가

testCompile('org.springframework.security:spring-security-test')

그리고 PostsApiControllerTest의 2개 테스트 메소드에 다음과 같이 임의 사용자 인증을 추가

@WithMockUser(roles="USER")

 - 인증된 모의 사용자를 만들어 사용
 - roles에 권한을 추가할 수 있음
 - 즉, 이 어노테이션으로 인해 ROLE_USER 권한을 가진 사용자가 API를 요청하는 것과 동일한 효과를 가지게 됨.

하지만 실제로 동작하지 않음

: @WithMockUser가 MockMvc에서만 작동하기 때문이다. 현재 PostsApiControllerTest는 @SpringBootTest로만 되어있으며 MockMvc를 전혀 사용하지 않음. 그래서 @SpringBootTest에서 MockMvc를 사용하는 방법은 다음과 같이 코드를 변경한다.

package com.jojoldu.book.springboot.web;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.jojoldu.book.springboot.domain.posts.Posts;
import com.jojoldu.book.springboot.domain.posts.PostsRepository;
import com.jojoldu.book.springboot.web.dto.PostsSaveRequestDto;
import com.jojoldu.book.springboot.web.dto.PostsUpdateRequestDto;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.boot.web.server.LocalServerPort;
import org.springframework.http.MediaType;
import org.springframework.security.test.context.support.WithMockUser;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.context.WebApplicationContext;

import java.util.List;

import static org.assertj.core.api.Assertions.assertThat;
import static org.springframework.security.test.web.servlet.setup.SecurityMockMvcConfigurers.springSecurity;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.put;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

// For mockMvc

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class PostsApiControllerTest {

    @LocalServerPort
    private int port;

    @Autowired
    private TestRestTemplate restTemplate;

    @Autowired
    private PostsRepository postsRepository;

    @Autowired
    private WebApplicationContext context;

    private MockMvc mvc;

    @Before
    public void setup() {
        mvc = MockMvcBuilders
                .webAppContextSetup(context)
                .apply(springSecurity())
                .build();
    }

    @After
    public void tearDown() throws Exception {
        postsRepository.deleteAll();
    }

    @Test
    @WithMockUser(roles="USER")
    public void Posts_등록된다() throws Exception {
        //given
        String title = "title";
        String content = "content";
        PostsSaveRequestDto requestDto = PostsSaveRequestDto.builder()
                .title(title)
                .content(content)
                .author("author")
                .build();

        String url = "http://localhost:" + port + "/api/v1/posts";

        //when
        mvc.perform(post(url)
                        .contentType(MediaType.APPLICATION_JSON_UTF8)
                        .content(new ObjectMapper().writeValueAsString(requestDto)))
                .andExpect(status().isOk());

        //then
        List<Posts> all = postsRepository.findAll();
        assertThat(all.get(0).getTitle()).isEqualTo(title);
        assertThat(all.get(0).getContent()).isEqualTo(content);
    }

    @Test
    @WithMockUser(roles="USER")
    public void Posts_수정된다() throws Exception {
        //given
        Posts savedPosts = postsRepository.save(Posts.builder()
                .title("title")
                .content("content")
                .author("author")
                .build());

        Long updateId = savedPosts.getId();
        String expectedTitle = "title2";
        String expectedContent = "content2";

        PostsUpdateRequestDto requestDto = PostsUpdateRequestDto.builder()
                .title(expectedTitle)
                .content(expectedContent)
                .build();

        String url = "http://localhost:" + port + "/api/v1/posts/" + updateId;

        //when
        mvc.perform(put(url)
                        .contentType(MediaType.APPLICATION_JSON_UTF8)
                        .content(new ObjectMapper().writeValueAsString(requestDto)))
                .andExpect(status().isOk());

        //then
        List<Posts> all = postsRepository.findAll();
        assertThat(all.get(0).getTitle()).isEqualTo(expectedTitle);
        assertThat(all.get(0).getContent()).isEqualTo(expectedContent);
    }
}

①import
 - 새로 추가되는 부분 많음

② @Before
 - 매번 테스트가 시작되기 전에 MockMvc 인스턴스를 생성

③ mvc.perform
 - 생성된 MockMvc를 통해 API를 테스트
 - 본문(Body) 영역은 문자열로 표현하기 위해 ObjectMapper를 통해 문자열 JSON으로 변환

Post 테스트도 정상적으로 수행됨

 

 

문제 3. @WebMvcTest에서 CustomOAuth2UserService을 찾을 수 없음

 

문제1에서 발생한 "Hello가 리턴된다" 테스트를 확인해보자.

그럼 첫 번쨰로 해결한 것과 동일한 메시지인 "No qualifying bean of type 'com.jojoldu.book.springboot.config.auth.CustomOAuth2UserService'"이다.

 

이 문제는 왜 발생할까?

 

HelloControllerTest는 1번과 조금 다르다. 바로 @WebMvcTest를 사용한다는 점이다.

1번을 통해 스프링 시큐리티 설정은 잘 작동했지만, @WebMvcTest는 CustomOAuth2UserService를 스캔하지 않기 때문

 

@WebMvcTest는 WebSecurityConfigurerAdapter, WebMvcConfigurer를 비롯한 @ControllerAdvice, @Controller를 읽는다. 즉, @Repository, @Service, @Component는 스캔 대상이 아니다.

 

그러니 SecurityConfig는 읽었지만, 그를 생성하기 위해 필요한 CustomOAuth2UserService는 읽을 수가 없어 앞에서와 같이 에러가 발생.

 

그래서 이 문제를 해결하기 위한 다음과 같이 스캔대상에서 SecurityConfig를 제거한다.

@WebMvcTest(controllers = HelloController.class, excludeFilters = {@ComponentScan.Filter(type= FilterType.ASSIGNABLE_TYPE,classes= SecurityConfig.class)})

 

마찬가지로 @WithMockUser를 사용해 가짜로 인증된 사용자를 생성

@WithMockUser(roles="USER")

 

이렇게 한 뒤 다시 테스트를 돌려보면 다음과 같은 추가 에러가 발생한다.

 

java.lang.IllegalArgumentException: JPA metamodel must not be empty!

 

이 에러는 @EnableJpaAuditing로 인해 발생한다. @EnableJpaAuditing를 사용하기 위해서 최소 하나의 @Entity 클래스가 필요하다

@WebMvcTest이다 보니 당연히 없다.

@EnableJpaAuditing가 @SpringBootApplication와 함께 있다보니 @WebMvcTest에서도 스캔하게 되었다. 그래서 @EnableJpaAuditing과 @SpringBootApplication  둘을 분리. Application.java에서 @EnableJpaAuditing을 제거

Application.java

// 삭제 @EnableJpaAuditing // JPA Auditing 활성화
@SpringBootApplication
public class Application { //앞으로 만들 프로젝트의 메인 클래스
    public static void main(String[] args){
        SpringApplication.run(Application.class,args);
    }
}

 

그리고 config 패키지에 JpaConfig를 생성하여 @EnableJpaAuditing 추가

 

JpaConfig.java

package com.jojoldu.book.springboot.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.data.jpa.repository.config.EnableJpaAuditing;

@Configuration
@EnableJpaAuditing
public class JpaConfig {
}

 

전체 테스트 통과!

 

 

출처 : 스프링 부트와 AWS로 혼자 구현하는 웹 서비스 [이동욱 지음]