Add test case to check that build settings are recovered after a crash

Author: ahoppen

Tests/INPUTS/ClangCrashRecoveryBuildSettings/main.cpp

@@ -0,0 +1,11 @@
+/*loc*/
+
+#if FOO
+void foo() {}
+#else
+void foo() {}
+#endif
+
+int main() {
+  foo();
+}

Tests/INPUTS/ClangCrashRecoveryBuildSettings/project.json

@@ -0,0 +1,4 @@
+{
+  "clang_flags": ["-fno-modules", "-Wunused-variable", "-DFOO"],
+  "sources": ["main.cpp"]
+}

Tests/SourceKitTests/CrashRecoveryTests.swift

@@ -10,6 +10,7 @@
 //
 //===----------------------------------------------------------------------===//
 
+import ISDBTestSupport
 import LanguageServerProtocol
 import SourceKit
 import SKTestSupport
@@ -93,6 +94,40 @@ final class CrashRecoveryTests: XCTestCase {
       XCTAssertEqual(postCrashHoverResponse, expectedHoverResponse)
     }())
   }
+  
+  /// Crashes clangd and waits for it to restart
+  /// - Parameters:
+  ///   - ws: The workspace for which the clangd server shall be crashed
+  ///   - loc: A test location that points to the first line of a given file. This line needs to be otherwise empty.
+  private func crashClangd(for ws: SKTibsTestWorkspace, firstLineLoc loc: TestLocation) {
+    let clangdServer = ws.testServer.server!.languageService(for: loc.docUri, .cpp, in: ws.testServer.server!.workspace!)!
+    
+    let clangdCrashed = self.expectation(description: "clangd crashed")
+    let clangdRestarted = self.expectation(description: "clangd restarted")
+
+    clangdServer.addStateChangeHandler { (oldState, newState) in
+      switch newState {
+      case .connectionInterrupted:
+        clangdCrashed.fulfill()
+      case .connected:
+        clangdRestarted.fulfill()
+      default:
+        break
+      }
+    }
+
+    // Add a pragma to crash clang
+    let addCrashPragma = TextDocumentContentChangeEvent(range: loc.position..<loc.position, rangeLength: 0, text: "#pragma clang __debug crash\n")
+    ws.sk.send(DidChangeTextDocumentNotification(textDocument: VersionedTextDocumentIdentifier(loc.docUri, version: 3), contentChanges: [addCrashPragma]))
+
+    self.wait(for: [clangdCrashed], timeout: 5)
+
+    // Once clangds has crashed, remove the pragma again to allow it to restart
+    let removeCrashPragma = TextDocumentContentChangeEvent(range: loc.position..<Position(line: 1, utf16index: 0), rangeLength: 28, text: "")
+    ws.sk.send(DidChangeTextDocumentNotification(textDocument: VersionedTextDocumentIdentifier(loc.docUri, version: 4), contentChanges: [removeCrashPragma]))
+
+    self.wait(for: [clangdRestarted], timeout: 30)
+  }
 
   func testClangdCrashRecovery() {
     guard longTestsEnabled else {
@@ -130,33 +165,7 @@ final class CrashRecoveryTests: XCTestCase {
 
     // Crash clangd
 
-    let clangdServer = ws.testServer.server!.languageService(for: loc.docUri, .cpp, in: ws.testServer.server!.workspace!)!
-
-    let clangdCrashed = self.expectation(description: "clangd crashed")
-    let clangdRestarted = self.expectation(description: "clangd restarted")
-
-    clangdServer.addStateChangeHandler { (oldState, newState) in
-      switch newState {
-      case .connectionInterrupted:
-        clangdCrashed.fulfill()
-      case .connected:
-        clangdRestarted.fulfill()
-      default:
-        break
-      }
-    }
-
-    // Add a pragma to crash clang
-    let addCrashPragma = TextDocumentContentChangeEvent(range: loc.position..<loc.position, rangeLength: 0, text: "#pragma clang __debug crash\n")
-    ws.sk.send(DidChangeTextDocumentNotification(textDocument: VersionedTextDocumentIdentifier(loc.docUri, version: 3), contentChanges: [addCrashPragma]))
-
-    self.wait(for: [clangdCrashed], timeout: 5)
-
-    // Once clangds has crashed, remove the pragma again to allow it to restart
-    let removeCrashPragma = TextDocumentContentChangeEvent(range: loc.position..<Position(line: 1, utf16index: 0), rangeLength: 30, text: "")
-    ws.sk.send(DidChangeTextDocumentNotification(textDocument: VersionedTextDocumentIdentifier(loc.docUri, version: 4), contentChanges: [removeCrashPragma]))
-
-    self.wait(for: [clangdRestarted], timeout: 30)
+    crashClangd(for: ws, firstLineLoc: loc)
 
     // Check that we have re-opened the document with the correct in-memory state
 
@@ -165,5 +174,37 @@ final class CrashRecoveryTests: XCTestCase {
       XCTAssertEqual(postCrashHoverResponse, expectedHoverResponse)
     }())
   }
+    
+  func testClangdCrashRecoveryReopensWithCorrectBuildSettings() {
+    let ws = try! staticSourceKitTibsWorkspace(name: "ClangCrashRecoveryBuildSettings")!
+    let loc = ws.testLoc("loc")
+    
+    try! ws.openDocument(loc.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 highlightRequest = DocumentHighlightRequest(textDocument: loc.docIdentifier, position: Position(line: 9, utf16index: 3))
+    let preCrashHighlightResponse = try! ws.sk.sendSync(highlightRequest)
+    precondition(preCrashHighlightResponse == expectedHighlightResponse, "Sanity check failed. The Hover response was not what we expected, even before crashing sourcekitd")
+    
+    // Crash clangd
+
+    crashClangd(for: ws, firstLineLoc: loc)
+    
+    // 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
+    // pick the definition of foo() in the #else branch.
+
+    XCTAssertNoThrow(try {
+      let postCrashHighlightResponse = try ws.sk.sendSync(highlightRequest)
+      XCTAssertEqual(postCrashHighlightResponse, expectedHighlightResponse)
+    }())
+  }
 }