Merge pull request #2084 from ahoppen/fulfill-variadic

Make `fulfillmentOfOrThrow` take a variadic list of expectations

Author: ahoppen

Sources/SKTestSupport/Assertions.swift

@@ -144,7 +144,7 @@ package struct ExpectationNotFulfilledError: Error, CustomStringConvertible {
 /// Wait for the given expectations to be fulfilled. If the expectations aren't
 /// fulfilled within `timeout`, throw an error, aborting the test execution.
 package nonisolated func fulfillmentOfOrThrow(
-  _ expectations: [XCTestExpectation],
+  _ expectations: XCTestExpectation...,
   timeout: TimeInterval = defaultTimeout,
   enforceOrder enforceOrderOfFulfillment: Bool = false
 ) async throws {

Tests/BuildSystemIntegrationTests/BuildSystemManagerTests.swift

@@ -173,7 +173,7 @@ final class BuildSystemManagerTests: XCTestCase {
       (a, .swift, fallbackBuildSettings(for: a, language: .swift, options: .init()), changed)
     ])
     await buildSystem.setBuildSettings(for: a, to: nil)
-    try await fulfillmentOfOrThrow([changed])
+    try await fulfillmentOfOrThrow(changed)
   }
 
   func testSettingsMainFileInitialNil() async throws {
@@ -187,7 +187,7 @@ final class BuildSystemManagerTests: XCTestCase {
     let changed = expectation(description: "changed settings")
     await del.setExpected([(a, .swift, FileBuildSettings(compilerArguments: ["x"], language: .swift), changed)])
     await buildSystem.setBuildSettings(for: a, to: TextDocumentSourceKitOptionsResponse(compilerArguments: ["x"]))
-    try await fulfillmentOfOrThrow([changed])
+    try await fulfillmentOfOrThrow(changed)
   }
 
   func testSettingsMainFileWithFallback() async throws {
@@ -211,12 +211,12 @@ final class BuildSystemManagerTests: XCTestCase {
       for: a,
       to: TextDocumentSourceKitOptionsResponse(compilerArguments: ["non-fallback", "args"])
     )
-    try await fulfillmentOfOrThrow([changed])
+    try await fulfillmentOfOrThrow(changed)
 
     let revert = expectation(description: "revert to fallback settings")
     await del.setExpected([(a, .swift, fallbackSettings, revert)])
     await buildSystem.setBuildSettings(for: a, to: nil)
-    try await fulfillmentOfOrThrow([revert])
+    try await fulfillmentOfOrThrow(revert)
   }
 
   func testSettingsHeaderChangeMainFile() async throws {
@@ -257,20 +257,20 @@ final class BuildSystemManagerTests: XCTestCase {
     let changed = expectation(description: "changed settings to cpp2")
     await del.setExpected([(h, .c, FileBuildSettings(compilerArguments: ["C++ 2"], language: .c), changed)])
     await manager.mainFilesChanged()
-    try await fulfillmentOfOrThrow([changed])
+    try await fulfillmentOfOrThrow(changed)
 
     let changed2 = expectation(description: "still cpp2, no update")
     changed2.isInverted = true
     await del.setExpected([(h, .c, nil, changed2)])
     await manager.mainFilesChanged()
-    try await fulfillmentOfOrThrow([changed2], timeout: 1)
+    try await fulfillmentOfOrThrow(changed2, timeout: 1)
 
     await mainFiles.updateMainFiles(for: h, to: [cpp1, cpp2])
 
     let changed3 = expectation(description: "added lexicographically earlier main file")
     await del.setExpected([(h, .c, FileBuildSettings(compilerArguments: ["C++ 1"], language: .c), changed3)])
     await manager.mainFilesChanged()
-    try await fulfillmentOfOrThrow([changed3], timeout: 1)
+    try await fulfillmentOfOrThrow(changed3, timeout: 1)
 
     await mainFiles.updateMainFiles(for: h, to: [])
 
@@ -279,7 +279,7 @@ final class BuildSystemManagerTests: XCTestCase {
       (h, .c, fallbackBuildSettings(for: h, language: .cpp, options: .init()), changed4)
     ])
     await manager.mainFilesChanged()
-    try await fulfillmentOfOrThrow([changed4])
+    try await fulfillmentOfOrThrow(changed4)
   }
 
   func testSettingsOneMainTwoHeader() async throws {
@@ -332,7 +332,7 @@ final class BuildSystemManagerTests: XCTestCase {
       for: cpp,
       to: TextDocumentSourceKitOptionsResponse(compilerArguments: [newCppArg, cpp.pseudoPath])
     )
-    try await fulfillmentOfOrThrow([changed1, changed2])
+    try await fulfillmentOfOrThrow(changed1, changed2)
   }
 }
 

Tests/LanguageServerProtocolJSONRPCTests/ConnectionTests.swift

@@ -52,7 +52,7 @@ class ConnectionTests: XCTestCase {
       expectation.fulfill()
     }
 
-    try await fulfillmentOfOrThrow([expectation])
+    try await fulfillmentOfOrThrow(expectation)
   }
 
   func testMessageBuffer() async throws {
@@ -81,7 +81,7 @@ class ConnectionTests: XCTestCase {
       _rawData: [notification1Str.utf8.last!, notfication2Str.utf8.first!].withUnsafeBytes { DispatchData(bytes: $0) }
     )
 
-    try await fulfillmentOfOrThrow([expectation])
+    try await fulfillmentOfOrThrow(expectation)
 
     let expectation2 = self.expectation(description: "notification received")
 
@@ -94,7 +94,7 @@ class ConnectionTests: XCTestCase {
       clientConnection.send(_rawData: [b].withUnsafeBytes { DispatchData(bytes: $0) })
     }
 
-    try await fulfillmentOfOrThrow([expectation2])
+    try await fulfillmentOfOrThrow(expectation2)
 
     // Close the connection before accessing requestBuffer, which ensures we don't race.
     connection.serverToClientConnection.close()
@@ -120,7 +120,7 @@ class ConnectionTests: XCTestCase {
       expectation2.fulfill()
     }
 
-    try await fulfillmentOfOrThrow([expectation, expectation2])
+    try await fulfillmentOfOrThrow(expectation, expectation2)
   }
 
   func testEchoNotification() async throws {
@@ -134,7 +134,7 @@ class ConnectionTests: XCTestCase {
 
     client.send(EchoNotification(string: "hello!"))
 
-    try await fulfillmentOfOrThrow([expectation])
+    try await fulfillmentOfOrThrow(expectation)
   }
 
   func testUnknownRequest() async throws {
@@ -151,7 +151,7 @@ class ConnectionTests: XCTestCase {
       expectation.fulfill()
     }
 
-    try await fulfillmentOfOrThrow([expectation])
+    try await fulfillmentOfOrThrow(expectation)
   }
 
   func testUnknownNotification() async throws {
@@ -173,7 +173,7 @@ class ConnectionTests: XCTestCase {
       expectation.fulfill()
     }
 
-    try await fulfillmentOfOrThrow([expectation])
+    try await fulfillmentOfOrThrow(expectation)
   }
 
   func testUnexpectedResponse() async throws {
@@ -192,7 +192,7 @@ class ConnectionTests: XCTestCase {
       expectation.fulfill()
     }
 
-    try await fulfillmentOfOrThrow([expectation])
+    try await fulfillmentOfOrThrow(expectation)
   }
 
   func testSendAfterClose() async throws {
@@ -212,7 +212,7 @@ class ConnectionTests: XCTestCase {
     connection.clientToServerConnection.close()
     connection.clientToServerConnection.close()
 
-    try await fulfillmentOfOrThrow([expectation])
+    try await fulfillmentOfOrThrow(expectation)
   }
 
   func testSendBeforeClose() async throws {
@@ -227,7 +227,7 @@ class ConnectionTests: XCTestCase {
     server.client.send(EchoNotification(string: "about to close!"))
     connection.serverToClientConnection.close()
 
-    try await fulfillmentOfOrThrow([expectation])
+    try await fulfillmentOfOrThrow(expectation)
   }
 
   /// We can explicitly close a connection, but the connection also
@@ -279,7 +279,7 @@ class ConnectionTests: XCTestCase {
       #endif
       conn.close()
 
-      try await fulfillmentOfOrThrow([expectation])
+      try await fulfillmentOfOrThrow(expectation)
       withExtendedLifetime(conn) {}
     }
   }
@@ -300,7 +300,7 @@ class ConnectionTests: XCTestCase {
       """
     connection.clientToServerConnection.send(message: messageContents)
 
-    try await fulfillmentOfOrThrow([expectation])
+    try await fulfillmentOfOrThrow(expectation)
   }
 }
 

Tests/LanguageServerProtocolTests/ConnectionTests.swift

@@ -37,7 +37,7 @@ class ConnectionTests: XCTestCase {
       expectation.fulfill()
     }
 
-    try await fulfillmentOfOrThrow([expectation])
+    try await fulfillmentOfOrThrow(expectation)
   }
 
   func testEchoError() async throws {
@@ -57,7 +57,7 @@ class ConnectionTests: XCTestCase {
       expectation2.fulfill()
     }
 
-    try await fulfillmentOfOrThrow([expectation, expectation2])
+    try await fulfillmentOfOrThrow(expectation, expectation2)
   }
 
   func testEchoNotification() async throws {
@@ -71,6 +71,6 @@ class ConnectionTests: XCTestCase {
 
     client.send(EchoNotification(string: "hello!"))
 
-    try await fulfillmentOfOrThrow([expectation])
+    try await fulfillmentOfOrThrow(expectation)
   }
 }

Tests/SKLoggingTests/LoggingTests.swift

@@ -83,7 +83,7 @@ final class LoggingTests: XCTestCase {
       }
     )
     logger.log(level: .error, "my message")
-    try await fulfillmentOfOrThrow([expectation])
+    try await fulfillmentOfOrThrow(expectation)
     XCTAssert(
       message.starts(with: "[org.swift.sourcekit-lsp:test] error"),
       "Message did not have expected header. Received \n\(message)"

Tests/SKUtilitiesTests/DebouncerTests.swift

@@ -23,7 +23,7 @@ final class DebouncerTests: XCTestCase {
     }
     await debouncer.scheduleCall()
     await debouncer.scheduleCall()
-    try await fulfillmentOfOrThrow([expectation])
+    try await fulfillmentOfOrThrow(expectation)
     // Sleep for 0.2s to make sure the debouncer actually debounces and doesn't fulfill the expectation twice.
     try await Task.sleep(for: .seconds(0.2))
   }
@@ -37,6 +37,6 @@ final class DebouncerTests: XCTestCase {
     }
     await debouncer.scheduleCall(1)
     await debouncer.scheduleCall(2)
-    try await fulfillmentOfOrThrow([expectation])
+    try await fulfillmentOfOrThrow(expectation)
   }
 }

Tests/SemanticIndexTests/TaskSchedulerTests.swift

@@ -226,17 +226,17 @@ final class TaskSchedulerTests: XCTestCase {
     }
 
     // The high priority task should be able to finish because we have an execution slot for it.
-    try await fulfillmentOfOrThrow([highPriorityTaskFinished])
+    try await fulfillmentOfOrThrow(highPriorityTaskFinished)
 
     // But we shouldn't be able to execute the low priority task because it doesn't have an execution slot.
-    await assertThrowsError(try await fulfillmentOfOrThrow([lowPriorityTaskFinished1], timeout: 1)) { error in
+    await assertThrowsError(try await fulfillmentOfOrThrow(lowPriorityTaskFinished1, timeout: 1)) { error in
       XCTAssert(error is ExpectationNotFulfilledError)
     }
 
     await taskScheduler.setMaxConcurrentTasksByPriority([(.high, 1), (.low, 1)])
 
     // After increasing the number of execution slots, we should be able to execute the low-priority task
-    try await fulfillmentOfOrThrow([lowPriorityTaskFinished2])
+    try await fulfillmentOfOrThrow(lowPriorityTaskFinished2)
   }
 
   func testDecreaseNumberOfExecutionSlots() async throws {
@@ -261,7 +261,7 @@ final class TaskSchedulerTests: XCTestCase {
       taskStartedExecuting.fulfill()
 
       do {
-        try await fulfillmentOfOrThrow([executionSlotsReduced])
+        try await fulfillmentOfOrThrow(executionSlotsReduced)
 
         try await repeatUntilExpectedResult {
           try Task.checkCancellation()
@@ -276,14 +276,14 @@ final class TaskSchedulerTests: XCTestCase {
     }
 
     // Check that we cancel the in-progress task when reducing the number of execution slots
-    try await fulfillmentOfOrThrow([taskStartedExecuting])
+    try await fulfillmentOfOrThrow(taskStartedExecuting)
     await taskScheduler.setMaxConcurrentTasksByPriority([(.low, 0)])
     executionSlotsReduced.fulfill()
-    try await fulfillmentOfOrThrow([taskCancelled])
+    try await fulfillmentOfOrThrow(taskCancelled)
 
     // And check that we execute it again when increasing the number of execution slots again
     await taskScheduler.setMaxConcurrentTasksByPriority([(.low, 1)])
-    try await fulfillmentOfOrThrow([taskExecutedAgain])
+    try await fulfillmentOfOrThrow(taskExecutedAgain)
   }
 
   func testUseAllExecutionSlotsWithHighAndLowPriorityTasks() async throws {

Tests/SourceKitDTests/CrashRecoveryTests.swift

@@ -139,8 +139,8 @@ final class CrashRecoveryTests: XCTestCase {
 
     await clangdServer.crash()
 
-    try await fulfillmentOfOrThrow([clangdCrashed])
-    try await fulfillmentOfOrThrow([clangdRestarted])
+    try await fulfillmentOfOrThrow(clangdCrashed)
+    try await fulfillmentOfOrThrow(clangdRestarted)
   }
 
   func testClangdCrashRecovery() async throws {
@@ -298,15 +298,15 @@ final class CrashRecoveryTests: XCTestCase {
 
     await clangdServer.crash()
 
-    try await fulfillmentOfOrThrow([clangdCrashed], timeout: 5)
-    try await fulfillmentOfOrThrow([clangdRestartedFirstTime], timeout: 30)
+    try await fulfillmentOfOrThrow(clangdCrashed, timeout: 5)
+    try await fulfillmentOfOrThrow(clangdRestartedFirstTime, timeout: 30)
     // Clangd has restarted. Note the date so we can check that the second restart doesn't happen too quickly.
     let firstRestartDate = Date()
 
     // Crash clangd again. This time, it should only restart after a delay.
     await clangdServer.crash()
 
-    try await fulfillmentOfOrThrow([clangdRestartedSecondTime], timeout: 30)
+    try await fulfillmentOfOrThrow(clangdRestartedSecondTime, timeout: 30)
     XCTAssert(
       Date().timeIntervalSince(firstRestartDate) > 5,
       "Clangd restarted too quickly after crashing twice in a row. We are not preventing crash loops."

Tests/SourceKitDTests/SourceKitDTests.swift

@@ -86,7 +86,7 @@ final class SourceKitDTests: XCTestCase {
 
     _ = try await sourcekitd.send(req, timeout: defaultTimeoutDuration, fileContents: nil)
 
-    try await fulfillmentOfOrThrow([expectation1, expectation2])
+    try await fulfillmentOfOrThrow(expectation1, expectation2)
 
     let close = sourcekitd.dictionary([
       keys.request: sourcekitd.requests.editorClose,

Tests/SourceKitLSPTests/BackgroundIndexingTests.swift

@@ -604,7 +604,7 @@ final class BackgroundIndexingTests: XCTestCase {
       DocumentDiagnosticsRequest(textDocument: TextDocumentIdentifier(uri))
     )
 
-    try await fulfillmentOfOrThrow([receivedEmptyDiagnostics])
+    try await fulfillmentOfOrThrow(receivedEmptyDiagnostics)
 
     // Check that we received a work done progress for the re-preparation of the target
     _ = try await project.testClient.nextNotification(
@@ -2618,7 +2618,7 @@ final class BackgroundIndexingTests: XCTestCase {
         func myTestFunc() {}
         """
     )
-    try await fulfillmentOfOrThrow([updateIndexStoreStarted])
+    try await fulfillmentOfOrThrow(updateIndexStoreStarted)
     try await repeatUntilExpectedResult(sleepInterval: .milliseconds(2)) {
       try await !project.testClient.send(IsIndexingRequest()).indexing
     }