テスト

テストでは、トランスポートを MockHttpTransport に置き換えます。これは用意したレスポンスで応答し、送られたものを記録します。spring_boot_starter_test に含まれ、Spring の MockRestServiceServer の役割を果たします。エンコード、デコード、エラー処理、インターセプターを含むクライアント自体は、本番と同じように動きます。

使う理由

本物のリモートサービスを呼ぶテストは、遅く、不安定で、制御できないデータに依存します。トランスポートを置き換えれば、ネットワーク以外のクライアントのすべてを保てるため、テストは正しいリクエストが出ていき、応答が正しく読まれることを確認できます。

例

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 server = MockHttpTransport();
  final app = springBootTest(
    springApplication,
    overrides: [BeanOverride<HttpTransport>(server)],
    properties: {'catalog.url': 'https://catalog.test'},
  );

  test('reads a book', () async {
    server.when(HttpMethod.get, '/books/1').respond(200, json: {'isbn': '1', 'title': 'Dune'});
    expect(await app.getBean<Shop>().title('1'), 'Dune');
    expect(server.lastRequest.headers['Accept'], 'application/json');
  });

  test('a missing book is null', () async {
    server.when(HttpMethod.get, '/books/2').respond(404);
    expect(await app.getBean<Shop>().title('2'), isNull);
  });
}

respondEvents([...]) はサーバー送信イベントのストリームで応答します (サーバー送信イベント を参照)。

クライアント全体を置き換える

HTTP をまったく使わずに、クライアントを使うコードをテストするには、クライアントを置き換えます。

final app = springBootTest(
  springApplication,
  overrides: [BeanOverride<CatalogClient>(FakeCatalog())],
);

class FakeCatalog implements CatalogClient {
  @override
  Future<Book> find(String isbn) async => Book(isbn: isbn, title: 'Dune');
  // ...
}

トランスポート

リクエストは HttpTransport の Bean を通ります。デフォルトは spring_web_dart の platformHttpTransport() です。VM と Flutter (モバイル、デスクトップ) では dart:io、Web では fetch で、そこではサーバーが CORS で自分のオリジンを許可しなければなりません。別の HTTP ライブラリの上のアダプターのように、別のものを通して送るには、独自の HttpTransport の Bean を宣言してください。connect-timeout (default の下) がデフォルトのトランスポートを設定します。

仕組み

@FeignClient には (spring_core_dart の) @InterfaceProxy が付いています。そうしたインターフェースについて、ジェネレーターは、各呼び出しをメソッドのアノテーション、パラメーター名、型とともに、スターターの feignClientFactory の Bean が作る InvocationHandler に渡すメソッドを持つクラスを書きます。クライアントは普通の Bean なので、AOP が適用されます。(spring_boot_starter_cache を使った) クライアントのメソッドの @Cacheable はレスポンスをキャッシュします。

Spring (Java) との対応

MockRestServiceServer server = MockRestServiceServer.bindTo(restTemplate).build();
server.expect(requestTo("/books/1")).andRespond(withSuccess(json, MediaType.APPLICATION_JSON));

Spring Cloud OpenFeign のテストは通常 WireMock を使います。MockHttpTransport は代わりにトランスポートの Bean を置き換えます。

関連項目