テスト

spring_boot_starter_test の springBootTest は flutter_test で動きます。テスト用のプロパティとフェイクを使い、ファイルのテストのためにアプリケーションを一度起動します。ウィジェットを、テストのコンテキストを持つ SpringScope の下に、そしてプロパティのアプリのウィジェット、テーマ、テキストのために SpringApp の下に置きます。Bean は BeanOverride で置き換えます。

使う理由

ウィジェットは、その状態とサービスを、コンストラクターではなくアプリケーションコンテキストから得ます。そのためテストはアプリケーション (または必要な部分) を起動し、いくつかの Bean をフェイクに置き換え、そのコンテキストでウィジェットを表示します。同じテストのツールが Spring のサーバーのテストにも使われるため、チームは一度学べば済みます。

セットアップ

# pubspec.yaml
dev_dependencies:
  flutter_test:
    sdk: flutter
  build_runner: ^2.17.0
  spring_core_dart_generator: ^0.9.0
  spring_boot_starter_test: ^0.9.0

ウィジェットテスト

概要 のカウンターアプリは Material のアプリなので、テストも Material をインポートします。

import 'package:flutter_test/flutter_test.dart';
import 'package:material_ui/material_ui.dart';
import 'package:my_app/main.dart';
import 'package:my_app/spring_gen/main.spring.dart';
import 'package:spring_boot_starter_flutter_material/spring_boot_starter_flutter_material.dart';
import 'package:spring_boot_starter_test/spring_boot_starter_test.dart';

void main() {
  // このファイルのために、プロパティとフェイクでアプリケーションを一度起動する。
  final app = springBootTest(
    springApplication,
    properties: {'counter.step': 2},
    overrides: [BeanOverride<Clock>(FixedClock())],
  );

  setUp(app.markDirty); // テストごとに新しいコンテキスト、つまり新しい Counter

  testWidgets('a tap adds counter.step', (tester) async {
    await tester.pumpWidget(
      SpringScope(
        applicationContext: app.context,
        child: const SpringApp(home: CounterPage()),
      ),
    );

    expect(find.text('0'), findsOneWidget);
    await tester.tap(find.byIcon(Icons.add));
    await tester.pump();

    expect(find.text('2'), findsOneWidget);
    expect(app.context.getBean<Counter>().value, 2);
  });
}

テストでのテーマ

プロパティが表示するテーマを選びます。

final app = springBootTest(
  springApplication,
  properties: {'spring.flutter.theme.active': 'dark'},
);

または、設定ページのように、テストが選びます。

app.context.getBean<ThemeSelection>().select(AppThemes.ocean);
await tester.pumpAndSettle();

active: system では、テーマは tester.platformDispatcher.platformBrightnessTestValue に従います。デバイスのダークモードをテストするには、それを Brightness.dark に設定してください。テーマのフォントは、テストでもアプリと同じくアセットから読み込まれるため、ゴールデンファイルはテスト用のフォントではなくそれらを表示します。

プラットフォーム

springBootTest はプラットフォームのプロファイルを追加しません。プラットフォームのプロファイルの Bean やファイルは、テストのプロパティのそのプロファイル ('spring.profiles.active': 'ios') と、ウィジェットのための Flutter の debugDefaultTargetPlatformOverride でテストします。

起動全体

起動そのもの (スプラッシュ、失敗した起動、プラットフォームのプロファイル) をテストするには、runApp と同じく SpringApplicationWidget を pump します。

testWidgets('the app starts', (tester) async {
  await tester.pumpWidget(
    SpringApplicationWidget(
      application: () => springApplication,
      home: const CounterPage(),
    ),
  );
  await tester.pumpAndSettle();

  // テストはデバッグビルドの Android として動く: それらのプロファイルがアクティブ。
  final context = SpringScope.of(tester.element(find.byType(CounterPage)));
  expect(context.environment.activeProfiles, ['mobile', 'android', 'debug']);

  await tester.pumpWidget(const SizedBox()); // 取り除くとコンテキストが閉じる
});

SpringApplicationWidget はテスト用のプロパティも Bean のオーバーライドも受け取りません。それらが必要なテストは、springApplication のコピーにオーバーライドを加えて組み立てた独自の SpringApplication を渡します。

アプリケーションなしの、フェイクを使うウィジェット

SpringStatelessWidget は、アプリケーションなしにフェイクで組み立てられます。

final widget = const BasketBadge().buildWith(context, (FakeBasket(), FakeClock()));

ファイルとディレクトリ

ウィジェットテストには path_provider のプラグインがありません。その場合 FileTemplate はデバイスのディレクトリを持たないため、BeanOverride<FileStore>(InMemoryFileStore()) でそのストアを置き換えてください。SQLite のデータベースは URL が示す場所にとどまります (SQLite データベース を参照)。

ゴールデンファイル

matchesGoldenFile は、どの Flutter のテストとも同じように動きます。画面を SpringApp の下で pump し、各テーマを順に選び、テーマごとに一つのゴールデンと比較してください。フレームワークのテーマの例は、同梱するすべてのテーマについてそうしています。

関連項目