forked from tuist/tuist
-
Notifications
You must be signed in to change notification settings - Fork 1
/
GraphLinterTests.swift
365 lines (294 loc) · 17.2 KB
/
GraphLinterTests.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
import Basic
import Foundation
import TuistCore
import XCTest
@testable import TuistCoreTesting
@testable import TuistGenerator
final class GraphLinterTests: XCTestCase {
var subject: GraphLinter!
var fileHandler: MockFileHandler!
override func setUp() {
super.setUp()
fileHandler = try! MockFileHandler()
subject = GraphLinter(fileHandler: fileHandler)
}
func test_lint_when_carthage_frameworks_are_missing() throws {
let cache = GraphLoaderCache()
let graph = Graph.test(cache: cache)
let frameworkAPath = fileHandler.currentPath.appending(RelativePath("Carthage/Build/iOS/A.framework"))
let frameworkBPath = fileHandler.currentPath.appending(RelativePath("Carthage/Build/iOS/B.framework"))
try fileHandler.createFolder(frameworkAPath)
let frameworkA = FrameworkNode(path: frameworkAPath)
let frameworkB = FrameworkNode(path: frameworkBPath)
cache.add(precompiledNode: frameworkA)
cache.add(precompiledNode: frameworkB)
let result = subject.lint(graph: graph)
XCTAssertTrue(result.contains(LintingIssue(reason: "Framework not found at path \(frameworkBPath.pathString). The path might be wrong or Carthage dependencies not fetched", severity: .warning)))
}
func test_lint_when_frameworks_are_missing() throws {
let cache = GraphLoaderCache()
let graph = Graph.test(cache: cache)
let frameworkAPath = fileHandler.currentPath.appending(component: "A.framework")
let frameworkBPath = fileHandler.currentPath.appending(component: "B.framework")
try fileHandler.createFolder(frameworkAPath)
let frameworkA = FrameworkNode(path: frameworkAPath)
let frameworkB = FrameworkNode(path: frameworkBPath)
cache.add(precompiledNode: frameworkA)
cache.add(precompiledNode: frameworkB)
let result = subject.lint(graph: graph)
XCTAssertTrue(result.contains(LintingIssue(reason: "Framework not found at path \(frameworkBPath.pathString)", severity: .error)))
}
func test_lint_when_static_product_linked_twice() throws {
let cache = GraphLoaderCache()
let appTarget = Target.test(name: "AppTarget", dependencies: [.target(name: "staticFramework"), .target(name: "frameworkA")])
let frameworkTarget = Target.test(name: "frameworkA", dependencies: [.target(name: "staticFramework")])
let staticFrameworkTarget = Target.test(name: "staticFramework", product: .staticFramework)
let app = Project.test(path: "/tmp/app", name: "App", targets: [appTarget])
let projectFramework = Project.test(path: "/tmp/framework", name: "projectFramework", targets: [frameworkTarget])
let projectStaticFramework = Project.test(path: "/tmp/staticframework", name: "projectStaticFramework", targets: [staticFrameworkTarget])
let staticFramework = TargetNode(project: projectStaticFramework, target: staticFrameworkTarget, dependencies: [])
let framework = TargetNode(project: projectFramework, target: frameworkTarget, dependencies: [staticFramework])
let appTargetNode = TargetNode(project: app, target: appTarget, dependencies: [staticFramework, framework])
cache.add(project: app)
cache.add(targetNode: appTargetNode)
cache.add(targetNode: framework)
cache.add(targetNode: staticFramework)
let graph = Graph.test(cache: cache, entryNodes: [appTargetNode, framework, staticFramework])
let result = subject.lint(graph: graph)
XCTAssertTrue(result.contains(LintingIssue(reason: "Target staticFramework has been linked against AppTarget and frameworkA, it is a static product so may introduce unwanted side effects.", severity: .warning)))
}
func test_lint_when_staticFramework_depends_on_static_products() throws {
// Given
let appTarget = Target.test(name: "AppTarget", product: .app)
let staticFrameworkA = Target.test(name: "staticFrameworkA", product: .staticFramework)
let staticFrameworkB = Target.test(name: "staticFrameworkB", product: .staticFramework)
let staticLibrary = Target.test(name: "staticLibrary", product: .staticLibrary)
let app = Project.test(path: "/tmp/app", name: "App", targets: [appTarget])
let frameworks = Project.test(path: "/tmp/staticframework",
name: "projectStaticFramework",
targets: [staticFrameworkA, staticFrameworkB, staticLibrary])
let graph = Graph.create(dependencies: [
(project: app, target: appTarget, dependencies: [staticFrameworkA, staticFrameworkB, staticLibrary]),
(project: frameworks, target: staticFrameworkA, dependencies: [staticFrameworkB]),
(project: frameworks, target: staticFrameworkB, dependencies: [staticLibrary]),
(project: frameworks, target: staticLibrary, dependencies: []),
])
// When
let result = subject.lint(graph: graph)
// Then
XCTAssertTrue(result.isEmpty)
}
func test_lint_when_staticLibrary_depends_on_static_products() throws {
// Given
let appTarget = Target.test(name: "AppTarget", product: .app)
let staticLibraryA = Target.test(name: "staticLibraryA", product: .staticLibrary)
let staticLibraryB = Target.test(name: "staticLibraryB", product: .staticLibrary)
let staticFramework = Target.test(name: "staticFramework", product: .staticFramework)
let app = Project.test(path: "/tmp/app", name: "App", targets: [appTarget])
let frameworks = Project.test(path: "/tmp/staticframework",
name: "projectStaticFramework",
targets: [staticLibraryA, staticLibraryB, staticFramework])
let graph = Graph.create(dependencies: [
(project: app, target: appTarget, dependencies: [staticLibraryA, staticLibraryB, staticFramework]),
(project: frameworks, target: staticLibraryA, dependencies: [staticLibraryB]),
(project: frameworks, target: staticLibraryB, dependencies: [staticFramework]),
(project: frameworks, target: staticFramework, dependencies: []),
])
// When
let result = subject.lint(graph: graph)
// Then
XCTAssertTrue(result.isEmpty)
}
func test_lint_frameworkDependsOnBundle() throws {
// Given
let bundle = Target.empty(name: "bundle", product: .bundle)
let framework = Target.empty(name: "framework", product: .framework)
let graph = Graph.create(project: .empty(),
dependencies: [
(target: bundle, dependencies: []),
(target: framework, dependencies: [bundle]),
])
// When
let result = subject.lint(graph: graph)
// Then
XCTAssertTrue(result.isEmpty)
}
func test_lint_applicationDependsOnBundle() throws {
// Given
let bundle = Target.empty(name: "bundle", product: .bundle)
let application = Target.empty(name: "application", product: .app)
let graph = Graph.create(project: .empty(),
dependencies: [
(target: bundle, dependencies: []),
(target: application, dependencies: [bundle]),
])
// When
let result = subject.lint(graph: graph)
// Then
XCTAssertTrue(result.isEmpty)
}
func test_lint_testTargetsDependsOnBundle() throws {
// Given
let bundle = Target.empty(name: "bundle", product: .bundle)
let unitTests = Target.empty(name: "unitTests", product: .unitTests)
let uiTests = Target.empty(name: "uiTests", product: .unitTests)
let graph = Graph.create(project: .empty(),
dependencies: [
(target: bundle, dependencies: []),
(target: unitTests, dependencies: [bundle]),
(target: uiTests, dependencies: [bundle]),
])
// When
let result = subject.lint(graph: graph)
// Then
XCTAssertTrue(result.isEmpty)
}
func test_lint_staticTargetDependsOnBundle() throws {
// Given
let bundle = Target.empty(name: "bundle", product: .bundle)
let staticFramework = Target.empty(name: "staticFramework", product: .staticFramework)
let staticLibrary = Target.empty(name: "staticLibrary", product: .staticLibrary)
let graph = Graph.create(project: .empty(),
dependencies: [
(target: bundle, dependencies: []),
(target: staticFramework, dependencies: [bundle]),
(target: staticLibrary, dependencies: [bundle]),
])
// When
let result = subject.lint(graph: graph)
// Then
let sortedResults = result.sorted { $0.reason < $1.reason }
XCTAssertEqual(sortedResults, [
LintingIssue(reason: "Target staticFramework has a dependency with target bundle of type bundle for platform 'iOS' which is invalid or not supported yet.", severity: .error),
LintingIssue(reason: "Target staticLibrary has a dependency with target bundle of type bundle for platform 'iOS' which is invalid or not supported yet.", severity: .error),
])
}
func test_lint_staticProductsCanDependOnDynamicFrameworks() throws {
// Given
let staticFramework = Target.empty(name: "StaticFramework", product: .staticFramework)
let staticLibrary = Target.empty(name: "StaticLibrary", product: .staticLibrary)
let dynamicFramework = Target.empty(name: "DynamicFramework", product: .framework)
let graph = Graph.create(project: .empty(),
dependencies: [
(target: staticLibrary, dependencies: [dynamicFramework]),
(target: staticFramework, dependencies: [dynamicFramework]),
(target: dynamicFramework, dependencies: []),
])
// When
let result = subject.lint(graph: graph)
// Then
XCTAssertTrue(result.isEmpty)
}
func test_lint_macStaticProductsCantDependOniOSStaticProducts() throws {
// Given
let macStaticFramework = Target.empty(name: "MacStaticFramework", platform: .macOS, product: .staticFramework)
let iosStaticFramework = Target.empty(name: "iOSStaticFramework", platform: .iOS, product: .staticFramework)
let iosStaticLibrary = Target.empty(name: "iOSStaticLibrary", platform: .iOS, product: .staticLibrary)
let graph = Graph.create(project: .empty(),
dependencies: [
(target: macStaticFramework, dependencies: [iosStaticFramework, iosStaticLibrary]),
(target: iosStaticFramework, dependencies: []),
(target: iosStaticLibrary, dependencies: []),
])
// When
let result = subject.lint(graph: graph)
// Then
XCTAssertFalse(result.isEmpty)
}
func test_lint_missingProjectConfigurationsFromDependencyProjects() throws {
// Given
let customConfigurations: [BuildConfiguration: Configuration?] = [
.debug("Debug"): nil,
.debug("Testing"): nil,
.release("Beta"): nil,
.release("Release"): nil,
]
let targetA = Target.empty(name: "TargetA", product: .framework)
let projectA = Project.empty(path: "/path/to/a", name: "ProjectA", settings: Settings(configurations: customConfigurations))
let targetB = Target.empty(name: "TargetB", product: .framework)
let projectB = Project.empty(path: "/path/to/b", name: "ProjectB", settings: Settings(configurations: customConfigurations))
let targetC = Target.empty(name: "TargetC", product: .framework)
let projectC = Project.empty(path: "/path/to/c", name: "ProjectC", settings: .default)
let graph = Graph.create(projects: [projectA, projectB, projectC],
dependencies: [
(project: projectA, target: targetA, dependencies: [targetB]),
(project: projectB, target: targetB, dependencies: [targetC]),
(project: projectC, target: targetC, dependencies: []),
])
// When
let result = subject.lint(graph: graph)
// Then
XCTAssertEqual(result, [
LintingIssue(reason: "The project 'ProjectC' has missing or mismatching configurations. It has [Debug (debug), Release (release)], other projects have [Beta (release), Debug (debug), Release (release), Testing (debug)]",
severity: .warning),
])
}
func test_lint_mismatchingProjectConfigurationsFromDependencyProjects() throws {
// Given
let customConfigurations: [BuildConfiguration: Configuration?] = [
.debug("Debug"): nil,
.debug("Testing"): nil,
.release("Beta"): nil,
.release("Release"): nil,
]
let targetA = Target.empty(name: "TargetA", product: .framework)
let projectA = Project.empty(path: "/path/to/a", name: "ProjectA", settings: Settings(configurations: customConfigurations))
let targetB = Target.empty(name: "TargetB", product: .framework)
let projectB = Project.empty(path: "/path/to/b", name: "ProjectB", settings: Settings(configurations: customConfigurations))
let mismatchingConfigurations: [BuildConfiguration: Configuration?] = [
.release("Debug"): nil,
.release("Testing"): nil,
.release("Beta"): nil,
.release("Release"): nil,
]
let targetC = Target.empty(name: "TargetC", product: .framework)
let projectC = Project.empty(path: "/path/to/c", name: "ProjectC", settings: Settings(configurations: mismatchingConfigurations))
let graph = Graph.create(projects: [projectA, projectB, projectC],
entryNodes: [targetA],
dependencies: [
(project: projectA, target: targetA, dependencies: [targetB]),
(project: projectB, target: targetB, dependencies: [targetC]),
(project: projectC, target: targetC, dependencies: []),
])
// When
let result = subject.lint(graph: graph)
// Then
XCTAssertEqual(result, [
LintingIssue(reason: "The project 'ProjectC' has missing or mismatching configurations. It has [Beta (release), Debug (release), Release (release), Testing (release)], other projects have [Beta (release), Debug (debug), Release (release), Testing (debug)]",
severity: .warning),
])
}
func test_lint_doesNotFlagDependenciesWithExtraConfigurations() throws {
// Lower level dependencies could be shared by projects in different workspaces as such
// it is ok for them to contain more configurations than the entry node projects
// Given
let customConfigurations: [BuildConfiguration: Configuration?] = [
.debug("Debug"): nil,
.release("Beta"): nil,
.release("Release"): nil,
]
let targetA = Target.empty(name: "TargetA", product: .framework)
let projectA = Project.empty(path: "/path/to/a", name: "ProjectA", settings: Settings(configurations: customConfigurations))
let targetB = Target.empty(name: "TargetB", product: .framework)
let projectB = Project.empty(path: "/path/to/b", name: "ProjectB", settings: Settings(configurations: customConfigurations))
let additionalConfigurations: [BuildConfiguration: Configuration?] = [
.debug("Debug"): nil,
.debug("Testing"): nil,
.release("Beta"): nil,
.release("Release"): nil,
]
let targetC = Target.empty(name: "TargetC", product: .framework)
let projectC = Project.empty(path: "/path/to/c", name: "ProjectC", settings: Settings(configurations: additionalConfigurations))
let graph = Graph.create(projects: [projectA, projectB, projectC],
entryNodes: [targetA],
dependencies: [
(project: projectA, target: targetA, dependencies: [targetB]),
(project: projectB, target: targetB, dependencies: [targetC]),
(project: projectC, target: targetC, dependencies: []),
])
// When
let result = subject.lint(graph: graph)
// Then
XCTAssertEqual(result, [])
}
}