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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021-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
*/
import XCTest
@testable import SwiftDocC
class DiagnosticEngineTests: XCTestCase {
class TestConsumer: DiagnosticConsumer {
let expectation: XCTestExpectation
init(_ exp: XCTestExpectation) {
expectation = exp
}
func receive(_ problems: [Problem]) {
expectation.fulfill()
}
func finalize() { }
}
func testEmitDiagnostic() {
let diagnostic = Diagnostic(source: nil, severity: .error, range: nil, identifier: "org.swift.docc.test", summary: "Test diagnostic")
let problem = Problem(diagnostic: diagnostic, possibleSolutions: [])
let engine = DiagnosticEngine()
let exp = expectation(description: "Recieved diagnostic")
let consumer = TestConsumer(exp)
XCTAssertEqual(engine.problems.count, 0)
XCTAssertEqual(engine.consumers.sync { $0.count }, 0)
engine.add(consumer)
XCTAssertEqual(engine.consumers.sync { $0.count }, 1)
engine.emit(problem)
waitForExpectations(timeout: 0.5)
XCTAssertEqual(engine.problems.count, 1)
engine.remove(consumer)
XCTAssertEqual(engine.consumers.sync { $0.count }, 0)
engine.clearDiagnostics()
XCTAssertEqual(engine.problems.count, 0)
}
func testMultipleConsumers() {
let diagnostic = Diagnostic(source: nil, severity: .error, range: nil, identifier: "org.swift.docc.test", summary: "Test diagnostic")
let problem = Problem(diagnostic: diagnostic, possibleSolutions: [])
let engine = DiagnosticEngine()
let exp = expectation(description: "Recieved diagnostic")
exp.expectedFulfillmentCount = 2
let consumerA = TestConsumer(exp)
let consumerB = TestConsumer(exp)
XCTAssertEqual(engine.problems.count, 0)
XCTAssertEqual(engine.consumers.sync { $0.count }, 0)
engine.add(consumerA)
engine.add(consumerB)
XCTAssertEqual(engine.consumers.sync { $0.count }, 2)
engine.emit(problem)
waitForExpectations(timeout: 0.5)
XCTAssertEqual(engine.problems.count, 1)
}
func testAddConsumers() {
let exp = XCTestExpectation()
let consumerA = TestConsumer(exp)
let consumerB = TestConsumer(exp)
let engine = DiagnosticEngine()
engine.add(consumerA)
engine.add(consumerB)
XCTAssertEqual(engine.consumers.sync { $0.count }, 2)
engine.add(consumerA)
engine.add(consumerB)
XCTAssertEqual(engine.consumers.sync { $0.count }, 2, "A diagnostic engine shouldn't be able to add duplicate references to consumers")
}
func testRemoveConsumers() {
let exp = XCTestExpectation()
let consumerA = TestConsumer(exp)
let consumerB = TestConsumer(exp)
let engine = DiagnosticEngine()
engine.add(consumerA)
engine.add(consumerB)
XCTAssertEqual(engine.consumers.sync { $0.count }, 2)
engine.remove(consumerB)
XCTAssertEqual(engine.consumers.sync { $0.count }, 1)
engine.remove(consumerB)
XCTAssertEqual(engine.consumers.sync { $0.count }, 1, "Removing a consumer more than once shouldn't have a side effect on a diagnostic engine")
}
func testProblemFiltering() {
let error = Problem(diagnostic: Diagnostic(source: nil, severity: .error, range: nil, identifier: "org.swift.docc.tests", summary: "Test error"), possibleSolutions: [])
let warning = Problem(diagnostic: Diagnostic(source: nil, severity: .warning, range: nil, identifier: "org.swift.docc.tests", summary: "Test warning"), possibleSolutions: [])
let information = Problem(diagnostic: Diagnostic(source: nil, severity: .information, range: nil, identifier: "org.swift.docc.tests", summary: "Test information"), possibleSolutions: [])
let hint = Problem(diagnostic: Diagnostic(source: nil, severity: .hint, range: nil, identifier: "org.swift.docc.tests", summary: "Test hint"), possibleSolutions: [])
let defaultEngine = DiagnosticEngine()
defaultEngine.emit(error)
defaultEngine.emit(warning)
defaultEngine.emit(information)
defaultEngine.emit(hint)
XCTAssertEqual(DiagnosticConsoleWriter.formattedDescription(for: defaultEngine.problems, options: .formatConsoleOutputForTools), """
error: Test error
warning: Test warning
""")
let engine = DiagnosticEngine(filterLevel: .information)
engine.emit(error)
engine.emit(warning)
engine.emit(information)
engine.emit(hint)
XCTAssertEqual(DiagnosticConsoleWriter.formattedDescription(for: engine.problems, options: .formatConsoleOutputForTools), """
error: Test error
warning: Test warning
note: Test information
""")
}
func testTreatWarningsAsErrors() {
let error = Problem(diagnostic: Diagnostic(source: nil, severity: .error, range: nil, identifier: "org.swift.docc.tests", summary: "Test error"), possibleSolutions: [])
let warning = Problem(diagnostic: Diagnostic(source: nil, severity: .warning, range: nil, identifier: "org.swift.docc.tests", summary: "Test warning"), possibleSolutions: [])
let information = Problem(diagnostic: Diagnostic(source: nil, severity: .information, range: nil, identifier: "org.swift.docc.tests", summary: "Test information"), possibleSolutions: [])
let defaultEngine = DiagnosticEngine()
defaultEngine.emit(error)
defaultEngine.emit(warning)
defaultEngine.emit(information)
XCTAssertEqual(DiagnosticConsoleWriter.formattedDescription(for: defaultEngine.problems, options: .formatConsoleOutputForTools), """
error: Test error
warning: Test warning
""")
let engine = DiagnosticEngine(filterLevel: .information, treatWarningsAsErrors: true)
engine.emit(error)
engine.emit(warning)
engine.emit(information)
XCTAssertEqual(DiagnosticConsoleWriter.formattedDescription(for: engine.problems, options: .formatConsoleOutputForTools), """
error: Test error
error: Test warning
note: Test information
""")
let errorFilterLevelEngine = DiagnosticEngine(filterLevel: .error, treatWarningsAsErrors: true)
errorFilterLevelEngine.emit(error)
errorFilterLevelEngine.emit(warning)
errorFilterLevelEngine.emit(information)
XCTAssertEqual(DiagnosticConsoleWriter.formattedDescription(for: errorFilterLevelEngine.problems, options: .formatConsoleOutputForTools), """
error: Test error
error: Test warning
""")
}
}
|
