Skip to content

Make expect for async closures take in Sendable closures #1070

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
younata merged 1 commit into from
Jul 29, 2023
Merged

Make expect for async closures take in Sendable closures #1070

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions Sources/Nimble/DSL+AsyncAwait.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import Dispatch
#endif

/// Make an ``AsyncExpectation`` on a given actual value. The value given is lazily evaluated.
public func expect<T>(file: FileString = #file, line: UInt = #line, _ expression: @escaping () async throws -> T?) -> AsyncExpectation<T> {
public func expect<T>(file: FileString = #file, line: UInt = #line, _ expression: @escaping @Sendable () async throws -> T?) -> AsyncExpectation<T> {
return AsyncExpectation(
expression: AsyncExpression(
expression: expression,
Expand All @@ -12,7 +12,7 @@ public func expect<T>(file: FileString = #file, line: UInt = #line, _ expression
}

/// Make an ``AsyncExpectation`` on a given actual value. The closure is lazily invoked.
public func expect<T>(file: FileString = #file, line: UInt = #line, _ expression: () -> (() async throws -> T)) -> AsyncExpectation<T> {
public func expect<T>(file: FileString = #file, line: UInt = #line, _ expression: @Sendable () -> (@Sendable () async throws -> T)) -> AsyncExpectation<T> {
return AsyncExpectation(
expression: AsyncExpression(
expression: expression(),
Expand All @@ -21,7 +21,7 @@ public func expect<T>(file: FileString = #file, line: UInt = #line, _ expression
}

/// Make an ``AsyncExpectation`` on a given actual value. The closure is lazily invoked.
public func expect<T>(file: FileString = #file, line: UInt = #line, _ expression: () -> (() async throws -> T?)) -> AsyncExpectation<T> {
public func expect<T>(file: FileString = #file, line: UInt = #line, _ expression: @Sendable () -> (@Sendable () async throws -> T?)) -> AsyncExpectation<T> {
return AsyncExpectation(
expression: AsyncExpression(
expression: expression(),
Expand All @@ -30,7 +30,7 @@ public func expect<T>(file: FileString = #file, line: UInt = #line, _ expression
}

/// Make an ``AsyncExpectation`` on a given actual value. The closure is lazily invoked.
public func expect(file: FileString = #file, line: UInt = #line, _ expression: () -> (() async throws -> Void)) -> AsyncExpectation<Void> {
public func expect(file: FileString = #file, line: UInt = #line, _ expression: @Sendable () -> (@Sendable () async throws -> Void)) -> AsyncExpectation<Void> {
return AsyncExpectation(
expression: AsyncExpression(
expression: expression(),
Expand All @@ -40,7 +40,7 @@ public func expect(file: FileString = #file, line: UInt = #line, _ expression: (

/// Make an ``AsyncExpectation`` on a given actual value. The value given is lazily evaluated.
/// This is provided to avoid confusion between `expect -> SyncExpectation` and `expect -> AsyncExpectation`.
public func expecta<T>(file: FileString = #file, line: UInt = #line, _ expression: @autoclosure @escaping () async throws -> T?) async -> AsyncExpectation<T> {
public func expecta<T>(file: FileString = #file, line: UInt = #line, _ expression: @autoclosure @escaping @Sendable () async throws -> T?) async -> AsyncExpectation<T> {
return AsyncExpectation(
expression: AsyncExpression(
expression: expression,
Expand All @@ -50,7 +50,7 @@ public func expecta<T>(file: FileString = #file, line: UInt = #line, _ expressio

/// Make an ``AsyncExpectation`` on a given actual value. The closure is lazily invoked.
/// This is provided to avoid confusion between `expect -> SyncExpectation` and `expect -> AsyncExpectation`
public func expecta<T>(file: FileString = #file, line: UInt = #line, _ expression: @autoclosure () -> (() async throws -> T)) async -> AsyncExpectation<T> {
public func expecta<T>(file: FileString = #file, line: UInt = #line, _ expression: @autoclosure @Sendable () -> (@Sendable () async throws -> T)) async -> AsyncExpectation<T> {
return AsyncExpectation(
expression: AsyncExpression(
expression: expression(),
Expand All @@ -60,7 +60,7 @@ public func expecta<T>(file: FileString = #file, line: UInt = #line, _ expressio

/// Make an ``AsyncExpectation`` on a given actual value. The closure is lazily invoked.
/// This is provided to avoid confusion between `expect -> SyncExpectation` and `expect -> AsyncExpectation`
public func expecta<T>(file: FileString = #file, line: UInt = #line, _ expression: @autoclosure () -> (() async throws -> T?)) async -> AsyncExpectation<T> {
public func expecta<T>(file: FileString = #file, line: UInt = #line, _ expression: @autoclosure @Sendable () -> (@Sendable () async throws -> T?)) async -> AsyncExpectation<T> {
return AsyncExpectation(
expression: AsyncExpression(
expression: expression(),
Expand All @@ -70,7 +70,7 @@ public func expecta<T>(file: FileString = #file, line: UInt = #line, _ expressio

/// Make an ``AsyncExpectation`` on a given actual value. The closure is lazily invoked.
/// This is provided to avoid confusion between `expect -> SyncExpectation` and `expect -> AsyncExpectation`
public func expecta(file: FileString = #file, line: UInt = #line, _ expression: @autoclosure () -> (() async throws -> Void)) async -> AsyncExpectation<Void> {
public func expecta(file: FileString = #file, line: UInt = #line, _ expression: @autoclosure @Sendable () -> (@Sendable () async throws -> Void)) async -> AsyncExpectation<Void> {
return AsyncExpectation(
expression: AsyncExpression(
expression: expression(),
Expand Down
6 changes: 3 additions & 3 deletions Tests/NimbleTests/AsyncAwaitTest.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import NimbleSharedTestHelpers

final class AsyncAwaitTest: XCTestCase {
func testToPositiveMatches() async {
func someAsyncFunction() async throws -> Int {
@Sendable func someAsyncFunction() async throws -> Int {
try await Task.sleep(nanoseconds: 1_000_000) // 1 millisecond
return 1
}
Expand Down Expand Up @@ -119,7 +119,7 @@ final class AsyncAwaitTest: XCTestCase {
func testToEventuallyWithAsyncExpectationDoesNotNecessarilyExecutesExpressionOnMainActor() async {
// This prevents a "Class property 'isMainThread' is unavailable from asynchronous contexts; Work intended for the main actor should be marked with @MainActor; this is an error in Swift 6" warning.
// However, the functionality actually works as you'd expect it to, you're just expected to tag things to use the main actor.
func isMainThread() -> Bool { Thread.isMainThread }
@Sendable func isMainThread() -> Bool { Thread.isMainThread }

await expecta(isMainThread()).toEventually(beFalse())
await expecta(isMainThread()).toEventuallyNot(beTrue())
Expand All @@ -131,7 +131,7 @@ final class AsyncAwaitTest: XCTestCase {
func testToEventuallyWithAsyncExpectationDoesExecuteExpressionOnMainActorWhenTestRunsOnMainActor() async {
// This prevents a "Class property 'isMainThread' is unavailable from asynchronous contexts; Work intended for the main actor should be marked with @MainActor; this is an error in Swift 6" warning.
// However, the functionality actually works as you'd expect it to, you're just expected to tag things to use the main actor.
func isMainThread() -> Bool { Thread.isMainThread }
@Sendable func isMainThread() -> Bool { Thread.isMainThread }

await expecta(isMainThread()).toEventually(beTrue())
await expecta(isMainThread()).toEventuallyNot(beFalse())
Expand Down
2 changes: 1 addition & 1 deletion Tests/NimbleTests/Matchers/AlwaysFailMatcher.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import Nimble
import NimbleSharedTestHelpers
#endif

func alwaysFail<T>() -> Predicate<T> {
func alwaysFail<T>() -> Nimble.Predicate<T> {
return Predicate { _ throws -> PredicateResult in
return PredicateResult(status: .fail, message: .fail("This matcher should always fail"))
}
Expand Down
10 changes: 5 additions & 5 deletions Tests/NimbleTests/Matchers/EqualTest.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ final class EqualTest: XCTestCase { // swiftlint:disable:this type_body_length
expect(originalArray) != expectedArray.reversed()
expect(originalArray) != []

let originalArrayAsync = { () async in originalArray }
let originalArrayAsync = { @Sendable () async in originalArray }
await expect(originalArrayAsync).toEventually(equal(expectedArray))
await expect(originalArrayAsync).toEventuallyNot(equal(expectedArray.reversed()))
await expect(originalArrayAsync).toEventuallyNot(equal([]))
Expand Down Expand Up @@ -346,7 +346,7 @@ final class EqualTest: XCTestCase { // swiftlint:disable:this type_body_length
expect(originalArray) != expectedArray.reversed()
expect(originalArray) != []

let originalArrayAsync = { () async in originalArray }
let originalArrayAsync = { @Sendable () async in originalArray }
await expect(originalArrayAsync).toEventually(equal(expectedArray))
await expect(originalArrayAsync).toEventuallyNot(equal(expectedArray.reversed()))
await expect(originalArrayAsync).toEventuallyNot(equal([]))
Expand Down Expand Up @@ -379,7 +379,7 @@ final class EqualTest: XCTestCase { // swiftlint:disable:this type_body_length
expect(originalArray) != expectedArray.reversed()
expect(originalArray) != []

let originalArrayAsync = { () async in originalArray }
let originalArrayAsync = { @Sendable () async in originalArray }
await expect(originalArrayAsync).toEventually(equal(expectedArray))
await expect(originalArrayAsync).toEventuallyNot(equal(expectedArray.reversed()))
await expect(originalArrayAsync).toEventuallyNot(equal([]))
Expand Down Expand Up @@ -412,7 +412,7 @@ final class EqualTest: XCTestCase { // swiftlint:disable:this type_body_length
expect(originalArray) != expectedArray.reversed()
expect(originalArray) != []

let originalArrayAsync = { () async in originalArray }
let originalArrayAsync = { @Sendable () async in originalArray }
await expect(originalArrayAsync).toEventually(equal(expectedArray))
await expect(originalArrayAsync).toEventuallyNot(equal(expectedArray.reversed()))
await expect(originalArrayAsync).toEventuallyNot(equal([]))
Expand Down Expand Up @@ -445,7 +445,7 @@ final class EqualTest: XCTestCase { // swiftlint:disable:this type_body_length
expect(originalArray) != expectedArray.reversed()
expect(originalArray) != []

let originalArrayAsync = { () async in originalArray }
let originalArrayAsync = { @Sendable () async in originalArray }
await expect(originalArrayAsync).toEventually(equal(expectedArray))
await expect(originalArrayAsync).toEventuallyNot(equal(expectedArray.reversed()))
await expect(originalArrayAsync).toEventuallyNot(equal([]))
Expand Down