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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2014-2017 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 PackageModel
import PackageGraph
import SPMTestSupport
import SourceControl
import Workspace
import XCTest
import class TSCBasic.InMemoryFileSystem
import struct TSCUtility.Version
final class PinsStoreTests: XCTestCase {
let v1: Version = "1.0.0"
func testBasics() throws {
let fs = InMemoryFileSystem()
let pinsFile = AbsolutePath("/pinsfile.txt")
do {
let fooPath = AbsolutePath("/foo")
let foo = PackageIdentity(path: fooPath)
let fooRef = PackageReference.localSourceControl(identity: foo, path: fooPath)
let barPath = AbsolutePath("/bar")
let bar = PackageIdentity(path: barPath)
let barRef = PackageReference.localSourceControl(identity: bar, path: barPath)
var store = try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fs, mirrors: .init())
// Pins file should not be created right now.
XCTAssert(!fs.exists(pinsFile))
XCTAssert(store.pins.isEmpty)
let revision = UUID().uuidString
let state = PinsStore.PinState.version(v1, revision: revision)
store.pin(packageRef: fooRef, state: state)
try store.saveState(toolsVersion: ToolsVersion.current, originHash: .none)
XCTAssert(fs.exists(pinsFile))
// Load the store again from disk.
let store2 = try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fs, mirrors: .init())
// Test basics on the store.
for s in [store, store2] {
XCTAssert(s.pins.count == 1)
XCTAssertEqual(s.pins[bar], nil)
let fooPin = s.pins[foo]!
XCTAssertEqual(fooPin.packageRef, fooRef)
XCTAssertEqual(fooPin.state, .version(v1, revision: revision))
XCTAssertEqual(fooPin.state.description, v1.description)
}
// We should be able to pin again.
store.pin(packageRef: fooRef, state: state)
store.pin(
packageRef: fooRef,
state: .version("1.0.2", revision: revision)
)
store.pin(packageRef: barRef, state: state)
try store.saveState(toolsVersion: ToolsVersion.current, originHash: .none)
store = try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fs, mirrors: .init())
XCTAssert(store.pins.count == 2)
}
// Test source control version pin.
do {
let path = AbsolutePath("/foo")
let identity = PackageIdentity(path: path)
let revision = UUID().uuidString
var store = try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fs, mirrors: .init())
store.pin(
packageRef: .localSourceControl(identity: identity, path: path),
state: .version("1.2.3", revision: revision)
)
try store.saveState(toolsVersion: ToolsVersion.current, originHash: .none)
store = try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fs, mirrors: .init())
let pin = store.pins[identity]!
XCTAssertEqual(pin.state, .version("1.2.3", revision: revision))
XCTAssertEqual(pin.state.description, "1.2.3")
}
// Test source control branch pin.
do {
let path = AbsolutePath("/foo")
let identity = PackageIdentity(path: path)
let revision = UUID().uuidString
var store = try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fs, mirrors: .init())
store.pin(
packageRef: .localSourceControl(identity: identity, path: path),
state: .branch(name: "develop", revision: revision)
)
try store.saveState(toolsVersion: ToolsVersion.current, originHash: .none)
store = try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fs, mirrors: .init())
let pin = store.pins[identity]!
XCTAssertEqual(pin.state, .branch(name: "develop", revision: revision))
XCTAssertEqual(pin.state.description, "develop")
}
// Test source control revision pin.
do {
let path = AbsolutePath("/foo")
let identity = PackageIdentity(path: path)
let revision = UUID().uuidString
var store = try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fs, mirrors: .init())
store.pin(
packageRef: .localSourceControl(identity: identity, path: path),
state: .revision(revision)
)
try store.saveState(toolsVersion: ToolsVersion.current, originHash: .none)
store = try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fs, mirrors: .init())
let pin = store.pins[identity]!
XCTAssertEqual(pin.state, .revision(revision))
XCTAssertEqual(pin.state.description, revision)
}
// Test registry pin.
do {
let identity = PackageIdentity.plain("baz.baz") // FIXME: use scope identifier
var store = try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fs, mirrors: .init())
store.pin(
packageRef: .registry(identity: identity),
state: .version("1.2.3", revision: .none)
)
try store.saveState(toolsVersion: ToolsVersion.current, originHash: .none)
store = try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fs, mirrors: .init())
let pin = store.pins[identity]!
XCTAssertEqual(pin.state, .version("1.2.3", revision: .none))
XCTAssertEqual(pin.state.description, "1.2.3")
}
}
func testLoadingSchema1() throws {
let fs = InMemoryFileSystem()
let pinsFile = AbsolutePath("/pinsfile.txt")
try fs.writeFileContents(pinsFile, string:
"""
{
"version": 1,
"object": {
"pins": [
{
"package": "Clang_C",
"repositoryURL": "https://github.com/something/Clang_C.git",
"state": {
"branch": null,
"revision": "90a9574276f0fd17f02f58979423c3fd4d73b59e",
"version": "1.0.2",
}
},
{
"package": "Commandant",
"repositoryURL": "https://github.com/something/Commandant.git",
"state": {
"branch": null,
"revision": "c281992c31c3f41c48b5036c5a38185eaec32626",
"version": "0.12.0"
}
}
]
}
}
"""
)
let store = try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fs, mirrors: .init())
XCTAssertEqual(store.pins.keys.map { $0.description }.sorted(), ["clang_c", "commandant"])
}
func testLoadingSchema2() throws {
let fs = InMemoryFileSystem()
let pinsFile = AbsolutePath("/pinsfile.txt")
try fs.writeFileContents(pinsFile, string:
"""
{
"version": 2,
"pins": [
{
"identity": "clang_c",
"kind": "remoteSourceControl",
"location": "https://github.com/something/Clang_C.git",
"state": {
"revision": "90a9574276f0fd17f02f58979423c3fd4d73b59e",
"version": "1.0.2",
}
},
{
"identity": "commandant",
"kind": "remoteSourceControl",
"location": "https://github.com/something/Commandant.git",
"state": {
"revision": "c281992c31c3f41c48b5036c5a38185eaec32626",
"version": "0.12.0"
}
},
{
"identity": "scope.package",
"kind": "registry",
"location": "",
"state": {
"version": "0.12.0"
}
}
]
}
"""
)
let store = try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fs, mirrors: .init())
XCTAssertEqual(store.pins.keys.map { $0.description }.sorted(), ["clang_c", "commandant", "scope.package"])
}
func testLoadingSchema3() throws {
let fs = InMemoryFileSystem()
let pinsFile = AbsolutePath("/pinsfile.txt")
let originHash = UUID().uuidString
try fs.writeFileContents(pinsFile, string:
"""
{
"version": 3,
"originHash": "\(originHash)",
"pins": [
{
"identity": "clang_c",
"kind": "remoteSourceControl",
"location": "https://github.com/something/Clang_C.git",
"state": {
"revision": "90a9574276f0fd17f02f58979423c3fd4d73b59e",
"version": "1.0.2",
}
},
{
"identity": "commandant",
"kind": "remoteSourceControl",
"location": "https://github.com/something/Commandant.git",
"state": {
"revision": "c281992c31c3f41c48b5036c5a38185eaec32626",
"version": "0.12.0"
}
},
{
"identity": "scope.package",
"kind": "registry",
"location": "",
"state": {
"version": "0.12.0"
}
}
]
}
"""
)
let store = try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fs, mirrors: .init())
XCTAssertEqual(store.pins.keys.map { $0.description }.sorted(), ["clang_c", "commandant", "scope.package"])
XCTAssertEqual(store.originHash, originHash)
}
func testLoadingUnknownSchemaVersion() throws {
let fs = InMemoryFileSystem()
let pinsFile = AbsolutePath("/pinsfile.txt")
let version = -1
try fs.writeFileContents(pinsFile, string: "{ \"version\": \(version) }");
XCTAssertThrowsError(try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fs, mirrors: .init()), "error expected", { error in
XCTAssertEqual("\(error)", "\(pinsFile) file is corrupted or malformed; fix or delete the file to continue: unknown 'PinsStorage' version '\(version)' at '\(pinsFile)'.")
})
}
func testLoadingBadFormat() throws {
let fs = InMemoryFileSystem()
let pinsFile = AbsolutePath("/pinsfile.txt")
try fs.writeFileContents(pinsFile, string: "boom")
XCTAssertThrowsError(try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fs, mirrors: .init()), "error expected", { error in
XCTAssertMatch("\(error)", .contains("\(pinsFile) file is corrupted or malformed; fix or delete the file to continue"))
})
}
func testEmptyPins() throws {
let fs = InMemoryFileSystem()
let pinsFile = AbsolutePath("/pinsfile.txt")
let store = try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fs, mirrors: .init())
try store.saveState(toolsVersion: ToolsVersion.current, originHash: .none)
XCTAssertFalse(fs.exists(pinsFile))
let fooPath = AbsolutePath("/foo")
let foo = PackageIdentity(path: fooPath)
let fooRef = PackageReference.localSourceControl(identity: foo, path: fooPath)
let revision = "81513c8fd220cf1ed1452b98060cd80d3725c5b7"
store.pin(packageRef: fooRef, state: .version(v1, revision: revision))
XCTAssert(!fs.exists(pinsFile))
try store.saveState(toolsVersion: ToolsVersion.current, originHash: .none)
XCTAssert(fs.exists(pinsFile))
store.unpinAll()
try store.saveState(toolsVersion: ToolsVersion.current, originHash: .none)
XCTAssertFalse(fs.exists(pinsFile))
}
func testPinsWithMirrors() throws {
let fooURL = SourceControlURL("https://github.com/corporate/foo.git")
let fooIdentity = PackageIdentity(url: fooURL)
let fooMirroredURL = SourceControlURL("https://github.corporate.com/team/foo.git")
let barURL = SourceControlURL("https://github.com/corporate/baraka.git")
let barIdentity = PackageIdentity(url: barURL)
let barMirroredURL = SourceControlURL("https://github.corporate.com/team/bar.git")
let barMirroredIdentity = PackageIdentity(url: barMirroredURL)
let bazURL = SourceControlURL("https://github.com/cool/baz.git")
let bazIdentity = PackageIdentity(url: bazURL)
let mirrors = try DependencyMirrors()
try mirrors.set(mirror: fooMirroredURL.absoluteString, for: fooURL.absoluteString)
try mirrors.set(mirror: barMirroredURL.absoluteString, for: barURL.absoluteString)
let fileSystem = InMemoryFileSystem()
let pinsFile = AbsolutePath("/pins.txt")
let store = try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fileSystem, mirrors: mirrors)
store.pin(packageRef: .remoteSourceControl(identity: fooIdentity, url: fooMirroredURL),
state: .version(v1, revision: "foo-revision"))
store.pin(packageRef: .remoteSourceControl(identity: barIdentity, url: barMirroredURL),
state: .version(v1, revision: "bar-revision"))
store.pin(packageRef: .remoteSourceControl(identity: bazIdentity, url: bazURL),
state: .version(v1, revision: "baz-revision"))
XCTAssert(store.pins.count == 3)
XCTAssertEqual(store.pins[fooIdentity]!.packageRef.kind, .remoteSourceControl(fooMirroredURL))
XCTAssertEqual(store.pins[barIdentity]!.packageRef.kind, .remoteSourceControl(barMirroredURL))
XCTAssertNil(store.pins[barMirroredIdentity])
XCTAssertEqual(store.pins[bazIdentity]!.packageRef.kind, .remoteSourceControl(bazURL))
try store.saveState(toolsVersion: ToolsVersion.current, originHash: .none)
XCTAssert(fileSystem.exists(pinsFile))
let content: String = try fileSystem.readFileContents(pinsFile)
XCTAssertMatch(content, .contains(fooURL.absoluteString))
XCTAssertNoMatch(content, .contains(fooMirroredURL.absoluteString))
// Load the store again from disk, with no mirrors
let store2 = try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fileSystem, mirrors: .init())
XCTAssert(store2.pins.count == 3)
XCTAssertEqual(store2.pins[fooIdentity]!.packageRef.kind, .remoteSourceControl(fooURL))
XCTAssertEqual(store2.pins[barIdentity]!.packageRef.kind, .remoteSourceControl(barURL))
XCTAssertEqual(store2.pins[bazIdentity]!.packageRef.kind, .remoteSourceControl(bazURL))
// Load the store again from disk, with mirrors
let store3 = try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fileSystem, mirrors: mirrors)
XCTAssert(store3.pins.count == 3)
XCTAssertEqual(store3.pins, store.pins)
}
func testPinsWithMirrorsDeterminism() throws {
let fooIdentity = PackageIdentity.plain("foo")
let fooURL1 = SourceControlURL("https://github.com/corporate/foo")
let fooURL2 = SourceControlURL("https://github.com/corporate/foo.git")
let fooURL3 = SourceControlURL("https://github.com/old-corporate/foo")
let fooURL4 = SourceControlURL("https://github.com/old-corporate/foo.git")
let fooMirroredURL = SourceControlURL("https://github.corporate.com/team/foo")
let mirrors = try DependencyMirrors()
try mirrors.set(mirror: fooMirroredURL.absoluteString, for: fooURL1.absoluteString)
try mirrors.set(mirror: fooMirroredURL.absoluteString, for: fooURL2.absoluteString)
try mirrors.set(mirror: fooMirroredURL.absoluteString, for: fooURL3.absoluteString)
try mirrors.set(mirror: fooMirroredURL.absoluteString, for: fooURL4.absoluteString)
let fileSystem = InMemoryFileSystem()
let pinsFile = AbsolutePath("/pins.txt")
let store1 = try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fileSystem, mirrors: mirrors)
store1.pin(
packageRef: .remoteSourceControl(identity: fooIdentity, url: fooMirroredURL),
state: .version(v1, revision: "revision")
)
XCTAssert(store1.pins.count == 1)
XCTAssertEqual(store1.pins[fooIdentity]!.packageRef.kind, .remoteSourceControl(fooMirroredURL))
try store1.saveState(toolsVersion: ToolsVersion.current, originHash: .none)
XCTAssert(fileSystem.exists(pinsFile))
let content: String = try fileSystem.readFileContents(pinsFile)
XCTAssertMatch(content, .contains(fooURL1.absoluteString))
XCTAssertNoMatch(content, .contains(fooURL2.absoluteString))
XCTAssertNoMatch(content, .contains(fooURL3.absoluteString))
XCTAssertNoMatch(content, .contains(fooURL4.absoluteString))
XCTAssertNoMatch(content, .contains(fooMirroredURL.absoluteString))
// Load the store again from disk, with no mirrors
let store2 = try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fileSystem, mirrors: .init())
XCTAssert(store2.pins.count == 1)
XCTAssertEqual(store2.pins[fooIdentity]!.packageRef.kind, .remoteSourceControl(fooURL1))
// Load the store again from disk, with mirrors
let store3 = try PinsStore(pinsFile: pinsFile, workingDirectory: .root, fileSystem: fileSystem, mirrors: mirrors)
XCTAssert(store3.pins.count == 1)
XCTAssertEqual(store3.pins, store1.pins)
}
func testMirrorsDeterminism() throws {
let URL1 = URL("https://github.com/corporate/foo")
let URL2 = URL("https://github.com/corporate/foo.git")
let URL3 = URL("https://github.com/old-corporate/foo")
let URL4 = URL("https://github.com/old-corporate/foo.git")
let mirroredURL = URL("https://github.corporate.com/team/foo")
do {
let mirrors = try DependencyMirrors([
URL1.absoluteString: mirroredURL.absoluteString,
URL2.absoluteString: mirroredURL.absoluteString,
URL3.absoluteString: mirroredURL.absoluteString,
URL4.absoluteString: mirroredURL.absoluteString
])
XCTAssertEqual(mirrors.mirror(for: URL2.absoluteString), mirroredURL.absoluteString)
// reverse index is sorted by "visited", then alphabetically
XCTAssertEqual(mirrors.original(for: mirroredURL.absoluteString), URL2.absoluteString)
}
do {
let mirrors = try DependencyMirrors([
URL1.absoluteString: mirroredURL.absoluteString,
URL2.absoluteString: mirroredURL.absoluteString,
URL3.absoluteString: mirroredURL.absoluteString,
URL4.absoluteString: mirroredURL.absoluteString
])
XCTAssertEqual(mirrors.mirror(for: URL3.absoluteString), mirroredURL.absoluteString)
// reverse index is sorted by "visited", then alphabetically
XCTAssertEqual(mirrors.original(for: mirroredURL.absoluteString), URL3.absoluteString)
}
do {
let mirrors = try DependencyMirrors([
URL1.absoluteString: mirroredURL.absoluteString,
URL2.absoluteString: mirroredURL.absoluteString,
URL3.absoluteString: mirroredURL.absoluteString,
URL4.absoluteString: mirroredURL.absoluteString
])
XCTAssertEqual(mirrors.mirror(for: URL2.absoluteString), mirroredURL.absoluteString)
XCTAssertEqual(mirrors.mirror(for: URL3.absoluteString), mirroredURL.absoluteString)
// reverse index is sorted by "visited", then alphabetically
XCTAssertEqual(mirrors.original(for: mirroredURL.absoluteString), URL2.absoluteString)
}
do {
let mirrors = try DependencyMirrors([
URL1.absoluteString: mirroredURL.absoluteString,
URL2.absoluteString: mirroredURL.absoluteString,
URL3.absoluteString: mirroredURL.absoluteString,
URL4.absoluteString: mirroredURL.absoluteString
])
XCTAssertEqual(mirrors.mirror(for: URL3.absoluteString), mirroredURL.absoluteString)
XCTAssertEqual(mirrors.mirror(for: URL2.absoluteString), mirroredURL.absoluteString)
// reverse index is sorted by "visited", then alphabetically
XCTAssertEqual(mirrors.original(for: mirroredURL.absoluteString), URL3.absoluteString)
}
do {
let mirrors = try DependencyMirrors([
URL1.absoluteString: mirroredURL.absoluteString,
URL2.absoluteString: mirroredURL.absoluteString,
URL3.absoluteString: mirroredURL.absoluteString,
URL4.absoluteString: mirroredURL.absoluteString
])
// reverse index is sorted by "visited", then alphabetically
XCTAssertEqual(mirrors.original(for: mirroredURL.absoluteString), URL1.absoluteString)
}
}
}
|
