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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 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 the list of Swift project authors
//
//===----------------------------------------------------------------------===//
@_spi(Testing) import LSPLogging
import SKTestSupport
import XCTest
fileprivate func assertLogging(
logLevel: NonDarwinLogLevel = .default,
privacyLevel: NonDarwinLogPrivacy = .private,
expected: [String],
_ body: (NonDarwinLogger) -> Void,
file: StaticString = #filePath,
line: UInt = #line
) async {
// nonisolated(unsafe) because calls of `assertLogging` do not log to `logHandler` concurrently.
nonisolated(unsafe) var messages: [String] = []
let logger = NonDarwinLogger(
subsystem: LoggingScope.subsystem,
category: "test",
logLevel: logLevel,
privacyLevel: privacyLevel,
overrideLogHandler: { messages.append($0) }
)
body(logger)
await NonDarwinLogger.flush()
guard messages.count == expected.count else {
XCTFail(
"""
Number of messages does not match expected does not match expected
Received:
\(messages.joined(separator: "\n"))
""",
file: file,
line: line
)
return
}
for (message, expected) in zip(messages, expected) {
guard let firstNewline = message.firstIndex(of: "\n") else {
XCTFail(
"""
Did not find newline separating header from message in
\(message)
""",
file: file,
line: line
)
continue
}
guard message.hasSuffix("\n---") else {
XCTFail("Message is expected to end with `---`", file: file, line: line)
return
}
let messageContent = String(message[message.index(after: firstNewline)...].dropLast(4))
XCTAssertEqual(messageContent, expected, "Message does not match expected", file: file, line: line)
}
messages.removeAll()
}
final class LoggingTests: XCTestCase {
func testLoggingFormat() async throws {
let expectation = self.expectation(description: "message logged")
// nonisolated(unsafe) because we only have a single call to `logger.log` and that cannot race.
nonisolated(unsafe) var message: String = ""
let logger = NonDarwinLogger(
subsystem: LoggingScope.subsystem,
category: "test",
overrideLogHandler: {
message = $0
expectation.fulfill()
}
)
logger.log(level: .error, "my message")
try await fulfillmentOfOrThrow([expectation])
XCTAssert(
message.starts(with: "[org.swift.sourcekit-lsp:test] error"),
"Message did not have expected header. Received \n\(message)"
)
XCTAssert(message.hasSuffix("\nmy message\n---"), "Message did not have expected body. Received \n\(message)")
}
func testLoggingBasic() async {
await assertLogging(
expected: ["a"],
{
$0.log("a")
}
)
await assertLogging(
expected: [],
{ _ in
}
)
await assertLogging(expected: ["b\n\nc"]) {
$0.log("b\n\nc")
}
}
func testLogLevels() async {
await assertLogging(
logLevel: .default,
expected: ["d", "e", "f"]
) {
$0.fault("d")
$0.error("e")
$0.log("f")
$0.info("g")
$0.debug("h")
}
await assertLogging(
logLevel: .error,
expected: ["d", "e"]
) {
$0.fault("d")
$0.error("e")
$0.log("f")
$0.info("g")
$0.debug("h")
}
await assertLogging(
logLevel: .fault,
expected: ["d"]
) {
$0.fault("d")
$0.error("e")
$0.log("f")
$0.info("g")
$0.debug("h")
}
}
func testPrivacyMaskingLevels() async {
await assertLogging(expected: ["password is <private>"]) {
let password: String = "1234"
$0.log("password is \(password, privacy: .sensitive)")
}
await assertLogging(expected: ["username is root"]) {
let username: String = "root"
$0.log("username is \(username, privacy: .private)")
}
await assertLogging(expected: ["username is root"]) {
let username: String = "root"
$0.log("username is \(username)")
}
await assertLogging(
privacyLevel: .public,
expected: ["username is <private>"]
) {
let username: String = "root"
$0.log("username is \(username, privacy: .private)")
}
await assertLogging(
privacyLevel: .public,
expected: ["username is <private>"]
) {
let username: String = "root"
$0.log("username is \(username)")
}
}
func testPrivacyMaskingTypes() async {
await assertLogging(
privacyLevel: .public,
expected: ["logging a static string"]
) {
$0.log("logging a \("static string")")
}
await assertLogging(
privacyLevel: .public,
expected: ["logging from LSPLoggingTests.LoggingTests"]
) {
$0.log("logging from \(LoggingTests.self)")
}
struct LogStringConvertible: CustomLogStringConvertible {
var description: String = "full description"
var redactedDescription: String = "redacted description"
}
await assertLogging(
privacyLevel: .public,
expected: ["got redacted description"]
) {
$0.log("got \(LogStringConvertible().forLogging)")
}
await assertLogging(
privacyLevel: .private,
expected: ["got full description"]
) {
$0.log("got \(LogStringConvertible().forLogging)")
}
}
}
|
