2
* Copyright (C) 2008 The Guava Authors
4
* Licensed under the Apache License, Version 2.0 (the "License");
5
* you may not use this file except in compliance with the License.
6
* You may obtain a copy of the License at
8
* http://www.apache.org/licenses/LICENSE-2.0
10
* Unless required by applicable law or agreed to in writing, software
11
* distributed under the License is distributed on an "AS IS" BASIS,
12
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
* See the License for the specific language governing permissions and
14
* limitations under the License.
17
package com.google.common.testing;
19
import com.google.common.annotations.GwtCompatible;
20
import com.google.errorprone.annotations.concurrent.GuardedBy;
21
import java.util.ArrayList;
22
import java.util.Collections;
24
import java.util.logging.Handler;
25
import java.util.logging.LogRecord;
26
import org.checkerframework.checker.nullness.qual.Nullable;
29
* Tests may use this to intercept messages that are logged by the code under test. Example:
32
* TestLogHandler handler;
34
* protected void setUp() throws Exception {
36
* handler = new TestLogHandler();
37
* SomeClass.logger.addHandler(handler);
38
* addTearDown(new TearDown() {
39
* public void tearDown() throws Exception {
40
* SomeClass.logger.removeHandler(handler);
45
* public void test() {
47
* LogRecord firstRecord = handler.getStoredLogRecords().get(0);
48
* assertEquals("some message", firstRecord.getMessage());
52
* @author Kevin Bourrillion
56
@ElementTypesAreNonnullByDefault
57
public class TestLogHandler extends Handler {
58
private final Object lock = new Object();
60
/** We will keep a private list of all logged records */
62
private final List<LogRecord> list = new ArrayList<>();
64
/** Adds the most recently logged record to our list. */
66
public void publish(@Nullable LogRecord record) {
75
public void flush() {}
78
public void close() {}
86
/** Returns a snapshot of the logged records. */
88
* TODO(cpovirk): consider higher-level APIs here (say, assertNoRecordsLogged(),
89
* getOnlyRecordLogged(), getAndClearLogRecords()...)
91
* TODO(cpovirk): consider renaming this method to reflect that it takes a snapshot (and/or return
94
public List<LogRecord> getStoredLogRecords() {
96
List<LogRecord> result = new ArrayList<>(list);
97
return Collections.unmodifiableList(result);