CLOVER🍀

That was when it all began.

Spring Web MVCアプリケヌションのテスト方法を芋おいきたいモックでBeanのテスト

これは、なにをしたくお曞いたもの

Spring Web MVCのテスト方法を、ドキュメントをしっかり眺めお芋たこずないなぁず。
時々扱っおいる時もかなり雰囲気で䜿っおいたので、ちょっず芋おみるこずにしたした。

あず、オマケでモックMockitoでふ぀うにBeanのテストをするものも぀けおおきたす。

この゚ントリヌは、こちらの続き的な感じですね。

Spring Boot/Spring Frameworkのテストに関するドキュメントをざっくり眺めてみる - CLOVER🍀

参照するドキュメントずSpring Web MVCのテスト

今回、Spring Web MVCのテストを芋おいくにあたり、参照するドキュメントは䞻に次の2぀です。

Spring Bootのテストに関するドキュメント。

Core Features / Testing

さらに絞り蟌むず、Spring Boot Applicationのテストに関するセクションですね。

Core Features / Testing / Testing Spring Boot Applications

Spring Frameworkのテストに関するドキュメント。

Testing

こちらも絞り蟌むず、むンテグレヌションテストに関するセクションになりたす。

Testing / Integration Testing

基本的には、Spring Bootのドキュメントを芋おいき、テスト自䜓を曞く時に䜿うクラスに関しおはSpring Frameworkのドキュメントを
必芁に応じお芋おいく、ずいう感じになりたす。

Spring Web MVCのテストをする方法ですが、Spring BootやSpring Frameworkのテストに関するドキュメントを芋おいくず
耇数あるこずに気づきたす。

読み進め方ですが、たずはSpring Bootプロゞェクトを䜜成しおサンプルプログラムを䜜り、そこからテストのバリ゚ヌションを倉え぀぀
テストコヌドを曞いおいくこずにしたす。

順番は、以䞋にしたす。

䞋に行くに埓っお時間がかかるようになりたすが、より本物の環境に近づいおいきたす。ずいうか、最埌のパタヌンはテスト䞭に
組み蟌みTomcatを起動するこずになりたす。

このあたりを、適宜ドキュメントの内容を絡めながら曞いおいきたいず思いたす。HtmlUnitやSeleniumを䜿ったテストは扱いたせん。

ちなみに、Spring Frameworkのテストのセクションには、HtmlUnitやWebDriver、GebずMockMvcを合わせお䜿う方法に぀いお曞かれたり
しおいたす。興味があれば、こちらをどうぞ。

Testing / Integration / MockMvc / Testing HtmlUnit Integration

では、進めおいきたす。

環境

今回の環境は、こちら。

$ java --version
openjdk 17.0.2 2022-01-18
OpenJDK Runtime Environment (build 17.0.2+8-Ubuntu-120.04)
OpenJDK 64-Bit Server VM (build 17.0.2+8-Ubuntu-120.04, mixed mode, sharing)


$ mvn --version
Apache Maven 3.8.5 (3599d3414f046de2324203b78ddcf9b5e4388aa0)
Maven home: $HOME/.sdkman/candidates/maven/current
Java version: 17.0.2, vendor: Private Build, runtime: /usr/lib/jvm/java-17-openjdk-amd64
Default locale: ja_JP, platform encoding: UTF-8
OS name: "linux", version: "5.4.0-107-generic", arch: "amd64", family: "unix"

準備

たずはSpring Bootプロゞェクトを䜜成したす。

$ curl -s https://start.spring.io/starter.tgz \
  -d bootVersion=2.6.6 \
  -d javaVersion=17 \
  -d name=webmvc-testing \
  -d groupId=org.littlewings \
  -d artifactId=webmvc-testing \
  -d version=0.0.1-SNAPSHOT \
  -d packageName=org.littlewings \
  -d dependencies=web,webflux \
  -d baseDir=webmvc-testing | tar zxvf -

䟝存関係にweb以倖にwebfluxが入っおいたすが、この理由は埌で曞きたす。

プロゞェクト内ぞ移動。

$ cd webmvc-testing

ディレクトリ構成。

$ tree
.
├── HELP.md
├── mvnw
├── mvnw.cmd
├── pom.xml
└── src
    ├── main
    │   ├── java
    │   │   └── org
    │   │       └── littlewings
    │   │           └── WebmvcTestingApplication.java
    │   └── resources
    │       ├── application.properties
    │       ├── static
    │       └── templates
    └── test
        └── java
            └── org
                └── littlewings
                    └── WebmvcTestingApplicationTests.java

12 directories, 7 files

Mavenでの䟝存関係およびプラグむン蚭定。

        <dependencies>
                <dependency>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-starter-web</artifactId>
                </dependency>
                <dependency>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-starter-webflux</artifactId>
                </dependency>

                <dependency>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-starter-test</artifactId>
                        <scope>test</scope>
                </dependency>
                <dependency>
                        <groupId>io.projectreactor</groupId>
                        <artifactId>reactor-test</artifactId>
                        <scope>test</scope>
                </dependency>
        </dependencies>

        <build>
                <plugins>
                        <plugin>
                                <groupId>org.springframework.boot</groupId>
                                <artifactId>spring-boot-maven-plugin</artifactId>
                        </plugin>
                </plugins>
        </build>

含たれおいる゜ヌスコヌドは、こんな感じですね。

src/main/java/org/littlewings/WebmvcTestingApplication.java

package org.littlewings;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class WebmvcTestingApplication {

        public static void main(String[] args) {
                SpringApplication.run(WebmvcTestingApplication.class, args);
        }

}

src/test/java/org/littlewings/WebmvcTestingApplicationTests.java

package org.littlewings;

import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class WebmvcTestingApplicationTests {

        @Test
        void contextLoads() {
        }

}

テストコヌドには、@SpringBootTestアノテヌションが付䞎されおいたす。

このあたりは、いったん削陀したす。

$ rm src/main/java/org/littlewings/WebmvcTestingApplication.java src/test/java/org/littlewings/WebmvcTestingApplicationTests.java

@SpringBootTestアノテヌションに぀いお

@SpringBootTestアノテヌションに぀いおの説明を少し芋おみたす。

@SpringBootTestアノテヌションは、Spring Bootの機胜が必芁な堎合に@ContextConfigurationアノテヌションの代わりに䜿甚したす。

Spring Boot provides a @SpringBootTest annotation, which can be used as an alternative to the standard spring-test @ContextConfiguration annotation when you need Spring Boot features. The annotation works by creating the ApplicationContext used in your tests through SpringApplication. In addition to @SpringBootTest a number of other annotations are also provided for testing more specific slices of an application.

Core Features / Testing / Testing Spring Boot Applications

SpringApplicationを䜿い、ApplicationContextの䜜成を行いたす。たた、テストでの機胜が䞍足する堎合、Auto Configurationを行うための
機胜も提䟛しおいたすスラむスず読んでいたす。

Core Features / Testing / Testing Spring Boot Applications / https://docs.spring.io/spring-boot/docs/2.6.6/reference/html/features.html#features.testing.spring-boot-applications.autoconfigured-tests

そしお、Web環境の方に目を向けおみるず、@SpringBootTestアノテヌションはサヌバヌを開始しないず曞いおいたす。
ですが、webEnvironment属性を䜿っおテストの実行方法を決められるようです。

By default, @SpringBootTest will not start a server. You can use the webEnvironment attribute of @SpringBootTest to further refine how your tests run:

Core Features / Testing / Testing Spring Boot Applications

@SpringBootTestアノテヌションのwebEnvironment属性には、以䞋の4皮類が指定できたす。

  • MOCK
    • デフォルトの挙動で、Web甚のApplicationContextをロヌドしお、モックWeb環境を提䟛する
    • 組み蟌みサヌバヌは起動しない
    • @AutoConfigureMockMvcアノテヌションたたは@AutoConfigureWebTestClientアノテヌションず組み合わせるこずで、Webアプリケヌションのモックベヌスのテストが可胜になる
  • RANDOM_PORT
    • WebServerApplicationContextをロヌドしお、本物のWeb環境を提䟛する
    • 組み蟌みサヌバヌが起動し、ランダムなポヌトでリッスンする
  • DEFINED_PORT
    • WebServerApplicationContextをロヌドしお、本物のWeb環境を提䟛する
    • 組み蟌みサヌバヌが起動し、application.propertiesで定矩されたポヌトたたはデフォルトの8080ポヌトでリッスンする
  • NONE
    • SpringApplicationによっおApplicationContextはロヌドするものの、モックやそれ以倖のいずれのWeb環境も提䟛しない

テストをモックWeb環境で行うか、組み蟌みサヌバヌで行うか、ずいう感じになりたすたったくWeb環境を䜿わないずいう遞択肢もありたすが。

Spring Web MVCが䜿甚可胜な堎合は、Spring Web MVCベヌスのApplicationContextが構成されるようです。

If Spring MVC is available, a regular MVC-based application context is configured.

Core Features / Testing / Testing Spring Boot Applications / Detecting Web Application Type

サンプルアプリケヌションを䜜成する

テスト察象のサンプルアプリケヌションを䜜成したしょう。お題は、ちょっずしたechoプログラムにしたす。

mainクラス。

src/main/java/org/littlewings/spring/webmvc/App.java

package org.littlewings.spring.webmvc;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class App {
    public static void main(String... args) {
        SpringApplication.run(App.class, args);
    }
}

RestController。GETずPOST甚のメ゜ッドを甚意しお、POSTの堎合はJSONでリク゚ストを受け取るようにしたす。

src/main/java/org/littlewings/spring/webmvc/EchoController.java

package org.littlewings.spring.webmvc;

import java.util.Optional;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("echo")
public class EchoController {
    MessageDecorationService messageDecorationService;

    public EchoController(MessageDecorationService messageDecorationService) {
        this.messageDecorationService = messageDecorationService;
    }

    @GetMapping("get")
    public EchoResponse get(@RequestParam String message) {
        Thread.dumpStack();

        return EchoResponse
                .create(
                        messageDecorationService
                                .decorate(Optional.ofNullable(message).orElse("Hello World[get]!!")),
                        Thread.currentThread().getName()
                );
    }

    @PostMapping("post")
    public EchoResponse post(@RequestBody EchoRequest echoRequest) {
        Thread.dumpStack();

        return EchoResponse
                .create(
                        messageDecorationService
                                .decorate(Optional.ofNullable(echoRequest.getMessage()).orElse("Hello World[post]!!")),
                        Thread.currentThread().getName()
                );
    }
}

レスポンスには受け取ったメッセヌゞをServiceで加工しお返し、この時に動䜜しおいるスレッド名を返すようにしたす。
それから、RestControllerのメ゜ッド呌び出し時にはスタックトレヌスを出力するようにしおいたす。

リク゚スト甚のクラス。

src/main/java/org/littlewings/spring/webmvc/EchoRequest.java

package org.littlewings.spring.webmvc;

public class EchoRequest {
    String message;

    public static EchoRequest create(String message) {
        EchoRequest echoRequest = new EchoRequest();
        echoRequest.setMessage(message);

        return echoRequest;
    }

    // gettersetterは省略
}

レスポンス甚のクラス。

src/main/java/org/littlewings/spring/webmvc/EchoResponse.java

package org.littlewings.spring.webmvc;

public class EchoResponse {
    String message;
    String threadName;

    public static EchoResponse create(String message, String threadName) {
        EchoResponse echoResponse = new EchoResponse();
        echoResponse.setMessage(message);
        echoResponse.setThreadName(threadName);

        return echoResponse;
    }

    // gettersetterは省略
}

RestControllerが䜿うServiceクラス。

src/main/java/org/littlewings/spring/webmvc/MessageDecorationService.java

package org.littlewings.spring.webmvc;

import org.springframework.stereotype.Service;

@Service
public class MessageDecorationService {
    public String decorate(String message) {
        return String.format("★★★ %s !!★★★", message);
    }
}

動䜜確認。

$ mvn spring-boot:run

OKですね。

$ curl localhost:8080/echo/get?message=Hello
{"message":"★★★ Hello !!★★★","threadName":"http-nio-8080-exec-1"}


$ curl -H 'Content-Type: application/json' localhost:8080/echo/post -d '{"message": "Hello"}'
{"message":"★★★ Hello !!★★★","threadName":"http-nio-8080-exec-2"}

では、こちらに察しおテストを曞いおいきたしょう。なお、䟝存関係にspring-boot-starter-webfluxが含たれおいたしたが、特に明瀺的に
説明しない限りはspring-boot-starter-webずspring-boot-starter-testが䟝存関係に含たれおいればテストは動䜜したす。

spring-boot-starter-webfluxに぀いおは、必芁な郚分で説明したす。

デフォルトの@SpringBootTestで組み蟌みサヌバヌが起動しないこずを確認する

実際のテストに行く前に、@SpringBootTestアノテヌションだけでは組み蟌みサヌバヌが起動しないこずを確認しおおきたす。

こんなテストで確認。

src/test/java/org/littlewings/spring/webmvc/SpringBootTestDefaultTest.java

package org.littlewings.spring.webmvc;

import java.io.IOException;
import java.net.ConnectException;
import java.net.HttpURLConnection;
import java.net.URI;

import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

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

@SpringBootTest
public class SpringBootTestDefaultTest {
    @Test
    public void test() throws IOException {
        HttpURLConnection conn = (HttpURLConnection) URI.create("http://localhost:8080").toURL().openConnection();
        assertThatThrownBy(() -> conn.connect())
                .isInstanceOf(ConnectException.class)
                .hasMessage("接続を拒吊されたした");
    }
}

ドキュメントどおりサヌバヌが起動しおいないので、接続が拒吊されたす。

では、先に進めおいきたしょう。

@WebMvcTestを䜿っおテストを曞く

ドキュメントの順番ずはだいぶ異なりたすが、最初に@WebMvcTestアノテヌションを䜿ったテストを曞くこずにしたす。

Core Features / Testing / Testing Spring Boot Applications / Auto-configured Spring MVC Tests

こちらは、Spring Web MVCを䜿っお実装した、特定のControllerが動䜜するかをテストしたす。

@WebMvcTestアノテヌションを䜿甚するず、Spring Web MVCを構成するずずもに限られたBeanをスキャンしたす。

  • @Controller
  • @ControllerAdvice
  • @JsonComponent
  • Converter
  • GenericConverter
  • Filter
  • HandlerInterceptor
  • WebMvcConfigurer
  • WebMvcRegistrations
  • HandlerMethodArgumentResolver

通垞の@Componentや@ConfigurationPropertiesずいったBeanは、@WebMvcTestアノテヌションを䜿甚しおもスキャンされたせん。
䜿甚したい堎合は、@EnableConfigurationPropertiesアノテヌションを付䞎するこずになりたす。

なお、@WebMvcTestアノテヌションを䜿甚した時に有効になるAuto Configurationは、以䞋にたずめられおいたす。

Test Auto-configuration Annotations

@WebMvcTestアノテヌションを䜿甚しお䜜成したテストは、こちら。

src/test/java/org/littlewings/spring/webmvc/WebMvcTestTest.java

package org.littlewings.spring.webmvc;

import com.fasterxml.jackson.databind.ObjectMapper;
import org.hamcrest.Matchers;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.MockMvc;

import static org.mockito.BDDMockito.given;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;

@WebMvcTest(EchoController.class)
public class WebMvcTestTest {
    @Autowired
    MockMvc mvc;

    @MockBean
    MessageDecorationService messageDecorationService;

    @Autowired
    ObjectMapper objectMapper;

    @Test
    public void getTest() throws Exception {
        given(messageDecorationService.decorate("WebMvcTest[get]"))
                .willReturn("*** WebMvcTest[get] !!***");

        // queryParam
        mvc
                .perform(
                        get("/echo/get")
                                .queryParam("message", "WebMvcTest[get]")

                )
                .andExpect(status().isOk())
                .andExpect(
                        content()
                                .json(
                                        objectMapper.writeValueAsString(
                                                EchoResponse.create("*** WebMvcTest[get] !!***", "main")
                                        )
                                )
                );

        // querystring
        mvc
                .perform(
                        get("/echo/get?message=WebMvcTest[get]")

                )
                .andExpect(status().isOk())
                .andExpect(jsonPath("message", Matchers.is("*** WebMvcTest[get] !!***")))
                .andExpect(jsonPath("threadName", Matchers.is("main")));
    }

    @Test
    public void postTest() throws Exception {
        given(messageDecorationService.decorate("WebMvcTest[post]"))
                .willReturn("*** WebMvcTest[post] !!***");

        mvc
                .perform(
                        post("/echo/post")
                                .contentType(MediaType.APPLICATION_JSON)
                                .content(
                                        objectMapper.writeValueAsString(
                                                EchoRequest.create("WebMvcTest[post]")
                                        )
                                )

                )
                .andExpect(status().isOk())
                .andExpect(header().string("content-type", MediaType.APPLICATION_JSON_VALUE))
                .andExpect(jsonPath("message", Matchers.is("*** WebMvcTest[post] !!***")))
                .andExpect(jsonPath("threadName", Matchers.is("main")));
    }
}

テストクラスに@WebMvcTestアノテヌションを付䞎したす。

@WebMvcTest(EchoController.class)
public class WebMvcTestTest {

ドキュメントに習っおControllerを@WebMvcTestアノテヌションに指定しおいたすが、実は指定しなくおも動きたす。
スキャン察象に@Controllerが入っおいるからですね。

Controllerが䟝存するBeanは、モックにしたす。

    @MockBean
    MessageDecorationService messageDecorationService;

ずいうか、最初に曞いたようにスキャンされるBeanが限定されおいるので、今回のように別のBeanに䟝存しおいるControllerはモックで
䟝存関係をなんずかするなりBeanを登録するなりしないず動䜜したせん。

もし今回の゜ヌスコヌドからモックに関するコヌドを削陀するず、䜜成したRestControllerの䟝存関係が解決できずにテストに倱敗したす。

Caused by: org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'echoController' defined in file [/path/to/webmvc-testing/target/classes/org/littlewings/spring/webmvc/EchoController.class]: Unsatisfied dependency expressed through constructor parameter 0; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'org.littlewings.spring.webmvc.MessageDecorationService' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {}
    at org.springframework.beans.factory.support.ConstructorResolver.createArgumentArray(ConstructorResolver.java:800)
    at org.springframework.beans.factory.support.ConstructorResolver.autowireConstructor(ConstructorResolver.java:229)
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.autowireConstructor(AbstractAutowireCapableBeanFactory.java:1372)
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBeanInstance(AbstractAutowireCapableBeanFactory.java:1222)
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.doCreateBean(AbstractAutowireCapableBeanFactory.java:582)
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBean(AbstractAutowireCapableBeanFactory.java:542)
    at org.springframework.beans.factory.support.AbstractBeanFactory.lambda$doGetBean$0(AbstractBeanFactory.java:335)
    at org.springframework.beans.factory.support.DefaultSingletonBeanRegistry.getSingleton(DefaultSingletonBeanRegistry.java:234)
    at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:333)
    at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:208)
    at org.springframework.beans.factory.support.DefaultListableBeanFactory.preInstantiateSingletons(DefaultListableBeanFactory.java:953)
    at org.springframework.context.support.AbstractApplicationContext.finishBeanFactoryInitialization(AbstractApplicationContext.java:918)
    at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:583)
    at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:740)
    at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:415)
    at org.springframework.boot.SpringApplication.run(SpringApplication.java:303)
    at org.springframework.boot.test.context.SpringBootContextLoader.loadContext(SpringBootContextLoader.java:136)
    at org.springframework.test.context.cache.DefaultCacheAwareContextLoaderDelegate.loadContextInternal(DefaultCacheAwareContextLoaderDelegate.java:99)
    at org.springframework.test.context.cache.DefaultCacheAwareContextLoaderDelegate.loadContext(DefaultCacheAwareContextLoaderDelegate.java:124)
    ... 72 more
Caused by: org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'org.littlewings.spring.webmvc.MessageDecorationService' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {}
    at org.springframework.beans.factory.support.DefaultListableBeanFactory.raiseNoMatchingBeanFound(DefaultListableBeanFactory.java:1799)
    at org.springframework.beans.factory.support.DefaultListableBeanFactory.doResolveDependency(DefaultListableBeanFactory.java:1355)
    at org.springframework.beans.factory.support.DefaultListableBeanFactory.resolveDependency(DefaultListableBeanFactory.java:1309)
    at org.springframework.beans.factory.support.ConstructorResolver.resolveAutowiredArgument(ConstructorResolver.java:887)
    at org.springframework.beans.factory.support.ConstructorResolver.createArgumentArray(ConstructorResolver.java:791)
    ... 90 more

テストにはMockMvcを䜿甚したす。

    @Autowired
    MockMvc mvc;

MockMvc自䜓に぀いおは、こちらを参照。

Testing / Integration Testing / MockMvc

今回は、最初に䟝存するServiceのモックを蚭定しお、それからMockMvcを䜿っおテストしおいたす。

    @Test
    public void getTest() throws Exception {
        given(messageDecorationService.decorate("WebMvcTest[get]"))
                .willReturn("*** WebMvcTest[get] !!***");

        // queryParam
        mvc
                .perform(
                        get("/echo/get")
                                .queryParam("message", "WebMvcTest[get]")

                )
                .andExpect(status().isOk())
                .andExpect(
                        content()
                                .json(
                                        objectMapper.writeValueAsString(
                                                EchoResponse.create("*** WebMvcTest[get] !!***", "main")
                                        )
                                )
                );

        // querystring
        mvc
                .perform(
                        get("/echo/get?message=WebMvcTest[get]")

                )
                .andExpect(status().isOk())
                .andExpect(jsonPath("message", Matchers.is("*** WebMvcTest[get] !!***")))
                .andExpect(jsonPath("threadName", Matchers.is("main")));
    }

今回は、なんずなくQueryStringをqueryParamで蚭定したり、盎接URLに付けたりしおみたした。たた、JSONレスポンスのアサヌション方法も
分けおいたす。

アサヌション結果を芋るずわかるのですが、今回のテストではRestControllerはmainスレッドで動䜜しおいたすね。

                .andExpect(jsonPath("message", Matchers.is("*** WebMvcTest[get] !!***")))
                .andExpect(jsonPath("threadName", Matchers.is("main")));

RestControllerのメ゜ッド呌び出し時のスタックトレヌスはこちら。

java.lang.Exception: Stack trace
        at java.base/java.lang.Thread.dumpStack(Thread.java:1380)
        at org.littlewings.spring.webmvc.EchoController.get(EchoController.java:23)
        at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
        at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
        at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
        at java.base/java.lang.reflect.Method.invoke(Method.java:568)
        at org.springframework.web.method.support.InvocableHandlerMethod.doInvoke(InvocableHandlerMethod.java:205)
        at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:150)
        at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:117)
        at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:895)
        at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:808)
        at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87)
        at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1067)
        at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:963)
        at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1006)
        at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:898)
        at javax.servlet.http.HttpServlet.service(HttpServlet.java:655)
        at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:883)
        at org.springframework.test.web.servlet.TestDispatcherServlet.service(TestDispatcherServlet.java:72)
        at javax.servlet.http.HttpServlet.service(HttpServlet.java:764)
        at org.springframework.mock.web.MockFilterChain$ServletFilterProxy.doFilter(MockFilterChain.java:167)
        at org.springframework.mock.web.MockFilterChain.doFilter(MockFilterChain.java:134)
        at org.springframework.web.filter.RequestContextFilter.doFilterInternal(RequestContextFilter.java:100)
        at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)
        at org.springframework.mock.web.MockFilterChain.doFilter(MockFilterChain.java:134)
        at org.springframework.web.filter.FormContentFilter.doFilterInternal(FormContentFilter.java:93)
        at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)
        at org.springframework.mock.web.MockFilterChain.doFilter(MockFilterChain.java:134)
        at org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:201)
        at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)
        at org.springframework.mock.web.MockFilterChain.doFilter(MockFilterChain.java:134)
        at org.springframework.test.web.servlet.MockMvc.perform(MockMvc.java:199)
        at org.littlewings.spring.webmvc.WebMvcTestTest.getTest(WebMvcTestTest.java:35)
        
        〜省略〜

この少し埌に曞くモック環境でのテストに぀いお曞いた内容を芋るずわかりたすが、@WebMvcTestアノテヌションを䜿った時もモック環境で
動䜜しおいるこずになりたす。

MockMvcに぀いお

MockMvcに぀いお、もう少し深堀しおみたしょう。

MockMvcにはスタンドアロンモヌドずSpringのConfigurationを䜿ったモヌドの2぀のセットアップ方法がありたす。

Testing / Integration Testing / MockMvc / Setup Choices

Spring Bootでは、SpringのConfigurationを䜿ったモヌドでセットアップするようです。

https://github.com/spring-projects/spring-boot/blob/v2.6.6/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/web/servlet/MockMvcAutoConfiguration.java#L78-L87

https://github.com/spring-projects/spring-boot/blob/v2.6.6/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/web/servlet/MockMvcAutoConfiguration.java#L95-L99

MockMvcのセットアップ自䜓は完了しおいるので、あずはリク゚ストを蚭定したり、レスポンスをアサヌションしたりずいった感じの
䜿い方になりたす。

Testing / Integration Testing / MockMvc / Performing Requests

Testing / Integration Testing / MockMvc / Defining Expectations

今回は通垞のControllerで䜿いたくなるようなフォワヌド先やモデルのアサヌションは行いたせんが、サンプルがあるのでこちらを
参考にするずよいでしょう。

https://github.com/spring-projects/spring-framework/tree/v5.3.18/spring-test/src/test/java/org/springframework/test/web/servlet/samples

Servlet Filterを登録する機胜もありそうですが

Testing / Integration Testing / MockMvc / Filter Registrations

こちらは、@WebMvcTestアノテヌションの属性で衚珟するこずになりそうです。

WebMvcTest (Spring Boot 2.6.6 API)

ドキュメントを芋るず、@AutoConfigureMockMvcアノテヌションを䜿うずよい、ずは曞かれおいたすが。

Core Features / Testing / Testing Spring Boot Applications / Auto-configured Spring MVC Tests

たた、MockMvcずE2Eテストの比范に぀いおもドキュメントに曞かれおいたす。

Testing / Integration Testing / MockMvc / MockMvc vs End-to-End Tests

MockMvcはServletのモック実装に基づいお構築されおいお、実際のサヌブレットコンテナず比べるず異なる郚分もありたす。

jsessoinid Cookieがない、フォワヌドやリダむレクト、サヌブレットの䟋倖ハンドリングは行われず、Spring Bootではあたり関係ないですが
JSPのレンダリングも行われたせん。
※Theymeleafなどのテンプレヌト゚ンゞンでのレンダリングや、JSON、XMLなどでのレスポンスは行えるようです

MockMvcを䜿甚したテストではControllerに䟝存するBeanをモック化したりしお、Webレむダヌに限定したテストがしやすくなるずころが
ポむントです。SpringずしおはMockMvcの利甚もむンテグレヌションテストに䜍眮づけおいたすが、単䜓テストに近いものではありたす。

このため、E2Eテストのようなブラックボックス的なテストず異なり、MockMvcではHandlerControllerが䜿われたこず、䟋倖凊理で
HandlerExceptionResolverが䜿われたこず、モデルの属性やバむンディング゚ラヌなどを確認できたす。

このような特性を螏たえ぀぀、どのテストを䜿うかを決めおいくこずになるんでしょうね。

モック環境でテストする

次は、モック環境でのテストを行いたす。

Core Features / Testing / Testing Spring Boot Applications / Testing with a mock environment

具䜓的には、@SpringBootTestアノテヌションず@AutoConfigureMockMvcアノテヌションの組み合わせになりたす。

䜜成したテストコヌドはこちら。

src/test/java/org/littlewings/spring/webmvc/AutoConfigureMockMvcTest.java

package org.littlewings.spring.webmvc;

import com.fasterxml.jackson.databind.ObjectMapper;
import org.hamcrest.Matchers;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.MockMvc;

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;

@SpringBootTest
@AutoConfigureMockMvc
public class AutoConfigureMockMvcTest {
    @Test
    public void getTest(@Autowired MockMvc mvc) throws Exception {
        mvc
                .perform(
                        get("/echo/get")
                                .queryParam("message", "MockMvc[get]")

                )
                .andExpect(status().isOk())
                .andExpect(jsonPath("message", Matchers.is("★★★ MockMvc[get] !!★★★")))
                .andExpect(jsonPath("threadName", Matchers.is("main")));
    }

    @Test
    public void postTest(@Autowired MockMvc mvc, @Autowired ObjectMapper objectMapper) throws Exception {
        mvc
                .perform(
                        post("/echo/post")
                                .contentType(MediaType.APPLICATION_JSON)
                                .content(
                                        objectMapper.writeValueAsString(
                                                EchoRequest.create("MockMvc[post]")
                                        )
                                )

                )
                .andExpect(status().isOk())
                .andExpect(header().string("content-type", MediaType.APPLICATION_JSON_VALUE))
                .andExpect(jsonPath("message", Matchers.is("★★★ MockMvc[post] !!★★★")))
                .andExpect(jsonPath("threadName", Matchers.is("main")));
    }
}

@WebMvcTestアノテヌションを䜿った時ず同じようにMockMvcを䜿ったテストになりたすが、先ほどずの違いはRestControllerが
䟝存するBeanをモック化しおいないこずですね。

たたテストクラスに付䞎するアノテヌションで、明瀺的なControllerの指定もなくなりたした。

@SpringBootTest
@AutoConfigureMockMvc
public class AutoConfigureMockMvcTest {

RestControllerのメ゜ッド呌び出し時のスタックトレヌスは、こちら。

java.lang.Exception: Stack trace
    at java.base/java.lang.Thread.dumpStack(Thread.java:1380)
    at org.littlewings.spring.webmvc.EchoController.get(EchoController.java:23)
    at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
    at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
    at java.base/java.lang.reflect.Method.invoke(Method.java:568)
    at org.springframework.web.method.support.InvocableHandlerMethod.doInvoke(InvocableHandlerMethod.java:205)
    at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:150)
    at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:117)
    at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:895)
    at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:808)
    at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87)
    at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1067)
    at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:963)
    at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1006)
    at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:898)
    at javax.servlet.http.HttpServlet.service(HttpServlet.java:655)
    at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:883)
    at org.springframework.test.web.servlet.TestDispatcherServlet.service(TestDispatcherServlet.java:72)
    at javax.servlet.http.HttpServlet.service(HttpServlet.java:764)
    at org.springframework.mock.web.MockFilterChain$ServletFilterProxy.doFilter(MockFilterChain.java:167)
    at org.springframework.mock.web.MockFilterChain.doFilter(MockFilterChain.java:134)
    at org.springframework.web.filter.RequestContextFilter.doFilterInternal(RequestContextFilter.java:100)
    at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)
    at org.springframework.mock.web.MockFilterChain.doFilter(MockFilterChain.java:134)
    at org.springframework.web.filter.FormContentFilter.doFilterInternal(FormContentFilter.java:93)
    at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)
    at org.springframework.mock.web.MockFilterChain.doFilter(MockFilterChain.java:134)
    at org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:201)
    at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)
    at org.springframework.mock.web.MockFilterChain.doFilter(MockFilterChain.java:134)
    at org.springframework.test.web.servlet.MockMvc.perform(MockMvc.java:199)
    at org.littlewings.spring.webmvc.AutoConfigureMockMvcTest.getTest(AutoConfigureMockMvcTest.java:22)

    〜省略〜

よく芋るず、@WebMvcTestアノテヌションを䜿った時のスタックトレヌスずたったく同じです。

そしお、スレッド名もmainであるこずが確認できたす。

                .andExpect(jsonPath("message", Matchers.is("★★★ MockMvc[post] !!★★★")))
                .andExpect(jsonPath("threadName", Matchers.is("main")));

ずいうこずは、この2぀のテスト方法では、同じモック環境で動䜜しおいるこずになりたすね。違いはBeanのスキャン範囲ずいったずころ
でしょうか@SpringBootTestアノテヌションを䜿っおいる差かず。

ちなみに、このテストの䞭に@MockBeanアノテヌションを䜿ったコヌドを远加するこずで、䟝存するBeanをモック化するこずは
ふ぀うにできたす。

    @MockBean
    MessageDecorationService messageDecorationService;

組み蟌みサヌバヌを起動しおテストする

最埌は、組み蟌みサヌバヌを起動しおテストを行いたす。

Core Features / Testing / Testing Spring Boot Applications / Testing with a running server

こちらは、@SpringBootTestアノテヌションのwebEnvironment属性にRANDOM_PORTたたはDEFINED_PORTを指定するこずで
実珟できたす。今回は、RANDOM_PORTを䜿甚したす。

䜜成したテストはこちら。

src/test/java/org/littlewings/spring/webmvc/SpringBootTestWebEnvironmentTest.java

package org.littlewings.spring.webmvc;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.test.web.reactive.server.WebTestClient;

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

@SpringBootTest(
        webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT,
        properties = "server.tomcat.threads.max=1"
)
public class SpringBootTestWebEnvironmentTest {
    @Test
    public void getTest(@Autowired WebTestClient webClient) {
        webClient
                .get()
                .uri(uriBuilder -> uriBuilder
                        .path("/echo/get")
                        .queryParam("message", "WebEnvironment Test[get]")
                        .build()
                )
                .exchange()
                .expectStatus().isOk()
                .expectBody(EchoResponse.class)
                .consumeWith(result -> {
                    EchoResponse response = result.getResponseBody();
                    assertThat(response.getMessage()).isEqualTo("★★★ WebEnvironment Test[get] !!★★★");
                    assertThat(response.getThreadName()).isEqualTo("http-nio-auto-1-exec-1");
                });
    }

    @Test
    public void postTest(@Autowired WebTestClient webClient) {
        webClient
                .post()
                .uri("/echo/post")
                .contentType(MediaType.APPLICATION_JSON)
                .bodyValue(EchoRequest.create("WebEnvironment Test[post]"))
                .exchange()
                .expectStatus().isOk()
                .expectBody(EchoResponse.class)
                .consumeWith(result -> {
                    EchoResponse response = result.getResponseBody();
                    assertThat(response.getMessage()).isEqualTo("★★★ WebEnvironment Test[post] !!★★★");
                    assertThat(response.getThreadName()).isEqualTo("http-nio-auto-1-exec-1");
                });
    }
}

@SpringBootTestアノテヌションのwebEnvironment属性はRANDOM_PORTずし、たたRestControllerがスレッド名を返すので
固定になるように組み蟌みTomcatのスレッドプヌルは1にしたした。

@SpringBootTest(
        webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT,
        properties = "server.tomcat.threads.max=1"
)
public class SpringBootTestWebEnvironmentTest {

テストには、WebTestClientを䜿うようです。

    @Test
    public void getTest(@Autowired WebTestClient webClient) {
        webClient
                .get()
                .uri(uriBuilder -> uriBuilder
                        .path("/echo/get")
                        .queryParam("message", "WebEnvironment Test[get]")
                        .build()
                )
                .exchange()
                .expectStatus().isOk()
                .expectBody(EchoResponse.class)
                .consumeWith(result -> {
                    EchoResponse response = result.getResponseBody();
                    assertThat(response.getMessage()).isEqualTo("★★★ WebEnvironment Test[get] !!★★★");
                    assertThat(response.getThreadName()).isEqualTo("http-nio-auto-1-exec-1");
                });
    }

このために、䟝存関係にspring-boot-starter-webfluxを远加しおいたす。

Core Features / Testing / Testing Spring Boot Applications / Testing with a running server

Testing / Integration Testing / WebTestClient

ちなみに、WebTestClientはモック環境でも利甚できるようです。

Spring WebFluxを䟝存関係に远加したくない堎合は、TestRestTemplateを䜿っおテストしおもOKです。

RestController呌び出し時のスタックトレヌスはこちら。

java.lang.Exception: Stack trace
    at java.base/java.lang.Thread.dumpStack(Thread.java:1380)
    at org.littlewings.spring.webmvc.EchoController.get(EchoController.java:23)
    at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
    at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
    at java.base/java.lang.reflect.Method.invoke(Method.java:568)
    at org.springframework.web.method.support.InvocableHandlerMethod.doInvoke(InvocableHandlerMethod.java:205)
    at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:150)
    at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:117)
    at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:895)
    at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:808)
    at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87)
    at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1067)
    at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:963)
    at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1006)
    at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:898)
    at javax.servlet.http.HttpServlet.service(HttpServlet.java:655)
    at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:883)
    at javax.servlet.http.HttpServlet.service(HttpServlet.java:764)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:227)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
    at org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:53)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
    at org.springframework.web.filter.RequestContextFilter.doFilterInternal(RequestContextFilter.java:100)
    at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
    at org.springframework.web.filter.FormContentFilter.doFilterInternal(FormContentFilter.java:93)
    at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
    at org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:201)
    at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
    at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:197)
    at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:97)
    at org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:541)
    at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:135)
    at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:92)
    at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:78)
    at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:360)
    at org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:399)
    at org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:65)
    at org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:889)
    at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1743)
    at org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49)
    at org.apache.tomcat.util.threads.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1191)
    at org.apache.tomcat.util.threads.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:659)
    at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)
    at java.base/java.lang.Thread.run(Thread.java:833)

Tomcatのスレッドプヌル内で動䜜しおいるこずがわかりたすね。

たた、アサヌション時に確認しおいたスレッド名も、mainではなくなっおいたした。

                .consumeWith(result -> {
                    EchoResponse response = result.getResponseBody();
                    assertThat(response.getMessage()).isEqualTo("★★★ WebEnvironment Test[get] !!★★★");
                    assertThat(response.getThreadName()).isEqualTo("http-nio-auto-1-exec-1");
                });

Beanのモック化も行わなず、Spring Web MVCアプリケヌションずしお完党な圢で動䜜したす。E2Eテストずいった甚途のむメヌゞで
䜿うこずになるんでしょうね。

これでひずずおりSpring Web MVCのテスト方法の確認はできた感じでしょうか。

オマケモックを䜿ったBeanのテスト

ここたでSpring Web MVCのテストを芋おきたしたが、ふ぀うのBeanのテストのパタヌンを完党に飛ばしおいたす。

軜くやっおおきたしょう。単䜓テストな感じであればむンスタンスをnewしおも良いず思うのですが、今回はモックを䜿っおみたす。

Core Features / Testing / Testing Spring Boot Applications / Mocking and Spying Beans

たずは、Serviceをもうひず぀远加したしょう。

src/main/java/org/littlewings/spring/webmvc/WordsJoinService.java

package org.littlewings.spring.webmvc;

import java.util.Arrays;
import java.util.stream.Collectors;

import org.springframework.stereotype.Service;

@Service
public class WordsJoinService {
    MessageDecorationService messageDecorationService;

    public WordsJoinService(MessageDecorationService messageDecorationService) {
        this.messageDecorationService = messageDecorationService;
    }

    public String join(String... words) {
        return messageDecorationService.decorate(Arrays.stream(words).collect(Collectors.joining(" ")));
    }
}

このServiceでは、最初に䜜成したServiceを䜿っおいたす。

テストはこちら。

src/test/java/org/littlewings/spring/webmvc/MockingBeansTest.java

package org.littlewings.spring.webmvc;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.mock.mockito.MockBean;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.mockito.BDDMockito.given;

@SpringBootTest
public class MockingBeansTest {
    @Autowired
    WordsJoinService wordsJoinService;

    @MockBean
    MessageDecorationService messageDecorationService;

    @Test
    public void serviceTest() {
        given(messageDecorationService.decorate("Hello World"))
                .willReturn("*** Hello World !!***");

        assertThat(wordsJoinService.join("Hello", "World"), is("*** Hello World !!***"));
    }
}

テストクラスは@SpringBootTestアノテヌションを䜿っお䜜成しお、テスト察象のBeanを@Autowiredし぀぀、䟝存するBeanは
@MockBeanアノテヌションでモック化すればOKです。

たずめ

Spring Web MVCで䜜成したアプリケヌションのテスト方法を芋おみたした。

あたり理解できおいなかったので、時間を取っお今回敎理しおみお良かったかなぁず思いたす。