AutoMockable

KO | EN

gitlite — search

#python #hacktoberfest #go #golang #android #machine-learning #deep-learning #docker #windows #kubernetes #awesome-list #vue #pytorch #ios

(★ 17)

Code Generate Swift Mocks with Sourcery

AutoMockable 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## Articles related to this project

- [Code Generating Swift Mocks with Sourcery](https://www.vadimbulavin.com/mocking-in-swift-using-sourcery/)
- [Unit Testing Asynchronous Code in Swift](https://www.vadimbulavin.com/unit-testing-async-code-in-swift/)

---

# AutoMockable

The project demonstrates how to code generate Swift mocks using [Sourcery](https://github.com/krzysztofzablocki/Sourcery).

### Usage

Annotate the protocol you want to mock:

```swift
//sourcery: AutoMockable
protocol HTTPClient {
    func execute(
        request: URLRequest,
        completion: @escaping (Result<Data, Error>) -> Void
    )
}
```

Then build your Xcode project test target. During the build phase, Sourcery will generate `HTTPClient+AutoMockable.generated.swift` that is ready for use in your tests.

### Sample test

Given `CurrenciesAPIService` that we want to test:

```swift
final class CurrenciesAPIService {
    private let httpClient: HTTPClient

init(httpClient: HTTPClient) {
        self.httpClient = httpClient
    }

func allCurrencies(completion: @escaping (Result<[CurrencyDTO], Error>) -> Void) {
        httpClient.execute(request: .allCurrencies()) { result in
            completion(
                result.flatMap { data in Result { try JSONDecoder().decode([CurrencyDTO].self, from: data) }}
            )
        }
    }
}
```

And a generated `HTTPClientMock`:

```swift
// Generated using Sourcery 1.3.2 — https://github.com/krzysztofzablocki/Sourcery
// DO NOT EDIT
// swiftlint:disable all

import UIKit
@testable import AutoMockable

class HTTPClientMock: HTTPClient {

//MARK: - execute

var executeRequestCompletionCallsCount = 0
    var executeRequestCompletionCalled: Bool {
        return executeRequestCompletionCallsCount > 0
    }
    var executeRequestCompletionReceivedArguments: (request: URLRequest, completion: (Result<Data, Error>) -> Void)?
    var executeRequestCompletionReceivedInvocations: [(request: URLRequest, completion: (Result<Data, Error>) -> Void)] = []
    var executeRequestCompletionClosure: ((URLRequest, @escaping (Result<Data, Error>) -> Void) -> Void)?

func execute(request: URLRequest, completion: @escaping (Result<Data, Error>) -> Void) {
        executeRequestCompletionCallsCount += 1
        executeRequestCompletionReceivedArguments = (request: request, completion: completion)
        executeRequestCompletionReceivedInvocations.append((request: request, completion: completion))
        executeRequestCompletionClosure?(request, completion)
    }

}
```

The next test verifies that `CurrenciesAPIService` correctly handles malformed data in response:

```swift
import Foundation
import XCTest
@testable import AutoMockable

class CurrenciesAPIServiceTests: XCTestCase {

let httpClient = HTTPClientMock()
    lazy var sut = CurrenciesAPIService(httpClient: httpClient)

func test_allCurrencies_withMalformedData_returnsError() throws {
        httpClient.executeRequestCompletionClosure = { _, completion in
            completion(.success(Data())) // <--- Stub malformed data
        }

var result: Result<[CurrencyDTO], Error>?

sut.allCurrencies { result = $0 }

XCTAssertThrowsError(try result?.get())
    }
}
```

Verify `CurrenciesAPIService` correctly parses a response with valid payload:

```swift
class CurrenciesAPIServiceTests: XCTestCase {
    ...

func test_allCurrencies_withResponseSuccess_returnsValidData() throws {
        let expected = CurrencyDTO(
            currencyCode: "A",
            country: "B",
            currencyName: "C",
            countryCode: "D"
        )
        let data = try JSONEncoder().encode([expected])
        httpClient.executeRequestCompletionClosure = { _, completion in
            completion(.success(data)) // <--- Stub valid data
        }

var result: Result<[CurrencyDTO], Error>?

sut.allCurrencies { result = $0 }

XCTAssertEqual(try result?.get(), [expected])
    }
}
```

AutoMockable

AutoMockable 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

AutoMockable

AutoMockable 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README