テスト

Supabase を使うコードのテストに、プロジェクトもネットワークも要りません。すべての呼び出しはアプリケーションの HttpTransport の Bean を通り、Realtime は WebSocketTransport の Bean を通ります。テストはそれらをフェイクに置き換え、送られたものを読み、プロジェクトの代わりに応答します。

使う理由

本物のプロジェクトに対するテストは遅く、CI にキーが必要で、ちょうどよい瞬間にエラーを返させるのも簡単ではありません。フェイクのトランスポートなら、アプリケーションのコードは本番と同じ (同じリポジトリ、同じ資格情報のルール) で、すべての応答をテストが決めます。

一つの部分を手で組み立てる

MockHttpTransport は、package:spring_boot_starter_test/spring_boot_starter_test.dart (と spring_boot_starter_test) にあります。このテストは、その上に StorageTemplate を組み立てます。

import 'dart:typed_data';

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

void main() {
  late MockHttpTransport transport;
  late StorageTemplate storage;

  setUp(() {
    transport = MockHttpTransport();
    final properties = SupabaseProperties()
      ..url = 'https://abcd.supabase.co'
      ..anonKey = 'anon-key';
    storage = StorageTemplate(
      http: SupabaseHttp(
        properties: properties,
        transport: transport,
        credentials: DefaultSupabaseCredentials(
          properties: properties,
          authentication: () => null,       // nobody is signed in
        ),
      ),
      mapper: ObjectMapper(),
    );
  });

  test('posts the bytes with the key, the token and the options', () async {
    transport
        .when(HttpMethod.post, '/storage/v1/object/avatars/u1/a b.png')
        .respond(200, json: {'Key': 'avatars/u1/a b.png'});

    await storage.upload(
      'avatars',
      'u1/a b.png',
      Uint8List.fromList([1, 2, 3]),
      contentType: 'image/png',
      upsert: true,
    );

    final request = transport.requests.single;
    expect(
      '${request.url}',
      'https://abcd.supabase.co/storage/v1/object/avatars/u1/a%20b.png',
    );
    expect(request.body, [1, 2, 3]);
    expect(request.headers['apikey'], 'anon-key');
    expect(request.headers['Authorization'], 'Bearer anon-key');
    expect(request.headers['x-upsert'], 'true');
    expect(request.followRedirects, isFalse);
  });

  test('a refused policy is a permission failure', () async {
    transport.when(HttpMethod.post, '/storage/v1/object/b/p').respond(
      400,
      json: {
        'statusCode': '403',
        'error': 'Unauthorized',
        'message': 'new row violates row-level security policy',
      },
    );
    await expectLater(
      storage.upload('b', 'p', const [1]),
      throwsA(isA<StoragePermissionDeniedException>()),
    );
  });
}

アプリケーション全体

ApplicationContextRunner は、スターターの自動構成と、HttpTransport の Bean としてのフェイクのトランスポートで、アプリケーションを起動します。リポジトリと宣言したインターフェースは、生成された Bean になります。

ApplicationContextRunner appRunner(MockHttpTransport transport) =>
    const ApplicationContextRunner()
        .withUserConfiguration($application)
        .withAutoConfiguration(springBootAutoConfiguration)
        .withAutoConfiguration(springSecurityCoreAutoConfiguration)
        .withAutoConfiguration(springBootStarterFeignAutoConfiguration)
        .withAutoConfiguration(springBootStarterWebsocketAutoConfiguration)
        .withAutoConfiguration(springBootStarterDataAutoConfiguration)
        .withAutoConfiguration(springBootStarterCacheAutoConfiguration)
        .withAutoConfiguration(springBootStarterSupabaseAutoConfiguration)
        .withPropertyValues([
          'spring.supabase.url=https://abcd.supabase.co',
          'spring.supabase.anon-key=anon-key',
        ])
        .withBean<HttpTransport>(() => transport);

test('a derived query becomes filters of the REST API', () async {
  final transport = MockHttpTransport();
  transport.when(HttpMethod.get, '/rest/v1/todos').respond(200, json: [
    {'id': 1, 'title': 'Buy milk', 'done': false},
  ]);

  await appRunner(transport).runAsync((context) async {
    expect(context.startupFailure, isNull);
    final found =
        await context.getBean<Todos>().findByDoneOrderByCreatedAtDesc(false);
    expect(found.single.title, 'Buy milk');
  });

  expect(
    Uri.decodeFull(transport.requests.single.url.query),
    'done=eq.false&order=created_at.desc',
  );
});

springBootStarterSupabaseAutoConfiguration とその他は、package:spring_boot_starter_supabase/spring_auto_configuration.dart から来ます。

応答と失敗

フェイクで コードが見るもの
.respond(200, json: …) その応答
.respond(409, json: {'code': '23505', 'message': '…'}) リポジトリからの DuplicateKeyException
件数のリクエスト (limit=0 の GET) への .respond(200, headers: {'Content-Range': '0-1/7'}) Page の合計
.fail(HttpTransportException('connection refused')) リポジトリからは DataAccessResourceFailureException、Storage と Auth からは SupabaseUnavailableException

ユーザー

Realtime

MockWebSocketTransport が Realtime のサーバーを演じます。テストは、クライアントが送ったフレームを読み、サーバーのフレームを送り出します。プロトコルは Phoenix Channels クライアントのもので、最初のワイヤーフォーマットです (topic、event、payload、ref を持つ JSON オブジェクト)。パッケージ自身のテストは、そのトランスポートを使う PhoenixSocketFactory の上に SupabaseRealtime を組み立てます。

パッケージ自身のテストのレベル

スターターのテストには、その dart_test.yaml に従ってタグが付いています。

レベル タグ 内容 必要なもの
1 supabase (すべてのテストファイルに付く) REST API のフィルター、フェイクのサーバーに対する Phoenix プロトコル、フェイクの HTTP トランスポートに対する Storage、Auth、関数、テストが作る鍵でのトークンの検査、パスのセグメント、呼び出し元を含むキャッシュキー なし
2 と 3 supabase-docker PostgreSQL コンテナ上の、spring.supabase.db.rls: user での SQL の経路。PostgreSQL の上の本物の PostgREST に対する、行レベルセキュリティ付きの REST ストア Docker。なければスキップされる。CONTAINERS_REQUIRED=true では失敗になる
4 supabase-stack 本物のサービスだけが答えられること Supabase 全体 (Supabase CLI のスタック、またはホストされたプロジェクト)。SUPABASE_URL、SUPABASE_ANON_KEY、SUPABASE_SERVICE_ROLE_KEY、SUPABASE_DB_URL で渡す。なければスキップされる
dart test --exclude-tags "supabase-docker || supabase-stack"   # level 1
dart test --tags supabase-docker                               # levels 2 and 3
dart test --tags supabase-stack                                # level 4

各レベルは、フレームワークのメインのパイプラインではなく、専用のパイプライン (.github/workflows/supabase.yml) で実行されます。レベル 1 から 3 はジョブ unit と containers で、レベル 4 (test/stack_*_test.dart、Supabase CLI の設定は test/stack/) はジョブ stack で Supabase CLI のローカルスタックに対して実行されます。さらにジョブ hosted では、リポジトリのシークレットにアドレスとキーがあれば、ホストされたプロジェクトに対して実行されます。

互いに通信しなければならないコンテナ (PostgreSQL と PostgREST) のために、テストスターターにはネットワークがあります。アプリケーションのテスト用の Supabase コンテナは、まだありません。

Spring (Java) との対応

MockHttpTransport は MockRestServiceServer の役割を果たし、ApplicationContextRunner は Spring Boot のものです。

関連項目