11d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/* 21d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Copyright (C) 2008 The Guava Authors 31d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 41d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Licensed under the Apache License, Version 2.0 (the "License"); 51d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * you may not use this file except in compliance with the License. 61d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * You may obtain a copy of the License at 71d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 81d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * http://www.apache.org/licenses/LICENSE-2.0 91d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 101d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Unless required by applicable law or agreed to in writing, software 111d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * distributed under the License is distributed on an "AS IS" BASIS, 121d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 131d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See the License for the specific language governing permissions and 141d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * limitations under the License. 151d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 161d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 171d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertpackage com.google.common.testing; 181d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 191d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.annotations.Beta; 201d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 211d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.ArrayList; 221d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.Collections; 231d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.List; 241d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.logging.Handler; 251d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.logging.LogRecord; 261d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 277dd252788645e940eada959bdde927426e2531c9Paul Duffinimport javax.annotation.Nullable; 287dd252788645e940eada959bdde927426e2531c9Paul Duffin 291d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/** 301d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Tests may use this to intercept messages that are logged by the code under 311d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * test. Example: 321d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * <pre> 331d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * TestLogHandler handler; 341d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 351d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * protected void setUp() throws Exception { 361d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * super.setUp(); 371d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * handler = new TestLogHandler(); 381d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * SomeClass.logger.addHandler(handler); 391d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * addTearDown(new TearDown() { 401d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * public void tearDown() throws Exception { 411d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * SomeClass.logger.removeHandler(handler); 421d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * } 431d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * }); 441d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * } 451d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 461d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * public void test() { 471d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * SomeClass.foo(); 481d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * LogRecord firstRecord = handler.getStoredLogRecords().get(0); 491d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * assertEquals("some message", firstRecord.getMessage()); 501d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * } 511d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * </pre> 521d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 531d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @author Kevin Bourrillion 541d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @since 10.0 551d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 561d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert@Beta 571d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertpublic class TestLogHandler extends Handler { 581d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** We will keep a private list of all logged records */ 591d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert private final List<LogRecord> list = 601d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert Collections.synchronizedList(new ArrayList<LogRecord>()); 611d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 621d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 631d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Adds the most recently logged record to our list. 641d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 651d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 667dd252788645e940eada959bdde927426e2531c9Paul Duffin public void publish(@Nullable LogRecord record) { 671d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert list.add(record); 681d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 691d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 701d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 717dd252788645e940eada959bdde927426e2531c9Paul Duffin public void flush() {} 721d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 731d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 747dd252788645e940eada959bdde927426e2531c9Paul Duffin public void close() {} 751d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 761d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void clear() { 771d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert list.clear(); 781d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 791d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 801d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 811d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Fetch the list of logged records 821d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @return unmodifiable LogRecord list of all logged records 831d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 841d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public List<LogRecord> getStoredLogRecords() { 851d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert List<LogRecord> result = new ArrayList<LogRecord>(list); 861d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return Collections.unmodifiableList(result); 871d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 881d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert} 89