SWIFT-1609 Async-ifying the Unified Test Runner and underlying operations

.gitignore

@@ -3,3 +3,4 @@
 Package.resolved
 **/xcuserdata/
 .DS_Store
+.swift-version

Sources/MongoSwift/ClientSession.swift

@@ -98,6 +98,9 @@ public final class ClientSession {
         return false
     }
 
+    /// Returns whether or not the `pinnedServerAddress` exists.
+    internal var isPinned: Bool { self.pinnedServerAddress != nil }
+
     /// The client used to start this session.
     public let client: MongoClient
 

Sources/TestsCommon/Failpoint.swift

@@ -0,0 +1,105 @@
+import MongoSwift
+/// Protocol that test cases which configure fail points during their execution conform to.
+public protocol FailPointConfigured {
+    /// The fail point currently set, if one exists.
+    var activeFailPoint: FailPoint? { get set }
+
+    /// The address of the host in which this failpoint was set on, if applicable.
+    var targetedHost: ServerAddress? { get set }
+}
+
+/// Struct modeling a MongoDB fail point.
+///
+/// - Note: if a fail point results in a connection being closed / interrupted, libmongoc built in debug mode will print
+///         a warning.
+public struct FailPoint: Decodable {
+    public var failPoint: BSONDocument
+
+    /// The fail point being configured.
+    public var name: String {
+        self.failPoint["configureFailPoint"]?.stringValue ?? ""
+    }
+
+    private init(_ document: BSONDocument) {
+        self.failPoint = document
+    }
+
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.singleValueContainer()
+        let unordered = try container.decode(BSONDocument.self)
+        guard let command = unordered["configureFailPoint"] else {
+            throw DecodingError.dataCorruptedError(
+                in: container,
+                debugDescription: "fail point \(unordered) did not contain \"configureFailPoint\" command"
+            )
+        }
+        var ordered: BSONDocument = ["configureFailPoint": command]
+        for (k, v) in unordered {
+            guard k != "configureFailPoint" else {
+                continue
+            }
+            ordered[k] = v
+        }
+        self.failPoint = ordered
+    }
+
+    /// Enum representing the options for the "mode" field of a `configureFailPoint` command.
+    public enum Mode {
+        case times(Int)
+        case alwaysOn
+        case off
+        case activationProbability(Double)
+
+        internal func toBSON() -> BSON {
+            switch self {
+            case let .times(i):
+                return ["times": BSON(i)]
+            case let .activationProbability(d):
+                return ["activationProbability": .double(d)]
+            default:
+                return .string(String(describing: self))
+            }
+        }
+    }
+
+    /// Factory function for creating a `failCommand` failpoint.
+    /// Note: enabling a `failCommand` failpoint will override any other `failCommand` failpoint that is currently
+    /// enabled.
+    /// For more information, see the wiki: https://github.com/mongodb/mongo/wiki/The-%22failCommand%22-fail-point
+    public static func failCommand(
+        failCommands: [String],
+        mode: Mode,
+        blockTimeMS: Int? = nil,
+        closeConnection: Bool? = nil,
+        errorCode: Int? = nil,
+        errorLabels: [String]? = nil,
+        writeConcernError: BSONDocument? = nil
+    ) -> FailPoint {
+        var data: BSONDocument = [
+            "failCommands": .array(failCommands.map { .string($0) })
+        ]
+        if let blockTime = blockTimeMS {
+            data["blockTimeMS"] = BSON(blockTime)
+            data["blockConnection"] = true
+        }
+        if let close = closeConnection {
+            data["closeConnection"] = .bool(close)
+        }
+        if let code = errorCode {
+            data["errorCode"] = BSON(code)
+        }
+        if let labels = errorLabels {
+            data["errorLabels"] = .array(labels.map { .string($0) })
+        }
+        if let writeConcernError = writeConcernError {
+            data["writeConcernError"] = .document(writeConcernError)
+        }
+
+        let command: BSONDocument = [
+            "configureFailPoint": "failCommand",
+            "mode": mode.toBSON(),
+            "data": .document(data)
+        ]
+        return FailPoint(command)
+    }
+}

Tests/MongoSwiftSyncTests/ClientSessionTests.swift

@@ -516,16 +516,6 @@ final class SyncClientSessionTests: MongoSwiftTestCase {
         }
     }
 
-    func testSessionsUnified() throws {
-        let tests = try retrieveSpecTestFiles(
-            specName: "sessions",
-            subdirectory: "unified",
-            asType: UnifiedTestFile.self
-        )
-        let runner = try UnifiedTestRunner()
-        try runner.runFiles(tests.map { $0.1 })
-    }
-
     func testSnapshotSessionsProse() throws {
         /// 1. Setting both snapshot and causalConsistency to true is not allowed
         try self.withTestNamespace { client, _, _ in

Tests/MongoSwiftSyncTests/CrudTests.swift

@@ -73,27 +73,6 @@ final class CrudTests: MongoSwiftTestCase {
     func testWrites() throws {
         try self.doTests(forSubdirectory: "v1/write")
     }
-
-    func testCrudUnified() throws {
-        let skipFiles: [String] = [
-            // Skipping because we use bulk-write for these commands and can't pass extra options
-            // TODO: SWIFT-1429 unskip
-            "deleteOne-let.json",
-            "deleteMany-let.json",
-            "updateOne-let.json",
-            "updateMany-let.json",
-            // TODO: SWIFT-1515 unskip
-            "estimatedDocumentCount-comment.json"
-        ]
-        let files = try retrieveSpecTestFiles(
-            specName: "crud",
-            subdirectory: "unified",
-            excludeFiles: skipFiles,
-            asType: UnifiedTestFile.self
-        )
-        let runner = try UnifiedTestRunner()
-        try runner.runFiles(files.map { $0.1 })
-    }
 }
 
 /// A container for the data from a single .json file.

Tests/MongoSwiftSyncTests/MongoDatabaseTests.swift

@@ -138,16 +138,6 @@ final class MongoDatabaseTests: MongoSwiftTestCase {
         expect(collectionInfo[1]).to(equal(expectedView))
     }
 
-    func testCreateCollectionUnified() throws {
-        let tests = try retrieveSpecTestFiles(
-            specName: "collection-management",
-            asType: UnifiedTestFile.self
-        ).map { $0.1 }
-
-        let runner = try UnifiedTestRunner()
-        try runner.runFiles(tests)
-    }
-
     func testListCollections() throws {
         let client = try MongoClient.makeTestClient()
         let monitor = client.addCommandMonitor()

Tests/MongoSwiftSyncTests/RetryableWritesTests.swift

@@ -142,15 +142,4 @@ final class RetryableWritesTests: MongoSwiftTestCase {
             }
         }
     }
-
-    func testRetryableWritesUnified() throws {
-        let tests = try retrieveSpecTestFiles(
-            specName: "retryable-writes",
-            subdirectory: "unified",
-            asType: UnifiedTestFile.self
-        ).map { $0.1 }
-
-        let runner = try UnifiedTestRunner()
-        try runner.runFiles(tests)
-    }
 }

Tests/MongoSwiftSyncTests/SpecTestRunner/FailPoint.swift

@@ -1,15 +1,6 @@
 import MongoSwiftSync
 import TestsCommon
 
-/// Protocol that test cases which configure fail points during their execution conform to.
-internal protocol FailPointConfigured {
-    /// The fail point currently set, if one exists.
-    var activeFailPoint: FailPoint? { get set }
-
-    /// The address of the host in which this failpoint was set on, if applicable.
-    var targetedHost: ServerAddress? { get set }
-}
-
 extension FailPointConfigured {
     /// Sets the active fail point to the provided fail point and enables it.
     internal mutating func activateFailPoint(
@@ -51,37 +42,7 @@ class FailPointGuard {
 ///
 /// - Note: if a fail point results in a connection being closed / interrupted, libmongoc built in debug mode will print
 ///         a warning.
-internal struct FailPoint: Decodable {
-    private var failPoint: BSONDocument
-
-    /// The fail point being configured.
-    internal var name: String {
-        self.failPoint["configureFailPoint"]?.stringValue ?? ""
-    }
-
-    private init(_ document: BSONDocument) {
-        self.failPoint = document
-    }
-
-    public init(from decoder: Decoder) throws {
-        let container = try decoder.singleValueContainer()
-        let unordered = try container.decode(BSONDocument.self)
-        guard let command = unordered["configureFailPoint"] else {
-            throw DecodingError.dataCorruptedError(
-                in: container,
-                debugDescription: "fail point \(unordered) did not contain \"configureFailPoint\" command"
-            )
-        }
-        var ordered: BSONDocument = ["configureFailPoint": command]
-        for (k, v) in unordered {
-            guard k != "configureFailPoint" else {
-                continue
-            }
-            ordered[k] = v
-        }
-        self.failPoint = ordered
-    }
-
+extension FailPoint {
     internal func enable(
         using client: MongoClient,
         options: RunCommandOptions? = nil
@@ -119,64 +80,4 @@ internal struct FailPoint: Decodable {
             print("Failed to disable failpoint: \(error)")
         }
     }
-
-    /// Enum representing the options for the "mode" field of a `configureFailPoint` command.
-    public enum Mode {
-        case times(Int)
-        case alwaysOn
-        case off
-        case activationProbability(Double)
-
-        internal func toBSON() -> BSON {
-            switch self {
-            case let .times(i):
-                return ["times": BSON(i)]
-            case let .activationProbability(d):
-                return ["activationProbability": .double(d)]
-            default:
-                return .string(String(describing: self))
-            }
-        }
-    }
-
-    /// Factory function for creating a `failCommand` failpoint.
-    /// Note: enabling a `failCommand` failpoint will override any other `failCommand` failpoint that is currently
-    /// enabled.
-    /// For more information, see the wiki: https://github.com/mongodb/mongo/wiki/The-%22failCommand%22-fail-point
-    public static func failCommand(
-        failCommands: [String],
-        mode: Mode,
-        blockTimeMS: Int? = nil,
-        closeConnection: Bool? = nil,
-        errorCode: Int? = nil,
-        errorLabels: [String]? = nil,
-        writeConcernError: BSONDocument? = nil
-    ) -> FailPoint {
-        var data: BSONDocument = [
-            "failCommands": .array(failCommands.map { .string($0) })
-        ]
-        if let blockTime = blockTimeMS {
-            data["blockTimeMS"] = BSON(blockTime)
-            data["blockConnection"] = true
-        }
-        if let close = closeConnection {
-            data["closeConnection"] = .bool(close)
-        }
-        if let code = errorCode {
-            data["errorCode"] = BSON(code)
-        }
-        if let labels = errorLabels {
-            data["errorLabels"] = .array(labels.map { .string($0) })
-        }
-        if let writeConcernError = writeConcernError {
-            data["writeConcernError"] = .document(writeConcernError)
-        }
-
-        let command: BSONDocument = [
-            "configureFailPoint": "failCommand",
-            "mode": mode.toBSON(),
-            "data": .document(data)
-        ]
-        return FailPoint(command)
-    }
 }

Tests/MongoSwiftSyncTests/SyncChangeStreamTests.swift

@@ -4,23 +4,6 @@ import TestsCommon
 import XCTest
 
 final class SyncChangeStreamTests: MongoSwiftTestCase {
-    let excludeFiles = [
-        // TODO: SWIFT-1458 Unskip.
-        "change-streams-showExpandedEvents.json",
-        // TODO: SWIFT-1472 Unskip.
-        "change-streams-pre_and_post_images.json"
-    ]
-    func testChangeStreamSpecUnified() throws {
-        let tests = try retrieveSpecTestFiles(
-            specName: "change-streams",
-            subdirectory: "unified",
-            excludeFiles: excludeFiles,
-            asType: UnifiedTestFile.self
-        ).map { $0.1 }
-        let testRunner = try UnifiedTestRunner()
-        try testRunner.runFiles(tests)
-    }
-
     /// How long in total a change stream should poll for an event or error before returning.
     /// Used as a default value for `ChangeStream.nextWithTimeout`
     public static let TIMEOUT: TimeInterval = 15

Tests/MongoSwiftSyncTests/TransactionsTests.swift

@@ -69,14 +69,4 @@ final class TransactionsTests: MongoSwiftTestCase {
             try testFile.runTests()
         }
     }
-
-    func testTransactionsUnified() throws {
-        let files = try retrieveSpecTestFiles(
-            specName: "transactions",
-            subdirectory: "unified",
-            asType: UnifiedTestFile.self
-        )
-        let runner = try UnifiedTestRunner()
-        try runner.runFiles(files.map { $0.1 })
-    }
 }

Tests/MongoSwiftTests/ChangeStreamTests.swift

@@ -1,9 +1,11 @@
+#if compiler(>=5.5.2) && canImport(_Concurrency)
 import Foundation
 import MongoSwift
 import Nimble
 import NIOConcurrencyHelpers
 import TestsCommon
 
+@available(macOS 10.15, *)
 final class ChangeStreamTests: MongoSwiftTestCase {
     func testChangeStreamNext() throws {
         try self.withTestClient { client in
@@ -163,4 +165,22 @@ final class ChangeStreamTests: MongoSwiftTestCase {
             expect(try stream.forEach(increment).wait()).to(throwError(errorType: MongoError.LogicError.self))
         }
     }
+
+    func testChangeStreamSpecUnified() async throws {
+        let excludeFiles = [
+            // TODO: SWIFT-1458 Unskip.
+            "change-streams-showExpandedEvents.json",
+            // TODO: SWIFT-1472 Unskip.
+            "change-streams-pre_and_post_images.json"
+        ]
+        let tests = try retrieveSpecTestFiles(
+            specName: "change-streams",
+            subdirectory: "unified",
+            excludeFiles: excludeFiles,
+            asType: UnifiedTestFile.self
+        ).map { $0.1 }
+        let testRunner = try await UnifiedTestRunner()
+        try await testRunner.runFiles(tests)
+    }
 }
+#endif