filozoff/xctestextension

Example usage

Work with structured concurrency

It may happen that async operations don't return a value or don't throw any error (e.g. when converting from closures or Combine). In that case, they will hang out for infinity. The XCTTimeout) catches that issue and throws an error, unblocking the hanging async task.

func test_whenGetDetails_thenReceivedExpectedDetails() {

    (...)

    // when
    let details = try await XCTTimeout(
        await sut.getDetails(),
        timeout: 0.01
    )

    // then
    XCTAssertEqual(details, expectedDetails)
}

Work with Combine's Publisher and expectation

Use PublisherExpectation to simplify work with Publisher's streams and avoid boilerplate code.

As an example, for a stream value observation, use receivedValue(predicate:). To expect a specific value received from the stream, set the predicate parameter to:

predicate: { $0 == expectedValue }

A complete code example is below:

func test_givenValue_whenPublisherSend_thenReceivedExpectedValueInStream() {

    // given
    let value = "charizard"
    let expectedValue = value
    let sut = PassthroughSubject<String, Error>()
    let expectation = PublisherExpectation(
        sut,
        observation: .receivedValue(
            predicate: { $0 == expectedValue }
        ),
        description : "Publisher did not receive expected value \(expectedValue)"
    )

    // when
    sut.send(value)

    // then
    wait(for: [expectation], timeout: 0.01)
}

Use .anyReceived() convenience method where the value received from the stream does not matter.

For stream termination expectation, use .completion(predicate:) or .anyCompletion().

Additional assertions

XCTAssertEqual does not provide a readable output for not equal values. Use XCTAssertNoDiff to receive a readable diff.

XCTAssertNoDiff relies on Difference created by Krzysztof Zabłocki.

Documentation

Documentation is generated by DocC.

Getting started can be found here.

Full documentation can be found here.

Requirements

| Item | Minimum tool version | | --- | --- | | Swift | 5.8 | | Xcode | 14.3 |

| Item | Minimum target version | | --- | --- | | iOS | 13.0 | | macOS | 10.15 | | watchOS | 6.0 | | tvOS | 13.0 |

Installation

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler.

Once you have your Swift package set up, add XCTestExtension as a dependency to your Package.swift:

dependencies: [
    .package(url: "https://github.com/Filozoff/XCTestExtension.git", branch: "master")
]

and add it to you testTarget's dependencies:

targets: [
    (...)
    .testTarget(
        (...)
        dependencies: [
            (...)
            "XCTestExtension"
        ]
    )
]

Xcode project (Swift Package Manager)

1. Go to File->Add Packages...
2. Paste https://github.com/Filozoff/XCTestExtension.git in "Search or Enter Package URL"
3. Choose Dependency Rule and Project suited to you needs and go to Add Package
4. Choose your test target under Add to Target and go to Add Package

Package Metadata

Repository: filozoff/xctestextension

Default branch: master

README: README.md