11d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/* 21d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Copyright (C) 2011 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.util.concurrent; 181d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 193ecfa412eddc4b084663f38d562537b86b9734d5Paul Duffinimport static com.google.common.truth.Truth.assertThat; 200888a09821a98ac0680fad765217302858e70fa4Paul Duffin 210888a09821a98ac0680fad765217302858e70fa4Paul Duffinimport junit.framework.AssertionFailedError; 220888a09821a98ac0680fad765217302858e70fa4Paul Duffinimport junit.framework.TestCase; 231d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 247dd252788645e940eada959bdde927426e2531c9Paul Duffinimport java.util.concurrent.CancellationException; 251d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.concurrent.ExecutionException; 261d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.concurrent.ExecutorService; 271d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.concurrent.Executors; 281d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.concurrent.atomic.AtomicReference; 291d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 301d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/** 311d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Tests for {@link AbstractFuture}. 321d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 331d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @author Brian Stoler 341d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 351d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 361d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertpublic class AbstractFutureTest extends TestCase { 371d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void testSuccess() throws ExecutionException, InterruptedException { 381d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert final Object value = new Object(); 391d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertSame(value, new AbstractFuture<Object>() { 401d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert { 411d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert set(value); 421d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 431d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert }.get()); 441d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 451d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 461d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void testException() throws InterruptedException { 471d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert final Throwable failure = new Throwable(); 481d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert AbstractFuture<String> future = new AbstractFuture<String>() { 491d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert { 501d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert setException(failure); 511d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 521d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert }; 531d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 541d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert ExecutionException ee1 = getExpectingExecutionException(future); 551d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert ExecutionException ee2 = getExpectingExecutionException(future); 561d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 571d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert // Ensure we get a unique execution exception on each get 581d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertNotSame(ee1, ee2); 591d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 601d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertSame(failure, ee1.getCause()); 611d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertSame(failure, ee2.getCause()); 621d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 631d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert checkStackTrace(ee1); 641d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert checkStackTrace(ee2); 651d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 661d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 677dd252788645e940eada959bdde927426e2531c9Paul Duffin public void testCancel_notDoneNoInterrupt() throws Exception { 681d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert InterruptibleFuture future = new InterruptibleFuture(); 691d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertTrue(future.cancel(false)); 701d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertTrue(future.isCancelled()); 711d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertTrue(future.isDone()); 727dd252788645e940eada959bdde927426e2531c9Paul Duffin assertFalse(future.wasInterrupted()); 737dd252788645e940eada959bdde927426e2531c9Paul Duffin assertFalse(future.interruptTaskWasCalled); 747dd252788645e940eada959bdde927426e2531c9Paul Duffin try { 757dd252788645e940eada959bdde927426e2531c9Paul Duffin future.get(); 767dd252788645e940eada959bdde927426e2531c9Paul Duffin fail("Expected CancellationException"); 777dd252788645e940eada959bdde927426e2531c9Paul Duffin } catch (CancellationException e) { 787dd252788645e940eada959bdde927426e2531c9Paul Duffin assertNotNull(e.getCause()); 797dd252788645e940eada959bdde927426e2531c9Paul Duffin } 801d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 811d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 827dd252788645e940eada959bdde927426e2531c9Paul Duffin public void testCancel_notDoneInterrupt() throws Exception { 831d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert InterruptibleFuture future = new InterruptibleFuture(); 841d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertTrue(future.cancel(true)); 851d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertTrue(future.isCancelled()); 861d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertTrue(future.isDone()); 877dd252788645e940eada959bdde927426e2531c9Paul Duffin assertTrue(future.wasInterrupted()); 887dd252788645e940eada959bdde927426e2531c9Paul Duffin assertTrue(future.interruptTaskWasCalled); 897dd252788645e940eada959bdde927426e2531c9Paul Duffin try { 907dd252788645e940eada959bdde927426e2531c9Paul Duffin future.get(); 917dd252788645e940eada959bdde927426e2531c9Paul Duffin fail("Expected CancellationException"); 927dd252788645e940eada959bdde927426e2531c9Paul Duffin } catch (CancellationException e) { 937dd252788645e940eada959bdde927426e2531c9Paul Duffin assertNotNull(e.getCause()); 947dd252788645e940eada959bdde927426e2531c9Paul Duffin } 951d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 961d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 977dd252788645e940eada959bdde927426e2531c9Paul Duffin public void testCancel_done() throws Exception { 981d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert AbstractFuture<String> future = new AbstractFuture<String>() { 991d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert { 1001d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert set("foo"); 1011d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1021d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert }; 1031d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertFalse(future.cancel(true)); 1041d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertFalse(future.isCancelled()); 1051d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertTrue(future.isDone()); 1061d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1071d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1081d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void testCompletionFinishesWithDone() { 1091d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert ExecutorService executor = Executors.newFixedThreadPool(10); 1101d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert for (int i = 0; i < 50000; i++) { 1111d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert final AbstractFuture<String> future = new AbstractFuture<String>() {}; 1121d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert final AtomicReference<String> errorMessage = new AtomicReference<String>(); 1131d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert executor.execute(new Runnable() { 1141d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 1151d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void run() { 1161d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert future.set("success"); 1171d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert if (!future.isDone()) { 1181d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert errorMessage.set("Set call exited before future was complete."); 1191d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1201d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1211d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert }); 1221d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert executor.execute(new Runnable() { 1231d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 1241d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void run() { 1251d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert future.setException(new IllegalArgumentException("failure")); 1261d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert if (!future.isDone()) { 1271d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert errorMessage.set("SetException call exited before future was complete."); 1281d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1291d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1301d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert }); 1311d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert executor.execute(new Runnable() { 1321d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 1331d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void run() { 1341d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert future.cancel(true); 1351d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert if (!future.isDone()) { 1361d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert errorMessage.set("Cancel call exited before future was complete."); 1371d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1381d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1391d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert }); 1401d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert try { 1411d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert future.get(); 1421d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } catch (Throwable t) { 1431d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert // Ignore, we just wanted to block. 1441d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1451d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert String error = errorMessage.get(); 1461d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertNull(error, error); 1471d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1481d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert executor.shutdown(); 1491d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1501d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1511d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert private void checkStackTrace(ExecutionException e) { 1521d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert // Our call site for get() should be in the trace. 1531d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert int index = findStackFrame( 1541d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert e, getClass().getName(), "getExpectingExecutionException"); 1551d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1563ecfa412eddc4b084663f38d562537b86b9734d5Paul Duffin assertThat(index).isNotEqualTo(0); 1571d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1581d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert // Above our method should be the call to get(). Don't assert on the class 1591d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert // because it could be some superclass. 1603ecfa412eddc4b084663f38d562537b86b9734d5Paul Duffin assertThat(e.getStackTrace()[index - 1].getMethodName()).isEqualTo("get"); 1611d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1621d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1631d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert private static int findStackFrame( 1641d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert ExecutionException e, String clazz, String method) { 1651d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert StackTraceElement[] elements = e.getStackTrace(); 1661d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert for (int i = 0; i < elements.length; i++) { 1671d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert StackTraceElement element = elements[i]; 1681d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert if (element.getClassName().equals(clazz) 1691d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert && element.getMethodName().equals(method)) { 1701d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return i; 1711d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1721d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1731d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert AssertionFailedError failure = 1741d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert new AssertionFailedError("Expected element " + clazz + "." + method 1751d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert + " not found in stack trace"); 1761d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert failure.initCause(e); 1771d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert throw failure; 1781d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1791d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1801d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert private ExecutionException getExpectingExecutionException( 1811d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert AbstractFuture<String> future) throws InterruptedException { 1821d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert try { 1831d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert String got = future.get(); 1841d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert fail("Expected exception but got " + got); 1851d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } catch (ExecutionException e) { 1861d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return e; 1871d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1881d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1891d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert // unreachable, but compiler doesn't know that fail() always throws 1901d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return null; 1911d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1921d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1931d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert private static final class InterruptibleFuture 1941d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert extends AbstractFuture<String> { 1957dd252788645e940eada959bdde927426e2531c9Paul Duffin boolean interruptTaskWasCalled; 1961d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1971d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override protected void interruptTask() { 1987dd252788645e940eada959bdde927426e2531c9Paul Duffin assertFalse(interruptTaskWasCalled); 1997dd252788645e940eada959bdde927426e2531c9Paul Duffin interruptTaskWasCalled = true; 2001d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 2011d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 2021d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert} 203