Merge pull request #1358 from ahoppen/switch-test-to-background-indexing

Switch most tests to use background indexing instead of building the project

Author: ahoppen

Sources/SKTestSupport/SkipUnless.swift

@@ -175,10 +175,8 @@ public actor SkipUnless {
     line: UInt = #line
   ) async throws {
     try await shared.skipUnlessSupportedByToolchain(swiftVersion: SwiftVersion(5, 11), file: file, line: line) {
-      let workspace = try await SwiftPMTestProject(
-        files: ["test.swift": ""],
-        build: true
-      )
+      let workspace = try await SwiftPMTestProject(files: ["test.swift": ""])
+      try await SwiftPMTestProject.build(at: workspace.scratchDirectory)
       let modulesDirectory = workspace.scratchDirectory
         .appendingPathComponent(".build")
         .appendingPathComponent("debug")

Sources/SKTestSupport/SwiftPMTestProject.swift

@@ -40,8 +40,6 @@ public class SwiftPMTestProject: MultiFileTestProject {
     files: [RelativeFileLocation: String],
     manifest: String = SwiftPMTestProject.defaultPackageManifest,
     workspaces: (URL) async throws -> [WorkspaceFolder] = { [WorkspaceFolder(uri: DocumentURI($0))] },
-    build: Bool = false,
-    allowBuildFailure: Bool = false,
     capabilities: ClientCapabilities = ClientCapabilities(),
     serverOptions: SourceKitLSPServer.Options = .testDefault,
     enableBackgroundIndexing: Bool = false,
@@ -79,13 +77,6 @@ public class SwiftPMTestProject: MultiFileTestProject {
       testName: testName
     )
 
-    if build {
-      if allowBuildFailure {
-        try? await Self.build(at: self.scratchDirectory)
-      } else {
-        try await Self.build(at: self.scratchDirectory)
-      }
-    }
     if pollIndex {
       // Wait for the indexstore-db to finish indexing
       _ = try await testClient.send(PollIndexRequest())

Tests/SourceKitLSPTests/CallHierarchyTests.swift

@@ -200,7 +200,7 @@ final class CallHierarchyTests: XCTestCase {
         void FilePathIndex::2️⃣foo() {}
         """,
       ],
-      build: true
+      enableBackgroundIndexing: true
     )
     let (uri, positions) = try project.openDocument("lib.h", language: .cpp)
     let result = try await project.testClient.send(

Tests/SourceKitLSPTests/DefinitionTests.swift

@@ -126,7 +126,7 @@ class DefinitionTests: XCTestCase {
         }
         """,
       ],
-      build: true
+      enableBackgroundIndexing: true
     )
     let (uri, positions) = try project.openDocument("test.cpp")
 
@@ -177,7 +177,7 @@ class DefinitionTests: XCTestCase {
           ]
         )
         """,
-      build: true
+      enableBackgroundIndexing: true
     )
 
     let (uri, positions) = try project.openDocument("main.swift")
@@ -391,8 +391,7 @@ class DefinitionTests: XCTestCase {
         }
         """,
       ],
-      build: true,
-      allowBuildFailure: true
+      enableBackgroundIndexing: true
     )
 
     let (bUri, bPositions) = try project.openDocument("FileB.swift")
@@ -428,12 +427,11 @@ class DefinitionTests: XCTestCase {
       .locations([Location(uri: aUri, range: Range(updatedAPositions["2️⃣"]))])
     )
 
-    try await SwiftPMTestProject.build(at: project.scratchDirectory)
-    let afterBuilding = try await project.testClient.send(
+    let afterChange = try await project.testClient.send(
       DefinitionRequest(textDocument: TextDocumentIdentifier(bUri), position: bPositions["1️⃣"])
     )
     XCTAssertEqual(
-      afterBuilding,
+      afterChange,
       .locations([Location(uri: aUri, range: Range(updatedAPositions["2️⃣"]))])
     )
   }
@@ -517,7 +515,7 @@ class DefinitionTests: XCTestCase {
         }
         """,
       ],
-      build: true
+      enableBackgroundIndexing: true
     )
 
     let definitionUri = try project.uri(for: "definition.swift")
@@ -549,8 +547,6 @@ class DefinitionTests: XCTestCase {
       ])
     )
 
-    try await SwiftPMTestProject.build(at: project.scratchDirectory)
-
     let resultAfterFileMove = try await project.testClient.send(
       DefinitionRequest(textDocument: TextDocumentIdentifier(callerUri), position: callerPositions["2️⃣"])
     )

Tests/SourceKitLSPTests/DependencyTrackingTests.swift

@@ -50,8 +50,6 @@ final class DependencyTrackingTests: XCTestCase {
     // Semantic analysis: expect module import error.
     XCTAssertEqual(initialDiags.diagnostics.count, 1)
     if let diagnostic = initialDiags.diagnostics.first {
-      // FIXME: The error message for the missing module is misleading on Darwin
-      // https://github.com/apple/swift-package-manager/issues/5925
       XCTAssert(
         diagnostic.message.contains("Could not build Objective-C module")
           || diagnostic.message.contains("No such module"),

Tests/SourceKitLSPTests/DocumentTestDiscoveryTests.swift

@@ -48,7 +48,7 @@ final class DocumentTestDiscoveryTests: XCTestCase {
           targets: [.testTarget(name: "MyLibraryTests")]
         )
         """,
-      build: true
+      enableBackgroundIndexing: true
     )
 
     let (uri, positions) = try project.openDocument("MyTests.swift")
@@ -1304,7 +1304,7 @@ final class DocumentTestDiscoveryTests: XCTestCase {
           targets: [.testTarget(name: "MyLibraryTests")]
         )
         """,
-      build: true
+      enableBackgroundIndexing: true
     )
 
     let (uri, positions) = try project.openDocument("Test.m")
@@ -1363,7 +1363,7 @@ final class DocumentTestDiscoveryTests: XCTestCase {
           targets: [.testTarget(name: "MyLibraryTests")]
         )
         """,
-      build: true
+      enableBackgroundIndexing: true
     )
 
     let (uri, positions) = try project.openDocument("Test.m")

Tests/SourceKitLSPTests/ImplementationTests.swift

@@ -296,7 +296,7 @@ final class ImplementationTests: XCTestCase {
         struct MyStruct: 2️⃣MyProto {}
         """,
       ],
-      build: true
+      enableBackgroundIndexing: true
     )
 
     let (aUri, aPositions) = try project.openDocument("a.swift")

Tests/SourceKitLSPTests/IndexTests.swift

@@ -48,7 +48,7 @@ final class IndexTests: XCTestCase {
           ]
         )
         """,
-      build: true
+      enableBackgroundIndexing: true
     )
 
     let (libAUri, libAPositions) = try project.openDocument("LibA.swift")

Tests/SourceKitLSPTests/MainFilesProviderTests.swift

@@ -45,7 +45,6 @@ final class MainFilesProviderTests: XCTestCase {
           ]
         )
         """,
-      build: false,
       usePullDiagnostics: false
     )
 
@@ -86,7 +85,6 @@ final class MainFilesProviderTests: XCTestCase {
           ]
         )
         """,
-      build: false,
       usePullDiagnostics: false
     )
 
@@ -143,7 +141,7 @@ final class MainFilesProviderTests: XCTestCase {
           ]
         )
         """,
-      build: true,
+      enableBackgroundIndexing: true,
       usePullDiagnostics: false
     )
 
@@ -192,7 +190,7 @@ final class MainFilesProviderTests: XCTestCase {
           ]
         )
         """,
-      build: true,
+      enableBackgroundIndexing: true,
       usePullDiagnostics: false
     )
 
@@ -208,10 +206,11 @@ final class MainFilesProviderTests: XCTestCase {
     let newFancyLibraryContents = """
       #include "\(project.scratchDirectory.path)/Sources/shared.h"
       """
-    let fancyLibraryURL = try project.uri(for: "MyFancyLibrary.c").fileURL!
-    try newFancyLibraryContents.write(to: fancyLibraryURL, atomically: false, encoding: .utf8)
-
-    try await SwiftPMTestProject.build(at: project.scratchDirectory)
+    let fancyLibraryUri = try project.uri(for: "MyFancyLibrary.c")
+    try newFancyLibraryContents.write(to: try XCTUnwrap(fancyLibraryUri.fileURL), atomically: false, encoding: .utf8)
+    project.testClient.send(
+      DidChangeWatchedFilesNotification(changes: [FileEvent(uri: fancyLibraryUri, type: .changed)])
+    )
 
     // 'MyFancyLibrary.c' now also includes 'shared.h'. Since it lexicographically preceeds MyLibrary, we should use its
     // build settings.

Tests/SourceKitLSPTests/RenameAssertions.swift

@@ -145,7 +145,7 @@ func assertMultiFileRename(
   let project = try await SwiftPMTestProject(
     files: files,
     manifest: manifest,
-    build: true,
+    enableBackgroundIndexing: true,
     testName: testName
   )
   try preRenameActions(project)