Define the sources of ClangCrashRecoveryBuildSettings inline with the tests

Author: ahoppen

Sources/SKTestSupport/INPUTS/ClangCrashRecoveryBuildSettings/main.cpp

@@ -62,6 +62,7 @@ public class MultiFileTestWorkspace {
 
   public init(
     files: [RelativeFileLocation: String],
+    workspaces: (URL) -> [WorkspaceFolder] = { [WorkspaceFolder(uri: DocumentURI($0))] },
     testName: String = #function
   ) async throws {
     scratchDirectory = try testScratchDir(testName: testName)
@@ -92,9 +93,7 @@ public class MultiFileTestWorkspace {
     self.fileData = fileData
 
     self.testClient = try await TestSourceKitLSPClient(
-      workspaceFolders: [
-        WorkspaceFolder(uri: DocumentURI(scratchDirectory))
-      ],
+      workspaceFolders: workspaces(scratchDirectory),
       cleanUp: { [scratchDirectory] in
         try? FileManager.default.removeItem(at: scratchDirectory)
       }

Sources/SKTestSupport/INPUTS/ClangCrashRecoveryBuildSettings/project.json

@@ -218,21 +218,35 @@ final class CrashRecoveryTests: XCTestCase {
   func testClangdCrashRecoveryReopensWithCorrectBuildSettings() async throws {
     try XCTSkipIf(longTestsDisabled)
 
-    let ws = try await staticSourceKitTibsWorkspace(name: "ClangCrashRecoveryBuildSettings")!
-    let loc = ws.testLoc("loc")
+    let ws = try await MultiFileTestWorkspace(files: [
+      "main.cpp": """
+      #if FOO
+      void 1️⃣foo2️⃣() {}
+      #else
+      void foo() {}
+      #endif
+
+      int main() {
+        3️⃣foo4️⃣();
+      }
+      """,
+      "compile_flags.txt": """
+      -DFOO
+      """,
+    ])
 
-    try ws.openDocument(loc.url, language: .cpp)
+    let (mainUri, positions) = try ws.openDocument("main.cpp")
 
     // Do a sanity check and verify that we get the expected result from a hover response before crashing clangd.
 
     let expectedHighlightResponse = [
-      DocumentHighlight(range: Position(line: 3, utf16index: 5)..<Position(line: 3, utf16index: 8), kind: .text),
-      DocumentHighlight(range: Position(line: 9, utf16index: 2)..<Position(line: 9, utf16index: 5), kind: .text),
+      DocumentHighlight(range: positions["1️⃣"]..<positions["2️⃣"], kind: .text),
+      DocumentHighlight(range: positions["3️⃣"]..<positions["4️⃣"], kind: .text),
     ]
 
     let highlightRequest = DocumentHighlightRequest(
-      textDocument: loc.docIdentifier,
-      position: Position(line: 9, utf16index: 3)
+      textDocument: TextDocumentIdentifier(mainUri),
+      position: positions["3️⃣"]
     )
     let preCrashHighlightResponse = try await ws.testClient.send(highlightRequest)
     precondition(
@@ -242,7 +256,7 @@ final class CrashRecoveryTests: XCTestCase {
 
     // Crash clangd
 
-    try await crashClangd(for: ws.testClient, document: loc.docUri)
+    try await crashClangd(for: ws.testClient, document: mainUri)
 
     // Check that we have re-opened the document with the correct build settings
     // If we did not recover the correct build settings, document highlight would

Sources/SKTestSupport/MultiFileTestWorkspace.swift

@@ -13,64 +13,62 @@
 import Foundation
 import LanguageServerProtocol
 import SKCore
+import SKTestSupport
 import TSCBasic
 import XCTest
 
 final class CompilationDatabaseTests: XCTestCase {
   func testModifyCompilationDatabase() async throws {
-    let ws = try await mutableSourceKitTibsTestWorkspace(name: "ClangCrashRecoveryBuildSettings")!
-    let loc = ws.testLoc("loc")
+    let ws = try await MultiFileTestWorkspace(files: [
+      "main.cpp": """
+      #if FOO
+      void 1️⃣foo2️⃣() {}
+      #else
+      void 3️⃣foo4️⃣() {}
+      #endif
 
-    try ws.openDocument(loc.url, language: .cpp)
+      int main() {
+        5️⃣foo6️⃣();
+      }
+      """,
+      "compile_flags.txt": """
+      -DFOO
+      """,
+    ])
+
+    let (mainUri, positions) = try ws.openDocument("main.cpp")
 
     // Do a sanity check and verify that we get the expected result from a hover response before modifing the compile commands.
 
     let highlightRequest = DocumentHighlightRequest(
-      textDocument: loc.docIdentifier,
-      position: Position(line: 9, utf16index: 3)
+      textDocument: TextDocumentIdentifier(mainUri),
+      position: positions["5️⃣"]
     )
     let preChangeHighlightResponse = try await ws.testClient.send(highlightRequest)
     XCTAssertEqual(
       preChangeHighlightResponse,
       [
-        DocumentHighlight(range: Position(line: 3, utf16index: 5)..<Position(line: 3, utf16index: 8), kind: .text),
-        DocumentHighlight(range: Position(line: 9, utf16index: 2)..<Position(line: 9, utf16index: 5), kind: .text),
+        DocumentHighlight(range: positions["1️⃣"]..<positions["2️⃣"], kind: .text),
+        DocumentHighlight(range: positions["5️⃣"]..<positions["6️⃣"], kind: .text),
       ]
     )
 
     // Remove -DFOO from the compile commands.
 
-    let compilationDatabaseUrl = ws.builder.buildRoot.appendingPathComponent("compile_commands.json")
-
-    _ = try ws.sources.edit({ builder in
-      let compilationDatabase = try XCTUnwrap(
-        JSONCompilationDatabase(
-          file: AbsolutePath(validating: compilationDatabaseUrl.path)
-        )
-      )
-      let newCommands = compilationDatabase.allCommands.map {
-        (command: CompilationDatabaseCompileCommand) -> CompilationDatabaseCompileCommand in
-        var command = command
-        command.commandLine.removeAll(where: { $0 == "-DFOO" })
-        return command
-      }
-      let newCompilationDatabase = JSONCompilationDatabase(newCommands)
-      let newCompilationDatabaseData = try JSONEncoder().encode(newCompilationDatabase)
-      let newCompilationDatabaseStr = String(data: newCompilationDatabaseData, encoding: .utf8)!
-      builder.write(newCompilationDatabaseStr, to: compilationDatabaseUrl)
-    })
+    let compileFlagsUri = try ws.uri(for: "compile_flags.txt")
+    try "".write(to: compileFlagsUri.fileURL!, atomically: false, encoding: .utf8)
 
     ws.testClient.send(
       DidChangeWatchedFilesNotification(changes: [
-        FileEvent(uri: DocumentURI(compilationDatabaseUrl), type: .changed)
+        FileEvent(uri: compileFlagsUri, type: .changed)
       ])
     )
 
     // DocumentHighlight should now point to the definition in the `#else` block.
 
     let expectedPostEditHighlight = [
-      DocumentHighlight(range: Position(line: 5, utf16index: 5)..<Position(line: 5, utf16index: 8), kind: .text),
-      DocumentHighlight(range: Position(line: 9, utf16index: 2)..<Position(line: 9, utf16index: 5), kind: .text),
+      DocumentHighlight(range: positions["3️⃣"]..<positions["4️⃣"], kind: .text),
+      DocumentHighlight(range: positions["5️⃣"]..<positions["6️⃣"], kind: .text),
     ]
 
     var didReceiveCorrectHighlight = false

Tests/SourceKitDTests/CrashRecoveryTests.swift

@@ -118,37 +118,51 @@ final class WorkspaceTests: XCTestCase {
   }
 
   func testMultipleClangdWorkspaces() async throws {
-    guard let ws = try await staticSourceKitTibsWorkspace(name: "ClangModules") else { return }
-
-    let loc = ws.testLoc("main_file")
+    let ws = try await MultiFileTestWorkspace(
+      files: [
+        "WorkspaceA/main.cpp": """
+        #if FOO
+        void 1️⃣foo2️⃣() {}
+        #else
+        void foo() {}
+        #endif
+
+        int main() {
+          3️⃣foo4️⃣();
+        }
+        """,
+        "WorkspaceA/compile_flags.txt": """
+        -DFOO
+        """,
+        "WorkspaceB/test.m": "",
+      ],
+      workspaces: { scratchDir in
+        return [
+          WorkspaceFolder(uri: DocumentURI(scratchDir.appendingPathComponent("WorkspaceA"))),
+          WorkspaceFolder(uri: DocumentURI(scratchDir.appendingPathComponent("WorkspaceB"))),
+        ]
+      }
+    )
 
-    try ws.openDocument(loc.url, language: .objective_c)
+    _ = try ws.openDocument("test.m")
 
     let diags = try await ws.testClient.nextDiagnosticsNotification()
     XCTAssertEqual(diags.diagnostics.count, 0)
 
-    let otherWs = try await staticSourceKitTibsWorkspace(
-      name: "ClangCrashRecoveryBuildSettings",
-      testClient: ws.testClient
-    )!
-    assert(ws.testClient === otherWs.testClient, "Sanity check: The two workspaces should be opened in the same server")
-    let otherLoc = otherWs.testLoc("loc")
-
-    try otherWs.openDocument(otherLoc.url, language: .cpp)
-
-    // Do a sanity check and verify that we get the expected result from a hover response before crashing clangd.
-
-    let expectedHighlightResponse = [
-      DocumentHighlight(range: Position(line: 3, utf16index: 5)..<Position(line: 3, utf16index: 8), kind: .text),
-      DocumentHighlight(range: Position(line: 9, utf16index: 2)..<Position(line: 9, utf16index: 5), kind: .text),
-    ]
+    let (mainUri, positions) = try ws.openDocument("main.cpp")
 
     let highlightRequest = DocumentHighlightRequest(
-      textDocument: otherLoc.docIdentifier,
-      position: Position(line: 9, utf16index: 3)
+      textDocument: TextDocumentIdentifier(mainUri),
+      position: positions["3️⃣"]
+    )
+    let highlightResponse = try await ws.testClient.send(highlightRequest)
+    XCTAssertEqual(
+      highlightResponse,
+      [
+        DocumentHighlight(range: positions["1️⃣"]..<positions["2️⃣"], kind: .text),
+        DocumentHighlight(range: positions["3️⃣"]..<positions["4️⃣"], kind: .text),
+      ]
     )
-    let highlightResponse = try await otherWs.testClient.send(highlightRequest)
-    XCTAssertEqual(highlightResponse, expectedHighlightResponse)
   }
 
   func testRecomputeFileWorkspaceMembershipOnPackageSwiftChange() async throws {