-
Notifications
You must be signed in to change notification settings - Fork 317
/
LoggingTester.java
339 lines (296 loc) · 8.96 KB
/
LoggingTester.java
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
/**
* Copyright (c) 2015, 2024 itemis AG (http://www.itemis.eu) and others.
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.xtext.testing.logging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.Objects;
import java.util.Queue;
import java.util.concurrent.ConcurrentLinkedQueue;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.apache.log4j.Appender;
import org.apache.log4j.AppenderSkeleton;
import org.apache.log4j.Category;
import org.apache.log4j.Level;
import org.apache.log4j.Logger;
import org.apache.log4j.spi.Filter;
import org.apache.log4j.spi.LoggingEvent;
import org.eclipse.xtend2.lib.StringConcatenation;
import org.eclipse.xtext.xbase.lib.Conversions;
import org.eclipse.xtext.xbase.lib.IterableExtensions;
import org.eclipse.xtext.xbase.lib.Pure;
import org.eclipse.xtext.xbase.lib.util.ToStringBuilder;
import org.junit.Assert;
import com.google.common.annotations.Beta;
import com.google.common.primitives.Longs;
@Beta
public class LoggingTester {
private static final Comparator<LogEntry> TEMPORAL_ORDER = ($0, $1) -> Longs.compare($0.timeStamp, $1.timeStamp);
public static LogCapture captureLogging(Level level, Class<?> source, Runnable action) {
Logger logger = Logger.getLogger(source);
QueueAppender appender = new QueueAppender();
Level oldLevel = logger.getLevel();
List<Appender> allAppenders = appenderHierarchy(logger);
SourceFilter filter = new SourceFilter(logger);
try {
allAppenders.forEach(it -> it.addFilter(filter));
logger.addAppender(appender);
logger.setLevel(level);
action.run();
List<LogEntry> events = IterableExtensions.sortWith(IterableExtensions.toList(appender.events),
LoggingTester.TEMPORAL_ORDER);
return new LoggingTester.LogCapture(events);
} finally {
logger.removeAppender(appender);
allAppenders.forEach(it -> LoggingTester.removeFilter(it, filter));
logger.setLevel(oldLevel);
}
}
@SuppressWarnings("unchecked")
private static List<Appender> appenderHierarchy(Logger logger) {
List<Appender> appenders = new ArrayList<>();
for (Category current = logger; current != null; current = current.getParent())
appenders.addAll(Collections.list(current.getAllAppenders()));
return appenders;
}
private static void removeFilter(Appender appender, Filter filter) {
List<Filter> filtersToKeep = new ArrayList<>();
Filter present = appender.getFilter();
while (present != null) {
if (!Objects.equals(present, filter)) {
filtersToKeep.add(present);
}
present = present.getNext();
}
appender.clearFilters();
filtersToKeep.forEach(addMe -> {
addMe.setNext(null);
appender.addFilter(addMe);
});
}
public static class LogCapture {
private final List<LogEntry> logEntries;
public void assertNoLogEntries() {
assertNumberOfLogEntries(0);
}
public void assertLogEntry(String... messageParts) {
assertNumberOfLogEntries(1, messageParts);
}
public void assertLogEntry(Level level, String... messageParts) {
assertNumberOfLogEntries(1, level, messageParts);
}
public void assertNumberOfLogEntries(int number) {
assertNumberOfLogEntries(number, new String[] {});
}
public void assertNumberOfLogEntries(int number, String... messageParts) {
assertNumberOfLogEntries(number, null, messageParts);
}
public void assertNumberOfLogEntries(int number, Level level, String... messageParts) {
@SuppressWarnings("unchecked")
Iterable<LogEntry> passed = IterableExtensions
.filter(logEntries,
log -> ((level == null || Objects.equals(log.level, level)) && IterableExtensions.forall(
((Iterable<String>) Conversions.doWrapArray(messageParts)),
it -> log.message.contains(it))));
if (IterableExtensions.size(passed) != number) {
StringConcatenation builder = new StringConcatenation();
if (number == 0) {
builder.append("Expected no log entries");
builder.newLine();
} else {
if (number == 1) {
builder.append("Expected a log entry");
builder.newLine();
} else {
builder.append("Expected ");
builder.append(number);
builder.append(" log entries");
builder.newLineIfNotEmpty();
}
}
if (level != null) {
builder.append("with ");
builder.append(level);
builder.append(" level");
builder.newLineIfNotEmpty();
}
builder.append("containing the phrases ");
builder.append(Stream.of(messageParts).map(s -> "\"" + s + "\"").collect(Collectors.joining(", ")));
builder.newLineIfNotEmpty();
builder.append("but got");
builder.newLine();
builder.append(this.logEntries);
builder.newLineIfNotEmpty();
Assert.fail(builder.toString());
}
}
public LogCapture(List<LogEntry> logEntries) {
super();
this.logEntries = logEntries;
}
@Override
@Pure
public int hashCode() {
return 31 * 1 + ((logEntries == null) ? 0 : logEntries.hashCode());
}
@Override
@Pure
public boolean equals(final Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
LogCapture other = (LogCapture) obj;
if (logEntries == null) {
if (other.logEntries != null)
return false;
} else if (!logEntries.equals(other.logEntries))
return false;
return true;
}
@Override
@Pure
public String toString() {
ToStringBuilder b = new ToStringBuilder(this);
b.add("logEntries", logEntries);
return b.toString();
}
@Pure
public List<LogEntry> getLogEntries() {
return logEntries;
}
}
public static class LogEntry {
private final String message;
private final String source;
private final long timeStamp;
private final Level level;
public LogEntry(String message, String source, long timeStamp, Level level) {
this.message = message;
this.source = source;
this.timeStamp = timeStamp;
this.level = level;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + (message == null ? 0 : message.hashCode());
result = prime * result + (source == null ? 0 : source.hashCode());
result = prime * result + (int) (timeStamp ^ (timeStamp >>> 32));
return prime * result + (level == null ? 0 : level.hashCode());
}
@Override
public boolean equals(final Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
LogEntry other = (LogEntry) obj;
if (message == null) {
if (other.message != null)
return false;
} else if (!message.equals(other.message))
return false;
if (source == null) {
if (other.source != null)
return false;
} else if (!source.equals(other.source))
return false;
if (other.timeStamp != timeStamp)
return false;
if (level == null) {
if (other.level != null)
return false;
} else if (!level.equals(other.level))
return false;
return true;
}
@Override
public String toString() {
ToStringBuilder b = new ToStringBuilder(this);
b.add("message", message);
b.add("source", source);
b.add("timeStamp", timeStamp);
b.add("level", level);
return b.toString();
}
public String getMessage() {
return message;
}
public String getSource() {
return source;
}
public long getTimeStamp() {
return timeStamp;
}
public Level getLevel() {
return level;
}
}
private static class QueueAppender extends AppenderSkeleton {
private final Queue<LogEntry> events = new ConcurrentLinkedQueue<>();
@Override
public boolean requiresLayout() {
return false;
}
@Override
public void close() {
}
@Override
protected void append(LoggingEvent event) {
events.add(new LogEntry(event.getRenderedMessage(), event.getLoggerName(), event.getTimeStamp(),
event.getLevel()));
}
@Pure
public Queue<LoggingTester.LogEntry> getEvents() {
return events;
}
}
private static class SourceFilter extends Filter {
private final Logger source;
@Override
public int decide(LoggingEvent event) {
return Objects.equals(event.getLoggerName(), source.getName()) ? Filter.DENY : Filter.NEUTRAL;
}
public SourceFilter(Logger source) {
this.source = source;
}
@Override
public int hashCode() {
return 31 * 1 + (source == null ? 0 : source.hashCode());
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
SourceFilter other = (SourceFilter) obj;
if (source == null) {
if (other.source != null)
return false;
} else if (!source.equals(other.source))
return false;
return true;
}
@Override
public String toString() {
return new ToStringBuilder(this).addAllFields().toString();
}
}
}