moving RecordingScheduler to common gax-core

4dbab5d9ba7e57dbc6c0e19cf9238ca38191aad8
commit 4dbab5d9ba7e57dbc6c0e19cf9238ca38191aad8
diff --git a/gax-grpc/src/test/java/com/google/api/gax/grpc/CancellationTest.java b/gax-grpc/src/test/java/com/google/api/gax/grpc/CancellationTest.java
@@ -33,6 +33,7 @@
 import com.google.api.core.ApiFuture;
 import com.google.api.core.SettableApiFuture;
 import com.google.api.gax.core.FakeApiClock;
+import com.google.api.gax.core.RecordingScheduler;
 import com.google.api.gax.retrying.RetrySettings;
 import com.google.api.gax.rpc.ApiCallContext;
 import com.google.api.gax.rpc.ClientContext;

diff --git a/gax-grpc/src/test/java/com/google/api/gax/grpc/GrpcOperationCallableImplTest.java b/gax-grpc/src/test/java/com/google/api/gax/grpc/GrpcOperationCallableImplTest.java
@@ -38,6 +38,7 @@
 import com.google.api.core.ApiFuture;
 import com.google.api.core.ListenableFutureToApiFuture;
 import com.google.api.gax.core.FakeApiClock;
+import com.google.api.gax.core.RecordingScheduler;
 import com.google.api.gax.grpc.testing.FakeMethodDescriptor;
 import com.google.api.gax.retrying.RetrySettings;
 import com.google.api.gax.retrying.TimedAttemptSettings;

diff --git a/gax-grpc/src/test/java/com/google/api/gax/grpc/RetryingTest.java b/gax-grpc/src/test/java/com/google/api/gax/grpc/RetryingTest.java
@@ -32,6 +32,7 @@
 import com.google.api.core.ApiFuture;
 import com.google.api.core.ApiFutures;
 import com.google.api.gax.core.FakeApiClock;
+import com.google.api.gax.core.RecordingScheduler;
 import com.google.api.gax.retrying.RetrySettings;
 import com.google.api.gax.rpc.ApiCallContext;
 import com.google.api.gax.rpc.ApiException;

diff --git a/gax-httpjson/src/test/java/com/google/api/gax/httpjson/RetryingTest.java b/gax-httpjson/src/test/java/com/google/api/gax/httpjson/RetryingTest.java
@@ -0,0 +1,309 @@
+/*
+ * Copyright 2017, Google Inc. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following disclaimer
+ * in the documentation and/or other materials provided with the
+ * distribution.
+ *     * Neither the name of Google Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package com.google.api.gax.httpjson;
+
+import com.google.api.core.ApiFuture;
+import com.google.api.core.ApiFutures;
+import com.google.api.gax.core.FakeApiClock;
+import com.google.api.gax.core.RecordingScheduler;
+import com.google.api.gax.retrying.RetrySettings;
+import com.google.api.gax.rpc.ApiCallContext;
+import com.google.api.gax.rpc.ApiException;
+import com.google.api.gax.rpc.ClientContext;
+import com.google.api.gax.rpc.SimpleCallSettings;
+import com.google.api.gax.rpc.StatusCode;
+import com.google.api.gax.rpc.UnaryCallable;
+import com.google.common.collect.ImmutableSet;
+import com.google.common.truth.Truth;
+import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.UncheckedExecutionException;
+import io.grpc.Status;
+import java.util.Set;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.ExpectedException;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+import org.mockito.Mockito;
+import org.threeten.bp.Duration;
+
+@RunWith(JUnit4.class)
+public class RetryingTest {
+  @SuppressWarnings("unchecked")
+  private UnaryCallable<Integer, Integer> callInt = Mockito.mock(UnaryCallable.class);
+
+  private RecordingScheduler executor;
+  private FakeApiClock fakeClock;
+  private ClientContext clientContext;
+
+  private static final RetrySettings FAST_RETRY_SETTINGS =
+      RetrySettings.newBuilder()
+          .setInitialRetryDelay(Duration.ofMillis(2L))
+          .setRetryDelayMultiplier(1)
+          .setMaxRetryDelay(Duration.ofMillis(2L))
+          .setInitialRpcTimeout(Duration.ofMillis(2L))
+          .setRpcTimeoutMultiplier(1)
+          .setMaxRpcTimeout(Duration.ofMillis(2L))
+          .setTotalTimeout(Duration.ofMillis(10L))
+          .build();
+
+  @Before
+  public void resetClock() {
+    fakeClock = new FakeApiClock(System.nanoTime());
+    executor = RecordingScheduler.create(fakeClock);
+    clientContext = ClientContext.newBuilder().setExecutor(executor).setClock(fakeClock).build();
+  }
+
+  @After
+  public void teardown() {
+    executor.shutdownNow();
+  }
+
+  @Rule public ExpectedException thrown = ExpectedException.none();
+
+  static <V> ApiFuture<V> immediateFailedFuture(Throwable t) {
+    return ApiFutures.<V>immediateFailedFuture(t);
+  }
+
+  @Test
+  public void retry() {
+    ImmutableSet<StatusCode> retryable =
+        ImmutableSet.<StatusCode>of(GrpcStatusCode.of(Status.Code.UNAVAILABLE));
+    Throwable throwable = Status.UNAVAILABLE.asException();
+    Mockito.when(callInt.futureCall((Integer) Mockito.any(), (ApiCallContext) Mockito.any()))
+        .thenReturn(RetryingTest.<Integer>immediateFailedFuture(throwable))
+        .thenReturn(RetryingTest.<Integer>immediateFailedFuture(throwable))
+        .thenReturn(RetryingTest.<Integer>immediateFailedFuture(throwable))
+        .thenReturn(ApiFutures.<Integer>immediateFuture(2));
+
+    SimpleCallSettings<Integer, Integer> callSettings =
+        createSettings(retryable, FAST_RETRY_SETTINGS);
+    UnaryCallable<Integer, Integer> callable =
+        GrpcCallableFactory.create(callInt, callSettings, clientContext);
+    Truth.assertThat(callable.call(1)).isEqualTo(2);
+  }
+
+  @Test(expected = ApiException.class)
+  public void retryTotalTimeoutExceeded() {
+    ImmutableSet<StatusCode> retryable =
+        ImmutableSet.<StatusCode>of(GrpcStatusCode.of(Status.Code.UNAVAILABLE));
+    Throwable throwable = Status.UNAVAILABLE.asException();
+    Mockito.when(callInt.futureCall((Integer) Mockito.any(), (ApiCallContext) Mockito.any()))
+        .thenReturn(RetryingTest.<Integer>immediateFailedFuture(throwable))
+        .thenReturn(ApiFutures.<Integer>immediateFuture(2));
+
+    RetrySettings retrySettings =
+        FAST_RETRY_SETTINGS
+            .toBuilder()
+            .setInitialRetryDelay(Duration.ofMillis(Integer.MAX_VALUE))
+            .setMaxRetryDelay(Duration.ofMillis(Integer.MAX_VALUE))
+            .build();
+    SimpleCallSettings<Integer, Integer> callSettings = createSettings(retryable, retrySettings);
+    UnaryCallable<Integer, Integer> callable =
+        GrpcCallableFactory.create(callInt, callSettings, clientContext);
+    callable.call(1);
+  }
+
+  @Test(expected = ApiException.class)
+  public void retryMaxAttemptsExeeded() {
+    ImmutableSet<StatusCode> retryable =
+        ImmutableSet.<StatusCode>of(GrpcStatusCode.of(Status.Code.UNAVAILABLE));
+    Throwable throwable = Status.UNAVAILABLE.asException();
+    Mockito.when(callInt.futureCall((Integer) Mockito.any(), (ApiCallContext) Mockito.any()))
+        .thenReturn(RetryingTest.<Integer>immediateFailedFuture(throwable))
+        .thenReturn(RetryingTest.<Integer>immediateFailedFuture(throwable))
+        .thenReturn(ApiFutures.<Integer>immediateFuture(2));
+
+    RetrySettings retrySettings = FAST_RETRY_SETTINGS.toBuilder().setMaxAttempts(2).build();
+    SimpleCallSettings<Integer, Integer> callSettings = createSettings(retryable, retrySettings);
+    UnaryCallable<Integer, Integer> callable =
+        GrpcCallableFactory.create(callInt, callSettings, clientContext);
+    callable.call(1);
+  }
+
+  @Test
+  public void retryWithinMaxAttempts() {
+    ImmutableSet<StatusCode> retryable =
+        ImmutableSet.<StatusCode>of(GrpcStatusCode.of(Status.Code.UNAVAILABLE));
+    Throwable throwable = Status.UNAVAILABLE.asException();
+    Mockito.when(callInt.futureCall((Integer) Mockito.any(), (ApiCallContext) Mockito.any()))
+        .thenReturn(RetryingTest.<Integer>immediateFailedFuture(throwable))
+        .thenReturn(RetryingTest.<Integer>immediateFailedFuture(throwable))
+        .thenReturn(ApiFutures.<Integer>immediateFuture(2));
+
+    RetrySettings retrySettings = FAST_RETRY_SETTINGS.toBuilder().setMaxAttempts(3).build();
+    SimpleCallSettings<Integer, Integer> callSettings = createSettings(retryable, retrySettings);
+    UnaryCallable<Integer, Integer> callable =
+        GrpcCallableFactory.create(callInt, callSettings, clientContext);
+    callable.call(1);
+    Truth.assertThat(callable.call(1)).isEqualTo(2);
+  }
+
+  @Test
+  public void retryOnStatusUnknown() {
+    ImmutableSet<StatusCode> retryable =
+        ImmutableSet.<StatusCode>of(GrpcStatusCode.of(Status.Code.UNKNOWN));
+    Throwable throwable = Status.UNKNOWN.asException();
+    Mockito.when(callInt.futureCall((Integer) Mockito.any(), (ApiCallContext) Mockito.any()))
+        .thenReturn(RetryingTest.<Integer>immediateFailedFuture(throwable))
+        .thenReturn(RetryingTest.<Integer>immediateFailedFuture(throwable))
+        .thenReturn(RetryingTest.<Integer>immediateFailedFuture(throwable))
+        .thenReturn(ApiFutures.<Integer>immediateFuture(2));
+    SimpleCallSettings<Integer, Integer> callSettings =
+        createSettings(retryable, FAST_RETRY_SETTINGS);
+    UnaryCallable<Integer, Integer> callable =
+        GrpcCallableFactory.create(callInt, callSettings, clientContext);
+    Truth.assertThat(callable.call(1)).isEqualTo(2);
+  }
+
+  @Test
+  public void retryOnUnexpectedException() {
+    thrown.expect(ApiException.class);
+    thrown.expectMessage("foobar");
+    ImmutableSet<StatusCode> retryable =
+        ImmutableSet.<StatusCode>of(GrpcStatusCode.of(Status.Code.UNKNOWN));
+    Throwable throwable = new RuntimeException("foobar");
+    Mockito.when(callInt.futureCall((Integer) Mockito.any(), (ApiCallContext) Mockito.any()))
+        .thenReturn(RetryingTest.<Integer>immediateFailedFuture(throwable));
+    SimpleCallSettings<Integer, Integer> callSettings =
+        createSettings(retryable, FAST_RETRY_SETTINGS);
+    UnaryCallable<Integer, Integer> callable =
+        GrpcCallableFactory.create(callInt, callSettings, clientContext);
+    callable.call(1);
+  }
+
+  @Test
+  public void retryNoRecover() {
+    thrown.expect(ApiException.class);
+    thrown.expectMessage("foobar");
+    ImmutableSet<StatusCode> retryable =
+        ImmutableSet.<StatusCode>of(GrpcStatusCode.of(Status.Code.UNAVAILABLE));
+    Mockito.when(callInt.futureCall((Integer) Mockito.any(), (ApiCallContext) Mockito.any()))
+        .thenReturn(
+            RetryingTest.<Integer>immediateFailedFuture(
+                Status.FAILED_PRECONDITION.withDescription("foobar").asException()))
+        .thenReturn(ApiFutures.<Integer>immediateFuture(2));
+    SimpleCallSettings<Integer, Integer> callSettings =
+        createSettings(retryable, FAST_RETRY_SETTINGS);
+    UnaryCallable<Integer, Integer> callable =
+        GrpcCallableFactory.create(callInt, callSettings, clientContext);
+    callable.call(1);
+  }
+
+  @Test
+  public void retryKeepFailing() {
+    thrown.expect(UncheckedExecutionException.class);
+    thrown.expectMessage("foobar");
+    ImmutableSet<StatusCode> retryable =
+        ImmutableSet.<StatusCode>of(GrpcStatusCode.of(Status.Code.UNAVAILABLE));
+    Mockito.when(callInt.futureCall((Integer) Mockito.any(), (ApiCallContext) Mockito.any()))
+        .thenReturn(
+            RetryingTest.<Integer>immediateFailedFuture(
+                Status.UNAVAILABLE.withDescription("foobar").asException()));
+    SimpleCallSettings<Integer, Integer> callSettings =
+        createSettings(retryable, FAST_RETRY_SETTINGS);
+    UnaryCallable<Integer, Integer> callable =
+        GrpcCallableFactory.create(callInt, callSettings, clientContext);
+    // Need to advance time inside the call.
+    ApiFuture<Integer> future = callable.futureCall(1);
+    Futures.getUnchecked(future);
+  }
+
+  @Test
+  public void noSleepOnRetryTimeout() {
+    ImmutableSet<StatusCode> retryable =
+        ImmutableSet.<StatusCode>of(
+            GrpcStatusCode.of(Status.Code.UNAVAILABLE),
+            GrpcStatusCode.of(Status.Code.DEADLINE_EXCEEDED));
+    Mockito.when(callInt.futureCall((Integer) Mockito.any(), (ApiCallContext) Mockito.any()))
+        .thenReturn(
+            RetryingTest.<Integer>immediateFailedFuture(
+                Status.DEADLINE_EXCEEDED.withDescription("DEADLINE_EXCEEDED").asException()))
+        .thenReturn(ApiFutures.<Integer>immediateFuture(2));
+
+    SimpleCallSettings<Integer, Integer> callSettings =
+        createSettings(retryable, FAST_RETRY_SETTINGS);
+    UnaryCallable<Integer, Integer> callable =
+        GrpcCallableFactory.create(callInt, callSettings, clientContext);
+    callable.call(1);
+    Truth.assertThat(executor.getSleepDurations().size()).isEqualTo(1);
+    Truth.assertThat(executor.getSleepDurations().get(0))
+        .isEqualTo(ApiResultRetryAlgorithm.DEADLINE_SLEEP_DURATION);
+  }
+
+  @Test
+  public void testKnownStatusCode() {
+    ImmutableSet<StatusCode> retryable =
+        ImmutableSet.<StatusCode>of(GrpcStatusCode.of(Status.Code.UNAVAILABLE));
+    Mockito.when(callInt.futureCall((Integer) Mockito.any(), (ApiCallContext) Mockito.any()))
+        .thenReturn(
+            RetryingTest.<Integer>immediateFailedFuture(
+                Status.FAILED_PRECONDITION.withDescription("known").asException()));
+    SimpleCallSettings<Integer, Integer> callSettings =
+        SimpleCallSettings.<Integer, Integer>newBuilder().setRetryableCodes(retryable).build();
+    UnaryCallable<Integer, Integer> callable =
+        GrpcCallableFactory.create(callInt, callSettings, clientContext);
+    try {
+      callable.call(1);
+    } catch (GrpcApiException exception) {
+      Truth.assertThat(exception.getStatusCode().getCode())
+          .isEqualTo(Status.Code.FAILED_PRECONDITION);
+      Truth.assertThat(exception.getMessage())
+          .isEqualTo("io.grpc.StatusException: FAILED_PRECONDITION: known");
+    }
+  }
+
+  @Test
+  public void testUnknownStatusCode() {
+    ImmutableSet<StatusCode> retryable = ImmutableSet.<StatusCode>of();
+    Mockito.when(callInt.futureCall((Integer) Mockito.any(), (ApiCallContext) Mockito.any()))
+        .thenReturn(RetryingTest.<Integer>immediateFailedFuture(new RuntimeException("unknown")));
+    SimpleCallSettings<Integer, Integer> callSettings =
+        SimpleCallSettings.<Integer, Integer>newBuilder().setRetryableCodes(retryable).build();
+    UnaryCallable<Integer, Integer> callable =
+        GrpcCallableFactory.create(callInt, callSettings, clientContext);
+    try {
+      callable.call(1);
+    } catch (GrpcApiException exception) {
+      Truth.assertThat(exception.getStatusCode().getCode()).isEqualTo(Status.Code.UNKNOWN);
+      Truth.assertThat(exception.getMessage()).isEqualTo("java.lang.RuntimeException: unknown");
+    }
+  }
+
+  public static SimpleCallSettings<Integer, Integer> createSettings(
+      Set<StatusCode> retryableCodes, RetrySettings retrySettings) {
+    return SimpleCallSettings.<Integer, Integer>newBuilder()
+        .setRetryableCodes(retryableCodes)
+        .setRetrySettings(retrySettings)
+        .build();
+  }
+}
diff --git a/gax/src/test/java/com/google/api/gax/core/RecordingScheduler.java b/gax/src/test/java/com/google/api/gax/core/RecordingScheduler.java
@@ -27,13 +27,12 @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-package com.google.api.gax.grpc;
+package com.google.api.gax.core;
 
 import static org.mockito.Matchers.any;
 import static org.mockito.Matchers.anyLong;
 import static org.mockito.Mockito.when;
 
-import com.google.api.gax.core.FakeApiClock;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.ScheduledExecutorService;