springBootTest
springBootTest は、それを囲む main や group のテストのためにアプリケーションを起動します。runApplication が行うことをすべて行います。設定ファイルを読み、自動構成を適用し、@ConfigurationProperties をバインドし、ランナーを呼びます。Spring の @SpringBootTest に当たります。
使う理由
テストによっては本物の結び付けが必要です。リポジトリを持つサービス、設定ファイルからのプロパティ、MockMvc の背後のコントローラーなどです。テストのグループに対してアプリケーションを一度だけ起動すればテストは速く保たれ、オプションによって各テストファイルは、一つのプロパティや一つの Bean のように、必要なものだけを変えられます。
例
import 'package:spring_boot_starter_test/spring_boot_starter_test.dart';
import 'package:test/test.dart';
import '../bin/spring_gen/main.spring.dart';
void main() {
final gateway = FakeGateway();
final app = springBootTest(
springApplication,
args: ['--shop.name=Night Books'], // コマンドラインと同じく
properties: {'logging.console.enabled': false}, // 他のすべてのソースより優先される
profiles: ['test'], // spring.profiles.active
systemEnvironment: {'SHOP_MAX_BASKET_SIZE': '25'}, // マシンのものの代わりに
overrides: [BeanOverride<PaymentGateway>(gateway)],
);
test('pays through the fake', () {
app.getBean<Checkout>().pay(10);
expect(gateway.charged, [10]);
});
test('changes shared state', () {
app.getBean<Basket>().add(book);
// バスケットはもう空ではない: 次のテストは新しいコンテキストを得る。
app.markDirty();
});
}
springBootTest はすぐに戻ります。アプリケーションは最初のテストの前に起動します。
動作
- コンテキストは、
mainやgroupの最初のテストの前に、setUpAllの中で一度だけ起動します。最後のテストの後、tearDownAllの中でcloseAsync()によって閉じられるため、非同期の@PreDestroyメソッドとライフサイクルの停止は待たれます。 app.markDirty()は現在のテストの終わりにコンテキストを閉じ、次のテストは新しいコンテキストを起動します。setUp(app.markDirty)はすべてのテストに新しいコンテキストを与えます。appは、テストの中、setUp、そしてspringBootTestの呼び出しより後に宣言したsetUpAllの中で使えます。それ以外の場所では、コンテキストがまだ存在しないため、app.contextはStateErrorを投げます。- アプリケーションが変更した
SpringLogのレベルとハンドラーは、最後のテストの後に元に戻されます。 - 各
springBootTestは自分のコンテキストを起動します。テストファイル間で共有されるキャッシュはありません。
オプション
| パラメーター | 働き | Spring |
|---|---|---|
| 最初の引数 | 起動する SpringApplication。通常は生成された springApplication |
classes |
args |
コマンドライン引数 | @SpringBootTest(args) |
properties |
コマンドラインと propertyFiles を含む他のすべてのソースより上のプロパティ |
@SpringBootTest(properties) |
propertyFiles |
.properties ファイルのリソースロケーション。後のファイルが優先される。ないファイルは StateError で起動を失敗させる |
@TestPropertySource(locations) |
dynamicProperties |
テストの実行時にしか分からないプロパティ。properties より上 |
@DynamicPropertySource |
profiles |
設定ファイルの値を置き換えて spring.profiles.active になる |
@ActiveProfiles |
systemEnvironment |
アプリケーションから見える環境変数。デフォルトは空 | なし |
resourceDirectories |
クラスパスの先頭に置くディレクトリ。デフォルトは ['test/resources'] |
テストのクラスパス |
overrides |
偽物やモックに置き換える Bean | @MockitoBean、@TestBean |
initializers |
リフレッシュの前に実行される ApplicationContextInitializer |
@ContextConfiguration(initializers) |
webEnvironment |
どの Web サーバーを起動するか: mock (なし。デフォルト)、randomPort、definedPort、none |
@SpringBootTest(webEnvironment) |
プロパティのオプションの優先順位は テストのプロパティ を、overrides は BeanOverride を、webEnvironment は MockMvc を参照してください。
SpringBootTestContext
springBootTest が返すもの:
| メンバー | 得られるもの |
|---|---|
getBean<T>({qualifier})、getBeanByName(name) |
Bean。なければ例外を投げる |
findBean<T>({qualifier}) |
Bean または null |
getBeans<T>({qualifier}) |
T のすべての Bean。@Order で並べられる |
value<T>(expression)、optionalValue<T>(expression) |
@Value フィールドと同じように解決した ${...} または #{...} 式 |
context、environment |
動作中のコンテキストとその Environment |
mockMvc |
メモリ上でのコントローラーへのリクエスト (Web スターターがある場合)。なければ StateError |
localServerPort |
本物のサーバーのポート (randomPort、definedPort)。動いていなければ StateError |
output |
アプリケーションが出力した行。起動しなかったコンテキストの失敗レポートなど。テストが失敗したときにも出力される |
markDirty() |
次のテストのための新しいコンテキスト |
test('reads its configuration', () {
expect(app.value<int>(r'${shop.max-basket-size}'), 25);
expect(app.environment.activeProfiles, ['test']);
expect(app.getBeans<PaymentGateway>(), hasLength(1));
});
起動時の情報は出力されるのではなく SpringLog を通してログに出されるため、output には含まれません。それには captureLogs を使ってください。
起動しないコンテキスト
アプリケーションの起動に失敗すると、グループのテストはそのエラーで失敗し、app.output は APPLICATION FAILED TO START のレポートを持ちます。これは失敗とともに出力もされます。
複数のアプリケーション
複数のエントリーポイントを持つパッケージには、複数の生成ファイルがあります。使いたいものを渡してください (インポートのプレフィックスを付けた admin.springApplication)。テストクラスは @SpringBootTest(application: 'bin/admin.dart') でそれを指定します。テストクラス を参照してください。
Spring (Java) との対応
@SpringBootTest(args = "--shop.name=Night Books",
properties = "logging.console.enabled=false")
@ActiveProfiles("test")
class CheckoutTest {
@MockitoBean PaymentGateway gateway;
@Autowired Checkout checkout;
}
同じオプションを、クラスのアノテーションとして指定します。ここでは関数の形が基本で、テストクラスはそこに生成されます。