概要
SpringBootのテストスライスアノテーションについて、どのような実装になっているのか探ってみた。
テストスライスアノテーションとは？
まず、ここでのテストスライスアノテーションは、アプリケーションの全量ではなく一部だけをテストしたい、といった場合に利用するアノテーションのことを指す。(このページにSpringBoot公式で提供されている全量が記載されている)
テストスライスアノテーションを利用する動機としては、ユニットテスト実行時間は最小限に抑えつつ、意味のあるユニットテストをしたい、という希望を叶えることにある。
SpringBootで作成するWebアプリケーションであれば、リクエスト・レスポンスのバリデーションや変換を受け持つController層、ビジネスロジックを持つService層、DB等へのアクセスを受け持つRepository層に分けて作成を行う。
この前提のもと、例としてController層のテストを考える。@SpringBootTestで全てのユニットテストを書けば、本番稼働の状況と限りなく近づくが、テスト実行時間は増える。一方、Controller層で依存しているものを全てモックに差し替えてテストを行った場合、テスト実行時間は短いが、本番稼働の状況からは遠のく。
@WebMvcTestを利用すれば、リクエストのバリデーションやJsonデシリアライズ、レスポンスのJsonシリアライズやエラーハンドリングについて本番相当の部品でテストでき、実行時間も@SpringBootTestよりは短くて済む。
テストスライスアノテーションの中身
テストスライスアノテーションは実際どのように実装されているのかみていく。例として@DataJpaTestをみていくが、基本的な構造は他のテストスライスアノテーションでもほぼ一緒である。
DataJpaTest
SpringBoot2.7.5だと下記のよう。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@BootstrapWith(DataJpaTestContextBootstrapper.class)
@ExtendWith(SpringExtension.class)
@OverrideAutoConfiguration(enabled = false)
@TypeExcludeFilters(DataJpaTypeExcludeFilter.class)
@Transactional
@AutoConfigureCache
@AutoConfigureDataJpa
@AutoConfigureTestDatabase
@AutoConfigureTestEntityManager
@ImportAutoConfiguration
public @interface DataJpaTest {
特徴的なところをみていく。
@BootstrapWith(DataJpaTestContextBootstrapper.class)
@BootstrapWithではテスト実行時のアプリケーションコンテキストを作成するにあたって、どこを起点に作成するかを決める。
DataJpaTestContextBootstrapperは SpringBootTestContextBootstrapperを継承しているが、SpringBootTestContextBootstrapperでは@DataJpaTestを付与したパッケージから遡って行って、@SpringBootConfigurationが付与されたクラスを起点に選ぶ。なお、@SpringBootConfigurationは@SpringBootApplicationに内包されている。
protected Class<?>[] getOrFindConfigurationClasses(MergedContextConfiguration mergedConfig) {
Class<?>[] classes = mergedConfig.getClasses();
if (containsNonTestComponent(classes) || mergedConfig.hasLocations()) {
return classes;
}
Class<?> found = new AnnotatedClassFinder(SpringBootConfiguration.class) // <- 起点である SpringBootConfiguration.class を探している
.findFromClass(mergedConfig.getTestClass());
Assert.state(found != null, "Unable to find a @SpringBootConfiguration, you need to use "
+ "@ContextConfiguration or @SpringBootTest(classes=...) with your test");
logger.info("Found @SpringBootConfiguration " + found.getName() + " for test " + mergedConfig.getTestClass());
return merge(found, classes);
}
そのため、@DataJpaTestでは通常@SpringBootApplicationが付与されたクラスを起点にアプリケーションコンテキストを作成することになる。
@SpringBootConfigurationへのたどり方は、対象のテストクラスから1つずつパッケージを上がっていって見つける。
そのため、テストクラスがcom.example.slicetest.demoにあったとしたら、@SpringBootApplicationを付与したクラスは com.example.slicetest, com.example, comのいずれかに配置されている必要がある。
もし、com.example.slicetest.applicationなどに配置されているとエラーになる。
@TypeExcludeFilters(DataJpaTypeExcludeFilter.class)
@SpringBootApplicationでアプリケーションコンテキストを作る際に、bean登録しないクラスを選別するための設定。
DataJpaTypeExcludeFilterの中身は下記。
public final class DataJpaTypeExcludeFilter extends StandardAnnotationCustomizableTypeExcludeFilter<DataJpaTest> {
DataJpaTypeExcludeFilter(Class<?> testClass) {
super(testClass);
}
}
上記のようにDataJpaTypeExcludeFilterはStandardAnnotationCustomizableTypeExcludeFilterを継承しているが、特に新しく設定を追加してはいない。
StandardAnnotationCustomizableTypeExcludeFilterをそのまま利用すると、@SpringBootApplicationを付与したクラスからの@ComponentScanはされなくなる。
つまり、@Controller、@Service、@Component、@RepositoryによるBean定義はアプリケーションコンテキストに入らなくなり、@Configurationを付与したクラスでのBean定義も効かなくなる。
DataJpaTypeExcludeFilterと同列である、WebMvcTypeExcludeFilterでは下記のようにComponentScanの対象となるアノテーションやクラスを明示するようにしている。
(ExcludeFilterという名前であったので、てっきり除外するものを列挙しているのだろうと思ったが、逆にscanするものを列挙してそれ以外は省く、という発想であった)
Set<Class<?>> includes = new LinkedHashSet<>();
includes.add(ControllerAdvice.class);
includes.add(JsonComponent.class);
includes.add(WebMvcConfigurer.class);
includes.add(WebMvcRegistrations.class);
includes.add(javax.servlet.Filter.class);
includes.add(FilterRegistrationBean.class);
includes.add(DelegatingFilterProxyRegistrationBean.class);
includes.add(HandlerMethodArgumentResolver.class);
includes.add(HttpMessageConverter.class);
includes.add(ErrorAttributes.class);
includes.add(Converter.class);
includes.add(GenericConverter.class);
includes.add(HandlerInterceptor.class);
@AutoConfigure~~~~
DataJpaTestでは下記が設定されている。
@AutoConfigureCache@AutoConfigureDataJpa@AutoConfigureTestDatabase@AutoConfigureTestEntityManager
上記アノテーションによって、META-INF/spring/~~~.importsファイルに含まれたクラスをauto configureする。
ファイル名とauto configureするクラスの対応は下記の通り。
- org.springframework.boot.test.autoconfigure.core.AutoConfigureCache.imports
- org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration
- org.springframework.boot.test.autoconfigure.orm.jpa.AutoConfigureDataJpa.imports
- org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfiguration
- org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration
- org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration
- org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration
- org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration
- org.springframework.boot.autoconfigure.liquibase.LiquibaseAutoConfiguration
- org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration
- org.springframework.boot.autoconfigure.sql.init.SqlInitializationAutoConfiguration
- org.springframework.boot.autoconfigure.transaction.TransactionAutoConfiguration
- org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase.imports
- org.springframework.boot.test.autoconfigure.jdbc.TestDatabaseAutoConfiguration
- org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration
- org.springframework.boot.test.autoconfigure.orm.jpa.AutoConfigureTestEntityManager.imports
- org.springframework.boot.test.autoconfigure.orm.jpa.TestEntityManagerAutoConfiguration
@DataJpaTestは@Repositoryを付与したクラスをアプリケーションコンテキストに入れるが、その設定はどこにあるのかというと、JpaRepositoriesAutoConfigurationにて行っている。
まとめ
DataJpaTestを中心にテストスライスアノテーションの実装について調査した。
調べた結果、テストスライスアノテーションの肝となる箇所は、
-
@TypeExcludeFiltersでどのアノテーション、クラスをアプリケーションコンテキストに入れるか -
@AutoConfigure~~で何をauto configureするか
であるということが分かった。
参考