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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
|
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
@testable import Basics
@testable import Build
@testable import CoreCommands
@testable import Commands
@testable import PackageModel
import SPMTestSupport
import XCTest
import class TSCBasic.BufferedOutputByteStream
import protocol TSCBasic.OutputByteStream
import var TSCBasic.stderrStream
final class SwiftCommandStateTests: CommandsTestCase {
func testVerbosityLogLevel() throws {
try fixture(name: "Miscellaneous/Simple") { fixturePath in
do {
let outputStream = BufferedOutputByteStream()
let options = try GlobalOptions.parse(["--package-path", fixturePath.pathString])
let tool = try SwiftCommandState.makeMockState(outputStream: outputStream, options: options)
XCTAssertEqual(tool.logLevel, .warning)
tool.observabilityScope.emit(error: "error")
tool.observabilityScope.emit(warning: "warning")
tool.observabilityScope.emit(info: "info")
tool.observabilityScope.emit(debug: "debug")
tool.waitForObservabilityEvents(timeout: .now() + .seconds(1))
XCTAssertMatch(outputStream.bytes.validDescription, .contains("error: error"))
XCTAssertMatch(outputStream.bytes.validDescription, .contains("warning: warning"))
XCTAssertNoMatch(outputStream.bytes.validDescription, .contains("info: info"))
XCTAssertNoMatch(outputStream.bytes.validDescription, .contains("debug: debug"))
}
do {
let outputStream = BufferedOutputByteStream()
let options = try GlobalOptions.parse(["--package-path", fixturePath.pathString, "--verbose"])
let tool = try SwiftCommandState.makeMockState(outputStream: outputStream, options: options)
XCTAssertEqual(tool.logLevel, .info)
tool.observabilityScope.emit(error: "error")
tool.observabilityScope.emit(warning: "warning")
tool.observabilityScope.emit(info: "info")
tool.observabilityScope.emit(debug: "debug")
tool.waitForObservabilityEvents(timeout: .now() + .seconds(1))
XCTAssertMatch(outputStream.bytes.validDescription, .contains("error: error"))
XCTAssertMatch(outputStream.bytes.validDescription, .contains("warning: warning"))
XCTAssertMatch(outputStream.bytes.validDescription, .contains("info: info"))
XCTAssertNoMatch(outputStream.bytes.validDescription, .contains("debug: debug"))
}
do {
let outputStream = BufferedOutputByteStream()
let options = try GlobalOptions.parse(["--package-path", fixturePath.pathString, "-v"])
let tool = try SwiftCommandState.makeMockState(outputStream: outputStream, options: options)
XCTAssertEqual(tool.logLevel, .info)
tool.observabilityScope.emit(error: "error")
tool.observabilityScope.emit(warning: "warning")
tool.observabilityScope.emit(info: "info")
tool.observabilityScope.emit(debug: "debug")
tool.waitForObservabilityEvents(timeout: .now() + .seconds(1))
XCTAssertMatch(outputStream.bytes.validDescription, .contains("error: error"))
XCTAssertMatch(outputStream.bytes.validDescription, .contains("warning: warning"))
XCTAssertMatch(outputStream.bytes.validDescription, .contains("info: info"))
XCTAssertNoMatch(outputStream.bytes.validDescription, .contains("debug: debug"))
}
do {
let outputStream = BufferedOutputByteStream()
let options = try GlobalOptions.parse(["--package-path", fixturePath.pathString, "--very-verbose"])
let tool = try SwiftCommandState.makeMockState(outputStream: outputStream, options: options)
XCTAssertEqual(tool.logLevel, .debug)
tool.observabilityScope.emit(error: "error")
tool.observabilityScope.emit(warning: "warning")
tool.observabilityScope.emit(info: "info")
tool.observabilityScope.emit(debug: "debug")
tool.waitForObservabilityEvents(timeout: .now() + .seconds(1))
XCTAssertMatch(outputStream.bytes.validDescription, .contains("error: error"))
XCTAssertMatch(outputStream.bytes.validDescription, .contains("warning: warning"))
XCTAssertMatch(outputStream.bytes.validDescription, .contains("info: info"))
XCTAssertMatch(outputStream.bytes.validDescription, .contains("debug: debug"))
}
do {
let outputStream = BufferedOutputByteStream()
let options = try GlobalOptions.parse(["--package-path", fixturePath.pathString, "--vv"])
let tool = try SwiftCommandState.makeMockState(outputStream: outputStream, options: options)
XCTAssertEqual(tool.logLevel, .debug)
tool.observabilityScope.emit(error: "error")
tool.observabilityScope.emit(warning: "warning")
tool.observabilityScope.emit(info: "info")
tool.observabilityScope.emit(debug: "debug")
tool.waitForObservabilityEvents(timeout: .now() + .seconds(1))
XCTAssertMatch(outputStream.bytes.validDescription, .contains("error: error"))
XCTAssertMatch(outputStream.bytes.validDescription, .contains("warning: warning"))
XCTAssertMatch(outputStream.bytes.validDescription, .contains("info: info"))
XCTAssertMatch(outputStream.bytes.validDescription, .contains("debug: debug"))
}
do {
let outputStream = BufferedOutputByteStream()
let options = try GlobalOptions.parse(["--package-path", fixturePath.pathString, "--quiet"])
let tool = try SwiftCommandState.makeMockState(outputStream: outputStream, options: options)
XCTAssertEqual(tool.logLevel, .error)
tool.observabilityScope.emit(error: "error")
tool.observabilityScope.emit(warning: "warning")
tool.observabilityScope.emit(info: "info")
tool.observabilityScope.emit(debug: "debug")
tool.waitForObservabilityEvents(timeout: .now() + .seconds(1))
XCTAssertMatch(outputStream.bytes.validDescription, .contains("error: error"))
XCTAssertNoMatch(outputStream.bytes.validDescription, .contains("warning: warning"))
XCTAssertNoMatch(outputStream.bytes.validDescription, .contains("info: info"))
XCTAssertNoMatch(outputStream.bytes.validDescription, .contains("debug: debug"))
}
do {
let outputStream = BufferedOutputByteStream()
let options = try GlobalOptions.parse(["--package-path", fixturePath.pathString, "-q"])
let tool = try SwiftCommandState.makeMockState(outputStream: outputStream, options: options)
XCTAssertEqual(tool.logLevel, .error)
tool.observabilityScope.emit(error: "error")
tool.observabilityScope.emit(warning: "warning")
tool.observabilityScope.emit(info: "info")
tool.observabilityScope.emit(debug: "debug")
tool.waitForObservabilityEvents(timeout: .now() + .seconds(1))
XCTAssertMatch(outputStream.bytes.validDescription, .contains("error: error"))
XCTAssertNoMatch(outputStream.bytes.validDescription, .contains("warning: warning"))
XCTAssertNoMatch(outputStream.bytes.validDescription, .contains("info: info"))
XCTAssertNoMatch(outputStream.bytes.validDescription, .contains("debug: debug"))
}
}
}
func testAuthorizationProviders() throws {
try fixture(name: "DependencyResolution/External/XCFramework") { fixturePath in
let fs = localFileSystem
// custom .netrc file
do {
let customPath = try fs.tempDirectory.appending(component: UUID().uuidString)
try fs.writeFileContents(
customPath,
string: "machine mymachine.labkey.org login custom@labkey.org password custom"
)
let options = try GlobalOptions.parse(["--package-path", fixturePath.pathString, "--netrc-file", customPath.pathString])
let tool = try SwiftCommandState.makeMockState(options: options)
let authorizationProvider = try tool.getAuthorizationProvider() as? CompositeAuthorizationProvider
let netrcProviders = authorizationProvider?.providers.compactMap { $0 as? NetrcAuthorizationProvider } ?? []
XCTAssertEqual(netrcProviders.count, 1)
XCTAssertEqual(try netrcProviders.first.map { try resolveSymlinks($0.path) }, try resolveSymlinks(customPath))
let auth = try tool.getAuthorizationProvider()?.authentication(for: "https://mymachine.labkey.org")
XCTAssertEqual(auth?.user, "custom@labkey.org")
XCTAssertEqual(auth?.password, "custom")
// delete it
try localFileSystem.removeFileTree(customPath)
XCTAssertThrowsError(try tool.getAuthorizationProvider(), "error expected") { error in
XCTAssertEqual(error as? StringError, StringError("Did not find netrc file at \(customPath)."))
}
}
// Tests should not modify user's home dir .netrc so leaving that out intentionally
}
}
func testRegistryAuthorizationProviders() throws {
try fixture(name: "DependencyResolution/External/XCFramework") { fixturePath in
let fs = localFileSystem
// custom .netrc file
do {
let customPath = try fs.tempDirectory.appending(component: UUID().uuidString)
try fs.writeFileContents(
customPath,
string: "machine mymachine.labkey.org login custom@labkey.org password custom"
)
let options = try GlobalOptions.parse(["--package-path", fixturePath.pathString, "--netrc-file", customPath.pathString])
let tool = try SwiftCommandState.makeMockState(options: options)
// There is only one AuthorizationProvider depending on platform
#if canImport(Security)
let keychainProvider = try tool.getRegistryAuthorizationProvider() as? KeychainAuthorizationProvider
XCTAssertNotNil(keychainProvider)
#else
let netrcProvider = try tool.getRegistryAuthorizationProvider() as? NetrcAuthorizationProvider
XCTAssertNotNil(netrcProvider)
XCTAssertEqual(try netrcProvider.map { try resolveSymlinks($0.path) }, try resolveSymlinks(customPath))
let auth = try tool.getRegistryAuthorizationProvider()?.authentication(for: "https://mymachine.labkey.org")
XCTAssertEqual(auth?.user, "custom@labkey.org")
XCTAssertEqual(auth?.password, "custom")
// delete it
try localFileSystem.removeFileTree(customPath)
XCTAssertThrowsError(try tool.getRegistryAuthorizationProvider(), "error expected") { error in
XCTAssertEqual(error as? StringError, StringError("did not find netrc file at \(customPath)"))
}
#endif
}
// Tests should not modify user's home dir .netrc so leaving that out intentionally
}
}
func testDebugFormatFlags() throws {
let fs = InMemoryFileSystem(emptyFiles: [
"/Pkg/Sources/exe/main.swift",
])
let observer = ObservabilitySystem.makeForTesting()
let graph = try loadModulesGraph(fileSystem: fs, manifests: [
Manifest.createRootManifest(displayName: "Pkg",
path: "/Pkg",
targets: [TargetDescription(name: "exe")])
], observabilityScope: observer.topScope)
var plan: BuildPlan
/* -debug-info-format dwarf */
let explicitDwarfOptions = try GlobalOptions.parse(["--triple", "x86_64-unknown-windows-msvc", "-debug-info-format", "dwarf"])
let explicitDwarf = try SwiftCommandState.makeMockState(options: explicitDwarfOptions)
plan = try BuildPlan(
destinationBuildParameters: explicitDwarf.productsBuildParameters,
toolsBuildParameters: explicitDwarf.toolsBuildParameters,
graph: graph,
fileSystem: fs,
observabilityScope: observer.topScope
)
try XCTAssertMatch(plan.buildProducts.compactMap { $0 as? Build.ProductBuildDescription }.first?.linkArguments() ?? [],
[.anySequence, "-g", "-use-ld=lld", "-Xlinker", "-debug:dwarf"])
/* -debug-info-format codeview */
let explicitCodeViewOptions = try GlobalOptions.parse(["--triple", "x86_64-unknown-windows-msvc", "-debug-info-format", "codeview"])
let explicitCodeView = try SwiftCommandState.makeMockState(options: explicitCodeViewOptions)
plan = try BuildPlan(
destinationBuildParameters: explicitCodeView.productsBuildParameters,
toolsBuildParameters: explicitCodeView.productsBuildParameters,
graph: graph,
fileSystem: fs,
observabilityScope: observer.topScope
)
try XCTAssertMatch(plan.buildProducts.compactMap { $0 as? Build.ProductBuildDescription }.first?.linkArguments() ?? [],
[.anySequence, "-g", "-debug-info-format=codeview", "-Xlinker", "-debug"])
// Explicitly pass Linux as when the `SwiftCommandState` tests are enabled on
// Windows, this would fail otherwise as CodeView is supported on the
// native host.
let unsupportedCodeViewOptions = try GlobalOptions.parse(["--triple", "x86_64-unknown-linux-gnu", "-debug-info-format", "codeview"])
let unsupportedCodeView = try SwiftCommandState.makeMockState(options: unsupportedCodeViewOptions)
XCTAssertThrowsError(try unsupportedCodeView.productsBuildParameters) {
XCTAssertEqual($0 as? StringError, StringError("CodeView debug information is currently not supported on linux"))
}
/* <<null>> */
let implicitDwarfOptions = try GlobalOptions.parse(["--triple", "x86_64-unknown-windows-msvc"])
let implicitDwarf = try SwiftCommandState.makeMockState(options: implicitDwarfOptions)
plan = try BuildPlan(
destinationBuildParameters: implicitDwarf.productsBuildParameters,
toolsBuildParameters: implicitDwarf.toolsBuildParameters,
graph: graph,
fileSystem: fs,
observabilityScope: observer.topScope
)
try XCTAssertMatch(plan.buildProducts.compactMap { $0 as? Build.ProductBuildDescription }.first?.linkArguments() ?? [],
[.anySequence, "-g", "-use-ld=lld", "-Xlinker", "-debug:dwarf"])
/* -debug-info-format none */
let explicitNoDebugInfoOptions = try GlobalOptions.parse(["--triple", "x86_64-unknown-windows-msvc", "-debug-info-format", "none"])
let explicitNoDebugInfo = try SwiftCommandState.makeMockState(options: explicitNoDebugInfoOptions)
plan = try BuildPlan(
destinationBuildParameters: explicitNoDebugInfo.productsBuildParameters,
toolsBuildParameters: explicitNoDebugInfo.toolsBuildParameters,
graph: graph,
fileSystem: fs,
observabilityScope: observer.topScope
)
try XCTAssertMatch(plan.buildProducts.compactMap { $0 as? Build.ProductBuildDescription }.first?.linkArguments() ?? [],
[.anySequence, "-gnone", .anySequence])
}
func testToolchainArgument() throws {
let customTargetToolchain = AbsolutePath("/path/to/toolchain")
let hostSwiftcPath = AbsolutePath("/usr/bin/swiftc")
let hostArPath = AbsolutePath("/usr/bin/ar")
let targetSwiftcPath = customTargetToolchain.appending(components: ["usr", "bin" , "swiftc"])
let targetArPath = customTargetToolchain.appending(components: ["usr", "bin", "llvm-ar"])
let fs = InMemoryFileSystem(emptyFiles: [
"/Pkg/Sources/exe/main.swift",
hostSwiftcPath.pathString,
hostArPath.pathString,
targetSwiftcPath.pathString,
targetArPath.pathString
])
for path in [hostSwiftcPath, hostArPath, targetSwiftcPath, targetArPath,] {
try fs.updatePermissions(path, isExecutable: true)
}
let observer = ObservabilitySystem.makeForTesting()
let graph = try loadModulesGraph(
fileSystem: fs,
manifests: [
Manifest.createRootManifest(
displayName: "Pkg",
path: "/Pkg",
targets: [TargetDescription(name: "exe")]
)
],
observabilityScope: observer.topScope
)
let options = try GlobalOptions.parse(
[
"--toolchain", customTargetToolchain.pathString,
"--triple", "x86_64-unknown-linux-gnu",
]
)
let swiftCommandState = try SwiftCommandState.makeMockState(
options: options,
fileSystem: fs,
environment: ["PATH": "/usr/bin"]
)
XCTAssertEqual(swiftCommandState.originalWorkingDirectory, fs.currentWorkingDirectory)
XCTAssertEqual(
try swiftCommandState.getTargetToolchain().swiftCompilerPath,
targetSwiftcPath
)
XCTAssertEqual(
try swiftCommandState.getTargetToolchain().swiftSDK.toolset.knownTools[.swiftCompiler]?.path,
nil
)
let plan = try BuildPlan(
destinationBuildParameters: swiftCommandState.productsBuildParameters,
toolsBuildParameters: swiftCommandState.toolsBuildParameters,
graph: graph,
fileSystem: fs,
observabilityScope: observer.topScope
)
let arguments = try plan.buildProducts.compactMap { $0 as? Build.ProductBuildDescription }.first?.linkArguments() ?? []
XCTAssertMatch(arguments, [.contains("/path/to/toolchain")])
}
}
extension SwiftCommandState {
static func makeMockState(
outputStream: OutputByteStream = stderrStream,
options: GlobalOptions,
fileSystem: any FileSystem = localFileSystem,
environment: Environment = .current
) throws -> SwiftCommandState {
return try SwiftCommandState(
outputStream: outputStream,
options: options,
toolWorkspaceConfiguration: .init(shouldInstallSignalHandlers: false),
workspaceDelegateProvider: {
CommandWorkspaceDelegate(
observabilityScope: $0,
outputHandler: $1,
progressHandler: $2,
inputHandler: $3
)
},
workspaceLoaderProvider: {
XcodeWorkspaceLoader(
fileSystem: $0,
observabilityScope: $1
)
},
hostTriple: .arm64Linux,
fileSystem: fileSystem,
environment: environment
)
}
}
|
