Swift Protocol Di Testing

作者 affaan-mef648e01899b无许可证275K 个星标收录于 2026年10月8日更新于 2026年10月8日仓库3天前更新

Protocol-based dependency injection for testable Swift code — mock file system, network, and external APIs using focused protocols and Swift Testing.

仅含说明Software Development

AI 生成的概览

指导 Swift 开发者使用基于协议的依赖注入，使文件、网络和 API 代码可通过模拟对象进行测试。

功能: 该技能提供在 Swift 中将外部依赖抽象为小型、专注协议的模式。它展示如何定义协议、创建默认生产实现、为测试构建模拟实现，并通过默认参数注入依赖。它还涵盖使用 Swift Testing 编写测试，并列出最佳实践和反模式。
适用场景: 适用于编写访问文件系统、网络或外部 API 的 Swift 代码，并希望在不进行真实 I/O 的情况下获得确定性测试的场景。它也适合测试错误处理路径、为应用、测试和 SwiftUI 预览环境设计模块，或使用 Swift 并发和 actor 时使用。
运行要求: 无需脚本或特殊工具，仅为纯说明性参考。假定读者熟悉 Swift、Swift Testing 以及 Sendable、actor 等 Swift 并发概念。

Swift Protocol-Based Dependency Injection for Testing

Patterns for making Swift code testable by abstracting external dependencies (file system, network, iCloud) behind small, focused protocols. Enables deterministic tests without I/O.

When to Activate

Writing Swift code that accesses file system, network, or external APIs
Need to test error handling paths without triggering real failures
Building modules that work across environments (app, test, SwiftUI preview)
Designing testable architecture with Swift concurrency (actors, Sendable)

Core Pattern

1. Define Small, Focused Protocols

Each protocol handles exactly one external concern.

swift

// File system accesspublic protocol FileSystemProviding: Sendable {    func containerURL(for purpose: Purpose) -> URL?}
// File read/write operationspublic protocol FileAccessorProviding: Sendable {    func read(from url: URL) throws -> Data    func write(_ data: Data, to url: URL) throws    func fileExists(at url: URL) -> Bool}
// Bookmark storage (e.g., for sandboxed apps)public protocol BookmarkStorageProviding: Sendable {    func saveBookmark(_ data: Data, for key: String) throws    func loadBookmark(for key: String) throws -> Data?}

// File system accesspublic protocol FileSystemProviding: Sendable {    func containerURL(for purpose: Purpose) -> URL?}
// File read/write operationspublic protocol FileAccessorProviding: Sendable {    func read(from url: URL) throws -> Data    func write(_ data: Data, to url: URL) throws    func fileExists(at url: URL) -> Bool}
// Bookmark storage (e.g., for sandboxed apps)public protocol BookmarkStorageProviding: Sendable {    func saveBookmark(_ data: Data, for key: String) throws    func loadBookmark(for key: String) throws -> Data?}

2. Create Default (Production) Implementations

swift

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)    }}

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. Create Mock Implementations for Testing

swift

/// NOTE: Not thread-safe. Use only in single-threaded test contexts.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    }}

/// NOTE: Not thread-safe. Use only in single-threaded test contexts.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. Inject Dependencies with Default Parameters

Production code uses defaults; tests inject mocks.

swift

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")        )        // Process data...    }}

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")        )        // Process data...    }}

5. Write Tests with Swift Testing

swift

import Testing
@Test("Sync manager handles missing container")func testMissingContainer() async {    let mockFileSystem = MockFileSystemProvider(containerURL: nil)    let manager = SyncManager(fileSystem: mockFileSystem)
    await #expect(throws: SyncError.containerNotAvailable) {        try await manager.sync()    }}
@Test("Sync manager reads data correctly")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("Sync manager handles read errors gracefully")func testReadError() async {    let mockFileAccessor = MockFileAccessor()    mockFileAccessor.readError = CocoaError(.fileReadCorruptFile)
    let manager = SyncManager(fileAccessor: mockFileAccessor)
    await #expect(throws: SyncError.self) {        try await manager.sync()    }}

import Testing
@Test("Sync manager handles missing container")func testMissingContainer() async {    let mockFileSystem = MockFileSystemProvider(containerURL: nil)    let manager = SyncManager(fileSystem: mockFileSystem)
    await #expect(throws: SyncError.containerNotAvailable) {        try await manager.sync()    }}
@Test("Sync manager reads data correctly")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("Sync manager handles read errors gracefully")func testReadError() async {    let mockFileAccessor = MockFileAccessor()    mockFileAccessor.readError = CocoaError(.fileReadCorruptFile)
    let manager = SyncManager(fileAccessor: mockFileAccessor)
    await #expect(throws: SyncError.self) {        try await manager.sync()    }}

Best Practices

Single Responsibility: Each protocol should handle one concern — don't create "god protocols" with many methods
Sendable conformance: Required when protocols are used across actor boundaries
Default parameters: Let production code use real implementations by default; only tests need to specify mocks
Error simulation: Design mocks with configurable error properties for testing failure paths
Only mock boundaries: Mock external dependencies (file system, network, APIs), not internal types

Anti-Patterns to Avoid

Creating a single large protocol that covers all external access
Mocking internal types that have no external dependencies
Using #if DEBUG conditionals instead of proper dependency injection
Forgetting Sendable conformance when used with actors
Over-engineering: if a type has no external dependencies, it doesn't need a protocol

When to Use

Any Swift code that touches file system, network, or external APIs
Testing error handling paths that are hard to trigger in real environments
Building modules that need to work in app, test, and SwiftUI preview contexts
Apps using Swift concurrency (actors, structured concurrency) that need testable architecture

来源与署名

来源：affaan-m/ecc位于.kiro/skills/swift-protocol-di-testing提交ef648e0

许可证：无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架

Swift Protocol Di Testing

Swift Protocol-Based Dependency Injection for Testing

When to Activate

Core Pattern

1. Define Small, Focused Protocols

2. Create Default (Production) Implementations

3. Create Mock Implementations for Testing

4. Inject Dependencies with Default Parameters

5. Write Tests with Swift Testing

Best Practices

Anti-Patterns to Avoid

When to Use

来源与署名

更多来自 affaan-m/ecc 的技能

Vue Patterns

Uncloud

Team Agent Orchestration

Tasteforge Video

Taste

Social Publisher

更多Software Development技能

Playground

M5 Onboard

Cardputer Buddy

Web Design Guidelines

Vercel React Native Skills

Vercel React Best Practices