swift-protocol-di-testing

Swift プロトコルベース依存性注入によるテスト容易性の向上

ファイルシステム、ネットワーク、iCloud などの外部依存関係を、小さく焦点を絞ったプロトコルの背後に抽象化することで、Swift コードをテスト可能にするパターンです。I/O を伴わない決定論的なテストを可能にします。

アクティベーションのタイミング

• ファイルシステム、ネットワーク、または外部 API にアクセスする Swift コードを記述する場合
• 実際の障害を発生させずにエラーハンドリングパスをテストする必要がある場合
• 異なる環境（アプリ、テスト、SwiftUI プレビュー）で動作するモジュールを構築する場合
• Swift Concurrency（アクター、Sendable）を使用してテスト可能なアーキテクチャを設計する場合

コアパターン

1. 小さく焦点を絞ったプロトコルを定義する

各プロトコルは、外部の懸念事項を正確に 1 つ処理します。

// ファイルシステムへのアクセス
public protocol FileSystemProviding: Sendable {
    func containerURL(for purpose: Purpose) -> URL?
}

// ファイルの読み取り/書き込み操作
public protocol FileAccessorProviding: Sendable {
    func read(from url: URL) throws -> Data
    func write(_ data: Data, to url: URL) throws
    func fileExists(at url: URL) -> Bool
}

// ブックマークストレージ（例：サンドボックス化されたアプリ用）
public protocol BookmarkStorageProviding: Sendable {
    func saveBookmark(_ data: Data, for key: String) throws
    func loadBookmark(for key: String) throws -> Data?
}

2. デフォルト（本番用）実装を作成する

public struct DefaultFileSystemProvider: FileSystemProviding {
    public init() {}

    public func containerURL(for purpose: Purpose) -> URL? {
        FileManager.default.url(forUbiquityContainerIdentifier: nil)
    }
}

public struct DefaultFileAccessor: FileAccessorProviding {
    public init() {}

    public func read(from url: URL) throws -> Data {
        try Data(contentsOf: url)
    }

    public func write(_ data: Data, to url: URL) throws {
        try data.write(to: url, options: .atomic)
    }

    public func fileExists(at url: URL) -> Bool {
        FileManager.default.fileExists(atPath: url.path)
    }
}

3. テスト用のモック実装を作成する

public final class MockFileAccessor: FileAccessorProviding, @unchecked Sendable {
    public var files: [URL: Data] = [:]
    public var readError: Error?
    public var writeError: Error?

    public init() {}

    public func read(from url: URL) throws -> Data {
        if let error = readError { throw error }
        guard let data = files[url] else {
            throw CocoaError(.fileReadNoSuchFile)
        }
        return data
    }

    public func write(_ data: Data, to url: URL) throws {
        if let error = writeError { throw error }
        files[url] = data
    }

    public func fileExists(at url: URL) -> Bool {
        files[url] != nil
    }
}

4. デフォルトパラメータを使用して依存関係を注入する

本番コードはデフォルトを使用し、テストはモックを注入します。

public actor SyncManager {
    private let fileSystem: FileSystemProviding
    private let fileAccessor: FileAccessorProviding

    public init(
        fileSystem: FileSystemProviding = DefaultFileSystemProvider(),
        fileAccessor: FileAccessorProviding = DefaultFileAccessor()
    ) {
        self.fileSystem = fileSystem
        self.fileAccessor = fileAccessor
    }

    public func sync() async throws {
        guard let containerURL = fileSystem.containerURL(for: .sync) else {
            throw SyncError.containerNotAvailable
        }
        let data = try fileAccessor.read(
            from: containerURL.appendingPathComponent("data.json")
        )
        // データを処理...
    }
}

5. Swift Testing でテストを記述する

import Testing

@Test("同期マネージャはコンテナがない場合を処理する")
func testMissingContainer() async {
    let mockFileSystem = MockFileSystemProvider(containerURL: nil)
    let manager = SyncManager(fileSystem: mockFileSystem)

    await #expect(throws: SyncError.containerNotAvailable) {
        try await manager.sync()
    }
}

@Test("同期マネージャはデータを正しく読み取る")
func testReadData() async throws {
    let mockFileAccessor = MockFileAccessor()
    mockFileAccessor.files[testURL] = testData

    let manager = SyncManager(fileAccessor: mockFileAccessor)
    let result = try await manager.loadData()

    #expect(result == expectedData)
}

@Test("同期マネージャは読み取りエラーを適切に処理する")
func testReadError() async {
    let mockFileAccessor = MockFileAccessor()
    mockFileAccessor.readError = CocoaError(.fileReadCorruptFile)

    let manager = SyncManager(fileAccessor: mockFileAccessor)

    await #expect(throws: SyncError.self) {
        try await manager.sync()
    }
}

ベストプラクティス

• 単一責任: 各プロトコルは 1 つの懸念事項を処理するようにしてください。「神プロトコル」を作成しないでください。
• Sendable 準拠: プロトコルがアクター境界を越えて使用される場合に必要です。
• デフォルトパラメータ: 本番コードはデフォルトで実際の実装を使用させ、テストのみがモックを指定するようにします。
• エラーシミュレーション: 失敗パスをテストするために、設定可能なエラープロパティを持つモックを設計します。
• 境界のみをモック化する: 外部依存関係（ファイルシステム、ネットワーク、API）のみをモック化し、内部型はモック化しません。

避けるべきアンチパターン

• すべての外部アクセスをカバーする単一の巨大なプロトコルを作成すること
• 外部依存関係のない内部型をモック化すること
• 適切な依存性注入の代わりに #if DEBUG 条件文を使用すること
• アクターで使用する場合に Sendable 準拠を忘れること
• 過剰エンジニアリング: 型に外部依存関係がない場合、プロトコルは必要ありません

使用すべきタイミング

• ファイルシステム、ネットワーク、または外部 API に触れる Swift コード
• 実際の環境ではトリガーが難しいエラーハンドリングパスをテストする場合
• アプリ、テスト、SwiftUI プレビューのコンテキストで動作する必要があるモジュールを構築する場合
• テスト可能なアーキテクチャを必要とする Swift Concurrency（アクター、構造化並行性）を使用するアプリ