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
|
//===------------- MockingIncrementalCompilation.swift --------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2021 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 TSCBasic
import XCTest
// MARK: - utilities for unit testing
extension ModuleDependencyGraph {
func haveAnyNodesBeenTraversed(inMock i: Int) -> Bool {
blockingConcurrentAccessOrMutation {
let dependencySource = DependencySource(
SwiftSourceFile(mock: i),
internedStringTable)
// optimization
if let fileNode = nodeFinder.findFileInterfaceNode(forMock: dependencySource),
fileNode.isTraced {
return true
}
if let nodes = nodeFinder.findNodes(for: .known(dependencySource))?.values,
nodes.contains(where: {$0.isTraced}) {
return true
}
return false
}
}
func setUntraced() {
nodeFinder.forEachNode {
$0.setUntraced()
}
}
func ensureIsSerializable() {
var nodeIDs = Set<Node>()
nodeFinder.forEachNode { node in
nodeIDs.insert(node)
}
for key in nodeFinder.usesByDef.keys {
for use in nodeFinder.usesByDef[key, default: []] {
XCTAssertTrue(nodeIDs.contains(use), "Node ID was not registered! \(use), \(String(describing: use.fingerprint))")
}
}
}
}
extension Version {
var withAlteredMinor: Self {
Self(major, minor + 1, patch)
}
}
// MARK: - mocking
extension DependencySource {
var sourceFileProvideNameForMockDependencySource: String {
typedFile.file.name
}
var interfaceHashForMockDependencySource: String {
file.name
}
fileprivate var sourceFileProvidesNameForMocking: InternedString {
// Only when mocking are these two guaranteed to be the same
internedFileName
}
}
extension SwiftSourceFile {
init(mock i: Int) {
self.init(try! VirtualPath.intern(path: String(i) + "." + FileType.swift.rawValue))
}
}
extension SwiftSourceFile {
var mockID: Int {
Int(typedFile.file.basenameWithoutExt)!
}
}
extension ModuleDependencyGraph.NodeFinder {
func findFileInterfaceNode(
forMock dependencySource: DependencySource
) -> Graph.Node? {
let fileKey = DependencyKey(fileKeyForMockDependencySource: dependencySource)
return findNode((.known(dependencySource), fileKey))
}
}
fileprivate extension DependencyKey {
init(fileKeyForMockDependencySource dependencySource: DependencySource) {
self.init(aspect: .interface,
designator:
.sourceFileProvide(name: dependencySource.sourceFileProvidesNameForMocking)
)
}
}
extension BuildRecordInfo {
static func mock(
diagnosticEngine: DiagnosticsEngine,
outputFileMap: OutputFileMap,
compilerVersion: String
) -> Self {
self.init(
buildRecordPath: try! VirtualPath(path: "no-build-record"),
fileSystem: localFileSystem,
currentArgsHash: "",
actualSwiftVersion: compilerVersion,
timeBeforeFirstJob: .now(),
diagnosticEngine: diagnosticEngine,
compilationInputModificationDates: [:])
}
}
extension IncrementalCompilationState.IncrementalDependencyAndInputSetup {
static func mock(
options: IncrementalCompilationState.Options = [.verifyDependencyGraphAfterEveryImport],
outputFileMap: OutputFileMap,
fileSystem: FileSystem = localFileSystem,
diagnosticEngine: DiagnosticsEngine = DiagnosticsEngine()
) -> Self {
// Must set input files in order to avoid graph deserialization from culling
let inputFiles = outputFileMap.entries.keys
.filter {VirtualPath.lookup($0).extension == FileType.swift.rawValue }
.map {TypedVirtualPath(file: $0, type: .swift)}
let buildRecord = BuildRecordInfo.mock(
diagnosticEngine: diagnosticEngine,
outputFileMap: outputFileMap,
compilerVersion: "for-testing")
return Self(options, outputFileMap,
buildRecord,
nil, inputFiles, fileSystem,
diagnosticEngine)
}
}
func `is`<S: StringProtocol>(dotFileName a: S, lessThan b: S) -> Bool {
let sequenceNumbers = [a, b].map { Int($0.split(separator: ".").dropLast().last!)! }
return sequenceNumbers[0] < sequenceNumbers[1]
}
extension Collection where Element: StringProtocol {
func sortedByDotFileSequenceNumbers() -> [Element] {
sorted(by: `is`(dotFileName:lessThan:))
}
}
// MARK: - Mocking up a ModuleDependencyGraph
protocol ModuleDependencyGraphMocker {
static var mockGraphCreator: MockModuleDependencyGraphCreator {get}
}
struct MockModuleDependencyGraphCreator {
let maxIndex: Int
let info: IncrementalCompilationState.IncrementalDependencyAndInputSetup
/// maxIndex must be larger than any index used
init(maxIndex: Int) {
let outputFileMap = OutputFileMap.mock(maxIndex: maxIndex)
self.info = IncrementalCompilationState.IncrementalDependencyAndInputSetup
.mock(outputFileMap: outputFileMap)
self.maxIndex = maxIndex
}
func mockUpAGraph() -> ModuleDependencyGraph {
.createForBuildingFromSwiftDeps(info.buildRecordInfo.buildRecord([], []), info)
}
}
extension OutputFileMap {
static func mock(maxIndex: Int) -> Self {
OutputFileMap(entries: (0...maxIndex) .reduce(into: [:]) {
entries, index in
let inputHandle = SwiftSourceFile(mock: index).fileHandle
let swiftDepsHandle = SwiftSourceFile(mock: index).fileHandle
entries[inputHandle] = [.swiftDeps: swiftDepsHandle]
})
}
}
|
