mirror of
https://github.com/apple/sourcekit-lsp.git
synced 2026-03-02 18:23:24 +01:00
122 lines
4.1 KiB
Swift
122 lines
4.1 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2023 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 Foundation
|
|
import LanguageServerProtocol
|
|
import SKCore
|
|
|
|
/// The location of a test file within test workspace.
|
|
public struct RelativeFileLocation: Hashable, ExpressibleByStringLiteral {
|
|
/// The subdirectories in which the file is located.
|
|
fileprivate let directories: [String]
|
|
|
|
/// The file's name.
|
|
fileprivate let fileName: String
|
|
|
|
public init(directories: [String] = [], _ fileName: String) {
|
|
self.directories = directories
|
|
self.fileName = fileName
|
|
}
|
|
|
|
public init(stringLiteral value: String) {
|
|
self.init(value)
|
|
}
|
|
}
|
|
|
|
/// A workspace that writes multiple files to disk and opens a `TestSourceKitLSPClient` client with a workspace pointing
|
|
/// to a temporary directory containing those files.
|
|
///
|
|
/// The temporary files will be deleted when the `TestSourceKitLSPClient` is destructed.
|
|
public class MultiFileTestWorkspace {
|
|
/// Information necessary to open a file in the LSP server by its filename.
|
|
private struct FileData {
|
|
/// The URI at which the file is stored on disk.
|
|
let uri: DocumentURI
|
|
|
|
/// The contents of the file including location markers.
|
|
let markedText: String
|
|
}
|
|
|
|
public let testClient: TestSourceKitLSPClient
|
|
|
|
/// Information necessary to open a file in the LSP server by its filename.
|
|
private let fileData: [String: FileData]
|
|
|
|
enum Error: Swift.Error {
|
|
/// No file with the given filename is known to the `SwiftPMTestWorkspace`.
|
|
case fileNotFound
|
|
}
|
|
|
|
/// The directory in which the temporary files are being placed.
|
|
let scratchDirectory: URL
|
|
|
|
public init(
|
|
files: [RelativeFileLocation: String],
|
|
testName: String = #function
|
|
) async throws {
|
|
scratchDirectory = try testScratchDir(testName: testName)
|
|
try FileManager.default.createDirectory(at: scratchDirectory, withIntermediateDirectories: true)
|
|
|
|
var fileData: [String: FileData] = [:]
|
|
for (fileLocation, markedText) in files {
|
|
var fileURL = scratchDirectory
|
|
for directory in fileLocation.directories {
|
|
fileURL = fileURL.appendingPathComponent(directory)
|
|
}
|
|
fileURL = fileURL.appendingPathComponent(fileLocation.fileName)
|
|
try FileManager.default.createDirectory(
|
|
at: fileURL.deletingLastPathComponent(),
|
|
withIntermediateDirectories: true
|
|
)
|
|
try extractMarkers(markedText).textWithoutMarkers.write(to: fileURL, atomically: false, encoding: .utf8)
|
|
|
|
precondition(
|
|
fileData[fileLocation.fileName] == nil,
|
|
"Files within a `MultiFileTestWorkspace` must have unique names"
|
|
)
|
|
fileData[fileLocation.fileName] = FileData(
|
|
uri: DocumentURI(fileURL),
|
|
markedText: markedText
|
|
)
|
|
}
|
|
self.fileData = fileData
|
|
|
|
self.testClient = try await TestSourceKitLSPClient(
|
|
workspaceFolders: [
|
|
WorkspaceFolder(uri: DocumentURI(scratchDirectory))
|
|
],
|
|
cleanUp: { [scratchDirectory] in
|
|
try? FileManager.default.removeItem(at: scratchDirectory)
|
|
}
|
|
)
|
|
}
|
|
|
|
/// Opens the document with the given file name in the SourceKit-LSP server.
|
|
///
|
|
/// - Returns: The URI for the opened document and the positions of the location markers.
|
|
public func openDocument(_ fileName: String) throws -> (uri: DocumentURI, positions: DocumentPositions) {
|
|
guard let fileData = self.fileData[fileName] else {
|
|
throw Error.fileNotFound
|
|
}
|
|
let positions = testClient.openDocument(fileData.markedText, uri: fileData.uri)
|
|
return (fileData.uri, positions)
|
|
}
|
|
|
|
/// Returns the URI of the file with the given name.
|
|
public func uri(for fileName: String) throws -> DocumentURI {
|
|
guard let fileData = self.fileData[fileName] else {
|
|
throw Error.fileNotFound
|
|
}
|
|
return fileData.uri
|
|
}
|
|
}
|