SpringBootでマッパークラスに対するテストが失敗する

Question

前提・実現したいこと

SpringBootで、Mybatisを利用したマッパーのテストクラスを作成してテストしている
テストして実際に値が取れることを確認したい
※DBはインメモリのH2

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

テスト実行しても、AutowiredしたマッパーがNULLでテストに失敗する1
※SpringBootを起動して、実行する分には、AutowiredしたMapperにアクセスできる

JUNIT起動時に以下のメッセージがでて失敗する。

java.lang.NullPointerException
	at com.example.demo.SampleRepositoryTest2.contextLoads(SampleRepositoryTest2.java:26)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at 

該当のソースコード

テストクラス

package com.example.demo;

import java.util.Optional;

import org.junit.Test;
import org.junit.jupiter.api.Assertions;
import org.junit.runner.RunWith;
import org.mybatis.spring.boot.test.autoconfigure.MybatisTest;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.annotation.Import;
import org.springframework.test.context.junit4.SpringRunner;

import com.example.demo.repository.SampleRepository;
import com.example.demo.repository.entity.Todo;

@SpringBootTest(classes = SampleRepositoryTest2.class)
@MybatisTest
public class SampleRepositoryTest2 {

	@Autowired
	private SampleRepository repo;
	
	@Test
	public void contextLoads() throws Exception {
		Optional<Todo> todo = repo.findById(1);
		Assertions.assertEquals(todo.get().getTodoTitle(), "夜ごはんつくる");

	}
}

リポジトリ

package com.example.demo.repository;

import java.util.List;
import java.util.Optional;

import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;
import org.springframework.stereotype.Repository;

import com.example.demo.repository.entity.Todo;

@Mapper
public interface SampleRepository {
	@Select("select todo_id, todo_title, finished, created_at from todo where todo_id = #{id}")
	Optional<Todo> findById(Integer id);
	
	@Select("select todo_id, todo_title, finished, created_at from todo ")
	List<Todo> findAll();
	
	@Select("SELECT COUNT(*) FROM todo WHERE finished = #{finished}")
	long countByFinished(boolean finished);

	@Insert("insert into todo ( todo_id, todo_title, finished, created_at ) values (#{todoId},#{todoTitle}, #{finished}, #{created_at})")
	void insert(Todo todo);
}

\src\main\resources\data.sql

INSERT INTO todo ( todo_id, todo_title, finished, created_at ) VALUES ( 1, '朝ごはんつくる', false, '2020-12-01 09:15:00' );
INSERT INTO todo ( todo_id, todo_title, finished, created_at ) VALUES ( 2, '夜ごはんつくる', false, '2020-12-01 09:15:00' );

\src\main\resources\schema.sql

create table if not exists todo (
    todo_id int,
    todo_title varchar(30),
    finished boolean,
    created_at timestamp
);

build.gradle

plugins {
	id 'org.springframework.boot' version '2.3.2.RELEASE'
	id 'io.spring.dependency-management' version '1.0.9.RELEASE'
	id 'java'
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'

repositories {
	mavenCentral()
}

ext {
	set('springCloudVersion', "Hoxton.SR7")
}

dependencies {

	implementation 'org.springframework.boot:spring-boot-starter-cache'
	implementation 'org.springframework.boot:spring-boot-starter-data-redis'
	
	implementation 'org.springframework.boot:spring-boot-starter-data-jdbc'
	implementation 'org.springframework.boot:spring-boot-starter-security'
	implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
	implementation 'org.springframework.boot:spring-boot-starter-web'
	implementation  'org.springframework.boot:spring-boot-starter-data-rest'
	implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter:2.1.3'
	implementation 'org.springframework.cloud:spring-cloud-starter-config'
	implementation 'org.springframework.boot:spring-boot-starter-actuator'

	developmentOnly 'org.springframework.boot:spring-boot-devtools'
	runtimeOnly 'com.h2database:h2'

//	implementation 'com.github.springtestdbunit:spring-test-dbunit:1.3.0'
//	implementation 'org.dbunit:dbunit:2.5.1'

	testImplementation 'org.springframework.boot:spring-boot-starter-test'
	testImplementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter-test:2.1.3'
	testImplementation 'org.springframework.security:spring-security-test'

	compileOnly("org.projectlombok:lombok")
}

dependencyManagement {
	imports {
		mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
	}
}

test {
	useJUnitPlatform()
}

パッケージ構成

試したこと

build.gradleで、mybatisのテストライブラリのバージョンを以下に修正した。

http://mybatis.org/spring-boot-starter/mybatis-spring-boot-test-autoconfigure/
mybatisの公式を確認すると、、SpringBoot2.1以上は、mybatisのテストライブラリのバージョンが2.1が指定されていたため

修正前

implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter-test:1.3.4'

修正後

testImplementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter-test:2.1.3'

補足情報（FW/ツールのバージョンなど）

IDE
Spring Tool Suite Version: 3.9.7.RELEASE

Answer 1

そもそもテスト起動時にDIコンテナが起動する想定だが起動していなかったので、テストクラスを新規で作りなしたら、うまく動作した。（これ自体の原因は不明）

※Mybatisのテストでは余計なアノテーションを削除して、「@MybatisTest」のみでテストできることも確認できた。

Answer 2

mybatis-spring-boot-starter-test:2.1.3 をお使いの場合は、もう少し簡略化できます。

また、@SpringBootTestに設定するクラスは「Spring用の設定クラス名」ですので、この場合不要です。

もしJUnit4系を使う場合は、@RunWith(SpringRunner.class)を記述します。
JUnit5系を使う場合は、@RunWithの記載も不要です。

http://mybatis.org/spring-boot-starter/mybatis-spring-boot-test-autoconfigure/ の 「Using @MybatisTest on JUnit 5」近辺を参照に。

@MybatisTest
public class SampleRepositoryTest2 {

    @Autowired
    SampleRepository repo;

    @Test
    public void contextLoads() throws Exception {
        Optional<Todo> todo = repo.findById(1);
        Assertions.assertEquals(todo.get().getTodoTitle(), "夜ごはんつくる");

    }
}

Comments

[khr-rock]

返信が遅れ申し訳ないです。回答ありがとうございます。

該当のリンクを確認して以下の記載があったので、@MyBatisTest以外を除いて試してみたのですが、エラーが変わりませんでした。

>Since 2.0.1, the @ExtendWith(SpringExtension.class) can omit as follow:
@MybatisTest

Autowiredを利用しているのでDIコンテナがインスタンスを作る認識ですが、テストするとSpringBootが起動するまでもなく落ちてしまっています。（SpringBootという文字がコンソールにでない）

何か設定が良くないのかなと考えています。

[A-pZ]

@SpringBootTest(classes = SampleRepositoryTest2.class) の記述も不要ではないかと思います。

[khr-rock]

回答ありがとうございます。

テストですが、新しく作り直すと上手く動きました、、ちょっと原因は分からないですが、解決しました。。。。

また@SpringBootTest(classes = SampleRepositoryTest2.class) を消して、「@MybatisTest」のみでテストできることも確認しました。助かりました。

Answer 3

Autowiredは、Spring動かさないとDIされないはずですが、

@RunWith(SpringRunner.class)

がなくても動くんですっけ？

@SpringBootTestがコンフィグレーションを自動検出する仕組み - Qiita

Comments

[khr-rock]

返信が遅れ申し訳ないです。回答ありがとうございます。
Junit5を利用していました。なので@ExtendWithに置き換わったので、@Runwithは使わない認識です。