Rename TestSourceKitServer to TestSourceKitClient

Really, what the class was mocking is a SourceKit-LSP client.

Author: ahoppen

Sources/SKTestSupport/SKSwiftPMTestWorkspace.swift

@@ -53,11 +53,16 @@ public final class SKSwiftPMTestWorkspace {
   public let toolchain: Toolchain
 
   /// Connection to the language server.
-  public let testServer: TestSourceKitServer
+  public let testClient: TestSourceKitLSPClient
 
   /// When `testServer` is not `nil`, the workspace will be opened in that server, otherwise a new server will be created for the workspace
-  public init(projectDir: URL, tmpDir: URL, toolchain: Toolchain, testServer: TestSourceKitServer? = nil) async throws {
-    self.testServer = testServer ?? TestSourceKitServer()
+  public init(
+    projectDir: URL,
+    tmpDir: URL,
+    toolchain: Toolchain,
+    testClient: TestSourceKitLSPClient? = nil
+  ) async throws {
+    self.testClient = testClient ?? TestSourceKitLSPClient()
 
     self.projectDir = URL(
       fileURLWithPath: try resolveSymlinks(AbsolutePath(validating: projectDir.path)).pathString
@@ -103,7 +108,7 @@ public final class SKSwiftPMTestWorkspace {
       listenToUnitEvents: false
     )
 
-    let server = self.testServer.server
+    let server = self.testClient.server
     let workspace = await Workspace(
       documentManager: DocumentManager(),
       rootUri: DocumentURI(sources.rootDirectory),
@@ -151,7 +156,7 @@ extension SKSwiftPMTestWorkspace {
 
 extension SKSwiftPMTestWorkspace {
   public func openDocument(_ url: URL, language: Language) throws {
-    testServer.send(
+    testClient.send(
       DidOpenTextDocumentNotification(
         textDocument: TextDocumentItem(
           uri: DocumentURI(url),
@@ -164,15 +169,15 @@ extension SKSwiftPMTestWorkspace {
   }
 
   public func closeDocument(_ url: URL) {
-    testServer.send(DidCloseTextDocumentNotification(textDocument: TextDocumentIdentifier(DocumentURI(url))))
+    testClient.send(DidCloseTextDocumentNotification(textDocument: TextDocumentIdentifier(DocumentURI(url))))
   }
 }
 
 extension XCTestCase {
 
   public func staticSourceKitSwiftPMWorkspace(
     name: String,
-    server: TestSourceKitServer? = nil
+    testClient: TestSourceKitLSPClient? = nil
   ) async throws -> SKSwiftPMTestWorkspace? {
     let testDirName = testDirectoryName
     let toolchain = ToolchainRegistry.shared.default!
@@ -181,7 +186,7 @@ extension XCTestCase {
       tmpDir: URL(fileURLWithPath: NSTemporaryDirectory(), isDirectory: true)
         .appendingPathComponent("sk-test-data/\(testDirName)/\(name)", isDirectory: true),
       toolchain: toolchain,
-      testServer: server
+      testClient: testClient
     )
 
     let hasClangFile: Bool = workspace.sources.locations.contains { _, loc in

Sources/SKTestSupport/SKTibsTestWorkspace.swift

@@ -36,7 +36,7 @@ fileprivate extension SourceKitServer {
 public final class SKTibsTestWorkspace {
 
   public let tibsWorkspace: TibsTestWorkspace
-  public let testServer: TestSourceKitServer
+  public let testClient: TestSourceKitLSPClient
 
   public var index: IndexStoreDB { tibsWorkspace.index }
   public var builder: TibsBuilder { tibsWorkspace.builder }
@@ -49,9 +49,9 @@ public final class SKTibsTestWorkspace {
     removeTmpDir: Bool,
     toolchain: Toolchain,
     clientCapabilities: ClientCapabilities,
-    testServer: TestSourceKitServer? = nil
+    testClient: TestSourceKitLSPClient? = nil
   ) async throws {
-    self.testServer = testServer ?? TestSourceKitServer()
+    self.testClient = testClient ?? TestSourceKitLSPClient()
     self.tibsWorkspace = try TibsTestWorkspace(
       immutableProjectDir: immutableProjectDir,
       persistentBuildDir: persistentBuildDir,
@@ -68,9 +68,9 @@ public final class SKTibsTestWorkspace {
     tmpDir: URL,
     toolchain: Toolchain,
     clientCapabilities: ClientCapabilities,
-    testServer: TestSourceKitServer? = nil
+    testClient: TestSourceKitLSPClient? = nil
   ) async throws {
-    self.testServer = testServer ?? TestSourceKitServer()
+    self.testClient = testClient ?? TestSourceKitLSPClient()
 
     self.tibsWorkspace = try TibsTestWorkspace(
       projectDir: projectDir,
@@ -98,8 +98,8 @@ public final class SKTibsTestWorkspace {
       indexDelegate: indexDelegate
     )
 
-    await workspace.buildSystemManager.setDelegate(testServer.server)
-    await testServer.server.setWorkspaces([workspace])
+    await workspace.buildSystemManager.setDelegate(testClient.server)
+    await testClient.server.setWorkspaces([workspace])
   }
 }
 
@@ -122,7 +122,7 @@ extension SKTibsTestWorkspace {
 
 extension SKTibsTestWorkspace {
   public func openDocument(_ url: URL, language: Language) throws {
-    testServer.send(
+    testClient.send(
       DidOpenTextDocumentNotification(
         textDocument: TextDocumentItem(
           uri: DocumentURI(url),
@@ -142,7 +142,7 @@ extension XCTestCase {
     clientCapabilities: ClientCapabilities = .init(),
     tmpDir: URL? = nil,
     removeTmpDir: Bool = true,
-    server: TestSourceKitServer? = nil
+    testClient: TestSourceKitLSPClient? = nil
   ) async throws -> SKTibsTestWorkspace? {
     let testDirName = testDirectoryName
     let workspace = try await SKTibsTestWorkspace(
@@ -156,7 +156,7 @@ extension XCTestCase {
       removeTmpDir: removeTmpDir,
       toolchain: ToolchainRegistry.shared.default!,
       clientCapabilities: clientCapabilities,
-      testServer: server
+      testClient: testClient
     )
 
     if workspace.builder.targets.contains(where: { target in !target.clangTUs.isEmpty })

Sources/SKTestSupport/TestServer.swift renamed to Sources/SKTestSupport/TestSourceKitLSPClient.swift

@@ -19,7 +19,13 @@ import SKSupport
 import SourceKitLSP
 import XCTest
 
-public final class TestSourceKitServer: MessageHandler {
+/// A mock SourceKit-LSP client (aka. a mock editor) that behaves like an editor
+/// for testing purposes.
+///
+/// It can send requests to the LSP server and receive requests or notifications
+/// that the server sends to the client.
+public final class TestSourceKitLSPClient: MessageHandler {
+  /// A function that takes a request and returns the request's response.
   public typealias RequestHandler<Request: RequestType> = (Request) -> Request.Response
 
   public static let serverOptions: SourceKitServer.Options = SourceKitServer.Options()
@@ -37,7 +43,7 @@ public final class TestSourceKitServer: MessageHandler {
   public let server: SourceKitServer
 
   /// The connection via which the server sends requests and notifications to us.
-  private let clientConnection: LocalConnection
+  private let serverToClientConnection: LocalConnection
 
   /// Stream of the notifications that the server has sent to the client.
   private let notifications: AsyncStream<any NotificationType>
@@ -72,7 +78,7 @@ public final class TestSourceKitServer: MessageHandler {
     self.notificationYielder = notificationYielder
 
     let clientConnection = LocalConnection()
-    self.clientConnection = clientConnection
+    self.serverToClientConnection = clientConnection
     server = SourceKitServer(
       client: clientConnection,
       options: serverOptions,
@@ -81,7 +87,7 @@ public final class TestSourceKitServer: MessageHandler {
       }
     )
 
-    self.clientConnection.start(handler: WeakMessageHandler(self))
+    self.serverToClientConnection.start(handler: WeakMessageHandler(self))
   }
 
   deinit {
@@ -207,6 +213,8 @@ public final class TestSourceKitServer: MessageHandler {
   }
 }
 
+// MARK: - WeakMessageHelper
+
 /// Wrapper around a weak `MessageHandler`.
 ///
 /// This allows us to set the ``TestSourceKitServer`` as the message handler of

Tests/SKSwiftPMWorkspaceTests/SwiftPMWorkspaceTests.swift

@@ -44,7 +44,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
           workspacePath: packageRoot,
           toolchainRegistry: tr,
           fileSystem: fs,
-          buildSetup: TestSourceKitServer.serverOptions.buildSetup
+          buildSetup: TestSourceKitLSPClient.serverOptions.buildSetup
         )
       )
     }
@@ -71,7 +71,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
           workspacePath: packageRoot,
           toolchainRegistry: tr,
           fileSystem: fs,
-          buildSetup: TestSourceKitServer.serverOptions.buildSetup
+          buildSetup: TestSourceKitLSPClient.serverOptions.buildSetup
         )
       )
     }
@@ -98,7 +98,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
           workspacePath: packageRoot,
           toolchainRegistry: ToolchainRegistry(),
           fileSystem: fs,
-          buildSetup: TestSourceKitServer.serverOptions.buildSetup
+          buildSetup: TestSourceKitLSPClient.serverOptions.buildSetup
         )
       )
     }
@@ -126,7 +126,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
         workspacePath: packageRoot,
         toolchainRegistry: tr,
         fileSystem: fs,
-        buildSetup: TestSourceKitServer.serverOptions.buildSetup
+        buildSetup: TestSourceKitLSPClient.serverOptions.buildSetup
       )
 
       let aswift = packageRoot.appending(components: "Sources", "lib", "a.swift")
@@ -231,7 +231,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
         workspacePath: packageRoot,
         toolchainRegistry: tr,
         fileSystem: fs,
-        buildSetup: TestSourceKitServer.serverOptions.buildSetup
+        buildSetup: TestSourceKitLSPClient.serverOptions.buildSetup
       )
 
       let source = try resolveSymlinks(packageRoot.appending(component: "Package.swift"))
@@ -265,7 +265,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
         workspacePath: packageRoot,
         toolchainRegistry: tr,
         fileSystem: fs,
-        buildSetup: TestSourceKitServer.serverOptions.buildSetup
+        buildSetup: TestSourceKitLSPClient.serverOptions.buildSetup
       )
 
       let aswift = packageRoot.appending(components: "Sources", "lib", "a.swift")
@@ -309,7 +309,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
         workspacePath: packageRoot,
         toolchainRegistry: tr,
         fileSystem: fs,
-        buildSetup: TestSourceKitServer.serverOptions.buildSetup
+        buildSetup: TestSourceKitLSPClient.serverOptions.buildSetup
       )
 
       let aswift = packageRoot.appending(components: "Sources", "libA", "a.swift")
@@ -371,7 +371,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
         workspacePath: packageRoot,
         toolchainRegistry: tr,
         fileSystem: fs,
-        buildSetup: TestSourceKitServer.serverOptions.buildSetup
+        buildSetup: TestSourceKitLSPClient.serverOptions.buildSetup
       )
 
       let aswift = packageRoot.appending(components: "Sources", "libA", "a.swift")
@@ -407,7 +407,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
         workspacePath: packageRoot,
         toolchainRegistry: tr,
         fileSystem: fs,
-        buildSetup: TestSourceKitServer.serverOptions.buildSetup
+        buildSetup: TestSourceKitLSPClient.serverOptions.buildSetup
       )
 
       let acxx = packageRoot.appending(components: "Sources", "lib", "a.cpp")
@@ -499,7 +499,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
         workspacePath: packageRoot,
         toolchainRegistry: ToolchainRegistry.shared,
         fileSystem: fs,
-        buildSetup: TestSourceKitServer.serverOptions.buildSetup
+        buildSetup: TestSourceKitLSPClient.serverOptions.buildSetup
       )
 
       let aswift = packageRoot.appending(components: "Sources", "lib", "a.swift")
@@ -547,7 +547,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
         workspacePath: packageRoot,
         toolchainRegistry: tr,
         fileSystem: fs,
-        buildSetup: TestSourceKitServer.serverOptions.buildSetup
+        buildSetup: TestSourceKitLSPClient.serverOptions.buildSetup
       )
 
       let aswift1 = packageRoot.appending(components: "Sources", "lib", "a.swift")
@@ -606,7 +606,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
         workspacePath: packageRoot,
         toolchainRegistry: tr,
         fileSystem: fs,
-        buildSetup: TestSourceKitServer.serverOptions.buildSetup
+        buildSetup: TestSourceKitLSPClient.serverOptions.buildSetup
       )
 
       let acxx = packageRoot.appending(components: "Sources", "lib", "a.cpp")
@@ -651,7 +651,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
         workspacePath: packageRoot,
         toolchainRegistry: tr,
         fileSystem: fs,
-        buildSetup: TestSourceKitServer.serverOptions.buildSetup
+        buildSetup: TestSourceKitLSPClient.serverOptions.buildSetup
       )
 
       let aswift = packageRoot.appending(components: "Sources", "lib", "a.swift")
@@ -687,7 +687,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
         workspacePath: packageRoot,
         toolchainRegistry: tr,
         fileSystem: fs,
-        buildSetup: TestSourceKitServer.serverOptions.buildSetup
+        buildSetup: TestSourceKitLSPClient.serverOptions.buildSetup
       )
 
       assertEqual(await ws._packageRoot, try resolveSymlinks(tempDir.appending(component: "pkg")))
@@ -734,7 +734,7 @@ private func check(
 
 private func buildPath(
   root: AbsolutePath,
-  config: BuildSetup = TestSourceKitServer.serverOptions.buildSetup,
+  config: BuildSetup = TestSourceKitLSPClient.serverOptions.buildSetup,
   platform: String
 ) -> AbsolutePath {
   let buildPath = config.path ?? root.appending(component: ".build")