11d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/* 21d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Copyright (C) 2005 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.base; 181d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 191d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.base.internal.Finalizer; 207dd252788645e940eada959bdde927426e2531c9Paul Duffinimport com.google.common.testing.GcFinalization; 211d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 220888a09821a98ac0680fad765217302858e70fa4Paul Duffinimport junit.framework.TestCase; 230888a09821a98ac0680fad765217302858e70fa4Paul Duffin 241d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.lang.ref.ReferenceQueue; 251d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.lang.ref.WeakReference; 261d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.net.URL; 271d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.net.URLClassLoader; 280888a09821a98ac0680fad765217302858e70fa4Paul Duffinimport java.util.Arrays; 290888a09821a98ac0680fad765217302858e70fa4Paul Duffinimport java.util.Collections; 307dd252788645e940eada959bdde927426e2531c9Paul Duffin 311d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/** 321d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Unit test for {@link FinalizableReferenceQueue}. 331d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 341d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @author Bob Lee 351d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 361d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertpublic class FinalizableReferenceQueueTest extends TestCase { 371d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 381d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert private FinalizableReferenceQueue frq; 391d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 401d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 411d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert protected void tearDown() throws Exception { 421d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert frq = null; 431d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 441d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 451d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void testFinalizeReferentCalled() { 467dd252788645e940eada959bdde927426e2531c9Paul Duffin final MockReference reference = new MockReference( 471d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert frq = new FinalizableReferenceQueue()); 487dd252788645e940eada959bdde927426e2531c9Paul Duffin 497dd252788645e940eada959bdde927426e2531c9Paul Duffin GcFinalization.awaitDone(new GcFinalization.FinalizationPredicate() { 507dd252788645e940eada959bdde927426e2531c9Paul Duffin public boolean isDone() { 517dd252788645e940eada959bdde927426e2531c9Paul Duffin return reference.finalizeReferentCalled; 527dd252788645e940eada959bdde927426e2531c9Paul Duffin } 537dd252788645e940eada959bdde927426e2531c9Paul Duffin }); 541d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 551d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 561d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert static class MockReference extends FinalizableWeakReference<Object> { 571d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 581d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert volatile boolean finalizeReferentCalled; 591d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 601d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert MockReference(FinalizableReferenceQueue frq) { 611d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert super(new Object(), frq); 621d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 631d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 641d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 651d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void finalizeReferent() { 661d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert finalizeReferentCalled = true; 671d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 681d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 691d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 701d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 711d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Keeps a weak reference to the underlying reference queue. When this 721d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * reference is cleared, we know that the background thread has stopped 731d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * and released its strong reference. 741d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 751d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert private WeakReference<ReferenceQueue<Object>> queueReference; 761d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 771d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void testThatFinalizerStops() { 781d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert weaklyReferenceQueue(); 797dd252788645e940eada959bdde927426e2531c9Paul Duffin GcFinalization.awaitClear(queueReference); 801d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 811d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 821d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 831d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * If we don't keep a strong reference to the reference object, it won't 841d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * be enqueued. 851d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 861d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert FinalizableWeakReference<Object> reference; 871d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 881d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 891d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Create the FRQ in a method that goes out of scope so that we're sure 901d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * it will be reclaimed. 911d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 921d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert private void weaklyReferenceQueue() { 931d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert frq = new FinalizableReferenceQueue(); 941d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert queueReference = new WeakReference<ReferenceQueue<Object>>(frq.queue); 951d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 961d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /* 971d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Queue and clear a reference for good measure. We test later on that 981d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * the finalizer thread stopped, but we should test that it actually 991d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * started first. 1001d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 1011d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert reference = new FinalizableWeakReference<Object>(new Object(), frq) { 1021d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 1031d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void finalizeReferent() { 1041d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert reference = null; 1051d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert frq = null; 1061d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1071d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert }; 1081d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1091d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1101d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void testDecoupledLoader() { 1111d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert FinalizableReferenceQueue.DecoupledLoader decoupledLoader = 1121d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert new FinalizableReferenceQueue.DecoupledLoader() { 1131d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 1141d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert URLClassLoader newLoader(URL base) { 1151d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return new DecoupledClassLoader(new URL[] { base }); 1161d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1171d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert }; 1181d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1191d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert Class<?> finalizerCopy = decoupledLoader.loadFinalizer(); 1201d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1211d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertNotNull(finalizerCopy); 1221d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertNotSame(Finalizer.class, finalizerCopy); 1231d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1241d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertNotNull(FinalizableReferenceQueue.getStartFinalizer(finalizerCopy)); 1251d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1261d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1271d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert static class DecoupledClassLoader extends URLClassLoader { 1281d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1291d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public DecoupledClassLoader(URL[] urls) { 1301d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert super(urls); 1311d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1321d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1331d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 1341d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert protected synchronized Class<?> loadClass(String name, boolean resolve) 1351d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert throws ClassNotFoundException { 1361d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert // Force Finalizer to load from this class loader, not its parent. 1371d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert if (name.equals(Finalizer.class.getName())) { 1381d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert Class<?> clazz = findClass(name); 1391d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert if (resolve) { 1401d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert resolveClass(clazz); 1411d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1421d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return clazz; 1431d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1441d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1451d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return super.loadClass(name, resolve); 1461d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1471d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1481d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1491d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void testGetFinalizerUrl() { 1501d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertNotNull(getClass().getResource("internal/Finalizer.class")); 1511d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1520888a09821a98ac0680fad765217302858e70fa4Paul Duffin 1530888a09821a98ac0680fad765217302858e70fa4Paul Duffin public void testFinalizeClassHasNoNestedClases() throws Exception { 1540888a09821a98ac0680fad765217302858e70fa4Paul Duffin // Ensure that the Finalizer class has no nested classes. 1550888a09821a98ac0680fad765217302858e70fa4Paul Duffin // See https://code.google.com/p/guava-libraries/issues/detail?id=1505 1560888a09821a98ac0680fad765217302858e70fa4Paul Duffin assertEquals(Collections.emptyList(), Arrays.asList(Finalizer.class.getDeclaredClasses())); 1570888a09821a98ac0680fad765217302858e70fa4Paul Duffin } 1581d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert} 159