sourcekit-lsp/Tests/SourceKitLSPTests/DocumentColorTests.swift

//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2019 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 LSPTestSupport
import SKTestSupport
import SourceKitLSP
import XCTest

final class DocumentColorTests: XCTestCase {
  /// Connection and lifetime management for the service.
  var connection: TestSourceKitServer! = nil

  /// The primary interface to make requests to the SourceKitServer.
  var sk: TestClient! = nil

  override func tearDown() {
    sk = nil
    connection = nil
  }

  func initialize() {
    connection = TestSourceKitServer()
    sk = connection.client
    let documentCapabilities = TextDocumentClientCapabilities()
    _ = try! sk.sendSync(InitializeRequest(
      processId: nil,
      rootPath: nil,
      rootURI: nil,
      initializationOptions: nil,
      capabilities: ClientCapabilities(workspace: nil, textDocument: documentCapabilities),
      trace: .off,
      workspaceFolders: nil))
  }

  func performDocumentColorRequest(text: String) -> [ColorInformation] {
    let url = URL(fileURLWithPath: "/\(#function)/a.swift")

    sk.send(DidOpenTextDocumentNotification(textDocument: TextDocumentItem(
      uri: DocumentURI(url),
      language: .swift,
      version: 12,
      text: text)))

    let request = DocumentColorRequest(textDocument: TextDocumentIdentifier(url))
    return try! sk.sendSync(request)
  }

  func performColorPresentationRequest(text: String, color: Color, range: Range<Position>) -> [ColorPresentation] {
    let url = URL(fileURLWithPath: "/\(#function)/a.swift")

    sk.send(DidOpenTextDocumentNotification(textDocument: TextDocumentItem(
      uri: DocumentURI(url),
      language: .swift,
      version: 12,
      text: text)))

    let request = ColorPresentationRequest(
      textDocument: TextDocumentIdentifier(url), 
      color: color, 
      range: range)
    return try! sk.sendSync(request)
  }

  func testEmptyText() {
    initialize()
    let colors = performDocumentColorRequest(text: "")
    XCTAssertEqual(colors, [])
  }

  func testSimple() {
    initialize()
    let text = #"""
    #colorLiteral(red: 0.1, green: 0.2, blue: 0.3, alpha: 0.4)
    """#
    let colors = performDocumentColorRequest(text: text)

    XCTAssertEqual(colors, [
      ColorInformation(
        range: Position(line: 0, utf16index: 0)..<Position(line: 0, utf16index: 58), 
        color: Color(red: 0.1, green: 0.2, blue: 0.3, alpha: 0.4))
    ])
  }

  func testWeirdWhitespace() {
    initialize()
    let text = #"""
      let x = #colorLiteral(red:0.5,green:0.5,blue:0.5,alpha:0.5)
      let y = #colorLiteral(
      red
      :
      000000000000000000.5
      ,
      green
      :
    0.5
        ,
            blue
        
        :       \#t0.5,       alpha:0.5   
        )
    """#
    let colors = performDocumentColorRequest(text: text)

    XCTAssertEqual(colors, [
      ColorInformation(
        range: Position(line: 0, utf16index: 10)..<Position(line: 0, utf16index: 61), 
        color: Color(red: 0.5, green: 0.5, blue: 0.5, alpha: 0.5)),
      ColorInformation(
        range: Position(line: 1, utf16index: 10)..<Position(line: 13, utf16index: 5), 
        color: Color(red: 0.5, green: 0.5, blue: 0.5, alpha: 0.5)),
    ])
  }

  func testPresentation() {
    initialize()
    let text = """
    let x = #colorLiteral(red: 0.5, green: 0.5, blue: 0.5, alpha: 0.5);
    """
    let color = Color(red: 0, green: 1, blue: 4 - .pi, alpha: 0.3)
    let range = Position(line: 0, utf16index: 8)..<Position(line: 0, utf16index: 58)
    let newText = """
    #colorLiteral(red: \(color.red), green: \(color.green), blue: \(color.blue), alpha: \(color.alpha))
    """
    let presentations = performColorPresentationRequest(text: text, color: color, range: range)
    XCTAssertEqual(presentations.count, 1)
    let presentation = presentations[0]
    XCTAssertEqual(presentation.label, "Color Literal")
    XCTAssertEqual(presentation.textEdit?.range, range)
    XCTAssertEqual(presentation.textEdit?.newText, newText)
  }
}