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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2014-2021 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import Basics
import PackageLoading
import PackageModel
import SPMTestSupport
import XCTest
import class TSCBasic.InMemoryFileSystem
class PackageDescriptionLoadingTests: XCTestCase, ManifestLoaderDelegate {
lazy var manifestLoader = ManifestLoader(toolchain: try! UserToolchain.default, delegate: self)
var parsedManifest = ThreadSafeBox<AbsolutePath>()
func willLoad(packageIdentity: PackageModel.PackageIdentity, packageLocation: String, manifestPath: AbsolutePath) {
// noop
}
func didLoad(packageIdentity: PackageIdentity, packageLocation: String, manifestPath: AbsolutePath, duration: DispatchTimeInterval) {
// noop
}
func willParse(packageIdentity: PackageIdentity, packageLocation: String) {
// noop
}
func didParse(packageIdentity: PackageIdentity, packageLocation: String, duration: DispatchTimeInterval) {
// noop
}
func willCompile(packageIdentity: PackageIdentity, packageLocation: String, manifestPath: AbsolutePath) {
// noop
}
func didCompile(packageIdentity: PackageIdentity, packageLocation: String, manifestPath: AbsolutePath, duration: DispatchTimeInterval) {
// noop
}
func willEvaluate(packageIdentity: PackageIdentity, packageLocation: String, manifestPath: AbsolutePath) {
// noop
}
func didEvaluate(packageIdentity: PackageModel.PackageIdentity, packageLocation: String, manifestPath: AbsolutePath, duration: DispatchTimeInterval) {
parsedManifest.put(manifestPath)
}
var toolsVersion: ToolsVersion {
fatalError("implement in subclass")
}
func loadAndValidateManifest(
_ content: String,
toolsVersion: ToolsVersion? = nil,
packageKind: PackageReference.Kind? = nil,
customManifestLoader: ManifestLoader? = nil,
observabilityScope: ObservabilityScope,
file: StaticString = #file,
line: UInt = #line
) async throws -> (manifest: Manifest, diagnostics: [Basics.Diagnostic]) {
try await Self.loadAndValidateManifest(
content,
toolsVersion: toolsVersion ?? self.toolsVersion,
packageKind: packageKind ?? .fileSystem(.root),
manifestLoader: customManifestLoader ?? self.manifestLoader,
observabilityScope: observabilityScope,
file: file,
line: line
)
}
static func loadAndValidateManifest(
_ content: String,
toolsVersion: ToolsVersion,
packageKind: PackageReference.Kind,
manifestLoader: ManifestLoader,
observabilityScope: ObservabilityScope,
file: StaticString = #file,
line: UInt = #line
) async throws -> (manifest: Manifest, diagnostics: [Basics.Diagnostic]) {
let packagePath: AbsolutePath
switch packageKind {
case .root(let path):
packagePath = path
case .fileSystem(let path):
packagePath = path
case .localSourceControl(let path):
packagePath = path
case .remoteSourceControl, .registry:
packagePath = .root
}
let toolsVersion = toolsVersion
let fileSystem = InMemoryFileSystem()
let manifestPath = packagePath.appending(component: Manifest.filename)
try fileSystem.writeFileContents(manifestPath, string: content)
let manifest = try await manifestLoader.load(
manifestPath: manifestPath,
packageKind: packageKind,
toolsVersion: toolsVersion,
fileSystem: fileSystem,
observabilityScope: observabilityScope
)
if manifest.toolsVersion != toolsVersion {
throw StringError("Invalid manifest version")
}
let validator = ManifestValidator(manifest: manifest, sourceControlValidator: NOOPManifestSourceControlValidator(), fileSystem: fileSystem)
let diagnostics = validator.validate()
return (manifest: manifest, diagnostics: diagnostics)
}
}
final class ManifestTestDelegate: ManifestLoaderDelegate {
private let loaded = ThreadSafeArrayStore<AbsolutePath>()
private let parsed = ThreadSafeArrayStore<AbsolutePath>()
func willLoad(packageIdentity: PackageModel.PackageIdentity, packageLocation: String, manifestPath: AbsolutePath) {
// noop
}
func didLoad(packageIdentity: PackageIdentity, packageLocation: String, manifestPath: AbsolutePath, duration: DispatchTimeInterval) {
self.loaded.append(manifestPath)
}
func willParse(packageIdentity: PackageIdentity, packageLocation: String) {
// noop
}
func didParse(packageIdentity: PackageIdentity, packageLocation: String, duration: DispatchTimeInterval) {
// noop
}
func willCompile(packageIdentity: PackageIdentity, packageLocation: String, manifestPath: AbsolutePath) {
// noop
}
func didCompile(packageIdentity: PackageIdentity, packageLocation: String, manifestPath: AbsolutePath, duration: DispatchTimeInterval) {
// noop
}
func willEvaluate(packageIdentity: PackageIdentity, packageLocation: String, manifestPath: AbsolutePath) {
// noop
}
func didEvaluate(packageIdentity: PackageIdentity, packageLocation: String, manifestPath: AbsolutePath, duration: DispatchTimeInterval) {
self.parsed.append(manifestPath)
}
func clear() {
self.loaded.clear()
self.parsed.clear()
}
func loaded(timeout: Duration) async throws -> [AbsolutePath] {
try await Task.sleep(for: timeout)
return self.loaded.get()
}
func parsed(timeout: Duration) async throws -> [AbsolutePath] {
try await Task.sleep(for: timeout)
return self.parsed.get()
}
}
fileprivate struct NOOPManifestSourceControlValidator: ManifestSourceControlValidator {
func isValidDirectory(_ path: AbsolutePath) throws -> Bool {
true
}
}
|
