Nimble Next

Nimble.xcodeproj/project.pbxproj

@@ -139,6 +139,7 @@
 		895644DF2C1B71DE0006EC12 /* SwiftTestingSupportTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 895644DE2C1B71DE0006EC12 /* SwiftTestingSupportTest.swift */; };
 		896962412A5FABD000A7929D /* AsyncAllPass.swift in Sources */ = {isa = PBXBuildFile; fileRef = 896962402A5FABD000A7929D /* AsyncAllPass.swift */; };
 		8969624A2A5FAD5F00A7929D /* AsyncAllPassTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 896962452A5FAD4500A7929D /* AsyncAllPassTest.swift */; };
+		897F84F42BA922B500BF354B /* NSLocking+Nimble.swift in Sources */ = {isa = PBXBuildFile; fileRef = 897F84F32BA922B500BF354B /* NSLocking+Nimble.swift */; };
 		898F28B025D9F4C30052B8D0 /* AlwaysFailMatcher.swift in Sources */ = {isa = PBXBuildFile; fileRef = 898F28AF25D9F4C30052B8D0 /* AlwaysFailMatcher.swift */; };
 		899441EF2902EE4B00C1FAF9 /* AsyncAwaitTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 899441EE2902EE4B00C1FAF9 /* AsyncAwaitTest.swift */; };
 		899441F82902EF2500C1FAF9 /* DSL+AsyncAwait.swift in Sources */ = {isa = PBXBuildFile; fileRef = 899441F32902EF0900C1FAF9 /* DSL+AsyncAwait.swift */; };
@@ -149,6 +150,7 @@
 		89D8AC852B3211C600410644 /* CwlCatchException in Frameworks */ = {isa = PBXBuildFile; productRef = 89D8AC842B3211C600410644 /* CwlCatchException */; };
 		89D8AC872B3211EA00410644 /* CwlPosixPreconditionTesting in Frameworks */ = {isa = PBXBuildFile; platformFilters = (tvos, watchos, ); productRef = 89D8AC862B3211EA00410644 /* CwlPosixPreconditionTesting */; };
 		89D8AC892B3211EA00410644 /* CwlPreconditionTesting in Frameworks */ = {isa = PBXBuildFile; platformFilters = (driverkit, ios, maccatalyst, macos, xros, ); productRef = 89D8AC882B3211EA00410644 /* CwlPreconditionTesting */; };
+		89E5E1682BC78724002D54ED /* LockedContainer.swift in Sources */ = {isa = PBXBuildFile; fileRef = 89E5E1672BC78724002D54ED /* LockedContainer.swift */; };
 		89EEF5A52A03293100988224 /* AsyncMatcher.swift in Sources */ = {isa = PBXBuildFile; fileRef = 89EEF5A42A03293100988224 /* AsyncMatcher.swift */; };
 		89EEF5B72A032C3200988224 /* AsyncPredicateTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 89EEF5B22A032C2500988224 /* AsyncPredicateTest.swift */; };
 		89EEF5C02A06211C00988224 /* AsyncHelpers.swift in Sources */ = {isa = PBXBuildFile; fileRef = 89EEF5BB2A06210D00988224 /* AsyncHelpers.swift */; };
@@ -330,13 +332,15 @@
 		895644DE2C1B71DE0006EC12 /* SwiftTestingSupportTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SwiftTestingSupportTest.swift; sourceTree = "<group>"; };
 		896962402A5FABD000A7929D /* AsyncAllPass.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AsyncAllPass.swift; sourceTree = "<group>"; };
 		896962452A5FAD4500A7929D /* AsyncAllPassTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AsyncAllPassTest.swift; sourceTree = "<group>"; };
+		897F84F32BA922B500BF354B /* NSLocking+Nimble.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "NSLocking+Nimble.swift"; sourceTree = "<group>"; };
 		898F28AF25D9F4C30052B8D0 /* AlwaysFailMatcher.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AlwaysFailMatcher.swift; sourceTree = "<group>"; };
 		899441EE2902EE4B00C1FAF9 /* AsyncAwaitTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AsyncAwaitTest.swift; sourceTree = "<group>"; };
 		899441F32902EF0900C1FAF9 /* DSL+AsyncAwait.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "DSL+AsyncAwait.swift"; sourceTree = "<group>"; };
 		89B8C60E2C6476A6001F12D3 /* Negation.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Negation.swift; sourceTree = "<group>"; };
 		89B8C6102C6478F2001F12D3 /* NegationTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NegationTest.swift; sourceTree = "<group>"; };
 		89C297CB2A911CDA002A143F /* AsyncTimerSequenceTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AsyncTimerSequenceTest.swift; sourceTree = "<group>"; };
 		89C297CD2A92AB34002A143F /* AsyncPromiseTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AsyncPromiseTest.swift; sourceTree = "<group>"; };
+		89E5E1672BC78724002D54ED /* LockedContainer.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LockedContainer.swift; sourceTree = "<group>"; };
 		89EEF5A42A03293100988224 /* AsyncMatcher.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AsyncMatcher.swift; sourceTree = "<group>"; };
 		89EEF5B22A032C2500988224 /* AsyncPredicateTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AsyncPredicateTest.swift; sourceTree = "<group>"; };
 		89EEF5BB2A06210D00988224 /* AsyncHelpers.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AsyncHelpers.swift; sourceTree = "<group>"; };
@@ -624,12 +628,14 @@
 			isa = PBXGroup;
 			children = (
 				1FD8CD261968AB07008ED995 /* PollAwait.swift */,
+				897F84F32BA922B500BF354B /* NSLocking+Nimble.swift */,
 				89F5E08B290B8D22001F9377 /* AsyncAwait.swift */,
 				891A04702AB0164500B46613 /* AsyncTimerSequence.swift */,
 				1FD8CD271968AB07008ED995 /* SourceLocation.swift */,
 				1FD8CD281968AB07008ED995 /* Stringers.swift */,
 				AE4BA9AC1C88DDB500B73906 /* Errors.swift */,
 				0477153423B740AD00402D4E /* NimbleTimeInterval.swift */,
+				89E5E1672BC78724002D54ED /* LockedContainer.swift */,
 			);
 			path = Utils;
 			sourceTree = "<group>";
@@ -864,6 +870,7 @@
 				1F1871D91CA89EF100A34BF2 /* NMBExpectation.swift in Sources */,
 				DA9E8C831A414BB9002633C2 /* DSL+Wait.swift in Sources */,
 				DDB1BC7A1A92235600F743C3 /* AllPass.swift in Sources */,
+				89E5E1682BC78724002D54ED /* LockedContainer.swift in Sources */,
 				1FD8CD3F1968AB07008ED995 /* BeAKindOf.swift in Sources */,
 				1FD8CD2F1968AB07008ED995 /* AssertionRecorder.swift in Sources */,
 				7B13BA061DD360AA00C9098C /* ContainElementSatisfying.swift in Sources */,
@@ -892,6 +899,7 @@
 				1FD8CD571968AB07008ED995 /* Contain.swift in Sources */,
 				7A0A26231E7F52360092A34E /* ToSucceed.swift in Sources */,
 				89F5E0862908E655001F9377 /* Polling+AsyncAwait.swift in Sources */,
+				897F84F42BA922B500BF354B /* NSLocking+Nimble.swift in Sources */,
 				899441F82902EF2500C1FAF9 /* DSL+AsyncAwait.swift in Sources */,
 				1FD8CD491968AB07008ED995 /* BeGreaterThanOrEqualTo.swift in Sources */,
 				1FE661571E6574E30035F243 /* ExpectationMessage.swift in Sources */,

Sources/Nimble/Adapters/AdapterProtocols.swift

@@ -1,5 +1,5 @@
 /// Protocol for the assertion handler that Nimble uses for all expectations.
-public protocol AssertionHandler {
+public protocol AssertionHandler: Sendable {
     func assert(_ assertion: Bool, message: FailureMessage, location: SourceLocation)
 }
 
@@ -10,11 +10,21 @@ public protocol AssertionHandler {
 /// before using any matchers, otherwise Nimble will abort the program.
 ///
 /// @see AssertionHandler
-public var NimbleAssertionHandler: AssertionHandler = { () -> AssertionHandler in
+public var NimbleAssertionHandler: AssertionHandler {
+    // swiftlint:disable:previous identifier_name
+    get {
+        _NimbleAssertionHandler.value
+    }
+    set {
+        _NimbleAssertionHandler.set(newValue)
+    }
+}
+
+private let _NimbleAssertionHandler = LockedContainer<AssertionHandler> {
     // swiftlint:disable:previous identifier_name
     if isSwiftTestingAvailable() || isXCTestAvailable() {
         return NimbleTestingHandler()
     }
 
     return NimbleTestingUnavailableHandler()
-}()
+}

Sources/Nimble/Adapters/AssertionDispatcher.swift

@@ -4,7 +4,7 @@
 /// @warning Does not fully dispatch if one of the handlers raises an exception.
 ///          This is possible with XCTest-based assertion handlers.
 ///
-public class AssertionDispatcher: AssertionHandler {
+public final class AssertionDispatcher: AssertionHandler {
     let handlers: [AssertionHandler]
 
     public init(handlers: [AssertionHandler]) {

Sources/Nimble/Adapters/AssertionRecorder+Async.swift

@@ -8,10 +8,7 @@
 ///
 /// @see AssertionHandler
 public func withAssertionHandler(_ tempAssertionHandler: AssertionHandler,
-                                 fileID: String = #fileID,
-                                 file: FileString = #filePath,
-                                 line: UInt = #line,
-                                 column: UInt = #column,
+                                 location: SourceLocation = SourceLocation(),
                                  closure: () async throws -> Void) async {
     let environment = NimbleEnvironment.activeInstance
     let oldRecorder = environment.assertionHandler
@@ -27,7 +24,6 @@ public func withAssertionHandler(_ tempAssertionHandler: AssertionHandler,
     } catch {
         let failureMessage = FailureMessage()
         failureMessage.stringValue = "unexpected error thrown: <\(error)>"
-        let location = SourceLocation(fileID: fileID, filePath: file, line: line, column: column)
         tempAssertionHandler.assert(false, message: failureMessage, location: location)
     }
 }

Sources/Nimble/Adapters/AssertionRecorder.swift

@@ -3,7 +3,7 @@
 ///
 /// @see AssertionRecorder
 /// @see AssertionHandler
-public struct AssertionRecord: CustomStringConvertible {
+public struct AssertionRecord: CustomStringConvertible, Sendable {
     /// Whether the assertion succeeded or failed
     public let success: Bool
     /// The failure message the assertion would display on failure.
@@ -20,9 +20,17 @@ public struct AssertionRecord: CustomStringConvertible {
 /// This is useful for testing failure messages for matchers.
 ///
 /// @see AssertionHandler
-public class AssertionRecorder: AssertionHandler {
+public final class AssertionRecorder: AssertionHandler {
     /// All the assertions that were captured by this recorder
-    public var assertions = [AssertionRecord]()
+    public var assertions: [AssertionRecord] {
+        get {
+            _assertion.value
+        }
+        set {
+            _assertion.set(newValue)
+        }
+    }
+    private let _assertion = LockedContainer([AssertionRecord]())
 
     public init() {}
 
@@ -63,10 +71,7 @@ extension NMBExceptionCapture {
 ///
 /// @see AssertionHandler
 public func withAssertionHandler(_ tempAssertionHandler: AssertionHandler,
-                                 fileID: String = #fileID,
-                                 file: FileString = #filePath,
-                                 line: UInt = #line,
-                                 column: UInt = #column,
+                                 location: SourceLocation = SourceLocation(),
                                  closure: () throws -> Void) {
     let environment = NimbleEnvironment.activeInstance
     let oldRecorder = environment.assertionHandler
@@ -84,11 +89,6 @@ public func withAssertionHandler(_ tempAssertionHandler: AssertionHandler,
     } catch {
         let failureMessage = FailureMessage()
         failureMessage.stringValue = "unexpected error thrown: <\(error)>"
-        let location = SourceLocation(
-            fileID: fileID,
-            filePath: file,
-            line: line, column: column
-        )
         tempAssertionHandler.assert(false, message: failureMessage, location: location)
     }
 }

Sources/Nimble/Adapters/NMBExpectation.swift

@@ -13,27 +13,42 @@
 }
 
 // Equivalent to Expectation, but for Nimble's Objective-C interface
-public class NMBExpectation: NSObject {
-    internal let _actualBlock: () -> NSObject?
-    internal var _negative: Bool
+public final class NMBExpectation: NSObject, Sendable {
+    internal let _actualBlock: @Sendable () -> NSObject?
+    internal let _negative: Bool
     internal let _file: FileString
     internal let _line: UInt
-    internal var _timeout: NimbleTimeInterval = .seconds(1)
+    internal let _timeout: NimbleTimeInterval
 
-    @objc public init(actualBlock: @escaping () -> NSObject?, negative: Bool, file: FileString, line: UInt) {
+    @objc public init(actualBlock: @escaping @Sendable () -> NSObject?, negative: Bool, file: FileString, line: UInt) {
         self._actualBlock = actualBlock
         self._negative = negative
         self._file = file
         self._line = line
+        self._timeout = .seconds(1)
+    }
+
+    private init(actualBlock: @escaping @Sendable () -> NSObject?, negative: Bool, file: FileString, line: UInt, timeout: NimbleTimeInterval) {
+        self._actualBlock = actualBlock
+        self._negative = negative
+        self._file = file
+        self._line = line
+        self._timeout = timeout
     }
 
     private var expectValue: SyncExpectation<NSObject> {
-        return expect(file: _file, line: _line, self._actualBlock() as NSObject?)
+        return expect(location: SourceLocation(fileID: "unknown/\(_file)", filePath: _file, line: _line, column: 0), self._actualBlock() as NSObject?)
     }
 
     @objc public var withTimeout: (TimeInterval) -> NMBExpectation {
-        return { timeout in self._timeout = timeout.nimbleInterval
-            return self
+        return { timeout in
+            NMBExpectation(
+                actualBlock: self._actualBlock,
+                negative: self._negative,
+                file: self._file,
+                line: self._line,
+                timeout: timeout.nimbleInterval
+            )
         }
     }
 
@@ -173,7 +188,7 @@
         return toAlwaysWithDescription
     }
 
     @objc public class func failWithMessage(_ message: String, file: FileString, line: UInt) {
         fail(message, location: SourceLocation(fileID: "Unknown/\(file)", filePath: file, line: line, column: 0))
     }
 }

Sources/Nimble/Adapters/NimbleSwiftTestingHandler.swift

@@ -7,7 +7,7 @@ import Foundation
 @_implementationOnly import Testing
 #endif
 
-public class NimbleSwiftTestingHandler: AssertionHandler {
+public struct NimbleSwiftTestingHandler: AssertionHandler {
     public func assert(_ assertion: Bool, message: FailureMessage, location: SourceLocation) {
         if !assertion {
             recordTestingFailure("\(message.stringValue)\n", location: location)

Sources/Nimble/Adapters/NimbleXCTestHandler.swift

@@ -2,7 +2,7 @@ import Foundation
 import XCTest
 
 /// Default handler for Nimble. This assertion handler passes on to Swift Testing or XCTest.
-public class NimbleTestingHandler: AssertionHandler {
+public struct NimbleTestingHandler: AssertionHandler {
     public func assert(_ assertion: Bool, message: FailureMessage, location: SourceLocation) {
         if isRunningSwiftTest() {
             NimbleSwiftTestingHandler().assert(assertion, message: message, location: location)
@@ -13,7 +13,7 @@ public class NimbleTestingHandler: AssertionHandler {
 }
 
 /// This assertion handler passes failures along to XCTest.
-public class NimbleXCTestHandler: AssertionHandler {
+public struct NimbleXCTestHandler: AssertionHandler {
     public func assert(_ assertion: Bool, message: FailureMessage, location: SourceLocation) {
         if !assertion {
             recordFailure("\(message.stringValue)\n", location: location)
@@ -23,7 +23,7 @@ public class NimbleXCTestHandler: AssertionHandler {
 
 /// Alternative handler for Nimble. This assertion handler passes failures along
 /// to XCTest by attempting to reduce the failure message size.
-public class NimbleShortXCTestHandler: AssertionHandler {
+public struct NimbleShortXCTestHandler: AssertionHandler {
     public func assert(_ assertion: Bool, message: FailureMessage, location: SourceLocation) {
         if !assertion {
             let msg: String
@@ -39,32 +39,45 @@ public class NimbleShortXCTestHandler: AssertionHandler {
 
 /// Fallback handler in case XCTest/Swift Testing is unavailable. This assertion handler will abort
 /// the program if it is invoked.
-class NimbleTestingUnavailableHandler: AssertionHandler {
+struct NimbleTestingUnavailableHandler: AssertionHandler {
     func assert(_ assertion: Bool, message: FailureMessage, location: SourceLocation) {
         fatalError("XCTest and Swift Testing are not available and no custom assertion handler was configured. Aborting.")
     }
 }
 
 #if canImport(Darwin)
 /// Helper class providing access to the currently executing XCTestCase instance, if any
-@objc final public class CurrentTestCaseTracker: NSObject, XCTestObservation {
+@objc final public class CurrentTestCaseTracker: NSObject, XCTestObservation, @unchecked Sendable {
     @objc public static let sharedInstance = CurrentTestCaseTracker()
 
-    private(set) var currentTestCase: XCTestCase?
+    private let lock = NSRecursiveLock()
+
+    private var _currentTestCase: XCTestCase?
+    var currentTestCase: XCTestCase? {
+        lock.lock()
+        defer { lock.unlock() }
+        return _currentTestCase
+    }
 
     private var stashed_swift_reportFatalErrorsToDebugger: Bool = false
 
     @objc public func testCaseWillStart(_ testCase: XCTestCase) {
+        lock.lock()
+        defer { lock.unlock() }
+
         #if (os(macOS) || os(iOS) || os(visionOS)) && !SWIFT_PACKAGE
         stashed_swift_reportFatalErrorsToDebugger = _swift_reportFatalErrorsToDebugger
         _swift_reportFatalErrorsToDebugger = false
         #endif
 
-        currentTestCase = testCase
+        _currentTestCase = testCase
     }
 
     @objc public func testCaseDidFinish(_ testCase: XCTestCase) {
-        currentTestCase = nil
+        lock.lock()
+        defer { lock.unlock() }
+
+        _currentTestCase = nil
 
         #if (os(macOS) || os(iOS) || os(visionOS)) && !SWIFT_PACKAGE
         _swift_reportFatalErrorsToDebugger = stashed_swift_reportFatalErrorsToDebugger