Remove awaitTask

It turns out that `XCTestCase.setUp` can indeed be `async` and we thus don’t actually need `awaitTask`

Author: ahoppen

Sources/LSPTestSupport/Assertions.swift

@@ -130,28 +130,4 @@ extension XCTestCase {
       throw ExpectationNotFulfilledError(expecatations: expectations)
     }
   }
-
-  /// Execute the given asynchronous `operation` and block execution until it
-  /// finishes.
-  ///
-  /// - Important: Only use this in context where execution of async functions
-  ///   is necessary but the context doesn't allow it, like `XCTestCase.setUp`
-  public func awaitTask(
-    description: String,
-    _ operation: () async throws -> Void,
-    file: StaticString = #filePath,
-    line: UInt = #line
-  ) {
-    let completed = self.expectation(description: description)
-    withoutActuallyEscaping(operation) { operation in
-      Task(priority: .userInitiated) {
-        await assertNoThrow<Void>(operation, "", file: file, line: line)
-        completed.fulfill()
-      }
-      let started = XCTWaiter.wait(for: [completed], timeout: defaultTimeout)
-      if started != .completed {
-        XCTFail("Task '\(description)' did not finish within timeout", file: file, line: line)
-      }
-    }
-  }
 }

Tests/SourceKitLSPTests/BuildSystemTests.swift

@@ -92,40 +92,38 @@ final class BuildSystemTests: XCTestCase {
   /// - Note: Set before each test run in `setUp`.
   private var haveClangd: Bool = false
 
-  override func setUp() {
-    awaitTask(description: "Setup complete") {
-      haveClangd = ToolchainRegistry.shared.toolchains.contains { $0.clangd != nil }
-      testClient = TestSourceKitLSPClient()
-      buildSystem = TestBuildSystem()
-
-      let server = testClient.server
-
-      self.workspace = await Workspace(
-        documentManager: DocumentManager(),
-        rootUri: nil,
-        capabilityRegistry: CapabilityRegistry(clientCapabilities: ClientCapabilities()),
-        toolchainRegistry: ToolchainRegistry.shared,
-        buildSetup: SourceKitServer.Options.testDefault.buildSetup,
-        underlyingBuildSystem: buildSystem,
-        index: nil,
-        indexDelegate: nil
-      )
+  override func setUp() async throws {
+    haveClangd = ToolchainRegistry.shared.toolchains.contains { $0.clangd != nil }
+    testClient = TestSourceKitLSPClient()
+    buildSystem = TestBuildSystem()
+
+    let server = testClient.server
+
+    self.workspace = await Workspace(
+      documentManager: DocumentManager(),
+      rootUri: nil,
+      capabilityRegistry: CapabilityRegistry(clientCapabilities: ClientCapabilities()),
+      toolchainRegistry: ToolchainRegistry.shared,
+      buildSetup: SourceKitServer.Options.testDefault.buildSetup,
+      underlyingBuildSystem: buildSystem,
+      index: nil,
+      indexDelegate: nil
+    )
 
-      await server.setWorkspaces([workspace])
-      await workspace.buildSystemManager.setDelegate(server)
-
-      _ = try await testClient.send(
-        InitializeRequest(
-          processId: nil,
-          rootPath: nil,
-          rootURI: nil,
-          initializationOptions: nil,
-          capabilities: ClientCapabilities(workspace: nil, textDocument: nil),
-          trace: .off,
-          workspaceFolders: nil
-        )
+    await server.setWorkspaces([workspace])
+    await workspace.buildSystemManager.setDelegate(server)
+
+    _ = try await testClient.send(
+      InitializeRequest(
+        processId: nil,
+        rootPath: nil,
+        rootURI: nil,
+        initializationOptions: nil,
+        capabilities: ClientCapabilities(workspace: nil, textDocument: nil),
+        trace: .off,
+        workspaceFolders: nil
       )
-    }
+    )
   }
 
   override func tearDown() {

Tests/SourceKitLSPTests/PublishDiagnosticsTests.swift

@@ -32,24 +32,22 @@ final class PublishDiagnosticsTests: XCTestCase {
   ///   `openDocument` and `editDocument`.
   private var version: Int!
 
-  override func setUp() {
+  override func setUp() async throws {
     version = 0
     uri = DocumentURI(URL(fileURLWithPath: "/PublishDiagnosticsTests/\(UUID()).swift"))
     testClient = TestSourceKitLSPClient()
     let documentCapabilities = TextDocumentClientCapabilities()
-    awaitTask(description: "Initialized") {
-      _ = try await self.testClient.send(
-        InitializeRequest(
-          processId: nil,
-          rootPath: nil,
-          rootURI: nil,
-          initializationOptions: nil,
-          capabilities: ClientCapabilities(workspace: nil, textDocument: documentCapabilities),
-          trace: .off,
-          workspaceFolders: nil
-        )
+    _ = try await self.testClient.send(
+      InitializeRequest(
+        processId: nil,
+        rootPath: nil,
+        rootURI: nil,
+        initializationOptions: nil,
+        capabilities: ClientCapabilities(workspace: nil, textDocument: documentCapabilities),
+        trace: .off,
+        workspaceFolders: nil
       )
-    }
+    )
   }
 
   override func tearDown() {

Tests/SourceKitLSPTests/SwiftInterfaceTests.swift

@@ -27,36 +27,34 @@ final class SwiftInterfaceTests: XCTestCase {
   /// - Note: Set before each test run in `setUp`.
   private var testClient: TestSourceKitLSPClient! = nil
 
-  override func setUp() {
+  override func setUp() async throws {
     // This is the only test that references modules from the SDK (Foundation).
     // `testSystemModuleInterface` has been flaky for a long while and a
     // hypothesis is that it was failing because of a malformed global module
     // cache that might still be present from previous CI runs. If we use a
     // local module cache, we define away that source of bugs.
     testClient = TestSourceKitLSPClient(useGlobalModuleCache: false)
-    awaitTask(description: "Initialize") {
-      _ = try await testClient.send(
-        InitializeRequest(
-          processId: nil,
-          rootPath: nil,
-          rootURI: nil,
-          initializationOptions: nil,
-          capabilities: ClientCapabilities(
-            workspace: nil,
-            textDocument: TextDocumentClientCapabilities(
-              codeAction: .init(
-                codeActionLiteralSupport: .init(
-                  codeActionKind: .init(valueSet: [.quickFix])
-                )
-              ),
-              publishDiagnostics: .init(codeDescriptionSupport: true)
-            )
-          ),
-          trace: .off,
-          workspaceFolders: nil
-        )
+    _ = try await testClient.send(
+      InitializeRequest(
+        processId: nil,
+        rootPath: nil,
+        rootURI: nil,
+        initializationOptions: nil,
+        capabilities: ClientCapabilities(
+          workspace: nil,
+          textDocument: TextDocumentClientCapabilities(
+            codeAction: .init(
+              codeActionLiteralSupport: .init(
+                codeActionKind: .init(valueSet: [.quickFix])
+              )
+            ),
+            publishDiagnostics: .init(codeDescriptionSupport: true)
+          )
+        ),
+        trace: .off,
+        workspaceFolders: nil
       )
-    }
+    )
   }
 
   override func tearDown() {