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
|
//===----- APIDigesterTests.swift - API/ABI Digester Operation Tests ------===//
//
// 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
//
//===----------------------------------------------------------------------===//
import XCTest
import TSCBasic
@_spi(Testing) import SwiftDriver
class APIDigesterTests: XCTestCase {
func testBaselineGenerationRequiresTopLevelModule() throws {
try assertDriverDiagnostics(args: ["swiftc", "foo.swift", "-emit-digester-baseline"]) {
$1.expect(.error("generating a baseline with '-emit-digester-baseline' is only supported with '-emit-module' or '-emit-module-path"))
}
try assertDriverDiagnostics(args: ["swiftc", "foo.swift", "-emit-digester-baseline-path", "/output/path.abi.json"]) {
$1.expect(.error("generating a baseline with '-emit-digester-baseline-path' is only supported with '-emit-module' or '-emit-module-path"))
}
}
func testDigesterModeValidation() throws {
try assertDriverDiagnostics(args: ["swiftc", "foo.swift", "-emit-module", "-emit-digester-baseline", "-digester-mode", "notamode"]) {
$1.expect(.error("invalid value 'notamode' in '-digester-mode'"))
}
try assertNoDriverDiagnostics(args: "swiftc", "foo.swift", "-emit-module", "-emit-digester-baseline", "-digester-mode", "api")
try assertNoDriverDiagnostics(args: "swiftc", "foo.swift", "-emit-module", "-emit-module-interface",
"-enable-library-evolution", "-emit-digester-baseline", "-digester-mode", "abi")
}
func testABIDigesterRequirements() throws {
try assertDriverDiagnostics(args: ["swiftc", "foo.swift", "-emit-module", "-emit-module-interface",
"-emit-digester-baseline", "-digester-mode", "abi"]) {
$1.expect(.error("'-digester-mode abi' cannot be specified if '-enable-library-evolution' is not present"))
}
try assertDriverDiagnostics(args: ["swiftc", "foo.swift", "-emit-module",
"-enable-library-evolution", "-emit-digester-baseline", "-digester-mode", "abi"]) {
$1.expect(.error("'-digester-mode abi' cannot be specified if '-emit-module-interface' is not present"))
}
}
func testBaselineOutputPath() throws {
do {
var driver = try Driver(args: ["swiftc", "foo.swift", "-emit-module", "-emit-digester-baseline"])
let digesterJob = try XCTUnwrap(driver.planBuild().first { $0.kind == .generateAPIBaseline })
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-o", .path(.relative(try .init(validating: "foo.api.json")))]))
}
do {
var driver = try Driver(args: ["swiftc", "foo.swift", "-emit-module","-emit-module-interface", "-enable-library-evolution", "-emit-digester-baseline", "-digester-mode", "abi"])
let digesterJob = try XCTUnwrap(driver.planBuild().first { $0.kind == .generateABIBaseline })
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-o", .path(.relative(try .init(validating: "foo.abi.json")))]))
}
do {
var driver = try Driver(args: ["swiftc", "foo.swift", "-emit-module", "-emit-digester-baseline-path", "bar.api.json"])
let digesterJob = try XCTUnwrap(driver.planBuild().first { $0.kind == .generateAPIBaseline })
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-o", .path(.relative(try .init(validating: "bar.api.json")))]))
}
do {
var driver = try Driver(args: ["swiftc", "foo.swift", "-emit-module","-emit-module-interface", "-enable-library-evolution", "-digester-mode", "abi", "-emit-digester-baseline-path", "bar.abi.json"])
let digesterJob = try XCTUnwrap(driver.planBuild().first { $0.kind == .generateABIBaseline })
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-o", .path(.relative(try .init(validating: "bar.abi.json")))]))
}
do {
try withTemporaryDirectory { path in
let projectDirPath = path.appending(component: "Project")
try localFileSystem.createDirectory(projectDirPath)
var driver = try Driver(args: ["swiftc", "-emit-module",
path.appending(component: "foo.swift").pathString,
"-emit-digester-baseline",
"-o", path.appending(component: "foo.swiftmodule").pathString])
let digesterJob = try XCTUnwrap(driver.planBuild().first { $0.kind == .generateAPIBaseline })
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-o", .path(.absolute(projectDirPath.appending(component: "foo.api.json")))]))
}
}
do {
try withTemporaryDirectory { path in
let projectDirPath = path.appending(component: "Project")
try localFileSystem.createDirectory(projectDirPath)
var driver = try Driver(args: ["swiftc", "-emit-module",
"-emit-module-interface", "-enable-library-evolution",
path.appending(component: "foo.swift").pathString,
"-emit-digester-baseline",
"-digester-mode", "abi",
"-o", path.appending(component: "foo.swiftmodule").pathString])
let digesterJob = try XCTUnwrap(driver.planBuild().first { $0.kind == .generateABIBaseline })
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-o", .path(.absolute(projectDirPath.appending(component: "foo.abi.json")))]))
}
}
do {
try withTemporaryDirectory { path in
let ofmPath = path.appending(component: "ofm.json")
try localFileSystem.writeFileContents(ofmPath) {
$0.send("""
{
"": {
"abi-baseline-json": "/path/to/baseline.abi.json"
}
}
""")
}
var driver = try Driver(args: ["swiftc", "-wmo", "-emit-module",
"-emit-module-interface", "-enable-library-evolution",
path.appending(component: "foo.swift").pathString,
"-emit-digester-baseline",
"-digester-mode", "abi",
"-o", path.appending(component: "foo.swiftmodule").pathString,
"-output-file-map", ofmPath.pathString,
])
let digesterJob = try XCTUnwrap(driver.planBuild().first { $0.kind == .generateABIBaseline })
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-o", .path(.absolute(try .init(validating: "/path/to/baseline.abi.json")))]))
}
}
do {
try withTemporaryDirectory { path in
let ofmPath = path.appending(component: "ofm.json")
try localFileSystem.writeFileContents(ofmPath) {
$0.send("""
{
"": {
"swiftsourceinfo": "/path/to/sourceinfo"
}
}
""")
}
var driver = try Driver(args: ["swiftc", "-wmo", "-emit-module",
"-emit-module-interface", "-enable-library-evolution",
path.appending(component: "foo.swift").pathString,
"-emit-digester-baseline",
"-digester-mode", "abi",
"-o", path.appending(component: "foo.swiftmodule").pathString,
"-output-file-map", ofmPath.pathString,
])
let digesterJob = try XCTUnwrap(driver.planBuild().first { $0.kind == .generateABIBaseline })
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-o", .path(.absolute(try .init(validating: "/path/to/sourceinfo.abi.json")))]))
}
}
}
func testBaselineGenerationJobFlags() throws {
do {
var driver = try Driver(args: ["swiftc", "foo.swift", "-emit-module", "-emit-digester-baseline",
"-sdk", "/path/to/sdk", "-I", "/some/path", "-F", "framework/path"])
let digesterJob = try XCTUnwrap(driver.planBuild().first { $0.kind == .generateAPIBaseline })
XCTAssertTrue(digesterJob.commandLine.contains("-dump-sdk"))
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-module", "foo"]))
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-I", .path(.relative(try .init(validating: ".")))]))
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-sdk", .path(.absolute(try .init(validating: "/path/to/sdk")))]))
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-I", .path(.absolute(try .init(validating: "/some/path")))]))
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-F", .path(.relative(try .init(validating: "framework/path")))]))
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-o", .path(.relative(try .init(validating: "foo.api.json")))]))
XCTAssertFalse(digesterJob.commandLine.contains("-abi"))
}
do {
var driver = try Driver(args: ["swiftc", "foo.swift", "-emit-module", "-emit-module-interface",
"-enable-library-evolution", "-emit-digester-baseline",
"-digester-mode", "abi",
"-sdk", "/path/to/sdk", "-I", "/some/path", "-F", "framework/path"])
let digesterJob = try XCTUnwrap(driver.planBuild().first { $0.kind == .generateABIBaseline })
XCTAssertTrue(digesterJob.commandLine.contains("-dump-sdk"))
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-module", "foo"]))
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-I", .path(.relative(try .init(validating: ".")))]))
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-sdk", .path(.absolute(try .init(validating: "/path/to/sdk")))]))
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-I", .path(.absolute(try .init(validating: "/some/path")))]))
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-F", .path(.relative(try .init(validating: "framework/path")))]))
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-o", .path(.relative(try .init(validating: "foo.abi.json")))]))
XCTAssertTrue(digesterJob.commandLine.contains("-abi"))
}
}
func testBaselineGenerationEndToEnd() throws {
#if true
// rdar://82302797
throw XCTSkip()
#else
try withTemporaryDirectory { path in
try localFileSystem.changeCurrentWorkingDirectory(to: path)
let source = path.appending(component: "foo.swift")
try localFileSystem.writeFileContents(source) {
$0.send("""
import C
import E
import G
public struct MyStruct {}
""")
}
let packageRootPath = URL(fileURLWithPath: #file).pathComponents
.prefix(while: { $0 != "Tests" }).joined(separator: "/").dropFirst()
let testInputsPath = packageRootPath + "/TestInputs"
let cHeadersPath : String = testInputsPath + "/ExplicitModuleBuilds/CHeaders"
let swiftModuleInterfacesPath : String = testInputsPath + "/ExplicitModuleBuilds/Swift"
var driver = try Driver(args: ["swiftc",
"-I", cHeadersPath,
"-I", swiftModuleInterfacesPath,
"-working-directory", path.pathString,
source.pathString,
"-emit-module",
"-emit-digester-baseline",
],
env: ProcessEnv.vars)
let jobs = try driver.planBuild()
try driver.run(jobs: jobs)
XCTAssertFalse(driver.diagnosticEngine.hasErrors)
let baseline = try localFileSystem.readFileContents(path.appending(component: "foo.api.json"))
try baseline.withData {
let json = try JSONSerialization.jsonObject(with: $0, options: []) as? [String: Any]
XCTAssertTrue((json?["children"] as? [Any])!.count >= 1)
}
}
#endif
}
func testComparisonOptionValidation() throws {
try assertDriverDiagnostics(args: ["swiftc", "foo.swift",
"-serialize-breaking-changes-path", "/path",
"-digester-breakage-allowlist-path", "/path"]) {
$1.expect(.error("'-serialize-breaking-changes-path' cannot be specified if '-compare-to-baseline-path' is not present"))
$1.expect(.error("'-digester-breakage-allowlist-path' cannot be specified if '-compare-to-baseline-path' is not present"))
}
}
func testBaselineComparisonJobFlags() throws {
#if !os(macOS)
throw XCTSkip("Skipping: ABI descriptor is only emitted on Darwin platforms.")
#endif
do {
var driver = try Driver(args: ["swiftc", "foo.swift", "-emit-module", "-compare-to-baseline-path", "/baseline/path",
"-sdk", "/path/to/sdk", "-I", "/some/path", "-F", "framework/path",
"-digester-breakage-allowlist-path", "allowlist/path"])
let digesterJob = try XCTUnwrap(driver.planBuild().first { $0.kind == .compareAPIBaseline })
XCTAssertTrue(digesterJob.commandLine.contains("-diagnose-sdk"))
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-module", "foo"]))
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-baseline-path", .path(.absolute(try .init(validating: "/baseline/path")))]))
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-I", .path(.relative(try .init(validating: ".")))]))
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-sdk", .path(.absolute(try .init(validating: "/path/to/sdk")))]))
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-I", .path(.absolute(try .init(validating: "/some/path")))]))
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-F", .path(.relative(try .init(validating: "framework/path")))]))
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-breakage-allowlist-path",
.path(.relative(try .init(validating: "allowlist/path")))]))
XCTAssertFalse(digesterJob.commandLine.contains("-abi"))
}
do {
var driver = try Driver(args: ["swiftc", "foo.swift", "-emit-module", "-compare-to-baseline-path", "/baseline/path",
"-emit-module-interface", "-enable-library-evolution",
"-digester-mode", "abi",
"-sdk", "/path/to/sdk", "-I", "/some/path", "-F", "framework/path",
"-serialize-breaking-changes-path", "breaking-changes.dia",
"-digester-breakage-allowlist-path", "allowlist/path"])
let digesterJob = try XCTUnwrap(driver.planBuild().first { $0.kind == .compareABIBaseline })
XCTAssertTrue(digesterJob.commandLine.contains("-diagnose-sdk"))
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-input-paths", .path(.absolute(try .init(validating: "/baseline/path")))]))
XCTAssertTrue(digesterJob.commandLine.contains(subsequence: ["-breakage-allowlist-path",
.path(.relative(try .init(validating: "allowlist/path")))]))
XCTAssertTrue(digesterJob.commandLine.contains("-abi"))
XCTAssertTrue(digesterJob.commandLine.contains("-serialize-diagnostics-path"))
}
}
func testAPIComparisonEndToEnd() throws {
#if true
// rdar://82302797
throw XCTSkip()
#else
try withTemporaryDirectory { path in
try localFileSystem.changeCurrentWorkingDirectory(to: path)
let source = path.appending(component: "foo.swift")
try localFileSystem.writeFileContents(source) {
$0.send("""
public struct MyStruct {
public var a: Int
}
""")
}
var driver = try Driver(args: ["swiftc",
"-working-directory", path.pathString,
source.pathString,
"-emit-module",
"-emit-digester-baseline"
],
env: ProcessEnv.vars)
guard driver.supportedFrontendFlags.contains("disable-fail-on-error") else {
throw XCTSkip("Skipping: swift-api-digester does not support '-disable-fail-on-error'")
}
let jobs = try driver.planBuild()
try driver.run(jobs: jobs)
XCTAssertFalse(driver.diagnosticEngine.hasErrors)
try localFileSystem.writeFileContents(source) {
$0.send("""
public struct MyStruct {
public var a: Bool
}
""")
}
var driver2 = try Driver(args: ["swiftc",
"-working-directory", path.pathString,
source.pathString,
"-emit-module",
"-compare-to-baseline-path",
path.appending(component: "foo.api.json").pathString,
"-serialize-breaking-changes-path",
path.appending(component: "changes.dia").pathString
],
env: ProcessEnv.vars)
let jobs2 = try driver2.planBuild()
try driver2.run(jobs: jobs2)
XCTAssertFalse(driver2.diagnosticEngine.hasErrors)
let contents = try localFileSystem.readFileContents(path.appending(component: "changes.dia"))
let diags = try SerializedDiagnostics(bytes: contents)
XCTAssertEqual(diags.diagnostics.map(\.text), [
"API breakage: var MyStruct.a has declared type change from Swift.Int to Swift.Bool",
"API breakage: accessor MyStruct.a.Get() has return type change from Swift.Int to Swift.Bool",
"API breakage: accessor MyStruct.a.Set() has parameter 0 type change from Swift.Int to Swift.Bool"
])
}
#endif
}
func testABIComparisonEndToEnd() throws {
#if true
// rdar://82302797
throw XCTSkip()
#else
try withTemporaryDirectory { path in
try localFileSystem.changeCurrentWorkingDirectory(to: path)
let source = path.appending(component: "foo.swift")
let allowlist = path.appending(component: "allowlist.txt")
try localFileSystem.writeFileContents(source) {
$0.send("""
@frozen public struct MyStruct {
var a: Int
var b: String
var c: Int
}
""")
}
try localFileSystem.writeFileContents(allowlist) {
$0.send("ABI breakage: var MyStruct.c has declared type change from Swift.Int to Swift.String")
}
var driver = try Driver(args: ["swiftc",
"-working-directory", path.pathString,
source.pathString,
"-emit-module",
"-emit-module-interface",
"-enable-library-evolution",
"-emit-digester-baseline",
"-digester-mode", "abi"
],
env: ProcessEnv.vars)
guard driver.supportedFrontendFlags.contains("disable-fail-on-error") else {
throw XCTSkip("Skipping: swift-api-digester does not support '-disable-fail-on-error'")
}
let jobs = try driver.planBuild()
try driver.run(jobs: jobs)
XCTAssertFalse(driver.diagnosticEngine.hasErrors)
try localFileSystem.writeFileContents(source) {
$0.send("""
@frozen public struct MyStruct {
var b: String
var a: Int
var c: String
}
""")
}
var driver2 = try Driver(args: ["swiftc",
"-working-directory", path.pathString,
source.pathString,
"-emit-module",
"-emit-module-interface",
"-enable-library-evolution",
"-compare-to-baseline-path",
path.appending(component: "foo.abi.json").pathString,
"-serialize-breaking-changes-path",
path.appending(component: "changes.dia").pathString,
"-digester-breakage-allowlist-path",
allowlist.pathString,
"-digester-mode", "abi"
],
env: ProcessEnv.vars)
let jobs2 = try driver2.planBuild()
try driver2.run(jobs: jobs2)
XCTAssertFalse(driver2.diagnosticEngine.hasErrors)
let contents = try localFileSystem.readFileContents(path.appending(component: "changes.dia"))
let diags = try SerializedDiagnostics(bytes: contents)
let messages = diags.diagnostics.map(\.text)
XCTAssertTrue(messages.contains("ABI breakage: var MyStruct.a in a non-resilient type changes position from 0 to 1"))
XCTAssertTrue(messages.contains("ABI breakage: var MyStruct.b in a non-resilient type changes position from 1 to 0"))
}
#endif
}
}
|
