forked from swiftlang/swift-package-manager
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathSourceControlPackageContainerTests.swift
764 lines (661 loc) · 31.4 KB
/
SourceControlPackageContainerTests.swift
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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2014-2024 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 _Concurrency
import Foundation
import PackageGraph
import PackageLoading
import PackageModel
import SourceControl
import _InternalTestSupport
@testable import Workspace
import XCTest
import enum TSCUtility.Git
import struct TSCUtility.Version
private class MockRepository: Repository {
/// The fake location of the repository.
let location: RepositorySpecifier.Location
/// The known repository versions, as a map of tags to manifests.
let versions: [Version: Manifest]
let fs: FileSystem
let packageRef: PackageReference
init(fs: FileSystem, path: AbsolutePath, versions: [Version: Manifest]) {
self.fs = fs
self.location = .path(path)
self.packageRef = .localSourceControl(identity: PackageIdentity(path: path), path: path)
self.versions = versions
}
init(fs: FileSystem, url: SourceControlURL, versions: [Version: Manifest]) {
self.fs = fs
self.location = .url(url)
self.packageRef = .remoteSourceControl(identity: PackageIdentity(url: url), url: url)
self.versions = versions
}
var specifier: RepositorySpecifier {
return RepositorySpecifier(location: self.location)
}
func getTags() throws -> [String] {
return self.versions.keys.map { String(describing: $0) }
}
func resolveRevision(tag: String) throws -> Revision {
assert(self.versions.index(forKey: Version(tag)!) != nil)
return Revision(identifier: tag)
}
func resolveRevision(identifier: String) throws -> Revision {
fatalError("Unexpected API call")
}
func fetch() throws {
fatalError("Unexpected API call")
}
func exists(revision: Revision) -> Bool {
fatalError("Unexpected API call")
}
func remove() throws {
fatalError("Unexpected API call")
}
func openFileView(revision: Revision) throws -> FileSystem {
assert(self.versions.index(forKey: Version(revision.identifier)!) != nil)
// This is used for reading the tools version.
return self.fs
}
public func openFileView(tag: String) throws -> FileSystem {
let revision = try self.resolveRevision(tag: tag)
return try self.openFileView(revision: revision)
}
}
private class MockRepositoryManagerDelegate: RepositoryManager.Delegate {
var fetched = ThreadSafeArrayStore<RepositorySpecifier>()
var updated = ThreadSafeArrayStore<RepositorySpecifier>()
func willFetch(package: PackageIdentity, repository: RepositorySpecifier, details: RepositoryManager.FetchDetails) {
self.fetched.append(repository)
}
func fetching(package: PackageIdentity, repository: RepositorySpecifier, objectsFetched: Int, totalObjectsToFetch: Int) {}
func didFetch(package: PackageIdentity, repository: RepositorySpecifier, result: Result<RepositoryManager.FetchDetails, Error>, duration: DispatchTimeInterval) {}
func willUpdate(package: PackageIdentity, repository: RepositorySpecifier) {
self.updated.append(repository)
}
func didUpdate(package: PackageIdentity, repository: RepositorySpecifier, duration: DispatchTimeInterval) {}
func reset() {
self.fetched.clear()
self.updated.clear()
}
}
// Some handy versions & ranges.
//
// The convention is that the name matches how specific the version is, so "v1"
// means "any 1.?.?", and "v1_1" means "any 1.1.?".
private let v1: Version = "1.0.0"
private let v2: Version = "2.0.0"
private let v1Range: VersionSetSpecifier = .range("1.0.0" ..< "2.0.0")
final class SourceControlPackageContainerTests: XCTestCase {
func testVprefixVersions() async throws {
let fs = InMemoryFileSystem()
try fs.createMockToolchain()
let repoPath = AbsolutePath.root
let filePath = repoPath.appending("Package.swift")
let specifier = RepositorySpecifier(path: repoPath)
let repo = InMemoryGitRepository(path: repoPath, fs: fs)
try repo.createDirectory(repoPath, recursive: true)
try repo.writeFileContents(filePath, string: "// swift-tools-version:\(ToolsVersion.current)\n")
try repo.commit()
try repo.tag(name: "v1.0.0")
try repo.tag(name: "v1.0.1")
try repo.tag(name: "v1.0.2")
try repo.tag(name: "v1.0.3")
try repo.tag(name: "v2.0.3")
let inMemRepoProvider = InMemoryGitRepositoryProvider()
inMemRepoProvider.add(specifier: specifier, repository: repo)
let p = AbsolutePath.root.appending("repoManager")
try fs.createDirectory(p, recursive: true)
let repositoryManager = RepositoryManager(
fileSystem: fs,
path: p,
provider: inMemRepoProvider,
delegate: MockRepositoryManagerDelegate()
)
let provider = try Workspace._init(
fileSystem: fs,
environment: .mockEnvironment,
location: .init(forRootPackage: repoPath, fileSystem: fs),
customHostToolchain: .mockHostToolchain(fs),
customManifestLoader: MockManifestLoader(manifests: [:]),
customRepositoryManager: repositoryManager
)
let ref = PackageReference.localSourceControl(identity: PackageIdentity(path: repoPath), path: repoPath)
let container = try await provider.getContainer(for: ref)
let v = try await container.toolsVersionsAppropriateVersionsDescending()
XCTAssertEqual(v, ["2.0.3", "1.0.3", "1.0.2", "1.0.1", "1.0.0"])
}
func testVersions() async throws {
let fs = InMemoryFileSystem()
try fs.createMockToolchain()
let repoPath = AbsolutePath.root
let filePath = repoPath.appending("Package.swift")
let specifier = RepositorySpecifier(path: repoPath)
let repo = InMemoryGitRepository(path: repoPath, fs: fs)
try repo.createDirectory(repoPath, recursive: true)
try repo.writeFileContents(filePath, bytes: "// swift-tools-version:3.1")
try repo.commit()
try repo.tag(name: "1.0.0")
try repo.writeFileContents(filePath, bytes: "// swift-tools-version:4.0")
try repo.commit()
try repo.tag(name: "1.0.1")
try repo.writeFileContents(filePath, bytes: "// swift-tools-version:4.2.0;hello\n")
try repo.commit()
try repo.tag(name: "1.0.2")
try repo.writeFileContents(filePath, bytes: "// swift-tools-version:4.2.0\n")
try repo.commit()
try repo.tag(name: "1.0.3")
let inMemRepoProvider = InMemoryGitRepositoryProvider()
inMemRepoProvider.add(specifier: specifier, repository: repo)
let p = AbsolutePath.root.appending("repoManager")
try fs.createDirectory(p, recursive: true)
let repositoryManager = RepositoryManager(
fileSystem: fs,
path: p,
provider: inMemRepoProvider,
delegate: MockRepositoryManagerDelegate()
)
func createProvider(_ currentToolsVersion: ToolsVersion) throws -> PackageContainerProvider {
return try Workspace._init(
fileSystem: fs,
environment: .mockEnvironment,
location: .init(forRootPackage: repoPath, fileSystem: fs),
customToolsVersion: currentToolsVersion,
customHostToolchain: .mockHostToolchain(fs),
customManifestLoader: MockManifestLoader(manifests: [:]),
customRepositoryManager: repositoryManager
)
}
do {
let provider = try createProvider(ToolsVersion(version: "4.0.0"))
let ref = PackageReference.localSourceControl(identity: PackageIdentity(path: repoPath), path: repoPath)
let container = try await provider.getContainer(for: ref)
let v = try await container.toolsVersionsAppropriateVersionsDescending()
XCTAssertEqual(v, ["1.0.1"])
}
do {
let provider = try createProvider(ToolsVersion(version: "4.2.0"))
let ref = PackageReference.localSourceControl(identity: PackageIdentity(path: repoPath), path: repoPath)
let container = try await provider.getContainer(for: ref) as! SourceControlPackageContainer
XCTAssertTrue(container.validToolsVersionsCache.isEmpty)
let v = try await container.toolsVersionsAppropriateVersionsDescending()
XCTAssertEqual(container.validToolsVersionsCache["1.0.0"], false)
XCTAssertEqual(container.validToolsVersionsCache["1.0.1"], true)
XCTAssertEqual(container.validToolsVersionsCache["1.0.2"], true)
XCTAssertEqual(container.validToolsVersionsCache["1.0.3"], true)
XCTAssertEqual(v, ["1.0.3", "1.0.2", "1.0.1"])
}
do {
let provider = try createProvider(ToolsVersion(version: "3.0.0"))
let ref = PackageReference.localSourceControl(identity: PackageIdentity(path: repoPath), path: repoPath)
let container = try await provider.getContainer(for: ref)
let v = try await container.toolsVersionsAppropriateVersionsDescending()
XCTAssertEqual(v, [])
}
// Test that getting dependencies on a revision that has unsupported tools version is diagnosed properly.
do {
let provider = try createProvider(ToolsVersion(version: "4.0.0"))
let ref = PackageReference.localSourceControl(identity: PackageIdentity(path: repoPath), path: repoPath)
let container = try await provider.getContainer(for: ref) as! SourceControlPackageContainer
let revision = try container.getRevision(forTag: "1.0.0")
do {
_ = try await container.getDependencies(at: revision.identifier, productFilter: .nothing)
} catch let error as SourceControlPackageContainer.GetDependenciesError {
let error = error.underlyingError as! UnsupportedToolsVersion
XCTAssertMatch(error.description, .and(.prefix("package '\(PackageIdentity(path: repoPath))' @"), .suffix("is using Swift tools version 3.1.0 which is no longer supported; consider using '// swift-tools-version:4.0' to specify the current tools version")))
}
}
}
func testPreReleaseVersions() async throws {
let fs = InMemoryFileSystem()
try fs.createMockToolchain()
let repoPath = AbsolutePath.root
let filePath = repoPath.appending("Package.swift")
let specifier = RepositorySpecifier(path: repoPath)
let repo = InMemoryGitRepository(path: repoPath, fs: fs)
try repo.createDirectory(repoPath, recursive: true)
try repo.writeFileContents(filePath, string: "// swift-tools-version:\(ToolsVersion.current)\n")
try repo.commit()
try repo.tag(name: "1.0.0-alpha.1")
try repo.tag(name: "1.0.0-beta.1")
try repo.tag(name: "1.0.0")
try repo.tag(name: "1.0.1")
try repo.tag(name: "1.0.2-dev")
try repo.tag(name: "1.0.2-dev.2")
try repo.tag(name: "1.0.4-alpha")
let inMemRepoProvider = InMemoryGitRepositoryProvider()
inMemRepoProvider.add(specifier: specifier, repository: repo)
let p = AbsolutePath.root.appending("repoManager")
try fs.createDirectory(p, recursive: true)
let repositoryManager = RepositoryManager(
fileSystem: fs,
path: p,
provider: inMemRepoProvider,
delegate: MockRepositoryManagerDelegate()
)
let provider = try Workspace._init(
fileSystem: fs,
environment: .mockEnvironment,
location: .init(forRootPackage: repoPath, fileSystem: fs),
customHostToolchain: .mockHostToolchain(fs),
customManifestLoader: MockManifestLoader(manifests: [:]),
customRepositoryManager: repositoryManager
)
let ref = PackageReference.localSourceControl(identity: PackageIdentity(path: repoPath), path: repoPath)
let container = try await provider.getContainer(for: ref)
let v = try await container.toolsVersionsAppropriateVersionsDescending()
XCTAssertEqual(v, ["1.0.4-alpha", "1.0.2-dev.2", "1.0.2-dev", "1.0.1", "1.0.0", "1.0.0-beta.1", "1.0.0-alpha.1"])
}
func testSimultaneousVersions() async throws {
let fs = InMemoryFileSystem()
try fs.createMockToolchain()
let repoPath = AbsolutePath.root
let filePath = repoPath.appending("Package.swift")
let specifier = RepositorySpecifier(path: repoPath)
let repo = InMemoryGitRepository(path: repoPath, fs: fs)
try repo.createDirectory(repoPath, recursive: true)
try repo.writeFileContents(filePath, string: "// swift-tools-version:\(ToolsVersion.current)\n")
try repo.commit()
try repo.tag(name: "v1.0.0")
try repo.tag(name: "1.0.0")
try repo.tag(name: "v1.1.0")
try repo.tag(name: "1.1.0")
try repo.tag(name: "1.1")
try repo.tag(name: "1.2")
try repo.tag(name: "1.3")
try repo.tag(name: "1.3.0")
try repo.tag(name: "1.0.1")
try repo.tag(name: "v1.0.2")
try repo.tag(name: "1.0.4")
try repo.tag(name: "v2.0.1")
let inMemRepoProvider = InMemoryGitRepositoryProvider()
inMemRepoProvider.add(specifier: specifier, repository: repo)
let p = AbsolutePath.root.appending("repoManager")
try fs.createDirectory(p, recursive: true)
let repositoryManager = RepositoryManager(
fileSystem: fs,
path: p,
provider: inMemRepoProvider,
delegate: MockRepositoryManagerDelegate()
)
let provider = try Workspace._init(
fileSystem: fs,
environment: .mockEnvironment,
location: .init(forRootPackage: repoPath, fileSystem: fs),
customHostToolchain: .mockHostToolchain(fs),
customManifestLoader: MockManifestLoader(manifests: [:]),
customRepositoryManager: repositoryManager
)
let ref = PackageReference.localSourceControl(identity: PackageIdentity(path: repoPath), path: repoPath)
let container = try await provider.getContainer(for: ref)
let v = try await container.toolsVersionsAppropriateVersionsDescending()
XCTAssertEqual(v, ["2.0.1", "1.3.0", "1.2.0", "1.1.0", "1.0.4", "1.0.2", "1.0.1", "1.0.0"])
}
func testDependencyConstraints() throws {
#if ENABLE_TARGET_BASED_DEPENDENCY_RESOLUTION
#else
try XCTSkipIf(true)
#endif
let dependencies: [PackageDependency] = [
.localSourceControl(path: "/Bar1", requirement: .upToNextMajor(from: "1.0.0")),
.localSourceControl(path: "/Bar2", requirement: .upToNextMajor(from: "1.0.0")),
.localSourceControl(path: "/Bar3", requirement: .upToNextMajor(from: "1.0.0")),
]
let products = [
try ProductDescription(name: "Foo", type: .library(.automatic), targets: ["Foo1"]),
]
let targets = [
try TargetDescription(name: "Foo1", dependencies: ["Foo2", "Bar1"]),
try TargetDescription(name: "Foo2", dependencies: [.product(name: "B2", package: "Bar2")]),
try TargetDescription(name: "Foo3", dependencies: ["Bar3"]),
]
let v5ProductMapping: [String: ProductFilter] = [
"bar1": .specific(["Bar1", "Bar3"]),
"bar2": .specific(["B2", "Bar1", "Bar3"]),
"bar3": .specific(["Bar1", "Bar3"]),
]
let v5Constraints = try dependencies.map {
PackageContainerConstraint(
package: $0.packageRef,
requirement: try $0.toConstraintRequirement(),
products: v5ProductMapping[$0.identity.description]!
)
}
let v5_2ProductMapping: [String: ProductFilter] = [
"bar1": .specific(["Bar1"]),
"bar2": .specific(["B2"]),
"bar3": .specific(["Bar3"]),
]
let v5_2Constraints = try dependencies.map {
PackageContainerConstraint(
package: $0.packageRef,
requirement: try $0.toConstraintRequirement(),
products: v5_2ProductMapping[$0.identity.description]!
)
}
do {
let manifest = Manifest.createRootManifest(
displayName: "Foo",
path: "/Foo",
toolsVersion: .v5,
dependencies: dependencies,
products: products,
targets: targets
)
XCTAssertEqual(
try manifest
.dependencyConstraints(productFilter: .everything)
.sorted(by: { $0.package.identity < $1.package.identity }),
[
v5Constraints[0],
v5Constraints[1],
v5Constraints[2],
]
)
}
do {
let manifest = Manifest.createFileSystemManifest(
displayName: "Foo",
path: "/Foo",
toolsVersion: .v5,
dependencies: dependencies,
products: products,
targets: targets
)
XCTAssertEqual(
try manifest
.dependencyConstraints(productFilter: .everything)
.sorted(by: { $0.package.identity < $1.package.identity }),
[
v5Constraints[0],
v5Constraints[1],
v5Constraints[2],
]
)
}
do {
let manifest = Manifest.createRootManifest(
displayName: "Foo",
path: "/Foo",
toolsVersion: .v5_2,
dependencies: dependencies,
products: products,
targets: targets
)
XCTAssertEqual(
try manifest
.dependencyConstraints(productFilter: .everything)
.sorted(by: { $0.package.identity < $1.package.identity }),
[
v5_2Constraints[0],
v5_2Constraints[1],
v5_2Constraints[2],
]
)
}
do {
let manifest = Manifest.createFileSystemManifest(
displayName: "Foo",
path: "/Foo",
toolsVersion: .v5_2,
dependencies: dependencies,
products: products,
targets: targets
)
XCTAssertEqual(
try manifest
.dependencyConstraints(productFilter: .specific(Set(products.map { $0.name })))
.sorted(by: { $0.package.identity < $1.package.identity }),
[
v5_2Constraints[0],
v5_2Constraints[1],
]
)
}
}
func testMissingBranchDiagnostics() async throws {
try await testWithTemporaryDirectory { tmpDir in
// Create a repository.
let packageDir = tmpDir.appending("SomePackage")
try localFileSystem.createDirectory(packageDir)
initGitRepo(packageDir)
let packageRepo = GitRepository(path: packageDir)
// Create a package manifest in it (it only needs the `swift-tools-version` part, because we'll supply the manifest later).
let manifestFile = packageDir.appending("Package.swift")
try localFileSystem.writeFileContents(manifestFile, string: "// swift-tools-version:4.2")
// Commit it and tag it.
try packageRepo.stage(file: "Package.swift")
try packageRepo.commit(message: "Initial")
try packageRepo.tag(name: "1.0.0")
// Rename the `master` branch to `main`.
try systemQuietly([Git.tool, "-C", packageDir.pathString, "branch", "-m", "main"])
// Create a repository manager for it.
let repoProvider = GitRepositoryProvider()
let repositoryManager = RepositoryManager(
fileSystem: localFileSystem,
path: packageDir,
provider: repoProvider,
delegate: .none
)
// Create a container provider, configured with a mock manifest loader that will return the package manifest.
let manifest = Manifest.createRootManifest(
displayName: packageDir.basename,
path: packageDir,
targets: [
try TargetDescription(name: packageDir.basename, path: packageDir.pathString),
]
)
let containerProvider = try Workspace._init(
fileSystem: localFileSystem,
environment: .current,
location: .init(forRootPackage: packageDir, fileSystem: localFileSystem),
customManifestLoader: MockManifestLoader(manifests: [.init(url: packageDir.pathString, version: nil): manifest]),
customRepositoryManager: repositoryManager
)
// Get a hold of the container for the test package.
let packageRef = PackageReference.localSourceControl(identity: PackageIdentity(path: packageDir), path: packageDir)
let container = try await containerProvider.getContainer(for: packageRef) as! SourceControlPackageContainer
// Simulate accessing a fictitious dependency on the `master` branch, and check that we get back the expected error.
do { _ = try await container.getDependencies(at: "master", productFilter: .everything) }
catch let error as SourceControlPackageContainer.GetDependenciesError {
// We expect to get an error message that mentions main.
XCTAssertMatch(error.description, .and(.prefix("could not find a branch named ‘master’"), .suffix("(did you mean ‘main’?)")))
XCTAssertMatch(error.repository.description, .suffix("SomePackage"))
XCTAssertMatch(error.reference, "master")
}
// Simulate accessing a fictitious dependency on some random commit that doesn't exist, and check that we get back the expected error.
do { _ = try await container.getDependencies(at: "535f4cb5b4a0872fa691473e82d7b27b9894df00", productFilter: .everything) }
catch let error as SourceControlPackageContainer.GetDependenciesError {
// We expect to get an error message about the specific commit.
XCTAssertMatch(error.description, .prefix("could not find the commit 535f4cb5b4a0872fa691473e82d7b27b9894df00"))
XCTAssertMatch(error.repository.description, .suffix("SomePackage"))
XCTAssertMatch(error.reference, "535f4cb5b4a0872fa691473e82d7b27b9894df00")
}
}
}
func testRepositoryContainerUpdateStrategy() async throws {
try await testWithTemporaryDirectory { temporaryDirectory in
let packageDirectory = temporaryDirectory.appending("MyPackage")
let package = PackageReference.localSourceControl(identity: PackageIdentity(path: packageDirectory), path: packageDirectory)
try localFileSystem.createDirectory(packageDirectory)
initGitRepo(packageDirectory)
try localFileSystem.writeFileContents(packageDirectory.appending(Manifest.filename), string: "")
try ToolsVersionSpecificationWriter.rewriteSpecification(manifestDirectory: packageDirectory, toolsVersion: .current, fileSystem: localFileSystem)
let repositoryProvider = GitRepositoryProvider()
let repositoryManagerDelegate = MockRepositoryManagerDelegate()
let repositoryManager = RepositoryManager(
fileSystem: localFileSystem,
path: packageDirectory,
provider: repositoryProvider,
delegate: repositoryManagerDelegate
)
let containerProvider = try Workspace._init(
fileSystem: localFileSystem,
environment: .current,
location: .init(forRootPackage: packageDirectory, fileSystem: localFileSystem),
customManifestLoader: MockManifestLoader(
manifests: [
.init(url: packageDirectory.pathString, version: nil): Manifest.createRootManifest(
displayName: packageDirectory.basename,
path: packageDirectory,
targets: [
try TargetDescription(name: packageDirectory.basename, path: packageDirectory.pathString),
]
)
]
),
customRepositoryManager: repositoryManager
)
do {
repositoryManagerDelegate.reset()
XCTAssertEqual(repositoryManagerDelegate.updated.count, 0)
_ = try await containerProvider.getContainer(
for: package,
updateStrategy: .never
)
XCTAssertEqual(repositoryManagerDelegate.updated.count, 0)
}
do {
repositoryManagerDelegate.reset()
XCTAssertEqual(repositoryManagerDelegate.updated.count, 0)
_ = try await containerProvider.getContainer(
for: package,
updateStrategy: .always
)
XCTAssertEqual(repositoryManagerDelegate.updated.count, 1)
}
do {
let repository = GitRepository(path: packageDirectory)
try repository.tag(name: "1.0.0")
let revision = try repository.resolveRevision(tag: "1.0.0")
repositoryManagerDelegate.reset()
XCTAssertEqual(repositoryManagerDelegate.updated.count, 0)
_ = try await containerProvider.getContainer(
for: package,
updateStrategy: .ifNeeded(revision: revision.identifier)
)
XCTAssertEqual(repositoryManagerDelegate.updated.count, 0)
}
do {
repositoryManagerDelegate.reset()
XCTAssertEqual(repositoryManagerDelegate.updated.count, 0)
_ = try await containerProvider.getContainer(
for: package,
updateStrategy: .ifNeeded(revision: UUID().uuidString)
)
XCTAssertEqual(repositoryManagerDelegate.updated.count, 1)
}
}
}
// From rdar://problem/65284674
// RepositoryPackageContainer used to erroneously cache dependencies based only on version,
// storing the result of the first product filter and then continually returning it for other filters too.
// This lead to corrupt graph states.
func testRepositoryPackageContainerCache() async throws {
try await testWithTemporaryDirectory { temporaryDirectory in
let packageDirectory = temporaryDirectory.appending("Package")
try localFileSystem.createDirectory(packageDirectory)
initGitRepo(packageDirectory)
let packageRepository = GitRepository(path: packageDirectory)
let manifestFile = packageDirectory.appending("Package.swift")
try localFileSystem.writeFileContents(manifestFile, string: "// swift-tools-version:5.2")
try packageRepository.stage(file: "Package.swift")
try packageRepository.commit(message: "Initialized.")
try packageRepository.tag(name: "1.0.0")
let repositoryProvider = GitRepositoryProvider()
let repositoryManager = RepositoryManager(
fileSystem: localFileSystem,
path: packageDirectory,
provider: repositoryProvider,
delegate: .none
)
let version = Version(1, 0, 0)
let manifest = Manifest.createRootManifest(
displayName: packageDirectory.basename,
path: packageDirectory,
toolsVersion: .v5_2,
dependencies: [
.localSourceControl(
path: "/Somewhere/Dependency",
requirement: .exact(version),
productFilter: .specific([])
)
],
products: [
try ProductDescription(name: "Product", type: .library(.automatic), targets: ["Target"])
],
targets: [
try TargetDescription(
name: "Target",
dependencies: [.product(name: "DependencyProduct", package: "Dependency")]
),
]
)
let containerProvider = try Workspace._init(
fileSystem: localFileSystem,
environment: .current,
location: .init(forRootPackage: packageDirectory, fileSystem: localFileSystem),
customManifestLoader: MockManifestLoader(
manifests: [.init(url: packageDirectory.pathString, version: Version(1, 0, 0)): manifest]
),
customRepositoryManager: repositoryManager
)
let packageReference = PackageReference.localSourceControl(identity: PackageIdentity(path: packageDirectory), path: packageDirectory)
let container = try await containerProvider.getContainer(for: packageReference)
let forNothing = try await container.getDependencies(at: version, productFilter: .specific([]))
let forProduct = try await container.getDependencies(at: version, productFilter: .specific(["Product"]))
#if ENABLE_TARGET_BASED_DEPENDENCY_RESOLUTION
// If the cache overlaps (incorrectly), these will be the same.
XCTAssertNotEqual(forNothing, forProduct)
#endif
}
}
}
extension PackageContainerProvider {
fileprivate func getContainer(
for package: PackageReference,
updateStrategy: ContainerUpdateStrategy = .always
) async throws -> PackageContainer {
try await withCheckedThrowingContinuation { continuation in
self.getContainer(
for: package,
updateStrategy: updateStrategy,
observabilityScope: ObservabilitySystem.NOOP,
on: .global(),
completion: {
continuation.resume(with: $0)
}
)
}
}
}
extension RepositoryManager {
fileprivate convenience init(
fileSystem: FileSystem,
path: AbsolutePath,
provider: RepositoryProvider,
cachePath: AbsolutePath? = .none,
cacheLocalPackages: Bool = false,
delegate: RepositoryManagerDelegate? = .none
) {
self.init(
fileSystem: fileSystem,
path: path,
provider: provider,
cachePath: cachePath,
cacheLocalPackages: cacheLocalPackages,
initializationWarningHandler: { _ in },
delegate: delegate
)
}
}