/
TestLogHandler.java
87 lines (79 loc) · 2.53 KB
/
TestLogHandler.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
/*
* Copyright (C) 2008 The Guava Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.common.testing;
import com.google.common.annotations.GwtCompatible;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.logging.Handler;
import java.util.logging.LogRecord;
import org.checkerframework.checker.nullness.qual.Nullable;
/**
* Tests may use this to intercept messages that are logged by the code under test. Example:
*
* <pre>
* TestLogHandler handler;
*
* protected void setUp() throws Exception {
* super.setUp();
* handler = new TestLogHandler();
* SomeClass.logger.addHandler(handler);
* addTearDown(new TearDown() {
* public void tearDown() throws Exception {
* SomeClass.logger.removeHandler(handler);
* }
* });
* }
*
* public void test() {
* SomeClass.foo();
* LogRecord firstRecord = handler.getStoredLogRecords().get(0);
* assertEquals("some message", firstRecord.getMessage());
* }
* </pre>
*
* @author Kevin Bourrillion
* @since 10.0
*/
@GwtCompatible
public class TestLogHandler extends Handler {
/** We will keep a private list of all logged records */
private final List<LogRecord> list = new ArrayList<>();
/** Adds the most recently logged record to our list. */
@Override
public synchronized void publish(@Nullable LogRecord record) {
list.add(record);
}
@Override
public void flush() {}
@Override
public void close() {}
public synchronized void clear() {
list.clear();
}
/** Returns a snapshot of the logged records. */
/*
* TODO(cpovirk): consider higher-level APIs here (say, assertNoRecordsLogged(),
* getOnlyRecordLogged(), getAndClearLogRecords()...)
*
* TODO(cpovirk): consider renaming this method to reflect that it takes a snapshot (and/or return
* an ImmutableList)
*/
public synchronized List<LogRecord> getStoredLogRecords() {
List<LogRecord> result = new ArrayList<>(list);
return Collections.unmodifiableList(result);
}
}