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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2021-2022 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
final class PackageDescription5_6LoadingTests: PackageDescriptionLoadingTests {
override var toolsVersion: ToolsVersion {
.v5_6
}
func testSourceControlDependencies() async throws {
let content = """
import PackageDescription
let package = Package(
name: "MyPackage",
dependencies: [
// from
.package(name: "foo1", url: "http://localhost/foo1", from: "1.1.1"),
.package(url: "http://localhost/foo2", from: "1.1.1"),
// upToNextMajor
.package(name: "bar1", url: "http://localhost/bar1", .upToNextMajor(from: "1.1.1")),
.package(url: "http://localhost/bar2", .upToNextMajor(from: "1.1.1")),
// upToNextMinor
.package(name: "baz1", url: "http://localhost/baz1", .upToNextMinor(from: "1.1.1")),
.package(url: "http://localhost/baz2", .upToNextMinor(from: "1.1.1")),
// exact
.package(name: "qux1", url: "http://localhost/qux1", .exact("1.1.1")),
.package(url: "http://localhost/qux2", .exact("1.1.1")),
.package(url: "http://localhost/qux3", exact: "1.1.1"),
// branch
.package(name: "quux1", url: "http://localhost/quux1", .branch("main")),
.package(url: "http://localhost/quux2", .branch("main")),
.package(url: "http://localhost/quux3", branch: "main"),
// revision
.package(name: "quuz1", url: "http://localhost/quuz1", .revision("abcdefg")),
.package(url: "http://localhost/quuz2", .revision("abcdefg")),
.package(url: "http://localhost/quuz3", revision: "abcdefg"),
]
)
"""
let observability = ObservabilitySystem.makeForTesting()
let (manifest, validationDiagnostics) = try await loadAndValidateManifest(content, observabilityScope: observability.topScope)
XCTAssertFalse(observability.diagnostics.hasErrors)
XCTAssertNoDiagnostics(validationDiagnostics)
let deps = Dictionary(uniqueKeysWithValues: manifest.dependencies.map{ ($0.identity.description, $0) })
XCTAssertEqual(deps["foo1"], .remoteSourceControl(identity: .plain("foo1"), deprecatedName: "foo1", url: "http://localhost/foo1", requirement: .range("1.1.1" ..< "2.0.0")))
XCTAssertEqual(deps["foo2"], .remoteSourceControl(identity: .plain("foo2"), url: "http://localhost/foo2", requirement: .range("1.1.1" ..< "2.0.0")))
XCTAssertEqual(deps["bar1"], .remoteSourceControl(identity: .plain("bar1"), deprecatedName: "bar1", url: "http://localhost/bar1", requirement: .range("1.1.1" ..< "2.0.0")))
XCTAssertEqual(deps["bar2"], .remoteSourceControl(identity: .plain("bar2"), url: "http://localhost/bar2", requirement: .range("1.1.1" ..< "2.0.0")))
XCTAssertEqual(deps["baz1"], .remoteSourceControl(identity: .plain("baz1"), deprecatedName: "baz1", url: "http://localhost/baz1", requirement: .range("1.1.1" ..< "1.2.0")))
XCTAssertEqual(deps["baz2"], .remoteSourceControl(identity: .plain("baz2"), url: "http://localhost/baz2", requirement: .range("1.1.1" ..< "1.2.0")))
XCTAssertEqual(deps["qux1"], .remoteSourceControl(identity: .plain("qux1"), deprecatedName: "qux1", url: "http://localhost/qux1", requirement: .exact("1.1.1")))
XCTAssertEqual(deps["qux2"], .remoteSourceControl(identity: .plain("qux2"), url: "http://localhost/qux2", requirement: .exact("1.1.1")))
XCTAssertEqual(deps["qux3"], .remoteSourceControl(identity: .plain("qux3"), url: "http://localhost/qux3", requirement: .exact("1.1.1")))
XCTAssertEqual(deps["quux1"], .remoteSourceControl(identity: .plain("quux1"), deprecatedName: "quux1", url: "http://localhost/quux1", requirement: .branch("main")))
XCTAssertEqual(deps["quux2"], .remoteSourceControl(identity: .plain("quux2"), url: "http://localhost/quux2", requirement: .branch("main")))
XCTAssertEqual(deps["quux3"], .remoteSourceControl(identity: .plain("quux3"), url: "http://localhost/quux3", requirement: .branch("main")))
XCTAssertEqual(deps["quuz1"], .remoteSourceControl(identity: .plain("quuz1"), deprecatedName: "quuz1", url: "http://localhost/quuz1", requirement: .revision("abcdefg")))
XCTAssertEqual(deps["quuz2"], .remoteSourceControl(identity: .plain("quuz2"), url: "http://localhost/quuz2", requirement: .revision("abcdefg")))
XCTAssertEqual(deps["quuz3"], .remoteSourceControl(identity: .plain("quuz3"), url: "http://localhost/quuz3", requirement: .revision("abcdefg")))
}
func testBuildToolPluginTarget() async throws {
let content = """
import PackageDescription
let package = Package(
name: "Foo",
targets: [
.plugin(
name: "Foo",
capability: .buildTool()
)
]
)
"""
let observability = ObservabilitySystem.makeForTesting()
let (manifest, validationDiagnostics) = try await loadAndValidateManifest(content, observabilityScope: observability.topScope)
XCTAssertNoDiagnostics(observability.diagnostics)
XCTAssertNoDiagnostics(validationDiagnostics)
XCTAssertEqual(manifest.targets[0].type, .plugin)
XCTAssertEqual(manifest.targets[0].pluginCapability, .buildTool)
}
func testPluginTargetCustomization() async throws {
let content = """
import PackageDescription
let package = Package(
name: "Foo",
targets: [
.plugin(
name: "Foo",
capability: .buildTool(),
path: "Sources/Foo",
exclude: ["IAmOut.swift"],
sources: ["CountMeIn.swift"]
)
]
)
"""
let observability = ObservabilitySystem.makeForTesting()
let (manifest, validationDiagnostics) = try await loadAndValidateManifest(content, observabilityScope: observability.topScope)
XCTAssertNoDiagnostics(observability.diagnostics)
XCTAssertNoDiagnostics(validationDiagnostics)
XCTAssertEqual(manifest.targets[0].type, .plugin)
XCTAssertEqual(manifest.targets[0].pluginCapability, .buildTool)
XCTAssertEqual(manifest.targets[0].path, "Sources/Foo")
XCTAssertEqual(manifest.targets[0].exclude, ["IAmOut.swift"])
XCTAssertEqual(manifest.targets[0].sources, ["CountMeIn.swift"])
}
func testCustomPlatforms() async throws {
// One custom platform.
do {
let content = """
import PackageDescription
let package = Package(
name: "Foo",
platforms: [
.custom("customos", versionString: "1.0"),
]
)
"""
let observability = ObservabilitySystem.makeForTesting()
let (manifest, validationDiagnostics) = try await loadAndValidateManifest(content, observabilityScope: observability.topScope)
XCTAssertNoDiagnostics(observability.diagnostics)
XCTAssertNoDiagnostics(validationDiagnostics)
XCTAssertEqual(manifest.platforms, [
PlatformDescription(name: "customos", version: "1.0"),
])
}
// Two custom platforms.
do {
let content = """
import PackageDescription
let package = Package(
name: "Foo",
platforms: [
.custom("customos", versionString: "1.0"),
.custom("anothercustomos", versionString: "2.3"),
]
)
"""
let observability = ObservabilitySystem.makeForTesting()
let (manifest, validationDiagnostics) = try await loadAndValidateManifest(content, observabilityScope: observability.topScope)
XCTAssertNoDiagnostics(observability.diagnostics)
XCTAssertNoDiagnostics(validationDiagnostics)
XCTAssertEqual(manifest.platforms, [
PlatformDescription(name: "customos", version: "1.0"),
PlatformDescription(name: "anothercustomos", version: "2.3"),
])
}
// Invalid custom platform version.
do {
let content = """
import PackageDescription
let package = Package(
name: "Foo",
platforms: [
.custom("customos", versionString: "xx"),
]
)
"""
let observability = ObservabilitySystem.makeForTesting()
do {
_ = try await loadAndValidateManifest(content, observabilityScope: observability.topScope)
XCTFail("manifest loading unexpectedly did not throw an error")
} catch ManifestParseError.runtimeManifestErrors(let errors) {
XCTAssertEqual(errors, ["invalid custom platform version xx; xx should be a positive integer"])
}
}
}
/// Tests use of Context.current.packageDirectory
func testPackageContextName() async throws {
let content = """
import PackageDescription
let package = Package(name: Context.packageDirectory)
"""
let observability = ObservabilitySystem.makeForTesting()
let (manifest, validationDiagnostics) = try await loadAndValidateManifest(content, observabilityScope: observability.topScope)
XCTAssertNoDiagnostics(observability.diagnostics)
XCTAssertNoDiagnostics(validationDiagnostics)
XCTAssertNotNil(parsedManifest)
XCTAssertNotNil(parsedManifest.parentDirectory)
let name = try XCTUnwrap(parsedManifest.parentDirectory).pathString
XCTAssertEqual(manifest.displayName, name)
}
/// Tests access to the package's directory contents.
func testPackageContextDirectory() async throws {
#if os(Windows)
throw XCTSkip("Skipping since this tests does not fully work without the VFS overlay which is currently disabled on Windows")
#endif
let content = """
import PackageDescription
import Foundation
let fileManager = FileManager.default
let contents = (try? fileManager.contentsOfDirectory(atPath: Context.packageDirectory)) ?? []
let package = Package(name: contents.joined(separator: ","))
"""
let observability = ObservabilitySystem.makeForTesting()
let (manifest, validationDiagnostics) = try await loadAndValidateManifest(content, observabilityScope: observability.topScope)
// FIXME: temporary filter a diagnostic that shows up on macOS 14.0
XCTAssertNoDiagnostics(observability.diagnostics.filter { !$0.message.contains("coreservicesd") })
XCTAssertNoDiagnostics(validationDiagnostics)
let files = manifest.displayName.split(separator: ",").map(String.init)
// Since we're loading `/Package.swift` in these tests, the context's package directory is supposed to be /.
let expectedFiles = try FileManager.default.contentsOfDirectory(atPath: "/")
XCTAssertEqual(files, expectedFiles)
}
func testCommandPluginTarget() async throws {
let content = """
import PackageDescription
let package = Package(
name: "Foo",
targets: [
.plugin(
name: "Foo",
capability: .command(
intent: .custom(verb: "mycmd", description: "helpful description of mycmd"),
permissions: [ .writeToPackageDirectory(reason: "YOLO") ]
)
)
]
)
"""
let observability = ObservabilitySystem.makeForTesting()
let (manifest, validationDiagnostics) = try await loadAndValidateManifest(content, observabilityScope: observability.topScope)
XCTAssertNoDiagnostics(observability.diagnostics)
XCTAssertNoDiagnostics(validationDiagnostics)
XCTAssertEqual(manifest.targets[0].type, .plugin)
XCTAssertEqual(manifest.targets[0].pluginCapability, .command(intent: .custom(verb: "mycmd", description: "helpful description of mycmd"), permissions: [.writeToPackageDirectory(reason: "YOLO")]))
}
}
|
