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
|
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2023 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 Swift project authors
//
#if canImport(XCTest)
import XCTest
@testable @_spi(ForToolsIntegrationOnly) import Testing
final class KnownIssueTests: XCTestCase {
func testIssueIsKnownPropertyIsSetCorrectly() async {
struct MyError: Error {}
let issueRecorded = expectation(description: "Issue recorded")
var configuration = Configuration()
configuration.eventHandler = { event, _ in
guard case let .issueRecorded(issue) = event.kind else {
return
}
issueRecorded.fulfill()
XCTAssertTrue(issue.isKnown)
}
await Test {
withKnownIssue {
throw MyError()
}
}.run(configuration: configuration)
await fulfillment(of: [issueRecorded], timeout: 0.0)
}
func testKnownIssueWithComment() async {
let issueRecorded = expectation(description: "Issue recorded")
var configuration = Configuration()
configuration.eventHandler = { event, _ in
guard case let .issueRecorded(issue) = event.kind else {
return
}
issueRecorded.fulfill()
guard case .knownIssueNotRecorded = issue.kind else {
return
}
XCTAssertEqual(issue.comments.first, "With Known Issue Comment")
XCTAssertFalse(issue.isKnown)
}
await Test {
withKnownIssue("With Known Issue Comment") { }
}.run(configuration: configuration)
await fulfillment(of: [issueRecorded], timeout: 0.0)
}
func testIssueIsKnownPropertyIsSetCorrectlyWithCustomIssueMatcher() async {
struct MyError: Error {}
let issueRecorded = expectation(description: "Issue recorded")
var configuration = Configuration()
configuration.eventHandler = { event, _ in
guard case let .issueRecorded(issue) = event.kind else {
return
}
issueRecorded.fulfill()
XCTAssertTrue(issue.isKnown)
}
await Test {
try! withKnownIssue {
throw MyError()
} matching: { issue in
issue.error is MyError
}
}.run(configuration: configuration)
await fulfillment(of: [issueRecorded], timeout: 0.0)
}
func testUnexpectedErrorRecordsTwoIssues() async {
// If an error is thrown that doesn't match with the issue matcher, then
// that's one issue; a second issue is that the *known* issue never
// happened.
struct MyExpectedError: Error {}
struct MyUnexpectedError: Error {}
let issueRecorded = expectation(description: "Issue recorded")
issueRecorded.expectedFulfillmentCount = 2
let errorRecorded = expectation(description: "Error recorded")
let knownIssueNotRecorded = expectation(description: "Known issue not recorded")
var configuration = Configuration()
configuration.eventHandler = { event, _ in
guard case let .issueRecorded(issue) = event.kind else {
return
}
issueRecorded.fulfill()
XCTAssertFalse(issue.isKnown)
if case .knownIssueNotRecorded = issue.kind {
knownIssueNotRecorded.fulfill()
} else if issue.error != nil {
errorRecorded.fulfill()
}
}
await Test {
try withKnownIssue {
throw MyUnexpectedError()
} matching: { issue in
return issue.error is MyExpectedError
}
}.run(configuration: configuration)
await fulfillment(of: [issueRecorded, errorRecorded, knownIssueNotRecorded], timeout: 0.0)
}
func testKnownIssueWithExpectCall() async {
let issueRecorded = expectation(description: "Issue recorded")
var configuration = Configuration()
configuration.eventHandler = { event, _ in
guard case let .issueRecorded(issue) = event.kind,
case .expectationFailed = issue.kind else {
return
}
issueRecorded.fulfill()
XCTAssertTrue(issue.isKnown)
}
await Test {
withKnownIssue {
#expect(Bool(false))
} matching: { issue in
if case .expectationFailed = issue.kind {
return true
}
return false
}
}.run(configuration: configuration)
await fulfillment(of: [issueRecorded], timeout: 0.0)
}
func testKnownIssueWithExpectCallAndCondition() async {
let issueRecorded = expectation(description: "Issue recorded")
var configuration = Configuration()
configuration.eventHandler = { event, _ in
guard case let .issueRecorded(issue) = event.kind,
case .expectationFailed = issue.kind else {
return
}
issueRecorded.fulfill()
XCTAssertTrue(issue.isKnown)
}
await Test {
withKnownIssue {
#expect(Bool(false))
} when: {
true
}
}.run(configuration: configuration)
await fulfillment(of: [issueRecorded], timeout: 0.0)
}
func testAsyncKnownIssueWithExpectCall() async {
struct MyError: Error {}
let issueRecorded = expectation(description: "Issue recorded")
issueRecorded.expectedFulfillmentCount = 2
var configuration = Configuration()
configuration.eventHandler = { event, _ in
guard case let .issueRecorded(issue) = event.kind else {
return
}
issueRecorded.fulfill()
XCTAssertTrue(issue.isKnown)
}
await Test {
await withKnownIssue { () async throws in
#expect(Bool(false))
throw MyError()
}
}.run(configuration: configuration)
await fulfillment(of: [issueRecorded], timeout: 0.0)
}
func testAsyncKnownIssueWithExpectCallAndCondition() async {
struct MyError: Error {}
let issueRecorded = expectation(description: "Issue recorded")
issueRecorded.expectedFulfillmentCount = 2
var configuration = Configuration()
configuration.eventHandler = { event, _ in
guard case let .issueRecorded(issue) = event.kind else {
return
}
issueRecorded.fulfill()
XCTAssertTrue(issue.isKnown)
}
await Test {
try await withKnownIssue { () async throws in
#expect(Bool(false))
throw MyError()
} when: {
true
}
}.run(configuration: configuration)
await fulfillment(of: [issueRecorded], timeout: 0.0)
}
#if !SWT_NO_UNSTRUCTURED_TASKS
func testKnownIssueOnDetachedTask() async {
let issueRecorded = expectation(description: "Issue recorded")
var configuration = Configuration()
configuration.eventHandler = { event, _ in
guard case let .issueRecorded(issue) = event.kind else {
return
}
issueRecorded.fulfill()
XCTAssertTrue(issue.isKnown)
}
await Test {
await Task.detached {
withKnownIssue {
#expect(Bool(false))
}
}.value
}.run(configuration: configuration)
await fulfillment(of: [issueRecorded], timeout: 0.0)
}
#endif
func testKnownIssueWithFalsePrecondition() async {
let issueRecorded = expectation(description: "Issue recorded")
let issueMatcherCalled = expectation(description: "Issue matcher called")
issueMatcherCalled.isInverted = true
var configuration = Configuration()
configuration.eventHandler = { event, _ in
guard case .issueRecorded = event.kind else {
return
}
issueRecorded.fulfill()
}
await Test {
withKnownIssue {
Issue.record()
} when: {
false
} matching: { _ in
issueMatcherCalled.fulfill()
return true
}
}.run(configuration: configuration)
await fulfillment(of: [issueRecorded, issueMatcherCalled], timeout: 0.0)
}
func testAsyncKnownIssueWithFalsePrecondition() async {
struct MyError: Error {}
let issueRecorded = expectation(description: "Issue recorded")
let issueMatcherCalled = expectation(description: "Issue matcher called")
issueMatcherCalled.isInverted = true
var configuration = Configuration()
configuration.eventHandler = { event, _ in
guard case .issueRecorded = event.kind else {
return
}
issueRecorded.fulfill()
}
await Test {
await withKnownIssue { () async in
Issue.record()
} when: {
false
} matching: { _ in
issueMatcherCalled.fulfill()
return true
}
}.run(configuration: configuration)
await fulfillment(of: [issueRecorded, issueMatcherCalled], timeout: 0.0)
}
func testKnownIssueThatDoesNotAlwaysOccur() async {
struct MyError: Error {}
let issueRecorded = expectation(description: "Issue recorded")
issueRecorded.expectedFulfillmentCount = 2
let knownIssueNotRecorded = expectation(description: "Known issue not recorded")
knownIssueNotRecorded.isInverted = true
var configuration = Configuration()
configuration.eventHandler = { event, _ in
guard case let .issueRecorded(issue) = event.kind else {
return
}
if case .knownIssueNotRecorded = issue.kind {
knownIssueNotRecorded.fulfill()
} else {
issueRecorded.fulfill()
}
}
await Test {
withKnownIssue(isIntermittent: true) {}
withKnownIssue(isIntermittent: true) {
Issue.record()
throw MyError()
}
}.run(configuration: configuration)
await fulfillment(of: [issueRecorded, knownIssueNotRecorded], timeout: 0.0)
}
func testAsyncKnownIssueThatDoesNotAlwaysOccur() async {
struct MyError: Error {}
let issueRecorded = expectation(description: "Issue recorded")
issueRecorded.expectedFulfillmentCount = 2
let knownIssueNotRecorded = expectation(description: "Known issue not recorded")
knownIssueNotRecorded.isInverted = true
var configuration = Configuration()
configuration.eventHandler = { event, _ in
guard case let .issueRecorded(issue) = event.kind else {
return
}
if case .knownIssueNotRecorded = issue.kind {
knownIssueNotRecorded.fulfill()
} else {
issueRecorded.fulfill()
}
}
await Test {
await withKnownIssue(isIntermittent: true) { () async in
}
await withKnownIssue(isIntermittent: true) { () async throws in
Issue.record()
throw MyError()
}
}.run(configuration: configuration)
await fulfillment(of: [issueRecorded, knownIssueNotRecorded], timeout: 0.0)
}
@MainActor
func testMainActorIsolated() async {
await Test {
await withKnownIssue(isIntermittent: true) { () async in }
}.run(configuration: .init())
}
}
#endif
|
