テストと時間

スケジュールされたメソッドは springBootTest でも実行されます。テストを決定的に保つには、スケジューリングを無効にしてメソッドを直接呼ぶか、fake_async や Flutter のウィジェットテストでテストに時間を進めさせます。スケジューラーは、それらのツールが偽装する package:clock の時刻を読みます。

使う理由

スケジュールのために実時間で 5 分待つテストは役に立たず、タイマーと競争するテストは不安定です。メソッドを直接呼べばそれが何をするかをテストでき、偽の時間を進めればそれがいつ実行されるかをテストできます。

例

import 'package:spring_boot_starter_test/spring_boot_starter_test.dart';
import 'package:test/test.dart';

import 'spring_gen/main.test.spring.dart';

void main() {
  final app = springBootTest(
    springApplication,
    properties: {'spring.task.scheduling.enabled': false},
  );

  test('refresh', () => app.getBean<Reports>().refreshCache());
}
// 偽の時間で実行するスケジュール: 5 分が一瞬で過ぎる。
fakeAsync((async) {
  var runs = 0;
  final scheduler = TimerTaskScheduler();
  scheduler.scheduleAtFixedRate(() => runs++, const Duration(minutes: 1));
  async.elapse(const Duration(minutes: 5));
  expect(runs, greaterThanOrEqualTo(5)); // 開始時に一回、その後 1 分ごとに一回
});

時間を進める

Flutter のウィジェットテスト (tester.pump) と fake_async は、タイマーと package:clock の現在時刻を偽装し、スケジューラーはデフォルトでそれを読みます。

独自のタイマーを持つテストは、その偽の時計の現在時刻とタイマーを渡します: TimerTaskScheduler(now: ..., createTimer: ...) を BeanOverride で登録します。ScheduledAnnotationBeanPostProcessor.scheduledTasks は、スケジュールされているものを列挙します。

スケジューラーが時間を読む方法

fixedRate と fixedDelay は実時間の時計を決して読みません。Spring のエクゼキューターが単調時計で数えるのと同じく、各タスクは独自のタイムラインを持ち、そのタイマーがそれを進めます。

そのため、実時間の時計を (手で、またはタイムサーバーで) 設定しても、それらの実行は何も動きません。止まった時計、遅れたり進んだりする時計、実際のタイマーが待っている間に飛ぶ時計も同様です。制限は 2 つで、どちらも独自の時計のもとでのものです。

cron や scheduleAt の時刻は実時間の時刻です。スケジューラーは実時間の時計から待機を計算し、タイマーがそれを待ちます。待機中に実時間の時計が戻されると、実行は実時間の時計で一度だけ早く来ます。次の時刻は再び実時間の時計から計画されます。1 日より長い待機は最大 1 日のタイマーで構成されるため、実時間の時計がその時刻を過ぎてから 1 日以内に終わります。

ホットリロード

タスクはコンテキストに属します。ホットリロードによる再起動はコンテキストを閉じ、それがすべてのタスクをキャンセルし、新しいコンテキストが新しいコードのメソッドをスケジュールします。

Spring (Java) との対応

@SpringBootTest(properties = "spring.task.scheduling.enabled=false")
class ReportsTest { ... }

Spring のテストは通常、Awaitility を使うかメソッドを直接呼びます。ここでは偽の時間がスケジューラーも動かします。

関連項目