テスト

テストには GPU がありません。そこでは Scene を作れません。アプリのウィジェットテストでは、エンジンの起動が失敗し (警告として一度だけログに出ます)、シーンのウィジェットはプレースホルダーになります。アプリの残りの部分は、いつもどおりテストします。

使う理由

アプリのコードには、シーンを描画できないデバイスのための分岐がありません。そのため、テストにも必要ありません。テストは、そのようなデバイスと同じようにアプリを見ます。残る選択は、テストが警告を聞くかどうかと、エンジンの周りの Bean (モデル、イベント、ステータス) を動かすかどうかです。

例

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

void main() {
  // エンジンは起動されない: シーンのウィジェットはプレースホルダーになる。
  final app = springBootTest(
    springApplication,
    properties: {'spring.flutter.scene.render': 'off'},
  );

  testWidgets('the showroom shows its placeholder', (tester) async {
    await tester.pumpWidget(
      SpringScope(
        applicationContext: app.context,
        child: const SpringApp(home: Showroom()),
      ),
    );

    expect(find.text('hero'), findsOneWidget);
  });
}

三つの方法

テスト 起きること
何も変えない シーンが最初に表示されるときに、エンジンの起動が失敗し、警告として一度だけログに出る。SceneFailedEvent と SceneUnavailableEvent が発行される。ウィジェットはプレースホルダーになる
spring.flutter.scene.render=off を設定する エンジンは起動されず、何もログに出ない。ウィジェットはプレースホルダーになる
SceneBackend Bean を置き換える エンジンは GPU なしで起動する。またはテストが指示したときに失敗する。その周りの Bean (イベント、ステータス、モデル) をテストできる

テストのプロパティの spring.flutter.scene.enabled=false は、シーンの Bean が一つもない状態のアプリをテストします。

テストが置き換える Bean

SceneBackend はシーンを描画するもので、SceneEngine が一度だけ起動します。SceneModelImporter は、モデルのファイルをノードツリーに変えます。スターター自身の Bean は、アプリやテストの Bean があれば退きます。

import 'dart:typed_data';

import 'package:flutter_scene/scene.dart' show Node;
import 'package:spring_boot_starter_flutter_scene/spring_boot_starter_flutter_scene.dart';

/// An engine without a GPU: starts, or fails when told to.
final class FakeBackend implements SceneBackend {
  FakeBackend({this.fails = false});

  final bool fails;

  @override
  String get name => 'fake';

  @override
  Future<void> start() async {
    if (fails) {
      throw StateError('no GPU here');
    }
  }
}

/// Makes a bare node for any file.
final class FakeImporter implements SceneModelImporter {
  @override
  Future<Node> import(Uint8List bytes, {required String name}) async =>
      Node(name: name);
}
final app = springBootTest(
  springApplication,
  overrides: [
    BeanOverride<SceneBackend>(FakeBackend()),
    BeanOverride<SceneModelImporter>(FakeImporter()),
  ],
);

test('the engine starts', () async {
  final engine = app.context.getBean<SceneEngine>();
  expect(await engine.start(), isTrue);
  expect(engine.state, SceneEngineState.ready);
});

起動するバックエンドがあると、SpringSceneView.declarative はエンジンのビューを組み立てます。そして、描画されるシーンには GPU が必要です。そのため、テストのバックエンドは Bean のテストのためのものです。ウィジェットのテストは render=off を設定するか、失敗するバックエンドを与えます。

関連項目