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
|
//
// 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
//
@testable @_spi(ForToolsIntegrationOnly) import Testing
#if SWT_TARGET_OS_APPLE && canImport(Foundation)
import Foundation
#endif
struct BacktracedError: Error {}
final class BacktracedRefCountedError: Error {}
@Suite("Backtrace Tests")
struct BacktraceTests {
@Test("Thrown error captures backtrace")
func thrownErrorCapturesBacktrace() async throws {
await confirmation("Backtrace found", expectedCount: 2) { hadBacktrace in
let testValueType = Test {
throw BacktracedError()
}
let testReferenceType = Test {
throw BacktracedRefCountedError()
}
var configuration = Configuration()
configuration.eventHandler = { event, _ in
if case let .issueRecorded(issue) = event.kind,
let backtrace = issue.sourceContext.backtrace,
!backtrace.addresses.isEmpty {
hadBacktrace()
}
}
let runner = await Runner(testing: [testValueType, testReferenceType], configuration: configuration)
await runner.run()
}
}
@available(_typedThrowsAPI, *)
@Test("Typed thrown error captures backtrace")
func typedThrownErrorCapturesBacktrace() async throws {
await confirmation("Error recorded", expectedCount: 4) { errorRecorded in
await confirmation("Backtrace found", expectedCount: 2) { hadBacktrace in
let testValueType = Test {
try Result<Never, _>.failure(BacktracedError()).get()
}
let testReferenceType = Test {
try Result<Never, _>.failure(BacktracedRefCountedError()).get()
}
let testAnyType = Test {
try Result<Never, any Error>.failure(BacktracedError()).get()
}
let testAnyObjectType = Test {
try Result<Never, any Error>.failure(BacktracedRefCountedError()).get()
}
var configuration = Configuration()
configuration.eventHandler = { event, _ in
if case let .issueRecorded(issue) = event.kind {
errorRecorded()
if let backtrace = issue.sourceContext.backtrace, !backtrace.addresses.isEmpty {
hadBacktrace()
}
}
}
let runner = await Runner(testing: [testValueType, testReferenceType, testAnyType, testAnyObjectType], configuration: configuration)
await runner.run()
}
}
}
#if SWT_TARGET_OS_APPLE && canImport(Foundation)
@available(_typedThrowsAPI, *)
@Test("Thrown NSError captures backtrace")
func thrownNSErrorCapturesBacktrace() async throws {
await confirmation("Backtrace found", expectedCount: 2) { hadBacktrace in
let testValueType = Test {
throw NSError(domain: "", code: 0, userInfo: [:])
}
let testReferenceType = Test {
try Result<Never, any Error>.failure(NSError(domain: "", code: 0, userInfo: [:])).get()
}
var configuration = Configuration()
configuration.eventHandler = { event, _ in
if case let .issueRecorded(issue) = event.kind,
let backtrace = issue.sourceContext.backtrace,
!backtrace.addresses.isEmpty {
hadBacktrace()
}
}
let runner = await Runner(testing: [testValueType, testReferenceType], configuration: configuration)
await runner.run()
}
}
@inline(never)
func throwNSError() throws {
let error = NSError(domain: "Oh no!", code: 123, userInfo: [:])
throw error
}
@inline(never)
func throwBacktracedRefCountedError() throws {
throw BacktracedRefCountedError()
}
@Test("Thrown NSError has a different backtrace than we generated", .enabled(if: Backtrace.isFoundationCaptureEnabled))
func foundationGeneratedNSError() {
do {
try throwNSError()
} catch {
let backtrace1 = Backtrace(forFirstThrowOf: error, checkFoundation: true)
let backtrace2 = Backtrace(forFirstThrowOf: error, checkFoundation: false)
#expect(backtrace1 != backtrace2)
}
// Foundation won't capture backtraces for reference-counted errors that
// don't inherit from NSError (even though the existential error box itself
// is of an NSError subclass.)
do {
try throwBacktracedRefCountedError()
} catch {
let backtrace1 = Backtrace(forFirstThrowOf: error, checkFoundation: true)
let backtrace2 = Backtrace(forFirstThrowOf: error, checkFoundation: false)
#expect(backtrace1 == backtrace2)
}
}
#endif
@Test("Backtrace.current() is populated")
func currentBacktrace() {
let backtrace = Backtrace.current()
#expect(!backtrace.addresses.isEmpty)
}
@Test("An unthrown error has no backtrace")
func noBacktraceForNewError() throws {
#expect(Backtrace(forFirstThrowOf: BacktracedError()) == nil)
}
#if canImport(Foundation)
@Test("Encoding/decoding")
func encodingAndDecoding() throws {
let original = Backtrace.current()
let copy = try JSON.encodeAndDecode(original)
#expect(original == copy)
}
#endif
#if !SWT_NO_DYNAMIC_LINKING
@Test("Symbolication", arguments: [Backtrace.SymbolicationMode.mangled, .demangled])
func symbolication(mode: Backtrace.SymbolicationMode) {
let backtrace = Backtrace.current()
let symbolNames = backtrace.symbolicate(mode)
#expect(backtrace.addresses.count == symbolNames.count)
if testsWithSignificantIOAreEnabled {
print(symbolNames.map(String.init(describingForTest:)).joined(separator: "\n"))
}
}
#endif
}
|
