【Flutter】一時ファイル作成を簡単に！MemoryFileSystem解説

2025年1月9日
2025年1月9日
Dart

Dart

Table of Contents

対象者

本記事は、ファイル操作を伴うテストを行う中級Flutterエンジニアを対象としています。テスト環境の効率化や依存削減を目指している方を想定しています。

はじめに

Flutterのアプリ開発において、ファイル操作を伴う処理をテストする場合、実際のファイルシステムを使用すると、テスト環境に依存する問題が発生しやすくなります。そんな時に役立つのがpackage:fileライブラリに含まれるMemoryFileSystemです。本記事では、MemoryFileSystemを用いたテスト方法を詳しく解説します。

MemoryFileSystemとは？

MemoryFileSystemは、メモリ上にファイルシステムを構築するテスト用のモックです。実際のディスクにファイルを書き込むのではなく、仮想的なファイルシステムを使用して操作を行うため、テストの効率と安全性を向上させることができます。特に、ファイルの読み書きが必要な処理に対して、外部環境への依存をなくし、テストを簡単に実行可能にします。

主なメリット

外部環境に依存しない: ローカルファイルに触れる必要がないため、環境ごとのファイルパスの違いを考慮しなくて済む。
テストの高速化: メモリ上で処理するため、実ファイルシステムよりも高速に読み書きできる。
ファイル操作の検証が容易: ファイルの存在確認や内容の検証が簡単。

実装

基本

以下はMemoryFileSystemを使ったテストコードの例です。

import 'package:flutter_test/flutter_test.dart';
import 'package:file/file.dart';
import 'package:file/memory.dart';

void main() {
  test('MemoryFileSystem', () async {
    final FileSystem fs = MemoryFileSystem();

    // ファイルを作成
    final file = fs.file('/example.txt');
    expect(file.existsSync(), false); // ファイルはまだ存在しない

    // ファイルに文字列を書き込む
    file.writeAsStringSync('test');

    // ファイルの存在を確認
    expect(file.existsSync(), true);
    expect(file.readAsStringSync(), 'test'); // 内容の確認
    expect(file.path, '/example.txt'); // パスの確認
  });
}

コードの解説

MemoryFileSystem(): メモリ上に新しいファイルシステムを作成。
fs.file('/example.txt'): メモリ内のファイルシステム上で/example.txtという名前のファイルを生成。
existsSync(): ファイルの存在を同期的に確認。
writeAsStringSync('test'): ファイルにtestという文字列を書き込む。
readAsStringSync(): ファイルから内容を読み取る。

実行結果

ファイル作成前: existsSync()はfalse
ファイル作成後: existsSync()はtrue、ファイル内容はtest

応用

MemoryFileSystemを使うことで、以下のようなケースにも対応可能です。

1. ディレクトリの作成と検証

final directory = fs.directory('/test_dir');
directory.createSync();
expect(directory.existsSync(), true);

テスト内で仮想ディレクトリを作成し、その存在を確認できます。

2. ファイル削除のテスト

file.deleteSync();
expect(file.existsSync(), false);

メモリ上のファイルを削除して、削除後にファイルが存在しないことを確認できます。

3. 例外のテスト

MemoryFileSystemでは、通常のファイルシステム同様に例外処理も確認できます。

expect(() => fs.file('/not_found.txt').readAsStringSync(), throwsException);

実用例

MemoryFileSystemは、以下のような場面で活用できます。

設定ファイルの読み書きテスト
キャッシュ機能のテスト
バックアップファイル作成のテスト
一時ファイル作成: テスト以外にも、アプリ内で一時的なデータ保存が必要な場合に、MemoryFileSystemを使用してメモリ上にファイルを生成・操作できます。

テスト対象のコードにファイルシステム操作が含まれる場合、MemoryFileSystemを使うことで外部ファイルへの依存を排除し、純粋なロジックのテストに集中できます。

注意点

パスの指定: ファイルパスの記述に慣れていない場合、OSのファイルパス仕様の違いに引きずられないよう注意が必要です。MemoryFileSystem内では基本的にUNIX形式のパスを使用するのが推奨されます（/example.txtなど）。
初期化忘れ: テストごとにMemoryFileSystemを新規作成する必要があります。使いまわすと意図しない状態が残る可能性があります。

Q＆A

**Q: **MemoryFileSystemは実際のファイルシステムとどう異なりますか？
A: MemoryFileSystemはメモリ上でのみファイル操作を行うため、ディスクに書き込む必要がありません。そのため、テスト環境に左右されず、非常に高速に動作します。

Q: テスト中にファイルパスを間違えてもエラーになりますか？
A: はい、実際のファイルシステムと同様に、無効なファイルパスや存在しないディレクトリを指定するとエラーが発生します。

Q: 複数のテストで同じファイルシステムを使いまわすことはできますか？
A: 可能ですが推奨されません。各テストごとに新しいMemoryFileSystemを作成することで、テスト間のデータ干渉を防ぐことができます。

まとめ

MemoryFileSystemは、メモリ上で仮想ファイルシステムを再現することで、効率的かつ安全なファイル操作のテストを実現します。外部環境への依存を排除し、純粋なビジネスロジックに集中したテストを書くことで、堅牢なコードベースを構築できます。ファイル読み書きの処理を含むアプリを開発する際は、ぜひMemoryFileSystemを活用してテストコードを充実させましょう。

参考

Dart CLI App で Riverpod を使ってみた

ソース(main.dartにコピペして動作確認用)

import 'package:flutter_test/flutter_test.dart';
import 'package:file/file.dart';
import 'package:file/memory.dart';

main() {
  test('MemoryFileSystem', () async {
    final FileSystem fs = MemoryFileSystem();

    final file = fs.file('/example.txt');
    expect(file.existsSync(), false);

    file.writeAsStringSync('test');

    expect(file.existsSync(), true);
    expect(file.readAsStringSync(), 'test');
    expect(file.path, '/example.txt');

    file.deleteSync();
    expect(file.existsSync(), false);
  });

  group('それぞれのファイルシステムが独立している', () {
    const fileName = '/test.txt';
    test('作成', () async {
      final FileSystem fs = MemoryFileSystem();

      final file = fs.file(fileName);
      expect(file.existsSync(), false);
      file.writeAsStringSync('test');
      expect(file.existsSync(), true);
    });
    test('存在しないことを確認', () async {
      final FileSystem fs = MemoryFileSystem();
      final file = fs.file(fileName);
      expect(file.existsSync(), false);
    });
  });

  test('ディレクトリの作成と検証', () async {
    final FileSystem fs = MemoryFileSystem();
    final directory = fs.directory('/test_dir');
    expect(directory.existsSync(), false);
    directory.createSync();
    expect(directory.existsSync(), true);
  });

  test('例外のテスト', () {
    final FileSystem fs = MemoryFileSystem();
    expect(() => fs.file('/not_found.txt').readAsStringSync(), throwsException);
  });
}