Add a test case checking that documentDependenciesUpdated works for clang

We weren’t sure if it works because it always sends 0 as the document’s version number, but everythig appears to be fine.

Author: ahoppen

Sources/SKTestSupport/SourceKitServer+WorkspaceForDocumentOnQueue.swift

@@ -0,0 +1,22 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2022 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import LanguageServerProtocol
+import SourceKitLSP
+
+public extension SourceKitServer {
+  func workspaceForDocumentOnQueue(uri: DocumentURI) -> Workspace? {
+    self.queue.sync {
+      return self.workspaceForDocument(uri: uri)
+    }
+  }
+}

Tests/SourceKitDTests/CrashRecoveryTests.swift

@@ -40,14 +40,6 @@ fileprivate extension HoverResponse {
   }
 }
 
-fileprivate extension SourceKitServer {
-  func workspaceForDocumentOnQueue(uri: DocumentURI) -> Workspace? {
-    self.queue.sync {
-      return self.workspaceForDocument(uri: uri)
-    }
-  }
-}
-
 final class CrashRecoveryTests: XCTestCase {
   func testSourcekitdCrashRecovery() throws {
     try XCTSkipUnless(isDarwinHost, "Linux and Windows use in-process sourcekitd")

Tests/SourceKitLSPTests/LocalClangTests.swift

@@ -322,4 +322,43 @@ final class LocalClangTests: XCTestCase {
       throw e
     }
   }
+
+  func testDocumentDependenciesUpdated() throws {
+    let ws = try! mutableSourceKitTibsTestWorkspace(name: "BasicCXX")!
+
+    let cFileLoc = ws.testLoc("Object:ref:main")
+
+    // Initially the workspace should build fine.
+    let documentOpened = self.expectation(description: "documentOpened")
+    ws.sk.handleNextNotification({ (note: LanguageServerProtocol.Notification<PublishDiagnosticsNotification>) in
+      XCTAssert(note.params.diagnostics.isEmpty)
+      documentOpened.fulfill()
+    })
+
+    try! ws.openDocument(cFileLoc.url, language: .cpp)
+
+    self.wait(for: [documentOpened], timeout: 5)
+
+    // We rename Object to MyObject in the header.
+    _ = try ws.sources.edit { builder in
+      let headerFilePath = ws.sources.rootDirectory.appendingPathComponent("Object.h")
+      var headerFile = try! String(contentsOf: headerFilePath, encoding: .utf8)
+      let targetMarkerRange = headerFile.range(of: "/*Object*/")!
+      headerFile.replaceSubrange(targetMarkerRange, with: "My")
+      builder.write(headerFile, to: headerFilePath)
+    }
+
+    // Now we should get a diagnostic in main.c file because `Object` is no longer defined.
+    let updatedNotificationsReceived = self.expectation(description: "updatedNotificationsReceived")
+    ws.sk.handleNextNotification({ (note: LanguageServerProtocol.Notification<PublishDiagnosticsNotification>) in
+      XCTAssertFalse(note.params.diagnostics.isEmpty)
+      updatedNotificationsReceived.fulfill()
+    })
+
+    let clangdServer = ws.testServer.server!._languageService(for: cFileLoc.docUri, .cpp, in: ws.testServer.server!.workspaceForDocumentOnQueue(uri: cFileLoc.docUri)!)!
+
+    clangdServer.documentDependenciesUpdated(cFileLoc.docUri)
+
+    self.wait(for: [updatedNotificationsReceived], timeout: 5)
+  }
 }

Tests/SourceKitLSPTests/WorkspaceTests.swift

@@ -19,14 +19,6 @@ import SKTestSupport
 import TSCBasic
 import XCTest
 
-fileprivate extension SourceKitServer {
-  func workspaceForDocumentOnQueue(uri: DocumentURI) -> Workspace? {
-    self.queue.sync {
-      return self.workspaceForDocument(uri: uri)
-    }
-  }
-}
-
 final class WorkspaceTests: XCTestCase {
 
   func testMultipleSwiftPMWorkspaces() throws {