Flutter × Realm：Unitテストでハマる2つの罠とその回避法

はじめに

FlutterでRealmを使ったアプリケーションを開発している際、Unitテストを書くことは重要ですが、いくつかの問題に直面することがあります。この記事では、RealmのUnitテストを書く際に遭遇する2つの課題とその解決策について紹介します。

課題1: realm.addやrealm.addAllがUnitテストで呼ばれない

原因

通常、Unitテストではmockitoなどを使ってモックを作成することでテストを行います。しかし、Realmの場合、writeメソッドの中で呼び出されるrealm.addやrealm.addAllのようなメソッドをモックすることが難しいです。

解決策

この問題に対処するために、Realmのモックは作らないことをお勧めします。代わりに、メモリ上で実際にRealmを動かしてテストを行います。以下のように、inMemory構成を使用することで、実際の動作に近い形でテストが可能です。

final config = Configuration.inMemory([Car.schema]);
final realm = Realm(config);

参考URL: Open an In-Memory Realm

この方法を使うことで、テスト環境を実際の使用環境に近づけることができ、モックよりも正確なテスト結果が得られます。

よくある質問: 「テストってモックで行うものじゃないの？」

回答
テストの目的は正しく動くことを確認し、バグを防ぐことです。その目的のために、モックを使わず、より本番に近い環境でテストを行うことは、むしろより良いことだと考えます。モックを使った場合、実際の動作と異なる挙動をしてしまう可能性があるため、メモリ上で実際にRealmを動かす方が安全で信頼性があります。

課題2: 複数のRealmのUnitテストを同時に実行すると失敗することがある

原因

テストが終了した際に、メモリリークを防ぐためにrealm.close()を呼ぶのは正しいアプローチですが、複数のテストが並行して実行されている場合に問題が発生することがあります。特に、片方のテストで使用しているRealmを閉じてしまうと、もう片方のテストが失敗する可能性があります。

解決策

この問題を避けるために、各テストごとにデータベースファイルの名前を変更しましょう。デフォルトのRealm名をテストごとにユニークにすることで、並行実行時の競合を防ぐことができます。

Configuration.defaultRealmName = "myRealmName.realm";
final customDefaultRealmPath = path.join(
    (await Directory.systemTemp.createTemp()).path,
    Configuration.defaultRealmName);
final config = Configuration.local([Car.schema]);

参考URL: Customize Default Configuration

このように、データベースファイル名をユニークにすることで、複数のテストが干渉することなく並行して実行できるようになります。

おわりに

ぴよぴよエンジニアですので、間違っている箇所がありましたら申し訳ありません
優しくコメントで教えてくださると嬉しいです！
また、この記事は時短のため、ChatGPTが整えました
確認はしましたが、言葉の不自然さがあったらごめんなさい