Rename test projects for consistency

Rename all the classes that write files to disk to create a test project that we can open in sourcekit-lsp to end with `TestProject`. This is better than the old `Workspace` suffix because it avoids ambiguities with the `Workspace` type inside sourcekit-lsp.

- IndexedSingleSwiftFileWorkspace -> IndexedSingleSwiftFileTestProject
- MultiFileTestWorkspace -> MultiFileTestProject
- SwiftPMTestWorkspace -> SwiftPMTestProject

Author: ahoppen

Sources/SKTestSupport/IndexedSingleSwiftFileWorkspace.swift renamed to Sources/SKTestSupport/IndexedSingleSwiftFileTestProject.swift

@@ -17,7 +17,7 @@ import LanguageServerProtocol
 import SourceKitLSP
 import TSCBasic
 
-public struct IndexedSingleSwiftFileWorkspace {
+public struct IndexedSingleSwiftFileTestProject {
   enum Error: Swift.Error {
     case swiftcNotFound
   }

Sources/SKTestSupport/MultiFileTestWorkspace.swift renamed to Sources/SKTestSupport/MultiFileTestProject.swift

@@ -33,11 +33,11 @@ public struct RelativeFileLocation: Hashable, ExpressibleByStringLiteral {
   }
 }
 
-/// A workspace that writes multiple files to disk and opens a `TestSourceKitLSPClient` client with a workspace pointing
-/// to a temporary directory containing those files.
+/// A test project that writes multiple files to disk and opens a `TestSourceKitLSPClient` client with a workspace
+/// pointing to a temporary directory containing those files.
 ///
 /// The temporary files will be deleted when the `TestSourceKitLSPClient` is destructed.
-public class MultiFileTestWorkspace {
+public class MultiFileTestProject {
   /// Information necessary to open a file in the LSP server by its filename.
   private struct FileData {
     /// The URI at which the file is stored on disk.
@@ -53,7 +53,7 @@ public class MultiFileTestWorkspace {
   private let fileData: [String: FileData]
 
   enum Error: Swift.Error {
-    /// No file with the given filename is known to the `SwiftPMTestWorkspace`.
+    /// No file with the given filename is known to the `MultiFileTestProject`.
     case fileNotFound
   }
 

Sources/SKTestSupport/SkipUnless.swift

@@ -180,7 +180,7 @@ public enum SkipUnless {
     line: UInt = #line
   ) async throws {
     try await skipUnlessSupportedByToolchain(swiftVersion: SwiftVersion(5, 11), file: file, line: line) {
-      let workspace = try await SwiftPMTestWorkspace(
+      let workspace = try await SwiftPMTestProject(
         files: ["test.swift": ""],
         build: true
       )

Sources/SKTestSupport/SwiftPMTestWorkspace.swift renamed to Sources/SKTestSupport/SwiftPMTestProject.swift

@@ -15,7 +15,7 @@ import LanguageServerProtocol
 @_spi(Testing) import SKCore
 import TSCBasic
 
-public class SwiftPMTestWorkspace: MultiFileTestWorkspace {
+public class SwiftPMTestProject: MultiFileTestProject {
   enum Error: Swift.Error {
     /// The `swift` executable could not be found.
     case swiftNotFound
@@ -37,7 +37,7 @@ public class SwiftPMTestWorkspace: MultiFileTestWorkspace {
   /// If `index` is `true`, then the package will be built, indexing all modules within the package.
   public init(
     files: [RelativeFileLocation: String],
-    manifest: String = SwiftPMTestWorkspace.defaultPackageManifest,
+    manifest: String = SwiftPMTestProject.defaultPackageManifest,
     workspaces: (URL) -> [WorkspaceFolder] = { [WorkspaceFolder(uri: DocumentURI($0))] },
     build: Bool = false,
     usePullDiagnostics: Bool = true,

Sources/SKTestSupport/TestSourceKitLSPClient.swift

@@ -70,7 +70,7 @@ public final class TestSourceKitLSPClient: MessageHandler {
 
   /// A closure that is called when the `TestSourceKitLSPClient` is destructed.
   ///
-  /// This allows e.g. a `IndexedSingleSwiftFileWorkspace` to delete its temporary files when they are no longer needed.
+  /// This allows e.g. a `IndexedSingleSwiftFileTestProject` to delete its temporary files when they are no longer needed.
   private let cleanUp: () -> Void
 
   /// - Parameters:
@@ -84,7 +84,7 @@ public final class TestSourceKitLSPClient: MessageHandler {
   ///   - usePullDiagnostics: Whether to use push diagnostics or use push-based diagnostics
   ///   - workspaceFolders: Workspace folders to open.
   ///   - cleanUp: A closure that is called when the `TestSourceKitLSPClient` is destructed.
-  ///     This allows e.g. a `IndexedSingleSwiftFileWorkspace` to delete its temporary files when they are no longer
+  ///     This allows e.g. a `IndexedSingleSwiftFileTestProject` to delete its temporary files when they are no longer
   ///     needed.
   public init(
     serverOptions: SourceKitLSPServer.Options = .testDefault,

Tests/SourceKitDTests/CrashRecoveryTests.swift

@@ -202,7 +202,7 @@ final class CrashRecoveryTests: XCTestCase {
   func testClangdCrashRecoveryReopensWithCorrectBuildSettings() async throws {
     try SkipUnless.longTestsEnabled()
 
-    let ws = try await MultiFileTestWorkspace(files: [
+    let ws = try await MultiFileTestProject(files: [
       "main.cpp": """
       #if FOO
       void 1️⃣foo2️⃣() {}

Tests/SourceKitLSPTests/CallHierarchyTests.swift

@@ -19,7 +19,7 @@ import XCTest
 
 final class CallHierarchyTests: XCTestCase {
   func testCallHierarchy() async throws {
-    let ws = try await IndexedSingleSwiftFileWorkspace(
+    let ws = try await IndexedSingleSwiftFileTestProject(
       """
       func 1️⃣a() {}
 
@@ -185,7 +185,7 @@ final class CallHierarchyTests: XCTestCase {
   }
 
   func testReportSingleItemInPrepareCallHierarchy() async throws {
-    let ws = try await SwiftPMTestWorkspace(
+    let ws = try await SwiftPMTestProject(
       files: [
         "MyLibrary/include/lib.h": """
         struct FilePathIndex {
@@ -227,7 +227,7 @@ final class CallHierarchyTests: XCTestCase {
 
   func testIncomingCallHierarchyShowsSurroundingFunctionCall() async throws {
     // We used to show `myVar` as the caller here
-    let ws = try await IndexedSingleSwiftFileWorkspace(
+    let ws = try await IndexedSingleSwiftFileTestProject(
       """
       func 1️⃣foo() {}
 
@@ -268,7 +268,7 @@ final class CallHierarchyTests: XCTestCase {
   }
 
   func testIncomingCallHierarchyFromComputedProperty() async throws {
-    let ws = try await IndexedSingleSwiftFileWorkspace(
+    let ws = try await IndexedSingleSwiftFileTestProject(
       """
       func 1️⃣foo() {}
 
@@ -310,7 +310,7 @@ final class CallHierarchyTests: XCTestCase {
   }
 
   func testIncomingCallHierarchyShowsAccessToVariables() async throws {
-    let ws = try await IndexedSingleSwiftFileWorkspace(
+    let ws = try await IndexedSingleSwiftFileTestProject(
       """
       var 1️⃣foo: Int
       func 2️⃣testFunc() {
@@ -368,7 +368,7 @@ final class CallHierarchyTests: XCTestCase {
   }
 
   func testOutgoingCallHierarchyShowsAccessesToVariable() async throws {
-    let ws = try await IndexedSingleSwiftFileWorkspace(
+    let ws = try await IndexedSingleSwiftFileTestProject(
       """
       var 1️⃣foo: Int
       func 2️⃣testFunc() {
@@ -409,7 +409,7 @@ final class CallHierarchyTests: XCTestCase {
   }
 
   func testOutgoingCallHierarchyFromVariableAccessor() async throws {
-    let ws = try await IndexedSingleSwiftFileWorkspace(
+    let ws = try await IndexedSingleSwiftFileTestProject(
       """
       func 1️⃣testFunc() -> Int { 0 }
       var 2️⃣foo: Int {
@@ -449,7 +449,7 @@ final class CallHierarchyTests: XCTestCase {
   }
 
   func testIncomingCallHierarchyLooksThroughProtocols() async throws {
-    let ws = try await IndexedSingleSwiftFileWorkspace(
+    let ws = try await IndexedSingleSwiftFileTestProject(
       """
       protocol MyProtocol {
         func foo()
@@ -498,7 +498,7 @@ final class CallHierarchyTests: XCTestCase {
   }
 
   func testIncomingCallHierarchyLooksThroughSuperclasses() async throws {
-    let ws = try await IndexedSingleSwiftFileWorkspace(
+    let ws = try await IndexedSingleSwiftFileTestProject(
       """
       class Base {
         func foo() {}

Tests/SourceKitLSPTests/ClangdTests.swift

@@ -16,7 +16,7 @@ import XCTest
 
 final class ClangdTests: XCTestCase {
   func testClangdGoToInclude() async throws {
-    let ws = try await MultiFileTestWorkspace(files: [
+    let ws = try await MultiFileTestProject(files: [
       "Object.h": "",
       "main.c": """
       #include 1️⃣"Object.h"
@@ -47,7 +47,7 @@ final class ClangdTests: XCTestCase {
   }
 
   func testClangdGoToDefinitionWithoutIndex() async throws {
-    let ws = try await MultiFileTestWorkspace(files: [
+    let ws = try await MultiFileTestProject(files: [
       "Object.h": """
       struct Object {
         int field;
@@ -87,7 +87,7 @@ final class ClangdTests: XCTestCase {
   }
 
   func testClangdGoToDeclaration() async throws {
-    let ws = try await MultiFileTestWorkspace(files: [
+    let ws = try await MultiFileTestProject(files: [
       "Object.h": """
       struct Object {
         int field;

Tests/SourceKitLSPTests/CodeActionTests.swift

@@ -430,7 +430,7 @@ final class CodeActionTests: XCTestCase {
   }
 
   func testCodeActionForFixItsProducedBySwiftSyntax() async throws {
-    let ws = try await MultiFileTestWorkspace(files: [
+    let ws = try await MultiFileTestProject(files: [
       "test.swift": "protocol 1️⃣Multi 2️⃣ident 3️⃣{}",
       "compile_commands.json": "[]",
     ])

Tests/SourceKitLSPTests/CompilationDatabaseTests.swift

@@ -19,7 +19,7 @@ import XCTest
 
 final class CompilationDatabaseTests: XCTestCase {
   func testModifyCompilationDatabase() async throws {
-    let ws = try await MultiFileTestWorkspace(files: [
+    let ws = try await MultiFileTestProject(files: [
       "main.cpp": """
       #if FOO
       void 1️⃣foo2️⃣() {}