Convert inlay type hint tests to use position markers

Author: ahoppen

Tests/SourceKitLSPTests/InlayHintTests.swift

@@ -18,14 +18,24 @@ import XCTest
 final class InlayHintTests: XCTestCase {
   // MARK: - Helpers
 
-  func performInlayHintRequest(text: String, range: Range<Position>? = nil) async throws -> [InlayHint] {
+  func performInlayHintRequest(
+    markedText: String,
+    range: (fromMarker: String, toMarker: String)? = nil
+  ) async throws -> (DocumentPositions, [InlayHint]) {
     let testClient = try await TestSourceKitLSPClient()
     let uri = DocumentURI(for: .swift)
 
+    let (positions, text) = DocumentPositions.extract(from: markedText)
     testClient.openDocument(text, uri: uri)
 
+    let range: Range<Position>? =
+      if let range {
+        positions[range.fromMarker]..<positions[range.toMarker]
+      } else {
+        nil
+      }
     let request = InlayHintRequest(textDocument: TextDocumentIdentifier(uri), range: range)
-    return try await testClient.send(request)
+    return (positions, try await testClient.send(request))
   }
 
   private func makeInlayHint(
@@ -51,27 +61,27 @@ final class InlayHintTests: XCTestCase {
   // MARK: - Tests
 
   func testEmpty() async throws {
-    let text = ""
-    let hints = try await performInlayHintRequest(text: text)
+    let (_, hints) = try await performInlayHintRequest(markedText: "")
     XCTAssertEqual(hints, [])
   }
 
   func testBindings() async throws {
-    let text = """
-      let x = 4
-      var y = "test" + "123"
-      """
-    let hints = try await performInlayHintRequest(text: text)
+    let (positions, hints) = try await performInlayHintRequest(
+      markedText: """
+        let x1️⃣ = 4
+        var y2️⃣ = "test" + "123"
+        """
+    )
     XCTAssertEqual(
       hints,
       [
         makeInlayHint(
-          position: Position(line: 0, utf16index: 5),
+          position: positions["1️⃣"],
           kind: .type,
           label: ": Int"
         ),
         makeInlayHint(
-          position: Position(line: 1, utf16index: 5),
+          position: positions["2️⃣"],
           kind: .type,
           label: ": String"
         ),
@@ -80,30 +90,31 @@ final class InlayHintTests: XCTestCase {
   }
 
   func testRanged() async throws {
-    let text = """
-      func square(_ x: Double) -> Double {
-        let result = x * x
-        return result
-      }
-
-      func collatz(_ n: Int) -> Int {
-        let even = n % 2 == 0
-        let result = even ? (n / 2) : (3 * n + 1)
-        return result
-      }
-      """
-    let range = Position(line: 6, utf16index: 0)..<Position(line: 9, utf16index: 0)
-    let hints = try await performInlayHintRequest(text: text, range: range)
+    let (positions, hints) = try await performInlayHintRequest(
+      markedText: """
+        func square(_ x: Double) -> Double {
+          let result = x * x
+          return result
+        }
+
+        func collatz(_ n: Int) -> Int {
+        1️⃣  let even2️⃣ = n % 2 == 0
+          let result3️⃣ = even ? (n / 2) : (3 * n + 1)
+          return result
+        } 4️⃣
+        """,
+      range: ("1️⃣", "4️⃣")
+    )
     XCTAssertEqual(
       hints,
       [
         makeInlayHint(
-          position: Position(line: 6, utf16index: 10),
+          position: positions["2️⃣"],
           kind: .type,
           label: ": Bool"
         ),
         makeInlayHint(
-          position: Position(line: 7, utf16index: 12),
+          position: positions["3️⃣"],
           kind: .type,
           label: ": Int"
         ),
@@ -112,47 +123,48 @@ final class InlayHintTests: XCTestCase {
   }
 
   func testFields() async throws {
-    let text = """
-      class X {
-        let instanceMember = 3
-        static let staticMember = "abc"
-      }
-
-      struct Y {
-        var instanceMember = "def" + "ghi"
-        static let staticMember = 1 + 2
-      }
-
-      enum Z {
-        static let staticMember = 3.0
-      }
-      """
-    let hints = try await performInlayHintRequest(text: text)
+    let (positions, hints) = try await performInlayHintRequest(
+      markedText: """
+        class X {
+          let instanceMember1️⃣ = 3
+          static let staticMember2️⃣ = "abc"
+        }
+
+        struct Y {
+          var instanceMember3️⃣ = "def" + "ghi"
+          static let staticMember4️⃣ = 1 + 2
+        }
+
+        enum Z {
+          static let staticMember5️⃣ = 3.0
+        }
+        """
+    )
     XCTAssertEqual(
       hints,
       [
         makeInlayHint(
-          position: Position(line: 1, utf16index: 20),
+          position: positions["1️⃣"],
           kind: .type,
           label: ": Int"
         ),
         makeInlayHint(
-          position: Position(line: 2, utf16index: 25),
+          position: positions["2️⃣"],
           kind: .type,
           label: ": String"
         ),
         makeInlayHint(
-          position: Position(line: 6, utf16index: 20),
+          position: positions["3️⃣"],
           kind: .type,
           label: ": String"
         ),
         makeInlayHint(
-          position: Position(line: 7, utf16index: 25),
+          position: positions["4️⃣"],
           kind: .type,
           label: ": Int"
         ),
         makeInlayHint(
-          position: Position(line: 11, utf16index: 25),
+          position: positions["5️⃣"],
           kind: .type,
           label: ": Double"
         ),
@@ -161,49 +173,51 @@ final class InlayHintTests: XCTestCase {
   }
 
   func testExplicitTypeAnnotation() async throws {
-    let text = """
-      let x: String = "abc"
-
-      struct X {
-        var y: Int = 34
-      }
-      """
-    let hints = try await performInlayHintRequest(text: text)
+    let (_, hints) = try await performInlayHintRequest(
+      markedText: """
+        let x: String = "abc"
+
+        struct X {
+          var y: Int = 34
+        }
+        """
+    )
     XCTAssertEqual(hints, [])
   }
 
   func testClosureParams() async throws {
-    let text = """
-      func f(x: Int) {}
-
-      let g = { (x: Int) in }
-      let h: (String) -> String = { x in x }
-      let i: (Double, Double) -> Double = { (x, y) in
-        x + y
-      }
-      """
-    let hints = try await performInlayHintRequest(text: text)
+    let (positions, hints) = try await performInlayHintRequest(
+      markedText: """
+        func f(x: Int) {}
+
+        let g1️⃣ = { (x: Int) in }
+        let h: (String) -> String = { x2️⃣ in x }
+        let i: (Double, Double) -> Double = { (x3️⃣, y4️⃣) in
+          x + y
+        }
+        """
+    )
     XCTAssertEqual(
       hints,
       [
         makeInlayHint(
-          position: Position(line: 2, utf16index: 5),
+          position: positions["1️⃣"],
           kind: .type,
           label: ": (Int) -> ()"
         ),
         makeInlayHint(
-          position: Position(line: 3, utf16index: 31),
+          position: positions["2️⃣"],
           kind: .type,
           label: ": String",
           hasEdit: false
         ),
         makeInlayHint(
-          position: Position(line: 4, utf16index: 40),
+          position: positions["3️⃣"],
           kind: .type,
           label: ": Double"
         ),
         makeInlayHint(
-          position: Position(line: 4, utf16index: 43),
+          position: positions["4️⃣"],
           kind: .type,
           label: ": Double"
         ),