テスト
@DataTest() を付けたテストクラスは、アプリケーションのデータ層だけを起動します。そのリポジトリとデータの Bean、マイグレーションを適用したメモリ上の SQLite データベース、そして各テストを囲み、その後にロールバックされるトランザクションです。サービス、コントローラー、ランナーはコンテキストに含まれません。spring_boot_starter_test がそれを実行します。
使う理由
リポジトリのテストには、リポジトリ、本物のデータベース、そしてテストごとのまっさらな状態が必要です。アプリケーション全体を起動すると遅く、テストに不要な Bean も持ち込みます。テスト間でデータを共有すると、テストがその順序に依存してしまいます。@DataTest は @AutoConfigureTestDatabase を伴う Spring の @DataJdbcTest で、小さなコンテキスト、新しいデータベース、各テストの後のロールバックを提供します。
例
# pubspec.yaml
dependencies:
spring_boot_starter_data: ^0.9.0
sqlite3: ^3.8.0 # 必須: テスト用のデータベースは SQLite
dev_dependencies:
build_runner: ^2.17.0
spring_core_dart_generator: ^0.9.0
spring_boot_starter_test: ^0.9.0
test: ^1.33.0
// test/book_repository_test.dart
import 'package:spring_boot_starter_data/spring_boot_starter_data.dart';
import 'package:spring_boot_starter_test/spring_boot_starter_test.dart';
import 'package:test/test.dart';
import 'spring_gen/book_repository.test.spring.dart'; // 生成されたもの
@DataTest()
class BookRepositoryTest {
@Autowired()
late BookRepository books;
@BeforeEach()
Future<void> seed() async { // テストのトランザクションの中で実行される
await books.save(Book(title: 'Dune', year: 1965));
}
@Test()
Future<void> findsABookByItsTitle() async {
await books.save(Book(title: 'Emma', year: 1815));
expect(await books.findByTitle('Emma'), hasLength(1));
} // ロールバックされる
@Test()
Future<void> startsWithTheSeedOnly() async {
expect(await books.count(), 1); // 前のテストの 'Emma' はない
}
}
void main() => runSpringTests();
dart run build_runner build # test/spring_gen/book_repository.test.spring.dart を書き出す
dart test
クラスは @SpringBootTest のものと同じように書きます。@Autowired() フィールド、@Test() メソッド、@BeforeEach、@Nested、@ActiveProfiles、@TestPropertySource、@TestBean は同じように動きます。クラスは @SpringBootTest() か @DataTest() のどちらかを持ち、両方は持ちません。
コンテキストが持つもの
- アプリケーションのデータの Bean: そのリポジトリ、そのエンティティの記述、
sqlite3のドライバーの Bean、スターターが使うか置き換える型の Bean (DataSource、PlatformTransactionManager、TransactionTemplate、JdbcTemplate、NamedParameterJdbcTemplate、JdbcClient、DataStore、NamingStrategy、AuditorAware、DateTimeProvider、RepositoryFactory...)、そして@EnableDataAuditingを持つクラス。 - データスターターの自動構成、コア、ロギング。他のスターター (Web、キャッシュ、セキュリティ、スケジューリング...) のものは除かれます。
- それ以外は何も。 除かれた Bean は存在しません。
@Autowired() late Library? library;フィールドはnullのままで、それを必要とする残された Bean は、通常のレポートとともに起動を失敗させます。 includeは、アプリケーションの Bean をそのクラスの型で追加します:@DataTest(include: [Library, ShopConfig])。構成クラスはそのすべての@Beanメソッドを持ち込みます。
データベース
アプリケーションが SQL データベースを構成している場合、@DataTest はコンテキストの起動前に、それをメモリ上の SQLite データベースに置き換えます。
| プロパティ | 設定値 | 理由 |
|---|---|---|
spring.datasource.url |
sqlite::memory: |
データベースはその接続と同じだけ生きる。 |
spring.datasource.driver |
sqlite3 |
設定が何を指定していても。 |
spring.datasource.pool.max-size |
1 |
各 SQLite 接続は独自のメモリ上のデータベースを持つ。 |
spring.datasource.pool.min-idle、idle-timeout、max-lifetime |
0 |
プールが唯一の接続を閉じてデータを失うことがないように。 |
その他の設定はすべて残り、各 spring.datasources.<name>.url にも同じことが起こります。構成されたデータベースがなければ、何も置き換えられません。リポジトリは、アプリケーションと同じくメモリ上のストアを使います。
replaceDatabase: falseは、構成されたデータベース (たとえばコンテナが起動したもの) を保ちます。テストは引き続きロールバックされます。- データベースを置き換えるには
sqlite3ドライバーが必要です。それがなければ、その旨を示して起動が失敗します。 - 独自の
DataSourceの Bean (プロパティが記述しないもの) は置き換えられません。 - 一つの接続は一つのトランザクションを意味します。 独自のトランザクションを開始するコード (
Propagation.requiresNew) は 2 つ目の接続を待ち、pool.connection-timeoutの後に失敗します。それは、複数の接続を持つデータベース上でreplaceDatabase: falseを使ってテストしてください。
スキーマは、アプリケーションでのものと同じところから来ます。マイグレーションが適用される (そしてエンティティが検証される) か、schema.sql と data.sql が実行されるか、どちらもなければエンティティからテーブルが作成されます。
トランザクション
各テストは、そのリポジトリが書き込むすべてのトランザクションマネージャー (プライマリーのデータベースのもの、メモリ上のストアのもの、名前付きのデータベースのもの) のトランザクションの中で実行され、終わるとロールバックされます。
- Spring と同じく、
@BeforeEachと@AfterEachはトランザクションの中で、@BeforeAllと@AfterAllは外で実行されます。 - テスト、クラス、
@Nestedのグループに付けた@Commit()(または@Rollback(false)) は、代わりにコミットします。最も内側のものが優先されます。それでも失敗したテストはロールバックされるため、失敗は何も残しません (Spring ならコミットします)。 @DataTest(transactionManager: 'stats')は、テストをそのマネージャー一つのトランザクションだけで実行します。他のデータベースには本当に書き込まれます。- テストメソッド、
@Nestedのグループ、クラスに付けた@Transactional(transactionManager: 'stats')は、その中のテストのマネージャーを選びます。最も内側のものが優先されます。その他の属性はテストでは何もしません。 - コミットを待つコールバックは、コミットするテストでだけ実行されます。
オプション
| オプション | デフォルト | 意味 |
|---|---|---|
application |
パッケージの唯一のアプリケーション | Bean を使うアプリケーション (Spring の classes)。 |
args |
[] |
コマンドライン引数。 |
properties |
{} |
テストのためのプロパティ。 |
resourceDirectories |
['test/resources'] |
追加のリソースディレクトリ。 |
include |
[] |
型で追加するアプリケーションの Bean。 |
replaceDatabase |
true |
構成されたデータベースをメモリ上の SQLite のものに置き換える。 |
transactionManager |
'' |
テストを実行するトランザクションの唯一のマネージャー。リポジトリが使うすべてのマネージャーなら空。 |
関数として書くテスト
package:spring_boot_starter_data/testing.dart の DataTestSetup と runInTestTransaction は、クラスなしで同じことを行います。
import 'package:spring_boot_starter_data/testing.dart';
void main() {
final data = DataTestSetup(springApplication);
final app = springBootTest(
springApplication,
properties: data.properties, // 他のスターターの自動構成を除く
initializers: [data.initializer], // データベースを置き換え、Bean を除く
);
test('finds a book', () => runInTestTransaction(app.context, () async {
final books = app.getBean<BookRepository>();
await books.save(Book(title: 'Dune', year: 1965));
expect(await books.findByTitle('Dune'), hasLength(1));
}));
}
Spring (Java) との対応
@DataJdbcTest
class BookRepositoryTest {
@Autowired BookRepository books;
@Test void findsABookByItsTitle() { ... }
}
@DataTest は、@AutoConfigureTestDatabase を伴う @DataJdbcTest の代わりです。それ自体がトランザクショナルで、テスト用のデータベースは常にメモリ上の SQLite のもの (replaceDatabase: false は自分のものを保ちます) です。失敗した @Commit のテストはロールバックされます。