element-ios/RiotSwiftUI/Modules/Common/Test/XCTestPublisherExtensions.swift
2021-09-09 17:00:45 +01:00

60 lines
1.8 KiB
Swift

//
// Copyright 2021 New Vector Ltd
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
import XCTest
import Combine
/**
XCTest utility to wait for results from publishers, so that the output can be used for assertions.
```
let collectedEvents = somePublisher.collect(3).first()
XCTAssertEqual(try xcAwait(collectedEvents), [expected, values, here])
```
*/
@available(iOS 14.0, *)
extension XCTestCase {
func xcAwait<T: Publisher>(
_ publisher: T,
timeout: TimeInterval = 10
) throws -> T.Output {
var result: Result<T.Output, Error>?
let expectation = self.expectation(description: "Awaiting publisher")
let cancellable = publisher.sink(
receiveCompletion: { completion in
switch completion {
case .failure(let error):
result = .failure(error)
case .finished:
break
}
expectation.fulfill()
},
receiveValue: { value in
result = .success(value)
}
)
waitForExpectations(timeout: timeout)
cancellable.cancel()
let unwrappedResult = try XCTUnwrap(
result,
"Awaited publisher did not produce any output"
)
return try unwrappedResult.get()
}
}