Automatically initialize the SourceKit-LSP server when creating a TestSourceKitLSPClient

Sources/SKTestSupport/SKSwiftPMTestWorkspace.swift

@@ -62,7 +62,14 @@ public final class SKSwiftPMTestWorkspace {
     toolchain: Toolchain,
     testClient: TestSourceKitLSPClient? = nil
   ) async throws {
-    self.testClient = testClient ?? TestSourceKitLSPClient()
+    self.testClient =
+      if let testClient {
+        testClient
+      } else {
+        // Don't initialize the LSP server because we wire up all the properties that `InitializeRequest` would set
+        // manually below.
+        try await TestSourceKitLSPClient(initialize: false)
+      }
 
     self.projectDir = URL(
       fileURLWithPath: try resolveSymlinks(AbsolutePath(validating: projectDir.path)).pathString

Sources/SKTestSupport/SKTibsTestWorkspace.swift

@@ -51,7 +51,14 @@ public final class SKTibsTestWorkspace {
     clientCapabilities: ClientCapabilities,
     testClient: TestSourceKitLSPClient? = nil
   ) async throws {
-    self.testClient = testClient ?? TestSourceKitLSPClient()
+    self.testClient =
+      if let testClient {
+        testClient
+      } else {
+        // Don't initialize the LSP server because we wire up all the properties that `InitializeRequest` would set
+        // manually below.
+        try await TestSourceKitLSPClient(initialize: false)
+      }
     self.tibsWorkspace = try TibsTestWorkspace(
       immutableProjectDir: immutableProjectDir,
       persistentBuildDir: persistentBuildDir,
@@ -70,7 +77,14 @@ public final class SKTibsTestWorkspace {
     clientCapabilities: ClientCapabilities,
     testClient: TestSourceKitLSPClient? = nil
   ) async throws {
-    self.testClient = testClient ?? TestSourceKitLSPClient()
+    self.testClient =
+      if let testClient {
+        testClient
+      } else {
+        // Don't initialize the LSP server because we wire up all the properties that `InitializeRequest` would set
+        // manually below.
+        try await TestSourceKitLSPClient(initialize: false)
+      }
 
     self.tibsWorkspace = try TibsTestWorkspace(
       projectDir: projectDir,

Sources/SKTestSupport/TestSourceKitLSPClient.swift

@@ -62,9 +62,22 @@ public final class TestSourceKitLSPClient: MessageHandler {
   private var requestHandlers: [Any] = []
 
   /// - Parameters:
+  ///   - serverOptions: The equivalent of the command line options with which sourcekit-lsp should be started
   ///   - useGlobalModuleCache: If `false`, the server will use its own module
   ///     cache in an empty temporary directory instead of the global module cache.
-  public init(serverOptions: SourceKitServer.Options = .testDefault, useGlobalModuleCache: Bool = true) {
+  ///   - initialize: Whether an `InitializeRequest` should be automatically sent to the SourceKit-LSP server.
+  ///     `true` by default
+  ///   - initializationOptions: Initialization options to pass to the SourceKit-LSP server.
+  ///   - capabilities: The test client's capabilities.
+  ///   - workspaceFolders: Workspace folders to open.
+  public init(
+    serverOptions: SourceKitServer.Options = .testDefault,
+    useGlobalModuleCache: Bool = true,
+    initialize: Bool = true,
+    initializationOptions: LSPAny? = nil,
+    capabilities: ClientCapabilities = ClientCapabilities(),
+    workspaceFolders: [WorkspaceFolder]? = nil
+  ) async throws {
     if !useGlobalModuleCache {
       moduleCache = URL(fileURLWithPath: NSTemporaryDirectory()).appendingPathComponent(UUID().uuidString)
     } else {
@@ -92,6 +105,20 @@ public final class TestSourceKitLSPClient: MessageHandler {
     )
 
     self.serverToClientConnection.start(handler: WeakMessageHandler(self))
+
+    if initialize {
+      _ = try await self.send(
+        InitializeRequest(
+          processId: nil,
+          rootPath: nil,
+          rootURI: nil,
+          initializationOptions: initializationOptions,
+          capabilities: capabilities,
+          trace: .off,
+          workspaceFolders: workspaceFolders
+        )
+      )
+    }
   }
 
   deinit {

Tests/SourceKitLSPTests/BuildSystemTests.swift

@@ -94,7 +94,7 @@ final class BuildSystemTests: XCTestCase {
 
   override func setUp() async throws {
     haveClangd = ToolchainRegistry.shared.toolchains.contains { $0.clangd != nil }
-    testClient = TestSourceKitLSPClient()
+    testClient = try await TestSourceKitLSPClient()
     buildSystem = TestBuildSystem()
 
     let server = testClient.server
@@ -112,18 +112,6 @@ final class BuildSystemTests: XCTestCase {
 
     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/DocumentColorTests.swift

@@ -17,34 +17,11 @@ import SourceKitLSP
 import XCTest
 
 final class DocumentColorTests: XCTestCase {
-  /// The mock client used to communicate with the SourceKit-LSP server.
-  ///
-  /// - Note: Set before each test run in `setUp`.
-  private var testClient: TestSourceKitLSPClient! = nil
-
-  override func setUp() async throws {
-    testClient = TestSourceKitLSPClient()
-    let documentCapabilities = TextDocumentClientCapabilities()
-    _ = try await testClient.send(
-      InitializeRequest(
-        processId: nil,
-        rootPath: nil,
-        rootURI: nil,
-        initializationOptions: nil,
-        capabilities: ClientCapabilities(workspace: nil, textDocument: documentCapabilities),
-        trace: .off,
-        workspaceFolders: nil
-      )
-    )
-  }
-
-  override func tearDown() {
-    testClient = nil
-  }
-
   // MARK: - Helpers
 
   private func performDocumentColorRequest(text: String) async throws -> [ColorInformation] {
+    let testClient = try await TestSourceKitLSPClient()
+
     let uri = DocumentURI.for(.swift)
 
     testClient.openDocument(text, uri: uri)
@@ -58,6 +35,8 @@ final class DocumentColorTests: XCTestCase {
     color: Color,
     range: Range<Position>
   ) async throws -> [ColorPresentation] {
+    let testClient = try await TestSourceKitLSPClient()
+
     let uri = DocumentURI.for(.swift)
 
     testClient.openDocument(text, uri: uri)

Tests/SourceKitLSPTests/DocumentSymbolTests.swift

@@ -17,37 +17,10 @@ import SourceKitLSP
 import XCTest
 
 final class DocumentSymbolTests: XCTestCase {
-  typealias DocumentSymbolCapabilities = TextDocumentClientCapabilities.DocumentSymbol
-
-  /// The mock client used to communicate with the SourceKit-LSP server.
-  ///
-  /// - Note: Set before each test run in `setUp`.
-  private var testClient: TestSourceKitLSPClient! = nil
-
-  override func setUp() async throws {
-    testClient = TestSourceKitLSPClient()
-    var documentCapabilities = TextDocumentClientCapabilities()
-    documentCapabilities.documentSymbol = DocumentSymbolCapabilities()
-    _ = try await testClient.send(
-      InitializeRequest(
-        processId: nil,
-        rootPath: nil,
-        rootURI: nil,
-        initializationOptions: nil,
-        capabilities: ClientCapabilities(workspace: nil, textDocument: documentCapabilities),
-        trace: .off,
-        workspaceFolders: nil
-      )
-    )
-  }
-
-  override func tearDown() {
-    testClient = nil
-  }
-
   // MARK: - Helpers
 
   private func performDocumentSymbolRequest(text: String) async throws -> DocumentSymbolResponse {
+    let testClient = try await TestSourceKitLSPClient()
     let uri = DocumentURI.for(.swift)
 
     testClient.openDocument(text, uri: uri)

Tests/SourceKitLSPTests/ExecuteCommandTests.swift

@@ -17,33 +17,6 @@ import SourceKitLSP
 import XCTest
 
 final class ExecuteCommandTests: XCTestCase {
-
-  /// The mock client used to communicate with the SourceKit-LSP server.
-  ///
-  /// - Note: Set before each test run in `setUp`.
-  private var testClient: TestSourceKitLSPClient! = nil
-
-  override func tearDown() {
-    testClient = nil
-  }
-
-  override func setUp() async throws {
-    testClient = TestSourceKitLSPClient()
-    _ = try await self.testClient.send(
-      InitializeRequest(
-        processId: nil,
-        rootPath: nil,
-        rootURI: nil,
-        initializationOptions: nil,
-        capabilities: ClientCapabilities(workspace: nil, textDocument: nil),
-        trace: .off,
-        workspaceFolders: nil
-      )
-    )
-  }
-
-  // MARK: - Tests
-
   func testLocationSemanticRefactoring() async throws {
     guard let ws = try await staticSourceKitTibsWorkspace(name: "SemanticRefactor") else { return }
     let loc = ws.testLoc("sr:string")

Tests/SourceKitLSPTests/InlayHintTests.swift

@@ -17,33 +17,10 @@ import SourceKitLSP
 import XCTest
 
 final class InlayHintTests: XCTestCase {
-  /// The mock client used to communicate with the SourceKit-LSP server.
-  ///
-  /// - Note: Set before each test run in `setUp`.
-  private var testClient: TestSourceKitLSPClient! = nil
-
-  override func setUp() async throws {
-    testClient = TestSourceKitLSPClient()
-    _ = 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() {
-    testClient = nil
-  }
-
   // MARK: - Helpers
 
   func performInlayHintRequest(text: String, range: Range<Position>? = nil) async throws -> [InlayHint] {
+    let testClient = try await TestSourceKitLSPClient()
     let uri = DocumentURI.for(.swift)
 
     testClient.openDocument(text, uri: uri)

Tests/SourceKitLSPTests/LocalClangTests.swift

@@ -28,45 +28,18 @@ final class LocalClangTests: XCTestCase {
   /// - Note: Set before each test run in `setUp`.
   private var haveClangd: Bool = false
 
-  /// The mock client used to communicate with the SourceKit-LSP server.
-  ///
-  /// - Note: Set before each test run in `setUp`.
-  private var testClient: TestSourceKitLSPClient! = nil
-
   override func setUp() async throws {
     haveClangd = ToolchainRegistry.shared.toolchains.contains { $0.clangd != nil }
     if LocalClangTests.requireClangd && !haveClangd {
       XCTFail("cannot find clangd in toolchain")
     }
-
-    testClient = TestSourceKitLSPClient()
-    let documentSymbol = TextDocumentClientCapabilities.DocumentSymbol(
-      dynamicRegistration: nil,
-      symbolKind: nil,
-      hierarchicalDocumentSymbolSupport: true
-    )
-    let textDocument = TextDocumentClientCapabilities(documentSymbol: documentSymbol)
-    _ = try await self.testClient.send(
-      InitializeRequest(
-        processId: nil,
-        rootPath: nil,
-        rootURI: nil,
-        initializationOptions: nil,
-        capabilities: ClientCapabilities(workspace: nil, textDocument: textDocument),
-        trace: .off,
-        workspaceFolders: nil
-      )
-    )
-  }
-
-  override func tearDown() {
-    testClient = nil
   }
 
   // MARK: - Tests
 
   func testSymbolInfo() async throws {
     guard haveClangd else { return }
+    let testClient = try await TestSourceKitLSPClient()
     let uri = DocumentURI.for(.cpp)
 
     let locations = testClient.openDocument(
@@ -142,6 +115,7 @@ final class LocalClangTests: XCTestCase {
 
   func testFoldingRange() async throws {
     guard haveClangd else { return }
+    let testClient = try await TestSourceKitLSPClient()
     let uri = DocumentURI.for(.cpp)
 
     testClient.openDocument(
@@ -169,6 +143,17 @@ final class LocalClangTests: XCTestCase {
 
   func testDocumentSymbols() async throws {
     guard haveClangd else { return }
+    let testClient = try await TestSourceKitLSPClient(
+      capabilities: ClientCapabilities(
+        textDocument: TextDocumentClientCapabilities(
+          documentSymbol: TextDocumentClientCapabilities.DocumentSymbol(
+            dynamicRegistration: nil,
+            symbolKind: nil,
+            hierarchicalDocumentSymbolSupport: true
+          )
+        )
+      )
+    )
     let uri = DocumentURI.for(.cpp)
 
     testClient.openDocument(