-
-
Notifications
You must be signed in to change notification settings - Fork 540
/
SchemesGenerator.swift
291 lines (264 loc) · 13.6 KB
/
SchemesGenerator.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
import Basic
import Foundation
import TuistCore
import xcodeproj
/// Protocol that defines the interface of the schemes generation.
protocol SchemesGenerating {
/// Generates the schemes for the project targets.
///
/// - Parameters:
/// - project: Project manifest.
/// - generatedProject: Generated Xcode project.
/// - Throws: A FatalError if the generation of the schemes fails.
func generateTargetSchemes(project: Project,
generatedProject: GeneratedProject) throws
}
final class SchemesGenerator: SchemesGenerating {
/// Default last upgrade version for generated schemes.
private static let defaultLastUpgradeVersion = "1010"
/// Default version for generated schemes.
private static let defaultVersion = "1.3"
/// Instance to interact with the file system.
let fileHandler: FileHandling
/// Initializes the schemes generator with its attributes.
///
/// - Parameter fileHandler: File handler.
init(fileHandler: FileHandling = FileHandler()) {
self.fileHandler = fileHandler
}
/// Generates the schemes for the project targets.
///
/// - Parameters:
/// - project: Project manifest.
/// - generatedProject: Generated Xcode project.
/// - Throws: A FatalError if the generation of the schemes fails.
func generateTargetSchemes(project: Project,
generatedProject: GeneratedProject) throws {
try project.targets.forEach { target in
let pbxTarget = generatedProject.targets[target.name]!
try generateTargetScheme(target: target,
pbxTarget: pbxTarget,
projectName: generatedProject.name,
projectPath: generatedProject.path)
}
}
/// Returns the build action for the project scheme.
///
/// - Parameters:
/// - project: Project manifest.
/// - generatedProject: Generated Xcode project.
/// - graph: Dependencies graph.
/// - Returns: Scheme build action.
func projectBuildAction(project: Project,
generatedProject: GeneratedProject,
graph: Graphing) -> XCScheme.BuildAction {
let targets = project.sortedTargetsForProjectScheme(graph: graph)
let entries: [XCScheme.BuildAction.Entry] = targets.map { (target) -> XCScheme.BuildAction.Entry in
let pbxTarget = generatedProject.targets[target.name]!
let buildableReference = targetBuildableReference(target: target,
pbxTarget: pbxTarget,
projectName: generatedProject.name)
var buildFor: [XCScheme.BuildAction.Entry.BuildFor] = []
if target.product.testsBundle {
buildFor.append(.testing)
} else {
buildFor.append(contentsOf: [.analyzing, .archiving, .profiling, .running, .testing])
}
return XCScheme.BuildAction.Entry(buildableReference: buildableReference,
buildFor: buildFor)
}
return XCScheme.BuildAction(buildActionEntries: entries,
parallelizeBuild: true,
buildImplicitDependencies: true)
}
/// Generates the test action for the project scheme.
///
/// - Parameters:
/// - project: Project manifest.
/// - generatedProject: Generated Xcode project.
/// - Returns: Scheme test action.
func projectTestAction(project: Project,
generatedProject: GeneratedProject) -> XCScheme.TestAction {
var testables: [XCScheme.TestableReference] = []
let testTargets = project.targets.filter { $0.product.testsBundle }
testTargets.forEach { target in
let pbxTarget = generatedProject.targets[target.name]!
let reference = targetBuildableReference(target: target,
pbxTarget: pbxTarget,
projectName: generatedProject.name)
let testable = XCScheme.TestableReference(skipped: false,
buildableReference: reference)
testables.append(testable)
}
return XCScheme.TestAction(buildConfiguration: "Debug",
macroExpansion: nil,
testables: testables)
}
/// Generates the scheme for a given target.
///
/// - Parameters:
/// - target: Target manifest.
/// - pbxTarget: Xcode native target.
/// - projectName: Project name with the .xcodeproj extension.
/// - projectPath: Path to the Xcodeproj project.
/// - Throws: An error if the generation fails.
func generateTargetScheme(target: Target,
pbxTarget: PBXNativeTarget,
projectName: String,
projectPath: AbsolutePath) throws {
let schemesDirectory = try createSchemesDirectory(projectPath: projectPath)
let schemePath = schemesDirectory.appending(component: "\(target.name).xcscheme")
let scheme = XCScheme(name: target.name,
lastUpgradeVersion: SchemesGenerator.defaultLastUpgradeVersion,
version: SchemesGenerator.defaultVersion,
buildAction: targetBuildAction(target: target,
pbxTarget: pbxTarget,
projectName: projectName),
testAction: targetTestAction(target: target,
pbxTarget: pbxTarget,
projectName: projectName),
launchAction: targetLaunchAction(target: target,
pbxTarget: pbxTarget,
projectName: projectName),
profileAction: targetProfileAction(target: target,
pbxTarget: pbxTarget,
projectName: projectName),
analyzeAction: targetAnalyzeAction(),
archiveAction: targetArchiveAction())
try scheme.write(path: schemePath.path, override: true)
}
/// Generates the scheme test action for a given target.
///
/// - Parameters:
/// - target: Target manifest.
/// - pbxTarget: Xcode native target.
/// - projectName: Project name with .xcodeproj extension.
/// - Returns: Scheme test action.
func targetTestAction(target: Target,
pbxTarget: PBXNativeTarget,
projectName: String) -> XCScheme.TestAction? {
var testables: [XCScheme.TestableReference] = []
if target.product.testsBundle {
let reference = targetBuildableReference(target: target,
pbxTarget: pbxTarget,
projectName: projectName)
let testable = XCScheme.TestableReference(skipped: false,
buildableReference: reference)
testables.append(testable)
}
return XCScheme.TestAction(buildConfiguration: "Debug",
macroExpansion: nil,
testables: testables)
}
/// Generates the scheme build action for a given target.
///
/// - Parameters:
/// - target: Target manifest.
/// - pbxTarget: Xcode native target.
/// - projectName: Project name with the .xcodeproj extension.
/// - Returns: Scheme build action.
func targetBuildAction(target: Target,
pbxTarget: PBXNativeTarget,
projectName: String) -> XCScheme.BuildAction? {
let buildFor: [XCScheme.BuildAction.Entry.BuildFor] = [
.analyzing, .archiving, .profiling, .running, .testing,
]
let buildableReference = targetBuildableReference(target: target,
pbxTarget: pbxTarget,
projectName: projectName)
var entries: [XCScheme.BuildAction.Entry] = []
entries.append(XCScheme.BuildAction.Entry(buildableReference: buildableReference, buildFor: buildFor))
return XCScheme.BuildAction(buildActionEntries: entries,
parallelizeBuild: true,
buildImplicitDependencies: true)
}
/// Generates the scheme launch action for a given target.
///
/// - Parameters:
/// - target: Target manifest.
/// - pbxTarget: Xcode native target.
/// - projectName: Project name with .xcodeproj extension.
/// - Returns: Scheme launch action.
func targetLaunchAction(target: Target,
pbxTarget: PBXNativeTarget,
projectName: String) -> XCScheme.LaunchAction? {
var buildableProductRunnable: XCScheme.BuildableProductRunnable?
var macroExpansion: XCScheme.BuildableReference?
let buildableReference = targetBuildableReference(target: target, pbxTarget: pbxTarget, projectName: projectName)
if target.product.runnable {
buildableProductRunnable = XCScheme.BuildableProductRunnable(buildableReference: buildableReference, runnableDebuggingMode: "0")
} else {
macroExpansion = buildableReference
}
let environmentVariables: [XCScheme.EnvironmentVariable] = target.environment.map { variable, value in
XCScheme.EnvironmentVariable(variable: variable, value: value, enabled: true)
}
return XCScheme.LaunchAction(buildableProductRunnable: buildableProductRunnable,
buildConfiguration: "Debug",
macroExpansion: macroExpansion,
environmentVariables: environmentVariables)
}
/// Generates the scheme profile action for a given target.
///
/// - Parameters:
/// - target: Target manifest.
/// - pbxTarget: Xcode native target.
/// - projectName: Project name with .xcodeproj extension.
/// - Returns: Scheme profile action.
func targetProfileAction(target: Target,
pbxTarget: PBXNativeTarget,
projectName: String) -> XCScheme.ProfileAction? {
var buildableProductRunnable: XCScheme.BuildableProductRunnable?
var macroExpansion: XCScheme.BuildableReference?
let buildableReference = targetBuildableReference(target: target, pbxTarget: pbxTarget, projectName: projectName)
if target.product.runnable {
buildableProductRunnable = XCScheme.BuildableProductRunnable(buildableReference: buildableReference, runnableDebuggingMode: "0")
} else {
macroExpansion = buildableReference
}
return XCScheme.ProfileAction(buildableProductRunnable: buildableProductRunnable,
buildConfiguration: "Release",
macroExpansion: macroExpansion)
}
/// Returns the scheme buildable reference for a given target.
///
/// - Parameters:
/// - target: Target manifest.
/// - pbxTarget: Xcode native target.
/// - projectName: Project name with the .xcodeproj extension.
/// - Returns: Buildable reference.
func targetBuildableReference(target: Target, pbxTarget: PBXNativeTarget, projectName: String) -> XCScheme.BuildableReference {
return XCScheme.BuildableReference(referencedContainer: "container:\(projectName)",
blueprint: pbxTarget,
buildableName: target.productName,
blueprintName: target.name,
buildableIdentifier: "primary")
}
/// Returns the scheme analyze action for a given target.
///
/// - Returns: Scheme analyze action.
func targetAnalyzeAction() -> XCScheme.AnalyzeAction {
return XCScheme.AnalyzeAction(buildConfiguration: "Debug")
}
/// Returns the scheme archive action for a given target.
///
/// - Returns: Scheme archive action.
func targetArchiveAction() -> XCScheme.ArchiveAction {
return XCScheme.ArchiveAction(buildConfiguration: "Release",
revealArchiveInOrganizer: true)
}
/// Creates the directory where the schemes are stored inside the project.
/// If the directory exists it does not re-create it.
///
/// - Parameters:
/// - projectPath: Path to the Xcode project.
/// - Returns: Path to the schemes directory.
/// - Throws: A FatalError if the creation of the directory fails.
private func createSchemesDirectory(projectPath: AbsolutePath) throws -> AbsolutePath {
let path = projectPath.appending(RelativePath("xcshareddata/xcschemes"))
if !fileHandler.exists(path) {
try fileHandler.createFolder(path)
}
return path
}
}