テスト

package:spring_web_dart/testing.dart には、両側のための偽物があります。MockHttpTransport は事前に用意したレスポンスで HTTP リクエストに応答し、送られたものを記録します。MockWebSocketTransport はすべての WebSocket 接続のサーバー役を演じます。MockServerHttpRequest、MockServerHttpResponse、WebSocketSessionPair はサーバーの型の代わりになります。Spring Boot のアプリケーションでは、いずれにせよアプリケーションが持っているテスト用の依存関係 spring_boot_starter_test からそれらをインポートしてください。

使う理由

他のサービスを呼ぶコードは、それらなしでテストすべきです。ネットワークなし、不安定なタイミングなしで、サービスが何を返すか (失敗を含む) はテストが決めます。

MockHttpTransport

import 'package:spring_web_dart/testing.dart';

final transport = MockHttpTransport();
transport.when(HttpMethod.get, '/books/1').respond(200, json: {'isbn': '1', 'title': 'Dune'});
transport.when(HttpMethod.get, '/books?q=dune').respond(200, json: []); // クエリも一致しなければならない
transport.when(HttpMethod.get, 'https://api.neon.books/stock').respond(503);

// リトライのテスト: 最初の呼び出しは失敗し、2 回目は成功する。
transport.when(HttpMethod.get, '/flaky').fail(HttpTransportException('down'));
transport.when(HttpMethod.get, '/flaky').respond(200, body: 'up');

// リクエストから計算した応答: 投稿された本をそのまま返す。
transport
    .when(HttpMethod.post, '/books')
    .respondWith((request) => HttpResponse(201, body: request.body!, request: request));

// Spring Boot のテストでは、Feign クライアントはこのモックと通信する。
final app = springBootTest(springApplication, overrides: [BeanOverride<HttpTransport>(transport)]);

expect(transport.lastRequest.headers['Accept'], 'application/json');
expect(transport.requests, hasLength(2));
呼び出し 応答
respond(status, json:, body:, headers:) 用意したレスポンス。
respondWith((request) => response) リクエストから計算したレスポンス。
fail(exception) ネットワークの失敗として例外を投げる。
respondEvents([...], keepOpen:) text/event-stream のボディ。String でないデータは JSON として書かれる。
respondStream(status, () => chunks) 任意のストリームのボディ。
transport
  ..when(HttpMethod.get, '/orders/events').respondEvents([
    ServerSentEvent({'id': 1, 'status': 'NEW'}, id: '1'),
  ])
  ..when(HttpMethod.get, '/orders/events').respond(204); // 再接続が止まる

MockWebSocketTransport

final sockets = MockWebSocketTransport();
// Spring Boot のテストでは: overrides: [BeanOverride<WebSocketTransport>(sockets)]

final server = await sockets.nextConnection;    // クライアントの接続を待つ
server.pushJson({'from': 'ann', 'text': 'hi'}); // サーバー → クライアント
expect(server.sentJson, [{'text': 'hello'}]);   // クライアントが送ったもの
await server.drop();                            // 接続の喪失 (1006)
sockets.failNextConnect();                      // 次の接続は失敗する

サーバー側のモック

型 内容
MockServerHttpRequest テスト対象のフィルターやハンドラーのためのリクエスト。
MockServerHttpResponse 応答を記録する: bodyText、json、サーバー送信イベントには events と eventStream。
WebSocketSessionPair メモリ上で接続された 2 つのセッション。
MockMultipartFile MockMvc.multipart のためのテスト用ファイル。

アプリケーションは、その上に MockMvc を載せたものを spring_boot_starter_test から得ます (Web スターターでのテスト を参照)。

Spring (Java) との対応

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

MockHttpTransport は Spring の MockRestServiceServer の役割をトランスポートのレベルで果たすため、HttpTransport の上に作られたすべてのクライアントに使えます。MockWebSocketTransport に対応するものは Spring にはありません。

関連項目