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（アクター、構造化並行処理）を使用するアプリ