ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/test/tck/CompletableFutureTest.java
(Generate patch)

Comparing jsr166/src/test/tck/CompletableFutureTest.java (file contents):
Revision 1.122 by jsr166, Sun Sep 6 22:21:07 2015 UTC vs.
Revision 1.136 by jsr166, Sun Nov 15 20:17:11 2015 UTC

# Line 7 | Line 7
7  
8   import static java.util.concurrent.TimeUnit.MILLISECONDS;
9   import static java.util.concurrent.TimeUnit.SECONDS;
10 + import static java.util.concurrent.CompletableFuture.completedFuture;
11 + import static java.util.concurrent.CompletableFuture.failedFuture;
12 +
13 + import java.lang.reflect.Method;
14 + import java.lang.reflect.Modifier;
15 +
16 + import java.util.stream.Collectors;
17 + import java.util.stream.Stream;
18  
19   import java.util.ArrayList;
20 + import java.util.Arrays;
21   import java.util.List;
22   import java.util.Objects;
23 + import java.util.Set;
24   import java.util.concurrent.Callable;
25   import java.util.concurrent.CancellationException;
26   import java.util.concurrent.CompletableFuture;
# Line 28 | Line 38 | import java.util.function.BiConsumer;
38   import java.util.function.BiFunction;
39   import java.util.function.Consumer;
40   import java.util.function.Function;
41 + import java.util.function.Predicate;
42   import java.util.function.Supplier;
43  
44 + import junit.framework.AssertionFailedError;
45   import junit.framework.Test;
46   import junit.framework.TestSuite;
47  
# Line 828 | Line 840 | public class CompletableFutureTest exten
840          if (!createIncomplete) assertTrue(f.complete(v1));
841          final CompletableFuture<Integer> g = f.exceptionally
842              ((Throwable t) -> {
831                // Should not be called
843                  a.getAndIncrement();
844 <                throw new AssertionError();
844 >                threadFail("should not be called");
845 >                return null;            // unreached
846              });
847          if (createIncomplete) assertTrue(f.complete(v1));
848  
# Line 864 | Line 876 | public class CompletableFutureTest exten
876          assertEquals(1, a.get());
877      }}
878  
879 +    /**
880 +     * If an "exceptionally action" throws an exception, it completes
881 +     * exceptionally with that exception
882 +     */
883      public void testExceptionally_exceptionalCompletionActionFailed() {
884          for (boolean createIncomplete : new boolean[] { true, false })
885      {
# Line 882 | Line 898 | public class CompletableFutureTest exten
898          if (createIncomplete) f.completeExceptionally(ex1);
899  
900          checkCompletedWithWrappedException(g, ex2);
901 +        checkCompletedExceptionally(f, ex1);
902          assertEquals(1, a.get());
903      }}
904  
# Line 889 | Line 906 | public class CompletableFutureTest exten
906       * whenComplete action executes on normal completion, propagating
907       * source result.
908       */
909 <    public void testWhenComplete_normalCompletion1() {
909 >    public void testWhenComplete_normalCompletion() {
910          for (ExecutionMode m : ExecutionMode.values())
911          for (boolean createIncomplete : new boolean[] { true, false })
912          for (Integer v1 : new Integer[] { 1, null })
# Line 899 | Line 916 | public class CompletableFutureTest exten
916          if (!createIncomplete) assertTrue(f.complete(v1));
917          final CompletableFuture<Integer> g = m.whenComplete
918              (f,
919 <             (Integer x, Throwable t) -> {
919 >             (Integer result, Throwable t) -> {
920                  m.checkExecutionMode();
921 <                threadAssertSame(x, v1);
921 >                threadAssertSame(result, v1);
922                  threadAssertNull(t);
923                  a.getAndIncrement();
924              });
# Line 926 | Line 943 | public class CompletableFutureTest exten
943          if (!createIncomplete) f.completeExceptionally(ex);
944          final CompletableFuture<Integer> g = m.whenComplete
945              (f,
946 <             (Integer x, Throwable t) -> {
946 >             (Integer result, Throwable t) -> {
947                  m.checkExecutionMode();
948 <                threadAssertNull(x);
948 >                threadAssertNull(result);
949                  threadAssertSame(t, ex);
950                  a.getAndIncrement();
951              });
# Line 953 | Line 970 | public class CompletableFutureTest exten
970          if (!createIncomplete) assertTrue(f.cancel(mayInterruptIfRunning));
971          final CompletableFuture<Integer> g = m.whenComplete
972              (f,
973 <             (Integer x, Throwable t) -> {
973 >             (Integer result, Throwable t) -> {
974                  m.checkExecutionMode();
975 <                threadAssertNull(x);
975 >                threadAssertNull(result);
976                  threadAssertTrue(t instanceof CancellationException);
977                  a.getAndIncrement();
978              });
# Line 970 | Line 987 | public class CompletableFutureTest exten
987       * If a whenComplete action throws an exception when triggered by
988       * a normal completion, it completes exceptionally
989       */
990 <    public void testWhenComplete_actionFailed() {
990 >    public void testWhenComplete_sourceCompletedNormallyActionFailed() {
991          for (boolean createIncomplete : new boolean[] { true, false })
992          for (ExecutionMode m : ExecutionMode.values())
993          for (Integer v1 : new Integer[] { 1, null })
# Line 981 | Line 998 | public class CompletableFutureTest exten
998          if (!createIncomplete) assertTrue(f.complete(v1));
999          final CompletableFuture<Integer> g = m.whenComplete
1000              (f,
1001 <             (Integer x, Throwable t) -> {
1001 >             (Integer result, Throwable t) -> {
1002                  m.checkExecutionMode();
1003 <                threadAssertSame(x, v1);
1003 >                threadAssertSame(result, v1);
1004                  threadAssertNull(t);
1005                  a.getAndIncrement();
1006                  throw ex;
# Line 998 | Line 1015 | public class CompletableFutureTest exten
1015      /**
1016       * If a whenComplete action throws an exception when triggered by
1017       * a source completion that also throws an exception, the source
1018 <     * exception takes precedence.
1018 >     * exception takes precedence (unlike handle)
1019       */
1020 <    public void testWhenComplete_actionFailedSourceFailed() {
1020 >    public void testWhenComplete_sourceFailedActionFailed() {
1021          for (boolean createIncomplete : new boolean[] { true, false })
1022          for (ExecutionMode m : ExecutionMode.values())
1023      {
# Line 1012 | Line 1029 | public class CompletableFutureTest exten
1029          if (!createIncomplete) f.completeExceptionally(ex1);
1030          final CompletableFuture<Integer> g = m.whenComplete
1031              (f,
1032 <             (Integer x, Throwable t) -> {
1032 >             (Integer result, Throwable t) -> {
1033                  m.checkExecutionMode();
1034                  threadAssertSame(t, ex1);
1035 <                threadAssertNull(x);
1035 >                threadAssertNull(result);
1036                  a.getAndIncrement();
1037                  throw ex2;
1038              });
# Line 1040 | Line 1057 | public class CompletableFutureTest exten
1057          if (!createIncomplete) assertTrue(f.complete(v1));
1058          final CompletableFuture<Integer> g = m.handle
1059              (f,
1060 <             (Integer x, Throwable t) -> {
1060 >             (Integer result, Throwable t) -> {
1061                  m.checkExecutionMode();
1062 <                threadAssertSame(x, v1);
1062 >                threadAssertSame(result, v1);
1063                  threadAssertNull(t);
1064                  a.getAndIncrement();
1065                  return inc(v1);
# Line 1069 | Line 1086 | public class CompletableFutureTest exten
1086          if (!createIncomplete) f.completeExceptionally(ex);
1087          final CompletableFuture<Integer> g = m.handle
1088              (f,
1089 <             (Integer x, Throwable t) -> {
1089 >             (Integer result, Throwable t) -> {
1090                  m.checkExecutionMode();
1091 <                threadAssertNull(x);
1091 >                threadAssertNull(result);
1092                  threadAssertSame(t, ex);
1093                  a.getAndIncrement();
1094                  return v1;
# Line 1098 | Line 1115 | public class CompletableFutureTest exten
1115          if (!createIncomplete) assertTrue(f.cancel(mayInterruptIfRunning));
1116          final CompletableFuture<Integer> g = m.handle
1117              (f,
1118 <             (Integer x, Throwable t) -> {
1118 >             (Integer result, Throwable t) -> {
1119                  m.checkExecutionMode();
1120 <                threadAssertNull(x);
1120 >                threadAssertNull(result);
1121                  threadAssertTrue(t instanceof CancellationException);
1122                  a.getAndIncrement();
1123                  return v1;
# Line 1113 | Line 1130 | public class CompletableFutureTest exten
1130      }}
1131  
1132      /**
1133 <     * handle result completes exceptionally if action does
1133 >     * If a "handle action" throws an exception when triggered by
1134 >     * a normal completion, it completes exceptionally
1135       */
1136 <    public void testHandle_sourceFailedActionFailed() {
1136 >    public void testHandle_sourceCompletedNormallyActionFailed() {
1137          for (ExecutionMode m : ExecutionMode.values())
1138          for (boolean createIncomplete : new boolean[] { true, false })
1139 +        for (Integer v1 : new Integer[] { 1, null })
1140      {
1141          final CompletableFuture<Integer> f = new CompletableFuture<>();
1142          final AtomicInteger a = new AtomicInteger(0);
1143 <        final CFException ex1 = new CFException();
1144 <        final CFException ex2 = new CFException();
1126 <        if (!createIncomplete) f.completeExceptionally(ex1);
1143 >        final CFException ex = new CFException();
1144 >        if (!createIncomplete) assertTrue(f.complete(v1));
1145          final CompletableFuture<Integer> g = m.handle
1146              (f,
1147 <             (Integer x, Throwable t) -> {
1147 >             (Integer result, Throwable t) -> {
1148                  m.checkExecutionMode();
1149 <                threadAssertNull(x);
1150 <                threadAssertSame(ex1, t);
1149 >                threadAssertSame(result, v1);
1150 >                threadAssertNull(t);
1151                  a.getAndIncrement();
1152 <                throw ex2;
1152 >                throw ex;
1153              });
1154 <        if (createIncomplete) f.completeExceptionally(ex1);
1154 >        if (createIncomplete) assertTrue(f.complete(v1));
1155  
1156 <        checkCompletedWithWrappedException(g, ex2);
1157 <        checkCompletedExceptionally(f, ex1);
1156 >        checkCompletedWithWrappedException(g, ex);
1157 >        checkCompletedNormally(f, v1);
1158          assertEquals(1, a.get());
1159      }}
1160  
1161 <    public void testHandle_sourceCompletedNormallyActionFailed() {
1162 <        for (ExecutionMode m : ExecutionMode.values())
1161 >    /**
1162 >     * If a "handle action" throws an exception when triggered by
1163 >     * a source completion that also throws an exception, the action
1164 >     * exception takes precedence (unlike whenComplete)
1165 >     */
1166 >    public void testHandle_sourceFailedActionFailed() {
1167          for (boolean createIncomplete : new boolean[] { true, false })
1168 <        for (Integer v1 : new Integer[] { 1, null })
1168 >        for (ExecutionMode m : ExecutionMode.values())
1169      {
1148        final CompletableFuture<Integer> f = new CompletableFuture<>();
1170          final AtomicInteger a = new AtomicInteger(0);
1171 <        final CFException ex = new CFException();
1172 <        if (!createIncomplete) assertTrue(f.complete(v1));
1171 >        final CFException ex1 = new CFException();
1172 >        final CFException ex2 = new CFException();
1173 >        final CompletableFuture<Integer> f = new CompletableFuture<>();
1174 >
1175 >        if (!createIncomplete) f.completeExceptionally(ex1);
1176          final CompletableFuture<Integer> g = m.handle
1177              (f,
1178 <             (Integer x, Throwable t) -> {
1178 >             (Integer result, Throwable t) -> {
1179                  m.checkExecutionMode();
1180 <                threadAssertSame(x, v1);
1181 <                threadAssertNull(t);
1180 >                threadAssertNull(result);
1181 >                threadAssertSame(ex1, t);
1182                  a.getAndIncrement();
1183 <                throw ex;
1183 >                throw ex2;
1184              });
1185 <        if (createIncomplete) assertTrue(f.complete(v1));
1185 >        if (createIncomplete) f.completeExceptionally(ex1);
1186  
1187 <        checkCompletedWithWrappedException(g, ex);
1188 <        checkCompletedNormally(f, v1);
1187 >        checkCompletedWithWrappedException(g, ex2);
1188 >        checkCompletedExceptionally(f, ex1);
1189          assertEquals(1, a.get());
1190      }}
1191  
# Line 3632 | Line 3656 | public class CompletableFutureTest exten
3656          funs.add((y) -> m.thenAcceptBoth(y, v42, new SubtractAction(m)));
3657          funs.add((y) -> m.thenCombine(y, v42, new SubtractFunction(m)));
3658  
3659 <        funs.add((y) -> m.whenComplete(y, (Integer x, Throwable t) -> {}));
3659 >        funs.add((y) -> m.whenComplete(y, (Integer r, Throwable t) -> {}));
3660  
3661          funs.add((y) -> m.thenCompose(y, new CompletableFutureInc(m)));
3662  
# Line 3688 | Line 3712 | public class CompletableFutureTest exten
3712          }
3713      }}
3714  
3715 +    /**
3716 +     * Minimal completion stages throw UOE for all non-CompletionStage methods
3717 +     */
3718 +    public void testMinimalCompletionStage_minimality() {
3719 +        if (!testImplementationDetails) return;
3720 +        Function<Method, String> toSignature =
3721 +            (method) -> method.getName() + Arrays.toString(method.getParameterTypes());
3722 +        Predicate<Method> isNotStatic =
3723 +            (method) -> (method.getModifiers() & Modifier.STATIC) == 0;
3724 +        List<Method> minimalMethods =
3725 +            Stream.of(Object.class, CompletionStage.class)
3726 +            .flatMap((klazz) -> Stream.of(klazz.getMethods()))
3727 +            .filter(isNotStatic)
3728 +            .collect(Collectors.toList());
3729 +        // Methods from CompletableFuture permitted NOT to throw UOE
3730 +        String[] signatureWhitelist = {
3731 +            "newIncompleteFuture[]",
3732 +            "defaultExecutor[]",
3733 +            "minimalCompletionStage[]",
3734 +            "copy[]",
3735 +        };
3736 +        Set<String> permittedMethodSignatures =
3737 +            Stream.concat(minimalMethods.stream().map(toSignature),
3738 +                          Stream.of(signatureWhitelist))
3739 +            .collect(Collectors.toSet());
3740 +        List<Method> allMethods = Stream.of(CompletableFuture.class.getMethods())
3741 +            .filter(isNotStatic)
3742 +            .filter((method) -> !permittedMethodSignatures.contains(toSignature.apply(method)))
3743 +            .collect(Collectors.toList());
3744 +
3745 +        CompletionStage<Integer> minimalStage =
3746 +            new CompletableFuture<Integer>().minimalCompletionStage();
3747 +
3748 +        List<Method> bugs = new ArrayList<>();
3749 +        for (Method method : allMethods) {
3750 +            Class<?>[] parameterTypes = method.getParameterTypes();
3751 +            Object[] args = new Object[parameterTypes.length];
3752 +            // Manufacture boxed primitives for primitive params
3753 +            for (int i = 0; i < args.length; i++) {
3754 +                Class<?> type = parameterTypes[i];
3755 +                if (parameterTypes[i] == boolean.class)
3756 +                    args[i] = false;
3757 +                else if (parameterTypes[i] == int.class)
3758 +                    args[i] = 0;
3759 +                else if (parameterTypes[i] == long.class)
3760 +                    args[i] = 0L;
3761 +            }
3762 +            try {
3763 +                method.invoke(minimalStage, args);
3764 +                bugs.add(method);
3765 +            }
3766 +            catch (java.lang.reflect.InvocationTargetException expected) {
3767 +                if (! (expected.getCause() instanceof UnsupportedOperationException)) {
3768 +                    bugs.add(method);
3769 +                    // expected.getCause().printStackTrace();
3770 +                }
3771 +            }
3772 +            catch (ReflectiveOperationException bad) { throw new Error(bad); }
3773 +        }
3774 +        if (!bugs.isEmpty())
3775 +            throw new Error("Methods did not throw UOE: " + bugs.toString());
3776 +    }
3777 +
3778 +    static class Monad {
3779 +        static class ZeroException extends RuntimeException {
3780 +            public ZeroException() { super("monadic zero"); }
3781 +        }
3782 +        // "return", "unit"
3783 +        static <T> CompletableFuture<T> unit(T value) {
3784 +            return completedFuture(value);
3785 +        }
3786 +        // monadic zero ?
3787 +        static <T> CompletableFuture<T> zero() {
3788 +            return failedFuture(new ZeroException());
3789 +        }
3790 +        // >=>
3791 +        static <T,U,V> Function<T, CompletableFuture<V>> compose
3792 +            (Function<T, CompletableFuture<U>> f,
3793 +             Function<U, CompletableFuture<V>> g) {
3794 +            return (x) -> f.apply(x).thenCompose(g);
3795 +        }
3796 +
3797 +        static void assertZero(CompletableFuture<?> f) {
3798 +            try {
3799 +                f.getNow(null);
3800 +                throw new AssertionFailedError("should throw");
3801 +            } catch (CompletionException success) {
3802 +                assertTrue(success.getCause() instanceof ZeroException);
3803 +            }
3804 +        }
3805 +
3806 +        static <T> void assertFutureEquals(CompletableFuture<T> f,
3807 +                                           CompletableFuture<T> g) {
3808 +            T fval = null, gval = null;
3809 +            Throwable fex = null, gex = null;
3810 +
3811 +            try { fval = f.get(); }
3812 +            catch (ExecutionException ex) { fex = ex.getCause(); }
3813 +            catch (Throwable ex) { fex = ex; }
3814 +
3815 +            try { gval = g.get(); }
3816 +            catch (ExecutionException ex) { gex = ex.getCause(); }
3817 +            catch (Throwable ex) { gex = ex; }
3818 +
3819 +            if (fex != null || gex != null)
3820 +                assertSame(fex.getClass(), gex.getClass());
3821 +            else
3822 +                assertEquals(fval, gval);
3823 +        }
3824 +
3825 +        static class PlusFuture<T> extends CompletableFuture<T> {
3826 +            AtomicReference<Throwable> firstFailure = new AtomicReference<>(null);
3827 +        }
3828 +
3829 +        // Monadic "plus"
3830 +        static <T> CompletableFuture<T> plus(CompletableFuture<? extends T> f,
3831 +                                             CompletableFuture<? extends T> g) {
3832 +            PlusFuture<T> plus = new PlusFuture<T>();
3833 +            BiConsumer<T, Throwable> action = (T result, Throwable ex) -> {
3834 +                if (ex == null) {
3835 +                    if (plus.complete(result))
3836 +                        if (plus.firstFailure.get() != null)
3837 +                            plus.firstFailure.set(null);
3838 +                }
3839 +                else if (plus.firstFailure.compareAndSet(null, ex)) {
3840 +                    if (plus.isDone())
3841 +                        plus.firstFailure.set(null);
3842 +                }
3843 +                else {
3844 +                    // first failure has precedence
3845 +                    Throwable first = plus.firstFailure.getAndSet(null);
3846 +
3847 +                    // may fail with "Self-suppression not permitted"
3848 +                    try { first.addSuppressed(ex); }
3849 +                    catch (Exception ignored) {}
3850 +
3851 +                    plus.completeExceptionally(first);
3852 +                }
3853 +            };
3854 +            f.whenComplete(action);
3855 +            g.whenComplete(action);
3856 +            return plus;
3857 +        }
3858 +    }
3859 +
3860 +    /**
3861 +     * CompletableFuture is an additive monad - sort of.
3862 +     * https://en.wikipedia.org/wiki/Monad_(functional_programming)#Additive_monads
3863 +     */
3864 +    public void testAdditiveMonad() throws Throwable {
3865 +        Function<Long, CompletableFuture<Long>> unit = Monad::unit;
3866 +        CompletableFuture<Long> zero = Monad.zero();
3867 +
3868 +        // Some mutually non-commutative functions
3869 +        Function<Long, CompletableFuture<Long>> triple
3870 +            = (x) -> Monad.unit(3 * x);
3871 +        Function<Long, CompletableFuture<Long>> inc
3872 +            = (x) -> Monad.unit(x + 1);
3873 +
3874 +        // unit is a right identity: m >>= unit === m
3875 +        Monad.assertFutureEquals(inc.apply(5L).thenCompose(unit),
3876 +                                 inc.apply(5L));
3877 +        // unit is a left identity: (unit x) >>= f === f x
3878 +        Monad.assertFutureEquals(unit.apply(5L).thenCompose(inc),
3879 +                                 inc.apply(5L));
3880 +
3881 +        // associativity: (m >>= f) >>= g === m >>= ( \x -> (f x >>= g) )
3882 +        Monad.assertFutureEquals(
3883 +            unit.apply(5L).thenCompose(inc).thenCompose(triple),
3884 +            unit.apply(5L).thenCompose((x) -> inc.apply(x).thenCompose(triple)));
3885 +
3886 +        // The case for CompletableFuture as an additive monad is weaker...
3887 +
3888 +        // zero is a monadic zero
3889 +        Monad.assertZero(zero);
3890 +
3891 +        // left zero: zero >>= f === zero
3892 +        Monad.assertZero(zero.thenCompose(inc));
3893 +        // right zero: f >>= (\x -> zero) === zero
3894 +        Monad.assertZero(inc.apply(5L).thenCompose((x) -> zero));
3895 +
3896 +        // f plus zero === f
3897 +        Monad.assertFutureEquals(Monad.unit(5L),
3898 +                                 Monad.plus(Monad.unit(5L), zero));
3899 +        // zero plus f === f
3900 +        Monad.assertFutureEquals(Monad.unit(5L),
3901 +                                 Monad.plus(zero, Monad.unit(5L)));
3902 +        // zero plus zero === zero
3903 +        Monad.assertZero(Monad.plus(zero, zero));
3904 +        {
3905 +            CompletableFuture<Long> f = Monad.plus(Monad.unit(5L),
3906 +                                                   Monad.unit(8L));
3907 +            // non-determinism
3908 +            assertTrue(f.get() == 5L || f.get() == 8L);
3909 +        }
3910 +
3911 +        CompletableFuture<Long> godot = new CompletableFuture<>();
3912 +        // f plus godot === f (doesn't wait for godot)
3913 +        Monad.assertFutureEquals(Monad.unit(5L),
3914 +                                 Monad.plus(Monad.unit(5L), godot));
3915 +        // godot plus f === f (doesn't wait for godot)
3916 +        Monad.assertFutureEquals(Monad.unit(5L),
3917 +                                 Monad.plus(godot, Monad.unit(5L)));
3918 +    }
3919 +
3920 + //     static <U> U join(CompletionStage<U> stage) {
3921 + //         CompletableFuture<U> f = new CompletableFuture<>();
3922 + //         stage.whenComplete((v, ex) -> {
3923 + //             if (ex != null) f.completeExceptionally(ex); else f.complete(v);
3924 + //         });
3925 + //         return f.join();
3926 + //     }
3927 +
3928 + //     static <U> boolean isDone(CompletionStage<U> stage) {
3929 + //         CompletableFuture<U> f = new CompletableFuture<>();
3930 + //         stage.whenComplete((v, ex) -> {
3931 + //             if (ex != null) f.completeExceptionally(ex); else f.complete(v);
3932 + //         });
3933 + //         return f.isDone();
3934 + //     }
3935 +
3936 + //     static <U> U join2(CompletionStage<U> stage) {
3937 + //         return stage.toCompletableFuture().copy().join();
3938 + //     }
3939 +
3940 + //     static <U> boolean isDone2(CompletionStage<U> stage) {
3941 + //         return stage.toCompletableFuture().copy().isDone();
3942 + //     }
3943 +
3944   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines