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
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
|
//===------- CachingModuleBuildTests.swift - Swift Driver Tests -----------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
@_spi(Testing) import SwiftDriver
import SwiftDriverExecution
import TSCBasic
import XCTest
import TestUtilities
private var testInputsPath: AbsolutePath {
get throws {
var root: AbsolutePath = try AbsolutePath(validating: #file)
while root.basename != "Tests" {
root = root.parentDirectory
}
return root.parentDirectory.appending(component: "TestInputs")
}
}
private func checkCachingBuildJob(job: Job,
moduleId: ModuleDependencyId,
dependencyGraph: InterModuleDependencyGraph)
throws {
let moduleInfo = try dependencyGraph.moduleInfo(of: moduleId)
switch moduleInfo.details {
case .swift(let swiftModuleDetails):
XCTAssertTrue(job.commandLine.contains(.flag(String("-disable-implicit-swift-modules"))))
XCTAssertTrue(job.commandLine.contains(.flag(String("-cache-compile-job"))))
XCTAssertTrue(job.commandLine.contains(.flag(String("-cas-path"))))
let moduleInterfacePath =
TypedVirtualPath(file: swiftModuleDetails.moduleInterfacePath!.path,
type: .swiftInterface)
XCTAssertEqual(job.kind, .compileModuleFromInterface)
XCTAssertTrue(job.inputs.contains(moduleInterfacePath))
if let compiledCandidateList = swiftModuleDetails.compiledModuleCandidates {
for compiledCandidate in compiledCandidateList {
let candidatePath = compiledCandidate.path
let typedCandidatePath = TypedVirtualPath(file: candidatePath,
type: .swiftModule)
XCTAssertTrue(job.inputs.contains(typedCandidatePath))
XCTAssertTrue(job.commandLine.contains(.flag(VirtualPath.lookup(candidatePath).description)))
}
XCTAssertTrue(job.commandLine.filter {$0 == .flag("-candidate-module-file")}.count == compiledCandidateList.count)
}
// make sure command-line from dep-scanner are included.
let extraCommandLine = try XCTUnwrap(swiftModuleDetails.commandLine)
for command in extraCommandLine {
XCTAssertTrue(job.commandLine.contains(.flag(command)))
}
case .clang(_):
XCTAssertEqual(job.kind, .generatePCM)
XCTAssertEqual(job.description, "Compiling Clang module \(moduleId.moduleName)")
case .swiftPrebuiltExternal(_):
XCTFail("Unexpected prebuilt external module dependency found.")
case .swiftPlaceholder(_):
XCTFail("Placeholder dependency found.")
}
// Ensure the frontend was prohibited from doing implicit module builds
XCTAssertTrue(job.commandLine.contains(.flag(String("-fno-implicit-modules"))))
try checkCachingBuildJobDependencies(job: job,
moduleInfo: moduleInfo,
dependencyGraph: dependencyGraph)
}
/// Checks that the output keys are in the action cache and also the output
/// can be replayed from CAS and identicial to the original output.
private func checkCASForResults(jobs: [Job], cas: SwiftScanCAS, fs: FileSystem) throws {
let expectation = XCTestExpectation(description: "Check CAS for output")
@Sendable
func replayAndVerifyOutput(_ job: Job, _ compilations: [CachedCompilation]) async throws {
func hashFile(_ file: VirtualPath) throws -> String {
// store the content in the CAS as a hashing function.
return try fs.readFileContents(file).withData {
try cas.store(data: $0)
}
}
let outputHashes = try job.outputs.map {
let hash = try hashFile($0.file)
// remove the original output after hashing the file.
try fs.removeFileTree($0.file)
return hash
}
let resolver = try ArgsResolver(fileSystem: fs)
let arguments: [String] = try resolver.resolveArgumentList(for: job.commandLine)
let instance = try cas.createReplayInstance(commandLine: arguments)
for compilation in compilations {
let _ = try cas.replayCompilation(instance: instance, compilation: compilation)
}
let replayHashes = try job.outputs.map {
try hashFile($0.file)
}
XCTAssertEqual(outputHashes, replayHashes, "replayed output is not identical to original")
}
Task {
defer {
expectation.fulfill()
}
for job in jobs {
if !job.kind.supportCaching {
continue
}
var compilations = [CachedCompilation]()
for (_, key) in job.outputCacheKeys {
if let compilation = try await cas.queryCacheKey(key, globally: false) {
for output in compilation {
XCTAssertTrue(output.isMaterialized, "Cached output not founded in CAS")
let success = try await output.load()
XCTAssertTrue(success, "Cached output not founded in CAS")
// Try async download. Download should succeed even on a local CAS.
let casID = try output.getCASID()
let downloaded = try await cas.download(with: casID)
XCTAssertTrue(downloaded, "Cached output cannot be downloaded")
}
// Execise the uploading path.
try await compilation.makeGlobal()
// Execise call back uploading method.
compilation.makeGlobal { error in
XCTAssertTrue(error == nil, "Upload Error")
}
compilations.append(compilation)
} else {
XCTFail("Cached entry not found")
}
}
try await replayAndVerifyOutput(job, compilations)
}
}
let result = XCTWaiter.wait(for: [expectation], timeout: 10.0)
XCTAssertEqual(result, .completed)
}
/// Checks that the build job for the specified module contains the required options and inputs
/// to build all of its dependencies explicitly
private func checkCachingBuildJobDependencies(job: Job,
moduleInfo : ModuleInfo,
dependencyGraph: InterModuleDependencyGraph
) throws {
let validateSwiftCommandLineDependency: (ModuleDependencyId, SwiftModuleDetails) throws -> Void = { dependencyId, dependencyDetails in
let cacheKey = try XCTUnwrap(dependencyDetails.moduleCacheKey)
XCTAssertTrue(job.commandLine.contains(
.flag(String("-swift-module-file=\(dependencyId.moduleName)=\(cacheKey)"))))
}
let validateBinaryCommandLineDependency: (ModuleDependencyId, SwiftPrebuiltExternalModuleDetails) throws -> Void = { dependencyId, dependencyDetails in
let cacheKey = try XCTUnwrap(dependencyDetails.moduleCacheKey)
XCTAssertTrue(job.commandLine.contains(
.flag(String("-swift-module-file=\(dependencyId.moduleName)=\(cacheKey)"))))
}
let validateClangCommandLineDependency: (ModuleDependencyId,
ModuleInfo,
ClangModuleDetails) throws -> Void = { dependencyId, dependencyInfo, clangDependencyDetails in
let clangDependencyModulePathString = dependencyInfo.modulePath.path
let clangDependencyModulePath =
TypedVirtualPath(file: clangDependencyModulePathString, type: .pcm)
XCTAssertTrue(job.inputs.contains(clangDependencyModulePath))
XCTAssertTrue(job.commandLine.contains(
.flag(String("-fmodule-file=\(dependencyId.moduleName)=\(clangDependencyModulePathString)"))))
XCTAssertTrue(job.commandLine.contains(
.flag(String("-fmodule-file-cache-key"))))
let cacheKey = try XCTUnwrap(clangDependencyDetails.moduleCacheKey)
XCTAssertTrue(job.commandLine.contains(.flag(String(cacheKey))))
}
for dependencyId in moduleInfo.directDependencies! {
let dependencyInfo = try dependencyGraph.moduleInfo(of: dependencyId)
switch dependencyInfo.details {
case .swift(let swiftDependencyDetails):
try validateSwiftCommandLineDependency(dependencyId, swiftDependencyDetails)
case .swiftPrebuiltExternal(let swiftDependencyDetails):
try validateBinaryCommandLineDependency(dependencyId, swiftDependencyDetails)
case .clang(let clangDependencyDetails):
try validateClangCommandLineDependency(dependencyId, dependencyInfo, clangDependencyDetails)
case .swiftPlaceholder(_):
XCTFail("Placeholder dependency found.")
}
// Ensure all transitive dependencies got added as well.
for transitiveDependencyId in dependencyInfo.directDependencies! {
try checkCachingBuildJobDependencies(job: job,
moduleInfo: try dependencyGraph.moduleInfo(of: transitiveDependencyId),
dependencyGraph: dependencyGraph)
}
}
}
final class CachingBuildTests: XCTestCase {
let dependencyOracle = InterModuleDependencyOracle()
override func setUpWithError() throws {
try super.setUpWithError()
// If the toolchain doesn't support caching, skip directly.
let driver = try Driver(args: ["swiftc", "-v"])
#if os(Windows)
throw XCTSkip("caching not supported on windows")
#else
guard driver.isFeatureSupported(.compilation_caching) else {
throw XCTSkip("caching not supported")
}
#endif
}
private func pathMatchesSwiftModule(path: VirtualPath, _ name: String) -> Bool {
return path.basenameWithoutExt.starts(with: "\(name)-") &&
path.extension! == FileType.swiftModule.rawValue
}
func testCachingBuildJobs() throws {
try withTemporaryDirectory { path in
let main = path.appending(component: "testCachingBuildJobs.swift")
try localFileSystem.writeFileContents(main) {
$0.send("import C;import E;import G;")
}
let casPath = path.appending(component: "cas")
let swiftModuleInterfacesPath: AbsolutePath =
try testInputsPath.appending(component: "ExplicitModuleBuilds")
.appending(component: "Swift")
let cHeadersPath: AbsolutePath =
try testInputsPath.appending(component: "ExplicitModuleBuilds")
.appending(component: "CHeaders")
let bridgingHeaderpath: AbsolutePath =
cHeadersPath.appending(component: "Bridging.h")
let sdkArgumentsForTesting = (try? Driver.sdkArgumentsForTesting()) ?? []
var driver = try Driver(args: ["swiftc",
"-target", "x86_64-apple-macosx11.0",
"-I", cHeadersPath.nativePathString(escaped: true),
"-I", swiftModuleInterfacesPath.nativePathString(escaped: true),
"-explicit-module-build", "-v",
"-cache-compile-job", "-cas-path", casPath.nativePathString(escaped: true),
"-import-objc-header", bridgingHeaderpath.nativePathString(escaped: true),
main.nativePathString(escaped: true)] + sdkArgumentsForTesting)
let jobs = try driver.planBuild()
let dependencyGraph = try driver.gatherModuleDependencies()
let mainModuleInfo = try dependencyGraph.moduleInfo(of: .swift("testCachingBuildJobs"))
guard case .swift(_) = mainModuleInfo.details else {
XCTFail("Main module does not have Swift details field")
return
}
for job in jobs {
XCTAssertEqual(job.outputs.count, 1)
let outputFilePath = job.outputs[0].file
// Swift dependencies
if outputFilePath.extension != nil,
outputFilePath.extension! == FileType.swiftModule.rawValue {
if pathMatchesSwiftModule(path: outputFilePath, "A") {
try checkCachingBuildJob(job: job, moduleId: .swift("A"),
dependencyGraph: dependencyGraph)
} else if pathMatchesSwiftModule(path: outputFilePath, "E") {
try checkCachingBuildJob(job: job, moduleId: .swift("E"),
dependencyGraph: dependencyGraph)
} else if pathMatchesSwiftModule(path: outputFilePath, "G") {
try checkCachingBuildJob(job: job, moduleId: .swift("G"),
dependencyGraph: dependencyGraph)
} else if pathMatchesSwiftModule(path: outputFilePath, "Swift") {
try checkCachingBuildJob(job: job, moduleId: .swift("Swift"),
dependencyGraph: dependencyGraph)
} else if pathMatchesSwiftModule(path: outputFilePath, "_Concurrency") {
try checkCachingBuildJob(job: job, moduleId: .swift("_Concurrency"),
dependencyGraph: dependencyGraph)
} else if pathMatchesSwiftModule(path: outputFilePath, "_StringProcessing") {
try checkCachingBuildJob(job: job, moduleId: .swift("_StringProcessing"),
dependencyGraph: dependencyGraph)
} else if pathMatchesSwiftModule(path: outputFilePath, "SwiftOnoneSupport") {
try checkCachingBuildJob(job: job, moduleId: .swift("SwiftOnoneSupport"),
dependencyGraph: dependencyGraph)
}
// Clang Dependencies
} else if let outputExtension = outputFilePath.extension,
outputExtension == FileType.pcm.rawValue {
let relativeOutputPathFileName = outputFilePath.basename
if relativeOutputPathFileName.starts(with: "A-") {
try checkCachingBuildJob(job: job, moduleId: .clang("A"),
dependencyGraph: dependencyGraph)
}
else if relativeOutputPathFileName.starts(with: "B-") {
try checkCachingBuildJob(job: job, moduleId: .clang("B"),
dependencyGraph: dependencyGraph)
}
else if relativeOutputPathFileName.starts(with: "C-") {
try checkCachingBuildJob(job: job, moduleId: .clang("C"),
dependencyGraph: dependencyGraph)
}
else if relativeOutputPathFileName.starts(with: "G-") {
try checkCachingBuildJob(job: job, moduleId: .clang("G"),
dependencyGraph: dependencyGraph)
}
else if relativeOutputPathFileName.starts(with: "F-") {
try checkCachingBuildJob(job: job, moduleId: .clang("F"),
dependencyGraph: dependencyGraph)
}
else if relativeOutputPathFileName.starts(with: "SwiftShims-") {
try checkCachingBuildJob(job: job, moduleId: .clang("SwiftShims"),
dependencyGraph: dependencyGraph)
}
else if relativeOutputPathFileName.starts(with: "_SwiftConcurrencyShims-") {
try checkCachingBuildJob(job: job, moduleId: .clang("_SwiftConcurrencyShims"),
dependencyGraph: dependencyGraph)
}
else {
XCTFail("Unexpected module dependency build job output: \(outputFilePath)")
}
} else {
switch (outputFilePath) {
case .relative(try RelativePath(validating: "testCachingBuildJobs")):
XCTAssertTrue(driver.isExplicitMainModuleJob(job: job))
XCTAssertEqual(job.kind, .link)
case .temporary(_):
let baseName = "testCachingBuildJobs"
XCTAssertTrue(matchTemporary(outputFilePath, basename: baseName, fileExtension: "o") ||
matchTemporary(outputFilePath, basename: baseName, fileExtension: "autolink") ||
matchTemporary(outputFilePath, basename: "Bridging", fileExtension: "pch"))
default:
XCTFail("Unexpected module dependency build job output: \(outputFilePath)")
}
}
}
}
}
func testModuleOnlyJob() throws {
let (stdlibPath, shimsPath, _, _) = try getDriverArtifactsForScanning()
try withTemporaryDirectory { path in
let main = path.appending(component: "testModuleOnlyJob.swift")
try localFileSystem.writeFileContents(main) {
$0.send("import C;import E;")
}
let other = path.appending(component: "testModuleOnlyJob2.swift")
try localFileSystem.writeFileContents(other) {
$0.send("import G;")
}
let swiftModuleInterfacesPath: AbsolutePath =
try testInputsPath.appending(component: "ExplicitModuleBuilds")
.appending(component: "Swift")
let cHeadersPath: AbsolutePath =
try testInputsPath.appending(component: "ExplicitModuleBuilds")
.appending(component: "CHeaders")
let casPath = path.appending(component: "cas")
let swiftInterfacePath: AbsolutePath = path.appending(component: "testModuleOnlyJob.swiftinterface")
let privateSwiftInterfacePath: AbsolutePath = path.appending(component: "testModuleOnlyJob.private.swiftinterface")
let modulePath: AbsolutePath = path.appending(component: "testModuleOnlyJob.swiftmodule")
let sdkArgumentsForTesting = (try? Driver.sdkArgumentsForTesting()) ?? []
var driver = try Driver(args: ["swiftc",
"-module-name", "Test",
"-I", cHeadersPath.nativePathString(escaped: true),
"-I", swiftModuleInterfacesPath.nativePathString(escaped: true),
"-I", stdlibPath.nativePathString(escaped: true),
"-I", shimsPath.nativePathString(escaped: true),
"-emit-module-interface-path", swiftInterfacePath.nativePathString(escaped: true),
"-emit-private-module-interface-path", privateSwiftInterfacePath.nativePathString(escaped: true),
"-explicit-module-build", "-emit-module-separately-wmo", "-disable-cmo", "-Rcache-compile-job",
"-enable-library-evolution", "-O", "-whole-module-optimization",
"-cache-compile-job", "-cas-path", casPath.nativePathString(escaped: true),
"-emit-module", "-o", modulePath.nativePathString(escaped: true),
main.nativePathString(escaped: true), other.nativePathString(escaped: true)] + sdkArgumentsForTesting,
env: ProcessEnv.vars,
interModuleDependencyOracle: dependencyOracle)
let jobs = try driver.planBuild()
try driver.run(jobs: jobs)
for job in jobs {
XCTAssertFalse(job.outputCacheKeys.isEmpty)
}
XCTAssertFalse(driver.diagnosticEngine.hasErrors)
let scanLibPath = try XCTUnwrap(driver.getSwiftScanLibPath())
try dependencyOracle.verifyOrCreateScannerInstance(fileSystem: localFileSystem,
swiftScanLibPath: scanLibPath)
let cas = try dependencyOracle.getOrCreateCAS(pluginPath: nil, onDiskPath: casPath, pluginOptions: [])
if let driverCAS = driver.cas {
XCTAssertEqual(cas, driverCAS, "CAS should only be created once")
} else {
XCTFail("Cached compilation doesn't have a CAS")
}
try checkCASForResults(jobs: jobs, cas: cas, fs: driver.fileSystem)
}
}
func testSeparateModuleJob() throws {
let (stdlibPath, shimsPath, _, _) = try getDriverArtifactsForScanning()
try withTemporaryDirectory { path in
let main = path.appending(component: "testSeparateModuleJob.swift")
try localFileSystem.writeFileContents(main) {
$0.send("import C;import E;")
}
let swiftModuleInterfacesPath: AbsolutePath =
try testInputsPath.appending(component: "ExplicitModuleBuilds")
.appending(component: "Swift")
let cHeadersPath: AbsolutePath =
try testInputsPath.appending(component: "ExplicitModuleBuilds")
.appending(component: "CHeaders")
let casPath = path.appending(component: "cas")
let swiftInterfacePath: AbsolutePath = path.appending(component: "testSeparateModuleJob.swiftinterface")
let privateSwiftInterfacePath: AbsolutePath = path.appending(component: "testSeparateModuleJob.private.swiftinterface")
let modulePath: AbsolutePath = path.appending(component: "testSeparateModuleJob.swiftmodule")
let sdkArgumentsForTesting = (try? Driver.sdkArgumentsForTesting()) ?? []
var driver = try Driver(args: ["swiftc",
"-module-name", "Test",
"-I", cHeadersPath.nativePathString(escaped: true),
"-I", swiftModuleInterfacesPath.nativePathString(escaped: true),
"-I", stdlibPath.nativePathString(escaped: true),
"-I", shimsPath.nativePathString(escaped: true),
"-emit-module-path", modulePath.nativePathString(escaped: true),
"-emit-module-interface-path", swiftInterfacePath.nativePathString(escaped: true),
"-emit-private-module-interface-path", privateSwiftInterfacePath.nativePathString(escaped: true),
"-explicit-module-build", "-experimental-emit-module-separately", "-Rcache-compile-job",
"-enable-library-evolution", "-O",
"-cache-compile-job", "-cas-path", casPath.nativePathString(escaped: true),
"-Xfrontend", "-disable-implicit-concurrency-module-import",
"-Xfrontend", "-disable-implicit-string-processing-module-import",
main.nativePathString(escaped: true)] + sdkArgumentsForTesting,
env: ProcessEnv.vars,
interModuleDependencyOracle: dependencyOracle)
let jobs = try driver.planBuild()
for job in jobs {
XCTAssertFalse(job.outputCacheKeys.isEmpty)
}
try driver.run(jobs: jobs)
XCTAssertFalse(driver.diagnosticEngine.hasErrors)
let scanLibPath = try XCTUnwrap(driver.getSwiftScanLibPath())
try dependencyOracle.verifyOrCreateScannerInstance(fileSystem: localFileSystem,
swiftScanLibPath: scanLibPath)
let cas = try dependencyOracle.getOrCreateCAS(pluginPath: nil, onDiskPath: casPath, pluginOptions: [])
if let driverCAS = driver.cas {
XCTAssertEqual(cas, driverCAS, "CAS should only be created once")
} else {
XCTFail("Cached compilation doesn't have a CAS")
}
try checkCASForResults(jobs: jobs, cas: cas, fs: driver.fileSystem)
}
}
/// Test generation of explicit module build jobs for dependency modules when the driver
/// is invoked with -explicit-module-build, -verify-emitted-module-interface and -enable-library-evolution.
func testExplicitModuleVerifyInterfaceJobs() throws {
try withTemporaryDirectory { path in
let main = path.appending(component: "testExplicitModuleVerifyInterfaceJobs.swift")
try localFileSystem.writeFileContents(main) {
$0.send("import C;import E;import G;")
}
let swiftModuleInterfacesPath: AbsolutePath =
try testInputsPath.appending(component: "ExplicitModuleBuilds")
.appending(component: "Swift")
let cHeadersPath: AbsolutePath =
try testInputsPath.appending(component: "ExplicitModuleBuilds")
.appending(component: "CHeaders")
let casPath = path.appending(component: "cas")
let swiftInterfacePath: AbsolutePath = path.appending(component: "testExplicitModuleVerifyInterfaceJobs.swiftinterface")
let privateSwiftInterfacePath: AbsolutePath = path.appending(component: "testExplicitModuleVerifyInterfaceJobs.private.swiftinterface")
let sdkArgumentsForTesting = (try? Driver.sdkArgumentsForTesting()) ?? []
var driver = try Driver(args: ["swiftc",
"-target", "x86_64-apple-macosx11.0",
"-I", cHeadersPath.nativePathString(escaped: true),
"-I", swiftModuleInterfacesPath.nativePathString(escaped: true),
"-emit-module-interface-path", swiftInterfacePath.nativePathString(escaped: true),
"-emit-private-module-interface-path", privateSwiftInterfacePath.nativePathString(escaped: true),
"-explicit-module-build", "-verify-emitted-module-interface",
"-enable-library-evolution",
"-cache-compile-job", "-cas-path", casPath.nativePathString(escaped: true),
main.nativePathString(escaped: true)] + sdkArgumentsForTesting)
guard driver.supportExplicitModuleVerifyInterface() else {
throw XCTSkip("-typecheck-module-from-interface doesn't support explicit build.")
}
let jobs = try driver.planBuild()
// Figure out which Triples to use.
let dependencyGraph = try driver.gatherModuleDependencies()
let mainModuleInfo = try dependencyGraph.moduleInfo(of: .swift("testExplicitModuleVerifyInterfaceJobs"))
guard case .swift(_) = mainModuleInfo.details else {
XCTFail("Main module does not have Swift details field")
return
}
for job in jobs {
if (job.outputs.count == 0) {
// This is the verify module job as it should be the only job scheduled to have no output.
XCTAssertTrue(job.kind == .verifyModuleInterface)
// Check the explicit module flags exists.
XCTAssertTrue(job.commandLine.contains(.flag(String("-explicit-interface-module-build"))))
XCTAssertTrue(job.commandLine.contains(.flag(String("-explicit-swift-module-map-file"))))
XCTAssertTrue(job.commandLine.contains(.flag(String("-disable-implicit-swift-modules"))))
XCTAssertTrue(job.commandLine.contains(.flag(String("-input-file-key"))))
continue
}
let outputFilePath = job.outputs[0].file
// Swift dependencies
if outputFilePath.extension != nil,
outputFilePath.extension! == FileType.swiftModule.rawValue {
if pathMatchesSwiftModule(path: outputFilePath, "A") {
try checkCachingBuildJob(job: job, moduleId: .swift("A"),
dependencyGraph: dependencyGraph)
} else if pathMatchesSwiftModule(path: outputFilePath, "E") {
try checkCachingBuildJob(job: job, moduleId: .swift("E"),
dependencyGraph: dependencyGraph)
} else if pathMatchesSwiftModule(path: outputFilePath, "G") {
try checkCachingBuildJob(job: job, moduleId: .swift("G"),
dependencyGraph: dependencyGraph)
} else if pathMatchesSwiftModule(path: outputFilePath, "Swift") {
try checkCachingBuildJob(job: job, moduleId: .swift("Swift"),
dependencyGraph: dependencyGraph)
} else if pathMatchesSwiftModule(path: outputFilePath, "_Concurrency") {
try checkCachingBuildJob(job: job, moduleId: .swift("_Concurrency"),
dependencyGraph: dependencyGraph)
} else if pathMatchesSwiftModule(path: outputFilePath, "_StringProcessing") {
try checkCachingBuildJob(job: job, moduleId: .swift("_StringProcessing"),
dependencyGraph: dependencyGraph)
} else if pathMatchesSwiftModule(path: outputFilePath, "SwiftOnoneSupport") {
try checkCachingBuildJob(job: job, moduleId: .swift("SwiftOnoneSupport"),
dependencyGraph: dependencyGraph)
}
// Clang Dependencies
} else if let outputExtension = outputFilePath.extension,
outputExtension == FileType.pcm.rawValue {
let relativeOutputPathFileName = outputFilePath.basename
if relativeOutputPathFileName.starts(with: "A-") {
try checkCachingBuildJob(job: job, moduleId: .clang("A"),
dependencyGraph: dependencyGraph)
}
else if relativeOutputPathFileName.starts(with: "B-") {
try checkCachingBuildJob(job: job, moduleId: .clang("B"),
dependencyGraph: dependencyGraph)
}
else if relativeOutputPathFileName.starts(with: "C-") {
try checkCachingBuildJob(job: job, moduleId: .clang("C"),
dependencyGraph: dependencyGraph)
}
else if relativeOutputPathFileName.starts(with: "G-") {
try checkCachingBuildJob(job: job, moduleId: .clang("G"),
dependencyGraph: dependencyGraph)
}
else if relativeOutputPathFileName.starts(with: "F-") {
try checkCachingBuildJob(job: job, moduleId: .clang("F"),
dependencyGraph: dependencyGraph)
}
else if relativeOutputPathFileName.starts(with: "SwiftShims-") {
try checkCachingBuildJob(job: job, moduleId: .clang("SwiftShims"),
dependencyGraph: dependencyGraph)
}
else if relativeOutputPathFileName.starts(with: "_SwiftConcurrencyShims-") {
try checkCachingBuildJob(job: job, moduleId: .clang("_SwiftConcurrencyShims"),
dependencyGraph: dependencyGraph)
}
else {
XCTFail("Unexpected module dependency build job output: \(outputFilePath)")
}
} else {
switch (outputFilePath) {
case .relative(try RelativePath(validating: "testExplicitModuleVerifyInterfaceJobs")):
XCTAssertTrue(driver.isExplicitMainModuleJob(job: job))
XCTAssertEqual(job.kind, .link)
case .temporary(_):
let baseName = "testExplicitModuleVerifyInterfaceJobs"
XCTAssertTrue(matchTemporary(outputFilePath, basename: baseName, fileExtension: "o") ||
matchTemporary(outputFilePath, basename: baseName, fileExtension: "autolink"))
default:
XCTFail("Unexpected module dependency build job output: \(outputFilePath)")
}
}
}
}
}
func testCacheBuildEndToEndBuild() throws {
try withTemporaryDirectory { path in
try localFileSystem.changeCurrentWorkingDirectory(to: path)
let moduleCachePath = path.appending(component: "ModuleCache")
let casPath = path.appending(component: "cas")
try localFileSystem.createDirectory(moduleCachePath)
let main = path.appending(component: "testCachingBuild.swift")
try localFileSystem.writeFileContents(main) {
$0.send("import C;import E;import G;")
}
let cHeadersPath: AbsolutePath =
try testInputsPath.appending(component: "ExplicitModuleBuilds")
.appending(component: "CHeaders")
let swiftModuleInterfacesPath: AbsolutePath =
try testInputsPath.appending(component: "ExplicitModuleBuilds")
.appending(component: "Swift")
let sdkArgumentsForTesting = (try? Driver.sdkArgumentsForTesting()) ?? []
var driver = try Driver(args: ["swiftc",
"-I", cHeadersPath.nativePathString(escaped: true),
"-I", swiftModuleInterfacesPath.nativePathString(escaped: true),
"-explicit-module-build", "-v", "-Rcache-compile-job",
"-module-cache-path", moduleCachePath.nativePathString(escaped: true),
"-cache-compile-job", "-cas-path", casPath.nativePathString(escaped: true),
"-working-directory", path.nativePathString(escaped: true),
main.nativePathString(escaped: true)] + sdkArgumentsForTesting,
env: ProcessEnv.vars,
interModuleDependencyOracle: dependencyOracle)
let jobs = try driver.planBuild()
try driver.run(jobs: jobs)
XCTAssertFalse(driver.diagnosticEngine.hasErrors)
let scanLibPath = try XCTUnwrap(driver.getSwiftScanLibPath())
try dependencyOracle.verifyOrCreateScannerInstance(fileSystem: localFileSystem,
swiftScanLibPath: scanLibPath)
let cas = try dependencyOracle.getOrCreateCAS(pluginPath: nil, onDiskPath: casPath, pluginOptions: [])
if let driverCAS = driver.cas {
XCTAssertEqual(cas, driverCAS, "CAS should only be created once")
} else {
XCTFail("Cached compilation doesn't have a CAS")
}
try checkCASForResults(jobs: jobs, cas: cas, fs: driver.fileSystem)
}
}
func testCacheBuildEndToEndWithBinaryHeaderDeps() throws {
try withTemporaryDirectory { path in
try localFileSystem.changeCurrentWorkingDirectory(to: path)
let moduleCachePath = path.appending(component: "ModuleCache")
try localFileSystem.createDirectory(moduleCachePath)
let PCHPath = path.appending(component: "PCH")
try localFileSystem.createDirectory(PCHPath)
let FooInstallPath = path.appending(component: "Foo")
try localFileSystem.createDirectory(FooInstallPath)
let foo = path.appending(component: "foo.swift")
let casPath = path.appending(component: "cas")
try localFileSystem.writeFileContents(foo) {
$0.send("extension Profiler {")
$0.send(" public static let count: Int = 42")
$0.send("}")
}
let fooHeader = path.appending(component: "foo.h")
try localFileSystem.writeFileContents(fooHeader) {
$0.send("struct Profiler { void* ptr; };")
}
let main = path.appending(component: "main.swift")
try localFileSystem.writeFileContents(main) {
$0.send("import Foo")
}
let sdkArgumentsForTesting = (try? Driver.sdkArgumentsForTesting()) ?? []
var fooBuildDriver = try Driver(args: ["swiftc",
"-explicit-module-build",
"-module-cache-path", moduleCachePath.nativePathString(escaped: true),
"-cache-compile-job", "-cas-path", casPath.nativePathString(escaped: true),
"-working-directory", path.nativePathString(escaped: true),
foo.nativePathString(escaped: true),
"-emit-module", "-wmo", "-module-name", "Foo",
"-emit-module-path", FooInstallPath.nativePathString(escaped: true),
"-import-objc-header", fooHeader.nativePathString(escaped: true),
"-pch-output-dir", PCHPath.nativePathString(escaped: true),
FooInstallPath.appending(component: "Foo.swiftmodule").nativePathString(escaped: true)]
+ sdkArgumentsForTesting,
env: ProcessEnv.vars,
interModuleDependencyOracle: dependencyOracle)
let scanLibPath = try XCTUnwrap(fooBuildDriver.getSwiftScanLibPath())
try dependencyOracle.verifyOrCreateScannerInstance(fileSystem: localFileSystem,
swiftScanLibPath: scanLibPath)
guard try dependencyOracle.supportsBinaryModuleHeaderDependencies() else {
throw XCTSkip("libSwiftScan does not support binary module header dependencies.")
}
let fooJobs = try fooBuildDriver.planBuild()
try fooBuildDriver.run(jobs: fooJobs)
XCTAssertFalse(fooBuildDriver.diagnosticEngine.hasErrors)
let cas = try dependencyOracle.getOrCreateCAS(pluginPath: nil, onDiskPath: casPath, pluginOptions: [])
if let driverCAS = fooBuildDriver.cas {
XCTAssertEqual(cas, driverCAS, "CAS should only be created once")
} else {
XCTFail("Cached compilation doesn't have a CAS")
}
try checkCASForResults(jobs: fooJobs, cas: cas, fs: fooBuildDriver.fileSystem)
var driver = try Driver(args: ["swiftc",
"-I", FooInstallPath.nativePathString(escaped: true),
"-explicit-module-build", "-emit-module", "-emit-module-path",
path.appending(component: "testEMBETEWBHD.swiftmodule").nativePathString(escaped: true),
"-module-cache-path", moduleCachePath.nativePathString(escaped: true),
"-cache-compile-job", "-cas-path", casPath.nativePathString(escaped: true),
"-working-directory", path.nativePathString(escaped: true),
main.nativePathString(escaped: true)] + sdkArgumentsForTesting,
env: ProcessEnv.vars,
interModuleDependencyOracle: dependencyOracle)
// This is currently not supported.
XCTAssertThrowsError(try driver.planBuild()) {
XCTAssertEqual($0 as? DependencyScanningError, .unsupportedConfigurationForCaching("module Foo has bridging header dependency"))
}
}
}
func testDependencyScanning() throws {
// Create a simple test case.
try withTemporaryDirectory { path in
let main = path.appending(component: "testDependencyScanning.swift")
try localFileSystem.writeFileContents(main) {
$0.send("import C;import E;import G;")
}
let vfsoverlay = path.appending(component: "overlay.yaml")
try localFileSystem.writeFileContents(vfsoverlay) {
$0.send("{\"case-sensitive\":\"false\",\"roots\":[],\"version\":0}")
}
let cHeadersPath: AbsolutePath =
try testInputsPath.appending(component: "ExplicitModuleBuilds")
.appending(component: "CHeaders")
let swiftModuleInterfacesPath: AbsolutePath =
try testInputsPath.appending(component: "ExplicitModuleBuilds")
.appending(component: "Swift")
let casPath = path.appending(component: "cas")
let sdkArgumentsForTesting = (try? Driver.sdkArgumentsForTesting()) ?? []
var driver = try Driver(args: ["swiftc",
"-I", cHeadersPath.nativePathString(escaped: true),
"-I", swiftModuleInterfacesPath.nativePathString(escaped: true),
"/tmp/Foo.o",
"-explicit-module-build",
"-cache-compile-job", "-cas-path", casPath.nativePathString(escaped: true),
"-working-directory", path.nativePathString(escaped: true),
"-Xcc", "-ivfsoverlay", "-Xcc", vfsoverlay.nativePathString(escaped: true),
"-disable-clang-target",
main.nativePathString(escaped: true)] + sdkArgumentsForTesting,
env: ProcessEnv.vars,
interModuleDependencyOracle: dependencyOracle)
let scanLibPath = try XCTUnwrap(driver.getSwiftScanLibPath())
try dependencyOracle.verifyOrCreateScannerInstance(fileSystem: localFileSystem,
swiftScanLibPath: scanLibPath)
let resolver = try ArgsResolver(fileSystem: localFileSystem)
var scannerCommand = try driver.dependencyScannerInvocationCommand().1.map { try resolver.resolve($0) }
// We generate full swiftc -frontend -scan-dependencies invocations in order to also be
// able to launch them as standalone jobs. Frontend's argument parser won't recognize
// -frontend when passed directly via libSwiftScan.
if scannerCommand.first == "-frontend" {
scannerCommand.removeFirst()
}
// Ensure we do not propagate the usual PCH-handling arguments to the scanner invocation
XCTAssertFalse(scannerCommand.contains("-pch-output-dir"))
XCTAssertFalse(scannerCommand.contains("Foo.o"))
// Xcc commands are used for scanner command.
XCTAssertTrue(scannerCommand.contains("-Xcc"))
XCTAssertTrue(scannerCommand.contains("-ivfsoverlay"))
// Here purely to dump diagnostic output in a reasonable fashion when things go wrong.
let lock = NSLock()
// Module `X` is only imported on Darwin when:
// #if __ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__ < 110000
let expectedNumberOfDependencies: Int
if driver.hostTriple.isMacOSX,
driver.hostTriple.version(for: .macOS) >= Triple.Version(11, 0, 0) {
expectedNumberOfDependencies = 11
} else if driver.targetTriple.isWindows {
expectedNumberOfDependencies = 14
} else {
expectedNumberOfDependencies = 12
}
// Dispatch several iterations in parallel
DispatchQueue.concurrentPerform(iterations: 20) { index in
// Give the main modules different names
let iterationCommand = scannerCommand + ["-module-name",
"testDependencyScanning\(index)",
// FIXME: We need to differentiate the scanning action hash,
// though the module-name above should be sufficient.
"-I/tmp/foo/bar/\(index)"]
do {
var scanDiagnostics: [ScannerDiagnosticPayload] = []
let dependencyGraph =
try dependencyOracle.getDependencies(workingDirectory: path,
commandLine: iterationCommand,
diagnostics: &scanDiagnostics)
// The _Concurrency and _StringProcessing modules are automatically
// imported in newer versions of the Swift compiler. If they happened to
// be provided, adjust our expectations accordingly.
let hasConcurrencyModule = dependencyGraph.modules.keys.contains {
$0.moduleName == "_Concurrency"
}
let hasConcurrencyShimsModule = dependencyGraph.modules.keys.contains {
$0.moduleName == "_SwiftConcurrencyShims"
}
let hasStringProcessingModule = dependencyGraph.modules.keys.contains {
$0.moduleName == "_StringProcessing"
}
let adjustedExpectedNumberOfDependencies =
expectedNumberOfDependencies +
(hasConcurrencyModule ? 1 : 0) +
(hasConcurrencyShimsModule ? 1 : 0) +
(hasStringProcessingModule ? 1 : 0)
if (dependencyGraph.modules.count != adjustedExpectedNumberOfDependencies) {
lock.lock()
print("Unexpected Dependency Scanning Result (\(dependencyGraph.modules.count) modules):")
dependencyGraph.modules.forEach {
print($0.key.moduleName)
}
lock.unlock()
}
XCTAssertTrue(dependencyGraph.modules.count ==
adjustedExpectedNumberOfDependencies)
} catch {
XCTFail("Unexpected error: \(error)")
}
}
// Change CAS path is an error.
let casPath2 = path.appending(component: "cas2")
let command = scannerCommand + ["-module-name",
"testDependencyScanningBad",
// FIXME: We need to differentiate the scanning action hash,
// though the module-name above should be sufficient.
"-I/tmp/bad",
"-cas-path", casPath2.nativePathString(escaped: true),
]
var scanDiagnostics: [ScannerDiagnosticPayload] = []
do {
let _ = try dependencyOracle.getDependencies(workingDirectory: path,
commandLine: command,
diagnostics: &scanDiagnostics)
} catch let error {
XCTAssertTrue(error is DependencyScanningError)
}
let testDiagnostics: [ScannerDiagnosticPayload]
if try dependencyOracle.supportsPerScanDiagnostics(),
!scanDiagnostics.isEmpty {
testDiagnostics = scanDiagnostics
print("Using Per-Scan diagnostics")
} else {
testDiagnostics = try XCTUnwrap(dependencyOracle.getScannerDiagnostics())
print("Using Scanner-Global diagnostics")
}
XCTAssertEqual(testDiagnostics.count, 1)
XCTAssertEqual(testDiagnostics[0].severity, .error)
XCTAssertEqual(testDiagnostics[0].message, "CAS error encountered: conflicting CAS options used in scanning service")
}
}
func testDependencyScanningPathRemap() throws {
// Create a simple test case.
try withTemporaryDirectory { path in
let main = path.appending(component: "testDependencyScanning.swift")
try localFileSystem.writeFileContents(main) {
$0.send("import C;")
$0.send("import E;")
$0.send("import G;")
}
let cHeadersPath: AbsolutePath =
try testInputsPath.appending(component: "ExplicitModuleBuilds")
.appending(component: "CHeaders")
let swiftModuleInterfacesPath: AbsolutePath =
try testInputsPath.appending(component: "ExplicitModuleBuilds")
.appending(component: "Swift")
let casPath = path.appending(component: "cas")
let sdkArgumentsForTesting = (try? Driver.sdkArgumentsForTesting()) ?? []
var driver = try Driver(args: ["swiftc",
"-I", cHeadersPath.nativePathString(escaped: true),
"-I", swiftModuleInterfacesPath.nativePathString(escaped: true),
"/tmp/Foo.o", "-v", "-g",
"-explicit-module-build",
"-cache-compile-job", "-cas-path", casPath.nativePathString(escaped: true),
"-working-directory", path.nativePathString(escaped: true),
"-disable-clang-target", "-scanner-prefix-map-sdk", "/^sdk",
"-scanner-prefix-map-toolchain", "/^toolchain",
"-scanner-prefix-map", testInputsPath.description + "=/^src",
"-scanner-prefix-map", path.description + "=/^tmp",
main.nativePathString(escaped: true)] + sdkArgumentsForTesting,
env: ProcessEnv.vars,
interModuleDependencyOracle: dependencyOracle)
guard driver.isFrontendArgSupported(.scannerPrefixMap) else {
throw XCTSkip("frontend doesn't support prefix map")
}
let scanLibPath = try XCTUnwrap(driver.getSwiftScanLibPath())
try dependencyOracle.verifyOrCreateScannerInstance(fileSystem: localFileSystem,
swiftScanLibPath: scanLibPath)
let resolver = try ArgsResolver(fileSystem: localFileSystem)
let scannerCommand = try driver.dependencyScannerInvocationCommand().1.map { try resolver.resolve($0) }
XCTAssertTrue(scannerCommand.contains("-scanner-prefix-map"))
XCTAssertTrue(scannerCommand.contains(try testInputsPath.description + "=/^src"))
let jobs = try driver.planBuild()
for job in jobs {
if !job.kind.supportCaching {
continue
}
let command = try job.commandLine.map { try resolver.resolve($0) }
// Check all the arguments that are in the temporary directory are remapped.
// The only one that is not remapped should be the `-cas-path` that points to
// `casPath`.
XCTAssertFalse(command.contains {
return $0.starts(with: path.description) && $0 != casPath.description
})
}
}
}
func testCacheIncrementalBuildPlan() throws {
try withTemporaryDirectory { path in
try localFileSystem.changeCurrentWorkingDirectory(to: path)
let moduleCachePath = path.appending(component: "ModuleCache")
let casPath = path.appending(component: "cas")
try localFileSystem.createDirectory(moduleCachePath)
let main = path.appending(component: "testCachingBuild.swift")
let mainFileContent = "import C;import E;import G;"
try localFileSystem.writeFileContents(main) {
$0.send(mainFileContent)
}
let ofm = path.appending(component: "ofm.json")
let inputPathsAndContents: [(AbsolutePath, String)] = [(main, mainFileContent)]
OutputFileMapCreator.write(
module: "Test", inputPaths: inputPathsAndContents.map {$0.0},
derivedData: path, to: ofm, excludeMainEntry: false)
let cHeadersPath: AbsolutePath =
try testInputsPath.appending(component: "ExplicitModuleBuilds")
.appending(component: "CHeaders")
let swiftModuleInterfacesPath: AbsolutePath =
try testInputsPath.appending(component: "ExplicitModuleBuilds")
.appending(component: "Swift")
let sdkArgumentsForTesting = (try? Driver.sdkArgumentsForTesting()) ?? []
let bridgingHeaderpath: AbsolutePath =
cHeadersPath.appending(component: "Bridging.h")
var driver = try Driver(args: ["swiftc",
"-I", cHeadersPath.nativePathString(escaped: true),
"-I", swiftModuleInterfacesPath.nativePathString(escaped: true),
"-explicit-module-build", "-v", "-Rcache-compile-job", "-incremental",
"-module-cache-path", moduleCachePath.nativePathString(escaped: true),
"-cache-compile-job", "-cas-path", casPath.nativePathString(escaped: true),
"-import-objc-header", bridgingHeaderpath.nativePathString(escaped: true),
"-output-file-map", ofm.nativePathString(escaped: true),
"-working-directory", path.nativePathString(escaped: true),
main.nativePathString(escaped: true)] + sdkArgumentsForTesting,
env: ProcessEnv.vars,
interModuleDependencyOracle: dependencyOracle)
let jobs = try driver.planBuild()
try driver.run(jobs: jobs)
XCTAssertFalse(driver.diagnosticEngine.hasErrors)
let scanLibPath = try XCTUnwrap(driver.getSwiftScanLibPath())
try dependencyOracle.verifyOrCreateScannerInstance(fileSystem: localFileSystem,
swiftScanLibPath: scanLibPath)
let cas = try dependencyOracle.getOrCreateCAS(pluginPath: nil, onDiskPath: casPath, pluginOptions: [])
if let driverCAS = driver.cas {
XCTAssertEqual(cas, driverCAS, "CAS should only be created once")
} else {
XCTFail("Cached compilation doesn't have a CAS")
}
try checkCASForResults(jobs: jobs, cas: cas, fs: driver.fileSystem)
// try replan the job and make sure some key command-line options are generated.
let rebuildJobs = try driver.planBuild()
for job in rebuildJobs {
if job.kind == .compile || job.kind == .emitModule {
XCTAssertTrue(job.commandLine.contains(.flag(String("-disable-implicit-swift-modules"))))
XCTAssertTrue(job.commandLine.contains(.flag(String("-cache-compile-job"))))
XCTAssertTrue(job.commandLine.contains(.flag(String("-cas-path"))))
XCTAssertTrue(job.commandLine.contains(.flag(String("-bridging-header-pch-key"))))
}
}
}
}
func testCASManagement() throws {
try withTemporaryDirectory { path in
let casPath = path.appending(component: "cas")
let driver = try Driver(args: ["swiftc", "-v"])
let scanLibPath = try XCTUnwrap(driver.getSwiftScanLibPath())
try dependencyOracle.verifyOrCreateScannerInstance(fileSystem: localFileSystem,
swiftScanLibPath: scanLibPath)
let cas = try dependencyOracle.getOrCreateCAS(pluginPath: nil, onDiskPath: casPath, pluginOptions: [])
guard cas.supportsSizeManagement else {
throw XCTSkip("CAS size management is not supported")
}
let preSize = try XCTUnwrap(try cas.getStorageSize())
let dataToStore = Data(count: 1000)
_ = try cas.store(data: dataToStore)
let postSize = try XCTUnwrap(try cas.getStorageSize())
XCTAssertTrue(postSize > preSize)
// Try prune.
try cas.setSizeLimit(100)
try cas.prune()
}
}
}
|
