sourcekit-lsp/Tests/SourceKitLSPTests/HoverTests.swift

//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2018 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
//
//===----------------------------------------------------------------------===//

@_spi(SourceKitLSP) import LanguageServerProtocol
import SKLogging
import SKTestSupport
import XCTest

final class HoverTests: SourceKitLSPTestCase {
  func testBasic() async throws {
    try await assertHover(
      """
      /// This is a doc comment for S.
      ///
      /// Details.
      struct 1️⃣S {}
      """,
      expectedContent: """
        ```swift
        struct S
        ```

        This is a doc comment for S.

        Details.
        """,
      expectedRange: Position(line: 3, utf16index: 7)..<Position(line: 3, utf16index: 8)
    )
  }

  func testHoverTriggeredFromComment() async throws {
    let testClient = try await TestSourceKitLSPClient()
    let url = URL(fileURLWithPath: "/\(UUID())/a.swift")
    let uri = DocumentURI(url)

    let positions = testClient.openDocument(
      """
      /// Thi1️⃣s is a doc comment for S.
      ///
      /// Details.
      struct S {}
      """,
      uri: uri
    )

    let response = try await testClient.send(
      HoverRequest(textDocument: TextDocumentIdentifier(url), position: positions["1️⃣"])
    )

    XCTAssertNil(response)
  }

  func testMultiCursorInfoResultsHover() async throws {
    try await assertHover(
      """
      struct Foo {
        init() {}
      }
      _ = 1️⃣Foo()
      """,
      expectedContent: """
        ## Multiple results

        ```swift
        struct Foo
        ```


        ---

        ```swift

        init()
        ```

        """,
      expectedRange:
        .init(line: 3, utf16index: 4) ..< .init(line: 3, utf16index: 7)
    )
  }

  func testMultiCursorInfoResultsHoverWithDocumentation() async throws {
    try await assertHover(
      """
      /// A struct
      struct Foo {
        /// The initializer
        init() {}
      }
      _ = 1️⃣Foo()
      """,
      expectedContent: """
        ## Multiple results

        ```swift
        struct Foo
        ```

        A struct

        ---

        ```swift

        init()
        ```

        The initializer
        """,
      expectedRange: Position(line: 5, utf16index: 4)..<Position(line: 5, utf16index: 7)
    )
  }

  func testHoverNameEscapingOnFunction() async throws {
    try await assertHover(
      """
      /// this is **bold** documentation
      func 1️⃣test(_ a: Int, _ b: Int) { }
      """,
      expectedContent: ##"""
        ```swift
        func test(_ a: Int, _ b: Int)
        ```

        this is **bold** documentation
        """##,
      expectedRange: Position(line: 1, utf16index: 5)..<Position(line: 1, utf16index: 9)
    )
  }

  func testHoverNameEscapingOnOperator() async throws {
    try await assertHover(
      """
      /// this is *italic* documentation
      func 1️⃣*%*(lhs: String, rhs: String) { }
      """,
      expectedContent: ##"""
        ```swift
        func *%* (lhs: String, rhs: String)
        ```

        this is *italic* documentation
        """##,
      expectedRange: Position(line: 1, utf16index: 5)..<Position(line: 1, utf16index: 8)
    )
  }

  func testPrecondition() async throws {
    try await assertHover(
      """
      /// Eat an apple
      ///
      /// - Precondition: Must have an apple
      func 1️⃣eatApple() {}
      """,
      expectedContent: """
        ```swift
        func eatApple()
        ```

        Eat an apple

        - Precondition: Must have an apple
        """,
      expectedRange: Position(line: 3, utf16index: 5)..<Position(line: 3, utf16index: 13)
    )
  }

  func testTrivia() async throws {
    try await assertHover(
      """
      func foo() {}
      func bar() {
        /*some comment*/1️⃣foo/*more comment*/()
      }
      """,
      expectedContent: """
        ```swift
        func foo()
        ```

        """,
      expectedRange: Position(line: 2, utf16index: 18)..<Position(line: 2, utf16index: 21)
    )
  }
}

private func assertHover(
  _ markedSource: String,
  expectedContent: String,
  expectedRange: Range<Position>,
  file: StaticString = #filePath,
  line: UInt = #line
) async throws {
  let testClient = try await TestSourceKitLSPClient()
  let uri = DocumentURI(for: .swift)

  let positions = testClient.openDocument(markedSource, uri: uri)

  let response = try await testClient.send(
    HoverRequest(textDocument: TextDocumentIdentifier(uri), position: positions["1️⃣"])
  )

  let hover = try XCTUnwrap(response, file: file, line: line)
  XCTAssertEqual(hover.range, expectedRange, file: file, line: line)
  guard case let .markupContent(content) = hover.contents else {
    XCTFail("hover.contents is not .markupContents", file: file, line: line)
    return
  }
  XCTAssertEqual(content.kind, .markdown, file: file, line: line)
  XCTAssertEqual(content.value, expectedContent, file: file, line: line)
}