add a file registration test

Author: Richard Howell

Tests/INPUTS/BuildServerBuildSystemTests.testFileRegistration/buildServer.json

@@ -0,0 +1,7 @@
+{
+    "name": "client name",
+    "version": "10",
+    "bspVersion": "2.0",
+    "languages": ["a", "b"],
+    "argv": ["server.py"]
+}

Tests/INPUTS/BuildServerBuildSystemTests.testFileRegistration/server.py

@@ -0,0 +1,81 @@
+#!/usr/bin/env python
+
+import json
+import os
+import sys
+
+
+def send(data):
+    dataStr = json.dumps(data)
+    sys.stdout.write("Content-Length: {}\r\n\r\n{}".format(len(dataStr), dataStr))
+    sys.stdout.flush()
+
+
+while True:
+    line = sys.stdin.readline()
+    if len(line) == 0:
+        break
+
+    assert line.startswith('Content-Length:')
+    length = int(line[len('Content-Length:'):])
+    sys.stdin.readline()
+    message = json.loads(sys.stdin.read(length))
+
+    response = None
+    notification = None
+
+    if message["method"] == "build/initialize":
+        response = {
+            "jsonrpc": "2.0",
+            "id": message["id"],
+            "result": {
+                "displayName": "test server",
+                "version": "0.1",
+                "bspVersion": "2.0",
+                "rootUri": "blah",
+                "capabilities": {"languageIds": ["a", "b"]},
+                "data": {
+                    "indexStorePath": "some/index/store/path"
+                }
+            }
+        }
+    elif message["method"] == "build/initialized":
+        continue
+    elif message["method"] == "build/shutdown":
+        response = {
+            "jsonrpc": "2.0",
+            "id": message["id"],
+            "result": None
+        }
+    elif message["method"] == "build/exit":
+        break
+    elif message["method"] == "textDocument/registerForChanges":
+        response = {
+            "jsonrpc": "2.0",
+            "id": message["id"],
+            "result": None
+        }
+        if message["params"]["action"] == "register":
+            notification = {
+                "jsonrpc": "2.0",
+                "method": "build/sourceKitOptionsChanged",
+                "params": {
+                    "uri": message["params"]["uri"],
+                    "options": [ "-a", "-b" ],
+                    "workingDirectory": "/some/dir",
+                }
+            }
+
+    # ignore other notifications
+    elif "id" in message:
+        response = {
+            "jsonrpc": "2.0",
+            "id": message["id"],
+            "error": {
+                "code": -32600,
+                "message": "unhandled method {}".format(message["method"]),
+            }
+        }
+
+    if response: send(response)
+    if notification: send(notification)

Tests/SKCoreTests/BuildServerBuildSystemTests.swift

@@ -46,4 +46,38 @@ final class BuildServerBuildSystemTests: XCTestCase {
     XCTAssertNil(buildSystem?.settings(for: missingFileURL, Language.swift))
   }
 
+  func testFileRegistration() {
+    let root = AbsolutePath(
+      inputsDirectory().appendingPathComponent(testDirectoryName, isDirectory: true).path)
+    let buildFolder = AbsolutePath(NSTemporaryDirectory())
+    let buildSystem = try? BuildServerBuildSystem(projectRoot: root, buildFolder: buildFolder)
+    XCTAssertNotNil(buildSystem)
+
+    let fileUrl = URL(fileURLWithPath: "/some/file/path")
+    let expectation = XCTestExpectation(description: "\(fileUrl) settings updated")
+    let buildSystemDelegate = TestDelegate(expectations: [fileUrl: expectation])
+    buildSystem?.delegate = buildSystemDelegate
+    buildSystem?.registerForChangeNotifications(for: fileUrl)
+
+    let result = XCTWaiter.wait(for: [expectation], timeout: 1)
+    if result != .completed {
+      fatalError("error \(result) waiting for settings notification")
+    }
+  }
+
+}
+
+final class TestDelegate: BuildSystemDelegate {
+
+  let expectations: [URL:XCTestExpectation]
+
+  public init(expectations: [URL:XCTestExpectation]) {
+    self.expectations = expectations
+  }
+
+  func fileBuildSettingsChanged(_ changedFiles: Set<URL>) {
+    for url in changedFiles {
+      expectations[url]?.fulfill()
+    }
+  }
 }

Tests/SKCoreTests/XCTestManifests.swift

@@ -6,6 +6,7 @@ extension BuildServerBuildSystemTests {
     //   `swift test --generate-linuxmain`
     // to regenerate.
     static let __allTests__BuildServerBuildSystemTests = [
+        ("testFileRegistration", testFileRegistration),
         ("testServerInitialize", testServerInitialize),
         ("testSettings", testSettings),
     ]