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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2021 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import Basics
import func XCTest.XCTAssertTrue
import func XCTest.XCTAssertEqual
import func XCTest.XCTFail
import struct TSCBasic.StringError
import TSCTestSupport
extension ObservabilitySystem {
public static func makeForTesting(verbose: Bool = true) -> TestingObservability {
let collector = TestingObservability.Collector(verbose: verbose)
let observabilitySystem = ObservabilitySystem(collector)
return TestingObservability(collector: collector, topScope: observabilitySystem.topScope)
}
public static var NOOP: ObservabilityScope {
ObservabilitySystem { _, _ in }.topScope
}
}
public struct TestingObservability {
private let collector: Collector
public let topScope: ObservabilityScope
fileprivate init(collector: Collector, topScope: ObservabilityScope) {
self.collector = collector
self.topScope = topScope
}
public var diagnostics: [Basics.Diagnostic] {
self.collector.diagnostics.get()
}
public var errors: [Basics.Diagnostic] {
self.diagnostics.filter { $0.severity == .error }
}
public var warnings: [Basics.Diagnostic] {
self.diagnostics.filter { $0.severity == .warning }
}
public var hasErrorDiagnostics: Bool {
self.collector.hasErrors
}
public var hasWarningDiagnostics: Bool {
self.collector.hasWarnings
}
final class Collector: ObservabilityHandlerProvider, DiagnosticsHandler, CustomStringConvertible {
var diagnosticsHandler: DiagnosticsHandler { self }
let diagnostics: ThreadSafeArrayStore<Basics.Diagnostic>
private let verbose: Bool
init(verbose: Bool) {
self.verbose = verbose
self.diagnostics = .init()
}
// TODO: do something useful with scope
func handleDiagnostic(scope: ObservabilityScope, diagnostic: Basics.Diagnostic) {
if self.verbose {
print(diagnostic.description)
}
self.diagnostics.append(diagnostic)
}
var hasErrors: Bool {
self.diagnostics.get().hasErrors
}
var hasWarnings: Bool {
self.diagnostics.get().hasWarnings
}
var description: String {
let diagnostics = self.diagnostics.get()
return "\(diagnostics)"
}
}
}
public func XCTAssertNoDiagnostics(
_ diagnostics: [Basics.Diagnostic],
problemsOnly: Bool = true,
file: StaticString = #file,
line: UInt = #line
) {
let diagnostics = problemsOnly ? diagnostics.filter { $0.severity >= .warning } : diagnostics
if diagnostics.isEmpty { return }
let description = diagnostics.map { "- " + $0.description }.joined(separator: "\n")
XCTFail("Found unexpected diagnostics: \n\(description)", file: file, line: line)
}
public func testDiagnostics(
_ diagnostics: [Basics.Diagnostic],
problemsOnly: Bool = true,
file: StaticString = #file,
line: UInt = #line,
handler: (DiagnosticsTestResult) throws -> Void
) {
testDiagnostics(
diagnostics,
minSeverity: problemsOnly ? .warning : .debug,
file: file,
line: line,
handler: handler
)
}
public func testDiagnostics(
_ diagnostics: [Basics.Diagnostic],
minSeverity: Basics.Diagnostic.Severity,
file: StaticString = #file,
line: UInt = #line,
handler: (DiagnosticsTestResult) throws -> Void
) {
let diagnostics = diagnostics.filter { $0.severity >= minSeverity }
let testResult = DiagnosticsTestResult(diagnostics)
do {
try handler(testResult)
} catch {
XCTFail("error \(String(describing: error))", file: file, line: line)
}
if !testResult.uncheckedDiagnostics.isEmpty {
XCTFail("unchecked diagnostics \(testResult.uncheckedDiagnostics)", file: file, line: line)
}
}
public func testPartialDiagnostics(
_ diagnostics: [Basics.Diagnostic],
minSeverity: Basics.Diagnostic.Severity,
file: StaticString = #file,
line: UInt = #line,
handler: (DiagnosticsTestResult) throws -> Void
) {
let diagnostics = diagnostics.filter { $0.severity >= minSeverity }
let testResult = DiagnosticsTestResult(diagnostics)
do {
try handler(testResult)
} catch {
XCTFail("error \(String(describing: error))", file: file, line: line)
}
}
/// Helper to check diagnostics in the engine.
public class DiagnosticsTestResult {
fileprivate var uncheckedDiagnostics: [Basics.Diagnostic]
init(_ diagnostics: [Basics.Diagnostic]) {
self.uncheckedDiagnostics = diagnostics
}
package func checkIsEmpty(
file: StaticString = #file,
line: UInt = #line
) {
XCTAssertTrue(self.uncheckedDiagnostics.isEmpty, file: file, line: line)
}
@discardableResult
public func check(
diagnostic message: StringPattern,
severity: Basics.Diagnostic.Severity,
//metadata: ObservabilityMetadata? = .none,
file: StaticString = #file,
line: UInt = #line
) -> Basics.Diagnostic? {
guard !self.uncheckedDiagnostics.isEmpty else {
XCTFail("No diagnostics left to check", file: file, line: line)
return nil
}
let diagnostic: Basics.Diagnostic = self.uncheckedDiagnostics.removeFirst()
XCTAssertMatch(diagnostic.message, message, file: file, line: line)
XCTAssertEqual(diagnostic.severity, severity, file: file, line: line)
// FIXME: (diagnostics) compare complete metadata when legacy bridge is removed
//XCTAssertEqual(diagnostic.metadata, metadata, file: file, line: line)
//XCTAssertEqual(diagnostic.metadata?.droppingLegacyKeys(), metadata?.droppingLegacyKeys(), file: file, line: line)
return diagnostic
}
@discardableResult
public func checkUnordered(
diagnostic diagnosticPattern: StringPattern,
severity: Basics.Diagnostic.Severity,
//metadata: ObservabilityMetadata? = .none,
file: StaticString = #file,
line: UInt = #line
) -> Basics.Diagnostic? {
guard !self.uncheckedDiagnostics.isEmpty else {
XCTFail("No diagnostics left to check", file: file, line: line)
return nil
}
let matching = self.uncheckedDiagnostics.indices
.filter { diagnosticPattern ~= self.uncheckedDiagnostics[$0].message }
if matching.isEmpty {
XCTFail("No diagnostics match \(diagnosticPattern)", file: file, line: line)
return nil
} else if matching.count == 1, let index = matching.first {
let diagnostic = self.uncheckedDiagnostics[index]
XCTAssertEqual(diagnostic.severity, severity, file: file, line: line)
// FIXME: (diagnostics) compare complete metadata when legacy bridge is removed
//XCTAssertEqual(diagnostic.metadata, metadata, file: file, line: line)
//XCTAssertEqual(diagnostic.metadata?.droppingLegacyKeys(), metadata?.droppingLegacyKeys(), file: file, line: line)
self.uncheckedDiagnostics.remove(at: index)
return diagnostic
// FIXME: (diagnostics) compare complete metadata when legacy bridge is removed
} else if let index = self.uncheckedDiagnostics.firstIndex(where: { diagnostic in diagnostic.severity == severity /*&& diagnostic.metadata == metadata*/}) {
//} else if let index = self.uncheckedDiagnostics.firstIndex(where: { diagnostic in diagnostic.severity == severity && diagnostic.metadata?.droppingLegacyKeys() == metadata?.droppingLegacyKeys()}) {
let diagnostic = self.uncheckedDiagnostics[index]
self.uncheckedDiagnostics.remove(at: index)
return diagnostic
} else {
return nil
}
}
}
|
