Rename USE_SWIFT_CONCURRENCY_WAITER to DISABLE_XCTWAITER

To make the semantics of the option clearer.

Author: kateinoigakukun

CMakeLists.txt

@@ -8,15 +8,15 @@ project(XCTest LANGUAGES Swift)
 option(BUILD_SHARED_LIBS "Build shared libraries" ON)
 option(USE_FOUNDATION_FRAMEWORK "Use Foundation.framework on Darwin" NO)
 
-set(USE_SWIFT_CONCURRENCY_WAITER_default NO)
+set(DISABLE_XCTWAITER_default NO)
 
 if(CMAKE_SYSTEM_PROCESSOR STREQUAL wasm32)
-  set(USE_SWIFT_CONCURRENCY_WAITER_default ON)
+  set(DISABLE_XCTWAITER_default ON)
 endif()
 
-option(USE_SWIFT_CONCURRENCY_WAITER "Use Swift Concurrency-based waiter implementation" "${USE_SWIFT_CONCURRENCY_WAITER_default}")
+option(DISABLE_XCTWAITER "Disable XCTWaiter" "${DISABLE_XCTWAITER_default}")
 
-if(NOT CMAKE_SYSTEM_NAME STREQUAL Darwin AND NOT USE_SWIFT_CONCURRENCY_WAITER)
+if(NOT CMAKE_SYSTEM_NAME STREQUAL Darwin AND NOT DISABLE_XCTWAITER)
   find_package(dispatch CONFIG REQUIRED)
   find_package(Foundation CONFIG REQUIRED)
 endif()
@@ -59,9 +59,9 @@ add_library(XCTest
   Sources/XCTest/Public/Asynchronous/XCTestCase+Asynchronous.swift
   Sources/XCTest/Public/Asynchronous/XCTestExpectation.swift)
 
-if(USE_SWIFT_CONCURRENCY_WAITER)
+if(DISABLE_XCTWAITER)
   target_compile_definitions(XCTest PRIVATE
-    USE_SWIFT_CONCURRENCY_WAITER)
+    DISABLE_XCTWAITER)
 endif()
 
 if(USE_FOUNDATION_FRAMEWORK)

Sources/XCTest/Private/WaiterManager.swift

@@ -9,7 +9,7 @@
 //
 //  WaiterManager.swift
 //
-#if !USE_SWIFT_CONCURRENCY_WAITER
+#if !DISABLE_XCTWAITER
 
 internal protocol ManageableWaiter: AnyObject, Equatable {
     var isFinished: Bool { get }

Sources/XCTest/Private/XCTestCase.TearDownBlocksState.swift

@@ -12,7 +12,7 @@ extension XCTestCase {
     /// Supports async and sync throwing methods.
     final class TeardownBlocksState {
 
-        #if USE_SWIFT_CONCURRENCY_WAITER
+        #if DISABLE_XCTWAITER
         typealias TeardownBlock = @Sendable () async throws -> Void
         #else
         typealias TeardownBlock = () throws -> Void
@@ -27,7 +27,7 @@ extension XCTestCase {
         // Because of this, we chose the unusual decision to forgo overloading (which is a super sweet language feature <3) to prevent this issue from surprising any contributors to corelibs-xctest
         @available(macOS 12.0, *)
         func appendAsync(_ block: @Sendable @escaping () async throws -> Void) {
-            #if USE_SWIFT_CONCURRENCY_WAITER
+            #if DISABLE_XCTWAITER
             XCTWaiter.subsystemQueue.sync {
                 precondition(wasFinalized == false, "API violation -- attempting to add a teardown block after teardown blocks have been dequeued")
                 blocks.append(block)

Sources/XCTest/Public/Asynchronous/XCTNSNotificationExpectation.swift

@@ -10,7 +10,7 @@
 //  XCTNSNotificationExpectation.swift
 //
 
-#if !USE_SWIFT_CONCURRENCY_WAITER
+#if !DISABLE_XCTWAITER
 
 /// Expectation subclass for waiting on a condition defined by a Foundation Notification instance.
 open class XCTNSNotificationExpectation: XCTestExpectation {

Sources/XCTest/Public/Asynchronous/XCTNSPredicateExpectation.swift

@@ -10,7 +10,7 @@
 //  XCTNSPredicateExpectation.swift
 //
 
-#if !USE_SWIFT_CONCURRENCY_WAITER
+#if !DISABLE_XCTWAITER
 
 /// Expectation subclass for waiting on a condition defined by an NSPredicate and an optional object.
 open class XCTNSPredicateExpectation: XCTestExpectation {

Sources/XCTest/Public/Asynchronous/XCTWaiter.swift

@@ -117,7 +117,7 @@ open class XCTWaiter {
     private var state = State.ready
     internal var timeout: TimeInterval = 0
     internal var waitSourceLocation: SourceLocation?
-    #if !USE_SWIFT_CONCURRENCY_WAITER
+    #if !DISABLE_XCTWAITER
     private weak var manager: WaiterManager<XCTWaiter>?
     #endif
     private var runLoop: RunLoop?
@@ -189,14 +189,14 @@ open class XCTWaiter {
     ///   these environments. To ensure compatibility of tests between
     ///   swift-corelibs-xctest and Apple XCTest, it is not recommended to pass
     ///   explicit values for `file` and `line`.
-    #if USE_SWIFT_CONCURRENCY_WAITER
+    #if DISABLE_XCTWAITER
     @available(*, unavailable, message: "Expectation-based waiting is not available when using the Swift concurrency waiter.")
     #else
     @available(*, noasync, message: "Use await fulfillment(of:timeout:enforceOrder:) instead.")
     #endif
     @discardableResult
     open func wait(for expectations: [XCTestExpectation], timeout: TimeInterval, enforceOrder: Bool = false, file: StaticString = #file, line: Int = #line) -> Result {
-        #if USE_SWIFT_CONCURRENCY_WAITER
+        #if DISABLE_XCTWAITER
         fatalError("This method is not available when using the Swift concurrency waiter.")
         #else
         precondition(Set(expectations).count == expectations.count, "API violation - each expectation can appear only once in the 'expectations' parameter.")
@@ -286,14 +286,14 @@ open class XCTWaiter {
     ///   these environments. To ensure compatibility of tests between
     ///   swift-corelibs-xctest and Apple XCTest, it is not recommended to pass
     ///   explicit values for `file` and `line`.
-    #if USE_SWIFT_CONCURRENCY_WAITER
+    #if DISABLE_XCTWAITER
     @available(*, unavailable, message: "Expectation-based waiting is not available when using the Swift concurrency waiter.")
     #else
     @available(macOS 12.0, *)
     #endif
     @discardableResult
     open func fulfillment(of expectations: [XCTestExpectation], timeout: TimeInterval, enforceOrder: Bool = false, file: StaticString = #file, line: Int = #line) async -> Result {
-#if USE_SWIFT_CONCURRENCY_WAITER
+#if DISABLE_XCTWAITER
         fatalError("This method is not available when using the Swift concurrency waiter.")
 #else
         return await withCheckedContinuation { continuation in
@@ -324,13 +324,13 @@ open class XCTWaiter {
     ///   expectations are not fulfilled before the given timeout. Default is the line
     ///   number of the call to this method in the calling file. It is rare to
     ///   provide this parameter when calling this method.
-    #if USE_SWIFT_CONCURRENCY_WAITER
+    #if DISABLE_XCTWAITER
     @available(*, unavailable, message: "Expectation-based waiting is not available when using the Swift concurrency waiter.")
     #else
     @available(*, noasync, message: "Use await fulfillment(of:timeout:enforceOrder:) instead.")
     #endif
     open class func wait(for expectations: [XCTestExpectation], timeout: TimeInterval, enforceOrder: Bool = false, file: StaticString = #file, line: Int = #line) -> Result {
-#if USE_SWIFT_CONCURRENCY_WAITER
+#if DISABLE_XCTWAITER
         fatalError("This method is not available when using the Swift concurrency waiter.")
 #else
         return XCTWaiter().wait(for: expectations, timeout: timeout, enforceOrder: enforceOrder, file: file, line: line)
@@ -353,13 +353,13 @@ open class XCTWaiter {
     ///   expectations are not fulfilled before the given timeout. Default is the line
     ///   number of the call to this method in the calling file. It is rare to
     ///   provide this parameter when calling this method.
-    #if USE_SWIFT_CONCURRENCY_WAITER
+    #if DISABLE_XCTWAITER
     @available(*, unavailable, message: "Expectation-based waiting is not available when using the Swift concurrency waiter.")
     #else
     @available(macOS 12.0, *)
     #endif
     open class func fulfillment(of expectations: [XCTestExpectation], timeout: TimeInterval, enforceOrder: Bool = false, file: StaticString = #file, line: Int = #line) async -> Result {
-#if USE_SWIFT_CONCURRENCY_WAITER
+#if DISABLE_XCTWAITER
         fatalError("This method is not available when using the Swift concurrency waiter.")
 #else
         return await XCTWaiter().fulfillment(of: expectations, timeout: timeout, enforceOrder: enforceOrder, file: file, line: line)
@@ -372,7 +372,7 @@ open class XCTWaiter {
         }
     }
 
-#if !USE_SWIFT_CONCURRENCY_WAITER
+#if !DISABLE_XCTWAITER
     private func queue_configureExpectations(_ expectations: [XCTestExpectation]) {
         dispatchPrecondition(condition: .onQueue(XCTWaiter.subsystemQueue))
 
@@ -452,7 +452,7 @@ open class XCTWaiter {
 
 }
 
-#if !USE_SWIFT_CONCURRENCY_WAITER
+#if !DISABLE_XCTWAITER
 private extension XCTWaiter {
     func primitiveWait(using runLoop: RunLoop, duration timeout: TimeInterval) {
         // The contract for `primitiveWait(for:)` explicitly allows waiting for a shorter period than requested
@@ -491,7 +491,7 @@ extension XCTWaiter: CustomStringConvertible {
     }
 }
 
-#if !USE_SWIFT_CONCURRENCY_WAITER
+#if !DISABLE_XCTWAITER
 extension XCTWaiter: ManageableWaiter {
     var isFinished: Bool {
         return XCTWaiter.subsystemQueue.sync {

Sources/XCTest/Public/Asynchronous/XCTestCase+Asynchronous.swift

@@ -11,7 +11,7 @@
 //  Methods on XCTestCase for testing asynchronous operations
 //
 
-#if !USE_SWIFT_CONCURRENCY_WAITER
+#if !DISABLE_XCTWAITER
 
 public extension XCTestCase {
 

Sources/XCTest/Public/XCAbstractTest.swift

@@ -36,7 +36,7 @@ open class XCTest {
     /// testRunClass. If the test has not yet been run, this will be nil.
     open private(set) var testRun: XCTestRun? = nil
 
-    #if USE_SWIFT_CONCURRENCY_WAITER
+    #if DISABLE_XCTWAITER
     internal var performTask: Task<Void, Never>?
 
     internal func _performAsync(_ run: XCTestRun) async {
@@ -53,7 +53,7 @@ open class XCTest {
 
     /// The method through which tests are executed. Must be overridden by
     /// subclasses.
-    #if USE_SWIFT_CONCURRENCY_WAITER
+    #if DISABLE_XCTWAITER
     @available(*, unavailable)
     #endif
     open func perform(_ run: XCTestRun) {
@@ -62,11 +62,11 @@ open class XCTest {
 
     /// Creates an instance of the `testRunClass` and passes it as a parameter
     /// to `perform()`.
-    #if USE_SWIFT_CONCURRENCY_WAITER
+    #if DISABLE_XCTWAITER
     @available(*, unavailable)
     #endif
     open func run() {
-        #if !USE_SWIFT_CONCURRENCY_WAITER
+        #if !DISABLE_XCTWAITER
         guard let testRunType = testRunClass as? XCTestRun.Type else {
             fatalError("XCTest.testRunClass must be a kind of XCTestRun.")
         }

Sources/XCTest/Public/XCTestCase.swift

@@ -36,7 +36,7 @@ open class XCTestCase: XCTest {
 
     private var skip: XCTSkip?
 
-#if USE_SWIFT_CONCURRENCY_WAITER
+#if DISABLE_XCTWAITER
     /// A task that ends when the test closure has actually finished running.
     /// This is used to ensure that all async work has completed.
     fileprivate var testClosureTask: Task<Void, Error>?
@@ -95,7 +95,7 @@ open class XCTestCase: XCTest {
         return XCTestCaseRun.self
     }
 
-    #if USE_SWIFT_CONCURRENCY_WAITER
+    #if DISABLE_XCTWAITER
     override func _performAsync(_ run: XCTestRun) async {
         guard let testRun = run as? XCTestCaseRun else {
             fatalError("Wrong XCTestRun class.")
@@ -135,7 +135,7 @@ open class XCTestCase: XCTest {
         self.testClosure = testClosure
     }
 
-    #if USE_SWIFT_CONCURRENCY_WAITER
+    #if DISABLE_XCTWAITER
     @MainActor internal func _invokeTestAsync() async {
         await performSetUpSequence()
 
@@ -170,11 +170,11 @@ open class XCTestCase: XCTest {
 
     /// Invoking a test performs its setUp, invocation, and tearDown. In
     /// general this should not be called directly.
-    #if USE_SWIFT_CONCURRENCY_WAITER
+    #if DISABLE_XCTWAITER
     @available(*, unavailable)
     #endif
     open func invokeTest() {
-        #if !USE_SWIFT_CONCURRENCY_WAITER
+        #if !DISABLE_XCTWAITER
         performSetUpSequence()
 
         do {
@@ -310,7 +310,7 @@ open class XCTestCase: XCTest {
         }
     }
 
-    #if USE_SWIFT_CONCURRENCY_WAITER
+    #if DISABLE_XCTWAITER
     @MainActor private func runTeardownBlocks() async {
         for block in self.teardownBlocksState.finalize().reversed() {
             do {
@@ -425,7 +425,7 @@ private func test<T: XCTestCase>(_ testFunc: @escaping (T) -> () throws -> Void)
 public func asyncTest<T: XCTestCase>(
     _ testClosureGenerator: @escaping (T) -> () async throws -> Void
 ) -> (T) -> () throws -> Void {
-#if USE_SWIFT_CONCURRENCY_WAITER
+#if DISABLE_XCTWAITER
     return { (testType: T) in
         let testClosure = testClosureGenerator(testType)
         return {
@@ -445,7 +445,7 @@ public func asyncTest<T: XCTestCase>(
 #endif
 }
 
-#if !USE_SWIFT_CONCURRENCY_WAITER
+#if !DISABLE_XCTWAITER
 @available(macOS 12.0, *)
 func awaitUsingExpectation(
     _ closure: @escaping () async throws -> Void

Sources/XCTest/Public/XCTestMain.swift

@@ -69,7 +69,7 @@
 /// - Returns: The exit code to use when the process terminates. `EXIT_SUCCESS`
 ///     indicates success, while any other value (including `EXIT_FAILURE`)
 ///     indicates failure.
-#if USE_SWIFT_CONCURRENCY_WAITER
+#if DISABLE_XCTWAITER
 @_disfavoredOverload
 public func XCTMain(
     _ testCases: [XCTestCaseEntry],
@@ -201,7 +201,7 @@ internal func XCTMainMisc(
     }
 }
 
-#if USE_SWIFT_CONCURRENCY_WAITER
+#if DISABLE_XCTWAITER
 // @available(*, deprecated, message: "Call the overload of XCTMain() that returns an exit code instead.")
 public func XCTMain(_ testCases: [XCTestCaseEntry]) async -> Never {
     exit(await XCTMain(testCases, arguments: CommandLine.arguments, observers: nil) as CInt)