mirror of
https://github.com/apple/sourcekit-lsp.git
synced 2026-03-02 18:23:24 +01:00
161171668c
Rename all the classes that write files to disk to create a test project that we can open in sourcekit-lsp to end with `TestProject`. This is better than the old `Workspace` suffix because it avoids ambiguities with the `Workspace` type inside sourcekit-lsp. - IndexedSingleSwiftFileWorkspace -> IndexedSingleSwiftFileTestProject - MultiFileTestWorkspace -> MultiFileTestProject - SwiftPMTestWorkspace -> SwiftPMTestProject
95 lines
3.2 KiB
Swift
95 lines
3.2 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
|
|
@_spi(Testing) import SKCore
|
|
import TSCBasic
|
|
|
|
public class SwiftPMTestProject: MultiFileTestProject {
|
|
enum Error: Swift.Error {
|
|
/// The `swift` executable could not be found.
|
|
case swiftNotFound
|
|
}
|
|
|
|
public static let defaultPackageManifest: String = """
|
|
// swift-tools-version: 5.7
|
|
|
|
import PackageDescription
|
|
|
|
let package = Package(
|
|
name: "MyLibrary",
|
|
targets: [.target(name: "MyLibrary")]
|
|
)
|
|
"""
|
|
|
|
/// Create a new SwiftPM package with the given files.
|
|
///
|
|
/// If `index` is `true`, then the package will be built, indexing all modules within the package.
|
|
public init(
|
|
files: [RelativeFileLocation: String],
|
|
manifest: String = SwiftPMTestProject.defaultPackageManifest,
|
|
workspaces: (URL) -> [WorkspaceFolder] = { [WorkspaceFolder(uri: DocumentURI($0))] },
|
|
build: Bool = false,
|
|
usePullDiagnostics: Bool = true,
|
|
testName: String = #function
|
|
) async throws {
|
|
var filesByPath: [RelativeFileLocation: String] = [:]
|
|
for (fileLocation, contents) in files {
|
|
let directories =
|
|
switch fileLocation.directories.first {
|
|
case "Sources", "Tests":
|
|
fileLocation.directories
|
|
case nil:
|
|
["Sources", "MyLibrary"]
|
|
default:
|
|
["Sources"] + fileLocation.directories
|
|
}
|
|
|
|
filesByPath[RelativeFileLocation(directories: directories, fileLocation.fileName)] = contents
|
|
}
|
|
filesByPath["Package.swift"] = manifest
|
|
try await super.init(
|
|
files: filesByPath,
|
|
workspaces: workspaces,
|
|
usePullDiagnostics: usePullDiagnostics,
|
|
testName: testName
|
|
)
|
|
|
|
if build {
|
|
try await Self.build(at: self.scratchDirectory)
|
|
}
|
|
// Wait for the indexstore-db to finish indexing
|
|
_ = try await testClient.send(PollIndexRequest())
|
|
}
|
|
|
|
/// Build a SwiftPM package package manifest is located in the directory at `path`.
|
|
public static func build(at path: URL) async throws {
|
|
guard let swift = await ToolchainRegistry.forTesting.default?.swift?.asURL else {
|
|
throw Error.swiftNotFound
|
|
}
|
|
let arguments = [
|
|
swift.path,
|
|
"build",
|
|
"--package-path", path.path,
|
|
"--build-tests",
|
|
"-Xswiftc", "-index-ignore-system-modules",
|
|
"-Xcc", "-index-ignore-system-symbols",
|
|
]
|
|
var environment = ProcessEnv.block
|
|
// FIXME: SwiftPM does not index-while-building on non-Darwin platforms for C-family files (rdar://117744039).
|
|
// Force-enable index-while-building with the environment variable.
|
|
environment["SWIFTPM_ENABLE_CLANG_INDEX_STORE"] = "1"
|
|
try await Process.checkNonZeroExit(arguments: arguments, environmentBlock: environment)
|
|
}
|
|
}
|