SpringBootのテスト、Mockmvcを利用したテストでセッションスコープのオブジェクトに格納した値が取得できない

Question

前提・実現したいこと

SpringBootで、セッションスコープのオブジェクトに格納した値をテストクラスから確認している

SampleScopeBeanTest#test1メソッド(後述参照)を起動するが、想定した値でなくNULLが取得されてしまい、テスト失敗する

test1メソッドの流れ
0. テスト用コントローラをMockMvcで呼び出しセッションスコープにオブジェクトを格納する

1. 格納したオブジェクトをテストクラスから確認する

発生している問題・エラーメッセージ

テストクラスから、セッションスコープのオブジェクトに格納した値を取得してもNULLになってしまう

org.opentest4j.AssertionFailedError: expected: <value1> but was: <null>

at org.junit.jupiter.api.AssertionUtils.fail(AssertionUtils.java:55)
at org.junit.jupiter.api.AssertionUtils.failNotEqual(AssertionUtils.java:62)
at org.junit.jupiter.api.AssertEquals.assertEquals(AssertEquals.java:182)
at org.junit.jupiter.api.AssertEquals.assertEquals(AssertEquals.java:177)
at org.junit.jupiter.api.Assertions.assertEquals(Assertions.java:1124)
at com.example.demo.SampleScopeBeanTest.test1(SampleScopeBeanTest.java:33)

・・・略

該当のソースコード

セッションスコープのオブジェクト

package com.example.demo.bean;

import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;

import org.springframework.context.annotation.Scope;
import org.springframework.context.annotation.ScopedProxyMode;
import org.springframework.stereotype.Component;

@Component
@Scope(value = "session", proxyMode = ScopedProxyMode.TARGET_CLASS)
public class SampleScopeBean implements Serializable {

	private static final long serialVersionUID = 1L;

	private Map<String, Object> maps;

	public SampleScopeBean() {
		this.maps = new HashMap<String, Object>();
	}

	public Object get(String key) {
		return maps.get(key);
	}

	public Object put(String key, Object value) {
		return maps.put(key, value);
	}

	public Object remove(String key) {
		return maps.remove(key);
	}

}

テスト用のコントローラクラス

package com.example.demo.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.example.demo.bean.SampleScopeBean;

@RestController
@RequestMapping("test/session")
public class VerifyRestController {
	@Autowired
	SampleScopeBean ssb;
	String key1 = "key1";
	String value1 = "value1";
         
     // テスト対象
	@GetMapping("prepare")
	public String prepare() {
		System.out.println("prepare");
		System.out.println("ssb_bef:" + ssb.get(key1));
		ssb.put(key1, value1);
		System.out.println("ssb_aft:" + ssb.get(key1));

		return "ok";
	}

	@GetMapping("test1")
	public String test1(boolean isDelete) {
		System.out.println("test1");
		System.out.println("ssb_bef:" + ssb.get(key1));
		if (isDelete) {
			ssb.remove(key1);
		}
		System.out.println("ssb_aft:" + ssb.get(key1));

		return "ok";
	}

}

テストクラス

package com.example.demo;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

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.test.web.servlet.MockMvc;

import com.example.demo.bean.SampleScopeBean;

@AutoConfigureMockMvc
@SpringBootTest
class SampleScopeBeanTest {
	@Autowired
	MockMvc mvc;
	@Autowired
	SampleScopeBean ssb;
	String baseUrl="/test/session";
	
	/**
	 * テスト内容
	 * 以下にアクセスしてコントローラがセッションスコープに格納した値を、
	 * テストクラスにAuwiredしたセッションスコープから値を取得して確認している
	 * http://localhost:8080/test/session/prepare
	 * @throws Exception
	 */
	@Test
	void test1() throws Exception {
		this.mvc.perform(get(baseUrl+"/prepare")).andExpect(status().isOk());
		String expected = (String) ssb.get("key1");
		assertEquals("value1",	 expected);
	}

}

コメント

テスト時にTomcatなどサーバーが立ち上がるので、セッションが作成されていると考えています。
テスト時はセッションが作成されないのでしょうか？

1028 追記
以下にセッションスコープを利用した場合のテストについて記載されていました。。。
まだ読み切れていませんが、こちら確認して対応します。
https://spring.pleiades.io/spring-framework/docs/current/spring-framework-reference/testing.html

Answer 1

mockMVCを使ったテスト内で別途オブジェクトをセッション属性で宣言しても、それは別のインスタンスになってしまい、本来行いたいであろう、Controller内で利用しているSampleScopeBeanには触れません。

実現されたい内容から考えると、Controllerを動作させてセッションに格納しているSampleScopeBeanの振る舞いを検証したい、つまりテスト用のモックである必要はありません。
JUnitを使って実オブジェクトの振る舞いを検証したいのでしたら、以下のように、mockMVCを経由せずに、具体的なコントローラーのメソッドを実行してテストクラスを動かします。

また、モッククラスで実行していないのでmockMvcも不要です。

import static org.junit.jupiter.api.Assertions.*;

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

@SpringBootTest
class VerifyRestControllerTest {

        @Autowired
        VerifyRestController target;

	@Test
	void test1() throws Exception {
		target.prepare();
		String expected = (String) (target.ssb).get("key1");
		assertEquals("value1", expected);
	}

}

Comments

[khr-rock]

回答ありがとうございます。
mockMVCを経由しない具体的なコントローラを利用することでテストが通りました。

Springbootのコントローラのテストで調べた際にMockmvcを利用した例が多いので、こうした記載はできずmockを必ず使うもの！と思い込んでいました。。。
よく考えたらサービスクラスが可能だから、コントローラも可能ですね。
迅速な回答ありがとうございました。

[A-pZ]

> Springbootのコントローラのテストで調べた際にMockmvcを利用した例が多い

確かにそうですね～。MockMVCはController→Viewの遷移設定を試験できるものなので、これに注力した試験だけを行いたいときに有用です。

[khr-rock]

＞MockMVCはController→Viewの遷移設定を試験できるもの

なるほど、やりたいテストに応じて書き分けられるよう精進します、、