1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2024 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 BuildSystemIntegration
import Foundation
import LanguageServerProtocol
import SKTestSupport
import ToolchainRegistry
/// A SwiftPM project that is built from files specified inside the test case and that can provide compiler arguments
/// for those files.
///
/// Compared to `SwiftPMTestProject`, the main difference is that this does not start a SourceKit-LSP server.
final class PluginSwiftPMTestProject {
/// The directory in which the temporary files are being placed.
let scratchDirectory: URL
private let fileData: [String: MultiFileTestProject.FileData]
private var _buildSystemManager: BuildSystemManager?
private var buildSystemManager: BuildSystemManager {
get async throws {
if let _buildSystemManager {
return _buildSystemManager
}
let buildSystemManager = await BuildSystemManager(
buildSystemSpec: BuildSystemSpec(
kind: .swiftPM,
projectRoot: scratchDirectory,
configPath: scratchDirectory.appendingPathComponent("Package.swift")
),
toolchainRegistry: .forTesting,
options: try .testDefault(backgroundIndexing: false),
connectionToClient: DummyBuildSystemManagerConnectionToClient(),
buildSystemHooks: BuildSystemHooks()
)
_buildSystemManager = buildSystemManager
return buildSystemManager
}
}
enum Error: Swift.Error {
/// No file with the given filename is known to the `PluginSwiftPMTestProject`.
case fileNotFound
/// `PluginSwiftPMTestProject` did not produce compiler arguments for a file.
case failedToRetrieveCompilerArguments
}
package init(
files: [RelativeFileLocation: String],
testName: String = #function
) async throws {
scratchDirectory = try testScratchDir(testName: testName)
self.fileData = try MultiFileTestProject.writeFilesToDisk(files: files, scratchDirectory: scratchDirectory)
// Build package
try await SwiftPMTestProject.build(at: scratchDirectory)
}
deinit {
if cleanScratchDirectories {
try? FileManager.default.removeItem(at: scratchDirectory)
}
}
/// Returns the URI of the file with the given name.
package func uri(for fileName: String) throws -> DocumentURI {
guard let fileData = self.fileData[fileName] else {
throw Error.fileNotFound
}
return fileData.uri
}
/// Returns the position of the given marker in the given file.
package func position(of marker: String, in fileName: String) throws -> Position {
guard let fileData = self.fileData[fileName] else {
throw Error.fileNotFound
}
return DocumentPositions(markedText: fileData.markedText)[marker]
}
/// Returns the contents of the file with the given name.
package func contents(of fileName: String) throws -> String {
guard let fileData = self.fileData[fileName] else {
throw Error.fileNotFound
}
return extractMarkers(fileData.markedText).textWithoutMarkers
}
package func compilerArguments(for fileName: String) async throws -> [String] {
try await buildSystemManager.waitForUpToDateBuildGraph()
let buildSettings = try await buildSystemManager.buildSettingsInferredFromMainFile(
for: try uri(for: fileName),
language: .swift,
fallbackAfterTimeout: false
)
guard let buildSettings else {
throw Error.failedToRetrieveCompilerArguments
}
let compilerArguments = buildSettings.compilerArguments
if compilerArguments.first?.hasSuffix("swiftc") ?? false {
// Compiler arguments returned from SwiftPMWorkspace contain the compiler executable.
// sourcekitd does not expect the compiler arguments to contain the executable.
return Array(compilerArguments.dropFirst())
}
return compilerArguments
}
}
|
